--- swagger: "2.0" x-collection-name: AWS EC2 x-complete: 0 info: title: AWS EC2 API Get Console Output version: 1.0.0 description: Gets the console output for the specified instance. schemes: - http produces: - application/json consumes: - application/json paths: /?Action=DescribeAccountAttributes: get: summary: Describe Account Attributes description: Describes attributes of your AWS account. operationId: describeaccountattributes x-api-path-slug: actiondescribeaccountattributes-get parameters: - in: query name: ClientToken description: Unique, case-sensitive identifier you provide to ensureidempotency of the request type: string - in: query name: Description description: A description for the new AMI in the destination region type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Encrypted description: Specifies whether the destination snapshots of the copied image should be encrypted type: string - in: query name: KmsKeyId description: The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation type: string - in: query name: Name description: The name of the new AMI in the destination region type: string - in: query name: SourceImageId description: The ID of the AMI to copy type: string - in: query name: SourceRegion description: The name of the region that contains the AMI to copy type: string responses: 200: description: OK tags: - Account /?Action=CopyImage: get: summary: Copy Image description: Initiates the copy of an AMI from the specified source region to the current region. operationId: copyimage x-api-path-slug: actioncopyimage-get parameters: - in: query name: BlockDeviceMapping.N description: Information about one or more block device mappings type: string - in: query name: Description description: A description for the new image type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: InstanceId description: The ID of the instance type: string - in: query name: Name description: A name for the new image type: string - in: query name: NoReboot description: By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image type: string responses: 200: description: OK tags: - Server Image /?Action=CreateImage: get: summary: Create Image description: Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. operationId: createimage x-api-path-slug: actioncreateimage-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: ImageId description: The ID of the AMI type: string responses: 200: description: OK tags: - Server Image /?Action=DeregisterImage: get: summary: Deregister Image description: Deregisters the specified AMI. operationId: deregisterimage x-api-path-slug: actionderegisterimage-get parameters: - in: query name: Attribute description: The AMI attribute type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: ImageId description: The ID of the AMI type: string responses: 200: description: OK tags: - Server Image /?Action=DescribeImageAttribute: get: summary: Describe Image Attribute description: Describes the specified attribute of the specified AMI. operationId: describeimageattribute x-api-path-slug: actiondescribeimageattribute-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: ExecutableBy.N description: Scopes the images by users with explicit launch permissions type: string - in: query name: Filter.N description: One or more filters type: string - in: query name: ImageId.N description: One or more image IDs type: string - in: query name: Owner.N description: Filters the images by the owner type: string responses: 200: description: OK tags: - Server Image /?Action=DescribeImages: get: summary: Describe Images description: Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. operationId: describeimages x-api-path-slug: actiondescribeimages-get parameters: - in: query name: Attribute description: The name of the attribute to modify type: string - in: query name: Description description: A description for the AMI type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: ImageId description: The ID of the AMI type: string - in: query name: LaunchPermission description: A launch permission modification type: string - in: query name: OperationType description: The operation type type: string - in: query name: ProductCode.N description: One or more product codes type: string - in: query name: UserGroup.N description: One or more user groups type: string - in: query name: UserId.N description: One or more AWS account IDs type: string - in: query name: Value description: The value of the attribute being modified type: string responses: 200: description: OK tags: - Server Image /?Action=ModifyImageAttribute: get: summary: Modify Image Attribute description: Modifies the specified attribute of the specified AMI. operationId: modifyimageattribute x-api-path-slug: actionmodifyimageattribute-get parameters: - in: query name: Architecture description: The architecture of the AMI type: string - in: query name: BlockDeviceMapping.N description: One or more block device mapping entries type: string - in: query name: Description description: A description for your AMI type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: EnaSupport description: Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI type: string - in: query name: ImageLocation description: The full path to your AMI manifest in Amazon S3 storage type: string - in: query name: KernelId description: The ID of the kernel type: string - in: query name: Name description: A name for your AMI type: string - in: query name: RamdiskId description: The ID of the RAM disk type: string - in: query name: RootDeviceName description: The name of the root device (for example, /dev/sda1, or/dev/xvda) type: string - in: query name: SriovNetSupport description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI type: string - in: query name: VirtualizationType description: The type of virtualization type: string responses: 200: description: OK tags: - Server Image /?Action=RegisterImage: get: summary: Register Image description: Registers an AMI. operationId: registerimage x-api-path-slug: actionregisterimage-get parameters: - in: query name: Attribute description: The attribute to reset (currently you can only reset the launch permission attribute) type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: ImageId description: The ID of the AMI type: string responses: 200: description: OK tags: - Server Image /?Action=ResetImageAttribute: get: summary: Reset Image Attribute description: Resets an attribute of an AMI to its default value. operationId: resetimageattribute x-api-path-slug: actionresetimageattribute-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: InstanceId description: The ID of the instance type: string - in: query name: ProductCode description: The product code type: string responses: 200: description: OK tags: - Server Image /?Action=ConfirmProductInstance: get: summary: Confirm Product Instance description: Determines whether a product code is associated with an instance. operationId: confirmproductinstance x-api-path-slug: actionconfirmproductinstance-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: InstanceId description: The ID of the instance to bundle type: string - in: query name: Storage description: The bucket in which to store the AMI type: string responses: 200: description: OK tags: - Product Instance /?Action=BundleInstance: get: summary: Bundle Instance description: Bundles an Amazon instance store-backed Windows instance. operationId: bundleinstance x-api-path-slug: actionbundleinstance-get parameters: - in: query name: BundleId description: The ID of the bundle task type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string responses: 200: description: OK tags: - Bundle Instance /?Action=CancelBundleTask: get: summary: Cancel Bundle Task description: Cancels a bundling operation for an instance store-backed Windows instance. operationId: cancelbundletask x-api-path-slug: actioncancelbundletask-get parameters: - in: query name: BundleId.N description: One or more bundle task IDs type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string responses: 200: description: OK tags: - Bundle Task /?Action=DescribeBundleTasks: get: summary: Describe Bundle Tasks description: Describes one or more of your bundling tasks. operationId: describebundletasks x-api-path-slug: actiondescribebundletasks-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: InstanceId description: The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC type: string - in: query name: SecurityGroupId.N description: The ID of one or more of the VPCs security groups type: string - in: query name: VpcId description: The ID of a ClassicLink-enabled VPC type: string responses: 200: description: OK tags: - Bundle Task /?Action=AttachClassicLinkVpc: get: summary: Attach Classic Link Vpc description: "Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's\n\t\t\tsecurity groups." operationId: attachclassiclinkvpc x-api-path-slug: actionattachclassiclinkvpc-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string - in: query name: InstanceId.N description: One or more instance IDs type: string - in: query name: MaxResults description: The maximum number of results to return for the request in a single page type: string - in: query name: NextToken description: The token to retrieve the next page of results type: string responses: 200: description: OK tags: - VPC Link /?Action=DescribeClassicLinkInstances: get: summary: Describe Classic Link Instances description: Describes one or more of your linked EC2-Classic instances. operationId: describeclassiclinkinstances x-api-path-slug: actiondescribeclassiclinkinstances-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string - in: query name: VpcId.N description: One or more VPCs for which you want to describe the ClassicLink status type: string responses: 200: description: OK tags: - Server Instance /?Action=DescribeVpcClassicLink: get: summary: Describe Vpc Classic Link description: Describes the ClassicLink status of one or more VPCs. operationId: describevpcclassiclink x-api-path-slug: actiondescribevpcclassiclink-get parameters: - in: query name: MaxResults description: The maximum number of items to return for this request type: string - in: query name: NextToken description: The token for the next set of items to return type: string - in: query name: VpcIds.N description: One or more VPC IDs type: string responses: 200: description: OK tags: - VPC /?Action=DescribeVpcClassicLinkDnsSupport: get: summary: Describe Vpc Classic Link Dns Support description: Describes the ClassicLink DNS support status of one or more VPCs. operationId: describevpcclassiclinkdnssupport x-api-path-slug: actiondescribevpcclassiclinkdnssupport-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: InstanceId description: The ID of the instance to unlink from the VPC type: string - in: query name: VpcId description: The ID of the VPC to which the instance is linked type: string responses: 200: description: OK tags: - VPC DNS /?Action=DetachClassicLinkVpc: get: summary: Detach Classic Link Vpc description: Unlinks (detaches) a linked EC2-Classic instance from a VPC. operationId: detachclassiclinkvpc x-api-path-slug: actiondetachclassiclinkvpc-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: VpcId description: The ID of the VPC type: string responses: 200: description: OK tags: - VPC /?Action=DisableVpcClassicLink: get: summary: Disable Vpc Classic Link description: Disables ClassicLink for a VPC. operationId: disablevpcclassiclink x-api-path-slug: actiondisablevpcclassiclink-get parameters: - in: query name: VpcId description: The ID of the VPC type: string responses: 200: description: OK tags: - VPC /?Action=DisableVpcClassicLinkDnsSupport: get: summary: Disable Vpc Classic Link Dns Support description: Disables ClassicLink DNS support for a VPC. operationId: disablevpcclassiclinkdnssupport x-api-path-slug: actiondisablevpcclassiclinkdnssupport-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: VpcId description: The ID of the VPC type: string responses: 200: description: OK tags: - VPC DNS /?Action=EnableVpcClassicLink: get: summary: Enable Vpc Classic Link description: Enables a VPC for ClassicLink. operationId: enablevpcclassiclink x-api-path-slug: actionenablevpcclassiclink-get parameters: - in: query name: VpcId description: The ID of the VPC type: string responses: 200: description: OK tags: - VPC /?Action=EnableVpcClassicLinkDnsSupport: get: summary: Enable Vpc Classic Link Dns Support description: Enables a VPC to support DNS hostname resolution for ClassicLink. operationId: enablevpcclassiclinkdnssupport x-api-path-slug: actionenablevpcclassiclinkdnssupport-get parameters: - in: query name: BgpAsn description: For devices that support BGP, the customer gateways BGP ASN type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: IpAddress description: The Internet-routable IP address for the customer gateways outside interface type: string - in: query name: Type description: The type of VPN connection that this customer gateway supports (ipsec type: string responses: 200: description: OK tags: - VPC NS /?Action=CreateCustomerGateway: get: summary: Create Customer Gateway description: Provides information to AWS about your VPN customer gateway device. operationId: createcustomergateway x-api-path-slug: actioncreatecustomergateway-get parameters: - in: query name: CustomerGatewayId description: The ID of the customer gateway type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string responses: 200: description: OK tags: - Gateway /?Action=DeleteCustomerGateway: get: summary: Delete Customer Gateway description: Deletes the specified customer gateway. operationId: deletecustomergateway x-api-path-slug: actiondeletecustomergateway-get parameters: - in: query name: CustomerGatewayId.N description: One or more customer gateway IDs type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string responses: 200: description: OK tags: - Customer Gateway /?Action=DescribeCustomerGateways: get: summary: Describe Customer Gateways description: Describes one or more of your VPN customer gateways. operationId: describecustomergateways x-api-path-slug: actiondescribecustomergateways-get parameters: - in: query name: AutoPlacement description: This is enabled by default type: string - in: query name: AvailabilityZone description: The Availability Zone for the Dedicated Hosts type: string - in: query name: ClientToken description: Unique, case-sensitive identifier you provide to ensure idempotency of the request type: string - in: query name: InstanceType description: Specify the instance type that you want your Dedicated Hosts to be configured for type: string - in: query name: Quantity description: The number of Dedicated Hosts you want to allocate to your account with these parameters type: string responses: 200: description: OK tags: - Customer Gateways /?Action=AllocateHosts: get: summary: Allocate Hosts description: Allocates a Dedicated Host to your account. operationId: allocatehosts x-api-path-slug: actionallocatehosts-get parameters: - in: query name: Filter.N description: One or more filters type: string - in: query name: HostId.N description: The IDs of the Dedicated Hosts type: string - in: query name: MaxResults description: The maximum number of results to return for the request in a single page type: string - in: query name: NextToken description: The token to retrieve the next page of results type: string responses: 200: description: OK tags: - Host /?Action=DescribeHosts: get: summary: Describe Hosts description: Describes one or more of your Dedicated Hosts. operationId: describehosts x-api-path-slug: actiondescribehosts-get parameters: - in: query name: Filter.N description: One or more filters type: string - in: query name: MaxDuration description: This is the maximum duration of the reservation youd like to purchase, specified in seconds type: string - in: query name: MaxResults description: The maximum number of results to return for the request in a single page type: string - in: query name: MinDuration description: This is the minimum duration of the reservation youd like to purchase, specified in seconds type: string - in: query name: NextToken description: The token to use to retrieve the next page of results type: string - in: query name: OfferingId description: The ID of the reservation offering type: string responses: 200: description: OK tags: - Hosts /?Action=DescribeHostReservationOfferings: get: summary: Describe Host Reservation Offerings description: Describes the Dedicated Host Reservations that are available to purchase. operationId: describehostreservationofferings x-api-path-slug: actiondescribehostreservationofferings-get parameters: - in: query name: Filter.N description: One or more filters type: string - in: query name: HostReservationIdSet.N description: One or more host reservation IDs type: string - in: query name: MaxResults description: The maximum number of results to return for the request in a single page type: string - in: query name: NextToken description: The token to use to retrieve the next page of results type: string responses: 200: description: OK tags: - Host Reservation /?Action=DescribeHostReservations: get: summary: Describe Host Reservations description: |- Describes Dedicated Host Reservations which are associated with Dedicated Hosts in your account. operationId: describehostreservations x-api-path-slug: actiondescribehostreservations-get parameters: - in: query name: HostIdSet.N description: The ID/s of the Dedicated Host/s that the reservation will be associated with type: string - in: query name: OfferingId description: The offering ID of the reservation type: string responses: 200: description: OK tags: - Host Reservation /?Action=GetHostReservationPurchasePreview: get: summary: Get Host Reservation Purchase Preview description: |- Preview a reservation purchase with configurations that match those of your Dedicated Host. operationId: gethostreservationpurchasepreview x-api-path-slug: actiongethostreservationpurchasepreview-get parameters: - in: query name: AutoPlacement description: Specify whether to enable or disable auto-placement type: string - in: query name: HostId.N description: The host IDs of the Dedicated Hosts you want to modify type: string responses: 200: description: OK tags: - Host Reservation /?Action=ModifyHosts: get: summary: Modify Hosts description: Modify the auto-placement setting of a Dedicated Host. operationId: modifyhosts x-api-path-slug: actionmodifyhosts-get parameters: - in: query name: Affinity description: The new affinity setting for the instance type: string - in: query name: HostId description: The ID of the Dedicated Host that the instance will have affinity with type: string - in: query name: InstanceId description: The ID of the instance that you are modifying type: string - in: query name: Tenancy description: The tenancy of the instance that you are modifying type: string responses: 200: description: OK tags: - Hosts /?Action=ModifyInstancePlacement: get: summary: Modify Instance Placement description: |- Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting. operationId: modifyinstanceplacement x-api-path-slug: actionmodifyinstanceplacement-get parameters: - in: query name: ClientToken description: Unique, case-sensitive identifier you provide to ensure idempotency of the request type: string - in: query name: CurrencyCode description: The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified type: string - in: query name: HostIdSet.N description: The ID/s of the Dedicated Host/s that the reservation will be associated with type: string - in: query name: LimitPrice description: The specified limit is checked against the total upfront cost of the reservation (calculated as the offerings upfront cost multiplied by the host count) type: string - in: query name: OfferingId description: The ID of the offering type: string responses: 200: description: OK tags: - Server Instance /?Action=PurchaseHostReservation: get: summary: Purchase Host Reservation description: Purchase a reservation with configurations that match those of your Dedicated Host. operationId: purchasehostreservation x-api-path-slug: actionpurchasehostreservation-get parameters: - in: query name: HostId.N description: The IDs of the Dedicated Hosts you want to release type: string responses: 200: description: OK tags: - Host Reservation /?Action=ReleaseHosts: get: summary: Release Hosts description: When you no longer want to use an On-Demand Dedicated Host it can be released. operationId: releasehosts x-api-path-slug: actionreleasehosts-get parameters: - in: query name: DhcpOptionsId description: The ID of the DHCP options set, or default to associate no DHCP options with the VPC type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: VpcId description: The ID of the VPC type: string responses: 200: description: OK tags: - Hosts /?Action=AssociateDhcpOptions: get: summary: Associate Dhcp Options description: Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC. operationId: associatedhcpoptions x-api-path-slug: actionassociatedhcpoptions-get parameters: - in: query name: DhcpConfiguration.N description: A DHCP configuration option type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string responses: 200: description: OK tags: - DHCP /?Action=CreateDhcpOptions: get: summary: Create Dhcp Options description: Creates a set of DHCP options for your VPC. operationId: createdhcpoptions x-api-path-slug: actioncreatedhcpoptions-get parameters: - in: query name: DhcpOptionsId description: The ID of the DHCP options set type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string responses: 200: description: OK tags: - DHCP /?Action=DeleteDhcpOptions: get: summary: Delete Dhcp Options description: Deletes the specified set of DHCP options. operationId: deletedhcpoptions x-api-path-slug: actiondeletedhcpoptions-get parameters: - in: query name: DhcpOptionsId.N description: The IDs of one or more DHCP options sets type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string responses: 200: description: OK tags: - DHCP /?Action=DescribeDhcpOptions: get: summary: Describe Dhcp Options description: Describes one or more of your DHCP options sets. operationId: describedhcpoptions x-api-path-slug: actiondescribedhcpoptions-get parameters: - in: query name: Device description: The device name to expose to the instance (for example, /dev/sdh or xvdh) type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: InstanceId description: The ID of the instance type: string - in: query name: VolumeId description: The ID of the EBS volume type: string responses: 200: description: OK tags: - DHCP /?Action=AttachVolume: get: summary: Attach Volume description: |- Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name. operationId: attachvolume x-api-path-slug: actionattachvolume-get parameters: - in: query name: Description description: A description for the EBS snapshot type: string - in: query name: DestinationRegion description: The destination region to use in the PresignedUrl parameter of a snapshot copy operation type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Encrypted description: Specifies whether the destination snapshot should be encrypted type: string - in: query name: KmsKeyId description: The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy type: string - in: query name: PresignedUrl description: The pre-signed URL that facilitates copying an encrypted snapshot type: string - in: query name: SourceRegion description: The ID of the region that contains the snapshot to be copied type: string - in: query name: SourceSnapshotId description: The ID of the EBS snapshot to copy type: string responses: 200: description: OK tags: - Drive Volume /?Action=CopySnapshot: get: summary: Copy Snapshot description: Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. operationId: copysnapshot x-api-path-slug: actioncopysnapshot-get parameters: - in: query name: Description description: A description for the snapshot type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: VolumeId description: The ID of the EBS volume type: string responses: 200: description: OK tags: - Drive Snapshot /?Action=CreateSnapshot: get: summary: Create Snapshot description: Creates a snapshot of an EBS volume and stores it in Amazon S3. operationId: createsnapshot x-api-path-slug: actioncreatesnapshot-get parameters: - in: query name: AvailabilityZone description: The Availability Zone in which to create the volume type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Encrypted description: Specifies whether the volume should be encrypted type: string - in: query name: Iops description: Only valid for Provisioned IOPS SSD volumes type: string - in: query name: KmsKeyId description: The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume type: string - in: query name: Size description: The size of the volume, in GiBs type: string - in: query name: SnapshotId description: The snapshot from which to create the volume type: string - in: query name: VolumeType description: The volume type type: string responses: 200: description: OK tags: - Snapshot /?Action=CreateVolume: get: summary: Create Volume description: Creates an EBS volume that can be attached to an instance in the same Availability Zone. operationId: createvolume x-api-path-slug: actioncreatevolume-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: SnapshotId description: The ID of the EBS snapshot type: string responses: 200: description: OK tags: - Volume /?Action=DeleteSnapshot: get: summary: Delete Snapshot description: Deletes the specified snapshot. operationId: deletesnapshot x-api-path-slug: actiondeletesnapshot-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: VolumeId description: The ID of the volume type: string responses: 200: description: OK tags: - Snapshot /?Action=DeleteVolume: get: summary: Delete Volume description: Deletes the specified EBS volume. operationId: deletevolume x-api-path-slug: actiondeletevolume-get parameters: - in: query name: Attribute description: The snapshot attribute you would like to view type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: SnapshotId description: The ID of the EBS snapshot type: string responses: 200: description: OK tags: - Volume /?Action=DescribeSnapshotAttribute: get: summary: Describe Snapshot Attribute description: Describes the specified attribute of the specified snapshot. operationId: describesnapshotattribute x-api-path-slug: actiondescribesnapshotattribute-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string - in: query name: MaxResults description: The maximum number of snapshot results returned by DescribeSnapshots in paginated output type: string - in: query name: NextToken description: The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter type: string - in: query name: Owner.N description: Returns the snapshots owned by the specified owner type: string - in: query name: RestorableBy.N description: One or more AWS accounts IDs that can create volumes from the snapshot type: string - in: query name: SnapshotId.N description: One or more snapshot IDs type: string responses: 200: description: OK tags: - Drive Snapshot /?Action=DescribeSnapshots: get: summary: Describe Snapshots description: Describes one or more of the EBS snapshots available to you. operationId: describesnapshots x-api-path-slug: actiondescribesnapshots-get parameters: - in: query name: Attribute description: The instance attribute type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: VolumeId description: The ID of the volume type: string responses: 200: description: OK tags: - Drive Snapshot /?Action=DescribeVolumeAttribute: get: summary: Describe Volume Attribute description: Describes the specified attribute of the specified volume. operationId: describevolumeattribute x-api-path-slug: actiondescribevolumeattribute-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string - in: query name: MaxResults description: The maximum number of volume results returned by DescribeVolumes in paginated output type: string - in: query name: NextToken description: The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter type: string - in: query name: VolumeId.N description: One or more volume IDs type: string responses: 200: description: OK tags: - Volumes /?Action=DescribeVolumes: get: summary: Describe Volumes description: Describes the specified EBS volumes. operationId: describevolumes x-api-path-slug: actiondescribevolumes-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string - in: query name: MaxResults description: The maximum number of volume results returned by DescribeVolumeStatus in paginated output type: string - in: query name: NextToken description: The NextToken value to include in a future DescribeVolumeStatus request type: string - in: query name: VolumeId.N description: One or more volume IDs type: string responses: 200: description: OK tags: - Volumes /?Action=DescribeVolumeStatus: get: summary: Describe Volume Status description: Describes the status of the specified volumes. operationId: describevolumestatus x-api-path-slug: actiondescribevolumestatus-get parameters: - in: query name: Device description: The device name type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Force description: Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally) type: string - in: query name: InstanceId description: The ID of the instance type: string - in: query name: VolumeId description: The ID of the volume type: string responses: 200: description: OK tags: - Volume Status /?Action=DetachVolume: get: summary: Detach Volume description: Detaches an EBS volume from an instance. operationId: detachvolume x-api-path-slug: actiondetachvolume-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: VolumeId description: The ID of the volume type: string responses: 200: description: OK tags: - Volume /?Action=EnableVolumeIO: get: summary: Enable Volume I O description: |- Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. operationId: enablevolumeio x-api-path-slug: actionenablevolumeio-get parameters: - in: query name: Attribute description: The snapshot attribute to modify type: string - in: query name: CreateVolumePermission description: A JSON representation of the snapshot attribute modification type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: OperationType description: The type of operation to perform to the attribute type: string - in: query name: SnapshotId description: The ID of the snapshot type: string - in: query name: UserGroup.N description: The group to modify for the snapshot type: string - in: query name: UserId.N description: The account ID to modify for the snapshot type: string responses: 200: description: OK tags: - Volumes /?Action=ModifySnapshotAttribute: get: summary: Modify Snapshot Attribute description: Adds or removes permission settings for the specified snapshot. operationId: modifysnapshotattribute x-api-path-slug: actionmodifysnapshotattribute-get parameters: - in: query name: AutoEnableIO description: Indicates whether the volume should be auto-enabled for I/O operations type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: VolumeId description: The ID of the volume type: string responses: 200: description: OK tags: - Snapshot /?Action=ModifyVolumeAttribute: get: summary: Modify Volume Attribute description: Modifies a volume attribute. operationId: modifyvolumeattribute x-api-path-slug: actionmodifyvolumeattribute-get parameters: - in: query name: Attribute description: The attribute to reset type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: SnapshotId description: The ID of the snapshot type: string responses: 200: description: OK tags: - Volume /?Action=ResetSnapshotAttribute: get: summary: Reset Snapshot Attribute description: Resets permission settings for the specified snapshot. operationId: resetsnapshotattribute x-api-path-slug: actionresetsnapshotattribute-get parameters: - in: query name: Domain description: Set to vpc to allocate the address for use with instances in a VPC type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string responses: 200: description: OK tags: - Snapshot /?Action=AllocateAddress: get: summary: Allocate Address description: Acquires an Elastic IP address. operationId: allocateaddress x-api-path-slug: actionallocateaddress-get parameters: - in: query name: AllocationId description: '[EC2-VPC] The allocation ID' type: string - in: query name: AllowReassociation description: '[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface' type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: InstanceId description: The ID of the instance type: string - in: query name: NetworkInterfaceId description: '[EC2-VPC] The ID of the network interface' type: string - in: query name: PrivateIpAddress description: '[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address' type: string - in: query name: PublicIp description: The Elastic IP address type: string responses: 200: description: OK tags: - IP Address /?Action=AssociateAddress: get: summary: Associate Address description: Associates an Elastic IP address with an instance or a network interface. operationId: associateaddress x-api-path-slug: actionassociateaddress-get parameters: - in: query name: AllocationId.N description: '[EC2-VPC] One or more allocation IDs' type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string - in: query name: PublicIp.N description: '[EC2-Classic] One or more Elastic IP addresses' type: string responses: 200: description: OK tags: - IP Address /?Action=DescribeAddresses: get: summary: Describe Addresses description: Describes one or more of your Elastic IP addresses. operationId: describeaddresses x-api-path-slug: actiondescribeaddresses-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string - in: query name: MaxResults description: The maximum number of results to return for the request in a single page type: string - in: query name: NextToken description: The token to use to retrieve the next page of results type: string - in: query name: PublicIp.N description: One or more Elastic IP addresses type: string responses: 200: description: OK tags: - IP ADdress /?Action=DescribeMovingAddresses: get: summary: Describe Moving Addresses description: Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. operationId: describemovingaddresses x-api-path-slug: actiondescribemovingaddresses-get parameters: - in: query name: AssociationId description: '[EC2-VPC] The association ID' type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: PublicIp description: '[EC2-Classic] The Elastic IP address' type: string responses: 200: description: OK tags: - IP Address /?Action=DisassociateAddress: get: summary: Disassociate Address description: Disassociates an Elastic IP address from the instance or network interface it's associated with. operationId: disassociateaddress x-api-path-slug: actiondisassociateaddress-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: PublicIp description: The Elastic IP address type: string responses: 200: description: OK tags: - IIP Address /?Action=MoveAddressToVpc: get: summary: Move Address To Vpc description: Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. operationId: moveaddresstovpc x-api-path-slug: actionmoveaddresstovpc-get parameters: - in: query name: AllocationId description: '[EC2-VPC] The allocation ID' type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: PublicIp description: '[EC2-Classic] The Elastic IP address' type: string responses: 200: description: OK tags: - IP Address /?Action=ReleaseAddress: get: summary: Release Address description: Releases the specified Elastic IP address. operationId: releaseaddress x-api-path-slug: actionreleaseaddress-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: PublicIp description: The Elastic IP address type: string responses: 200: description: OK tags: - IP Address /?Action=RestoreAddressToClassic: get: summary: Restore Address To Classic description: Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. operationId: restoreaddresstoclassic x-api-path-slug: actionrestoreaddresstoclassic-get parameters: - in: query name: Ipv6AddressCount description: The number of IPv6 addresses to assign to the network interface type: string - in: query name: Ipv6Addresses.N description: One or more specific IPv6 addresses to be assigned to the network interface type: string - in: query name: NetworkInterfaceId description: The ID of the network interface type: string responses: 200: description: OK tags: - IP ADdress /?Action=AssignIpv6Addresses: get: summary: Assign Ipv6 Addresses description: Assigns one or more IPv6 addresses to the specified network interface. operationId: assignipv6addresses x-api-path-slug: actionassignipv6addresses-get parameters: - in: query name: AllowReassignment description: Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface type: string - in: query name: NetworkInterfaceId description: The ID of the network interface type: string - in: query name: PrivateIpAddress.N description: One or more IP addresses to be assigned as a secondary private IP address to the network interface type: string - in: query name: SecondaryPrivateIpAddressCount description: The number of secondary IP addresses to assign to the network interface type: string responses: 200: description: OK tags: - IP Address /?Action=AssignPrivateIpAddresses: get: summary: Assign Private Ip Addresses description: Assigns one or more secondary private IP addresses to the specified network interface. operationId: assignprivateipaddresses x-api-path-slug: actionassignprivateipaddresses-get parameters: - in: query name: DeviceIndex description: The index of the device for the network interface attachment type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: InstanceId description: The ID of the instance type: string - in: query name: NetworkInterfaceId description: The ID of the network interface type: string responses: 200: description: OK tags: - IP Address /?Action=AttachNetworkInterface: get: summary: Attach Network Interface description: Attaches a network interface to an instance. operationId: attachnetworkinterface x-api-path-slug: actionattachnetworkinterface-get parameters: - in: query name: Description description: A description for the network interface type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Ipv6AddressCount description: The number of IPv6 addresses to assign to a network interface type: string - in: query name: Ipv6Addresses.N description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet type: string - in: query name: PrivateIpAddress description: The primary private IPv4 address of the network interface type: string - in: query name: PrivateIpAddresses.N description: One or more private IPv4 addresses type: string - in: query name: SecondaryPrivateIpAddressCount description: The number of secondary private IPv4 addresses to assign to a network interface type: string - in: query name: SecurityGroupId.N description: The IDs of one or more security groups type: string - in: query name: SubnetId description: The ID of the subnet to associate with the network interface type: string responses: 200: description: OK tags: - Network Interface /?Action=CreateNetworkInterface: get: summary: Create Network Interface description: Creates a network interface in the specified subnet. operationId: createnetworkinterface x-api-path-slug: actioncreatenetworkinterface-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: NetworkInterfaceId description: The ID of the network interface type: string responses: 200: description: OK tags: - Network Interface /?Action=DeleteNetworkInterface: get: summary: Delete Network Interface description: Deletes the specified network interface. operationId: deletenetworkinterface x-api-path-slug: actiondeletenetworkinterface-get parameters: - in: query name: Attribute description: The attribute of the network interface type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: NetworkInterfaceId description: The ID of the network interface type: string responses: 200: description: OK tags: - Network Interface /?Action=DescribeNetworkInterfaceAttribute: get: summary: Describe Network Interface Attribute description: Describes a network interface attribute. operationId: describenetworkinterfaceattribute x-api-path-slug: actiondescribenetworkinterfaceattribute-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string - in: query name: NetworkInterfaceId.N description: One or more network interface IDs type: string responses: 200: description: OK tags: - Network Interface /?Action=DescribeNetworkInterfaces: get: summary: Describe Network Interfaces description: Describes one or more of your network interfaces. operationId: describenetworkinterfaces x-api-path-slug: actiondescribenetworkinterfaces-get parameters: - in: query name: AttachmentId description: The ID of the attachment type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Force description: Specifies whether to force a detachment type: string responses: 200: description: OK tags: - Network Interface /?Action=DetachNetworkInterface: get: summary: Detach Network Interface description: Detaches a network interface from an instance. operationId: detachnetworkinterface x-api-path-slug: actiondetachnetworkinterface-get parameters: - in: query name: Attachment description: Information about the interface attachment type: string - in: query name: Description description: A description for the network interface type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: NetworkInterfaceId description: The ID of the network interface type: string - in: query name: SecurityGroupId.N description: Changes the security groups for the network interface type: string - in: query name: SourceDestCheck description: Indicates whether source/destination checking is enabled type: string responses: 200: description: OK tags: - Network Interface /?Action=ModifyNetworkInterfaceAttribute: get: summary: Modify Network Interface Attribute description: Modifies the specified network interface attribute. operationId: modifynetworkinterfaceattribute x-api-path-slug: actionmodifynetworkinterfaceattribute-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: NetworkInterfaceId description: The ID of the network interface type: string - in: query name: SourceDestCheck description: The source/destination checking attribute type: string responses: 200: description: OK tags: - Network Interface /?Action=ResetNetworkInterfaceAttribute: get: summary: Reset Network Interface Attribute description: Resets a network interface attribute. operationId: resetnetworkinterfaceattribute x-api-path-slug: actionresetnetworkinterfaceattribute-get parameters: - in: query name: Ipv6Addresses.N description: The IPv6 addresses to unassign from the network interface type: string - in: query name: NetworkInterfaceId description: The ID of the network interface type: string responses: 200: description: OK tags: - Network Interface /?Action=UnassignIpv6Addresses: get: summary: Unassign Ipv6 Addresses description: Unassigns one or more IPv6 addresses from a network interface. operationId: unassignipv6addresses x-api-path-slug: actionunassignipv6addresses-get parameters: - in: query name: NetworkInterfaceId description: The ID of the network interface type: string - in: query name: PrivateIpAddress.N description: The secondary private IP addresses to unassign from the network interface type: string responses: 200: description: OK tags: - IPv6 Addresses /?Action=UnassignPrivateIpAddresses: get: summary: Unassign Private Ip Addresses description: Unassigns one or more secondary private IP addresses from a network interface. operationId: unassignprivateipaddresses x-api-path-slug: actionunassignprivateipaddresses-get parameters: - in: query name: Attribute description: The instance attribute type: string - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: InstanceId description: The ID of the instance type: string responses: 200: description: OK tags: - IP ADdress /?Action=DescribeInstanceAttribute: get: summary: Describe Instance Attribute description: Describes the specified attribute of the specified instance. operationId: describeinstanceattribute x-api-path-slug: actiondescribeinstanceattribute-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string - in: query name: InstanceId.N description: One or more instance IDs type: string - in: query name: MaxResults description: The maximum number of results to return in a single call type: string - in: query name: NextToken description: The token to request the next page of results type: string responses: 200: description: OK tags: - Server Instance /?Action=DescribeInstances: get: summary: Describe Instances description: Describes one or more of your instances. operationId: describeinstances x-api-path-slug: actiondescribeinstances-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: Filter.N description: One or more filters type: string - in: query name: IncludeAllInstances description: When true, includes the health status for all instances type: string - in: query name: InstanceId.N description: One or more instance IDs type: string - in: query name: MaxResults description: The maximum number of results to return in a single call type: string - in: query name: NextToken description: The token to retrieve the next page of results type: string responses: 200: description: OK tags: - Server Instance /?Action=DescribeInstanceStatus: get: summary: Describe Instance Status description: Describes the status of one or more instances. operationId: describeinstancestatus x-api-path-slug: actiondescribeinstancestatus-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: InstanceId description: The ID of the instance type: string responses: 200: description: OK tags: - Server Instance Status /?Action=GetConsoleOutput: get: summary: Get Console Output description: Gets the console output for the specified instance. operationId: getconsoleoutput x-api-path-slug: actiongetconsoleoutput-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response type: string - in: query name: InstanceId description: The ID of the instance type: string - in: query name: WakeUp description: When set to true, acts as keystroke input and wakes up an instance thats in standby or sleep mode type: string responses: 200: description: OK tags: - Console Output x-streamrank: polling_total_time_average: 0 polling_size_download_average: 0 streaming_total_time_average: 0 streaming_size_download_average: 0 change_yes: 0 change_no: 0 time_percentage: 0 size_percentage: 0 change_percentage: 0 last_run: "" days_run: 0 minute_run: 0 ---