--- swagger: "2.0" x-collection-name: AWS EC2 x-complete: 0 info: title: AWS EC2 API Create Spot Datafeed Subscription version: 1.0.0 description: Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. 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 /?Action=GetConsoleScreenshot: get: summary: Get Console Screenshot description: Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. operationId: getconsolescreenshot x-api-path-slug: actiongetconsolescreenshot-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 Windows instance type: string responses: 200: description: OK tags: - Console Screenshot /?Action=GetPasswordData: get: summary: Get Password Data description: Retrieves the encrypted administrator password for an instance running Windows. operationId: getpassworddata x-api-path-slug: actiongetpassworddata-get parameters: - in: query name: Attribute description: The name of the attribute type: string - in: query name: BlockDeviceMapping.N description: Modifies the DeleteOnTermination attribute for volumesthat are currently attached type: string - in: query name: DisableApiTermination description: If the value is true, you cant terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can 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: EbsOptimized description: Specifies whether the instance is optimized for EBS I/O type: string - in: query name: EnaSupport description: Set to true to enable enhanced networking with ENA for the instance type: string - in: query name: GroupId.N description: '[EC2-VPC] Changes the security groups of the instance' type: string - in: query name: InstanceId description: The ID of the instance type: string - in: query name: InstanceInitiatedShutdownBehavior description: Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown) type: string - in: query name: InstanceType description: Changes the instance type to the specified value type: string - in: query name: Kernel description: Changes the instances kernel to the specified value type: string - in: query name: Ramdisk description: Changes the instances RAM disk to the specified value type: string - in: query name: SourceDestCheck description: Specifies whether source/destination checking is enabled type: string - in: query name: SriovNetSupport description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance type: string - in: query name: UserData description: Changes the instances user data to the specified value type: string - in: query name: Value description: A new value for the attribute type: string responses: 200: description: OK tags: - Password Data /?Action=ModifyInstanceAttribute: get: summary: Modify Instance Attribute description: Modifies the specified attribute of the specified instance. operationId: modifyinstanceattribute x-api-path-slug: actionmodifyinstanceattribute-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.N description: One or more instance IDs type: string responses: 200: description: OK tags: - Server Instance /?Action=MonitorInstances: get: summary: Monitor Instances description: Enables detailed monitoring for a running instance. operationId: monitorinstances x-api-path-slug: actionmonitorinstances-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.N description: One or more instance IDs type: string responses: 200: description: OK tags: - Monitor Instance /?Action=RebootInstances: get: summary: Reboot Instances description: Requests a reboot of one or more instances. operationId: rebootinstances x-api-path-slug: actionrebootinstances-get parameters: - in: query name: Description description: Descriptive text about the health state of your instance 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: EndTime description: The time at which the reported instance health state ended type: string - in: query name: InstanceId.N description: One or more instances type: string - in: query name: ReasonCode.N description: One or more reason codes that describes the health state of your instance type: string - in: query name: StartTime description: The time at which the reported instance health state began type: string - in: query name: Status description: The status of all instances listed type: string responses: 200: description: OK tags: - Instance /?Action=ReportInstanceStatus: get: summary: Report Instance Status description: Submits feedback about the status of an instance. operationId: reportinstancestatus x-api-path-slug: actionreportinstancestatus-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: InstanceId description: The ID of the instance type: string responses: 200: description: OK tags: - Server Instance /?Action=ResetInstanceAttribute: get: summary: Reset Instance Attribute description: Resets an attribute of an instance to its default value. operationId: resetinstanceattribute x-api-path-slug: actionresetinstanceattribute-get parameters: - in: query name: AdditionalInfo description: Reserved type: string - in: query name: BlockDeviceMapping.N description: The block device mapping type: string - in: query name: ClientToken description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request type: string - in: query name: DisableApiTermination description: If you set this parameter to true, you cant terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can 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: EbsOptimized description: Indicates whether the instance is optimized for EBS I/O type: string - in: query name: IamInstanceProfile description: The IAM instance profile type: string - in: query name: ImageId description: The ID of the AMI, which you can get by calling DescribeImages type: string - in: query name: InstanceInitiatedShutdownBehavior description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown) type: string - in: query name: InstanceType description: The instance type type: string - in: query name: Ipv6Address.N description: '[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface' type: string - in: query name: Ipv6AddressCount description: '[EC2-VPC] A number of IPv6 addresses to associate with the primary network interface' type: string - in: query name: KernelId description: The ID of the kernel type: string - in: query name: KeyName description: The name of the key pair type: string - in: query name: MaxCount description: The maximum number of instances to launch type: string - in: query name: MinCount description: The minimum number of instances to launch type: string - in: query name: Monitoring description: The monitoring for the instance type: string - in: query name: NetworkInterface.N description: One or more network interfaces type: string - in: query name: Placement description: The placement for the instance type: string - in: query name: PrivateIpAddress description: '[EC2-VPC] The primary IPv4 address' type: string - in: query name: RamdiskId description: The ID of the RAM disk type: string - in: query name: SecurityGroup.N description: '[EC2-Classic, default VPC] One or more security group names' type: string - in: query name: SecurityGroupId.N description: One or more security group IDs type: string - in: query name: SubnetId description: '[EC2-VPC] The ID of the subnet to launch the instance into' type: string - in: query name: UserData description: The user data to make available to the instance type: string responses: 200: description: OK tags: - Server Instance /?Action=RunInstances: get: summary: Run Instances description: |- Launches the specified number of instances using an AMI for which you have permissions. operationId: runinstances x-api-path-slug: actionruninstances-get parameters: - in: query name: AdditionalInfo description: Reserved 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.N description: One or more instance IDs type: string responses: 200: description: OK tags: - Server Instances /?Action=StartInstances: get: summary: Start Instances description: Starts an Amazon EBS-backed AMI that you've previously stopped. operationId: startinstances x-api-path-slug: actionstartinstances-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: Force description: Forces the instances to stop type: string - in: query name: InstanceId.N description: One or more instance IDs type: string responses: 200: description: OK tags: - Server Instances /?Action=StopInstances: get: summary: Stop Instances description: Stops an Amazon EBS-backed instance. operationId: stopinstances x-api-path-slug: actionstopinstances-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.N description: One or more instance IDs type: string responses: 200: description: OK tags: - Server Instances /?Action=TerminateInstances: get: summary: Terminate Instances description: Shuts down one or more instances. operationId: terminateinstances x-api-path-slug: actionterminateinstances-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.N description: One or more instance IDs type: string responses: 200: description: OK tags: - Terminal Instances /?Action=UnmonitorInstances: get: summary: Unmonitor Instances description: Disables detailed monitoring for a running instance. operationId: unmonitorinstances x-api-path-slug: actionunmonitorinstances-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: InternetGatewayId description: The ID of the Internet gateway type: string - in: query name: VpcId description: The ID of the VPC type: string responses: 200: description: OK tags: - Server Instance /?Action=AttachInternetGateway: get: summary: Attach Internet Gateway description: "Attaches an Internet gateway to a VPC, enabling connectivity between the Internet\n\t\t\t\tand the VPC." operationId: attachinternetgateway x-api-path-slug: actionattachinternetgateway-get parameters: - in: query name: ClientToken description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request 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 for which to create the egress-only Internet gateway type: string responses: 200: description: OK tags: - Internet Gateway /?Action=CreateEgressOnlyInternetGateway: get: summary: Create Egress Only Internet Gateway description: '[IPv6 only] Creates an egress-only Internet gateway for your VPC.' operationId: createegressonlyinternetgateway x-api-path-slug: actioncreateegressonlyinternetgateway-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 responses: 200: description: OK tags: - Internet Gateway /?Action=CreateInternetGateway: get: summary: Create Internet Gateway description: Creates an Internet gateway for use with a VPC. operationId: createinternetgateway x-api-path-slug: actioncreateinternetgateway-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: EgressOnlyInternetGatewayId description: The ID of the egress-only Internet gateway type: string responses: 200: description: OK tags: - Internet Gateway /?Action=DeleteEgressOnlyInternetGateway: get: summary: Delete Egress Only Internet Gateway description: Deletes an egress-only Internet gateway. operationId: deleteegressonlyinternetgateway x-api-path-slug: actiondeleteegressonlyinternetgateway-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: InternetGatewayId description: The ID of the Internet gateway type: string responses: 200: description: OK tags: - Internet Gateway /?Action=DeleteInternetGateway: get: summary: Delete Internet Gateway description: Deletes the specified Internet gateway. operationId: deleteinternetgateway x-api-path-slug: actiondeleteinternetgateway-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: EgressOnlyInternetGatewayId.N description: One or more egress-only Internet gateway 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: - Internet Gateway /?Action=DescribeEgressOnlyInternetGateways: get: summary: Describe Egress Only Internet Gateways description: Describes one or more of your egress-only Internet gateways. operationId: describeegressonlyinternetgateways x-api-path-slug: actiondescribeegressonlyinternetgateways-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: InternetGatewayId.N description: One or more Internet gateway IDs type: string responses: 200: description: OK tags: - Internet Gateway /?Action=DescribeInternetGateways: get: summary: Describe Internet Gateways description: Describes one or more of your Internet gateways. operationId: describeinternetgateways x-api-path-slug: actiondescribeinternetgateways-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: InternetGatewayId description: The ID of the Internet gateway type: string - in: query name: VpcId description: The ID of the VPC type: string responses: 200: description: OK tags: - Internet Gateways /?Action=DetachInternetGateway: get: summary: Detach Internet Gateway description: Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. operationId: detachinternetgateway x-api-path-slug: actiondetachinternetgateway-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: KeyName description: A unique name for the key pair type: string responses: 200: description: OK tags: - Internet Gateway /?Action=CreateKeyPair: get: summary: Create Key Pair description: Creates a 2048-bit RSA key pair with the specified name. operationId: createkeypair x-api-path-slug: actioncreatekeypair-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: KeyName description: The name of the key pair type: string responses: 200: description: OK tags: - Key Pair /?Action=DeleteKeyPair: get: summary: Delete Key Pair description: Deletes the specified key pair, by removing the public key from Amazon EC2. operationId: deletekeypair x-api-path-slug: actiondeletekeypair-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: KeyName.N description: One or more key pair names type: string responses: 200: description: OK tags: - Key Pair /?Action=DescribeKeyPairs: get: summary: Describe Key Pairs description: Describes one or more of your key pairs. operationId: describekeypairs x-api-path-slug: actiondescribekeypairs-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: KeyName description: A unique name for the key pair type: string - in: query name: PublicKeyMaterial description: The public key type: string responses: 200: description: OK tags: - Key Paris /?Action=ImportKeyPair: get: summary: Import Key Pair description: Imports the public key from an RSA key pair that you created with a third-party tool. operationId: importkeypair x-api-path-slug: actionimportkeypair-get parameters: - in: query name: AllocationId description: The allocation ID of an Elastic IP address to associate with the NAT gateway type: string - in: query name: ClientToken description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request type: string - in: query name: SubnetId description: The subnet in which to create the NAT gateway type: string responses: 200: description: OK tags: - Key Pair /?Action=CreateNatGateway: get: summary: Create Nat Gateway description: Creates a NAT gateway in the specified subnet. operationId: createnatgateway x-api-path-slug: actioncreatenatgateway-get parameters: - in: query name: NatGatewayId description: The ID of the NAT gateway type: string responses: 200: description: OK tags: - Gateway /?Action=DeleteNatGateway: get: summary: Delete Nat Gateway description: Deletes the specified NAT gateway. operationId: deletenatgateway x-api-path-slug: actiondeletenatgateway-get parameters: - in: query name: Filter.N description: One or more filters type: string - in: query name: MaxResults description: The maximum number of items to return for this request type: string - in: query name: NatGatewayId.N description: One or more NAT gateway IDs type: string - in: query name: NextToken description: The token to retrieve the next page of results type: string responses: 200: description: OK tags: - Gateway /?Action=DescribeNatGateways: get: summary: Describe Nat Gateways description: Describes one or more of the your NAT gateways. operationId: describenatgateways x-api-path-slug: actiondescribenatgateways-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: - NAT Gateways /?Action=CreateNetworkAcl: get: summary: Create Network Acl description: Creates a network ACL in a VPC. operationId: createnetworkacl x-api-path-slug: actioncreatenetworkacl-get parameters: - in: query name: CidrBlock description: The IPv4 network range to allow or deny, in CIDR notation (for example 172 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: Egress description: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet) type: string - in: query name: Icmp description: 'ICMP protocol: The ICMP or ICMPv6 type and code' type: string - in: query name: Ipv6CidrBlock description: The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64) type: string - in: query name: NetworkAclId description: The ID of the network ACL type: string - in: query name: PortRange description: 'TCP or UDP protocols: The range of ports the rule applies to' type: string - in: query name: Protocol description: The protocol type: string - in: query name: RuleAction description: Indicates whether to allow or deny the traffic that matches the rule type: string - in: query name: RuleNumber description: The rule number for the entry (for example, 100) type: string responses: 200: description: OK tags: - VPC ACL /?Action=CreateNetworkAclEntry: get: summary: Create Network Acl Entry description: Creates an entry (a rule) in a network ACL with the specified rule number. operationId: createnetworkaclentry x-api-path-slug: actioncreatenetworkaclentry-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: NetworkAclId description: The ID of the network ACL type: string responses: 200: description: OK tags: - VPC ACL /?Action=DeleteNetworkAcl: get: summary: Delete Network Acl description: Deletes the specified network ACL. operationId: deletenetworkacl x-api-path-slug: actiondeletenetworkacl-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: Egress description: Indicates whether the rule is an egress rule type: string - in: query name: NetworkAclId description: The ID of the network ACL type: string - in: query name: RuleNumber description: The rule number of the entry to delete type: string responses: 200: description: OK tags: - Network ACL /?Action=DeleteNetworkAclEntry: get: summary: Delete Network Acl Entry description: Deletes the specified ingress or egress entry (rule) from the specified network ACL. operationId: deletenetworkaclentry x-api-path-slug: actiondeletenetworkaclentry-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: NetworkAclId.N description: One or more network ACL IDs type: string responses: 200: description: OK tags: - Network ACL /?Action=DescribeNetworkAcls: get: summary: Describe Network Acls description: Describes one or more of your network ACLs. operationId: describenetworkacls x-api-path-slug: actiondescribenetworkacls-get parameters: - in: query name: AssociationId description: The ID of the current association between the original network ACL and the subnet 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: NetworkAclId description: The ID of the new network ACL to associate with the subnet type: string responses: 200: description: OK tags: - Network ACL /?Action=ReplaceNetworkAclAssociation: get: summary: Replace Network Acl Association description: Changes which network ACL a subnet is associated with. operationId: replacenetworkaclassociation x-api-path-slug: actionreplacenetworkaclassociation-get parameters: - in: query name: CidrBlock description: The IPv4 network range to allow or deny, in CIDR notation (for example 172 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: Egress description: Indicates whether to replace the egress rule type: string - in: query name: Icmp description: 'ICMP protocol: The ICMP or ICMPv6 type and code' type: string - in: query name: Ipv6CidrBlock description: The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64) type: string - in: query name: NetworkAclId description: The ID of the ACL type: string - in: query name: PortRange description: 'TCP or UDP protocols: The range of ports the rule applies to' type: string - in: query name: Protocol description: The IP protocol type: string - in: query name: RuleAction description: Indicates whether to allow or deny the traffic that matches the rule type: string - in: query name: RuleNumber description: The rule number of the entry to replace type: string responses: 200: description: OK tags: - Network ACL /?Action=ReplaceNetworkAclEntry: get: summary: Replace Network Acl Entry description: Replaces an entry (rule) in a network ACL. operationId: replacenetworkaclentry x-api-path-slug: actionreplacenetworkaclentry-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: GroupName description: A name for the placement group type: string - in: query name: Strategy description: The placement strategy type: string responses: 200: description: OK tags: - Network ACL /?Action=CreatePlacementGroup: get: summary: Create Placement Group description: Creates a placement group that you launch cluster instances into. operationId: createplacementgroup x-api-path-slug: actioncreateplacementgroup-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: GroupName description: The name of the placement group type: string responses: 200: description: OK tags: - Placement Group /?Action=DeletePlacementGroup: get: summary: Delete Placement Group description: Deletes the specified placement group. operationId: deleteplacementgroup x-api-path-slug: actiondeleteplacementgroup-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: GroupName.N description: One or more placement group names type: string responses: 200: description: OK tags: - Placement Group /?Action=DescribePlacementGroups: get: summary: Describe Placement Groups description: Describes one or more of your placement groups. operationId: describeplacementgroups x-api-path-slug: actiondescribeplacementgroups-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: ZoneName.N description: The names of one or more Availability Zones type: string responses: 200: description: OK tags: - Placement Groups /?Action=DescribeAvailabilityZones: get: summary: Describe Availability Zones description: Describes one or more of the Availability Zones that are available to you. operationId: describeavailabilityzones x-api-path-slug: actiondescribeavailabilityzones-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: RegionName.N description: The names of one or more regions type: string responses: 200: description: OK tags: - Availability Zones /?Action=DescribeRegions: get: summary: Describe Regions description: Describes one or more regions that are currently available to you. operationId: describeregions x-api-path-slug: actiondescriberegions-get responses: 200: description: OK tags: - Regions /?Action=AcceptReservedInstancesExchangeQuote: get: summary: Accept Reserved Instances Exchange Quote description: Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call. operationId: acceptreservedinstancesexchangequote x-api-path-slug: actionacceptreservedinstancesexchangequote-get parameters: - in: query name: ReservedInstancesListingId description: The ID of the Reserved Instance listing type: string responses: 200: description: OK tags: - Reserved Instances /?Action=CancelReservedInstancesListing: get: summary: Cancel Reserved Instances Listing description: Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. operationId: cancelreservedinstanceslisting x-api-path-slug: actioncancelreservedinstanceslisting-get parameters: - in: query name: ClientToken description: Unique, case-sensitive identifier you provide to ensure idempotency of yourlistings type: string - in: query name: InstanceCount description: The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace type: string - in: query name: PriceSchedules.N description: A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term type: string - in: query name: ReservedInstancesId description: The ID of the active Standard Reserved Instance type: string responses: 200: description: OK tags: - Reserved Instance /?Action=CreateReservedInstancesListing: get: summary: Create Reserved Instances Listing description: "Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance\n\t\t\tMarketplace." operationId: createreservedinstanceslisting x-api-path-slug: actioncreatereservedinstanceslisting-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: OfferingClass description: Describes whether the Reserved Instance is Standard or Convertible type: string - in: query name: OfferingType description: The Reserved Instance offering type type: string - in: query name: ReservedInstancesId.N description: One or more Reserved Instance IDs type: string responses: 200: description: OK tags: - Reserved Instance /?Action=DescribeReservedInstances: get: summary: Describe Reserved Instances description: Describes one or more of the Reserved Instances that you purchased. operationId: describereservedinstances x-api-path-slug: actiondescribereservedinstances-get parameters: - in: query name: Filter.N description: One or more filters type: string - in: query name: ReservedInstancesId description: One or more Reserved Instance IDs type: string - in: query name: ReservedInstancesListingId description: One or more Reserved Instance listing IDs type: string responses: 200: description: OK tags: - Reserved Instances /?Action=DescribeReservedInstancesListings: get: summary: Describe Reserved Instances Listings description: Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. operationId: describereservedinstanceslistings x-api-path-slug: actiondescribereservedinstanceslistings-get parameters: - in: query name: Filter.N description: One or more filters type: string - in: query name: NextToken description: The token to retrieve the next page of results type: string - in: query name: ReservedInstancesModificationId.N description: IDs for the submitted modification request type: string responses: 200: description: OK tags: - Reserved Instances /?Action=DescribeReservedInstancesModifications: get: summary: Describe Reserved Instances Modifications description: Describes the modifications made to your Reserved Instances. operationId: describereservedinstancesmodifications x-api-path-slug: actiondescribereservedinstancesmodifications-get parameters: - in: query name: AvailabilityZone description: The Availability Zone in which the Reserved Instance can be used 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: IncludeMarketplace description: Include Reserved Instance Marketplace offerings in the response type: string - in: query name: InstanceTenancy description: The tenancy of the instances covered by the reservation type: string - in: query name: InstanceType description: The instance type that the reservation will cover (for example, m1 type: string - in: query name: MaxDuration description: The maximum duration (in seconds) to filter when searching for offerings type: string - in: query name: MaxInstanceCount description: The maximum number of instances to filter when searching for offerings 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: The minimum duration (in seconds) to filter when searching for offerings type: string - in: query name: NextToken description: The token to retrieve the next page of results type: string - in: query name: OfferingClass description: The offering class of the Reserved Instance type: string - in: query name: OfferingType description: The Reserved Instance offering type type: string - in: query name: ProductDescription description: The Reserved Instance product platform description type: string - in: query name: ReservedInstancesOfferingId.N description: One or more Reserved Instances offering IDs type: string responses: 200: description: OK tags: - Reserved Instances /?Action=DescribeReservedInstancesOfferings: get: summary: Describe Reserved Instances Offerings description: Describes Reserved Instance offerings that are available for purchase. operationId: describereservedinstancesofferings x-api-path-slug: actiondescribereservedinstancesofferings-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: ReservedInstanceId.N description: The IDs of the Convertible Reserved Instances to exchange type: string - in: query name: TargetConfiguration.N description: The configuration requirements of the Convertible Reserved Instances to exchange for your current Convertible Reserved Instances type: string responses: 200: description: OK tags: - Reserved Instances /?Action=GetReservedInstancesExchangeQuote: get: summary: Get Reserved Instances Exchange Quote description: Returns details about the values and term of your specified Convertible Reserved Instances. operationId: getreservedinstancesexchangequote x-api-path-slug: actiongetreservedinstancesexchangequote-get parameters: - in: query name: ClientToken description: A unique, case-sensitive token you provide to ensure idempotency of your modification request type: string - in: query name: ReservedInstancesConfigurationSetItemType.N description: The configuration settings for the Reserved Instances to modify type: string - in: query name: ReservedInstancesId.N description: The IDs of the Reserved Instances to modify type: string responses: 200: description: OK tags: - Reserved Instances /?Action=ModifyReservedInstances: get: summary: Modify Reserved Instances description: Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Standard Reserved Instances. operationId: modifyreservedinstances x-api-path-slug: actionmodifyreservedinstances-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: InstanceCount description: The number of Reserved Instances to purchase type: string - in: query name: LimitPrice description: Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices type: string - in: query name: ReservedInstancesOfferingId description: The ID of the Reserved Instance offering to purchase type: string responses: 200: description: OK tags: - Reserved Instance /?Action=PurchaseReservedInstancesOffering: get: summary: Purchase Reserved Instances Offering description: Purchases a Reserved Instance for use with your account. operationId: purchasereservedinstancesoffering x-api-path-slug: actionpurchasereservedinstancesoffering-get parameters: - in: query name: PrincipalArn description: The ARN of the principal, which can be an IAM role, IAM user, or the root user type: string - in: query name: Resource description: 'The type of resource: instance | reservation | snapshot | volume' type: string responses: 200: description: OK tags: - Reserved Instance /?Action=DescribeIdentityIdFormat: get: summary: Describe Identity Id Format description: |- Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. operationId: describeidentityidformat x-api-path-slug: actiondescribeidentityidformat-get parameters: - in: query name: Resource description: 'The type of resource: instance | reservation | snapshot | volume' type: string responses: 200: description: OK tags: - Identity Format /?Action=DescribeIdFormat: get: summary: Describe Id Format description: Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. operationId: describeidformat x-api-path-slug: actiondescribeidformat-get parameters: - in: query name: PrincipalArn description: The ARN of the principal, which can be an IAM user, IAM role, or the root user type: string - in: query name: Resource description: 'The type of resource: instance | reservation | snapshot | volume' type: string - in: query name: UseLongIds description: Indicates whether the resource should use longer IDs (17-character IDs) type: string responses: 200: description: OK tags: - Identity Format /?Action=ModifyIdentityIdFormat: get: summary: Modify Identity Id Format description: |- Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. operationId: modifyidentityidformat x-api-path-slug: actionmodifyidentityidformat-get parameters: - in: query name: Resource description: 'The type of resource: instance | reservation | snapshot | volume' type: string - in: query name: UseLongIds description: Indicate whether the resource should use longer IDs (17-character IDs) type: string responses: 200: description: OK tags: - Identity Format /?Action=ModifyIdFormat: get: summary: Modify Id Format description: Modifies the ID format for the specified resource on a per-region basis. operationId: modifyidformat x-api-path-slug: actionmodifyidformat-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: RouteTableId description: The ID of the route table type: string - in: query name: SubnetId description: The ID of the subnet type: string responses: 200: description: OK tags: - Identity Format /?Action=AssociateRouteTable: get: summary: Associate Route Table description: Associates a subnet with a route table. operationId: associateroutetable x-api-path-slug: actionassociateroutetable-get parameters: - in: query name: DestinationCidrBlock description: The IPv4 CIDR address block used for the destination match type: string - in: query name: DestinationIpv6CidrBlock description: The IPv6 CIDR block used for the destination match 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: EgressOnlyInternetGatewayId description: '[IPv6 traffic only] The ID of an egress-only Internet gateway' type: string - in: query name: GatewayId description: The ID of an Internet gateway or virtual private gateway attached to your VPC type: string - in: query name: InstanceId description: The ID of a NAT instance in your VPC type: string - in: query name: NatGatewayId description: '[IPv4 traffic only] The ID of a NAT gateway' type: string - in: query name: NetworkInterfaceId description: The ID of a network interface type: string - in: query name: RouteTableId description: The ID of the route table for the route type: string - in: query name: VpcPeeringConnectionId description: The ID of a VPC peering connection type: string responses: 200: description: OK tags: - Route Table /?Action=CreateRoute: get: summary: Create Route description: Creates a route in a route table within a VPC. operationId: createroute x-api-path-slug: actioncreateroute-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: - Route Table /?Action=CreateRouteTable: get: summary: Create Route Table description: Creates a route table for the specified VPC. operationId: createroutetable x-api-path-slug: actioncreateroutetable-get parameters: - in: query name: DestinationCidrBlock description: The IPv4 CIDR range for the route type: string - in: query name: DestinationIpv6CidrBlock description: The IPv6 CIDR range for the route 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: RouteTableId description: The ID of the route table type: string responses: 200: description: OK tags: - Route Table /?Action=DeleteRoute: get: summary: Delete Route description: Deletes the specified route from the specified route table. operationId: deleteroute x-api-path-slug: actiondeleteroute-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: RouteTableId description: The ID of the route table type: string responses: 200: description: OK tags: - Route /?Action=DeleteRouteTable: get: summary: Delete Route Table description: Deletes the specified route table. operationId: deleteroutetable x-api-path-slug: actiondeleteroutetable-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: RouteTableId.N description: One or more route table IDs type: string responses: 200: description: OK tags: - Route Table /?Action=DescribeRouteTables: get: summary: Describe Route Tables description: Describes one or more of your route tables. operationId: describeroutetables x-api-path-slug: actiondescriberoutetables-get parameters: - in: query name: GatewayId description: The ID of the virtual private gateway type: string - in: query name: RouteTableId description: The ID of the route table type: string responses: 200: description: OK tags: - Route Tables /?Action=DisableVgwRoutePropagation: get: summary: Disable Vgw Route Propagation description: Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. operationId: disablevgwroutepropagation x-api-path-slug: actiondisablevgwroutepropagation-get parameters: - in: query name: AssociationId description: The association ID representing the current association between the route table and subnet 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: - Virtual Private Gateway /?Action=DisassociateRouteTable: get: summary: Disassociate Route Table description: Disassociates a subnet from a route table. operationId: disassociateroutetable x-api-path-slug: actiondisassociateroutetable-get parameters: - in: query name: GatewayId description: The ID of the virtual private gateway type: string - in: query name: RouteTableId description: The ID of the route table type: string responses: 200: description: OK tags: - Route Table /?Action=EnableVgwRoutePropagation: get: summary: Enable Vgw Route Propagation description: Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. operationId: enablevgwroutepropagation x-api-path-slug: actionenablevgwroutepropagation-get parameters: - in: query name: DestinationCidrBlock description: The IPv4 CIDR address block used for the destination match type: string - in: query name: DestinationIpv6CidrBlock description: The IPv6 CIDR address block used for the destination match 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: EgressOnlyInternetGatewayId description: '[IPv6 traffic only] The ID of an egress-only Internet gateway' type: string - in: query name: GatewayId description: The ID of an Internet gateway or virtual private gateway type: string - in: query name: InstanceId description: The ID of a NAT instance in your VPC type: string - in: query name: NatGatewayId description: '[IPv4 traffic only] The ID of a NAT gateway' type: string - in: query name: NetworkInterfaceId description: The ID of a network interface type: string - in: query name: RouteTableId description: The ID of the route table type: string - in: query name: VpcPeeringConnectionId description: The ID of a VPC peering connection type: string responses: 200: description: OK tags: - Virtual Private Gateway Route Propogation /?Action=ReplaceRoute: get: summary: Replace Route description: Replaces an existing route within a route table in a VPC. operationId: replaceroute x-api-path-slug: actionreplaceroute-get parameters: - in: query name: AssociationId description: 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: RouteTableId description: The ID of the new route table to associate with the subnet type: string responses: 200: description: OK tags: - Route /?Action=ReplaceRouteTableAssociation: get: summary: Replace Route Table Association description: Changes the route table associated with a given subnet in a VPC. operationId: replaceroutetableassociation x-api-path-slug: actionreplaceroutetableassociation-get responses: 200: description: OK tags: - Route Table /?Action=DescribeScheduledInstanceAvailability: get: summary: Describe Scheduled Instance Availability description: Finds available schedules that meet the specified criteria. operationId: describescheduledinstanceavailability x-api-path-slug: actiondescribescheduledinstanceavailability-get responses: 200: description: OK tags: - Server Instance Availability /?Action=DescribeScheduledInstances: get: summary: Describe Scheduled Instances description: Describes one or more of your Scheduled Instances. operationId: describescheduledinstances x-api-path-slug: actiondescribescheduledinstances-get responses: 200: description: OK tags: - Scheduled Server Instances /?Action=PurchaseScheduledInstances: get: summary: Purchase Scheduled Instances description: Purchases one or more Scheduled Instances with the specified schedule. operationId: purchasescheduledinstances x-api-path-slug: actionpurchasescheduledinstances-get responses: 200: description: OK tags: - Scheduled Instance /?Action=RunScheduledInstances: get: summary: Run Scheduled Instances description: Launches the specified Scheduled Instances. operationId: runscheduledinstances x-api-path-slug: actionrunscheduledinstances-get parameters: - in: query name: CidrIp description: The CIDR IPv4 address range 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: FromPort description: The start of port range for the TCP and UDP protocols, or an ICMP type number type: string - in: query name: GroupId description: The ID of the security group type: string - in: query name: IpPermissions.N description: A set of IP permissions type: string - in: query name: IpProtocol description: The IP protocol name or number type: string - in: query name: SourceSecurityGroupName description: The name of a destination security group type: string - in: query name: SourceSecurityGroupOwnerId description: The AWS account number for a destination security group type: string - in: query name: ToPort description: The end of port range for the TCP and UDP protocols, or an ICMP type number type: string responses: 200: description: OK tags: - Scheduled Instances /?Action=AuthorizeSecurityGroupEgress (EC2-VPC only): get: summary: Authorize Security Group Egress ( E C2- V P C only) description: '[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC.' operationId: authorizesecuritygroupegress-ec2vpc-only x-api-path-slug: actionauthorizesecuritygroupegress-ec2vpc-only-get parameters: - in: query name: CidrIp description: The CIDR IPv4 address range 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: FromPort description: The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number type: string - in: query name: GroupId description: The ID of the security group type: string - in: query name: GroupName description: '[EC2-Classic, default VPC] The name of the security group' type: string - in: query name: IpPermissions.N description: A set of IP permissions type: string - in: query name: IpProtocol description: The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers) type: string - in: query name: SourceSecurityGroupName description: '[EC2-Classic, default VPC] The name of the source security group' type: string - in: query name: SourceSecurityGroupOwnerId description: '[EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account' type: string - in: query name: ToPort description: The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code number type: string responses: 200: description: OK tags: - Security Group /?Action=AuthorizeSecurityGroupIngress: get: summary: Authorize Security Group Ingress description: Adds one or more ingress rules to a security group. operationId: authorizesecuritygroupingress x-api-path-slug: actionauthorizesecuritygroupingress-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: GroupDescription description: A description for the security group type: string - in: query name: GroupName description: The name of the security group type: string - in: query name: VpcId description: '[EC2-VPC] The ID of the VPC' type: string responses: 200: description: OK tags: - Security Group /?Action=CreateSecurityGroup: get: summary: Create Security Group description: Creates a security group. operationId: createsecuritygroup x-api-path-slug: actioncreatesecuritygroup-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: GroupId description: The ID of the security group type: string - in: query name: GroupName description: '[EC2-Classic, default VPC] The name of the security group' type: string responses: 200: description: OK tags: - Security Group /?Action=DeleteSecurityGroup: get: summary: Delete Security Group description: Deletes a security group. operationId: deletesecuritygroup x-api-path-slug: actiondeletesecuritygroup-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response type: string - in: query name: GroupId.N description: One or more security group IDs in your account type: string responses: 200: description: OK tags: - Security Group /?Action=DescribeSecurityGroupReferences (EC2-VPC only): get: summary: Describe Security Group References ( E C2- V P C only) description: '[EC2-VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you''ve specified in this request.' operationId: describesecuritygroupreferences-ec2vpc-only x-api-path-slug: actiondescribesecuritygroupreferences-ec2vpc-only-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: GroupId.N description: One or more security group IDs type: string - in: query name: GroupName.N description: '[EC2-Classic and default VPC only] One or more security group names' type: string responses: 200: description: OK tags: - Security Group /?Action=DescribeSecurityGroups: get: summary: Describe Security Groups description: Describes one or more of your security groups. operationId: describesecuritygroups x-api-path-slug: actiondescribesecuritygroups-get parameters: - in: query name: DryRun description: Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response type: string - 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: VpcId description: The ID of the VPC type: string responses: 200: description: OK tags: - Security Group /?Action=DescribeStaleSecurityGroups (EC2-VPC only): get: summary: Describe Stale Security Groups ( E C2- V P C only) description: '[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC.' operationId: describestalesecuritygroups-ec2vpc-only x-api-path-slug: actiondescribestalesecuritygroups-ec2vpc-only-get parameters: - in: query name: CidrIp description: The CIDR IP address range 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: FromPort description: The start of port range for the TCP and UDP protocols, or an ICMP type number type: string - in: query name: GroupId description: The ID of the security group type: string - in: query name: IpPermissions.N description: A set of IP permissions type: string - in: query name: IpProtocol description: The IP protocol name or number type: string - in: query name: SourceSecurityGroupName description: The name of a destination security group type: string - in: query name: SourceSecurityGroupOwnerId description: The AWS account number for a destination security group type: string - in: query name: ToPort description: The end of port range for the TCP and UDP protocols, or an ICMP type number type: string responses: 200: description: OK tags: - Security Groups /?Action=RevokeSecurityGroupEgress (EC2-VPC only): get: summary: Revoke Security Group Egress ( E C2- V P C only) description: '[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC.' operationId: revokesecuritygroupegress-ec2vpc-only x-api-path-slug: actionrevokesecuritygroupegress-ec2vpc-only-get parameters: - in: query name: CidrIp description: The CIDR IP address range 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: FromPort description: The start of port range for the TCP and UDP protocols, or an ICMP type number type: string - in: query name: GroupId description: The ID of the security group type: string - in: query name: GroupName description: '[EC2-Classic, default VPC] The name of the security group' type: string - in: query name: IpPermissions.N description: A set of IP permissions type: string - in: query name: IpProtocol description: The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers) type: string - in: query name: SourceSecurityGroupName description: '[EC2-Classic, default VPC] The name of the source security group' type: string - in: query name: SourceSecurityGroupOwnerId description: '[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account' type: string - in: query name: ToPort description: The end of port range for the TCP and UDP protocols, or an ICMP code number type: string responses: 200: description: OK tags: - Security Groups /?Action=RevokeSecurityGroupIngress: get: summary: Revoke Security Group Ingress description: Removes one or more ingress rules from a security group. operationId: revokesecuritygroupingress x-api-path-slug: actionrevokesecuritygroupingress-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: SpotInstanceRequestId.N description: One or more Spot instance request IDs type: string responses: 200: description: OK tags: - Security Groups /?Action=CancelSpotInstanceRequests: get: summary: Cancel Spot Instance Requests description: Cancels one or more Spot instance requests. operationId: cancelspotinstancerequests x-api-path-slug: actioncancelspotinstancerequests-get parameters: - in: query name: Bucket description: The Amazon S3 bucket in which to store the Spot instance data feed 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: Prefix description: A prefix for the data feed file names type: string responses: 200: description: OK tags: - Spot Instance /?Action=CreateSpotDatafeedSubscription: get: summary: Create Spot Datafeed Subscription description: Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. operationId: createspotdatafeedsubscription x-api-path-slug: actioncreatespotdatafeedsubscription-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 responses: 200: description: OK tags: - Subnet 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 ---