dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/aws/ec2/2014-05-01.json
SVN-Git Migration c3677a04e1 Imported Upstream version 0.55.0
2015-10-08 11:15:42 -07:00

20906 lines
1.6 MiB
Raw Blame History

{
"api_version": "2014-05-01",
"type": "query",
"result_wrapped": false,
"signature_version": "v2",
"service_full_name": "Amazon Elastic Compute Cloud",
"service_abbreviation": "Amazon EC2",
"endpoint_prefix": "ec2",
"xmlnamespace": "http://ec2.amazonaws.com/doc/2014-05-01/",
"documentation": "\n\t\t<fullname>Amazon Elastic Compute Cloud</fullname>\n <p>Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing\n capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates\n your need to invest in hardware up front, so you can develop and deploy\n applications faster.</p>\n ",
"operations": {
"AcceptVpcPeeringConnection": {
"name": "AcceptVpcPeeringConnection",
"input": {
"shape_name": "AcceptVpcPeeringConnectionRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpcPeeringConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC peering connection.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "AcceptVpcPeeringConnectionResult",
"type": "structure",
"members": {
"VpcPeeringConnection": {
"shape_name": "VpcPeeringConnection",
"type": "structure",
"members": {
"AccepterVpcInfo": {
"shape_name": "VpcPeeringConnectionVpcInfo",
"type": "structure",
"members": {
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The CIDR block for the VPC.</p>\n ",
"xmlname": "cidrBlock"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the VPC owner.</p>\n ",
"xmlname": "ownerId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
}
},
"documentation": "\n <p>The information of the peer VPC.</p>\n ",
"xmlname": "accepterVpcInfo"
},
"ExpirationTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time that an unaccepted VPC peering connection will expire.</p>\n ",
"xmlname": "expirationTime"
},
"RequesterVpcInfo": {
"shape_name": "VpcPeeringConnectionVpcInfo",
"type": "structure",
"members": {
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The CIDR block for the VPC.</p>\n ",
"xmlname": "cidrBlock"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the VPC owner.</p>\n ",
"xmlname": "ownerId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
}
},
"documentation": "\n <p>The information of the requester VPC.</p>\n ",
"xmlname": "requesterVpcInfo"
},
"Status": {
"shape_name": "VpcPeeringConnectionStateReason",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status of the VPC peering connection.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A message that provides more information about the status, if applicable.</p>\n ",
"xmlname": "message"
}
},
"documentation": "\n <p>The status of the VPC peering connection.</p>\n ",
"xmlname": "status"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the resource.</p>\n ",
"xmlname": "tagSet"
},
"VpcPeeringConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC peering connection.</p>\n ",
"xmlname": "vpcPeeringConnectionId"
}
},
"documentation": "\n <p>Information about the VPC peering connection.</p>\n ",
"xmlname": "vpcPeeringConnection"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Accept a VPC peering connection request. To accept a request, the VPC peering connection\n must be in the <code>pending-acceptance</code> state, and you must be the owner of\n the peer VPC. Use the <code>DescribeVpcPeeringConnections</code> request to\n view your outstanding VPC peering connection requests.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example accepts the specified VPC peering connection\n request.</description>\n <queryrequest> https://ec2.amazonaws.com/?Action=AcceptVpcPeeringConnection\n&amp;vpcPeeringConnectionId=pcx-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AcceptVpcPeeringConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;vpcPeeringConnection&gt;\n &lt;vpcPeeringConnectionId&gt;pcx-1a2b3c4d&lt;/vpcPeeringConnectionId&gt;\n &lt;requesterVpcInfo&gt;\n &lt;ownerId&gt;123456789012&lt;/ownerId&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&lt;/vpcId&gt;\n &lt;cidrBlock&gt;10.0.0.0/28&lt;/cidrBlock&gt;\n &lt;/requesterVpcInfo&gt;\n &lt;accepterVpcInfo&gt;\n &lt;ownerId&gt;777788889999&lt;/ownerId&gt;\n &lt;vpcId&gt;vpc-111aaa22&lt;/vpcId&gt;\n &lt;cidrBlock&gt;10.0.1.0/28&lt;/cidrBlock&gt;\n &lt;/accepterVpcInfo&gt;\n &lt;status&gt;\n &lt;code&gt;active&lt;/code&gt;\n &lt;message&gt;Active&lt;/message&gt;\n &lt;/status&gt;\n &lt;tagSet/&gt;\n &lt;/vpcPeeringConnection&gt;\n &lt;/AcceptVpcPeeringConnectionResponse&gt;\"</queryresponse>\n </example>\n </examples>\n "
},
"AllocateAddress": {
"name": "AllocateAddress",
"input": {
"shape_name": "AllocateAddressRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"Domain": {
"shape_name": "DomainType",
"type": "string",
"enum": [
"vpc",
"standard"
],
"documentation": "\n <p>Set to <code>vpc</code> to allocate the address for use with instances in a VPC.</p>\n <p>Default: The address is for use with instances in EC2-Classic.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "AllocateAddressResult",
"type": "structure",
"members": {
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Elastic IP address.</p>\n ",
"xmlname": "publicIp"
},
"Domain": {
"shape_name": "DomainType",
"type": "string",
"enum": [
"vpc",
"standard"
],
"documentation": "\n <p>Indicates whether this Elastic IP address is for use with instances\n\t\t\t\tin EC2-Classic (<code>standard</code>) or instances in a VPC (<code>vpc</code>).</p>\n ",
"xmlname": "domain"
},
"AllocationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] The ID that AWS assigns to represent the allocation of\n\t\t\t\tthe Elastic IP address for use with instances in a VPC.</p>\n ",
"xmlname": "allocationId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Acquires an Elastic IP address.</p>\n <p>An Elastic IP address is for use either in the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html\">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example for EC2-Classic</name>\n <description>This example request allocates an Elastic IP address for use with instances in EC2-Classic.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AllocateAddress\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AllocateAddressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;publicIp&gt;192.0.2.1&lt;/publicIp&gt;\n &lt;domain&gt;standard&lt;/domain&gt;\n&lt;/AllocateAddressResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example for EC2-VPC</name>\n <description>This example request allocates an Elastic IP address for use with instances in a VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AllocateAddress\nDomain=vpc\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AllocateAddressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;publicIp&gt;198.51.100.1&lt;/publicIp&gt;\n &lt;domain&gt;vpc&lt;/domain&gt;\n &lt;allocationId&gt;eipalloc-5723d13e&lt;/allocationId&gt;\n&lt;/AllocateAddressResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"AssignPrivateIpAddresses": {
"name": "AssignPrivateIpAddresses",
"input": {
"shape_name": "AssignPrivateIpAddressesRequest",
"type": "structure",
"members": {
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the network interface.</p>\n ",
"required": true
},
"PrivateIpAddresses": {
"shape_name": "PrivateIpAddressStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "PrivateIpAddress"
},
"documentation": "\n <p>One or more IP addresses to be assigned as a secondary private IP address to\n\t\t\t\tthe network interface.</p>\n\t\t <p>If you don't specify an IP address, Amazon EC2 automatically\n\t\t\t\tselects an IP address within the subnet range.</p>\n ",
"flattened": true
},
"SecondaryPrivateIpAddressCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of secondary IP addresses to assign to the network interface.</p>\n "
},
"AllowReassignment": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether to allow an IP address that is already assigned\n\t\t\t\tto another network interface or instance to be reassigned to the\n\t\t\t\tspecified network interface.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Assigns one or more secondary private IP addresses to the specified network interface. You\n\t\t\t\tcan specify one or more specific secondary IP addresses, or\n\t\t\t\tyou can specify the number of secondary IP addresses to be automatically assigned\n\t\t\t\twithin the subnet's CIDR block range. The number of secondary IP addresses that you\n\t\t\t\tcan assign to an instance varies by instance type. For information about\n\t\t\t\tinstance types, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\">Instance Types</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about Elastic IP\n\t\t\t\taddresses, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html\">Elastic IP\n\t\t\t\tAddresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>AssignPrivateIpAddresses is available only in EC2-VPC.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example assigns two secondary private IP addresses (<code>10.0.2.1</code> and\n\t\t\t\t\t<code>10.0.2.11</code>) to the specified network interface.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AssignPrivateIpAddresses\n&amp;NetworkInterfaceId=eni-d83388b1\n&amp;PrivateIpAddress.0=10.0.2.1\n&amp;PrivateIpAddress.1=10.0.2.11\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AssignPrivateIpAddresses xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/AssignPrivateIpAddresses&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example assigns two secondary private IP addresses to the specified network\n\t\t\t\t\tinterface. Amazon EC2 automatically assigns these IP addresses from the available IP\n\t\t\t\t\taddresses within the subnet's CIDR block range.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AssignPrivateIpAddresses\n&amp;NetworkInterfaceId=eni-d83388b1\n&amp;SecondaryPrivateIpAddressCount=2\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AssignPrivateIpAddresses xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/AssignPrivateIpAddresses&gt;</queryresponse>\n </example>\n </examples>\n "
},
"AssociateAddress": {
"name": "AssociateAddress",
"input": {
"shape_name": "AssociateAddressRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance. The operation fails if\n\t\t\t\tyou specify an instance ID unless exactly one network interface is\n\t\t\t\tattached.</p>\n "
},
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Elastic IP address.</p>\n "
},
"AllocationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] The allocation ID. This is required for EC2-VPC.</p>\n "
},
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] The ID of the network interface. If the instance has more than one \n network interface, you must specify a network interface ID.</p>\n "
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] The primary or secondary private IP address to associate\n\t\t\t\twith the Elastic IP address. If no private IP address is specified, the\n\t\t\t\tElastic IP address is associated with the primary private IP\n\t\t\t\taddress.</p>\n "
},
"AllowReassociation": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>[EC2-VPC] Allows an Elastic IP address that is already associated\n\t\t\t\twith an instance or network interface to be re-associated with the\n\t\t\t\tspecified instance or network interface. Otherwise, the operation\n\t\t\t\tfails.</p>\n <p>Default: <code>false</code></p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "AssociateAddressResult",
"type": "structure",
"members": {
"AssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] The ID that represents the association of the Elastic IP\n\t\t\t\taddress with an instance.</p>\n ",
"xmlname": "associationId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Associates an Elastic IP address with an instance or a network interface.</p>\n <p>An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html\">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>[EC2-Classic, default VPC] If the Elastic IP address is already associated with a different\n\t\t\t\tinstance, it is disassociated from that instance and associated with the specified\n\t\t\t\tinstance.</p>\n <p>[EC2-VPC] If you don't specify a private IP address, the Elastic IP address is\n\t\t\t\tassociated with the primary IP address. If the Elastic IP address is already\n\t\t\t\tassociated with a different instance or a network interface, you get an error unless\n\t\t\t\tyou allow reassociation.</p>\n <p>This is an idempotent operation. If you perform the operation more than once, Amazon EC2\n\t\t\t\tdoesn't return an error.</p>\n <examples>\n <example>\n <name>Example for EC2-Classic</name>\n <description>This example request associates an Elastic IP address with an instance in\n\t\t\t\t\tEC2-Classic.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AssociateAddress\n&amp;InstanceId=i-2ea64347\n&amp;PublicIp=192.0.2.1\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AssociateAddressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/AssociateAddressResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example for EC2-VPC</name>\n <description>This example request associates a Elastic IP address with an instance in a VPC.\n\t\t\t\t\tThe <code>AllowReassignment</code> parameter allows the Elastic IP address to be associated with \n\t\t\t\t\tthe specified instance even if it's already associated with a different instance or a network interface.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AssociateAddress\n&amp;InstanceId=i-4fd2431a\n&amp;AllocationId=eipalloc-5723d13e\n&amp;AllowReassignment=true\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AssociateAddressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n &lt;associationId&gt;eipassoc-fc5ca095&lt;/associationId&gt;\n&lt;/AssociateAddressResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"AssociateDhcpOptions": {
"name": "AssociateDhcpOptions",
"input": {
"shape_name": "AssociateDhcpOptionsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"DhcpOptionsId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the DHCP options set, or <code>default</code> to associate \n no DHCP options with the VPC.</p>\n ",
"required": true
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Associates a set of DHCP options (that you've previously created) with the\n\t\t\t specified VPC, or associates no DHCP options with the VPC.</p>\n\t\t <p>After you associate the options with the VPC, any existing instances and all new\n \t\t\t instances that you launch in that VPC use the options. You don't need to restart or\n\t \t\t relaunch the instances. They automatically pick up the changes within a few hours,\n\t\t \t depending on how frequently the instance renews its DHCP lease. You can\n\t\t\t explicitly renew the lease using the operating system on the instance.</p>\n\t\t <p>For more information,\n\t\t\t see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html\">DHCP Options Sets</a> \n\t\t\t in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example associates the DHCP options with the ID <code>dopt-7a8b9c2d</code> with the VPC\n\t\t\t\t\twith the ID <code>vpc-1a2b3c4d</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AssociateDhcpOptions \n&amp;DhcpOptionsId=dopt-7a8b9c2d\n&amp;VpcId=vpc-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AssociateDhcpOptionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt; \n&lt;/AssociateDhcpOptionsResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example changes the VPC with the ID <code>vpc-1a2b3c4d</code> to have no \n\t\t\t\t\tassociated DHCP options set.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AssociateDhcpOptions \n&amp;DhcpOptionsId=default\n&amp;VpcId=vpc-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AssociateDhcpOptionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt; \n&lt;/AssociateDhcpOptionsResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"AssociateRouteTable": {
"name": "AssociateRouteTable",
"input": {
"shape_name": "AssociateRouteTableRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet.</p>\n ",
"required": true
},
"RouteTableId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the route table.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "AssociateRouteTableResult",
"type": "structure",
"members": {
"AssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The route table association ID (needed to disassociate the route table).</p>\n ",
"xmlname": "associationId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Associates a subnet with a route table. The subnet and route table must be in the same VPC.\n\t\t\t\tThis association causes traffic originating from the subnet to be routed according\n\t\t\t\tto the routes in the route table. The action returns an association ID, which you\n\t\t\t\tneed in order to disassociate the route table from the subnet later. A route table\n\t\t\t\tcan be associated with multiple subnets.</p>\n\t\t <p>For more information about route tables, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html\">Route Tables</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example associates a route table with the ID <code>rtb-e4ad488d</code> with a subnet with\n\t\t\t\t\tthe ID <code>subnet-15ad487c</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AssociateRouteTable\n&amp;RouteTableId=rtb-e4ad488d\n&amp;SubnetId=subnet-15ad487c</queryrequest>\n <queryresponse>&lt;AssociateRouteTableResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;associationId&gt;rtbassoc-f8ad4891&lt;/associationId&gt;\n&lt;/AssociateRouteTableResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"AttachInternetGateway": {
"name": "AttachInternetGateway",
"input": {
"shape_name": "AttachInternetGatewayRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InternetGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the Internet gateway.</p>\n ",
"required": true
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Attaches an Internet gateway to a VPC, enabling connectivity between the Internet\n\t\t\t\tand the VPC. For more information about your VPC and Internet gateway, see the\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/\">Amazon Virtual Private Cloud User Guide</a>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example attaches the Internet gateway with the ID <code>igw-eaad4883</code> to the VPC with\n\t\t\t\t\tthe ID <code>vpc-11ad4878</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AttachInternetGateway\n&amp;InternetGatewayId=igw-eaad4883\n&amp;VpcId=vpc-11ad4878\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AttachInternetGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/AttachInternetGatewayResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"AttachNetworkInterface": {
"name": "AttachNetworkInterface",
"input": {
"shape_name": "AttachNetworkInterfaceRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"required": true
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the instance.</p>\n ",
"required": true
},
"DeviceIndex": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The index of the device for the network interface attachment.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "AttachNetworkInterfaceResult",
"type": "structure",
"members": {
"AttachmentId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface attachment.</p>\n ",
"xmlname": "attachmentId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Attaches a network interface to an instance.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example attaches the specified network interface \n\t\t\t\t\tto the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AttachNetworkInterface\n&amp;DeviceIndex=1\n&amp;InstanceId=i-9cc316fe\n&amp;NetworkInterfaceId=eni-ffda3197\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AttachNetworkInterfaceResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;ace8cd1e-e685-4e44-90fb-92014d907212&lt;/requestId&gt;\n &lt;attachmentId&gt;eni-attach-d94b09b0&lt;/attachmentId&gt;\n&lt;/AttachNetworkInterfaceResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"AttachVolume": {
"name": "AttachVolume",
"input": {
"shape_name": "AttachVolumeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Amazon EBS volume. The volume and instance must be within the same Availability\n Zone.</p>\n ",
"required": true
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"required": true
},
"Device": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name to expose to the instance (for example, <code>/dev/sdh</code> or\n <code>xvdh</code>).</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "VolumeAttachment",
"type": "structure",
"members": {
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"xmlname": "volumeId"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"Device": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name.</p>\n ",
"xmlname": "device"
},
"State": {
"shape_name": "VolumeAttachmentState",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n <p>The attachment state of the volume.</p>\n ",
"xmlname": "status"
},
"AttachTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when the attachment initiated.</p>\n ",
"xmlname": "attachTime"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n ",
"xmlname": "deleteOnTermination"
}
},
"documentation": "\n ",
"xmlname": "attachment"
},
"errors": [],
"documentation": "\n <p>Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance\n with the specified device name.</p>\n <p>Encrypted Amazon EBS volumes may only be attached to\n instances that support Amazon EBS encryption. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html\">Amazon EBS Encryption</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>For a list of supported device names, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html\">Attaching an Amazon EBS Volume to an Instance</a>. Any device names that aren't reserved\n for instance store volumes can be used for Amazon EBS volumes. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html\">Amazon EC2 Instance Store</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>If a volume has an AWS Marketplace product code:</p>\n <ul>\n <li>The volume can only be attached as the root device of a stopped instance.</li>\n <li>You must be subscribed to the AWS Marketplace code that is on the volume.</li>\n <li>The configuration (instance type, operating system) of the instance must support that\n specific AWS Marketplace code. For example, you cannot take a volume from a Windows instance\n and attach it to a Linux instance.</li>\n <li>AWS Marketplace product codes are copied from the volume to the instance.</li>\n </ul>\n <p>For an overview of the AWS Marketplace, see <a href=\"https://aws.amazon.com/marketplace/help/200900000\">https://aws.amazon.com/marketplace/help/200900000</a>. For more information about how to use the AWS\n Marketplace, see <a href=\"https://aws.amazon.com/marketplace\">AWS Marketplace</a>.</p>\n <p>For more information about Amazon EBS volumes, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-attaching-volume.html\">Attaching Amazon EBS Volumes</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example request attaches the volume with the ID <code>vol-1a2b3c4d</code> to\n the instance with the ID <code>i-1a2b3c4d</code> and exposes it as\n <code>/dev/sdh</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AttachVolume\n&amp;VolumeId=vol-1a2b3c4d\n&amp;InstanceId=i-1a2b3c4d\n&amp;Device=/dev/sdh\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AttachVolumeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;volumeId&gt;vol-1a2b3c4d&lt;/volumeId&gt;\n &lt;instanceId&gt;i-1a2b3c4d&lt;/instanceId&gt;\n &lt;device&gt;/dev/sdh&lt;/device&gt;\n &lt;status&gt;attaching&lt;/status&gt;\n &lt;attachTime&gt;YYYY-MM-DDTHH:MM:SS.000Z&lt;/attachTime&gt;\n&lt;/AttachVolumeResponse&gt;</queryresponse>\n </example>\n </examples>\n \n "
},
"AttachVpnGateway": {
"name": "AttachVpnGateway",
"input": {
"shape_name": "AttachVpnGatewayRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpnGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the virtual private gateway.</p>\n ",
"required": true
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "AttachVpnGatewayResult",
"type": "structure",
"members": {
"VpcAttachment": {
"shape_name": "VpcAttachment",
"type": "structure",
"members": {
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"State": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n\t\t <p>The current state of the attachment.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n\t\t <p>Information about the attachment.</p>\n ",
"xmlname": "attachment"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Attaches a virtual private gateway to a VPC. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html\">Adding a Hardware Virtual Private Gateway\n\t\t\t\t\tto Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example attaches the virtual private gateway with the ID <code>vgw-8db04f81</code> to the VPC with the ID\n\t\t\t\t\t<code>vpc-1a2b3c4d</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AttachVpnGateway\n&amp;VpnGatewayId=vgw-8db04f81\n&amp;VpcId=vpc-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AttachVpnGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;attachment&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&lt;/vpcId&gt;\n &lt;state&gt;attaching&lt;/state&gt;\n &lt;/attachment&gt;\n&lt;/AttachVpnGatewayResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"AuthorizeSecurityGroupEgress": {
"name": "AuthorizeSecurityGroupEgress",
"input": {
"shape_name": "AuthorizeSecurityGroupEgressRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"required": true
},
"SourceSecurityGroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.</p>\n "
},
"SourceSecurityGroupOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the source security group. You can't specify a source security group and a CIDR IP address range.</p>\n "
},
"IpProtocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The IP protocol name (<code>tcp</code>, <code>udp</code>, <code>icmp</code>) or number \n (see <a href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Protocol Numbers</a>). \n Use <code>-1</code> to specify all.</p>\n "
},
"FromPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use <code>-1</code> to specify all ICMP types.</p>\n "
},
"ToPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use <code>-1</code> to specify all ICMP codes for the ICMP type.</p>\n "
},
"CidrIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The CIDR IP address range. You can't specify this parameter when specifying a source security group.</p>\n "
},
"IpPermissions": {
"shape_name": "IpPermissionList",
"type": "list",
"members": {
"shape_name": "IpPermission",
"type": "structure",
"members": {
"IpProtocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The protocol.</p>\n\t\t <p>When you call <a>DescribeSecurityGroups</a>, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, <code>tcp</code>,\n\t\t\t\t<code>udp</code>, or <code>icmp</code>). For a list of\n\t\t\t\tprotocol numbers, see <a href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Protocol Numbers</a>.</p>\n "
},
"FromPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of <code>-1</code> indicates all ICMP types.</p>\n "
},
"ToPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The end of port range for the TCP and UDP protocols, or an ICMP code. A value of <code>-1</code>\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.</p>\n "
},
"UserIdGroupPairs": {
"shape_name": "UserIdGroupPairList",
"type": "list",
"members": {
"shape_name": "UserIdGroupPair",
"type": "structure",
"members": {
"UserId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of an AWS account.</p>\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group owned by the specified AWS account.</p>\n "
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group in the specified AWS account.</p>\n "
}
},
"documentation": "\n <p>Describes a security group and AWS account ID pair for EC2-Classic.</p>\n ",
"xmlname": "Groups"
},
"documentation": "\n\t\t <p>One or more security group and AWS account ID pairs.</p>\n ",
"flattened": true
},
"IpRanges": {
"shape_name": "IpRangeList",
"type": "list",
"members": {
"shape_name": "IpRange",
"type": "structure",
"members": {
"CidrIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR range. You can either specify a CIDR range or a source security group, not both.</p>\n "
}
},
"documentation": "\n\t\t <p>Describes an IP range.</p>\n "
},
"documentation": "\n\t\t <p>One or more IP ranges.</p>\n ",
"flattened": true
}
},
"documentation": "\n\t\t <p>Describes a security group rule.</p>\n "
},
"documentation": "\n <p></p>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Adds one or more egress rules to a security group for use with a VPC.\n\t\t\t\tSpecifically, this action permits instances to send traffic to one or more\n\t\t\t\tCIDR IP address ranges, or to one or more security groups\tfor the same VPC.</p>\n\t\t\t<important>\n\t\t\t\t<p>You can have up to 50 rules per security group (covering both ingress and\n\t\t\t\t\tegress rules).</p>\n\t\t\t</important>\n <p>A security group is for use with instances either in the EC2-Classic platform or in a specific VPC.\n\t\t\t\tThis action doesn't apply to security groups for use in EC2-Classic. \n\t\t\t\tFor more information, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in\n\t\t\t\tthe <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <p>Each rule consists of the protocol (for example, TCP), plus either a CIDR range or\n\t\t\t\ta source group. For the TCP and UDP protocols, you must also specify the destination\n\t\t\t\tport or port range. For the ICMP protocol, you must also specify the ICMP type and\n\t\t\t\tcode. You can use -1 for the type or code to mean all types or all codes.</p>\n <p>Rule changes are propagated to affected instances as quickly as possible. However,\n\t\t\t\ta small delay might occur.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example request grants your security group with the ID <code>sg-1a2b3c4d</code> access to the\n\t\t\t\t\t<code>192.0.2.0/24</code> and <code>198.51.100.0/24</code> address ranges on TCP port 80.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupEgress\n&amp;GroupId=sg-1a2b3c4d\n&amp;IpPermissions.1.IpProtocol=tcp\n&amp;IpPermissions.1.FromPort=80\n&amp;IpPermissions.1.ToPort=80\n&amp;IpPermissions.1.IpRanges.1.CidrIp=192.0.2.0/24\n&amp;IpPermissions.1.IpRanges.2.CidrIp=198.51.100.0/24\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AuthorizeSecurityGroupEgressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/AuthorizeSecurityGroupEgressResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example request grants egress access from the security group with the ID <code>sg-1a2b3c4d</code> \n\t\t\t\t\tto the security group with the ID <code>sg-9a8d7f5c</code> on TCP port 1433.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupEgress\n&amp;GroupId=sg-1a2b3c4d\n&amp;IpPermissions.1.IpProtocol=tcp\n&amp;IpPermissions.1.FromPort=1433\n&amp;IpPermissions.1.ToPort=1433\n&amp;IpPermissions.1.Groups.1.GroupId=sg-9a8d7f5c\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;AuthorizeSecurityGroupEgressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/AuthorizeSecurityGroupEgressResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"AuthorizeSecurityGroupIngress": {
"name": "AuthorizeSecurityGroupIngress",
"input": {
"shape_name": "AuthorizeSecurityGroupIngressRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-Classic, default VPC] The name of the security group.</p>\n "
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n "
},
"SourceSecurityGroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.</p>\n "
},
"SourceSecurityGroupOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the source security group. You can't specify a source security group and a CIDR IP address range.</p>\n "
},
"IpProtocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The IP protocol name (<code>tcp</code>, <code>udp</code>, <code>icmp</code>) or number \n (see <a href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Protocol Numbers</a>). \n Use <code>-1</code> to specify all.</p>\n "
},
"FromPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use <code>-1</code> to specify all ICMP types.</p>\n "
},
"ToPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use <code>-1</code> to specify all ICMP codes for the ICMP type.</p>\n "
},
"CidrIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The CIDR IP address range. You can't specify this parameter when specifying a source security group.</p>\n "
},
"IpPermissions": {
"shape_name": "IpPermissionList",
"type": "list",
"members": {
"shape_name": "IpPermission",
"type": "structure",
"members": {
"IpProtocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The protocol.</p>\n\t\t <p>When you call <a>DescribeSecurityGroups</a>, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, <code>tcp</code>,\n\t\t\t\t<code>udp</code>, or <code>icmp</code>). For a list of\n\t\t\t\tprotocol numbers, see <a href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Protocol Numbers</a>.</p>\n "
},
"FromPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of <code>-1</code> indicates all ICMP types.</p>\n "
},
"ToPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The end of port range for the TCP and UDP protocols, or an ICMP code. A value of <code>-1</code>\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.</p>\n "
},
"UserIdGroupPairs": {
"shape_name": "UserIdGroupPairList",
"type": "list",
"members": {
"shape_name": "UserIdGroupPair",
"type": "structure",
"members": {
"UserId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of an AWS account.</p>\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group owned by the specified AWS account.</p>\n "
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group in the specified AWS account.</p>\n "
}
},
"documentation": "\n <p>Describes a security group and AWS account ID pair for EC2-Classic.</p>\n ",
"xmlname": "Groups"
},
"documentation": "\n\t\t <p>One or more security group and AWS account ID pairs.</p>\n ",
"flattened": true
},
"IpRanges": {
"shape_name": "IpRangeList",
"type": "list",
"members": {
"shape_name": "IpRange",
"type": "structure",
"members": {
"CidrIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR range. You can either specify a CIDR range or a source security group, not both.</p>\n "
}
},
"documentation": "\n\t\t <p>Describes an IP range.</p>\n "
},
"documentation": "\n\t\t <p>One or more IP ranges.</p>\n ",
"flattened": true
}
},
"documentation": "\n\t\t <p>Describes a security group rule.</p>\n "
},
"documentation": "\n <p></p>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Adds one or more ingress rules to a security group.</p>\n\t\t\t<important>\n\t\t\t\t<p>EC2-Classic: You can have up to 100 rules per group.</p>\n\t\t\t\t<p>EC2-VPC: You can have up to 50 rules per group (covering both ingress and\n\t\t\t\t\tegress rules).</p>\n\t\t\t</important>\n <p>Rule changes are propagated to instances within the security group as quickly as\n\t\t\t\tpossible. However, a small delay might occur.</p>\n <p>[EC2-Classic] This action gives one or more CIDR IP address ranges permission to\n\t\t\t\taccess a security group in your account, or gives one or more security groups\n\t\t\t\t(called the <i>source groups</i>) permission to access a security\n\t\t\t\tgroup for your account. A source group can be for your own AWS account, or another.</p>\n <p>[EC2-VPC] This action gives one or more CIDR IP address ranges permission to\n\t\t\t\taccess a security group in your VPC, or gives one or more other security groups\n\t\t\t\t(called the <i>source groups</i>) permission to access a security\n\t\t\t\tgroup for your VPC. The security groups must all be for the same VPC.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example request grants TCP port 80 access from the <code>192.0.2.0/24</code>\n\t\t\t\t\tand <code>198.51.100.0/24</code> address ranges to the security group for EC2-Classic \n\t\t\t\t\tnamed <code>websrv</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupIngress\n&amp;GroupName=websrv\n&amp;IpPermissions.1.IpProtocol=tcp\n&amp;IpPermissions.1.FromPort=80\n&amp;IpPermissions.1.ToPort=80\n&amp;IpPermissions.1.IpRanges.1.CidrIp=192.0.2.0/24\n&amp;IpPermissions.1.IpRanges.2.CidrIp=198.51.100.0/24\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example request grants TCP port 80\n\t\t\t\t\taccess from the source group for EC2-Classic named <code>OtherAccountGroup</code> (in AWS\n\t\t\t\t\taccount <code>123456789012</code>) to the security group for EC2-Classic named <code>websrv</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupIngress\n&amp;GroupName=websrv\n&amp;IpPermissions.1.IpProtocol=tcp\n&amp;IpPermissions.1.FromPort=80\n&amp;IpPermissions.1.ToPort=80\n&amp;IpPermissions.1.Groups.1.GroupName=OtherAccountGroup\n&amp;IpPermissions.1.Groups.1.UserId=123456789012\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example request grants TCP port\n\t\t\t\t\t80 access from the source group named <code>OtherGroupInMyVPC</code>\n\t\t\t\t\t(with the ID <code>sg-2a2b3c4d</code>) to the security group named <code>VpcWebServers</code> \n\t\t\t\t\t(with the ID <code>sg-1a2b3c4d</code>). In EC2-VPC, you must use the security group IDs in \n\t\t\t\t\ta request, not the security group names. In this example, your AWS account ID is <code>123456789012</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupIngress\n&amp;GroupId=sg-1a2b3c4d\n&amp;IpPermissions.1.IpProtocol=tcp\n&amp;IpPermissions.1.FromPort=80\n&amp;IpPermissions.1.ToPort=80\n&amp;IpPermissions.1.Groups.1.GroupId=sg-2a2b3c4d\n&amp;IpPermissions.1.Groups.1.UserId=123456789012\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 4</name>\n <description>This example request grants your local\n\t\t\t\t\tsystem the ability to use SSH (port 22) to connect to any instance in the security group\n\t\t\t\t\tnamed <code>default</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/\n?Action=AuthorizeSecurityGroupIngress\n&amp;GroupName=default\n&amp;IpPermissions.1.IpProtocol=tcp\n&amp;IpPermissions.1.FromPort=22\n&amp;IpPermissions.1.ToPort=22\n&amp;IpPermissions.1.IpRanges.1.CidrIp=<i>your-local-system's-public-ip-address</i>/32\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 5</name>\n <description>This example request grants your local system\n\t\t\t\t\tthe ability to use Remote Desktop (port 3389) to connect to any instance in the security group\n\t\t\t\t\tnamed <code>default</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/\n?Action=AuthorizeSecurityGroupIngress\n&amp;GroupName=default\n&amp;IpPermissions.1.IpProtocol=tcp\n&amp;IpPermissions.1.FromPort=3389\n&amp;IpPermissions.1.ToPort=3389\n&amp;IpPermissions.1.IpRanges.1.CidrIp=<i>your-local-system's-public-ip-address</i>/32</queryrequest>\n </example>\n </examples>\n "
},
"BundleInstance": {
"name": "BundleInstance",
"input": {
"shape_name": "BundleInstanceRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n "
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The ID of the instance to bundle.</p>\n ",
"required": true
},
"Storage": {
"shape_name": "Storage",
"type": "structure",
"members": {
"S3": {
"shape_name": "S3Storage",
"type": "structure",
"members": {
"Bucket": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.</p>\n "
},
"Prefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The beginning of the file name of the AMI.</p>\n "
},
"AWSAccessKeyId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html\">Best Practices for Managing AWS Access Keys</a>.</p>\n "
},
"UploadPolicy": {
"shape_name": "String",
"type": "blob",
"documentation": "\n <p>A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.</p>\n "
},
"UploadPolicySignature": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The signature of the Base64 encoded JSON document.</p>\n "
}
},
"documentation": "\n <p>An Amazon S3 storage location.</p>\n "
}
},
"documentation": " \n <p>The bucket in which to store the AMI. You can specify a bucket that\n\t\t\t\tyou already own or a new bucket that Amazon EC2 creates on your behalf.\n\t\t\t\tIf you specify a bucket that belongs to someone else, Amazon EC2 returns\n\t\t\t\tan error.</p>\n ",
"required": true
}
},
"documentation": " \n "
},
"output": {
"shape_name": "BundleInstanceResult",
"type": "structure",
"members": {
"BundleTask": {
"shape_name": "BundleTask",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The ID of the instance associated with this bundle task.</p>\n ",
"xmlname": "instanceId"
},
"BundleId": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The ID for this bundle task.</p>\n ",
"xmlname": "bundleId"
},
"State": {
"shape_name": "BundleTaskState",
"type": "string",
"enum": [
"pending",
"waiting-for-shutdown",
"bundling",
"storing",
"cancelling",
"complete",
"failed"
],
"documentation": " \n <p>The state of the task.</p>\n ",
"xmlname": "state"
},
"StartTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": " \n <p>The time this task started.</p>\n ",
"xmlname": "startTime"
},
"UpdateTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": " \n <p>The time of the most recent update for the task.</p>\n ",
"xmlname": "updateTime"
},
"Storage": {
"shape_name": "Storage",
"type": "structure",
"members": {
"S3": {
"shape_name": "S3Storage",
"type": "structure",
"members": {
"Bucket": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.</p>\n ",
"xmlname": "bucket"
},
"Prefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The beginning of the file name of the AMI.</p>\n ",
"xmlname": "prefix"
},
"AWSAccessKeyId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html\">Best Practices for Managing AWS Access Keys</a>.</p>\n "
},
"UploadPolicy": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.</p>\n ",
"xmlname": "uploadPolicy"
},
"UploadPolicySignature": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The signature of the Base64 encoded JSON document.</p>\n ",
"xmlname": "uploadPolicySignature"
}
},
"documentation": "\n <p>An Amazon S3 storage location.</p>\n "
}
},
"documentation": " \n <p>The Amazon S3 storage locations.</p>\n ",
"xmlname": "storage"
},
"Progress": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The level of task completion, as a percent (for example, 20%).</p>\n ",
"xmlname": "progress"
},
"BundleTaskError": {
"shape_name": "BundleTaskError",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The error code.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The error message.</p>\n ",
"xmlname": "message"
}
},
"documentation": " \n <p>If the task fails, a description of the error.</p>\n ",
"xmlname": "error"
}
},
"documentation": " \n <p>Information about the bundle task.</p>\n ",
"xmlname": "bundleInstanceTask"
}
},
"documentation": " \n "
},
"errors": [],
"documentation": " \n <p>Bundles an Amazon instance store-backed Windows instance.</p>\n <p>During bundling, only the root device volume (C:\\) is bundled. Data on other\n\t\t\t\tinstance store volumes is not preserved.</p>\n <note>\n <p>This procedure is not applicable for Linux/Unix instances or Windows instances\n that are backed by Amazon EBS.</p>\n\t\t\t</note>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_InstanceStoreBacked_WinAMI.html\">Creating an Instance Store-Backed Windows AMI</a>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>\n <p>This example request bundles the specified instance.</p>\n <p>Before you specify a value for your access key ID, review and follow the guidance \n in <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html\">Best Practices for Managing AWS Access Keys</a>.</p>\n </description>\n <queryrequest>https://ec2.amazonaws.com/?Action=BundleInstance\n&amp;InstanceId=i-e468cd8d\n&amp;Storage.S3.AWSAccessKeyId='AKIAIOSFODNN7EXAMPLE'\n&amp;Storage.S3.Bucket=myawsbucket \n&amp;Storage.S3.Prefix=winami\n&amp;Storage.S3.UploadPolicy=eyJleHBpcmF0aW9uIjogIjIwMDgtMDgtMzBUMDg6NDk6MD\nlaIiwiY29uZGl0aW9ucyI6IFt7ImJ1Y2tldCI6ICJteS1idWNrZXQifSxbInN0YXJ0cy13aXRoIiwgI\niRrZXkiLCAibXktbmV3LWltYWdlIl0seyJhY2wiOiAiZWMyLWJ1bmRsZS1yZWFkIn1dfEXAMPLE\n&amp;Storage.S3.UploadPolicySignature=fh5tyyyQD8W4COEthj3nlGNEXAMPLE \n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;BundleInstanceResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;bundleInstanceTask&gt;\n &lt;instanceId&gt;i-12345678&lt;/instanceId&gt;\n &lt;bundleId&gt;bun-c1a540a8&lt;/bundleId&gt;\n &lt;state&gt;bundling&lt;/state&gt;\n &lt;startTime&gt;2008-10-07T11:41:50.000Z&lt;/startTime&gt;\n &lt;updateTime&gt;2008-10-07T11:51:50.000Z&lt;/updateTime&gt;\n &lt;progress&gt;70%&lt;/progress&gt;\n &lt;storage&gt;\n &lt;S3&gt;\n &lt;bucket&gt;myawsbucket&lt;/bucket&gt;\n &lt;prefix&gt;winami&lt;/prefix&gt;\n &lt;/S3&gt;\n &lt;/storage&gt;\n &lt;/bundleInstanceTask&gt;\n&lt;/BundleInstanceResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CancelBundleTask": {
"name": "CancelBundleTask",
"input": {
"shape_name": "CancelBundleTaskRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n "
},
"BundleId": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The ID of the bundle task.</p>\n ",
"required": true
}
},
"documentation": " \n "
},
"output": {
"shape_name": "CancelBundleTaskResult",
"type": "structure",
"members": {
"BundleTask": {
"shape_name": "BundleTask",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The ID of the instance associated with this bundle task.</p>\n ",
"xmlname": "instanceId"
},
"BundleId": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The ID for this bundle task.</p>\n ",
"xmlname": "bundleId"
},
"State": {
"shape_name": "BundleTaskState",
"type": "string",
"enum": [
"pending",
"waiting-for-shutdown",
"bundling",
"storing",
"cancelling",
"complete",
"failed"
],
"documentation": " \n <p>The state of the task.</p>\n ",
"xmlname": "state"
},
"StartTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": " \n <p>The time this task started.</p>\n ",
"xmlname": "startTime"
},
"UpdateTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": " \n <p>The time of the most recent update for the task.</p>\n ",
"xmlname": "updateTime"
},
"Storage": {
"shape_name": "Storage",
"type": "structure",
"members": {
"S3": {
"shape_name": "S3Storage",
"type": "structure",
"members": {
"Bucket": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.</p>\n ",
"xmlname": "bucket"
},
"Prefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The beginning of the file name of the AMI.</p>\n ",
"xmlname": "prefix"
},
"AWSAccessKeyId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html\">Best Practices for Managing AWS Access Keys</a>.</p>\n "
},
"UploadPolicy": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.</p>\n ",
"xmlname": "uploadPolicy"
},
"UploadPolicySignature": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The signature of the Base64 encoded JSON document.</p>\n ",
"xmlname": "uploadPolicySignature"
}
},
"documentation": "\n <p>An Amazon S3 storage location.</p>\n "
}
},
"documentation": " \n <p>The Amazon S3 storage locations.</p>\n ",
"xmlname": "storage"
},
"Progress": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The level of task completion, as a percent (for example, 20%).</p>\n ",
"xmlname": "progress"
},
"BundleTaskError": {
"shape_name": "BundleTaskError",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The error code.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The error message.</p>\n ",
"xmlname": "message"
}
},
"documentation": " \n <p>If the task fails, a description of the error.</p>\n ",
"xmlname": "error"
}
},
"documentation": " \n <p>The bundle task.</p>\n ",
"xmlname": "bundleInstanceTask"
}
},
"documentation": " \n "
},
"errors": [],
"documentation": " \n <p>Cancels a bundling operation for an instance store-backed Windows instance.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request cancels the specified bundle task.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CancelBundleTask\n&amp;BundleId=bun-cla322b9\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CancelBundleTaskResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;bundleInstanceTask&gt;\n &lt;instanceId&gt;i-12345678&lt;/instanceId&gt;\n &lt;bundleId&gt;bun-cla322b9&lt;/bundleId&gt;\n &lt;state&gt;canceling&lt;/state&gt;\n &lt;startTime&gt;2008-10-07T11:41:50.000Z&lt;/startTime&gt;\n &lt;updateTime&gt;2008-10-07T11:51:50.000Z&lt;/updateTime&gt;\n &lt;progress&gt;20%&lt;/progress&gt;\n &lt;storage&gt;\n &lt;S3&gt;\n &lt;bucket&gt;myawsbucket&lt;/bucket&gt;\n &lt;prefix&gt;my-new-image&lt;/prefix&gt;\n &lt;/S3&gt;\n &lt;/storage&gt;\n &lt;/bundleInstanceTask&gt;\n&lt;/CancelBundleTaskResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CancelConversionTask": {
"name": "CancelConversionTask",
"input": {
"shape_name": "CancelConversionRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ConversionTaskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the conversion task.</p>\n ",
"required": true
},
"ReasonMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Cancels an active conversion task. The task can be the import of an instance or volume. The\n action removes all artifacts of the conversion, including a partially uploaded volume or\n instance. If the conversion is complete or is in the process of transferring the final disk\n image, the command fails and returns an exception.</p>\n \n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html\">Using the Command Line Tools to Import Your Virtual Machine to Amazon\n EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request cancels the conversion task with the ID <code>import-i-fh95npoc</code>.</description> \n <queryrequest>https://ec2.amazonaws.com/?Action=CancelConversionTask\n&amp;ConversionTaskId=import-i-fh95npoc\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><CancelConversionTaskResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n</CancelConversionTaskResponse></queryresponse>\n </example>\n </examples>\n "
},
"CancelExportTask": {
"name": "CancelExportTask",
"input": {
"shape_name": "CancelExportTaskRequest",
"type": "structure",
"members": {
"ExportTaskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the export task. This is the ID\n returned by <code>CreateInstanceExportTask</code>.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Cancels an active export task. The request removes all artifacts of the export,\n including any partially-created Amazon S3 objects. If the export task is complete or\n is in the process of transferring the final disk image, the command fails and\n returns an error.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request cancels the export task with the ID <code>export-i-1234wxyz</code>.</description> \n <queryrequest>https://ec2.amazonaws.com/?Action=CancelExportTask\n &amp;exportTaskId=export-i-1234wxyz\n &amp;AUTHPARAMS</queryrequest>\n <queryresponse><CancelExportTask xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n<return>true</return>\n</CancelExportTask></queryresponse>\n </example>\n </examples>\n "
},
"CancelReservedInstancesListing": {
"name": "CancelReservedInstancesListing",
"input": {
"shape_name": "CancelReservedInstancesListingRequest",
"type": "structure",
"members": {
"ReservedInstancesListingId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Reserved Instance listing.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CancelReservedInstancesListingResult",
"type": "structure",
"members": {
"ReservedInstancesListings": {
"shape_name": "ReservedInstancesListingList",
"type": "list",
"members": {
"shape_name": "ReservedInstancesListing",
"type": "structure",
"members": {
"ReservedInstancesListingId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Reserved Instance listing.</p>\n ",
"xmlname": "reservedInstancesListingId"
},
"ReservedInstancesId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Reserved Instance.</p>\n ",
"xmlname": "reservedInstancesId"
},
"CreateDate": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time the listing was created.</p>\n ",
"xmlname": "createDate"
},
"UpdateDate": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The last modified timestamp of the listing.</p>\n ",
"xmlname": "updateDate"
},
"Status": {
"shape_name": "ListingStatus",
"type": "string",
"enum": [
"active",
"pending",
"cancelled",
"closed"
],
"documentation": "\n <p>The status of the Reserved Instance listing.</p>\n ",
"xmlname": "status"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason for the current status of the Reserved Instance listing. \n\t\t\t\tThe response can be blank.</p>\n ",
"xmlname": "statusMessage"
},
"InstanceCounts": {
"shape_name": "InstanceCountList",
"type": "list",
"members": {
"shape_name": "InstanceCount",
"type": "structure",
"members": {
"State": {
"shape_name": "ListingState",
"type": "string",
"enum": [
"available",
"sold",
"cancelled",
"pending"
],
"documentation": "\n <p>The states of the listed Reserved Instances.</p>\n ",
"xmlname": "state"
},
"InstanceCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>he number of listed Reserved Instances in the state specified by the <code>state</code>.</p>\n ",
"xmlname": "instanceCount"
}
},
"documentation": "\n <p>Describes a Reserved Instance listing state.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The number of instances in this state.</p>\n ",
"xmlname": "instanceCounts"
},
"PriceSchedules": {
"shape_name": "PriceScheduleList",
"type": "list",
"members": {
"shape_name": "PriceSchedule",
"type": "structure",
"members": {
"Term": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of months remaining in the reservation. For example, 2 is the second \n\t\t\t\tto the last month before the capacity reservation expires.</p>\n ",
"xmlname": "term"
},
"Price": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>The fixed price for the term.</p>\n ",
"xmlname": "price"
},
"CurrencyCode": {
"shape_name": "CurrencyCodeValues",
"type": "string",
"enum": [
"USD"
],
"documentation": "\n <p>The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is <code>USD</code>.</p>\n ",
"xmlname": "currencyCode"
},
"Active": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>The current price schedule, as determined by the term remaining for the \n\t\t\t\tReserved Instance in the listing.</p>\n <p>A specific price schedule is always in effect, \n\t\t\t\tbut only one price schedule can be active at any time. Take, for example, a \n\t\t\t\tReserved Instance listing that has five months remaining in its term. When you \n\t\t\t\tspecify price schedules for five months and two months, this means that \n\t\t\t\tschedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. \n\t\t\t\tThen schedule 2, covering the last two months of the term, will be active for months 2 and 1.</p>\n ",
"xmlname": "active"
}
},
"documentation": "\n <p>Describes the price for a Reserved Instance.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The price of the Reserved Instance listing.</p>\n ",
"xmlname": "priceSchedules"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the resource.</p>\n ",
"xmlname": "tagSet"
},
"ClientToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The idempotency token you provided when you created the listing.</p>\n ",
"xmlname": "clientToken"
}
},
"documentation": "\n <p>Describes a Reserved Instance listing.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The Reserved Instance listing.</p>\n ",
"xmlname": "reservedInstancesListingsSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.</p>\n <p>For more information, see \n <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html\">Reserved Instance Marketplace</a> \n in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request cancels a Reserved Instance listing in the Reserved Instance Marketplace.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CancelReservedInstancesListing\n&amp;ReservedInstancesListingId=3ebe97b5-f273-43b6-a204-7a18cEXAMPLE\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><CancelReservedInstancesListingResponse>\n <requestId>bec2cf62-98ef-434a-8a15-886fcexample</requestId>\n <reservedInstancesListingsSet>\n <item>\n <reservedInstancesListingId>3ebe97b5-f273-43b6-a204-7a18cEXAMPLE</reservedInstancesListingId>\n <reservedInstancesId>e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE</reservedInstancesId>\n <createDate>2012-07-12T16:55:28.000Z</createDate>\n <updateDate>2012-07-12T16:55:28.000Z</updateDate>\n <status>cancelled</status>\n <statusMessage>CANCELLED</statusMessage>\n <instanceCounts>\n <item>\n <state>Available</state>\n <instanceCount>0</instanceCount>\n </item>\n <item>\n <state>Sold</state>\n <instanceCount>0</instanceCount>\n </item>\n <item>\n <state>Cancelled</state>\n <instanceCount>1</instanceCount>\n </item>\n <item>\n <state>Pending</state>\n <instanceCount>0</instanceCount>\n </item>\n </instanceCounts>\n <priceSchedules>\n <item>\n <term>5</term>\n <price>166.64</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>4</term>\n <price>133.32</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>3</term>\n <price>99.99</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>2</term>\n <price>66.66</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>1</term>\n <price>33.33</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n </priceSchedules>\n <tagSet/>\n <clientToken>XqJIt1342112125076</clientToken>\n </item>\n </reservedInstancesListingsSet>\n</CancelReservedInstancesListingResponse></queryresponse>\n </example>\n </examples>\n "
},
"CancelSpotInstanceRequests": {
"name": "CancelSpotInstanceRequests",
"input": {
"shape_name": "CancelSpotInstanceRequestsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SpotInstanceRequestIds": {
"shape_name": "SpotInstanceRequestIdList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "SpotInstanceRequestId"
},
"documentation": "\n <p>One or more Spot Instance request IDs.</p>\n ",
"required": true,
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CancelSpotInstanceRequestsResult",
"type": "structure",
"members": {
"CancelledSpotInstanceRequests": {
"shape_name": "CancelledSpotInstanceRequestList",
"type": "list",
"members": {
"shape_name": "CancelledSpotInstanceRequest",
"type": "structure",
"members": {
"SpotInstanceRequestId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Spot Instance request.</p>\n ",
"xmlname": "spotInstanceRequestId"
},
"State": {
"shape_name": "CancelSpotInstanceRequestState",
"type": "string",
"enum": [
"active",
"open",
"closed",
"cancelled",
"completed"
],
"documentation": "\n <p>The state of the Spot Instance request.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n <p>Describes a request to cancel a Spot Instance.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more Spot Instance requests.</p>\n ",
"xmlname": "spotInstanceRequestSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Cancels one or more Spot Instance requests. Spot Instances are instances that\n\t\t\t\tAmazon EC2 starts on your behalf when the maximum price that you specify exceeds the\n\t\t\t\tcurrent Spot Price. Amazon EC2 periodically sets the Spot Price based on available\n\t\t\t\tSpot Instance capacity and current Spot Instance requests. For more information\n\t\t\t\tabout Spot Instances, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html\">Spot\n\t\t\t\t\tInstances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <important>\n <p>Canceling a Spot Instance request does not terminate running Spot Instances\n\t\t\t\t\tassociated with the request.</p>\n </important>\n <examples>\n <example>\n <name>Example</name>\n <description>This example cancels the specified Spot Instance request.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CancelSpotInstanceRequests\n&amp;SpotInstanceRequestId.1=sir-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CancelSpotInstanceRequestsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;spotInstanceRequestSet&gt;\n &lt;item&gt;\n &lt;spotInstanceRequestId&gt;sir-1a2b3c4d&lt;/spotInstanceRequestId&gt;\n &lt;state&gt;cancelled&lt;/state&gt;\n &lt;/item&gt;\n &lt;/spotInstanceRequestSet&gt;\n&lt;/CancelSpotInstanceRequestsResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ConfirmProductInstance": {
"name": "ConfirmProductInstance",
"input": {
"shape_name": "ConfirmProductInstanceRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ProductCode": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The product code. This must be an Amazon DevPay product code that you own.</p>\n ",
"required": true
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "ConfirmProductInstanceResult",
"type": "structure",
"members": {
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the instance owner. This is only present if the product code\n\t\t\t\tis attached to the instance.</p>\n ",
"xmlname": "ownerId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Determines whether a product code is associated with an instance. This action can\n\t\t\t\tonly be used by the owner of the product code. It is useful when a product code\n\t\t\t\towner needs to verify whether another user's instance is eligible for\n\t\t\t\tsupport.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example determines whether the specified product code is associated with the\n\t\t\t\t\tspecified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ConfirmProductInstance\n&amp;ProductCode=774F4FF8\n&amp;InstanceId=i-10a64379\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ConfirmProductInstanceResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n &lt;ownerId&gt;111122223333&lt;/ownerId&gt;\n&lt;/ConfirmProductInstanceResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CopyImage": {
"name": "CopyImage",
"input": {
"shape_name": "CopyImageRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n "
},
"SourceRegion": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the region that contains the AMI to copy.</p>\n ",
"required": true
},
"SourceImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI to copy.</p>\n ",
"required": true
},
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the new AMI in the destination region.</p>\n ",
"required": false
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>A description for the new AMI in the destination region.</p>\n "
},
"ClientToken": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>Unique, case-sensitive identifier you provide to ensure\n\t\t\t\tidempotency of the request. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html\">How to Ensure Idempotency</a> in the \n\t\t\t <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n "
}
},
"documentation": " \n "
},
"output": {
"shape_name": "CopyImageResult",
"type": "structure",
"members": {
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The ID of the new AMI.</p>\n ",
"xmlname": "imageId"
}
},
"documentation": " \n "
},
"errors": [],
"documentation": " \n <p>Initiates the copy of an AMI from the specified source region to the region in which the\n request was made. You specify the destination region by using its endpoint when making the\n request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html\">Copying AMIs</a>\n in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request copies the AMI in <code>us-west-2</code> with the ID <code>ami-1a2b3c4d</code>,\n\t\t\t\t\tnaming the new AMI <code>My-Standard-AMI</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CopyImage\n&amp;SourceRegion=us-west-2\n&amp;SourceImageId=ami-1a2b3c4d \n&amp;Name=My-Standard-AMI\n&amp;Description=This%20is%20the%20new%20version%20of%20My-Standard-AMI \n&amp;ClientToken=550e8400-e29b-41d4-a716-446655440000\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CopyImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\"&gt;\n &lt;requestId&gt;60bc441d-fa2c-494d-b155-5d6a3EXAMPLE&lt;/requestId&gt;\n &lt;imageId&gt;ami-4d3c2b1a&lt;/imageId&gt;\n&lt;/CopyImageResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CopySnapshot": {
"name": "CopySnapshot",
"input": {
"shape_name": "CopySnapshotRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SourceRegion": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the region that contains the snapshot to be copied.</p>\n ",
"required": true
},
"SourceSnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Amazon EBS snapshot to copy.</p>\n ",
"required": true
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description for the new Amazon EBS snapshot.</p>\n "
},
"DestinationRegion": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The destination region of the snapshot copy operation. This parameter is required in the\n <code>PresignedUrl</code>.</p>\n "
},
"PresignedUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only\n required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an\n optional parameter in all other cases. The <code>PresignedUrl</code> should use the snapshot\n source endpoint, the <code>CopySnapshot</code> action, and include the\n <code>SourceRegion</code>, <code>SourceSnapshotId</code>, and <code>DestinationRegion</code>\n parameters. The <code>PresignedUrl</code> must be signed using AWS Signature Version 4.\n Because Amazon EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the\n same logic that is described in <a href=\"http://http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html\">Authenticating Requests by Using Query Parameters (AWS Signature Version 4)</a> in the\n <i>Amazon Simple Storage Service API Reference</i>. An invalid or improperly signed <code>PresignedUrl</code> will cause\n the copy operation to fail asynchronously, and the snapshot will move to an <code>error</code>\n state.</p>\n "
}
},
"documentation": "\n\n "
},
"output": {
"shape_name": "CopySnapshotResult",
"type": "structure",
"members": {
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the new snapshot.</p>\n ",
"xmlname": "snapshotId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Copies a point-in-time snapshot of an Amazon EBS volume and stores it in Amazon S3. You can copy the\n snapshot within the same region or from one region to another. You can use the snapshot to\n create Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional\n endpoint that you send the HTTP request to.</p>\n <p>Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain\n unencrypted.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-copy-snapshot.html\">Copying an Amazon EBS Snapshot</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request copies the snapshot in the us-west-1 region with the ID\n <code>snap-1a2b3c4d</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CopySnapshot\n&amp;SourceRegion=us-west-1\n&amp;SourceSnapshotId=snap-1a2b3c4d\n&amp;Description=My_snapshot\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CopySnapshotResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;60bc441d-fa2c-494d-b155-5d6a3EXAMPLE&lt;/requestId&gt;\n &lt;snapshotId&gt;snap-2a2b3c4d&lt;/snapshotId&gt;\n&lt;/CopySnapshotResponse&gt;</queryresponse>\n </example>\n </examples>\n \n "
},
"CreateCustomerGateway": {
"name": "CreateCustomerGateway",
"input": {
"shape_name": "CreateCustomerGatewayRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"Type": {
"shape_name": "GatewayType",
"type": "string",
"enum": [
"ipsec.1"
],
"documentation": "\n\t\t <p>The type of VPN connection that this customer gateway supports.</p>\n ",
"required": true
},
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Internet-routable IP address for the customer gateway's outside\n\t\t\t\tinterface. The address must be static.</p>\n ",
"required": true,
"xmlname": "IpAddress"
},
"BgpAsn": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>For devices that support BGP, the customer gateway's BGP ASN.</p>\n\t\t <p>Default: 65000</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateCustomerGatewayResult",
"type": "structure",
"members": {
"CustomerGateway": {
"shape_name": "CustomerGateway",
"type": "structure",
"members": {
"CustomerGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the customer gateway.</p>\n ",
"xmlname": "customerGatewayId"
},
"State": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The current state of the customer gateway.</p>\n ",
"xmlname": "state"
},
"Type": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The type of VPN connection the customer gateway supports.</p>\n ",
"xmlname": "type"
},
"IpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Internet-routable IP address of the customer gateway's outside interface.</p>\n ",
"xmlname": "ipAddress"
},
"BgpAsn": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).</p>\n ",
"xmlname": "bgpAsn"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the customer gateway.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n\t\t <p>Information about the customer gateway.</p>\n ",
"xmlname": "customerGateway"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Provides information to AWS about your VPN customer gateway device. The customer\n\t\t\t\tgateway is the appliance at your end of the VPN connection. (The device on the AWS\n\t\t\t\tside of the VPN connection is the virtual private gateway.) You must provide the\n\t\t\t\tInternet-routable IP address of the customer gateway's external interface. The IP\n\t\t\t\taddress must be static and can't be behind a device performing network address\n\t\t\t\ttranslation (NAT).</p>\n\t\t <p>For devices that use Border Gateway Protocol (BGP), you can also provide the\n\t\t\t\tdevice's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to\n\t\t\t\tyour network. If you don't have an ASN already, you can use a private ASN (in the\n\t\t\t\t64512 - 65534 range).</p>\n\t\t\t<note>\n\t\t\t\t<p>Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the\n\t\t\t\t\texception of 7224, which is reserved in the <code>us-east-1</code> region, and 9059, which is\n\t\t\t\t\treserved in the <code>eu-west-1</code> region.</p>\n\t\t\t</note>\n\t\t <p>For more information about VPN customer gateways, see\n\t\t\t\t\t<a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html\">Adding a Hardware\n\t\t\t\t\tVirtual Private Gateway to Your VPC</a> in the\n\t\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example passes information to AWS about the customer gateway with the IP\n\t\t\t\t\taddress <code>12.1.2.3</code> and BGP ASN 65534.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateCustomerGateway\n&amp;Type=ipsec.1\n&amp;IpAddress=12.1.2.3\n&amp;BgpAsn=65534\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateCustomerGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;customerGateway&gt;\t\t\n &lt;customerGatewayId&gt;cgw-b4dc3961&lt;/customerGatewayId&gt;\n &lt;state&gt;pending&lt;/state&gt;\n &lt;type&gt;ipsec.1&lt;/type&gt;\n &lt;ipAddress&gt;12.1.2.3&lt;/ipAddress&gt;\n &lt;bgpAsn&gt;65534&lt;/bgpAsn&gt;\n &lt;tagSet/&gt;\n &lt;/customerGateway&gt;\n&lt;/CreateCustomerGatewayResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateDhcpOptions": {
"name": "CreateDhcpOptions",
"input": {
"shape_name": "CreateDhcpOptionsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"DhcpConfigurations": {
"shape_name": "DhcpConfigurationList",
"type": "list",
"members": {
"shape_name": "DhcpConfiguration",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The name of a DHCP option.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n\t\t <p>One or more values for the DHCP option.</p>\n ",
"flattened": true
}
},
"documentation": "\n\t\t <p>Describes a DHCP configuration option.</p>\n ",
"xmlname": "DhcpConfiguration"
},
"documentation": "\n\t\t <p>A DHCP configuration option.</p>\n ",
"required": true,
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateDhcpOptionsResult",
"type": "structure",
"members": {
"DhcpOptions": {
"shape_name": "DhcpOptions",
"type": "structure",
"members": {
"DhcpOptionsId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the set of DHCP options.</p>\n ",
"xmlname": "dhcpOptionsId"
},
"DhcpConfigurations": {
"shape_name": "DhcpConfigurationList",
"type": "list",
"members": {
"shape_name": "DhcpConfiguration",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The name of a DHCP option.</p>\n ",
"xmlname": "key"
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more values for the DHCP option.</p>\n ",
"xmlname": "valueSet"
}
},
"documentation": "\n\t\t <p>Describes a DHCP configuration option.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more DHCP options in the set.</p>\n ",
"xmlname": "dhcpConfigurationSet"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the DHCP options set.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n\t\t <p>A set of DHCP options.</p>\n ",
"xmlname": "dhcpOptions"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Creates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see <a href=\"http://www.ietf.org/rfc/rfc2132.txt\">RFC 2132</a>.</p>\n <ul>\n <li>\n<code>domain-name-servers</code> - The IP addresses of up to four domain name servers, or\n <code>AmazonProvidedDNS</code>. The default DHCP option set specifies\n <code>AmazonProvidedDNS</code>. If specifying more than one domain name server, specify\n the IP addresses in a single parameter, separated by commas.</li>\n <li>\n<code>domain-name</code> - If you're using AmazonProvidedDNS in <code>us-east-1</code>,\n specify <code>ec2.internal</code>. If you're using AmazonProvidedDNS in another region,\n specify <code>region.compute.internal</code> (for example,\n <code>ap-northeast-1.compute.internal</code>). Otherwise, specify a domain name (for\n example, <code>MyCompany.com</code>).</li>\n <li>\n<code>ntp-servers</code> - The IP addresses of up to four Network Time Protocol (NTP)\n servers.</li>\n <li>\n<code>netbios-name-servers</code> - The IP addresses of up to four NetBIOS name\n servers.</li>\n <li>\n<code>netbios-node-type</code> - The NetBIOS node type (1, 2, 4, or 8). We recommend that\n you specify 2 (broadcast and multicast are not currently supported). For more information\n about these node types, see <a href=\"http://www.ietf.org/rfc/rfc2132.txt\">RFC 2132</a>. </li>\n </ul>\n <p>For more information about DHCP options, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html\">DHCP Options Sets</a>\n\t\t\t\tin the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a set of DHCP options with a domain name\n <code>example.com</code> and two DNS servers (<code>10.2.5.1</code> and\n <code>10.2.5.2</code>). The DNS servers' IP addresses are specified in a single\n parameter, separated by commas, to preserve the order in which they are\n specified.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateDhcpOptions \n&amp;DhcpConfiguration.1.Key=domain-name\n&amp;DhcpConfiguration.1.Value.1=example.com\n&amp;DhcpConfiguration.2.Key=domain-name-servers\n&amp;DhcpConfiguration.2.Value.1=10.2.5.1,10.2.5.2\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateDhcpOptionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;dhcpOptions&gt;\n &lt;dhcpOptionsId&gt;dopt-7a8b9c2d&lt;/dhcpOptionsId&gt;\n &lt;dhcpConfigurationSet&gt;\n &lt;item&gt;\n &lt;key&gt;domain-name&lt;/key&gt;\n &lt;valueSet&gt;\n &lt;item&gt;\n &lt;value&gt;example.com&lt;/value&gt;\n &lt;/item&gt;\n &lt;/valueSet&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;key&gt;domain-name-servers&lt;/key&gt;\n &lt;valueSet&gt;\n &lt;item&gt;\n &lt;value&gt;10.2.5.1&lt;/value&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;value&gt;10.2.5.2&lt;/value&gt;\n &lt;/item&gt;\n &lt;/valueSet&gt;\n &lt;/item&gt;\n &lt;/dhcpConfigurationSet&gt;\n &lt;tagSet/&gt;\n &lt;/dhcpOptions&gt;\n&lt;/CreateDhcpOptionsResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateImage": {
"name": "CreateImage",
"input": {
"shape_name": "CreateImageRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"required": true
},
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A name for the new image.</p>\n <p>Constraints: 3-128 alphanumeric characters, parenthesis (()), periods (.), slashes\n\t\t\t\t(/), dashes (-), or underscores(_)</p>\n ",
"required": true
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description for the new image.</p>\n "
},
"NoReboot": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>By default, this parameter is set to <code>false</code>, which means\n\t\t\t\tAmazon EC2 attempts to shut down the instance cleanly before image\n\t\t\t\tcreation and then reboots the instance. When the parameter is set to\n\t\t\t\t<code>true</code>, Amazon EC2 doesn't shut down the instance before\n\t\t\t\tcreating the image. When this option is used, file system integrity on\n\t\t\t\tthe created image can't be guaranteed.</p>\n "
},
"BlockDeviceMappings": {
"shape_name": "BlockDeviceMappingRequestList",
"type": "list",
"members": {
"shape_name": "BlockDeviceMapping",
"type": "structure",
"members": {
"VirtualName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The virtual device name.</p>\n "
},
"DeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name exposed to the instance (for example, <code>/dev/sdh</code>).</p>\n "
},
"Ebs": {
"shape_name": "EbsBlockDevice",
"type": "structure",
"members": {
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the snapshot.</p>\n "
},
"VolumeSize": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiB.</p>\n <p>Constraints: If the volume type is <code>io1</code>, the minimum size of the volume is 10 GiB.</p>\n <p>Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.</p>\n "
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n "
},
"VolumeType": {
"shape_name": "VolumeType",
"type": "string",
"enum": [
"standard",
"io1",
"gp2"
],
"documentation": "\n <p>The volume type.</p>\n <p>Default: <code>standard</code></p>\n "
},
"Iops": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of I/O operations per second (IOPS) that the\n volume supports.</p>\n <p>Constraint: Range is 100 to 4000.</p>\n <p>Condition: Required when the volume type is <code>io1</code>; not used with\n <code>standard</code> or <code>gp2</code> volumes.</p>\n "
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is encrypted.</p>\n "
}
},
"documentation": "\n <p>Parameters used to automatically set up Amazon EBS volumes when the instance is launched.</p>\n "
},
"NoDevice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Suppresses the specified device included in the block device mapping of the AMI.</p>\n "
}
},
"documentation": "\n <p>Describes a block device mapping.</p>\n ",
"xmlname": "BlockDeviceMapping"
},
"documentation": "\n <p>Information about one or more block device mappings.</p>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateImageResult",
"type": "structure",
"members": {
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the new AMI.</p>\n ",
"xmlname": "imageId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": " \n <p>Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either\n\t\t\t\trunning or stopped.</p>\n <p>If you customized your instance with instance store volumes or EBS volumes\n\t\t\t\tin addition to the root device volume, the new AMI contains block device mapping\n\t\t\t\tinformation for those volumes. When you launch an instance from this new AMI,\n\t\t\t\tthe instance automatically launches with those additional volumes.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html\">Creating Amazon EBS-Backed Linux AMIs</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request creates an AMI from the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateImage\n&amp;Description=Standard+Web+Server+v1.0\n&amp;InstanceId=i-10a64379\n&amp;Name=standard-web-server-v1.0\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;imageId&gt;ami-4fa54026&lt;/imageId&gt;\n&lt;/CreateImageResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateInstanceExportTask": {
"name": "CreateInstanceExportTask",
"input": {
"shape_name": "CreateInstanceExportTaskRequest",
"type": "structure",
"members": {
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description for the conversion task or the resource being\n exported. The maximum length is 255 bytes.</p>\n "
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"required": true
},
"TargetEnvironment": {
"shape_name": "ExportEnvironment",
"type": "string",
"enum": [
"citrix",
"vmware",
"microsoft"
],
"documentation": "\n <p>The target virtualization environment.</p>\n "
},
"ExportToS3Task": {
"shape_name": "ExportToS3TaskSpecification",
"type": "structure",
"members": {
"DiskImageFormat": {
"shape_name": "DiskImageFormat",
"type": "string",
"enum": [
"VMDK",
"RAW",
"VHD"
],
"documentation": "\n "
},
"ContainerFormat": {
"shape_name": "ContainerFormat",
"type": "string",
"enum": [
"ova"
],
"documentation": "\n "
},
"S3Bucket": {
"shape_name": "String",
"type": "string",
"documentation": "\n "
},
"S3Prefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The image is written to a single object in the Amazon S3 bucket at the S3 key\n s3prefix + exportTaskId + '.' + diskImageFormat.</p>\n "
}
},
"documentation": "\n ",
"xmlname": "ExportToS3"
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateInstanceExportTaskResult",
"type": "structure",
"members": {
"ExportTask": {
"shape_name": "ExportTask",
"type": "structure",
"members": {
"ExportTaskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the export task.</p>\n ",
"xmlname": "exportTaskId"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description of the resource being exported.</p>\n ",
"xmlname": "description"
},
"State": {
"shape_name": "ExportTaskState",
"type": "string",
"enum": [
"active",
"cancelling",
"cancelled",
"completed"
],
"documentation": "\n <p>The state of the conversion task.</p>\n ",
"xmlname": "state"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status message related to the export task.</p>\n ",
"xmlname": "statusMessage"
},
"InstanceExportDetails": {
"shape_name": "InstanceExportDetails",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the resource being exported.</p>\n ",
"xmlname": "instanceId"
},
"TargetEnvironment": {
"shape_name": "ExportEnvironment",
"type": "string",
"enum": [
"citrix",
"vmware",
"microsoft"
],
"documentation": "\n <p>The target virtualization environment.</p>\n ",
"xmlname": "targetEnvironment"
}
},
"documentation": "\n <p>The instance being exported.</p>\n ",
"xmlname": "instanceExport"
},
"ExportToS3Task": {
"shape_name": "ExportToS3Task",
"type": "structure",
"members": {
"DiskImageFormat": {
"shape_name": "DiskImageFormat",
"type": "string",
"enum": [
"VMDK",
"RAW",
"VHD"
],
"documentation": "\n <p>The format for the exported image.</p>\n ",
"xmlname": "diskImageFormat"
},
"ContainerFormat": {
"shape_name": "ContainerFormat",
"type": "string",
"enum": [
"ova"
],
"documentation": "\n <p>The container format used to combine disk images with metadata (such as OVF). If absent, only\n the disk image is exported.</p>\n ",
"xmlname": "containerFormat"
},
"S3Bucket": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Amazon S3 bucket for the destination image. The destination bucket must\n exist and grant WRITE and READ_ACL permissions to the AWS account\n <code>vm-import-export@amazon.com</code>.</p>\n ",
"xmlname": "s3Bucket"
},
"S3Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n ",
"xmlname": "s3Key"
}
},
"documentation": "\n ",
"xmlname": "exportToS3"
}
},
"documentation": "\n ",
"xmlname": "exportTask"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Exports a running or stopped instance to an Amazon S3 bucket.</p>\n \n <p>For information about the supported operating systems, image formats, and known limitations for the\n types of instances you can export, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ExportingEC2Instances.html\">Exporting EC2 Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request creates an Export VM task that makes a Windows instance available\n as an OVA.</description> \n <queryrequest>https://ec2.amazonaws.com/?Action=CreateInstanceExportTask\n &amp;Description=Example%20for%20docs\n &amp;InstanceId=i-12345678\n &amp;TargetEnvironment=VMWare\n &amp;ExportToS3.DiskImageFormat=VMDK\n &amp;ExportToS3.ContainerFormat=OVA\n &amp;ExportToS3.S3bucket=my-bucket-for-exported-vm\n &amp;ExportToS3.S3prefix=my-exports/\n &amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateInstanceExportTaskResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;exportTask&gt;\n &lt;exportTaskId&gt;export-i-1234wxyz&lt;/exportTaskId&gt;\n &lt;description&gt;Example for docs&lt;/description&gt;\n &lt;state&gt;active&lt;/state&gt;\n &lt;statusMessage&gt;Running&lt;/statusMessage&gt;\n &lt;instanceExport&gt;\n &lt;instanceId&gt;i-12345678&lt;/instanceId&gt;\n &lt;targetEnvironment&gt;VMWare&lt;/targetEnvironment&gt;\n &lt;/instanceExport&gt;\n &lt;exportToS3&gt;\n &lt;diskImageFormat&gt;VMDK&lt;/diskImageFormat&gt;\n &lt;containerFormat&gt;OVA&lt;/containerFormat&gt;\n &lt;s3Bucket&gt;my-bucket-for-exported-vm&lt;/s3Bucket&gt;\n &lt;s3Key&gt;my-exports/ export-i-1234wxyz .ova&lt;/s3Key&gt;\n &lt;/exportToS3&gt;\n &lt;/exportTask&gt;\n &lt;/CreateInstanceExportTaskResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateInternetGateway": {
"name": "CreateInternetGateway",
"input": {
"shape_name": "CreateInternetGatewayRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateInternetGatewayResult",
"type": "structure",
"members": {
"InternetGateway": {
"shape_name": "InternetGateway",
"type": "structure",
"members": {
"InternetGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the Internet gateway.</p>\n ",
"xmlname": "internetGatewayId"
},
"Attachments": {
"shape_name": "InternetGatewayAttachmentList",
"type": "list",
"members": {
"shape_name": "InternetGatewayAttachment",
"type": "structure",
"members": {
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"State": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n\t\t <p>The current state of the attachment.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n\t\t <p>Describes the attachment of a VPC to an Internet gateway.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any VPCs attached to the Internet gateway.</p>\n ",
"xmlname": "attachmentSet"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the Internet gateway.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n\t\t <p>Information about the Internet gateway.</p>\n ",
"xmlname": "internetGateway"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Creates an Internet gateway for use with a VPC. After creating the Internet\n\t\t\t\tgateway, you attach it to a VPC using <a>AttachInternetGateway</a>.</p>\n\t\t <p>For more information about your VPC and Internet gateway, see the <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/\">Amazon Virtual Private Cloud User Guide</a>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates an Internet gateway.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateInternetGateway\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><CreateInternetGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <internetGateway>\n <internetGatewayId>igw-eaad4883</internetGatewayId>\n <attachmentSet/>\n <tagSet/>\n </internetGateway>\n</CreateInternetGatewayResponse></queryresponse>\n </example>\n </examples>\n "
},
"CreateKeyPair": {
"name": "CreateKeyPair",
"input": {
"shape_name": "CreateKeyPairRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"KeyName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A unique name for the key pair.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateKeyPairResult",
"type": "structure",
"members": {
"KeyName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the key pair.</p>\n ",
"xmlname": "keyName"
},
"KeyFingerprint": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The SHA-1 digest of the DER encoded private key.</p>\n ",
"xmlname": "keyFingerprint"
},
"KeyMaterial": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>An unencrypted PEM encoded RSA private key.</p>\n ",
"xmlname": "keyMaterial"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key\n\t\t\t\tand displays the private key for you to save to a file. The private key is\n\t\t\t\treturned as an unencrypted PEM encoded PKCS#8 private key. If a key with the\n\t\t\t\tspecified name already exists, Amazon EC2 returns an error.</p>\n <p>You can have up to five thousand key pairs per region.</p>\n <p>For more information about key pairs, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Key Pairs</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request creates a key pair named <code>my-key-pair</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateKeyPair\n&amp;KeyName=my-key-pair\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateKeyPairResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n <keyName>my-key-pair</keyName>\n <keyFingerprint>\n 1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f\n </keyFingerprint>\n <keyMaterial>---- BEGIN RSA PRIVATE KEY ----\nMIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6\nb24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd\nBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN\nMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD\nVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z\nb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt\nYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ\n21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T\nrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE\nIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4\nnUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb\nFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb\nNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE\n-----END RSA PRIVATE KEY-----</keyMaterial>\n</CreateKeyPairResponse></queryresponse>\n </example>\n <example>\n <name>Saving the File</name>\n <description>Create a file named <filename>my-key-pair.pem</filename> and paste\n\t\t\t\t\tthe entire key from the response into this file.\n\t\t\t\t\tKeep this file in a safe place; it is required to decrypt login information \n\t\t\t\t\twhen you connect to an instance that you launched using this key pair.\n\t\t\t\t\tIf you're using an SSH client on a Linux computer to connect to your instance, \n\t\t\t\t\tuse the following command to set the permissions of your private key file so \n\t\t\t\t\tthat only you can read it.</description>\n <queryrequest>chmod 400 my-key-pair.pem</queryrequest>\n </example>\n </examples>\n "
},
"CreateNetworkAcl": {
"name": "CreateNetworkAcl",
"input": {
"shape_name": "CreateNetworkAclRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateNetworkAclResult",
"type": "structure",
"members": {
"NetworkAcl": {
"shape_name": "NetworkAcl",
"type": "structure",
"members": {
"NetworkAclId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network ACL.</p>\n ",
"xmlname": "networkAclId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC for the network ACL.</p>\n ",
"xmlname": "vpcId"
},
"IsDefault": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether this is the default network ACL for the VPC.</p>\n ",
"xmlname": "default"
},
"Entries": {
"shape_name": "NetworkAclEntryList",
"type": "list",
"members": {
"shape_name": "NetworkAclEntry",
"type": "structure",
"members": {
"RuleNumber": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The rule number for the entry. ACL entries are processed in ascending order by rule number.</p>\n ",
"xmlname": "ruleNumber"
},
"Protocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The protocol. A value of <code>-1</code> means all protocols.</p>\n ",
"xmlname": "protocol"
},
"RuleAction": {
"shape_name": "RuleAction",
"type": "string",
"enum": [
"allow",
"deny"
],
"documentation": "\n\t\t <p>Indicates whether to allow or deny the traffic that matches the rule.</p>\n ",
"xmlname": "ruleAction"
},
"Egress": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).</p>\n ",
"xmlname": "egress"
},
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The network range to allow or deny, in CIDR notation.</p>\n ",
"xmlname": "cidrBlock"
},
"IcmpTypeCode": {
"shape_name": "IcmpTypeCode",
"type": "structure",
"members": {
"Type": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The ICMP code. A value of -1 means all codes for the specified ICMP type.</p>\n ",
"xmlname": "type"
},
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The ICMP type. A value of -1 means all types.</p>\n ",
"xmlname": "code"
}
},
"documentation": "\n\t\t <p>ICMP protocol: The ICMP type and code.</p>\n ",
"xmlname": "icmpTypeCode"
},
"PortRange": {
"shape_name": "PortRange",
"type": "structure",
"members": {
"From": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The first port in the range.</p>\n ",
"xmlname": "from"
},
"To": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The last port in the range.</p>\n ",
"xmlname": "to"
}
},
"documentation": "\n\t\t <p>TCP or UDP protocols: The range of ports the rule applies to.</p>\n ",
"xmlname": "portRange"
}
},
"documentation": "\n\t\t <p>Describes an entry in a network ACL.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more entries (rules) in the network ACL.</p>\n ",
"xmlname": "entrySet"
},
"Associations": {
"shape_name": "NetworkAclAssociationList",
"type": "list",
"members": {
"shape_name": "NetworkAclAssociation",
"type": "structure",
"members": {
"NetworkAclAssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the association between a network ACL and a subnet.</p>\n ",
"xmlname": "networkAclAssociationId"
},
"NetworkAclId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network ACL.</p>\n ",
"xmlname": "networkAclId"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet.</p>\n ",
"xmlname": "subnetId"
}
},
"documentation": "\n\t\t <p>Describes an association between a network ACL and a subnet.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any associations between the network ACL and one or more subnets</p>\n ",
"xmlname": "associationSet"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the network ACL.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n\t\t <p>Information about the network ACL.</p>\n ",
"xmlname": "networkAcl"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition\n\t\t\t\tto security groups) for the instances in your VPC.</p>\n\t\t <p>For more information about network ACLs, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html\">Network ACLs</a> in\n\t\t\t\tthe <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a network ACL in the specified VPC. \n\t\t\t\t\tThe response includes a default entry for egress, and another for ingress,\n\t\t\t\t\teach with a very high rule number. These are the last entries we process to\n\t\t\t\t\tdecide whether traffic is allowed in or out of an associated subnet. If the\n\t\t\t\t\ttraffic doesn't match any rules with a lower rule number, then these default\n\t\t\t\t\tentries ultimately deny the traffic.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateNetworkAcl\n&amp;VpcId=vpc-11ad4878\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><CreateNetworkAclResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <networkAcl>\n <networkAclId>acl-5fb85d36</networkAclId>\n <vpcId>vpc-11ad4878</vpcId>\n <default>false</default>\n <entrySet>\n <item>\n <ruleNumber>32767</ruleNumber>\n <protocol>all</protocol>\n <ruleAction>deny</ruleAction>\n <egress>true</egress>\n <cidrBlock>0.0.0.0/0</cidrBlock>\n </item>\n <item>\n <ruleNumber>32767</ruleNumber>\n <protocol>all</protocol>\n <ruleAction>deny</ruleAction>\n <egress>false</egress>\n <cidrBlock>0.0.0.0/0</cidrBlock>\n </item>\n </entrySet>\n <associationSet/>\n <tagSet/>\n </networkAcl>\n</CreateNetworkAclResponse></queryresponse>\n </example>\n </examples>\n "
},
"CreateNetworkAclEntry": {
"name": "CreateNetworkAclEntry",
"input": {
"shape_name": "CreateNetworkAclEntryRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"NetworkAclId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the ACL.</p>\n ",
"required": true
},
"RuleNumber": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The rule number for the entry (for example, 100). ACL\n\t\t\t\tentries are processed in ascending order by rule number.</p>\n <p>Constraints: Positive integer from 1 to 32766</p>\n ",
"required": true
},
"Protocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The protocol. A value of -1 means all protocols.</p>\n ",
"required": true
},
"RuleAction": {
"shape_name": "RuleAction",
"type": "string",
"enum": [
"allow",
"deny"
],
"documentation": "\n\t\t <p>Indicates whether to allow or deny the traffic that matches the rule.</p>\n ",
"required": true
},
"Egress": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).</p>\n ",
"required": true
},
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The network range to allow or deny, in CIDR notation.</p>\n ",
"required": true
},
"IcmpTypeCode": {
"shape_name": "IcmpTypeCode",
"type": "structure",
"members": {
"Type": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The ICMP code. A value of -1 means all codes for the specified ICMP type.</p>\n "
},
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The ICMP type. A value of -1 means all types.</p>\n "
}
},
"documentation": "\n\t\t <p>ICMP protocol: The ICMP type and code.</p>\n ",
"xmlname": "Icmp"
},
"PortRange": {
"shape_name": "PortRange",
"type": "structure",
"members": {
"From": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The first port in the range.</p>\n "
},
"To": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The last port in the range.</p>\n "
}
},
"documentation": "\n\t\t <p>TCP or UDP protocols: The range of ports the rule applies to.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Creates an entry (a rule) in a network ACL with the specified rule number. Each\n\t\t\t\tnetwork ACL has a set of numbered ingress rules and a separate set of numbered\n\t\t\t\tegress rules. When determining whether a packet should be allowed in or out of a\n\t\t\t\tsubnet associated with the ACL, we process the entries in the ACL according to the\n\t\t\t\trule numbers, in ascending order. Each network ACL has a set of ingress rules and a\n\t\t\t\tseparate set of egress rules.</p>\n\t\t <p>We recommend that you leave room between the rule numbers (for example,\n\t\t\t\t100, 110, 120, ...), and not number them one right after the other (for\n\t\t\t\texample, 101, 102, 103, ...). This makes it easier to add a rule between\n\t\t\t\texisting ones without having to renumber the rules.</p>\n\t\t <p>After you add an entry, you can't modify it; you must either replace it, or create\n\t\t\t\tan entry and delete the old one.</p>\n\t\t <p>For more information about network ACLs, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html\">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates an entry with rule number 110 in the network ACL with the ID\n\t\t\t\t\t<code>acl-2cb85d45</code>. The rule allows ingress traffic from anywhere (<code>0.0.0.0/0</code>) on UDP\n\t\t\t\t\tport 53 into any associated subnet.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateNetworkAclEntry\n&amp;NetworkAclId=acl-2cb85d45\n&amp;RuleNumber=110\n&amp;Protocol=udp\n&amp;RuleAction=allow\n&amp;Egress=false\n&amp;CidrBlock=0.0.0.0/0\n&amp;PortRange.From=53\n&amp;PortRange.To=53\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateNetworkAclEntryResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/CreateNetworkAclEntryResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateNetworkInterface": {
"name": "CreateNetworkInterface",
"input": {
"shape_name": "CreateNetworkInterfaceRequest",
"type": "structure",
"members": {
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet to associate with the network interface.</p>\n ",
"required": true
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>A description for the network interface.</p>\n "
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The primary private IP address of the network interface. If you don't specify an IP\n\t\t\t\taddress, Amazon EC2 selects one for you from the subnet range.</p>\n "
},
"Groups": {
"shape_name": "SecurityGroupIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "SecurityGroupId"
},
"documentation": "\n\t\t <p>The IDs of one or more security groups.</p>\n ",
"flattened": true
},
"PrivateIpAddresses": {
"shape_name": "PrivateIpAddressSpecificationList",
"type": "list",
"members": {
"shape_name": "PrivateIpAddressSpecification",
"type": "structure",
"members": {
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP addresses.</p>\n ",
"required": true
},
"Primary": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the private IP address is the primary private IP address.</p>\n "
}
},
"documentation": "\n\t\t <p>Describes a secondary private IP address for a network interface.</p>\n "
},
"documentation": "\n\t\t <p>One or more private IP addresses.</p>\n ",
"flattened": true
},
"SecondaryPrivateIpAddressCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The number of secondary private IP addresses to assign to a network\n\t\t\t\tinterface. When you specify a number of secondary IP addresses, Amazon EC2\n\t\t\t\tselects these IP addresses within the subnet range.</p>\n <p>The number of IP addresses you can assign to a network interface\n\t\t\t\tvaries by instance type. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI\">Private IP Addresses Per ENI Per Instance Type</a> in the\n\t\t\t\t<i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n "
},
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateNetworkInterfaceResult",
"type": "structure",
"members": {
"NetworkInterface": {
"shape_name": "NetworkInterface",
"type": "structure",
"members": {
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"xmlname": "networkInterfaceId"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet.</p>\n ",
"xmlname": "subnetId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Availability Zone.</p>\n ",
"xmlname": "availabilityZone"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>A description.</p>\n ",
"xmlname": "description"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The AWS account ID of the owner of the network interface.</p>\n ",
"xmlname": "ownerId"
},
"RequesterId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the entity that launched the instance on your behalf (for example, AWS\n\t\t\t\tManagement Console or Auto Scaling).</p>\n ",
"xmlname": "requesterId"
},
"RequesterManaged": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the network interface is being managed by AWS.</p>\n ",
"xmlname": "requesterManaged"
},
"Status": {
"shape_name": "NetworkInterfaceStatus",
"type": "string",
"enum": [
"available",
"attaching",
"in-use",
"detaching"
],
"documentation": "\n\t\t <p>The status of the network interface.</p>\n ",
"xmlname": "status"
},
"MacAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The MAC address.</p>\n ",
"xmlname": "macAddress"
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The IP address of the network interface within the subnet.</p>\n ",
"xmlname": "privateIpAddress"
},
"PrivateDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private DNS name.</p>\n ",
"xmlname": "privateDnsName"
},
"SourceDestCheck": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether traffic to or from the instance is validated.</p>\n ",
"xmlname": "sourceDestCheck"
},
"Groups": {
"shape_name": "GroupIdentifierList",
"type": "list",
"members": {
"shape_name": "GroupIdentifier",
"type": "structure",
"members": {
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any security groups for the network interface.</p>\n ",
"xmlname": "groupSet"
},
"Attachment": {
"shape_name": "NetworkInterfaceAttachment",
"type": "structure",
"members": {
"AttachmentId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface attachment.</p>\n ",
"xmlname": "attachmentId"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"InstanceOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The AWS account ID of the owner of the instance.</p>\n ",
"xmlname": "instanceOwnerId"
},
"DeviceIndex": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The device index of the network interface attachment on the instance.</p>\n ",
"xmlname": "deviceIndex"
},
"Status": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n\t\t <p>The attachment state.</p>\n ",
"xmlname": "status"
},
"AttachTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n\t\t <p>The timestamp indicating when the attachment initiated.</p>\n ",
"xmlname": "attachTime"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the network interface is deleted when the instance is terminated.</p>\n ",
"xmlname": "deleteOnTermination"
}
},
"documentation": "\n\t\t <p>The network interface attachment.</p>\n ",
"xmlname": "attachment"
},
"Association": {
"shape_name": "NetworkInterfaceAssociation",
"type": "structure",
"members": {
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The address of the Elastic IP address bound to the network interface.</p>\n ",
"xmlname": "publicIp"
},
"PublicDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t<p>The public DNS name.</p>\n\t",
"xmlname": "publicDnsName"
},
"IpOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the Elastic IP address owner.</p>\n ",
"xmlname": "ipOwnerId"
},
"AllocationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The allocation ID.</p>\n ",
"xmlname": "allocationId"
},
"AssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The association ID.</p>\n ",
"xmlname": "associationId"
}
},
"documentation": "\n\t\t <p>The association information for an Elastic IP associated with the network interface.</p>\n ",
"xmlname": "association"
},
"TagSet": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the network interface.</p>\n ",
"xmlname": "tagSet"
},
"PrivateIpAddresses": {
"shape_name": "NetworkInterfacePrivateIpAddressList",
"type": "list",
"members": {
"shape_name": "NetworkInterfacePrivateIpAddress",
"type": "structure",
"members": {
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP address.</p>\n ",
"xmlname": "privateIpAddress"
},
"PrivateDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private DNS name.</p>\n ",
"xmlname": "privateDnsName"
},
"Primary": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether this IP address is the primary private IP address of the network interface.</p>\n ",
"xmlname": "primary"
},
"Association": {
"shape_name": "NetworkInterfaceAssociation",
"type": "structure",
"members": {
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The address of the Elastic IP address bound to the network interface.</p>\n ",
"xmlname": "publicIp"
},
"PublicDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t<p>The public DNS name.</p>\n\t",
"xmlname": "publicDnsName"
},
"IpOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the Elastic IP address owner.</p>\n ",
"xmlname": "ipOwnerId"
},
"AllocationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The allocation ID.</p>\n ",
"xmlname": "allocationId"
},
"AssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The association ID.</p>\n ",
"xmlname": "associationId"
}
},
"documentation": "\n\t\t <p>The association information for an Elastic IP address associated with the network interface.</p>\n ",
"xmlname": "association"
}
},
"documentation": "\n\t\t <p>Describes the private IP address of a network interface.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>The private IP addresses associated with the network interface.</p>\n ",
"xmlname": "privateIpAddressesSet"
}
},
"documentation": "\n\t\t <p>Information about the network interface.</p>\n ",
"xmlname": "networkInterface"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Creates a network interface in the specified subnet.</p>\n\t\t <p>For more information about network interfaces, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html\">Elastic Network Interfaces</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example creates a network interface in the specified\n\t\t\t\t\tsubnet with a primary IP address that is automatically selected by Amazon EC2.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateNetworkInterface\n&amp;SubnetId=subnet-b2a249da\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateNetworkInterfaceResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;8dbe591e-5a22-48cb-b948-dd0aadd55adf&lt;/requestId&gt;\n &lt;networkInterface&gt;\n &lt;networkInterfaceId&gt;eni-cfca76a6&lt;/networkInterfaceId&gt;\n &lt;subnetId&gt;subnet-b2a249da&lt;/subnetId&gt;\n &lt;vpcId&gt;vpc-c31dafaa&lt;/vpcId&gt;\n &lt;availabilityZone&gt;ap-southeast-1b&lt;/availabilityZone&gt;\n &lt;description/&gt;\n &lt;ownerId&gt;251839141158&lt;/ownerId&gt;\n &lt;requesterManaged&gt;false&lt;/requesterManaged&gt;\n &lt;status&gt;available&lt;/status&gt;\n &lt;macAddress&gt;02:74:b0:72:79:61&lt;/macAddress&gt;\n &lt;privateIpAddress&gt;10.0.2.157&lt;/privateIpAddress&gt;\n &lt;sourceDestCheck&gt;true&lt;/sourceDestCheck&gt;\n &lt;groupSet&gt;\n &lt;item&gt;\n &lt;groupId&gt;sg-1a2b3c4d&lt;/groupId&gt;\n &lt;groupName&gt;default&lt;/groupName&gt;\n &lt;/item&gt;\n &lt;/groupSet&gt;\n &lt;tagSet/&gt;\n &lt;privateIpAddressesSet&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.2.157&lt;/privateIpAddress&gt;\n &lt;primary&gt;true&lt;/primary&gt;\n &lt;/item&gt;\n &lt;/privateIpAddressesSet&gt;\n &lt;/networkInterface&gt;\n&lt;/CreateNetworkInterfaceResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example creates a network interface in the specified\n\t\t\t\t\tsubnet with a primary IP address of <code>10.0.2.140</code> and four secondary private IP\n\t\t\t\t\taddresses that are automatically selected by Amazon EC2.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateNetworkInterface\n&amp;PrivateIpAddresses.0.Primary=true\n&amp;PrivateIpAddresses.0.PrivateIpAddress=10.0.2.140\n&amp;SecondaryPrivateIpAddressCount=4\n&amp;SubnetId=subnet-a61dafcf\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateNetworkInterfaceResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;bd78c839-0895-4fac-a17f-98b559b6b630&lt;/requestId&gt;\n &lt;networkInterface&gt;\n &lt;networkInterfaceId&gt;eni-1bcb7772&lt;/networkInterfaceId&gt;\n &lt;subnetId&gt;subnet-a61dafcf&lt;/subnetId&gt;\n &lt;vpcId&gt;vpc-c31dafaa&lt;/vpcId&gt;\n &lt;availabilityZone&gt;ap-southeast-1b&lt;/availabilityZone&gt;\n &lt;description/&gt;\n &lt;ownerId&gt;251839141158&lt;/ownerId&gt;\n &lt;requesterManaged&gt;false&lt;/requesterManaged&gt;\n &lt;status&gt;pending&lt;/status&gt;\n &lt;macAddress&gt;02:74:b0:70:7f:1a&lt;/macAddress&gt;\n &lt;privateIpAddress&gt;10.0.2.140&lt;/privateIpAddress&gt;\n &lt;sourceDestCheck&gt;true&lt;/sourceDestCheck&gt;\n &lt;groupSet&gt;\n &lt;item&gt;\n &lt;groupId&gt;sg-1a2b3c4d&lt;/groupId&gt;\n &lt;groupName&gt;default&lt;/groupName&gt;\n &lt;/item&gt;\n &lt;/groupSet&gt;\n &lt;tagSet/&gt;\n &lt;privateIpAddressesSet&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.2.140&lt;/privateIpAddress&gt;\n &lt;primary&gt;true&lt;/primary&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.2.172&lt;/privateIpAddress&gt;\n &lt;primary&gt;false&lt;/primary&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.2.169&lt;/privateIpAddress&gt;\n &lt;primary&gt;false&lt;/primary&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.2.170&lt;/privateIpAddress&gt;\n &lt;primary&gt;false&lt;/primary&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.2.171&lt;/privateIpAddress&gt;\n &lt;primary&gt;false&lt;/primary&gt;\n &lt;/item&gt;\n &lt;/privateIpAddressesSet&gt;\n &lt;/networkInterface&gt;\n&lt;/CreateNetworkInterfaceResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example creates a network interface with a primary private IP\n\t\t\t\t\taddress of 10.0.2.130 and two secondary IP addresses of 10.0.2.132 and\n\t\t\t\t\t10.0.2.133.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateNetworkInterface\n&amp;PrivateIpAddresses.0.Primary=true\n&amp;PrivateIpAddresses.0.PrivateIpAddress=10.0.2.130\n&amp;PrivateIpAddresses.1.Primary=false\n&amp;PrivateIpAddresses.1.PrivateIpAddress=10.0.2.132\n&amp;PrivateIpAddresses.2.Primary=false\n&amp;PrivateIpAddresses.2.PrivateIpAddress=10.0.2.133\n&amp;SubnetId=subnet-a61dafcf\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateNetworkInterfaceResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n&lt;requestId&gt;a9565f4c-f928-4113-859b-905886d11658&lt;/requestId&gt;\n &lt;networkInterface&gt;\n &lt;networkInterfaceId&gt;eni-41c47828&lt;/networkInterfaceId&gt;\n &lt;subnetId&gt;subnet-a61dafcf&lt;/subnetId&gt;\n &lt;vpcId&gt;vpc-c31dafaa&lt;/vpcId&gt;\n &lt;availabilityZone&gt;ap-southeast-1b&lt;/availabilityZone&gt;\n &lt;description/&gt;\n &lt;ownerId&gt;251839141158&lt;/ownerId&gt;\n &lt;requesterManaged&gt;false&lt;/requesterManaged&gt;\n &lt;status&gt;pending&lt;/status&gt;\n &lt;macAddress&gt;02:74:b0:78:bf:ab&lt;/macAddress&gt;\n &lt;privateIpAddress&gt;10.0.2.130&lt;/privateIpAddress&gt;\n &lt;sourceDestCheck&gt;true&lt;/sourceDestCheck&gt;\n &lt;groupSet&gt;\n &lt;item&gt;\n &lt;groupId&gt;sg-188d9f74&lt;/groupId&gt;\n &lt;groupName&gt;default&lt;/groupName&gt;\n &lt;/item&gt;\n &lt;/groupSet&gt;\n &lt;tagSet/&gt;\n &lt;privateIpAddressesSet&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.2.130&lt;/privateIpAddress&gt;\n &lt;primary&gt;true&lt;/primary&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.2.133&lt;/privateIpAddress&gt;\n &lt;primary&gt;false&lt;/primary&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.2.132&lt;/privateIpAddress&gt;\n &lt;primary&gt;false&lt;/primary&gt;\n &lt;/item&gt;\n &lt;/privateIpAddressesSet&gt;\n &lt;/networkInterface&gt;\n&lt;/CreateNetworkInterfaceResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreatePlacementGroup": {
"name": "CreatePlacementGroup",
"input": {
"shape_name": "CreatePlacementGroupRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A name for the placement group.</p>\n <p>Constraints: Up to 255 ASCII characters</p>\n ",
"required": true
},
"Strategy": {
"shape_name": "PlacementStrategy",
"type": "string",
"enum": [
"cluster"
],
"documentation": "\n <p>The placement strategy.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Creates a placement group that you launch cluster instances into. You must give\n\t\t\t the group a name that's unique within the scope of your account.</p>\n <p>For more information about placement groups and cluster instances, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html\">Cluster Instances</a>\n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a placement group named <code>XYZ-cluster</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreatePlacementGroup\n&amp;GroupName=XYZ-cluster\n&amp;Strategy=cluster\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreatePlacementGroupResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/CreatePlacementGroupResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateReservedInstancesListing": {
"name": "CreateReservedInstancesListing",
"input": {
"shape_name": "CreateReservedInstancesListingRequest",
"type": "structure",
"members": {
"ReservedInstancesId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the active Reserved Instance.</p>\n ",
"required": true
},
"InstanceCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of instances that are a part of a Reserved Instance account to be listed\n\t\t\t\tin the Reserved Instance Marketplace. This number should be less than or equal to the\n\t\t\t\tinstance count associated with the Reserved Instance ID specified in this call.</p>\n ",
"required": true
},
"PriceSchedules": {
"shape_name": "PriceScheduleSpecificationList",
"type": "list",
"members": {
"shape_name": "PriceScheduleSpecification",
"type": "structure",
"members": {
"Term": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of months remaining in the reservation. For example, 2 is the second \n\t\t\t\tto the last month before the capacity reservation expires.</p>\n "
},
"Price": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>The fixed price for the term.</p>\n "
},
"CurrencyCode": {
"shape_name": "CurrencyCodeValues",
"type": "string",
"enum": [
"USD"
],
"documentation": "\n <p>The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is <code>USD</code>.</p>\n "
}
},
"documentation": "\n <p>Describes the price for a Reserved Instance.</p>\n "
},
"documentation": "\n <p>A list specifying the price of the Reserved Instance for each month\n\t\t\t\tremaining in the Reserved Instance term.</p>\n ",
"required": true,
"flattened": true
},
"ClientToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Unique, case-sensitive identifier you provide to ensure idempotency of your\n\t\t\t\tlistings. This helps avoid duplicate listings. For more information, see \n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html\">Ensuring Idempotency</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateReservedInstancesListingResult",
"type": "structure",
"members": {
"ReservedInstancesListings": {
"shape_name": "ReservedInstancesListingList",
"type": "list",
"members": {
"shape_name": "ReservedInstancesListing",
"type": "structure",
"members": {
"ReservedInstancesListingId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Reserved Instance listing.</p>\n ",
"xmlname": "reservedInstancesListingId"
},
"ReservedInstancesId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Reserved Instance.</p>\n ",
"xmlname": "reservedInstancesId"
},
"CreateDate": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time the listing was created.</p>\n ",
"xmlname": "createDate"
},
"UpdateDate": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The last modified timestamp of the listing.</p>\n ",
"xmlname": "updateDate"
},
"Status": {
"shape_name": "ListingStatus",
"type": "string",
"enum": [
"active",
"pending",
"cancelled",
"closed"
],
"documentation": "\n <p>The status of the Reserved Instance listing.</p>\n ",
"xmlname": "status"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason for the current status of the Reserved Instance listing. \n\t\t\t\tThe response can be blank.</p>\n ",
"xmlname": "statusMessage"
},
"InstanceCounts": {
"shape_name": "InstanceCountList",
"type": "list",
"members": {
"shape_name": "InstanceCount",
"type": "structure",
"members": {
"State": {
"shape_name": "ListingState",
"type": "string",
"enum": [
"available",
"sold",
"cancelled",
"pending"
],
"documentation": "\n <p>The states of the listed Reserved Instances.</p>\n ",
"xmlname": "state"
},
"InstanceCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>he number of listed Reserved Instances in the state specified by the <code>state</code>.</p>\n ",
"xmlname": "instanceCount"
}
},
"documentation": "\n <p>Describes a Reserved Instance listing state.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The number of instances in this state.</p>\n ",
"xmlname": "instanceCounts"
},
"PriceSchedules": {
"shape_name": "PriceScheduleList",
"type": "list",
"members": {
"shape_name": "PriceSchedule",
"type": "structure",
"members": {
"Term": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of months remaining in the reservation. For example, 2 is the second \n\t\t\t\tto the last month before the capacity reservation expires.</p>\n ",
"xmlname": "term"
},
"Price": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>The fixed price for the term.</p>\n ",
"xmlname": "price"
},
"CurrencyCode": {
"shape_name": "CurrencyCodeValues",
"type": "string",
"enum": [
"USD"
],
"documentation": "\n <p>The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is <code>USD</code>.</p>\n ",
"xmlname": "currencyCode"
},
"Active": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>The current price schedule, as determined by the term remaining for the \n\t\t\t\tReserved Instance in the listing.</p>\n <p>A specific price schedule is always in effect, \n\t\t\t\tbut only one price schedule can be active at any time. Take, for example, a \n\t\t\t\tReserved Instance listing that has five months remaining in its term. When you \n\t\t\t\tspecify price schedules for five months and two months, this means that \n\t\t\t\tschedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. \n\t\t\t\tThen schedule 2, covering the last two months of the term, will be active for months 2 and 1.</p>\n ",
"xmlname": "active"
}
},
"documentation": "\n <p>Describes the price for a Reserved Instance.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The price of the Reserved Instance listing.</p>\n ",
"xmlname": "priceSchedules"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the resource.</p>\n ",
"xmlname": "tagSet"
},
"ClientToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The idempotency token you provided when you created the listing.</p>\n ",
"xmlname": "clientToken"
}
},
"documentation": "\n <p>Describes a Reserved Instance listing.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about the Reserved Instances listing.</p>\n ",
"xmlname": "reservedInstancesListingsSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. \n You can submit one Reserved Instance listing at a time.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html\">Reserved Instance Marketplace</a> in the\n\t\t\t\t<i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a Reserved Instance Marketplace listing from the \n specified Reserved Instance, which has 11 months remaining in its term. \n In this example, we set the upfront price at $2.50, and the price drops\n\t\t\t\t\tover the course of the 11-month term if the instance is still not sold.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateReservedInstancesListing\n&amp;ClientToken=myIdempToken1\n&amp;InstanceCount=1\n&amp;PriceSchedules.0.Price=2.5\n&amp;PriceSchedules.0.Term=11\n&amp;PriceSchedules.1.Price=2.0\n&amp;PriceSchedules.1.Term=8\n&amp;PriceSchedules.2.Price=1.5\n&amp;PriceSchedules.2.Term=5\n&amp;PriceSchedules.3.Price=0.7\n&amp;PriceSchedules.3.Term=3\n&amp;PriceSchedules.4.Price=0.1\n&amp;PriceSchedules.4.Term=1\n&amp;ReservedInstancesId=e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><CreateReservedInstancesListingResponse>\n <requestId>a42481af-335a-4e9e-b291-bd18dexample</requestId>\n <reservedInstancesListingsSet>\n <item>\n <reservedInstancesListingId>5ec28771-05ff-4b9b-aa31-9e57dEXAMPLE</reservedInstancesListingId>\n <reservedInstancesId>e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE</reservedInstancesId>\n <createDate>2012-07-17T17:11:09.449Z</createDate>\n <updateDate>2012-07-17T17:11:09.468Z</updateDate>\n <status>active</status>\n <statusMessage>ACTIVE</statusMessage>\n <instanceCounts>\n <item>\n <state>Available</state>\n <instanceCount>1</instanceCount>\n </item>\n <item>\n <state>Sold</state>\n <instanceCount>0</instanceCount>\n </item>\n <item>\n <state>Cancelled</state>\n <instanceCount>0</instanceCount>\n </item>\n <item>\n <state>Pending</state>\n <instanceCount>0</instanceCount>\n </item>\n </instanceCounts>\n <priceSchedules>\n <item>\n <term>11</term>\n <price>2.5</price>\n <currencyCode>USD</currencyCode>\n <active>true</active>\n </item>\n <item>\n <term>10</term>\n <price>2.5</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>9</term>\n <price>2.5</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>8</term>\n <price>2.0</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>7</term>\n <price>2.0</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>6</term>\n <price>2.0</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>5</term>\n <price>1.5</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>4</term>\n <price>1.5</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>3</term>\n <price>0.7</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>2</term>\n <price>0.7</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>1</term>\n <price>0.1</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n </priceSchedules>\n <tagSet/>\n <clientToken>myIdempToken1</clientToken>\n </item>\n </reservedInstancesListingsSet>\n</CreateReservedInstancesListingResponse></queryresponse>\n </example>\n </examples>\n "
},
"CreateRoute": {
"name": "CreateRoute",
"input": {
"shape_name": "CreateRouteRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"RouteTableId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the route table for the route.</p>\n ",
"required": true
},
"DestinationCidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR address block used for the destination match. Routing\n\t\t\t\tdecisions are based on the most specific match.</p>\n ",
"required": true
},
"GatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of an Internet gateway attached to your VPC.</p>\n "
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of a NAT instance in your VPC. The operation fails if\n\t\t\t\tyou specify an instance ID unless exactly one network interface is\n\t\t\t\tattached.</p>\n "
},
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of a network interface.</p>\n "
},
"VpcPeeringConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of a VPC peering connection.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Creates a route in a route table within a VPC.</p>\n <p>You must specify one of the following targets: Internet gateway, NAT instance, VPC peering connection, or network interface.</p>\n <p>When determining how to route traffic, we use the route with the most specific\n\t\t\tmatch. For example, let's say the traffic is destined for <code>192.0.2.3</code>, and the route\n\t\t\ttable includes the following two routes:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<p><code>192.0.2.0/24</code> (goes to some target A)</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p><code>192.0.2.0/28</code> (goes to some target B)</p>\n\t\t\t\t</li>\n\t\t\t</ul>\n\t\t <p>Both routes apply to the traffic destined for <code>192.0.2.3</code>. However, the second route\n\t\t\t\tin the list covers a smaller number of IP addresses and is therefore more specific,\n\t\t\t\tso we use that route to determine where to target the traffic.</p>\n <p>For more information about route tables, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html\">Route Tables</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example creates a route in the route table with the ID <code>rtb-e4ad488d</code>. The\n\t\t\t\t\troute matches all traffic (<code>0.0.0.0/0</code>) and routes it to the Internet gateway with the\n\t\t\t\t\tID <code>igw-eaad4883</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateRoute\n&amp;RouteTableId=rtb-e4ad488d\n&amp;DestinationCidrBlock=0.0.0.0/0\n&amp;GatewayId=igw-eaad4883\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example creates a route in the route table with the ID <code>rtb-g8ff4ea2</code>. The\n\t\t\t\t\troute sends all traffic (<code>0.0.0.0/0</code>) to the NAT instance with the ID\n\t\t\t\t\t<code>i-1a2b3c4d</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateRoute\n&amp;RouteTableId=rtb-g8ff4ea2\n&amp;DestinationCidrBlock=0.0.0.0/0\n&amp;InstanceId=i-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example command creates a route in route table <code>rtb-g8ff4ea2</code>. The route\n matches traffic for the CIDR block <code>10.0.0.0/16</code> and routes it to VPC\n peering connection, <code>pcx-111aaa22</code>. This route enables traffic to be\n directed to the other peered VPC in the VPC peering connection.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateRoute\n&amp;RouteTableId=rtb-g8ff4ea2\n&amp;DestinationCidrBlock=10.0.0.0/16\n&amp;vpcPeeringConnectionId=pcx-111aaa22\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"CreateRouteTable": {
"name": "CreateRouteTable",
"input": {
"shape_name": "CreateRouteTableRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateRouteTableResult",
"type": "structure",
"members": {
"RouteTable": {
"shape_name": "RouteTable",
"type": "structure",
"members": {
"RouteTableId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the route table.</p>\n ",
"xmlname": "routeTableId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"Routes": {
"shape_name": "RouteList",
"type": "list",
"members": {
"shape_name": "Route",
"type": "structure",
"members": {
"DestinationCidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR block used for the destination match.</p>\n ",
"xmlname": "destinationCidrBlock"
},
"GatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of a gateway attached to your VPC.</p>\n ",
"xmlname": "gatewayId"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of a NAT instance in your VPC.</p>\n ",
"xmlname": "instanceId"
},
"InstanceOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The AWS account ID of the owner of the instance.</p>\n ",
"xmlname": "instanceOwnerId"
},
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"xmlname": "networkInterfaceId"
},
"VpcPeeringConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC peering connection.</p>\n ",
"xmlname": "vpcPeeringConnectionId"
},
"State": {
"shape_name": "RouteState",
"type": "string",
"enum": [
"active",
"blackhole"
],
"documentation": "\n\t\t <p>The state of the route. The <code>blackhole</code> state indicates that the\n\t\t\t\troute's target isn't available (for example, the specified gateway isn't attached to the\n\t\t\t\tVPC, or the specified NAT instance has been terminated).</p>\n ",
"xmlname": "state"
},
"Origin": {
"shape_name": "RouteOrigin",
"type": "string",
"enum": [
"CreateRouteTable",
"CreateRoute",
"EnableVgwRoutePropagation"
],
"documentation": "\n <p>Describes how the route was created.</p>\n <ul>\n <li>\n<code>CreateRouteTable</code> indicates that route was automatically created when the route table was created.</li>\n <li>\n<code>CreateRoute</code> indicates that the route was manually added to the route table.</li>\n <li>\n<code>EnableVgwRoutePropagation</code> indicates that the route was propagated by route propagation.</li>\n </ul>\n ",
"xmlname": "origin"
}
},
"documentation": "\n\t\t <p>Describes a route in a route table.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>The routes in the route table.</p>\n ",
"xmlname": "routeSet"
},
"Associations": {
"shape_name": "RouteTableAssociationList",
"type": "list",
"members": {
"shape_name": "RouteTableAssociation",
"type": "structure",
"members": {
"RouteTableAssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the association between a route table and a subnet.</p>\n ",
"xmlname": "routeTableAssociationId"
},
"RouteTableId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the route table.</p>\n ",
"xmlname": "routeTableId"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet.</p>\n ",
"xmlname": "subnetId"
},
"Main": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether this is the main route table.</p>\n ",
"xmlname": "main"
}
},
"documentation": "\n\t\t <p>Describes an association between a route table and a subnet.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>The associations between the route table and one or more subnets.</p>\n ",
"xmlname": "associationSet"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the route table.</p>\n ",
"xmlname": "tagSet"
},
"PropagatingVgws": {
"shape_name": "PropagatingVgwList",
"type": "list",
"members": {
"shape_name": "PropagatingVgw",
"type": "structure",
"members": {
"GatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the virtual private gateway (VGW).</p>\n ",
"xmlname": "gatewayId"
}
},
"documentation": "\n\t\t <p>Describes a virtual private gateway propagating route.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any virtual private gateway (VGW) propagating routes.</p>\n ",
"xmlname": "propagatingVgwSet"
}
},
"documentation": "\n\t\t <p>Information about the route table.</p>\n ",
"xmlname": "routeTable"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Creates a route table for the specified VPC. After you create a route table, you can\n\t\t\tadd routes and associate the table with a subnet.</p>\n <p>For more information about route tables, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html\">Route Tables</a> in\n\t\t\t\tthe <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a route table for the VPC with the ID <code>vpc-11ad4878</code>.\n By default, every route table includes a local route that enables traffic to\n\t\t\t\t\tflow within the VPC. The following response shows that route.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateRouteTable\n&amp;VpcId=vpc-11ad4878\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><CreateRouteTableResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <routeTable>\n <routeTableId>rtb-f9ad4890</routeTableId>\n <vpcId>vpc-11ad4878</vpcId>\n <routeSet>\n <item>\n <destinationCidrBlock>10.0.0.0/22</destinationCidrBlock>\n <gatewayId>local</gatewayId>\n <state>active</state>\n </item>\n </routeSet>\n <associationSet/>\n <tagSet/>\n </routeTable>\n</CreateRouteTableResponse></queryresponse>\n </example>\n </examples>\n "
},
"CreateSecurityGroup": {
"name": "CreateSecurityGroup",
"input": {
"shape_name": "CreateSecurityGroupRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n <p>Constraints: Up to 255 characters in length</p>\n <p>Constraints for EC2-Classic: ASCII characters</p>\n <p>Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&amp;;{}!$*</p>\n ",
"required": true
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description for the security group. This is informational only.</p>\n ",
"required": true,
"xmlname": "GroupDescription"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] The ID of the VPC.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateSecurityGroupResult",
"type": "structure",
"members": {
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Creates a security group.</p>\n <p>A security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 Security Groups</a> in \n\t\t\t\tthe <i>Amazon Elastic Compute Cloud User Guide</i> and \n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <important>\n\t\t\t\t<p>EC2-Classic: You can have up to 500 security groups.</p>\n\t\t\t\t<p>EC2-VPC: You can create up to 100 security groups per VPC.</p>\n\t\t\t</important>\n <p>When you create a security group, you specify a friendly name of your choice. You\n\t\t\t\tcan have a security group for use in EC2-Classic with the same name as a security group\n\t\t\t\tfor use in a VPC. However, you can't have two security groups for use in EC2-Classic with the\n\t\t\t\tsame name or two security groups for use in a VPC with the same name.</p>\n <p>You have a default security group for use in EC2-Classic and a default security group\n\t\t\t\tfor use in your VPC. If you don't specify a security group when you launch an instance, the\n\t\t\t\tinstance is launched into the appropriate default security group. A default security\n\t\t\t\tgroup includes a default rule that grants instances unrestricted network access to\n\t\t\t\teach other.</p>\n <p>You can add or remove rules from your security groups using \n\t\t\t\t\t<a>AuthorizeSecurityGroupIngress</a>,\n\t\t\t\t\t<a>AuthorizeSecurityGroupEgress</a>,\n\t\t\t\t\t<a>RevokeSecurityGroupIngress</a>, and\n\t\t\t\t\t<a>RevokeSecurityGroupEgress</a>.</p>\n <examples>\n <example>\n <name>Example for EC2-Classic</name>\n <description>This example creates a security group named <code>websrv</code> for EC2-Classic.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateSecurityGroup\n&amp;GroupName=websrv\n&amp;GroupDescription=Web Servers\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateSecurityGroupResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n &lt;groupId&gt;sg-1a2b3c4d&lt;/groupId&gt;\n&lt;/CreateSecurityGroupResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example for EC2-VPC</name>\n <description>This example creates a security group named <code>WebServerSG</code> for the specified VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateSecurityGroup\n&amp;GroupName=WebServerSG\n&amp;GroupDescription=Web Servers\n&amp;VpcId=vpc-3325caf2\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateSecurityGroupResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n &lt;groupId&gt;sg-0a42d66a&lt;/groupId&gt;\n&lt;/CreateSecurityGroupResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateSnapshot": {
"name": "CreateSnapshot",
"input": {
"shape_name": "CreateSnapshotRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Amazon EBS volume.</p>\n ",
"required": true
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description for the snapshot.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "Snapshot",
"type": "structure",
"members": {
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the snapshot.</p>\n ",
"xmlname": "snapshotId"
},
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"xmlname": "volumeId"
},
"State": {
"shape_name": "SnapshotState",
"type": "string",
"enum": [
"pending",
"completed",
"error"
],
"documentation": "\n <p>The snapshot state.</p>\n ",
"xmlname": "status"
},
"StartTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when the snapshot was initiated.</p>\n ",
"xmlname": "startTime"
},
"Progress": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The progress of the snapshot, as a percentage.</p>\n ",
"xmlname": "progress"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the Amazon EBS snapshot owner.</p>\n ",
"xmlname": "ownerId"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The description for the snapshot.</p>\n ",
"xmlname": "description"
},
"VolumeSize": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiB.</p>\n ",
"xmlname": "volumeSize"
},
"OwnerAlias": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account alias (for example, <code>amazon</code>, <code>self</code>) or AWS account ID\n that owns the snapshot.</p>\n ",
"xmlname": "ownerAlias"
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the snapshot is encrypted.</p>\n ",
"xmlname": "encrypted"
}
},
"documentation": "\n ",
"xmlname": "snapshot"
},
"errors": [],
"documentation": "\n <p>Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups,\n to make copies of Amazon EBS volumes, and to save data before shutting down an instance.</p>\n <p>When a snapshot is created, any AWS Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.</p>\n <p>You can take a snapshot of an attached volume that is in use. However, snapshots only capture\n data that has been written to your Amazon EBS volume at the time the snapshot command is issued;\n this may exclude any data that has been cached by any applications or the operating system. If\n you can pause any file writes to the volume long enough to take a snapshot, your snapshot\n should be complete. However, if you cannot pause all file writes to the volume, you should\n unmount the volume from within the instance, issue the snapshot command, and then remount the\n volume to ensure a consistent and complete snapshot. You may remount and use your volume while\n the snapshot status is <code>pending</code>.</p>\n <p>To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance\n before taking the snapshot.</p>\n <p>Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are\n created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and\n any associated snapshots always remain protected.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html\">Amazon Elastic Block Store</a> and <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html\">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a snapshot of the volume with the ID\n <code>vol-1a2b3c4d</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateSnapshot\n&amp;VolumeId=vol-1a2b3c4d\n&amp;Description=Daily+Backup\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateSnapshotResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;snapshotId&gt;snap-1a2b3c4d&lt;/snapshotId&gt;\n &lt;volumeId&gt;vol-1a2b3c4d&lt;/volumeId&gt;\n &lt;status&gt;pending&lt;/status&gt;\n &lt;startTime&gt;YYYY-MM-DDTHH:MM:SS.000Z&lt;/startTime&gt;\n &lt;progress&gt;60%&lt;/progress&gt;\n &lt;ownerId&gt;111122223333&lt;/ownerId&gt;\n &lt;volumeSize&gt;30&lt;/volumeSize&gt;\n &lt;description&gt;Daily Backup&lt;/description&gt;\n&lt;/CreateSnapshotResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateSpotDatafeedSubscription": {
"name": "CreateSpotDatafeedSubscription",
"input": {
"shape_name": "CreateSpotDatafeedSubscriptionRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"Bucket": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Amazon S3 bucket in which to store the Spot Instance datafeed.</p>\n <p>Constraints: Must be a valid bucket associated with your AWS account.</p>\n ",
"required": true
},
"Prefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A prefix for the datafeed file names.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateSpotDatafeedSubscriptionResult",
"type": "structure",
"members": {
"SpotDatafeedSubscription": {
"shape_name": "SpotDatafeedSubscription",
"type": "structure",
"members": {
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the account.</p>\n ",
"xmlname": "ownerId"
},
"Bucket": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Amazon S3 bucket where the Spot Instance datafeed is located.</p>\n ",
"xmlname": "bucket"
},
"Prefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The prefix that is prepended to datafeed files.</p>\n ",
"xmlname": "prefix"
},
"State": {
"shape_name": "DatafeedSubscriptionState",
"type": "string",
"enum": [
"Active",
"Inactive"
],
"documentation": "\n <p>The state of the Spot Instance datafeed subscription.</p>\n ",
"xmlname": "state"
},
"Fault": {
"shape_name": "SpotInstanceStateFault",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason code for the Spot Instance state change.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The message for the Spot Instance state change.</p>\n ",
"xmlname": "message"
}
},
"documentation": "\n <p>The fault codes for the Spot Instance request, if any.</p>\n ",
"xmlname": "fault"
}
},
"documentation": "\n <p>The Spot Instance datafeed subscription.</p>\n ",
"xmlname": "spotDatafeedSubscription"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Creates a datafeed for Spot Instances, enabling you to view Spot Instance usage logs.\n\t\t\t\tYou can create one data feed per AWS account. For more information, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html\">Spot Instances</a> in\n\t\t\t\tthe <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a Spot Instance datafeed for the account.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateSpotDatafeedSubscription\n&amp;Bucket=my-s3-bucket\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateSpotDatafeedSubscriptionResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;spotDatafeedSubscription&gt;\n &lt;ownerId&gt;123456789012&lt;/ownerId&gt;\n &lt;bucket&gt;my-s3-bucket&lt;/bucket&gt;\n &lt;prefix&gt;spotdata_&lt;/prefix&gt;\n &lt;state&gt;Active&lt;/state&gt;\n &lt;/spotDatafeedSubscription&gt;\n&lt;/CreateSpotDatafeedSubscriptionResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateSubnet": {
"name": "CreateSubnet",
"input": {
"shape_name": "CreateSubnetRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"required": true
},
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The network range for the subnet, in CIDR notation. For example, <code>10.0.0.0/24</code>.</p>\n ",
"required": true
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Availability Zone for the subnet.</p>\n\t\t <p>Default: Amazon EC2 selects one for you (recommended).</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateSubnetResult",
"type": "structure",
"members": {
"Subnet": {
"shape_name": "Subnet",
"type": "structure",
"members": {
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet.</p>\n ",
"xmlname": "subnetId"
},
"State": {
"shape_name": "SubnetState",
"type": "string",
"enum": [
"pending",
"available"
],
"documentation": "\n\t\t <p>The current state of the subnet.</p>\n ",
"xmlname": "state"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC the subnet is in.</p>\n ",
"xmlname": "vpcId"
},
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR block assigned to the subnet.</p>\n ",
"xmlname": "cidrBlock"
},
"AvailableIpAddressCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The number of unused IP addresses in the subnet. Note that the IP addresses for any\n\t\t\t\tstopped instances are considered unavailable.</p>\n ",
"xmlname": "availableIpAddressCount"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Availability Zone of the subnet.</p>\n ",
"xmlname": "availabilityZone"
},
"DefaultForAz": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether this is the default subnet for the Availability Zone.</p>\n ",
"xmlname": "defaultForAz"
},
"MapPublicIpOnLaunch": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether instances launched in this subnet receive a public IP address.</p>\n ",
"xmlname": "mapPublicIpOnLaunch"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the subnet.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n\t\t <p>Information about the subnet.</p>\n ",
"xmlname": "subnet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Creates a subnet in an existing VPC.</p>\n <p>When you create each subnet, you provide the VPC ID and the CIDR block you want\n\t\t\t\tfor the subnet. After you create a subnet, you can't change its CIDR block. The\n\t\t\t\tsubnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only\n\t\t\t\ta single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more\n\t\t\t\tthan one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest\n\t\t\t\tsubnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the\n\t\t\t\tlargest uses a /16 netmask (65,536 IP addresses).</p>\n <important>\n <p>AWS reserves both the first four and the last IP address in each subnet's\n CIDR block. They're not available for use.</p>\n </important>\n\t\t <p>If you add more than one subnet to a VPC, they're set up in a star topology with a\n\t\t\t\tlogical router in the middle.</p>\n\t\t <p>For more information about subnets, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html\">Your VPC and Subnets</a>\n\t\t\t in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a subnet with CIDR block <code>10.0.1.0/24</code> in the VPC with the ID\n\t\t\t\t\t<code>vpc-1a2b3c4d</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateSubnet\n&amp;VpcId=vpc-1a2b3c4d\n&amp;CidrBlock=10.0.1.0/24\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateSubnetResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;subnet&gt;\n &lt;subnetId&gt;subnet-9d4a7b6c&lt;/subnetId&gt;\n &lt;state&gt;pending&lt;/state&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&lt;/vpcId&gt;\n &lt;cidrBlock&gt;10.0.1.0/24&lt;/cidrBlock&gt; \n &lt;availableIpAddressCount&gt;251&lt;/availableIpAddressCount&gt;\n &lt;availabilityZone&gt;us-east-1a&lt;/availabilityZone&gt;\n &lt;tagSet/&gt;\n &lt;/subnet&gt;\n&lt;/CreateSubnetResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateTags": {
"name": "CreateTags",
"input": {
"shape_name": "CreateTagsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"Resources": {
"shape_name": "ResourceIdList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ResourceId"
},
"documentation": "\n <p>The IDs of one or more resources to tag. For example, ami-1a2b3c4d.</p>\n ",
"required": true,
"flattened": true
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n "
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n "
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "Tag"
},
"documentation": "\n <p>One or more tags. The <code>value</code> parameter is required, but if you don't want the tag to have a value,\n specify the parameter with no value, and we set the value to an empty\n string. </p>\n ",
"required": true,
"flattened": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Adds or overwrites one or more tags for the specified EC2 resource or resources.\n Each resource can have a maximum of 10 tags. Each tag consists of a key and optional\n value. Tag keys must be unique per resource.</p>\n <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging\n Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request adds (or overwrites) two tags for an AMI and an instance. One\n of the tags is just a key (<code>webserver</code>), with no value (we set the value to an empty\n string). The other tag consists of a key (<code>stack</code>) and value\n (<code>Production</code>).</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateTags\n&amp;ResourceId.1=ami-1a2b3c4d\n&amp;ResourceId.2=i-7f4d3a2b\n&amp;Tag.1.Key=webserver\n&amp;Tag.1.Value=\n&amp;Tag.2.Key=stack\n&amp;Tag.2.Value=Production\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><CreateTagsResponse\nxmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <return>true</return>\n</CreateTagsResponse></queryresponse>\n </example>\n </examples>\n "
},
"CreateVolume": {
"name": "CreateVolume",
"input": {
"shape_name": "CreateVolumeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"Size": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiBs.</p>\n <p>Constraints: If the volume type is <code>io1</code>, the minimum size of the volume is 10\n GiB.</p>\n <p>Default: If you're creating the volume from a snapshot and don't specify a volume size, the\n default is the snapshot size.</p>\n "
},
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The snapshot from which to create the volume.</p>\n "
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone in which to create the volume. Use <a>DescribeAvailabilityZones</a> to\n list the Availability Zones that are currently available to you.</p>\n ",
"required": true
},
"VolumeType": {
"shape_name": "VolumeType",
"type": "string",
"enum": [
"standard",
"io1",
"gp2"
],
"documentation": "\n <p>The volume type. This can be <code>gp2</code> for General Purpose (SSD) volumes, <code>io1</code> for\n Provisioned IOPS (SSD) volumes, or <code>standard</code> for Magnetic volumes.</p>\n <p>Default: <code>standard</code></p>\n "
},
"Iops": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of I/O operations per second (IOPS) that the volume supports. This parameter is not\n used with Magnetic or General Purpose (SSD) volumes, but is required when the volume type is\n <code>io1</code>.</p>\n "
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Specifies whether the volume should be encrypted.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "Volume",
"type": "structure",
"members": {
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"xmlname": "volumeId"
},
"Size": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiBs.</p>\n ",
"xmlname": "size"
},
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The snapshot from which the volume was created, if applicable.</p>\n ",
"xmlname": "snapshotId"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone for the volume.</p>\n ",
"xmlname": "availabilityZone"
},
"State": {
"shape_name": "VolumeState",
"type": "string",
"enum": [
"creating",
"available",
"in-use",
"deleting",
"deleted",
"error"
],
"documentation": "\n <p>The volume state.</p>\n ",
"xmlname": "status"
},
"CreateTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when volume creation was initiated.</p>\n ",
"xmlname": "createTime"
},
"Attachments": {
"shape_name": "VolumeAttachmentList",
"type": "list",
"members": {
"shape_name": "VolumeAttachment",
"type": "structure",
"members": {
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"xmlname": "volumeId"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"Device": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name.</p>\n ",
"xmlname": "device"
},
"State": {
"shape_name": "VolumeAttachmentState",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n <p>The attachment state of the volume.</p>\n ",
"xmlname": "status"
},
"AttachTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when the attachment initiated.</p>\n ",
"xmlname": "attachTime"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n ",
"xmlname": "deleteOnTermination"
}
},
"documentation": "\n <p>Describes volume attachment details.</p>\n ",
"xmlname": "item"
},
"documentation": "\n ",
"xmlname": "attachmentSet"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the volume.</p>\n ",
"xmlname": "tagSet"
},
"VolumeType": {
"shape_name": "VolumeType",
"type": "string",
"enum": [
"standard",
"io1",
"gp2"
],
"documentation": "\n <p>The volume type. This can be <code>gp2</code> for General Purpose (SSD) volumes, <code>io1</code> for\n Provisioned IOPS (SSD) volumes, or <code>standard</code> for Magnetic volumes.</p>\n ",
"xmlname": "volumeType"
},
"Iops": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of I/O operations per second (IOPS) that the volume supports.</p>\n ",
"xmlname": "iops"
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the volume is encrypted.</p>\n ",
"xmlname": "encrypted"
}
},
"documentation": "\n ",
"xmlname": "volume"
},
"errors": [],
"documentation": "\n <p>Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone.\n The volume is created in the specified region.</p>\n <p>You can create a new empty volume or restore a volume from an Amazon EBS snapshot.\n Any AWS Marketplace product codes from the snapshot are propagated to the volume.</p>\n <p>You can create encrypted volumes with the\n <code>Encrypted</code> parameter. Encrypted volumes may only be attached to instances\n that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also\n automatically encrypted. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html\">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-volume.html\">Creating or\n Restoring an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request creates an 80 GiB encrypted volume in the Availability\n Zone <code>us-east-1a</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateVolume\n&amp;Size=80\n&amp;AvailabilityZone=us-east-1a\n&amp;Encrypted=1\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateVolumeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;volumeId&gt;vol-1a2b3c4d&lt;/volumeId&gt;\n &lt;size&gt;80&lt;/size&gt;\n &lt;snapshotId/&gt;\n &lt;availabilityZone&gt;us-east-1a&lt;/availabilityZone&gt;\n &lt;status&gt;creating&lt;/status&gt;\n &lt;createTime&gt;YYYY-MM-DDTHH:MM:SS.000Z&lt;/createTime&gt;\n &lt;volumeType&gt;standard&lt;/volumeType&gt;\n &lt;encrypted&gt;true&lt;/encrypted&gt;\n&lt;/CreateVolumeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateVpc": {
"name": "CreateVpc",
"input": {
"shape_name": "CreateVpcRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The network range for the VPC, in CIDR notation. For example, <code>10.0.0.0/16</code>.</p>\n ",
"required": true
},
"InstanceTenancy": {
"shape_name": "Tenancy",
"type": "string",
"enum": [
"default",
"dedicated"
],
"documentation": "\n\t\t <p>The supported tenancy options for instances launched into the VPC.\n\t\t\t\tA value of <code>default</code> means that instances can be launched\n\t\t\t\twith any tenancy; a value of <code>dedicated</code> means all instances\n\t\t\t\tlaunched into the VPC are launched as dedicated tenancy instances regardless of the tenancy\n\t\t\t\tassigned to the instance at launch. Dedicated tenancy instances\n\t\t\t\truns on single-tenant hardware.</p>\n <p>Default: <code>default</code></p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateVpcResult",
"type": "structure",
"members": {
"Vpc": {
"shape_name": "Vpc",
"type": "structure",
"members": {
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"State": {
"shape_name": "VpcState",
"type": "string",
"enum": [
"pending",
"available"
],
"documentation": "\n\t\t <p>The current state of the VPC.</p>\n ",
"xmlname": "state"
},
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR block for the VPC.</p>\n ",
"xmlname": "cidrBlock"
},
"DhcpOptionsId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the set of DHCP options you've associated with the VPC (or <code>default</code>\n\t\t\t\tif the default options are associated with the VPC).</p>\n ",
"xmlname": "dhcpOptionsId"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the VPC.</p>\n ",
"xmlname": "tagSet"
},
"InstanceTenancy": {
"shape_name": "Tenancy",
"type": "string",
"enum": [
"default",
"dedicated"
],
"documentation": "\n\t\t <p>The allowed tenancy of instances launched into the VPC.</p>\n ",
"xmlname": "instanceTenancy"
},
"IsDefault": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the VPC is the default VPC.</p>\n ",
"xmlname": "isDefault"
}
},
"documentation": "\n\t\t <p>Information about the VPC.</p>\n ",
"xmlname": "vpc"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Creates a VPC with the specified CIDR block.</p>\n\t\t <p>The smallest VPC you can create uses a /28 netmask (16 IP addresses), \n\t\t\t\tand the largest uses a /16 netmask (65,536 IP addresses). \n\t\t\t\tTo help you decide how big to make your VPC, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html\">Your VPC and Subnets</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n\t\t <p>By default, each instance you launch in the VPC has the default DHCP options, which\n\t\t\t includes only a default DNS server that we provide (AmazonProvidedDNS).\n\t\t\t For more information about DHCP options, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html\">DHCP Options Sets</a>\n\t\t\t\tin the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example creates a VPC with the CIDR block <code>10.0.0.0/16</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateVpc\n&amp;CidrBlock=10.0.0.0/16\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateVpcResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\t\t\t\t\t\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;vpc&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&lt;/vpcId&gt;\n &lt;state&gt;pending&lt;/state&gt;\n &lt;cidrBlock&gt;10.0.0.0/16&lt;/cidrBlock&gt; \n &lt;dhcpOptionsId&gt;dopt-1a2b3c4d2&lt;/dhcpOptionsId&gt;\n &lt;instanceTenancy&gt;default&lt;/instanceTenancy&gt;\n &lt;tagSet/&gt;\n &lt;/vpc&gt;\n&lt;/CreateVpcResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example creates a VPC with the <code>dedicated</code> tenancy option.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateVpc\n&amp;CidrBlock=10.32.0.0/16\n&amp;InstanceTenancy=dedicated\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateVpcResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;a9e49797-a74f-4f68-b302-a134a51fd054&lt;/requestId&gt;\n &lt;vpc&gt;\n &lt;vpcId&gt;vpc-11a63c78&lt;/vpcId&gt;\n &lt;state&gt;pending&lt;/state&gt;\n &lt;cidrBlock&gt;10.32.0.0/16&lt;/cidrBlock&gt;\n &lt;dhcpOptionsId&gt;dopt-1a2b3c4d2&lt;/dhcpOptionsId&gt;\n &lt;instanceTenancy&gt;dedicated&lt;/instanceTenancy&gt;\n &lt;/vpc&gt;\n&lt;/CreateVpcResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateVpcPeeringConnection": {
"name": "CreateVpcPeeringConnection",
"input": {
"shape_name": "CreateVpcPeeringConnectionRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the requester VPC.</p>\n "
},
"PeerVpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC with which you are creating the VPC peering connection.</p>\n "
},
"PeerOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the owner of the peer VPC.</p>\n <p>Default: Your AWS account ID</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateVpcPeeringConnectionResult",
"type": "structure",
"members": {
"VpcPeeringConnection": {
"shape_name": "VpcPeeringConnection",
"type": "structure",
"members": {
"AccepterVpcInfo": {
"shape_name": "VpcPeeringConnectionVpcInfo",
"type": "structure",
"members": {
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The CIDR block for the VPC.</p>\n ",
"xmlname": "cidrBlock"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the VPC owner.</p>\n ",
"xmlname": "ownerId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
}
},
"documentation": "\n <p>The information of the peer VPC.</p>\n ",
"xmlname": "accepterVpcInfo"
},
"ExpirationTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time that an unaccepted VPC peering connection will expire.</p>\n ",
"xmlname": "expirationTime"
},
"RequesterVpcInfo": {
"shape_name": "VpcPeeringConnectionVpcInfo",
"type": "structure",
"members": {
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The CIDR block for the VPC.</p>\n ",
"xmlname": "cidrBlock"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the VPC owner.</p>\n ",
"xmlname": "ownerId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
}
},
"documentation": "\n <p>The information of the requester VPC.</p>\n ",
"xmlname": "requesterVpcInfo"
},
"Status": {
"shape_name": "VpcPeeringConnectionStateReason",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status of the VPC peering connection.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A message that provides more information about the status, if applicable.</p>\n ",
"xmlname": "message"
}
},
"documentation": "\n <p>The status of the VPC peering connection.</p>\n ",
"xmlname": "status"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the resource.</p>\n ",
"xmlname": "tagSet"
},
"VpcPeeringConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC peering connection.</p>\n ",
"xmlname": "vpcPeeringConnectionId"
}
},
"documentation": "\n <p>Information about the VPC peering connection.</p>\n ",
"xmlname": "vpcPeeringConnection"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer\n VPC with which to create the connection. The peer VPC can belong to another AWS\n account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.</p>\n <p>The owner of the peer VPC must accept the peering request to activate the peering\n connection. The VPC peering connection request expires after 7 days, after which it\n cannot be accepted or rejected.</p>\n <p>A <code>CreateVpcPeeringConnection</code> request between VPCs with overlapping CIDR blocks\n results in the VPC peering connection having a status of <code>failed</code>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example requests a peering connection between your VPC (<code>vpc-1a2b3c4d</code>),\n and a VPC (<code>vpc-a1b2c3d4</code>) that belongs to AWS account\n 123456789012. </description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateVpcPeeringConnection\n&amp;VpcId=vpc-1a2b3c4d\n&amp;PeerVpcId=vpc-a1b2c3d4\n&amp;PeerOwnerId=123456789012\n&amp;AUTHPARAMS </queryrequest>\n <queryresponse>&lt;CreateVpcPeeringConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;vpcPeeringConnection&gt;\n &lt;vpcPeeringConnectionId&gt;pcx-73a5401a&lt;/vpcPeeringConnectionId&gt;\n &lt;requesterVpcInfo&gt;\n &lt;ownerId&gt;777788889999&lt;/ownerId&gt;\n &lt;vpcId&gt;vpc-vpc-1a2b3c4d&lt;/vpcId&gt;\n &lt;cidrBlock&gt;10.0.0.0/28&lt;/cidrBlock&gt;\n &lt;/requesterVpcInfo&gt;\n &lt;accepterVpcInfo&gt;\n &lt;ownerId&gt;123456789012&lt;/ownerId&gt;\n &lt;vpcId&gt;vpc-a1b2c3d4&lt;/vpcId&gt;\n &lt;/accepterVpcInfo&gt;\n &lt;status&gt;\n &lt;code&gt;initiating-request&lt;/code&gt;\n &lt;message&gt;Initiating Request to 123456789012&lt;/message&gt;\n &lt;/status&gt;\n &lt;expirationTime&gt;2014-02-18T14:37:25.000Z&lt;/expirationTime&gt;\n &lt;tagSet/&gt;\n &lt;/vpcPeeringConnection&gt;\n&lt;/CreateVpcPeeringConnectionResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example requests a peering connection between your VPCs <code>vpc-1a2b3c4d</code> and <code>vpc-11122233</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateVpcPeeringConnection\n&amp;VpcId=vpc-1a2b3c4d\n&amp;PeerVpcId=vpc-11122233\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"CreateVpnConnection": {
"name": "CreateVpnConnection",
"input": {
"shape_name": "CreateVpnConnectionRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"Type": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The type of VPN connection.</p>\n ",
"required": true
},
"CustomerGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the customer gateway.</p>\n ",
"required": true
},
"VpnGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the virtual private gateway.</p>\n ",
"required": true
},
"Options": {
"shape_name": "VpnConnectionOptionsSpecification",
"type": "structure",
"members": {
"StaticRoutesOnly": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the VPN connection uses static routes only. \n\t\t Static routes must be used for devices that don't support BGP.</p>\n "
}
},
"documentation": "\n\t\t <p>Indicates whether the VPN connection requires static routes. If you\n\t\t\t\tare creating a VPN connection for a device that does not support BGP,\n\t\t\t\tyou must specify <code>true</code>.</p>\n <p>Default: <code>false</code></p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateVpnConnectionResult",
"type": "structure",
"members": {
"VpnConnection": {
"shape_name": "VpnConnection",
"type": "structure",
"members": {
"VpnConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPN connection.</p>\n ",
"xmlname": "vpnConnectionId"
},
"State": {
"shape_name": "VpnState",
"type": "string",
"enum": [
"pending",
"available",
"deleting",
"deleted"
],
"documentation": "\n\t\t <p>The current state of the VPN connection.</p>\n ",
"xmlname": "state"
},
"CustomerGatewayConfiguration": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The configuration information for the VPN connection's customer gateway (in the\n\t\t\t\tnative XML format). This element is always present in the\n\t\t\t\t<a>CreateVpnConnection</a> response; however, it's present in the\n\t\t\t\t<a>DescribeVpnConnections</a> response only if the VPN connection is in\n\t\t\t\tthe <code>pending</code> or <code>available</code> state.</p>\n ",
"xmlname": "customerGatewayConfiguration"
},
"Type": {
"shape_name": "GatewayType",
"type": "string",
"enum": [
"ipsec.1"
],
"documentation": "\n\t\t <p>The type of VPN connection.</p>\n ",
"xmlname": "type"
},
"CustomerGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the customer gateway at your end of the VPN connection.</p>\n ",
"xmlname": "customerGatewayId"
},
"VpnGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the virtual private gateway at the AWS side of the VPN connection.</p>\n ",
"xmlname": "vpnGatewayId"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the VPN connection.</p>\n ",
"xmlname": "tagSet"
},
"VgwTelemetry": {
"shape_name": "VgwTelemetryList",
"type": "list",
"members": {
"shape_name": "VgwTelemetry",
"type": "structure",
"members": {
"OutsideIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Internet-routable IP address of the virtual private gateway's outside interface.</p>\n ",
"xmlname": "outsideIpAddress"
},
"Status": {
"shape_name": "TelemetryStatus",
"type": "string",
"enum": [
"UP",
"DOWN"
],
"documentation": "\n\t\t <p>The status of the VPN tunnel.</p>\n ",
"xmlname": "status"
},
"LastStatusChange": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n\t\t <p>The date and time of the last change in status.</p>\n ",
"xmlname": "lastStatusChange"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>If an error occurs, a description of the error.</p>\n ",
"xmlname": "statusMessage"
},
"AcceptedRouteCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The number of accepted routes.</p>\n ",
"xmlname": "acceptedRouteCount"
}
},
"documentation": "\n\t\t <p>Describes telemetry for a VPN tunnel.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Information about the VPN tunnel.</p>\n ",
"xmlname": "vgwTelemetry"
},
"Options": {
"shape_name": "VpnConnectionOptions",
"type": "structure",
"members": {
"StaticRoutesOnly": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the VPN connection uses static routes only. \n\t\t Static routes must be used for devices that don't support BGP.</p>\n ",
"xmlname": "staticRoutesOnly"
}
},
"documentation": "\n\t\t <p>The VPN connection options.</p>\n ",
"xmlname": "options"
},
"Routes": {
"shape_name": "VpnStaticRouteList",
"type": "list",
"members": {
"shape_name": "VpnStaticRoute",
"type": "structure",
"members": {
"DestinationCidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR block associated with the local subnet of the customer data center.</p>\n ",
"xmlname": "destinationCidrBlock"
},
"Source": {
"shape_name": "VpnStaticRouteSource",
"type": "string",
"enum": [
"Static"
],
"documentation": "\n\t\t <p>Indicates how the routes were provided.</p>\n ",
"xmlname": "source"
},
"State": {
"shape_name": "VpnState",
"type": "string",
"enum": [
"pending",
"available",
"deleting",
"deleted"
],
"documentation": "\n\t\t <p>The current state of the static route.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n\t\t <p>Describes a static route for a VPN connection.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>The static routes associated with the VPN connection.</p>\n ",
"xmlname": "routes"
}
},
"documentation": "\n\t\t <p>Information about the VPN connection.</p>\n ",
"xmlname": "vpnConnection"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Creates a VPN connection between an existing virtual private gateway and a VPN customer\n\t\t\t\tgateway. The only supported connection type is <code>ipsec.1</code>.</p>\n\t\t <p>The response includes information that you need to give to your network administrator \n\t\t to configure your customer gateway.</p>\n <important>\n\t\t\t<p>We strongly recommend that you use HTTPS when calling this operation\n\t\t\t\t\tbecause the response contains sensitive cryptographic information for\n\t\t\t\t\tconfiguring your customer gateway.</p>\n\t\t </important>\n\t\t <p>If you decide to shut down your VPN connection for any reason and later create a new VPN\n\t\t\t\tconnection, you must reconfigure your customer gateway with the new information\n\t\t\t\treturned from this call.</p>\n\t\t <p>For more information about VPN connections, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html\">Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example creates a VPN connection between the virtual private gateway with the ID\n\t\t\t\t\t<code>vgw-8db04f81</code> and the customer gateway with the ID <code>cgw-b4dc3961</code>. The response\n\t\t\t\t\tincludes configuration information for the customer gateway. Because it's a long set of information, we haven't\n\t\t\t\t included the complete response here. To see an example of the configuation information,\n\t\t\t\t see the <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/NetworkAdminGuide/\">Amazon Virtual Private Cloud Network Administrator Guide</a>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateVpnConnection\n&amp;Type=ipsec.1\n&amp;CustomerGatewayId=cgw-b4dc3961\n&amp;VpnGatewayId=vgw-8db04f81\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateVpnConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;vpnConnection&gt;\n &lt;vpnConnectionId&gt;vpn-44a8938f&lt;/vpnConnectionId&gt;\n &lt;state&gt;pending&lt;/state&gt;\n &lt;customerGatewayConfiguration&gt;\n ...Customer gateway configuration data in escaped XML format...\n &lt;/customerGatewayConfiguration&gt; \n &lt;type&gt;ipsec.1&lt;/type&gt;\n &lt;customerGatewayId&gt;cgw-b4dc3961&lt;/customerGatewayId&gt;\n &lt;vpnGatewayId&gt;vgw-8db04f81&lt;/vpnGatewayId&gt;\n &lt;tagSet/&gt;\n &lt;/vpnConnection&gt;\n&lt;/CreateVpnConnectionResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example creates a VPN connection with the static routes option between\n\t\t\t\t\tthe virtual private gateway with the ID <code>vgw-8db04f81</code>, and the customer\n\t\t\t\t\tgateway with the ID <code>cgw-b4dc3961</code>, for a device that does not support the Border\n\t\t\t\t\tGateway Protocol (BGP). The response includes configuration information for the\n\t\t\t\t\tVPN connection's customer gateway. Because it's a long set of information, we haven't\n\t\t\t\t\tincluded the complete response here.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateVpnConnection\n&amp;Type=ipsec.1\n&amp;CustomerGatewayId=cgw-b4dc3961\n&amp;VpnGatewayId=vgw-8db04f81\n&amp;Options.StaticRoutesOnly=true\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateVpnConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;5cc7891f-1f3b-4fc4-a626-bdea8f63ff5a&lt;/requestId&gt;\n &lt;vpnConnection&gt;\n &lt;vpnConnectionId&gt;vpn-83ad48ea&lt;/vpnConnectionId&gt;\n &lt;state&gt;pending&lt;/state&gt;\n &lt;customerGatewayConfiguration&gt;\n ...Customer gateway configuration data in escaped XML format...\n &lt;/customerGatewayConfiguration&gt;\n &lt;customerGatewayId&gt;cgw-63ae4b0a&lt;/customerGatewayId&gt;\n &lt;vpnGatewayId&gt;vgw-4ea04527&lt;/vpnGatewayId&gt;\n &lt;options&gt;\n &lt;staticRoutesOnly&gt;true&lt;/staticRoutesOnly&gt;\n &lt;/options&gt;\n &lt;routes/&gt;\n &lt;/vpnConnection&gt;\n&lt;/CreateVpnConnectionResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateVpnConnectionRoute": {
"name": "CreateVpnConnectionRoute",
"input": {
"shape_name": "CreateVpnConnectionRouteRequest",
"type": "structure",
"members": {
"VpnConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPN connection.</p>\n ",
"required": true
},
"DestinationCidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR block associated with the local subnet of the customer network.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Creates a static route associated with a VPN connection between an existing\n\t\t\t\tvirtual private gateway and a VPN customer gateway. The static route allows traffic\n\t\t\t\tto be routed from the virtual private gateway to the VPN customer gateway.</p>\n\t\t <p>For more information about VPN connections, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html\">Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a static route to the VPN connection for the VPN\n\t\t\t\t\tconnection with the ID <code>vpn-83ad48ea</code> to the destination CIDR block <code>11.12.0.0/16</code>. Note that\n\t\t\t\t\twhen using the Query API the \"/\" is denoted as \"%2F\".</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateVpnConnectionRoute\n&amp;DestinationCidrBlock=11.12.0.0%2F16\n&amp;VpnConnectionId=vpn-83ad48ea\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateVpnConnectionRouteResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;4f35a1b2-c2c3-4093-b51f-abb9d7311990&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/CreateVpnConnectionRouteResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"CreateVpnGateway": {
"name": "CreateVpnGateway",
"input": {
"shape_name": "CreateVpnGatewayRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"Type": {
"shape_name": "GatewayType",
"type": "string",
"enum": [
"ipsec.1"
],
"documentation": "\n\t\t <p>The type of VPN connection this virtual private gateway supports.</p>\n ",
"required": true
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Availability Zone for the virtual private gateway.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateVpnGatewayResult",
"type": "structure",
"members": {
"VpnGateway": {
"shape_name": "VpnGateway",
"type": "structure",
"members": {
"VpnGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the virtual private gateway.</p>\n ",
"xmlname": "vpnGatewayId"
},
"State": {
"shape_name": "VpnState",
"type": "string",
"enum": [
"pending",
"available",
"deleting",
"deleted"
],
"documentation": "\n\t\t <p>The current state of the virtual private gateway.</p>\n ",
"xmlname": "state"
},
"Type": {
"shape_name": "GatewayType",
"type": "string",
"enum": [
"ipsec.1"
],
"documentation": "\n\t\t <p>The type of VPN connection the virtual private gateway supports.</p>\n ",
"xmlname": "type"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Availability Zone where the virtual private gateway was created.</p>\n ",
"xmlname": "availabilityZone"
},
"VpcAttachments": {
"shape_name": "VpcAttachmentList",
"type": "list",
"members": {
"shape_name": "VpcAttachment",
"type": "structure",
"members": {
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"State": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n\t\t <p>The current state of the attachment.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n\t\t <p>Describes an attachment between a virtual private gateway and a VPC.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any VPCs attached to the virtual private gateway.</p>\n ",
"xmlname": "attachments"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the virtual private gateway.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n\t\t <p>Information about the virtual private gateway.</p>\n ",
"xmlname": "vpnGateway"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your\n\t\t\t\tVPN connection. You can create a virtual private gateway before creating the VPC itself.</p>\n\t\t <p>For more information about virtual private gateways, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html\">Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a virtual private gateway.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateVpnGateway\n&amp;Type=ipsec.1\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;CreateVpnGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;vpnGateway&gt;\n &lt;vpnGatewayId&gt;vgw-8db04f81&lt;/vpnGatewayId&gt;\n &lt;state&gt;pending&lt;/state&gt;\n &lt;type&gt;ipsec.1&lt;/type&gt;\n &lt;availabilityZone&gt;us-east-1a&lt;/availabilityZone&gt;\n &lt;attachments/&gt;\n &lt;tagSet/&gt;\n &lt;/vpnGateway&gt;\n&lt;/CreateVpnGatewayResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteCustomerGateway": {
"name": "DeleteCustomerGateway",
"input": {
"shape_name": "DeleteCustomerGatewayRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"CustomerGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the customer gateway.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified customer gateway. You must delete the VPN connection before you can delete\n\t\t\t\tthe customer gateway.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the specified customer gateway.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteCustomerGateway\n&amp;CustomerGatewayId=cgw-b4dc3961\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteCustomerGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteCustomerGatewayResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteDhcpOptions": {
"name": "DeleteDhcpOptions",
"input": {
"shape_name": "DeleteDhcpOptionsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"DhcpOptionsId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the DHCP options set.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified set of DHCP options. You must disassociate the set of DHCP options\n\t\t\t\tbefore you can delete it. You can disassociate the set of DHCP options by\n\t\t\t\tassociating either a new set of options or the default set of options with the VPC.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the specified set of DHCP options.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteDhcpOptions\t\t\t\t\t\t\t \n&amp;DhcpOptionsId=dopt-7a8b9c2d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteDhcpOptionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\t\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteDhcpOptionsResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteInternetGateway": {
"name": "DeleteInternetGateway",
"input": {
"shape_name": "DeleteInternetGatewayRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InternetGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the Internet gateway.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified Internet gateway. You must detach the Internet gateway \n\t\t\t\tfrom the VPC before you can delete it.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the specified Internet gateway.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteInternetGateway\n&amp;InternetGatewayId=igw-eaad4883\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteInternetGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteInternetGatewayResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteKeyPair": {
"name": "DeleteKeyPair",
"input": {
"shape_name": "DeleteKeyPairRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"KeyName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the key pair.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Deletes the specified key pair, by removing the public key from Amazon EC2.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request deletes the key pair named <code>my-key-pair</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteKeyPair\n&amp;KeyName=my-key-pair\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteKeyPairResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteKeyPairResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteNetworkAcl": {
"name": "DeleteNetworkAcl",
"input": {
"shape_name": "DeleteNetworkAclRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"NetworkAclId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network ACL.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. \n\t\t\t\tYou can't delete the default network ACL.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the specified network ACL.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteNetworkAcl\n&amp;NetworkAclId=acl-2cb85d45\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteNetworkAclResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteNetworkAclResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteNetworkAclEntry": {
"name": "DeleteNetworkAclEntry",
"input": {
"shape_name": "DeleteNetworkAclEntryRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"NetworkAclId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network ACL.</p>\n ",
"required": true
},
"RuleNumber": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The rule number of the entry to delete.</p>\n ",
"required": true
},
"Egress": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the rule is an egress rule.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified ingress or egress entry (rule) from the specified network ACL.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes ingress rule number 100 from the specified network ACL.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteNetworkAclEntry\n&amp;NetworkAclId=acl-2cb85d45\n&amp;RuleNumber=100\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteNetworkAclEntryResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteNetworkAclEntryResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteNetworkInterface": {
"name": "DeleteNetworkInterface",
"input": {
"shape_name": "DeleteNetworkInterfaceRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified network interface. You must detach the network interface\n\t\t\t before you can delete it.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the specified network interface.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteNetworkInterface\n&amp;NetworkInterfaceId=eni-ffda3197\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteNetworkInterfaceResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;e1c6d73b-edaa-4e62-9909-6611404e1739&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteNetworkInterfaceResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeletePlacementGroup": {
"name": "DeletePlacementGroup",
"input": {
"shape_name": "DeletePlacementGroupRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the placement group.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Deletes the specified placement group. You must terminate all instances in the\n\t\t\t\tplacement group before you can delete the placement group. For more information about placement groups and\n\t\t\t\tcluster instances, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html\">Cluster Instances</a>\n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the placement group named <code>XYZ-cluster</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeletePlacementGroup\n&amp;GroupName=XYZ-cluster\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeletePlacementGroupResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeletePlacementGroupResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteRoute": {
"name": "DeleteRoute",
"input": {
"shape_name": "DeleteRouteRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"RouteTableId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the route table.</p>\n ",
"required": true
},
"DestinationCidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR range for the route. The value you specify must\n\t\t\t\tmatch the CIDR for the route exactly.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified route from the specified route table.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the route with destination CIDR <code>172.16.1.0/24</code> from the\n\t\t\t\t\tspecified route table.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteRoute\n&amp;RouteTableId=rtb-e4ad488d\n&amp;DestinationCidrBlock=172.16.1.0/24\n&amp;AUTHPARMS</queryrequest>\n <queryresponse>&lt;DeleteRouteResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteRouteResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteRouteTable": {
"name": "DeleteRouteTable",
"input": {
"shape_name": "DeleteRouteTableRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"RouteTableId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the route table.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified route table. You must disassociate the route table from any subnets\n\t\t\t\tbefore you can delete it. You can't delete the main route table.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the specified route table.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteRouteTable\n&amp;RouteTableId=rtb-e4ad488d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteRouteTableResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteRouteTableResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteSecurityGroup": {
"name": "DeleteSecurityGroup",
"input": {
"shape_name": "DeleteSecurityGroupRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-Classic, default VPC] The name of the security group.</p>\n "
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Deletes a security group.</p>\n <p>If you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\t<code>InvalidGroup.InUse</code> in EC2-Classic or\n\t\t\t\t<code>DependencyViolation</code> in EC2-VPC.</p>\n <examples>\n <example>\n <name>Example for EC2-Classic</name>\n <description>This example deletes the specified security group for EC2-Classic.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteSecurityGroup\n&amp;GroupName=websrv\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteSecurityGroupResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteSecurityGroupResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example for EC2-VPC</name>\n <description>his example deletes the specified security group for EC2-VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteSecurityGroup\n&amp;GroupId=sg-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteSecurityGroupResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteSecurityGroupResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteSnapshot": {
"name": "DeleteSnapshot",
"input": {
"shape_name": "DeleteSnapshotRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Amazon EBS snapshot.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Deletes the specified snapshot.</p>\n <p>When you make periodic snapshots of a volume, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the volume.</p>\n <p>You cannot delete a snapshot of the root device of an Amazon EBS volume used by a registered AMI.\n You must first de-register the AMI before you can delete the snapshot.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-snapshot.html\">Deleting an\n Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request deletes the snapshot with the ID\n <code>snap-1a2b3c4d</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteSnapshot\n&amp;SnapshotId.1=snap-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteSnapshotResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteSnapshotResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteSpotDatafeedSubscription": {
"name": "DeleteSpotDatafeedSubscription",
"input": {
"shape_name": "DeleteSpotDatafeedSubscriptionRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Deletes the datafeed for Spot Instances. For more information, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html\">Spot Instances</a> in\n\t\t\t\tthe <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request deletes the datafeed for the AWS account.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteSpotDatafeedSubscription\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteSpotDatafeedSubscriptionResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteSpotDatafeedSubscriptionResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteSubnet": {
"name": "DeleteSubnet",
"input": {
"shape_name": "DeleteSubnetRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified subnet. You must terminate all running instances in the\n\t\t\t\tsubnet before you can delete the subnet.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the specified subnet.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteSubnet\n&amp;SubnetId=subnet-9d4a7b6c\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteSubnetResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\t\t\t\t\t\t\t\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteSubnetResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteTags": {
"name": "DeleteTags",
"input": {
"shape_name": "DeleteTagsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"Resources": {
"shape_name": "ResourceIdList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ResourceId"
},
"documentation": "\n <p>The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.</p>\n ",
"required": true,
"flattened": true
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n "
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n "
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "Tag"
},
"documentation": "\n <p>One or more tags to delete. If you omit the <code>value</code> parameter, we delete the tag regardless\n of its value. If you specify this parameter with an empty string as the\n value, we delete the key only if its value is an empty string.</p>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Deletes the specified set of tags from the specified set of resources. This call is designed\n to follow a <code>DescribeTags</code> request.</p>\n <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging\n Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the tags for the AMI with the ID <code>ami-1a2b3c4d</code>.\n First, get a list of the tags by using the <code>DescribeTags</code> request, then delete\n them.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteTags\n&amp;ResourceId.1=ami-1a2b3c4d\n&amp;Tag.1.Key=webserver\n&amp;Tag.2.Key=stack\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DeleteTagsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <return>true</return>\n</DeleteTagsResponse></queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example deletes the <code>stack</code> and <code>webserver</code> tags for two\n particular instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteTags\n&amp;ResourceId.1=i-5f4e3d2a\n&amp;ResourceId.2=i-5f4e3d2a\n&amp;Tag.1.Key=stack\n&amp;Tag.2.Key=webserver\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example</name>\n <description>You can specify a tag key without a corresponding tag value to delete the tag\n regardless of its value. This example request deletes all tags that have a key of\n <code>Purpose</code>, regardless of the tag value.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteTags\n&amp;ResourceId.1=i-5f4e3d2a\n&amp;Tag.1.Key=Purpose\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example</name>\n <description>When you create a tag, you can set the tag value to the empty\n string. Correspondingly, you can delete only tags that have a specific key and whose value is\n the empty string. This example request deletes all tags for the specified instance where the\n key is <code>Purpose</code> and the tag value is the empty string.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteTags\n&amp;ResourceId.1=i-5f4e3d2a\n&amp;Tag.1.Key=Purpose\n&amp;Tag.2.Value=\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DeleteVolume": {
"name": "DeleteVolume",
"input": {
"shape_name": "DeleteVolumeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Deletes the specified Amazon EBS volume. The volume must be in the <code>available</code> state (not\n attached to an instance).</p>\n <note>\n <p>The volume may remain in the <code>deleting</code> state for several minutes.</p>\n </note>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-volume.html\">Deleting an Amazon EBS\n Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request deletes the volume with the ID\n <code>vol-1a2b3c4d</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteVolume\n&amp;VolumeId=vol-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteVolumeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteVolumeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteVpc": {
"name": "DeleteVpc",
"input": {
"shape_name": "DeleteVpcRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified VPC. You must detach or delete all gateways and resources that are\n\t\t\t\tassociated with the VPC before you can delete it. For example, you must terminate all instances\n\t\t\t\trunning in the VPC, delete all security groups associated with the VPC (except the default one), \n\t\t\t\tdelete all route tables associated with the VPC (except the default one), and so on.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the specified VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteVpc\t\t\t\t\t\t\t \n&amp;VpcId=vpc-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteVpcResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\t\t\t\t\t\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteVpcResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteVpcPeeringConnection": {
"name": "DeleteVpcPeeringConnection",
"input": {
"shape_name": "DeleteVpcPeeringConnectionRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpcPeeringConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC peering connection.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DeleteVpcPeeringConnectionResult",
"type": "structure",
"members": {
"Return": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Returns <code>true</code> if the request succeeds; otherwise, it returns an error.</p>\n ",
"xmlname": "return"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the\n peer VPC can delete the VPC peering connection if it's in the <code>active</code>\n state. The owner of the requester VPC can delete a VPC peering connection in the\n <code>pending-acceptance</code> state.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the specified VPC peering connection.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteVpcPeeringConnection\n &amp;vpcPeeringConnectionId=pcx-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteVpcPeeringConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteVpcPeeringConnectionResponse&gt;</queryresponse>\n </example>\n </examples> \n "
},
"DeleteVpnConnection": {
"name": "DeleteVpnConnection",
"input": {
"shape_name": "DeleteVpnConnectionRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpnConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPN connection.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified VPN connection.</p>\n\t\t <p>If you're deleting the VPC and its associated components, we recommend that you\n\t\t\t\tdetach the virtual private gateway from the VPC and delete the VPC before deleting the VPN\n\t\t\t\tconnection.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the specified VPN connection.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteVpnConnection\n&amp;vpnConnectionId=vpn-44a8938f\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteVpnConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\t\t\t\t\t\t\t\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteVpnConnectionResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteVpnConnectionRoute": {
"name": "DeleteVpnConnectionRoute",
"input": {
"shape_name": "DeleteVpnConnectionRouteRequest",
"type": "structure",
"members": {
"VpnConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPN connection.</p>\n ",
"required": true
},
"DestinationCidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR block associated with the local subnet of the customer network.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified static route associated with a VPN connection between an existing\n\t\t\t\tvirtual private gateway and a VPN customer gateway. The static route allows traffic\n\t\t\t\tto be routed from the virtual private gateway to the VPN customer gateway.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes a static route to the destination CIDR block\n\t\t\t\t\t<code>11.12.0.0/16</code> associated with the VPN connection with the ID\n\t\t\t\t\t<code>vpn-83ad48ea</code>. Note that when using the Query API, the \"/\" is\n\t\t\t\t\tdenoted as \"%2F\".</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteVpnConnectionRoute\n&amp;DestinationCidrBlock=11.12.0.0%2F16\n&amp;VpnConnectionId=vpn-83ad48ea\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteVpnConnectionRouteResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;4f35a1b2-c2c3-4093-b51f-abb9d7311990&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteVpnConnectionRouteResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeleteVpnGateway": {
"name": "DeleteVpnGateway",
"input": {
"shape_name": "DeleteVpnGatewayRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpnGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the virtual private gateway.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Deletes the specified virtual private gateway. We recommend that before you\n\t\t\t\tdelete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note\n\t\t\t\tthat you don't need to delete the virtual private gateway if you plan to delete and\n\t\t\t\trecreate the VPN connection between your VPC and your network.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example deletes the specified virtual private gateway.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeleteVpnGateway\n&amp;vpnGatewayId=vgw-8db04f81\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeleteVpnGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\t\t\t\t\t\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeleteVpnGatewayResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DeregisterImage": {
"name": "DeregisterImage",
"input": {
"shape_name": "DeregisterImageRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": " \n <p>Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch\n\t\t\t\tnew instances.</p>\n <p>This command does not delete the AMI.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request deregisters the specified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeregisterImage\n&amp;ImageId=ami-4fa54026\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DeregisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DeregisterImageResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DescribeAccountAttributes": {
"name": "DescribeAccountAttributes",
"input": {
"shape_name": "DescribeAccountAttributesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"AttributeNames": {
"shape_name": "AccountAttributeNameStringList",
"type": "list",
"members": {
"shape_name": "AccountAttributeName",
"type": "string",
"enum": [
"supported-platforms",
"default-vpc"
],
"documentation": null,
"xmlname": "AttributeName"
},
"documentation": "\n <p>One or more account attribute names.</p>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeAccountAttributesResult",
"type": "structure",
"members": {
"AccountAttributes": {
"shape_name": "AccountAttributeList",
"type": "list",
"members": {
"shape_name": "AccountAttribute",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The name of the account attribute.</p>\n ",
"xmlname": "attributeName"
},
"AttributeValues": {
"shape_name": "AccountAttributeValueList",
"type": "list",
"members": {
"shape_name": "AccountAttributeValue",
"type": "structure",
"members": {
"AttributeValue": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The value.</p>\n ",
"xmlname": "attributeValue"
}
},
"documentation": " \n <p>Describes a value of an account attribute.</p>\n ",
"xmlname": "item"
},
"documentation": " \n <p>One or more values for the account attribute.</p>\n ",
"xmlname": "attributeValueSet"
}
},
"documentation": " \n <p>Describes an account attribute.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about one or more account attributes.</p>\n ",
"xmlname": "accountAttributeSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": " \n <p>Describes the specified attribute of your AWS account.</p> \n <examples>\n <example>\n <name>Example</name>\n <description>This example describes the platforms that are supported by your\n\t\t\t\t\tAWS account. The first response is for an account that supports only EC2-VPC.\n\t\t\t\t\tThe second response if for an account that supports both EC2-Classic and EC2-VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeAccountAttributes\n&amp;AttributeName.1=supported-platforms\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeAccountAttributesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;accountAttributeSet&gt;\n &lt;item&gt;\n &lt;attributeName&gt;supported-platforms&lt;/attributeName&gt;\n &lt;attributeValueSet&gt;\n &lt;item&gt;\n &lt;attributeValue&gt;VPC&lt;/attributeValue&gt;\u00a0\u00a0\u00a0 \n &lt;/item&gt;\n &lt;/attributeValueSet&gt;\n &lt;/item&gt;\n &lt;/accountAttributeSet&gt;\n&lt;/DescribeAccountAttributesResponse&gt;</queryresponse>\n <queryresponse>&lt;DescribeAccountAttributesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;accountAttributeSet&gt;\n &lt;item&gt;\n &lt;attributeName&gt;supported-platforms&lt;/attributeName&gt;\n &lt;attributeValueSet&gt;\n &lt;item&gt;\n &lt;attributeValue&gt;EC2&lt;/attributeValue&gt;\u00a0\u00a0\u00a0 \n &lt;/item&gt;\n &lt;item&gt;\n &lt;attributeValue&gt;VPC&lt;/attributeValue&gt;\u00a0\u00a0\u00a0 \n &lt;/item&gt;\n &lt;/attributeValueSet&gt;\n &lt;/item&gt;\n &lt;/accountAttributeSet&gt;\n&lt;/DescribeAccountAttributesResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example describes the ID of your default VPC. \n The first response is for an account that supports only EC2-VPC.\n\t\t\t\t The second response if for an account that supports both EC2-Classic and EC2-VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeAccountAttributes\n&amp;AttributeName.1=default-vpc\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeAccountAttributesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;accountAttributeSet&gt;\n &lt;item&gt;\n &lt;attributeName&gt;default-vpc&lt;/attributeName&gt;\n &lt;attributeValueSet&gt;\n &lt;item&gt;\n &lt;attributeValue&gt;vpc-xxxxxxxx&lt;/attributeValue&gt;\u00a0\u00a0\u00a0 \n &lt;/item&gt;\n &lt;/attributeValueSet&gt;\n &lt;/item&gt;\n &lt;/accountAttributeSet&gt;\n&lt;/DescribeAccountAttributesResponse&gt;</queryresponse>\n <queryresponse>&lt;DescribeAccountAttributesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;accountAttributeSet&gt;\n &lt;item&gt;\n &lt;attributeName&gt;default-vpc&lt;/attributeName&gt;\n &lt;attributeValueSet&gt;\n &lt;item&gt;\n &lt;attributeValue&gt;none&lt;/attributeValue&gt;\u00a0\u00a0\u00a0 \n &lt;/item&gt;\n &lt;/attributeValueSet&gt;\n &lt;/item&gt;\n &lt;/accountAttributeSet&gt;\n&lt;/DescribeAccountAttributesResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DescribeAddresses": {
"name": "DescribeAddresses",
"input": {
"shape_name": "DescribeAddressesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"PublicIps": {
"shape_name": "PublicIpStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "PublicIp"
},
"documentation": "\n <p>[EC2-Classic] One or more Elastic IP addresses.</p>\n <p>Default: Describes all your Elastic IP addresses.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>allocation-id</code> - [EC2-VPC] The allocation ID for the address.</p>\n </li>\n <li>\n <p><code>association-id</code> - [EC2-VPC] The association ID for the address.</p>\n </li>\n <li>\n <p><code>domain</code> - Indicates whether the address is for use in EC2-Classic (<code>standard</code>) \n or in a VPC (<code>vpc</code>).</p>\n </li>\n <li>\n <p><code>instance-id</code> - The ID of the instance the address is associated with, if any.</p>\n </li>\n <li>\n <p><code>network-interface-id</code> - [EC2-VPC] The ID of the network interface that the address is associated with, if any.</p>\n </li>\n <li>\n <p><code>network-interface-owner-id</code> - The AWS account ID of the owner.</p>\n </li>\n <li>\n <p><code>private-ip-address</code> - [EC2-VPC] The private IP address associated with the Elastic IP address.</p>\n </li>\n <li>\n <p><code>public-ip</code> - The Elastic IP address.</p>\n </li>\n </ul>\n ",
"flattened": true
},
"AllocationIds": {
"shape_name": "AllocationIdList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "AllocationId"
},
"documentation": "\n <p>[EC2-VPC] One or more allocation IDs.</p>\n <p>Default: Describes all your Elastic IP addresses.</p>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeAddressesResult",
"type": "structure",
"members": {
"Addresses": {
"shape_name": "AddressList",
"type": "list",
"members": {
"shape_name": "Address",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance the address is associated with (if any).</p>\n ",
"xmlname": "instanceId"
},
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Elastic IP address.</p>\n ",
"xmlname": "publicIp"
},
"AllocationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID representing the allocation of the address for use with EC2-VPC.</p>\n ",
"xmlname": "allocationId"
},
"AssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID representing the association of the address with an instance in a VPC.</p>\n ",
"xmlname": "associationId"
},
"Domain": {
"shape_name": "DomainType",
"type": "string",
"enum": [
"vpc",
"standard"
],
"documentation": "\n <p>Indicates whether this Elastic IP address is for use with instances\n\t\t\t\tin EC2-Classic (<code>standard</code>) or instances in a VPC (<code>vpc</code>).</p>\n ",
"xmlname": "domain"
},
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the network interface.</p>\n ",
"xmlname": "networkInterfaceId"
},
"NetworkInterfaceOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AWS account that owns the network interface.</p>\n ",
"xmlname": "networkInterfaceOwnerId"
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The private IP address associated with the Elastic IP address.</p>\n ",
"xmlname": "privateIpAddress"
}
},
"documentation": "\n <p>Describes an Elastic IP address.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about one or more Elastic IP addresses.</p>\n ",
"xmlname": "addressesSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes one or more of your Elastic IP addresses.</p>\n <p>An Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html\">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example for EC2-Classic</name>\n <description>This example request describes two specific Elastic IP addresses allocated to your account.\n\t\t\t\t\tBoth addresses were created for instances in EC2-Classic, so you must specify them using \n\t\t\t\t\ttheir IP addresses. The address <code>192.0.2.1</code> is assigned to instance <code>i-f15ebb98</code>, \n\t\t\t\t\tand <code>198.51.100.2</code> isn't assigned to an instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeAddresses\n&amp;PublicIp.1=192.0.2.1\n&amp;PublicIp.2=198.51.100.2\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeAddressesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;addressesSet&gt; \n &lt;item&gt;\n &lt;publicIp&gt;192.0.2.1&lt;/publicIp&gt;\n &lt;domain&gt;standard&lt;/domain&gt;\n &lt;instanceId&gt;i-f15ebb98&lt;/instanceId&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;publicIp&gt;198.51.100.2&lt;/publicIp&gt;\n &lt;domain&gt;standard&lt;/domain&gt;\n &lt;instanceId/&gt;\n &lt;/item&gt; \n &lt;/addressesSet&gt; \n&lt;/DescribeAddressesResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 1 for EC2-VPC</name>\n <description>This example request describes a specific Elastic IP address allocated to\n\t\t\t\t\tyour account. This address was created for instances in EC2-VPC, \n\t\t\t\t\tso you must use the allocation ID to specify the address.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeAddresses\n&amp;AllocationId.1= eipalloc-08229861\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeAddressesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;f7de5e98-491a-4c19-a92d-908d6EXAMPLE&lt;/requestId&gt;\n &lt;addressesSet&gt;\n &lt;item&gt;\n &lt;publicIp&gt;203.0.113.41&lt;/publicIp&gt;\n &lt;allocationId&gt;eipalloc-08229861&lt;/allocationId&gt;\n &lt;domain&gt;vpc&lt;/domain&gt;\n &lt;instanceId&gt;i-64600030&lt;/instanceId&gt;\n &lt;associationId&gt;eipassoc-f0229899&lt;/associationId&gt;\n &lt;networkInterfaceId&gt;eni-ef229886&lt;/networkInterfaceId&gt;\n &lt;networkInterfaceOwnerId&gt;053230519467&lt;/networkInterfaceOwnerId&gt;\n &lt;privateIpAddress&gt;10.0.0.228&lt;/privateIpAddress&gt;\n &lt;/item&gt;\n &lt;/addressesSet&gt;\n&lt;/DescribeAddressesResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2 for EC2-VPC</name>\n <description>This example describes your Elastic IP addresses for EC2-VPC only.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeAddresses\n&amp;Filter.1.Name=domain\n&amp;Filter.1.Value.1=vpc\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DescribeAvailabilityZones": {
"name": "DescribeAvailabilityZones",
"input": {
"shape_name": "DescribeAvailabilityZonesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ZoneNames": {
"shape_name": "ZoneNameStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ZoneName"
},
"documentation": "\n <p>The names of one or more Availability Zones.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>message</code> - Information about the Availability Zone.</p>\n </li>\n <li>\n <p><code>region-name</code> - The name of the region for the Availability Zone (for example, <code>us-east-1</code>).</p>\n </li>\n <li>\n <p><code>state</code> - The state of the Availability Zone\n (<code>available</code> | <code>impaired</code> | <code>unavailable</code>).</p>\n </li>\n <li>\n <p><code>zone-name</code> - The name of the Availability Zone (for example, <code>us-east-1a</code>).</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeAvailabilityZonesResult",
"type": "structure",
"members": {
"AvailabilityZones": {
"shape_name": "AvailabilityZoneList",
"type": "list",
"members": {
"shape_name": "AvailabilityZone",
"type": "structure",
"members": {
"ZoneName": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The name of the Availability Zone.</p>\n ",
"xmlname": "zoneName"
},
"State": {
"shape_name": "AvailabilityZoneState",
"type": "string",
"enum": [
"available"
],
"documentation": " \n <p>The state of the Availability Zone.</p>\n ",
"xmlname": "zoneState"
},
"RegionName": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The name of the region.</p>\n ",
"xmlname": "regionName"
},
"Messages": {
"shape_name": "AvailabilityZoneMessageList",
"type": "list",
"members": {
"shape_name": "AvailabilityZoneMessage",
"type": "structure",
"members": {
"Message": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The message about the Availability Zone.</p>\n ",
"xmlname": "message"
}
},
"documentation": " \n <p>Describes a message about an Availability Zone.</p>\n ",
"xmlname": "item"
},
"documentation": " \n <p>Any messages about the Availability Zone.</p>\n ",
"xmlname": "messageSet"
}
},
"documentation": " \n <p>Describes an Availability Zone.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about one or more Availability Zones.</p>\n ",
"xmlname": "availabilityZoneInfo"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": " \n <p>Describes one or more of the Availability Zones that are available to you. The results\n\t\t\t\tinclude zones only for the region you're currently using. If there is an event\n\t\t\t\timpacting an Availability Zone, you can use this request to view the state and any\n\t\t\t\tprovided message for that Availability Zone.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html\">Regions and Availability Zones</a>\n in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request describes the Availability Zones that are available to you.\n\t\t\t\t\tThe response includes Availability Zones only for the current region.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeAvailabilityZones\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeAvailabilityZonesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;availabilityZoneInfo&gt;\n &lt;item&gt;\n &lt;zoneName&gt;us-east-1a&lt;/zoneName&gt;\n &lt;zoneState&gt;available&lt;/zoneState&gt;\n &lt;regionName&gt;us-east-1&lt;/regionName&gt;\n &lt;messageSet/&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;zoneName&gt;us-east-1b&lt;/zoneName&gt;\n &lt;zoneState&gt;available&lt;/zoneState&gt;\n &lt;regionName&gt;us-east-1&lt;/regionName&gt;\n &lt;messageSet/&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;zoneName&gt;us-east-1c&lt;/zoneName&gt;\n &lt;zoneState&gt;available&lt;/zoneState&gt;\n &lt;regionName&gt;us-east-1&lt;/regionName&gt;\n &lt;messageSet/&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;zoneName&gt;us-east-1d&lt;/zoneName&gt;\n &lt;zoneState&gt;available&lt;/zoneState&gt;\n &lt;regionName&gt;us-east-1&lt;/regionName&gt;\n &lt;messageSet/&gt;\n &lt;/item&gt;\n &lt;/availabilityZoneInfo&gt;\n&lt;/DescribeAvailabilityZonesResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DescribeBundleTasks": {
"name": "DescribeBundleTasks",
"input": {
"shape_name": "DescribeBundleTasksRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"BundleIds": {
"shape_name": "BundleIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "BundleId"
},
"documentation": "\n <p>One or more bundle task IDs.</p>\n <p>Default: Describes all your bundle tasks.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>bundle-id</code> - The ID of the bundle task.</p>\n </li>\n <li>\n <p><code>error-code</code> - If the task failed, the error code returned.</p>\n </li>\n <li>\n <p><code>error-message</code> - If the task failed, the error message returned.</p>\n </li>\n <li>\n <p><code>instance-id</code> - The ID of the instance.</p>\n </li>\n <li>\n <p><code>progress</code> - The level of task completion, as a percentage (for example, 20%).</p>\n </li>\n <li>\n <p><code>s3-bucket</code> - The Amazon S3 bucket to store the AMI.</p>\n </li>\n <li>\n <p><code>s3-prefix</code> - The beginning of the AMI name.</p>\n </li>\n <li>\n <p><code>start-time</code> - The time the task started (for example, 2013-09-15T17:15:20.000Z).</p>\n </li>\n <li>\n <p><code>state</code> - The state of the task (<code>pending</code> | <code>waiting-for-shutdown</code> | <code>bundling</code> |\n <code>storing</code> | <code>cancelling</code> | <code>complete</code> | <code>failed</code>).</p>\n </li>\n <li>\n <p><code>update-time</code> - The time of the most recent update for the task.</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeBundleTasksResult",
"type": "structure",
"members": {
"BundleTasks": {
"shape_name": "BundleTaskList",
"type": "list",
"members": {
"shape_name": "BundleTask",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The ID of the instance associated with this bundle task.</p>\n ",
"xmlname": "instanceId"
},
"BundleId": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The ID for this bundle task.</p>\n ",
"xmlname": "bundleId"
},
"State": {
"shape_name": "BundleTaskState",
"type": "string",
"enum": [
"pending",
"waiting-for-shutdown",
"bundling",
"storing",
"cancelling",
"complete",
"failed"
],
"documentation": " \n <p>The state of the task.</p>\n ",
"xmlname": "state"
},
"StartTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": " \n <p>The time this task started.</p>\n ",
"xmlname": "startTime"
},
"UpdateTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": " \n <p>The time of the most recent update for the task.</p>\n ",
"xmlname": "updateTime"
},
"Storage": {
"shape_name": "Storage",
"type": "structure",
"members": {
"S3": {
"shape_name": "S3Storage",
"type": "structure",
"members": {
"Bucket": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.</p>\n ",
"xmlname": "bucket"
},
"Prefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The beginning of the file name of the AMI.</p>\n ",
"xmlname": "prefix"
},
"AWSAccessKeyId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html\">Best Practices for Managing AWS Access Keys</a>.</p>\n "
},
"UploadPolicy": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.</p>\n ",
"xmlname": "uploadPolicy"
},
"UploadPolicySignature": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The signature of the Base64 encoded JSON document.</p>\n ",
"xmlname": "uploadPolicySignature"
}
},
"documentation": "\n <p>An Amazon S3 storage location.</p>\n "
}
},
"documentation": " \n <p>The Amazon S3 storage locations.</p>\n ",
"xmlname": "storage"
},
"Progress": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The level of task completion, as a percent (for example, 20%).</p>\n ",
"xmlname": "progress"
},
"BundleTaskError": {
"shape_name": "BundleTaskError",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The error code.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": " \n <p>The error message.</p>\n ",
"xmlname": "message"
}
},
"documentation": " \n <p>If the task fails, a description of the error.</p>\n ",
"xmlname": "error"
}
},
"documentation": " \n <p>Describes a bundle task.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about one or more bundle tasks.</p>\n ",
"xmlname": "bundleInstanceTasksSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": " \n <p>Describes one or more of your bundling tasks.</p>\n <note><p>Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task.</p></note>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes the status of the specified bundle task.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeBundleTasks\n&amp;bundleId.1=bun-c1a540a8\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeBundleTasksResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <bundleInstanceTasksSet>\n <item>\n <instanceId>i-12345678</instanceId>\n <bundleId>bun-c1a540a8</bundleId>\n <state>cancelling</state>\n <startTime>2008-10-07T11:41:50.000Z</startTime>\n <updateTime>2008-10-07T11:51:50.000Z</updateTime>\n <storage>\n <S3>\n <bucket>myawsbucket</bucket>\n <prefix>winami</prefix>\n </S3>\n </storage>\n <progress>20%</progress>\n </item>\n <bundleInstanceTasksSet>\n</DescribeBundleTasksResponse></queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example filters the response to include only bundle tasks whose state is either <code>complete</code> or <code>failed</code>, and in addition are targeted for the Amazon S3 bucket named <code>myawsbucket</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeBundleTasks\n&amp;Filter.1.Name=s3-bucket\n&amp;Filter.1.Value.1=myawsbucket\n&amp;Filter.2.Name=state\n&amp;Filter.2.Name.1=complete\n&amp;Filter.2.Name.2=failed\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DescribeConversionTasks": {
"name": "DescribeConversionTasks",
"input": {
"shape_name": "DescribeConversionTasksRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n ",
"flattened": true
},
"ConversionTaskIds": {
"shape_name": "ConversionIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ConversionTaskId"
},
"documentation": "\n <p>One or more conversion task IDs.</p>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeConversionTasksResult",
"type": "structure",
"members": {
"ConversionTasks": {
"shape_name": "DescribeConversionTaskList",
"type": "list",
"members": {
"shape_name": "ConversionTask",
"type": "structure",
"members": {
"ConversionTaskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the conversion task.</p>\n ",
"required": true,
"xmlname": "conversionTaskId"
},
"ExpirationTime": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.</p>\n ",
"xmlname": "expirationTime"
},
"ImportInstance": {
"shape_name": "ImportInstanceTaskDetails",
"type": "structure",
"members": {
"Volumes": {
"shape_name": "ImportInstanceVolumeDetailSet",
"type": "list",
"members": {
"shape_name": "ImportInstanceVolumeDetailItem",
"type": "structure",
"members": {
"BytesConverted": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of bytes converted so far.</p>\n ",
"required": true,
"xmlname": "bytesConverted"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone where the resulting instance will reside.</p>\n ",
"required": true,
"xmlname": "availabilityZone"
},
"Image": {
"shape_name": "DiskImageDescription",
"type": "structure",
"members": {
"Format": {
"shape_name": "DiskImageFormat",
"type": "string",
"enum": [
"VMDK",
"RAW",
"VHD"
],
"documentation": "\n <p>The disk image format.</p>\n ",
"required": true,
"xmlname": "format"
},
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the disk image.</p>\n ",
"required": true,
"xmlname": "size"
},
"ImportManifestUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">Authenticating REST Requests</a> topic in the\n <i>Amazon Simple Storage Service Developer Guide</i>.</p>\n ",
"required": true,
"xmlname": "importManifestUrl"
},
"Checksum": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The checksum computed for the disk image.</p>\n ",
"xmlname": "checksum"
}
},
"documentation": "\n <p>The image.</p>\n ",
"required": true,
"xmlname": "image"
},
"Volume": {
"shape_name": "DiskImageVolumeDescription",
"type": "structure",
"members": {
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the volume.</p>\n ",
"xmlname": "size"
},
"Id": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The volume identifier.</p>\n ",
"required": true,
"xmlname": "id"
}
},
"documentation": "\n <p>The volume.</p>\n ",
"required": true,
"xmlname": "volume"
},
"Status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status of the import of this particular disk image.</p>\n ",
"required": true,
"xmlname": "status"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status information or errors related to the disk image.</p>\n ",
"xmlname": "statusMessage"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n ",
"xmlname": "description"
}
},
"documentation": "\n <p>Describes an import volume task.</p>\n ",
"xmlname": "item"
},
"documentation": "\n ",
"required": true,
"xmlname": "volumes"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n ",
"xmlname": "instanceId"
},
"Platform": {
"shape_name": "PlatformValues",
"type": "string",
"enum": [
"Windows"
],
"documentation": "\n <p>The instance operating system.</p>\n ",
"xmlname": "platform"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n ",
"xmlname": "description"
}
},
"documentation": "\n <p>If the task is for importing an instance, this contains information about the import instance task.</p>\n ",
"xmlname": "importInstance"
},
"ImportVolume": {
"shape_name": "ImportVolumeTaskDetails",
"type": "structure",
"members": {
"BytesConverted": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of bytes converted so far.</p>\n ",
"required": true,
"xmlname": "bytesConverted"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone where the resulting volume will reside.</p>\n ",
"required": true,
"xmlname": "availabilityZone"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The description you provided when starting the import volume task.</p>\n ",
"xmlname": "description"
},
"Image": {
"shape_name": "DiskImageDescription",
"type": "structure",
"members": {
"Format": {
"shape_name": "DiskImageFormat",
"type": "string",
"enum": [
"VMDK",
"RAW",
"VHD"
],
"documentation": "\n <p>The disk image format.</p>\n ",
"required": true,
"xmlname": "format"
},
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the disk image.</p>\n ",
"required": true,
"xmlname": "size"
},
"ImportManifestUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">Authenticating REST Requests</a> topic in the\n <i>Amazon Simple Storage Service Developer Guide</i>.</p>\n ",
"required": true,
"xmlname": "importManifestUrl"
},
"Checksum": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The checksum computed for the disk image.</p>\n ",
"xmlname": "checksum"
}
},
"documentation": "\n <p>The image.</p>\n ",
"required": true,
"xmlname": "image"
},
"Volume": {
"shape_name": "DiskImageVolumeDescription",
"type": "structure",
"members": {
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the volume.</p>\n ",
"xmlname": "size"
},
"Id": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The volume identifier.</p>\n ",
"required": true,
"xmlname": "id"
}
},
"documentation": "\n <p>The volume.</p>\n ",
"required": true,
"xmlname": "volume"
}
},
"documentation": "\n <p>If the task is for importing a volume, this contains information about the import volume task.</p>\n ",
"xmlname": "importVolume"
},
"State": {
"shape_name": "ConversionTaskState",
"type": "string",
"enum": [
"active",
"cancelling",
"cancelled",
"completed"
],
"documentation": "\n <p>The state of the conversion task.</p>\n ",
"required": true,
"xmlname": "state"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status message related to the conversion task.</p>\n ",
"xmlname": "statusMessage"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n <p>Describes a conversion task.</p>\n ",
"xmlname": "item"
},
"documentation": "\n ",
"xmlname": "conversionTasks"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes one or more of your conversion tasks. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html\">Using the Command Line\n Tools to Import Your Virtual Machine to Amazon EC2</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes all your conversion tasks.</description> \n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeConversionTasks\n &amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeConversionTasksResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <conversionTasks>\n <item>\n <conversionTask>\n <conversionTaskId>import-i-fh95npoc</conversionTaskId>\n <expirationTime>2010-12-22T12:01Z</expirationTime>\n <importVolume>\n <bytesConverted>1000</bytesConverted>\n <availabilityZone>us-east-1a</availabilityZone>\n <description/>\n <image>\n <format>VDMK</format>\n <size>128696320</size>\n <importManifestUrl>\n https://s3.amazonaws.com/myawsbucket/\u200ba3a5e1b6-590d-43cc-97c1-15c7325d3f41/\u200bWin_2008_Server_Data_Center_SP2_32-bit.\u200bvmdkmanifest.xml?AWSAccessKeyId=\u200bAKIAIOSFODNN7EXAMPLE&amp;\u200bExpires=1294855591&amp;\u200bSignature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n </importManifestUrl>\n </image>\n <volume>\n <size>8</size>\n <id>vol-34d8a2ff</id>\n </volume>\n </importVolume>\n <state>active</state>\n <statusMessage/>\n </conversionTask>\n </item>\n </conversionTasks>\n</DescribeConversionTasksResponse></queryresponse>\n </example>\n </examples>\n "
},
"DescribeCustomerGateways": {
"name": "DescribeCustomerGateways",
"input": {
"shape_name": "DescribeCustomerGatewaysRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"CustomerGatewayIds": {
"shape_name": "CustomerGatewayIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "CustomerGatewayId"
},
"documentation": "\n\t\t <p>One or more customer gateway IDs.</p>\n\t\t <p>Default: Describes all your customer gateways.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>bgp-asn</code> - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>customer-gateway-id</code> - The ID of the customer gateway.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>ip-address</code> - The IP address of the customer gateway's Internet-routable external interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>state</code> - The state of the customer gateway (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>type</code> - The type of customer gateway. Currently, the only supported type is <code>ipsec.1</code>.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeCustomerGatewaysResult",
"type": "structure",
"members": {
"CustomerGateways": {
"shape_name": "CustomerGatewayList",
"type": "list",
"members": {
"shape_name": "CustomerGateway",
"type": "structure",
"members": {
"CustomerGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the customer gateway.</p>\n ",
"xmlname": "customerGatewayId"
},
"State": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The current state of the customer gateway.</p>\n ",
"xmlname": "state"
},
"Type": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The type of VPN connection the customer gateway supports.</p>\n ",
"xmlname": "type"
},
"IpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Internet-routable IP address of the customer gateway's outside interface.</p>\n ",
"xmlname": "ipAddress"
},
"BgpAsn": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).</p>\n ",
"xmlname": "bgpAsn"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the customer gateway.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n\t\t <p>Describes a customer gateway.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Information about one or more customer gateways.</p>\n ",
"xmlname": "customerGatewaySet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Describes one or more of your VPN customer gateways.</p>\n\t\t <p>For more information about VPN customer gateways, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html\">Adding a Hardware\n\t\t\t\tVirtual Private Gateway to Your VPC</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example request describes the specified customer gateway.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeCustomerGateways\n&amp;CustomerGatewayId.1=cgw-b4dc3961\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeCustomerGatewaysResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;customerGatewaySet&gt;\n &lt;item&gt;\n &lt;customerGatewayId&gt;cgw-b4dc3961&lt;/customerGatewayId&gt;\n &lt;state&gt;available&lt;/state&gt;\n &lt;type&gt;ipsec.1&lt;/type&gt;\n &lt;ipAddress&gt;12.1.2.3&lt;/ipAddress&gt; \n &lt;bgpAsn&gt;65534&lt;/bgpasn&gt; \n &lt;tagSet/&gt;\n &lt;/item&gt;\n &lt;/customerGatewaySet&gt;\n&lt;/DescribeCustomerGatewaysResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example request uses filters to describe any customer gateway you\n\t\t\t\t\town whose IP address is <code>12.1.2.3</code>, and whose state is either <code>pending</code>\n\t\t\t\t\tor <code>available</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeCustomerGateways\n&amp;Filter.1.Name=ip-address\n&amp;Filter.1.Value.1=12.1.2.3\n&amp;Filter.2.Name=state\n&amp;Filter.2.Value.1=pending\n&amp;Filter.2.Value.2=available\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DescribeDhcpOptions": {
"name": "DescribeDhcpOptions",
"input": {
"shape_name": "DescribeDhcpOptionsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"DhcpOptionsIds": {
"shape_name": "DhcpOptionsIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "DhcpOptionsId"
},
"documentation": "\n\t\t <p>The IDs of one or more DHCP options sets.</p>\n\t\t <p>Default: Describes all your DHCP options sets.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>dhcp-options-id</code> - The ID of a set of DHCP options.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>key</code> - The key for one of the options (for example, <code>domain-name</code>).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>value</code> - The value for one of the options.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeDhcpOptionsResult",
"type": "structure",
"members": {
"DhcpOptions": {
"shape_name": "DhcpOptionsList",
"type": "list",
"members": {
"shape_name": "DhcpOptions",
"type": "structure",
"members": {
"DhcpOptionsId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the set of DHCP options.</p>\n ",
"xmlname": "dhcpOptionsId"
},
"DhcpConfigurations": {
"shape_name": "DhcpConfigurationList",
"type": "list",
"members": {
"shape_name": "DhcpConfiguration",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The name of a DHCP option.</p>\n ",
"xmlname": "key"
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more values for the DHCP option.</p>\n ",
"xmlname": "valueSet"
}
},
"documentation": "\n\t\t <p>Describes a DHCP configuration option.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more DHCP options in the set.</p>\n ",
"xmlname": "dhcpConfigurationSet"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the DHCP options set.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n\t\t <p>Describes a set of DHCP options.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Information about one or more DHCP options sets.</p>\n ",
"xmlname": "dhcpOptionsSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Describes one or more of your DHCP options sets.</p>\n\t\t <p>For more information about DHCP options sets, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html\">DHCP Options Sets</a>\n\t\t\t\tin the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes the specified DHCP options set.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeDhcpOptions\n&amp;DhcpOptionsId.1=dopt-7a8b9c2d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeDhcpOptionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;dhcpOptionsSet&gt;\n &lt;item&gt;\n &lt;dhcpOptionsId&gt;dopt-7a8b9c2d&lt;/dhcpOptionsId&gt;\n &lt;dhcpConfigurationSet&gt;\n &lt;item&gt;\n &lt;key&gt;domain-name&lt;/key&gt;\n &lt;valueSet&gt;\n &lt;item&gt;\n &lt;value&gt;example.com&lt;/value&gt;\n &lt;/item&gt;\n &lt;/valueSet&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;key&gt;domain-name-servers&lt;/key&gt;\n &lt;valueSet&gt;\n &lt;item&gt;\n &lt;value&gt;10.2.5.1&lt;/value&gt;\n &lt;/item&gt;\n &lt;/valueSet&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;key&gt;domain-name-servers&lt;/key&gt;\n &lt;valueSet&gt;\n &lt;item&gt;\n &lt;value&gt;10.2.5.2&lt;/value&gt;\n &lt;/item&gt;\n &lt;/valueSet&gt;\n &lt;/item&gt;\n &lt;/dhcpConfigurationSet&gt;\n &lt;tagSet/&gt;\n &lt;/item&gt;\n &lt;/dhcpOptionsSet&gt;\n&lt;/DescribeDhcpOptionsResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example uses filters to describe any DHCP options set that\n\t\t\t\t\tincludes a <code>domain-name</code> option whose value includes the string\n\t\t\t\t\t<code>example</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeDhcpOptions\n&amp;Filter.1.Name=key\n&amp;Filter.1.Value.1=domain-name\n&amp;Filter.2.Name=value\n&amp;Filter.2.Value.1=*example*\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DescribeExportTasks": {
"name": "DescribeExportTasks",
"input": {
"shape_name": "DescribeExportTasksRequest",
"type": "structure",
"members": {
"ExportTaskIds": {
"shape_name": "ExportTaskIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ExportTaskId"
},
"documentation": "\n <p>One or more export task IDs.</p>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeExportTasksResult",
"type": "structure",
"members": {
"ExportTasks": {
"shape_name": "ExportTaskList",
"type": "list",
"members": {
"shape_name": "ExportTask",
"type": "structure",
"members": {
"ExportTaskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the export task.</p>\n ",
"xmlname": "exportTaskId"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description of the resource being exported.</p>\n ",
"xmlname": "description"
},
"State": {
"shape_name": "ExportTaskState",
"type": "string",
"enum": [
"active",
"cancelling",
"cancelled",
"completed"
],
"documentation": "\n <p>The state of the conversion task.</p>\n ",
"xmlname": "state"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status message related to the export task.</p>\n ",
"xmlname": "statusMessage"
},
"InstanceExportDetails": {
"shape_name": "InstanceExportDetails",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the resource being exported.</p>\n ",
"xmlname": "instanceId"
},
"TargetEnvironment": {
"shape_name": "ExportEnvironment",
"type": "string",
"enum": [
"citrix",
"vmware",
"microsoft"
],
"documentation": "\n <p>The target virtualization environment.</p>\n ",
"xmlname": "targetEnvironment"
}
},
"documentation": "\n <p>The instance being exported.</p>\n ",
"xmlname": "instanceExport"
},
"ExportToS3Task": {
"shape_name": "ExportToS3Task",
"type": "structure",
"members": {
"DiskImageFormat": {
"shape_name": "DiskImageFormat",
"type": "string",
"enum": [
"VMDK",
"RAW",
"VHD"
],
"documentation": "\n <p>The format for the exported image.</p>\n ",
"xmlname": "diskImageFormat"
},
"ContainerFormat": {
"shape_name": "ContainerFormat",
"type": "string",
"enum": [
"ova"
],
"documentation": "\n <p>The container format used to combine disk images with metadata (such as OVF). If absent, only\n the disk image is exported.</p>\n ",
"xmlname": "containerFormat"
},
"S3Bucket": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Amazon S3 bucket for the destination image. The destination bucket must\n exist and grant WRITE and READ_ACL permissions to the AWS account\n <code>vm-import-export@amazon.com</code>.</p>\n ",
"xmlname": "s3Bucket"
},
"S3Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n ",
"xmlname": "s3Key"
}
},
"documentation": "\n ",
"xmlname": "exportToS3"
}
},
"documentation": "\n <p>Describes an export task.</p>\n ",
"xmlname": "item"
},
"documentation": "\n ",
"xmlname": "exportTaskSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes one or more of your export tasks.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes a single export task.</description> \n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeExportTasks\n &amp;exportTaskId.1=export-i-1234wxyz\n &amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeExportTasksResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;exportTaskSet&gt;\n &lt;item&gt;\n &lt;exportTaskId&gt;export-i-1234wxyz&lt;/exportTaskId&gt;\n &lt;description&gt;Example for docs&lt;/description&gt;\n &lt;state&gt;active&lt;/state&gt;\n &lt;statusMessage&gt;Running&lt;/statusMessage&gt;\n &lt;instanceExport&gt;\n &lt;instanceId&gt;i-12345678&lt;/instanceId&gt;\n &lt;targetEnvironment&gt;VMWare&lt;/targetEnvironment&gt;\n &lt;/instanceExport&gt;\n &lt;exportToS3&gt;\n &lt;diskImageFormat&gt;VMDK&lt;/diskImageFormat&gt;\n &lt;containerFormat&gt;OVA&lt;/containerFormat&gt;\n &lt;s3Bucket&gt;my-bucket-for-exported-vm&lt;/s3Bucket&gt;\n &lt;s3Key&gt;my-exports/ export-i-1234wxyz .ova&lt;/s3Key&gt;\n &lt;/exportToS3&gt;\n &lt;/item&gt;\n &lt;/exportTaskSet&gt;\n &lt;/ DescribeExportTasksResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DescribeImageAttribute": {
"name": "DescribeImageAttribute",
"input": {
"shape_name": "DescribeImageAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI.</p>\n ",
"required": true
},
"Attribute": {
"shape_name": "ImageAttributeName",
"type": "string",
"enum": [
"description",
"kernel",
"ramdisk",
"launchPermission",
"productCodes",
"blockDeviceMapping"
],
"documentation": "\n <p>The AMI attribute.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "ImageAttribute",
"type": "structure",
"members": {
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI.</p>\n ",
"xmlname": "imageId"
},
"LaunchPermissions": {
"shape_name": "LaunchPermissionList",
"type": "list",
"members": {
"shape_name": "LaunchPermission",
"type": "structure",
"members": {
"UserId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID.</p>\n ",
"xmlname": "userId"
},
"Group": {
"shape_name": "PermissionGroup",
"type": "string",
"enum": [
"all"
],
"documentation": "\n <p>The name of the group.</p>\n ",
"xmlname": "group"
}
},
"documentation": "\n <p>Describes a launch permission.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more launch permissions.</p>\n ",
"xmlname": "launchPermission"
},
"ProductCodes": {
"shape_name": "ProductCodeList",
"type": "list",
"members": {
"shape_name": "ProductCode",
"type": "structure",
"members": {
"ProductCodeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The product code.</p>\n ",
"xmlname": "productCode"
},
"ProductCodeType": {
"shape_name": "ProductCodeValues",
"type": "string",
"enum": [
"devpay",
"marketplace"
],
"documentation": "\n <p>The type of product code.</p>\n ",
"xmlname": "type"
}
},
"documentation": "\n <p>Describes a product code.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more product codes.</p>\n ",
"xmlname": "productCodes"
},
"KernelId": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>The kernel ID.</p>\n ",
"xmlname": "kernel"
},
"RamdiskId": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>The RAM disk ID.</p>\n ",
"xmlname": "ramdisk"
},
"Description": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>A description for the AMI.</p>\n ",
"xmlname": "description"
},
"SriovNetSupport": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": " \n ",
"xmlname": "sriovNetSupport"
},
"BlockDeviceMappings": {
"shape_name": "BlockDeviceMappingList",
"type": "list",
"members": {
"shape_name": "BlockDeviceMapping",
"type": "structure",
"members": {
"VirtualName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The virtual device name.</p>\n ",
"xmlname": "virtualName"
},
"DeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name exposed to the instance (for example, <code>/dev/sdh</code>).</p>\n ",
"xmlname": "deviceName"
},
"Ebs": {
"shape_name": "EbsBlockDevice",
"type": "structure",
"members": {
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the snapshot.</p>\n ",
"xmlname": "snapshotId"
},
"VolumeSize": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiB.</p>\n <p>Constraints: If the volume type is <code>io1</code>, the minimum size of the volume is 10 GiB.</p>\n <p>Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.</p>\n ",
"xmlname": "volumeSize"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n ",
"xmlname": "deleteOnTermination"
},
"VolumeType": {
"shape_name": "VolumeType",
"type": "string",
"enum": [
"standard",
"io1",
"gp2"
],
"documentation": "\n <p>The volume type.</p>\n <p>Default: <code>standard</code></p>\n ",
"xmlname": "volumeType"
},
"Iops": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of I/O operations per second (IOPS) that the\n volume supports.</p>\n <p>Constraint: Range is 100 to 4000.</p>\n <p>Condition: Required when the volume type is <code>io1</code>; not used with\n <code>standard</code> or <code>gp2</code> volumes.</p>\n ",
"xmlname": "iops"
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is encrypted.</p>\n ",
"xmlname": "encrypted"
}
},
"documentation": "\n <p>Parameters used to automatically set up Amazon EBS volumes when the instance is launched.</p>\n ",
"xmlname": "ebs"
},
"NoDevice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Suppresses the specified device included in the block device mapping of the AMI.</p>\n ",
"xmlname": "noDevice"
}
},
"documentation": "\n <p>Describes a block device mapping.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more block device mapping entries.</p>\n ",
"xmlname": "blockDeviceMapping"
}
},
"documentation": "\n <p>Information about the image attribute.</p>\n ",
"xmlname": "imageAttribute"
},
"errors": [],
"documentation": " \n <p>Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example lists the launch permissions for the specified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeImageAttribute\n&amp;ImageId=ami-61a54008\n&amp;Attribute=launchPermission\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeImageAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imageId>ami-61a54008</imageId>\n <launchPermission>\n <item>\n <group>all</group>\n </item>\n <item>\n <userId>495219933132</userId>\n </item>\n </launchPermission>\n</DescribeImageAttributeResponse></queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example lists the product codes for the specified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeImageAttribute\n&amp;ImageId=ami-2bb65342\n&amp;Attribute=productCodes\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeImageAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/>\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imageId>ami-2bb65342</imageId>\n <productCodes> \n <item>\n <productCode>a1b2c3d4e5f6g7h8i9j10k11</productCode>\n <type>marketplace</type>\n </item> \n </productCodes> \n</DescribeImageAttributeResponse></queryresponse>\n </example>\n </examples>\n "
},
"DescribeImages": {
"name": "DescribeImages",
"input": {
"shape_name": "DescribeImagesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ImageIds": {
"shape_name": "ImageIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ImageId"
},
"documentation": "\n <p>One or more image IDs.</p>\n <p>Default: Describes all images available to you.</p>\n ",
"flattened": true
},
"Owners": {
"shape_name": "OwnerStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Owner"
},
"documentation": "\n <p>Filters the images by the owner. \n\t\t\t\tSpecify an AWS account ID, <code>amazon</code> (owner is Amazon), \n\t\t\t\t<code>aws-marketplace</code> (owner is AWS Marketplace), \n\t\t\t\t<code>self</code> (owner is the sender of the request), or\n\t\t\t\t<code>all</code> (all owners).</p>\n ",
"flattened": true
},
"ExecutableUsers": {
"shape_name": "ExecutableByStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ExecutableBy"
},
"documentation": "\n <p>Scopes the images by users with explicit launch permissions. \n\t\t\t\tSpecify an AWS account ID, <code>self</code> (the sender of the request),\n\t\t\t\tor <code>all</code> (public AMIs).</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>architecture</code> - The image architecture (<code>i386</code> | <code>x86_64</code>).</p>\n </li>\n <li>\n <p><code>block-device-mapping.delete-on-termination</code> - A Boolean value that indicates \n whether the Amazon EBS volume is deleted on instance termination.</p>\n </li>\n <li>\n <p><code>block-device-mapping.device-name</code> - The device name for the Amazon EBS volume (for example, <code>/dev/sdh</code>).</p>\n </li>\n <li>\n <p><code>block-device-mapping.snapshot-id</code> - The ID of the snapshot used for the Amazon EBS volume.</p>\n </li>\n <li>\n <p><code>block-device-mapping.volume-size</code> - The volume size of the Amazon EBS volume, in GiB.</p>\n </li>\n <li>\n <p><code>block-device-mapping.volume-type</code> - The volume type of the Amazon EBS volume\n (<code>gp2</code> | <code>standard</code> | <code>io1</code>).</p>\n </li>\n <li>\n <p><code>description</code> - The description of the image (provided during image creation).</p>\n </li>\n <li>\n <p><code>hypervisor</code> - The hypervisor type (<code>ovm</code> | <code>xen</code>).</p>\n </li>\n <li>\n <p><code>image-id</code> - The ID of the image.</p>\n </li>\n <li>\n <p><code>image-type</code> - The image type (<code>machine</code> | <code>kernel</code> | <code>ramdisk</code>).</p>\n </li>\n <li>\n <p><code>is-public</code> - A Boolean that indicates whether the image is public.</p>\n </li>\n <li>\n <p><code>kernel-id</code> - The kernel ID.</p>\n </li>\n <li>\n <p><code>manifest-location</code> - The location of the image manifest.</p>\n </li>\n <li>\n <p><code>name</code> - The name of the AMI (provided during image creation).</p>\n </li>\n <li>\n <p><code>owner-alias</code> - The AWS account alias (for example, <code>amazon</code>).</p>\n </li>\n <li>\n <p><code>owner-id</code> - The AWS account ID of the image owner.</p>\n </li>\n <li>\n <p><code>platform</code> - The platform. To only list Windows-based AMIs, use <code>windows</code>.</p>\n </li>\n <li>\n <p><code>product-code</code> - The product code.</p>\n </li>\n <li>\n <p><code>product-code.type</code> - The type of the product code (<code>devpay</code> | <code>marketplace</code>).</p>\n </li>\n <li>\n <p><code>ramdisk-id</code> - The RAM disk ID.</p>\n </li>\n <li>\n <p><code>root-device-name</code> - The name of the root device volume (for example, <code>/dev/sda1</code>).</p>\n </li>\n <li>\n <p><code>root-device-type</code> - The type of the root device volume (<code>ebs</code> | <code>instance-store</code>).</p>\n </li>\n <li>\n <p><code>state</code> - The state of the image (<code>available</code> | <code>pending</code> | <code>failed</code>).</p>\n </li>\n <li>\n <p><code>state-reason-code</code> - The reason code for the state change.</p>\n </li>\n <li>\n <p><code>state-reason-message</code> - The message for the state change.</p>\n </li>\n <li>\n <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n </li>\n <li>\n <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned \n both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n </li>\n <li>\n <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n </li>\n <li>\n <p><code>virtualization-type</code> - The virtualization type (<code>paravirtual</code> | <code>hvm</code>).</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeImagesResult",
"type": "structure",
"members": {
"Images": {
"shape_name": "ImageList",
"type": "list",
"members": {
"shape_name": "Image",
"type": "structure",
"members": {
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI.</p>\n ",
"xmlname": "imageId"
},
"ImageLocation": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The location of the AMI.</p>\n ",
"xmlname": "imageLocation"
},
"State": {
"shape_name": "ImageState",
"type": "string",
"enum": [
"available",
"deregistered"
],
"documentation": "\n <p>The current state of the AMI. If the state is <code>available</code>, the image is successfully registered and can be used to launch an instance.</p>\n ",
"xmlname": "imageState"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the image owner.</p>\n ",
"xmlname": "imageOwnerId"
},
"Public": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the image has public launch permissions. The value is <code>true</code> if\n\t\t\t\tthis image has public launch permissions or <code>false</code>\n\t\t\t\tif it has only implicit and explicit launch permissions.</p>\n ",
"xmlname": "isPublic"
},
"ProductCodes": {
"shape_name": "ProductCodeList",
"type": "list",
"members": {
"shape_name": "ProductCode",
"type": "structure",
"members": {
"ProductCodeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The product code.</p>\n ",
"xmlname": "productCode"
},
"ProductCodeType": {
"shape_name": "ProductCodeValues",
"type": "string",
"enum": [
"devpay",
"marketplace"
],
"documentation": "\n <p>The type of product code.</p>\n ",
"xmlname": "type"
}
},
"documentation": "\n <p>Describes a product code.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any product codes associated with the AMI.</p>\n ",
"xmlname": "productCodes"
},
"Architecture": {
"shape_name": "ArchitectureValues",
"type": "string",
"enum": [
"i386",
"x86_64"
],
"documentation": "\n <p>The architecture of the image.</p>\n ",
"xmlname": "architecture"
},
"ImageType": {
"shape_name": "ImageTypeValues",
"type": "string",
"enum": [
"machine",
"kernel",
"ramdisk"
],
"documentation": "\n <p>The type of image.</p>\n ",
"xmlname": "imageType"
},
"KernelId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The kernel associated with the image, if any. Only applicable for machine images.</p>\n ",
"xmlname": "kernelId"
},
"RamdiskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The RAM disk associated with the image, if any. Only applicable for machine images.</p>\n ",
"xmlname": "ramdiskId"
},
"Platform": {
"shape_name": "PlatformValues",
"type": "string",
"enum": [
"Windows"
],
"documentation": "\n <p>The value is <code>Windows</code> for Windows AMIs; otherwise blank.</p>\n ",
"xmlname": "platform"
},
"SriovNetSupport": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies whether enhanced networking is enabled.</p>\n ",
"xmlname": "sriovNetSupport"
},
"StateReason": {
"shape_name": "StateReason",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason code for the state change.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The message for the state change.</p>\n <ul>\n <li><p><code>Server.SpotInstanceTermination</code>: A Spot Instance was terminated due to an increase in the market price.</p></li>\n <li><p><code>Server.InternalError</code>: An internal error occurred during instance launch, resulting in termination.</p></li>\n <li><p><code>Server.InsufficientInstanceCapacity</code>: There was insufficient instance capacity to satisfy the launch request.</p></li>\n <li><p><code>Client.InternalError</code>: A client error caused the instance to terminate on launch.</p></li>\n <li><p><code>Client.InstanceInitiatedShutdown</code>: The instance was shut down using the <code>shutdown -h</code> command from the instance.</p></li>\n <li><p><code>Client.UserInitiatedShutdown</code>: The instance was shut down using the Amazon EC2 API.</p></li>\n <li><p><code>Client.VolumeLimitExceeded</code>: The volume limit was exceeded.</p></li>\n <li><p><code>Client.InvalidSnapshot.NotFound</code>: The specified snapshot was not found.</p></li>\n </ul>\n ",
"xmlname": "message"
}
},
"documentation": "\n <p>The reason for the state change.</p>\n ",
"xmlname": "stateReason"
},
"ImageOwnerAlias": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account alias (for example, <code>amazon</code>, <code>self</code>) or\n the AWS account ID of the AMI owner.</p>\n ",
"xmlname": "imageOwnerAlias"
},
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the AMI that was provided during image creation.</p>\n ",
"xmlname": "name"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The description of the AMI that was provided during image creation.</p>\n ",
"xmlname": "description"
},
"RootDeviceType": {
"shape_name": "DeviceType",
"type": "string",
"enum": [
"ebs",
"instance-store"
],
"documentation": "\n <p>The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an\n\t\t\t\tinstance store volume.</p>\n ",
"xmlname": "rootDeviceType"
},
"RootDeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name of the root device (for example, <filename>/dev/sda1</filename> or <filename>xvda</filename>).</p>\n ",
"xmlname": "rootDeviceName"
},
"BlockDeviceMappings": {
"shape_name": "BlockDeviceMappingList",
"type": "list",
"members": {
"shape_name": "BlockDeviceMapping",
"type": "structure",
"members": {
"VirtualName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The virtual device name.</p>\n ",
"xmlname": "virtualName"
},
"DeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name exposed to the instance (for example, <code>/dev/sdh</code>).</p>\n ",
"xmlname": "deviceName"
},
"Ebs": {
"shape_name": "EbsBlockDevice",
"type": "structure",
"members": {
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the snapshot.</p>\n ",
"xmlname": "snapshotId"
},
"VolumeSize": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiB.</p>\n <p>Constraints: If the volume type is <code>io1</code>, the minimum size of the volume is 10 GiB.</p>\n <p>Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.</p>\n ",
"xmlname": "volumeSize"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n ",
"xmlname": "deleteOnTermination"
},
"VolumeType": {
"shape_name": "VolumeType",
"type": "string",
"enum": [
"standard",
"io1",
"gp2"
],
"documentation": "\n <p>The volume type.</p>\n <p>Default: <code>standard</code></p>\n ",
"xmlname": "volumeType"
},
"Iops": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of I/O operations per second (IOPS) that the\n volume supports.</p>\n <p>Constraint: Range is 100 to 4000.</p>\n <p>Condition: Required when the volume type is <code>io1</code>; not used with\n <code>standard</code> or <code>gp2</code> volumes.</p>\n ",
"xmlname": "iops"
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is encrypted.</p>\n ",
"xmlname": "encrypted"
}
},
"documentation": "\n <p>Parameters used to automatically set up Amazon EBS volumes when the instance is launched.</p>\n ",
"xmlname": "ebs"
},
"NoDevice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Suppresses the specified device included in the block device mapping of the AMI.</p>\n ",
"xmlname": "noDevice"
}
},
"documentation": "\n <p>Describes a block device mapping.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any block device mapping entries.</p>\n ",
"xmlname": "blockDeviceMapping"
},
"VirtualizationType": {
"shape_name": "VirtualizationType",
"type": "string",
"enum": [
"hvm",
"paravirtual"
],
"documentation": "\n <p>The type of virtualization of the AMI.</p>\n ",
"xmlname": "virtualizationType"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the image.</p>\n ",
"xmlname": "tagSet"
},
"Hypervisor": {
"shape_name": "HypervisorType",
"type": "string",
"enum": [
"ovm",
"xen"
],
"documentation": "\n <p>The hypervisor type of the image.</p>\n ",
"xmlname": "hypervisor"
}
},
"documentation": "\n <p>Describes an image.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about one or more images.</p> \n ",
"xmlname": "imagesSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": " \n <p>Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to\n\t\t\t\tyou include public images, private images that you own, and private images owned by\n\t\t\t\tother AWS accounts but for which you have explicit launch permissions.</p>\n <note><p>Deregistered images are included in the returned results for an unspecified interval after deregistration.</p></note>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes the specified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeImages\n&amp;ImageId.1=ami-be3adfd7\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeImagesResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imagesSet>\n <item>\n <imageId>ami-1a2b3c4d</imageId>\n <imageLocation>amazon/getting-started</imageLocation>\n <imageState>available</imageState>\n <imageOwnerId>123456789012</imageOwnerId>\n <isPublic>true</isPublic>\n <architecture>i386</architecture>\n <imageType>machine</imageType>\n <kernelId>aki-1a2b3c4d</kernelId>\n <ramdiskId>ari-1a2b3c4d</ramdiskId>\n <imageOwnerAlias>amazon</imageOwnerAlias>\n <name>getting-started</name>\n <description>Image Description</description>\n <rootDeviceType>ebs</rootDeviceType>\n <rootDeviceName>/dev/sda</rootDeviceName>\n <blockDeviceMapping>\n <item>\n <deviceName>/dev/sda1</deviceName>\n <ebs>\n <snapshotId>snap-1a2b3c4d</snapshotId>\n <volumeSize>15</volumeSize>\n <deleteOnTermination>false</deleteOnTermination>\n <volumeType>standard</volumeType>\n </ebs>\n </item>\n </blockDeviceMapping>\n <virtualizationType>paravirtual</virtualizationType>\n <tagSet/>\n <hypervisor>xen</hypervisor>\n </item>\n </imagesSet>\n</DescribeImagesResponse></queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example filters the response to include only public Windows images with an <code>x86_64</code> architecture.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeImages\n&amp;Filter.1.Name=is-public\n&amp;Filter.1.Value.1=true\n&amp;Filter.2.Name=architecture\n&amp;Filter.2.Value.1=x86_64\n&amp;Filter.3.Name=platform\n&amp;Filter.3.Value.1=windows\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeImagesResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imagesSet>\n <item>\n <imageId>ami-1a2b3c4d</imageId>\n <imageLocation>ec2-public-windows-images/Server2003r2-x86_64-Win-v1.07.manifest.xml</imageLocation>\n <imageState>available</imageState>\n <imageOwnerId>123456789012</imageOwnerId>\n <isPublic>true</isPublic>\n <architecture>x86_64</architecture>\n <imageType>machine</imageType>\n <platform>windows</platform>\n <imageOwnerAlias>amazon</imageOwnerAlias>\n <rootDeviceType>instance-store</rootDeviceType>\n <blockDeviceMapping/>\n <virtualizationType>hvm</virtualizationType>\n <tagSet/>\n <hypervisor>xen</hypervisor>\n </item>\n ...\n </imagesSet>\n</DescribeImagesResponse></queryresponse>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example returns the results to display images where the owner is\n\t\t\t\t\t\t<code>aws-marketplace</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeImages\n&amp;Owner.0=aws-marketplace\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeImagesResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>4a4a27a2-2e7c-475d-b35b-ca822EXAMPLE</requestId>\n <imagesSet>\n <item>\n <imageId>ami-1a2b3c4d</imageId>\n <imageLocation>aws-marketplace/example-marketplace-amzn-ami.1</imageLocation>\n <imageState>available</imageState>\n <imageOwnerId>123456789012</imageOwnerId>\n <isPublic>true</isPublic>\n <productCodes>\n <item>\n <productCode>a1b2c3d4e5f6g7h8i9j10k11</productCode>\n <type>marketplace</type>\n </item>\n </productCodes>\n <architecture>i386</architecture>\n <imageType>machine</imageType>\n <kernelId>aki-1a2b3c4d</kernelId>\n <imageOwnerAlias>aws-marketplace</imageOwnerAlias>\n <name>example-marketplace-amzn-ami.1</name>\n <description>Amazon Linux AMI i386 EBS</description>\n <rootDeviceType>ebs</rootDeviceType>\n <rootDeviceName>/dev/sda1</rootDeviceName>\n <blockDeviceMapping>\n <item>\n <deviceName>/dev/sda1</deviceName>\n <ebs>\n <snapshotId>snap-1a2b3c4d</snapshotId>\n <volumeSize>8</volumeSize>\n <deleteOnTermination>true</deleteOnTermination>\n </ebs>\n </item>\n </blockDeviceMapping>\n <virtualizationType>paravirtual</virtualizationType>\n <hypervisor>xen</hypervisor>\n </item>\n ...\n </imagesSet>\n</DescribeImagesResponse></queryresponse>\n </example>\n </examples>\n "
},
"DescribeInstanceAttribute": {
"name": "DescribeInstanceAttribute",
"input": {
"shape_name": "DescribeInstanceAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"required": true
},
"Attribute": {
"shape_name": "InstanceAttributeName",
"type": "string",
"enum": [
"instanceType",
"kernel",
"ramdisk",
"userData",
"disableApiTermination",
"instanceInitiatedShutdownBehavior",
"rootDeviceName",
"blockDeviceMapping",
"productCodes",
"sourceDestCheck",
"groupSet",
"ebsOptimized",
"sriovNetSupport"
],
"documentation": "\n <p>The instance attribute.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "InstanceAttribute",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"InstanceType": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>The instance type.</p>\n ",
"xmlname": "instanceType"
},
"KernelId": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>The kernel ID.</p>\n ",
"xmlname": "kernel"
},
"RamdiskId": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>The RAM disk ID.</p>\n ",
"xmlname": "ramdisk"
},
"UserData": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>The Base64-encoded MIME user data.</p>\n ",
"xmlname": "userData"
},
"DisableApiTermination": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>If the value is <code>true</code>, you can't terminate the instance through the Amazon EC2\n\t\t\t\tconsole, CLI, or API; otherwise, you can.</p>\n ",
"xmlname": "disableApiTermination"
},
"InstanceInitiatedShutdownBehavior": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Indicates whether an instance stops or terminates when you initiate\n\t\t\t\tshutdown from the instance (using the operating system command for system shutdown).</p>\n ",
"xmlname": "instanceInitiatedShutdownBehavior"
},
"RootDeviceName": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>The name of the root device (for example, <code>/dev/sda1</code>).</p>\n ",
"xmlname": "rootDeviceName"
},
"BlockDeviceMappings": {
"shape_name": "InstanceBlockDeviceMappingList",
"type": "list",
"members": {
"shape_name": "InstanceBlockDeviceMapping",
"type": "structure",
"members": {
"DeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name exposed to the instance (for example, <filename>/dev/sdh</filename>).</p>\n ",
"xmlname": "deviceName"
},
"Ebs": {
"shape_name": "EbsInstanceBlockDevice",
"type": "structure",
"members": {
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Amazon EBS volume.</p>\n ",
"xmlname": "volumeId"
},
"Status": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n <p>The attachment state.</p>\n ",
"xmlname": "status"
},
"AttachTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when the attachment initiated.</p>\n ",
"xmlname": "attachTime"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the volume is deleted on instance termination.</p>\n ",
"xmlname": "deleteOnTermination"
}
},
"documentation": "\n <p>Parameters used to automatically set up Amazon EBS volumes when the instance is launched.</p>\n ",
"xmlname": "ebs"
}
},
"documentation": "\n <p>Describes a block device mapping.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The block device mapping of the instance.</p>\n ",
"xmlname": "blockDeviceMapping"
},
"ProductCodes": {
"shape_name": "ProductCodeList",
"type": "list",
"members": {
"shape_name": "ProductCode",
"type": "structure",
"members": {
"ProductCodeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The product code.</p>\n ",
"xmlname": "productCode"
},
"ProductCodeType": {
"shape_name": "ProductCodeValues",
"type": "string",
"enum": [
"devpay",
"marketplace"
],
"documentation": "\n <p>The type of product code.</p>\n ",
"xmlname": "type"
}
},
"documentation": "\n <p>Describes a product code.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>A list of product codes.</p>\n ",
"xmlname": "productCodes"
},
"EbsOptimized": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Indicates whether the instance is optimized for EBS I/O.</p>\n ",
"xmlname": "ebsOptimized"
},
"SriovNetSupport": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": " \n ",
"xmlname": "sriovNetSupport"
},
"SourceDestCheck": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled.\n This value must be false for a NAT instance to perform NAT.</p>\n ",
"xmlname": "sourceDestCheck"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes the specified attribute of the specified instance. You can specify only one\n\t\t\t\tattribute at a time.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example lists the instance type of the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeInstanceAttribute\n&amp;InstanceId=i-10a64379\n&amp;Attribute=instanceType\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;instanceId&gt;i-10a64379&lt;/instanceId&gt;\n &lt;instanceType&gt;\n &lt;value&gt;t1.micro&lt;/value&gt;\n &lt;/instanceType&gt;\n&lt;/DescribeInstanceAttributeResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example lists the current value of the <code>InstanceInitiatedShutdownBehavior</code> attribute for the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeInstanceAttribute\n&amp;InstanceId=i-10a64379\n&amp;Attribute=instanceInitiatedShutdownBehavior\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;instanceId&gt;i-10a64379&lt;/instanceId&gt;\n &lt;instanceInitiatedShutdownBehavior&gt;\n &lt;value&gt;stop&lt;/value&gt;\n &lt;/instanceInitiatedShutdownBehavior&gt;\n&lt;/DescribeInstanceAttributeResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example lists the current value of the <code>DisableApiTermination</code> attribute for the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeInstanceAttribute\n&amp;InstanceId=i-10a64379\n&amp;Attribute=disableApiTermination\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;instanceId&gt;i-10a64379&lt;/instanceId&gt;\n &lt;disableApiTermination&gt;\n &lt;value&gt;false&lt;/value&gt;\n &lt;/disableApiTermination&gt;\n&lt;/DescribeInstanceAttributeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DescribeInstanceStatus": {
"name": "DescribeInstanceStatus",
"input": {
"shape_name": "DescribeInstanceStatusRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceIds": {
"shape_name": "InstanceIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "InstanceId"
},
"documentation": "\n <p>One or more instance IDs.</p>\n <p>Default: Describes all your instances.</p>\n <p>Constraints: Maximum 100 explicitly specified instance IDs.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>availability-zone</code> - The Availability Zone of the instance.</p>\n </li>\n <li>\n <p><code>event.code</code> - The code identifying the type of event (<code>instance-reboot</code> | <code>system-reboot</code> |\n <code>system-maintenance</code> | <code>instance-retirement</code> | <code>instance-stop</code>).</p>\n </li>\n <li>\n <p><code>event.description</code> - A description of the event.</p>\n </li>\n <li>\n <p><code>event.not-after</code> - The latest end time for the scheduled event.</p>\n </li>\n <li>\n <p><code>event.not-before</code> - The earliest start time for the scheduled event.</p>\n </li>\n <li>\n <p><code>instance-state-code</code> - A code representing the state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented.\n The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).</p>\n </li>\n <li>\n <p><code>instance-state-name</code> - The state of the instance (<code>pending</code> | <code>running</code> | <code>shutting-down</code> |\n <code>terminated</code> | <code>stopping</code> | <code>stopped</code>).</p>\n </li>\n <li>\n <p><code>instance-status.reachability</code> - Filters on instance status where the name is <code>reachability</code> (<code>passed</code> |\n <code>failed</code> | <code>initializing</code> | <code>insufficient-data</code>).</p>\n </li>\n <li>\n <p><code>instance-status.status</code> - The status of the instance (<code>ok</code> | <code>impaired</code> | <code>initializing</code> |\n <code>insufficient-data</code> | <code>not-applicable</code>).</p>\n </li>\n <li>\n <p><code>system-status.reachability</code> - Filters on system status where the name is <code>reachability</code> (<code>passed</code> |\n <code>failed</code> | <code>initializing</code> | <code>insufficient-data</code>).</p>\n </li>\n <li>\n <p><code>system-status.status</code> - The system status of the instance (<code>ok</code> | <code>impaired</code> | <code>initializing</code> |\n <code>insufficient-data</code> | <code>not-applicable</code>).</p>\n </li>\n </ul>\n ",
"flattened": true
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The next paginated set of results to return.</p>\n "
},
"MaxResults": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The maximum number of paginated instance items per response.</p>\n <p>Default: 1000</p>\n "
},
"IncludeAllInstances": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>When <code>true</code>, includes the health status for all instances.\n\t\t\t\tWhen <code>false</code>, includes the health status for running instances only.</p>\n\t\t <p>Default: <code>false</code></p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeInstanceStatusResult",
"type": "structure",
"members": {
"InstanceStatuses": {
"shape_name": "InstanceStatusList",
"type": "list",
"members": {
"shape_name": "InstanceStatus",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone of the instance.</p>\n ",
"xmlname": "availabilityZone"
},
"Events": {
"shape_name": "InstanceStatusEventList",
"type": "list",
"members": {
"shape_name": "InstanceStatusEvent",
"type": "structure",
"members": {
"Code": {
"shape_name": "EventCode",
"type": "string",
"enum": [
"instance-reboot",
"system-reboot",
"system-maintenance",
"instance-retirement",
"instance-stop"
],
"documentation": "\n <p>The associated code of the event.</p>\n ",
"xmlname": "code"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description of the event.</p>\n ",
"xmlname": "description"
},
"NotBefore": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The earliest scheduled start time for the event.</p>\n ",
"xmlname": "notBefore"
},
"NotAfter": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The latest scheduled end time for the event.</p>\n ",
"xmlname": "notAfter"
}
},
"documentation": "\n <p>Describes an instance event.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Extra information regarding events associated with the instance.</p>\n ",
"xmlname": "eventsSet"
},
"InstanceState": {
"shape_name": "InstanceState",
"type": "structure",
"members": {
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.</p>\n\t\t <ul>\n\t\t <li><p><code>0</code> : <code>pending</code></p></li>\n\t\t <li><p><code>16</code> : <code>running</code></p></li>\n\t\t <li><p><code>32</code> : <code>shutting-down</code></p></li>\n\t\t <li><p><code>48</code> : <code>terminated</code></p></li>\n\t\t <li><p><code>64</code> : <code>stopping</code></p></li>\n\t\t <li><p><code>80</code> : <code>stopped</code></p></li>\n\t\t </ul>\n ",
"xmlname": "code"
},
"Name": {
"shape_name": "InstanceStateName",
"type": "string",
"enum": [
"pending",
"running",
"shutting-down",
"terminated",
"stopping",
"stopped"
],
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "name"
}
},
"documentation": "\n <p>The intended state of the instance.\n\t\t\t\t<a>DescribeInstanceStatus</a> requires that an\n\t\t\t\tinstance be in the <code>running</code> state.</p>\n ",
"xmlname": "instanceState"
},
"SystemStatus": {
"shape_name": "InstanceStatusSummary",
"type": "structure",
"members": {
"Status": {
"shape_name": "SummaryStatus",
"type": "string",
"enum": [
"ok",
"impaired",
"insufficient-data",
"not-applicable"
],
"documentation": "\n <p>The status.</p>\n ",
"xmlname": "status"
},
"Details": {
"shape_name": "InstanceStatusDetailsList",
"type": "list",
"members": {
"shape_name": "InstanceStatusDetails",
"type": "structure",
"members": {
"Name": {
"shape_name": "StatusName",
"type": "string",
"enum": [
"reachability"
],
"documentation": "\n <p>The type of instance status.</p>\n ",
"xmlname": "name"
},
"Status": {
"shape_name": "StatusType",
"type": "string",
"enum": [
"passed",
"failed",
"insufficient-data"
],
"documentation": "\n <p>The status.</p>\n ",
"xmlname": "status"
},
"ImpairedSince": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time when a status check failed. For an instance that was launched and\n\t\t\t\timpaired, this is the time when the instance was launched.</p>\n ",
"xmlname": "impairedSince"
}
},
"documentation": "\n <p>Describes the instance status.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The system instance health or application instance health.</p>\n ",
"xmlname": "details"
}
},
"documentation": "\n <p>Reports impaired functionality that stems from issues related to the systems that\n\t\t\t\tsupport an instance, such as hardware failures and network connectivity problems.</p>\n ",
"xmlname": "systemStatus"
},
"InstanceStatus": {
"shape_name": "InstanceStatusSummary",
"type": "structure",
"members": {
"Status": {
"shape_name": "SummaryStatus",
"type": "string",
"enum": [
"ok",
"impaired",
"insufficient-data",
"not-applicable"
],
"documentation": "\n <p>The status.</p>\n ",
"xmlname": "status"
},
"Details": {
"shape_name": "InstanceStatusDetailsList",
"type": "list",
"members": {
"shape_name": "InstanceStatusDetails",
"type": "structure",
"members": {
"Name": {
"shape_name": "StatusName",
"type": "string",
"enum": [
"reachability"
],
"documentation": "\n <p>The type of instance status.</p>\n ",
"xmlname": "name"
},
"Status": {
"shape_name": "StatusType",
"type": "string",
"enum": [
"passed",
"failed",
"insufficient-data"
],
"documentation": "\n <p>The status.</p>\n ",
"xmlname": "status"
},
"ImpairedSince": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time when a status check failed. For an instance that was launched and\n\t\t\t\timpaired, this is the time when the instance was launched.</p>\n ",
"xmlname": "impairedSince"
}
},
"documentation": "\n <p>Describes the instance status.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The system instance health or application instance health.</p>\n ",
"xmlname": "details"
}
},
"documentation": "\n <p>Reports impaired functionality that stems from issues internal to the instance,\n\t\t\t\tsuch as impaired reachability.</p>\n ",
"xmlname": "instanceStatus"
}
},
"documentation": "\n <p>Describes the status of an instance.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more instance status descriptions.</p>\n ",
"xmlname": "instanceStatusSet"
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The next paginated set of results to return.</p>\n ",
"xmlname": "nextToken"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes the status of one or more instances, including any scheduled events.</p>\n\t\t\t<p>Instance status has two main components:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<p>System Status reports impaired functionality that stems from issues\n\t\t\t\t\t\trelated to the systems that support an instance, such as such as hardware\n\t\t\t\t\t\tfailures and network connectivity problems. This call reports\n\t\t\t\t\t\tsuch problems as impaired reachability.</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Instance Status reports impaired functionality that arises from\n\t\t\t\t\t\tproblems internal to the instance. This call reports\n\t\t\t\t\t\tsuch problems as impaired reachability.</p>\n\t\t\t\t</li>\n\t\t\t</ul>\n <p>Instance status provides information about four types of scheduled events for an\n instance that may require your attention:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the\n\t\t\t\t\t\tinstances status returns one of two event codes:\n\t\t\t\t\t\t<code>system-reboot</code> or <code>instance-reboot</code>. System\n\t\t\t\t\t\treboot commonly occurs if certain maintenance or upgrade operations require\n\t\t\t\t\t\ta reboot of the underlying host that supports an instance. Instance reboot\n\t\t\t\t\t\tcommonly occurs if the instance must be rebooted, rather than the underlying\n\t\t\t\t\t\thost. Rebooting events include a scheduled start and end time.</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>System Maintenance: When Amazon EC2 determines that an instance requires maintenance that\n\t\t\t\t\t\trequires power or network impact, the instance status is the event\n\t\t\t\t\t\tcode <code>system-maintenance</code>. System maintenance is either\n\t\t\t\t\t\tpower maintenance or network maintenance. For power maintenance, your\n\t\t\t\t\t\tinstance will be unavailable for a brief period of time and then rebooted.\n\t\t\t\t\t\tFor network maintenance, your instance will experience a brief loss of\n\t\t\t\t\t\tnetwork connectivity. System maintenance events include a scheduled start\n\t\t\t\t\t\tand end time. You will also be notified by email if one of your instances is\n\t\t\t\t\t\tset for system maintenance. The email message indicates when your instance\n\t\t\t\t\t\tis scheduled for maintenance.</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the\n\t\t\t\t\t\tinstance status is the event code\n\t\t\t\t\t\t<code>instance-retirement</code>. Retirement commonly occurs when the\n\t\t\t\t\t\tunderlying host is degraded and must be replaced. Retirement events include\n\t\t\t\t\t\ta scheduled start and end time. You will also be notified by email if one of\n\t\t\t\t\t\tyour instances is set to retiring. The email message indicates when your\n\t\t\t\t\t\tinstance will be permanently retired.</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the\n\t\t\t\t\t\tinstances status returns an event code called <code>instance-stop</code>.\n\t\t\t\t\t\tStop events include a scheduled start and end time. You will also be\n\t\t\t\t\t\tnotified by email if one of your instances is set to stop. The email message\n\t\t\t\t\t\tindicates when your instance will be stopped.</p>\n\t\t\t\t</li>\n\t\t\t</ul>\n\n\t\t\t<p>When your instance is retired, it will either be terminated (if its root device type is the\n\t\t\t\tinstance-store) or stopped (if its root device type is an EBS volume). Instances\n\t\t\t\tstopped due to retirement will not be restarted, but you can do so manually. You can\n\t\t\t\talso avoid retirement of EBS-backed instances by manually restarting your instance\n\t\t\t\twhen its event code is <code>instance-retirement</code>. This ensures that your\n\t\t\t\tinstance is started on a different underlying host.</p>\n <p>For more information about failed status checks, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html\">Troubleshooting Instances with Failed Status Checks</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about working with scheduled events, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html#schedevents_actions\">Working with an Instance That Has a Scheduled Event</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example returns instance status descriptions for all instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?\nAction=DescribeInstanceStatus\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example returns instance status descriptions for the specified instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?\nAction=DescribeInstanceStatus\n&amp;InstanceId.0=i-1a2b3c4d\n&amp;InstanceId.1=i-2a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example returns instance status descriptions for all instances specified\n\t\t\t\t\tby supported DescribeInstanceStatus filters.</description>\n <queryrequest>https://ec2.amazonaws.com/?\nAction=DescribeInstanceStatus\n&amp;Filter.0.Name=system-status.reachability\n&amp;Filter.0.Value.failed\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeInstanceStatusResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>3be1508e-c444-4fef-89cc-0b1223c4f02fEXAMPLE</requestId>\n <instanceStatusSet>\n <item>\n <instanceId>i-1a2b3c4d</instanceId>\n <availabilityZone>us-east-1d</availabilityZone>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <systemStatus>\n <status>impaired</status>\n <details>\n <item>\n <name>reachability</name>\n <status>failed</status>\n <impairedSince>YYYY-MM-DDTHH:MM:SS.000Z</impairedSince>\n </item>\n </details>\n </systemStatus>\n <instanceStatus>\n <status>impaired</status>\n <details>\n <item>\n <name>reachability</name>\n <status>failed</status>\n <impairedSince>YYYY-MM-DDTHH:MM:SS.000Z</impairedSince>\n </item>\n </details>\n </instanceStatus>\n <eventsSet>\n <item>\n <code>instance-retirement</code>\n <description>The instance is running on degraded hardware</description>\n <notBefore>YYYY-MM-DDTHH:MM:SS+0000</notBefore>\n <notAfter>YYYY-MM-DDTHH:MM:SS+0000</notAfter>\n </item>\n </eventsSet>\n </item>\n <item>\n <instanceId>i-2a2b3c4d</instanceId>\n <availabilityZone>us-east-1d</availabilityZone>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <systemStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </systemStatus>\n <instanceStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </instanceStatus>\n <eventsSet>\n <item>\n <code>instance-reboot</code>\n <description>The instance is scheduled for a reboot</description>\n <notBefore>YYYY-MM-DDTHH:MM:SS+0000</notBefore>\n <notAfter>YYYY-MM-DDTHH:MM:SS+0000</notAfter>\n </item>\n </eventsSet>\n </item>\n <item>\n <instanceId>i-3a2b3c4d</instanceId>\n <availabilityZone>us-east-1d</availabilityZone>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <systemStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </systemStatus>\n <instanceStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </instanceStatus>\n </item>\n <item>\n <instanceId>i-4a2b3c4d</instanceId>\n <availabilityZone>us-east-1d</availabilityZone>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <systemStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </systemStatus>\n <instanceStatus>\n <status>insufficient-data</status>\n <details>\n <item>\n <name>reachability</name>\n <status>insufficient-data</status>\n </item>\n </details>\n </instanceStatus>\n </item>\n </instanceStatusSet>\n</DescribeInstanceStatusResponse></queryresponse>\n </example>\n </examples>\n\t ",
"pagination": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "InstanceStatuses",
"py_input_token": "next_token"
}
},
"DescribeInstances": {
"name": "DescribeInstances",
"input": {
"shape_name": "DescribeInstancesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceIds": {
"shape_name": "InstanceIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "InstanceId"
},
"documentation": "\n <p>One or more instance IDs.</p>\n <p>Default: Describes all your instances.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>architecture</code> - The instance architecture (<code>i386</code> | <code>x86_64</code>).</p>\n </li>\n <li>\n <p><code>availability-zone</code> - The Availability Zone of the instance.</p>\n </li>\n <li>\n <p><code>block-device-mapping.attach-time</code> - The attach time for an Amazon EBS volume mapped to the instance.</p>\n </li>\n <li>\n <p><code>block-device-mapping.delete-on-termination</code> - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n </li>\n <li>\n <p><code>block-device-mapping.device-name</code> - The device name for the Amazon EBS volume (for example, <code>/dev/sdh</code>).</p>\n </li>\n <li>\n <p><code>block-device-mapping.status</code> - The status for the Amazon EBS volume (<code>attaching</code> | <code>attached</code> |\n <code>detaching</code> | <code>detached</code>).</p>\n </li>\n <li>\n <p><code>block-device-mapping.volume-id</code> - The volume ID of the Amazon EBS volume.</p>\n </li>\n <li>\n <p><code>client-token</code> - The idempotency token you provided when you launched the instance.</p>\n </li>\n <li>\n <p><code>dns-name</code> - The public DNS name of the instance.</p>\n </li>\n <li>\n <p><code>group-id</code> - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use <code>group-name</code> instead.</p>\n </li>\n <li>\n <p><code>group-name</code> - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use <code>group-id</code> instead.</p>\n </li>\n <li>\n <p><code>hypervisor</code> - The hypervisor type of the instance (<code>ovm</code> | <code>xen</code>).</p>\n </li>\n <li>\n <p><code>image-id</code> - The ID of the image used to launch the instance.</p>\n </li>\n <li>\n <p><code>instance-id</code> - The ID of the instance.</p>\n </li>\n <li>\n <p><code>instance-lifecycle</code> - Indicates whether this is a Spot Instance (<code>spot</code>).</p>\n </li>\n <li>\n <p><code>instance-state-code</code> - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).</p>\n </li>\n <li>\n <p><code>instance-state-name</code> - The state of the instance (<code>pending</code> | <code>running</code> | <code>shutting-down</code> | <code>terminated</code> | <code>stopping</code> | <code>stopped</code>).</p>\n </li>\n <li>\n <p><code>instance-type</code> - The type of instance (for example, <code>m1.small</code>).</p>\n </li>\n <li>\n <p><code>instance.group-id</code> - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use <code>instance.group-name</code> instead.</p>\n </li>\n <li>\n <p><code>instance.group-name</code> - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use <code>instance.group-id</code> instead.</p>\n </li>\n <li>\n <p><code>ip-address</code> - The public IP address of the instance.</p>\n </li>\n <li>\n <p><code>kernel-id</code> - The kernel ID.</p>\n </li>\n <li>\n <p><code>key-name</code> - The name of the key pair used when the instance was launched.</p>\n </li>\n <li>\n <p><code>launch-index</code> - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on). </p>\n </li>\n <li>\n <p><code>launch-time</code> - The time when the instance was launched.</p>\n </li>\n <li>\n <p><code>monitoring-state</code> - Indicates whether monitoring is enabled for the instance (<code>disabled</code> | <code>enabled</code>).</p>\n </li>\n <li>\n <p><code>owner-id</code> - The AWS account ID of the instance owner.</p>\n </li>\n <li>\n <p><code>placement-group-name</code> - The name of the placement group for the instance.</p>\n </li>\n <li>\n <p><code>platform</code> - The platform. Use <code>windows</code> if you have Windows instances; otherwise, leave blank.</p>\n </li>\n <li>\n <p><code>private-dns-name</code> - The private DNS name of the instance.</p>\n </li>\n <li>\n <p><code>private-ip-address</code> - The private IP address of the instance.</p>\n </li>\n <li>\n <p><code>product-code</code> - The product code associated with the AMI used to launch the instance.</p>\n </li>\n <li>\n <p><code>product-code.type</code> - The type of product code (<code>devpay</code> | <code>marketplace</code>).</p>\n </li>\n <li>\n <p><code>ramdisk-id</code> - The RAM disk ID.</p>\n </li>\n <li>\n <p><code>reason</code> - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.</p>\n </li>\n <li>\n <p><code>requester-id</code> - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).</p>\n </li>\n <li>\n <p><code>reservation-id</code> - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.</p>\n </li>\n <li>\n <p><code>root-device-name</code> - The name of the root device for the instance (for example, <code>/dev/sda1</code>).</p>\n </li>\n <li>\n <p><code>root-device-type</code> - The type of root device that the instance uses (<code>ebs</code> | <code>instance-store</code>).</p>\n </li>\n <li>\n <p><code>source-dest-check</code> - Indicates whether the instance performs source/destination checking. A value of <code>true</code> means that checking is enabled, and <code>false</code> means checking is disabled. The value must be <code>false</code> for the instance to perform network address translation (NAT) in your VPC. </p>\n </li>\n <li>\n <p><code>spot-instance-request-id</code> - The ID of the Spot Instance request.</p>\n </li>\n <li>\n <p><code>state-reason-code</code> - The reason code for the state change.</p>\n </li>\n <li>\n <p><code>state-reason-message</code> - A message that describes the state change.</p>\n </li>\n <li>\n <p><code>subnet-id</code> - The ID of the subnet for the instance.</p>\n </li>\n <li>\n <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to\n the resource, where <code>tag</code>:<i>key</i> is the tag's key. </p>\n </li>\n <li>\n <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter.\n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both\n the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is).\n If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n </li>\n <li>\n <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n </li>\n <li>\n <p><code>virtualization-type</code> - The virtualization type of the instance (<code>paravirtual</code> | <code>hvm</code>).</p>\n </li>\n <li>\n <p><code>vpc-id</code> - The ID of the VPC that the instance is running in.</p>\n </li>\n <li>\n <p><code>network-interface.description</code> - The description of the network interface.</p>\n </li>\n <li>\n <p><code>network-interface.subnet-id</code> - The ID of the subnet for the network interface.</p>\n </li>\n <li>\n <p><code>network-interface.vpc-id</code> - The ID of the VPC for the network interface.</p>\n </li>\n <li>\n <p><code>network-interface.network-interface.id</code> - The ID of the network interface.</p>\n </li>\n <li>\n <p><code>network-interface.owner-id</code> - The ID of the owner of the network interface.</p>\n </li>\n <li>\n <p><code>network-interface.availability-zone</code> - The Availability Zone for the network interface.</p>\n </li>\n <li>\n <p><code>network-interface.requester-id</code> - The requester ID for the network interface.</p>\n </li>\n <li>\n <p><code>network-interface.requester-managed</code> - Indicates whether the network interface is being managed by AWS.</p>\n </li>\n <li>\n <p><code>network-interface.status</code> - The status of the network interface (<code>available</code>) | <code>in-use</code>).</p>\n </li>\n <li>\n <p><code>network-interface.mac-address</code> - The MAC address of the network interface.</p>\n </li>\n <li>\n <p><code>network-interface-private-dns-name</code> - The private DNS name of the network interface.</p>\n </li>\n <li>\n <p><code>network-interface.source-destination-check</code> - Whether the network interface performs source/destination checking. A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. The value must be <code>false</code> for the network interface to perform network address translation (NAT) in your VPC.</p>\n </li>\n <li>\n <p><code>network-interface.group-id</code> - The ID of a security group associated with the network interface.</p>\n </li>\n <li>\n <p><code>network-interface.group-name</code> - The name of a security group associated with the network interface.</p>\n </li>\n <li>\n <p><code>network-interface.attachment.attachment-id</code> - The ID of the interface attachment.</p>\n </li>\n <li>\n <p><code>network-interface.attachment.instance-id</code> - The ID of the instance to which the network interface is attached.</p>\n </li>\n <li>\n <p><code>network-interface.attachment.instance-owner-id</code> - The owner ID of the instance to which the network interface is attached.</p>\n </li>\n <li>\n <p><code>network-interface.addresses.private-ip-address</code> - The private IP address associated with the network interface.</p>\n </li>\n <li>\n <p><code>network-interface.attachment.device-index</code> - The device index to which the network interface is attached.</p>\n </li>\n <li>\n <p><code>network-interface.attachment.status</code> - The status of the attachment (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</p>\n </li>\n <li>\n <p><code>network-interface.attachment.attach-time</code> - The time that the network interface was attached to an instance.</p>\n </li>\n <li>\n <p><code>network-interface.attachment.delete-on-termination</code> - Specifies whether the attachment is deleted when an instance is terminated.</p>\n </li>\n <li>\n <p><code>network-interface.addresses.primary</code> - Specifies whether the IP address of the network interface is the primary private IP address.</p>\n </li>\n <li>\n <p><code>network-interface.addresses.association.public-ip</code> - The ID of the association of an Elastic IP address with a network interface.</p>\n </li>\n <li>\n <p><code>network-interface.addresses.association.ip-owner-id</code> - The owner ID of the private IP address associated with the network interface.</p>\n </li>\n <li>\n <p><code>association.public-ip</code> - The address of the Elastic IP address bound to the network interface.</p>\n </li>\n <li>\n <p><code>association.ip-owner-id</code> - The owner of the Elastic IP address associated with the network interface.</p>\n </li>\n <li>\n <p><code>association.allocation-id</code> - The allocation ID returned when you allocated the Elastic IP address for your network interface.</p>\n </li>\n <li>\n <p><code>association.association-id</code> - The association ID returned when the network interface was associated with an IP address.</p>\n </li>\n </ul>\n ",
"flattened": true
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The token for the next set of items to return. (You received this token from a prior call.)</p>\n "
},
"MaxResults": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeInstancesResult",
"type": "structure",
"members": {
"Reservations": {
"shape_name": "ReservationList",
"type": "list",
"members": {
"shape_name": "Reservation",
"type": "structure",
"members": {
"ReservationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the reservation.</p>\n ",
"xmlname": "reservationId"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AWS account that owns the reservation.</p>\n ",
"xmlname": "ownerId"
},
"RequesterId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the requester that launched the instances on your behalf (for example,\n\t\t\t\tAWS Management Console or Auto Scaling).</p>\n ",
"xmlname": "requesterId"
},
"Groups": {
"shape_name": "GroupIdentifierList",
"type": "list",
"members": {
"shape_name": "GroupIdentifier",
"type": "structure",
"members": {
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more security groups.</p>\n ",
"xmlname": "groupSet"
},
"Instances": {
"shape_name": "InstanceList",
"type": "list",
"members": {
"shape_name": "Instance",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI used to launch the instance.</p>\n ",
"xmlname": "imageId"
},
"State": {
"shape_name": "InstanceState",
"type": "structure",
"members": {
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.</p>\n\t\t <ul>\n\t\t <li><p><code>0</code> : <code>pending</code></p></li>\n\t\t <li><p><code>16</code> : <code>running</code></p></li>\n\t\t <li><p><code>32</code> : <code>shutting-down</code></p></li>\n\t\t <li><p><code>48</code> : <code>terminated</code></p></li>\n\t\t <li><p><code>64</code> : <code>stopping</code></p></li>\n\t\t <li><p><code>80</code> : <code>stopped</code></p></li>\n\t\t </ul>\n ",
"xmlname": "code"
},
"Name": {
"shape_name": "InstanceStateName",
"type": "string",
"enum": [
"pending",
"running",
"shutting-down",
"terminated",
"stopping",
"stopped"
],
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "name"
}
},
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "instanceState"
},
"PrivateDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The private DNS name assigned to the instance. This DNS name can only be used\n\t\t\t\tinside the Amazon EC2 network. This name is not available until the instance enters\n\t\t\t\tthe <code>running</code> state.</p>\n ",
"xmlname": "privateDnsName"
},
"PublicDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The public DNS name assigned to the instance.\n\t\t\t\tThis name is not available until the instance enters the <code>running</code> state.</p>\n ",
"xmlname": "dnsName"
},
"StateTransitionReason": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason for the most recent state transition. This might be an empty string.</p>\n ",
"xmlname": "reason"
},
"KeyName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the key pair, if this instance was launched with an associated key pair.</p>\n ",
"xmlname": "keyName"
},
"AmiLaunchIndex": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The AMI launch index, which can be used to find this instance in the launch group.</p>\n ",
"xmlname": "amiLaunchIndex"
},
"ProductCodes": {
"shape_name": "ProductCodeList",
"type": "list",
"members": {
"shape_name": "ProductCode",
"type": "structure",
"members": {
"ProductCodeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The product code.</p>\n ",
"xmlname": "productCode"
},
"ProductCodeType": {
"shape_name": "ProductCodeValues",
"type": "string",
"enum": [
"devpay",
"marketplace"
],
"documentation": "\n <p>The type of product code.</p>\n ",
"xmlname": "type"
}
},
"documentation": "\n <p>Describes a product code.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The product codes attached to this instance.</p>\n ",
"xmlname": "productCodes"
},
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type.</p>\n ",
"xmlname": "instanceType"
},
"LaunchTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time the instance was launched.</p>\n ",
"xmlname": "launchTime"
},
"Placement": {
"shape_name": "Placement",
"type": "structure",
"members": {
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone of the instance.</p>\n ",
"xmlname": "availabilityZone"
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the placement group the instance is in (for cluster compute instances).</p>\n ",
"xmlname": "groupName"
},
"Tenancy": {
"shape_name": "Tenancy",
"type": "string",
"enum": [
"default",
"dedicated"
],
"documentation": "\n <p>The tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of <code>dedicated</code> runs\n on single-tenant hardware.</p>\n ",
"xmlname": "tenancy"
}
},
"documentation": "\n <p>The location where the instance launched.</p>\n ",
"xmlname": "placement"
},
"KernelId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The kernel associated with this instance.</p>\n ",
"xmlname": "kernelId"
},
"RamdiskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The RAM disk associated with this instance.</p>\n ",
"xmlname": "ramdiskId"
},
"Platform": {
"shape_name": "PlatformValues",
"type": "string",
"enum": [
"Windows"
],
"documentation": "\n <p>The value is <code>Windows</code> for Windows instances; otherwise blank.</p>\n ",
"xmlname": "platform"
},
"Monitoring": {
"shape_name": "Monitoring",
"type": "structure",
"members": {
"State": {
"shape_name": "MonitoringState",
"type": "string",
"enum": [
"disabled",
"enabled",
"pending"
],
"documentation": "\n <p>Indicates whether monitoring is enabled for the instance.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n <p>The monitoring information for the instance.</p>\n ",
"xmlname": "monitoring"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the subnet in which the instance is running.</p>\n ",
"xmlname": "subnetId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC in which the instance is running.</p>\n ",
"xmlname": "vpcId"
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The private IP address assigned to the instance.</p>\n ",
"xmlname": "privateIpAddress"
},
"PublicIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The public IP address assigned to the instance.</p>\n ",
"xmlname": "ipAddress"
},
"StateReason": {
"shape_name": "StateReason",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason code for the state change.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The message for the state change.</p>\n <ul>\n <li><p><code>Server.SpotInstanceTermination</code>: A Spot Instance was terminated due to an increase in the market price.</p></li>\n <li><p><code>Server.InternalError</code>: An internal error occurred during instance launch, resulting in termination.</p></li>\n <li><p><code>Server.InsufficientInstanceCapacity</code>: There was insufficient instance capacity to satisfy the launch request.</p></li>\n <li><p><code>Client.InternalError</code>: A client error caused the instance to terminate on launch.</p></li>\n <li><p><code>Client.InstanceInitiatedShutdown</code>: The instance was shut down using the <code>shutdown -h</code> command from the instance.</p></li>\n <li><p><code>Client.UserInitiatedShutdown</code>: The instance was shut down using the Amazon EC2 API.</p></li>\n <li><p><code>Client.VolumeLimitExceeded</code>: The volume limit was exceeded.</p></li>\n <li><p><code>Client.InvalidSnapshot.NotFound</code>: The specified snapshot was not found.</p></li>\n </ul>\n ",
"xmlname": "message"
}
},
"documentation": "\n <p>The reason for the most recent state transition.</p>\n ",
"xmlname": "stateReason"
},
"Architecture": {
"shape_name": "ArchitectureValues",
"type": "string",
"enum": [
"i386",
"x86_64"
],
"documentation": "\n <p>The architecture of the image.</p>\n ",
"xmlname": "architecture"
},
"RootDeviceType": {
"shape_name": "DeviceType",
"type": "string",
"enum": [
"ebs",
"instance-store"
],
"documentation": "\n <p>The root device type used by the AMI. The AMI can use an Amazon EBS volume\n or an instance store volume.</p>\n ",
"xmlname": "rootDeviceType"
},
"RootDeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The root device name (for example, <code>/dev/sda1</code>).</p>\n ",
"xmlname": "rootDeviceName"
},
"BlockDeviceMappings": {
"shape_name": "InstanceBlockDeviceMappingList",
"type": "list",
"members": {
"shape_name": "InstanceBlockDeviceMapping",
"type": "structure",
"members": {
"DeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name exposed to the instance (for example, <filename>/dev/sdh</filename>).</p>\n ",
"xmlname": "deviceName"
},
"Ebs": {
"shape_name": "EbsInstanceBlockDevice",
"type": "structure",
"members": {
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Amazon EBS volume.</p>\n ",
"xmlname": "volumeId"
},
"Status": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n <p>The attachment state.</p>\n ",
"xmlname": "status"
},
"AttachTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when the attachment initiated.</p>\n ",
"xmlname": "attachTime"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the volume is deleted on instance termination.</p>\n ",
"xmlname": "deleteOnTermination"
}
},
"documentation": "\n <p>Parameters used to automatically set up Amazon EBS volumes when the instance is launched.</p>\n ",
"xmlname": "ebs"
}
},
"documentation": "\n <p>Describes a block device mapping.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any block device mapping entries for the instance.</p>\n ",
"xmlname": "blockDeviceMapping"
},
"VirtualizationType": {
"shape_name": "VirtualizationType",
"type": "string",
"enum": [
"hvm",
"paravirtual"
],
"documentation": "\n <p>The virtualization type of the instance.</p>\n ",
"xmlname": "virtualizationType"
},
"InstanceLifecycle": {
"shape_name": "InstanceLifecycleType",
"type": "string",
"enum": [
"spot"
],
"documentation": "\n <p>Indicates whether this is a Spot Instance.</p>\n ",
"xmlname": "instanceLifecycle"
},
"SpotInstanceRequestId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Spot Instance request.</p>\n ",
"xmlname": "spotInstanceRequestId"
},
"ClientToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The idempotency token you provided when you launched the instance.</p>\n ",
"xmlname": "clientToken"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the instance.</p>\n ",
"xmlname": "tagSet"
},
"SecurityGroups": {
"shape_name": "GroupIdentifierList",
"type": "list",
"members": {
"shape_name": "GroupIdentifier",
"type": "structure",
"members": {
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more security groups for the instance.</p>\n ",
"xmlname": "groupSet"
},
"SourceDestCheck": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Specifies whether to enable an instance launched in a VPC to\n\t\t\t\tperform NAT. This controls whether source/destination checking\n\t\t\t\tis enabled on the instance. A value of <code>true</code> means\n\t\t\t\tchecking is enabled, and <code>false</code> means checking is\n\t\t\t\tdisabled. The value must be <code>false</code> for the instance\n\t\t\t\tto perform NAT. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html\">NAT\n\t\t\t\tInstances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n ",
"xmlname": "sourceDestCheck"
},
"Hypervisor": {
"shape_name": "HypervisorType",
"type": "string",
"enum": [
"ovm",
"xen"
],
"documentation": "\n <p>The hypervisor type of the instance.</p>\n ",
"xmlname": "hypervisor"
},
"NetworkInterfaces": {
"shape_name": "InstanceNetworkInterfaceList",
"type": "list",
"members": {
"shape_name": "InstanceNetworkInterface",
"type": "structure",
"members": {
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"xmlname": "networkInterfaceId"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet.</p>\n ",
"xmlname": "subnetId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The description.</p>\n ",
"xmlname": "description"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the AWS account that created the network interface.</p>\n ",
"xmlname": "ownerId"
},
"Status": {
"shape_name": "NetworkInterfaceStatus",
"type": "string",
"enum": [
"available",
"attaching",
"in-use",
"detaching"
],
"documentation": "\n\t\t <p>The status of the network interface.</p>\n ",
"xmlname": "status"
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The IP address of the network interface within the subnet.</p>\n ",
"xmlname": "privateIpAddress"
},
"PrivateDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private DNS name.</p>\n ",
"xmlname": "privateDnsName"
},
"SourceDestCheck": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether to validate network traffic to or from this network interface.</p>\n ",
"xmlname": "sourceDestCheck"
},
"Groups": {
"shape_name": "GroupIdentifierList",
"type": "list",
"members": {
"shape_name": "GroupIdentifier",
"type": "structure",
"members": {
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more security groups.</p>\n ",
"xmlname": "groupSet"
},
"Attachment": {
"shape_name": "InstanceNetworkInterfaceAttachment",
"type": "structure",
"members": {
"AttachmentId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface attachment.</p>\n ",
"xmlname": "attachmentId"
},
"DeviceIndex": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The index of the device on the instance for the network interface attachment.</p>\n ",
"xmlname": "deviceIndex"
},
"Status": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n\t\t <p>The attachment state.</p>\n ",
"xmlname": "status"
},
"AttachTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n\t\t <p>The time stamp when the attachment initiated.</p>\n ",
"xmlname": "attachTime"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the network interface is deleted when the instance is terminated.</p>\n ",
"xmlname": "deleteOnTermination"
}
},
"documentation": "\n\t\t <p>The network interface attachment.</p>\n ",
"xmlname": "attachment"
},
"Association": {
"shape_name": "InstanceNetworkInterfaceAssociation",
"type": "structure",
"members": {
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The address of the Elastic IP address bound to the network interface.</p>\n ",
"xmlname": "publicIp"
},
"PublicDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The public DNS name.</p>\n ",
"xmlname": "publicDnsName"
},
"IpOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the owner of the Elastic IP address.</p>\n ",
"xmlname": "ipOwnerId"
}
},
"documentation": "\n\t\t <p>The association information for an Elastic IP associated with the network interface.</p>\n ",
"xmlname": "association"
},
"PrivateIpAddresses": {
"shape_name": "InstancePrivateIpAddressList",
"type": "list",
"members": {
"shape_name": "InstancePrivateIpAddress",
"type": "structure",
"members": {
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP address of the network interface.</p>\n ",
"xmlname": "privateIpAddress"
},
"PrivateDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private DNS name.</p>\n ",
"xmlname": "privateDnsName"
},
"Primary": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether this IP address is the primary private IP address \n\t\t of the network interface.</p>\n ",
"xmlname": "primary"
},
"Association": {
"shape_name": "InstanceNetworkInterfaceAssociation",
"type": "structure",
"members": {
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The address of the Elastic IP address bound to the network interface.</p>\n ",
"xmlname": "publicIp"
},
"PublicDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The public DNS name.</p>\n ",
"xmlname": "publicDnsName"
},
"IpOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the owner of the Elastic IP address.</p>\n ",
"xmlname": "ipOwnerId"
}
},
"documentation": "\n\t\t <p>The association information for an Elastic IP address for the network interface.</p>\n ",
"xmlname": "association"
}
},
"documentation": "\n\t\t <p>Describes a private IP address.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>The private IP addresses associated with the network interface.</p>\n ",
"xmlname": "privateIpAddressesSet"
}
},
"documentation": "\n\t\t <p>Describes a network interface.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>[EC2-VPC] One or more network interfaces for the instance.</p>\n ",
"xmlname": "networkInterfaceSet"
},
"IamInstanceProfile": {
"shape_name": "IamInstanceProfile",
"type": "structure",
"members": {
"Arn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Amazon Resource Name (ARN) of the instance profile.</p>\n ",
"xmlname": "arn"
},
"Id": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance profile.</p>\n ",
"xmlname": "id"
}
},
"documentation": "\n <p>The IAM instance profile associated with the instance.</p>\n ",
"xmlname": "iamInstanceProfile"
},
"EbsOptimized": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal I/O performance. This optimization\n\t\t\t\tisn't available with all instance types. Additional usage charges apply when\n\t\t\t\tusing an EBS Optimized instance.</p>\n ",
"xmlname": "ebsOptimized"
},
"SriovNetSupport": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies whether enhanced networking is enabled.</p>\n ",
"xmlname": "sriovNetSupport"
}
},
"documentation": "\n <p>Describes an instance.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more instances.</p>\n ",
"xmlname": "instancesSet"
}
},
"documentation": "\n <p>Describes a reservation.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more reservations.</p>\n ",
"xmlname": "reservationSet"
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>\n ",
"xmlname": "nextToken"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes one or more of your instances.</p>\n <p>If you specify one or more instance IDs, Amazon EC2 returns information for those\n instances. If you do not specify instance IDs, Amazon EC2 returns information for\n all relevant instances. If you specify an instance ID that is not valid, an error is returned.\n If you specify an instance that you do not own, it is not included in the returned\n results.</p>\n <p>Recently terminated instances might appear in the returned results. This interval\n is usually less than one hour.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes all instances owned by your AWS account. The\n example response shows information for one instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeInstances\n&amp;AUTHPARAMS\n </queryrequest>\n <queryresponse>&lt;DescribeInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;fdcdcab1-ae5c-489e-9c33-4637c5dda355&lt;/requestId&gt;\n &lt;reservationSet&gt;\n &lt;item&gt;\n &lt;reservationId&gt;r-1a2b3c4d&lt;/reservationId&gt;\n &lt;ownerId&gt;123456789012&lt;/ownerId&gt;\n &lt;groupSet&gt;\n &lt;item&gt;\n &lt;groupId&gt;sg-1a2b3c4d&lt;/groupId&gt;\n &lt;groupName&gt;my-security-group&lt;/groupName&gt;\n &lt;/item&gt;\n &lt;/groupSet&gt;\n &lt;instancesSet&gt;\n &lt;item&gt;\n &lt;instanceId&gt;i-1a2b3c4d&lt;/instanceId&gt;\n &lt;imageId&gt;ami-1a2b3c4d&lt;/imageId&gt;\n &lt;instanceState&gt;\n &lt;code&gt;16&lt;/code&gt;\n &lt;name&gt;running&lt;/name&gt;\n &lt;/instanceState&gt;\n &lt;privateDnsName/&gt;\n &lt;dnsName/&gt;\n &lt;reason/&gt;\n &lt;keyName&gt;my-key-pair&lt;/keyName&gt;\n &lt;amiLaunchIndex&gt;0&lt;/amiLaunchIndex&gt;\n &lt;productCodes/&gt;\n &lt;instanceType&gt;c1.medium&lt;/instanceType&gt;\n &lt;launchTime&gt;YYYY-MM-DDTHH:MM:SS+0000&lt;/launchTime&gt;\n &lt;placement&gt;\n &lt;availabilityZone&gt;us-west-2a&lt;/availabilityZone&gt;\n &lt;groupName/&gt;\n &lt;tenancy&gt;default&lt;/tenancy&gt;\n &lt;/placement&gt;\n &lt;platform&gt;windows&lt;/platform&gt;\n &lt;monitoring&gt;\n &lt;state&gt;disabled&lt;/state&gt;\n &lt;/monitoring&gt;\n &lt;subnetId&gt;subnet-1a2b3c4d&lt;/subnetId&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&lt;/vpcId&gt;\n &lt;privateIpAddress&gt;10.0.0.12&lt;/privateIpAddress&gt;\n &lt;ipAddress&gt;46.51.219.63&lt;/ipAddress&gt;\n &lt;sourceDestCheck&gt;true&lt;/sourceDestCheck&gt;\n &lt;groupSet&gt;\n &lt;item&gt;\n &lt;groupId&gt;sg-1a2b3c4d&lt;/groupId&gt;\n &lt;groupName&gt;my-security-group&lt;/groupName&gt;\n &lt;/item&gt;\n &lt;/groupSet&gt;\n &lt;architecture&gt;x86_64&lt;/architecture&gt;\n &lt;rootDeviceType&gt;ebs&lt;/rootDeviceType&gt;\n &lt;rootDeviceName&gt;/dev/sda1&lt;/rootDeviceName&gt;\n &lt;blockDeviceMapping&gt;\n &lt;item&gt;\n &lt;deviceName&gt;/dev/sda1&lt;/deviceName&gt;\n &lt;ebs&gt;\n &lt;volumeId&gt;vol-1a2b3c4d&lt;/volumeId&gt;\n &lt;status&gt;attached&lt;/status&gt;\n &lt;attachTime&gt;YYYY-MM-DDTHH:MM:SS.SSSZ&lt;/attachTime&gt;\n &lt;deleteOnTermination&gt;true&lt;/deleteOnTermination&gt;\n &lt;/ebs&gt;\n &lt;/item&gt;\n &lt;/blockDeviceMapping&gt;\n &lt;virtualizationType&gt;hvm&lt;/virtualizationType&gt;\n &lt;clientToken&gt;ABCDE1234567890123&lt;/clientToken&gt;\n &lt;tagSet&gt;\n &lt;item&gt;\n &lt;key&gt;Name&lt;/key&gt;\n &lt;value&gt;Windows Instance&lt;/value&gt;\n &lt;/item&gt;\n &lt;/tagSet&gt;\n &lt;hypervisor&gt;xen&lt;/hypervisor&gt;\n &lt;networkInterfaceSet&gt;\n &lt;item&gt;\n &lt;networkInterfaceId&gt;eni-1a2b3c4d&lt;/networkInterfaceId&gt;\n &lt;subnetId&gt;subnet-1a2b3c4d&lt;/subnetId&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&lt;/vpcId&gt;\n &lt;description&gt;Primary network interface&lt;/description&gt;\n &lt;ownerId&gt;123456789012&lt;/ownerId&gt;\n &lt;status&gt;in-use&lt;/status&gt;\n &lt;macAddress&gt;1b:2b:3c:4d:5e:6f&lt;/macAddress&gt;\n &lt;privateIpAddress&gt;10.0.0.12&lt;/privateIpAddress&gt;\n &lt;sourceDestCheck&gt;true&lt;/sourceDestCheck&gt;\n &lt;groupSet&gt;\n &lt;item&gt;\n &lt;groupId&gt;sg-1a2b3c4d&lt;/groupId&gt;\n &lt;groupName&gt;my-security-group&lt;/groupName&gt;\n &lt;/item&gt;\n &lt;/groupSet&gt;\n &lt;attachment&gt;\n &lt;attachmentId&gt;eni-attach-1a2b3c4d&lt;/attachmentId&gt;\n &lt;deviceIndex&gt;0&lt;/deviceIndex&gt;\n &lt;status&gt;attached&lt;/status&gt;\n &lt;attachTime&gt;YYYY-MM-DDTHH:MM:SS+0000&lt;/attachTime&gt;\n &lt;deleteOnTermination&gt;true&lt;/deleteOnTermination&gt;\n &lt;/attachment&gt;\n &lt;association&gt;\n &lt;publicIp&gt;198.51.100.63&lt;/publicIp&gt;\n &lt;ipOwnerId&gt;123456789012&lt;/ipOwnerId&gt;\n &lt;/association&gt;\n &lt;privateIpAddressesSet&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.0.12&lt;/privateIpAddress&gt;\n &lt;primary&gt;true&lt;/primary&gt;\n &lt;association&gt;\n &lt;publicIp&gt;198.51.100.63&lt;/publicIp&gt;\n &lt;ipOwnerId&gt;123456789012&lt;/ipOwnerId&gt;\n &lt;/association&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.0.14&lt;/privateIpAddress&gt;\n &lt;primary&gt;false&lt;/primary&gt;\n &lt;association&gt;\n &lt;publicIp&gt;198.51.100.177&lt;/publicIp&gt;\n &lt;ipOwnerId&gt;123456789012&lt;/ipOwnerId&gt;\n &lt;/association&gt;\n &lt;/item&gt;\n &lt;/privateIpAddressesSet&gt;\n &lt;/item&gt;\n &lt;/networkInterfaceSet&gt;\n &lt;/item&gt;\n &lt;/instancesSet&gt;\n &lt;/item&gt;\n &lt;/reservationSet&gt;\n &lt;/DescribeInstancesResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example describes only the instances that have the <code>m1.small</code> or <code>m1.large</code> instance type and an attached Amazon EBS volume that will be deleted on termination.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeInstances\n&amp;Filter.1.Name=instance-type\n&amp;Filter.1.Value.1=m1.small\n&amp;Filter.1.Value.2=m1.large\n&amp;Filter.2.Name=block-device-mapping.status\n&amp;Filter.2.Value.1=attached\n&amp;Filter.3.Name=block-device-mapping.delete-on-termination\n&amp;Filter.3.Value.1=true\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example describes all instances that are running in a VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeInstances\n&amp;Filter.1.Name=vpc-id\n&amp;Filter.1.Value.1=*\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 4</name>\n <description>This example describes any instances that have a tag with the key <code>Owner</code>,\n regardless of the value of the tag.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeInstances\n&amp;Filter.1.Name=tag-key\n&amp;Filter.1.Value.1=Owner\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example</name>\n <description>This example lists only the instances that have a tag with the key\n <code>Owner</code> and the value <code>DbAdmin</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeInstances\n&amp;Filter.1.Name=tag:Owner\n&amp;Filter.1.Value.1=DbAdmin\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n ",
"pagination": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Reservations",
"py_input_token": "next_token"
}
},
"DescribeInternetGateways": {
"name": "DescribeInternetGateways",
"input": {
"shape_name": "DescribeInternetGatewaysRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InternetGatewayIds": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "InternetGatewayId"
},
"documentation": "\n\t\t <p>One or more Internet gateway IDs.</p>\n\t\t <p>Default: Describes all your Internet gateways.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>attachment.state</code> - The current state of the attachment between the gateway and the VPC. Present only if a VPC is attached.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.vpc-id</code> - The ID of an attached VPC.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>internet-gateway-id</code> - The ID of the Internet gateway.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeInternetGatewaysResult",
"type": "structure",
"members": {
"InternetGateways": {
"shape_name": "InternetGatewayList",
"type": "list",
"members": {
"shape_name": "InternetGateway",
"type": "structure",
"members": {
"InternetGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the Internet gateway.</p>\n ",
"xmlname": "internetGatewayId"
},
"Attachments": {
"shape_name": "InternetGatewayAttachmentList",
"type": "list",
"members": {
"shape_name": "InternetGatewayAttachment",
"type": "structure",
"members": {
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"State": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n\t\t <p>The current state of the attachment.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n\t\t <p>Describes the attachment of a VPC to an Internet gateway.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any VPCs attached to the Internet gateway.</p>\n ",
"xmlname": "attachmentSet"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the Internet gateway.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n\t\t <p>Describes an Internet gateway.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Information about one or more Internet gateways.</p>\n ",
"xmlname": "internetGatewaySet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Describes one or more of your Internet gateways.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes all your Internet gateways.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeInternetGateways\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeInternetGatewaysResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <internetGatewaySet> \n <item>\n <internetGatewayId>igw-eaad4883EXAMPLE</internetGatewayId>\n <attachmentSet>\n <item>\n <vpcId>vpc-11ad4878</vpcId>\n <state>available</state>\n </item>\n </attachmentSet>\n <tagSet/>\n </item>\n </internetGatewaySet>\n</DescribeInternetGatewaysResponse></queryresponse>\n </example>\n </examples>\n "
},
"DescribeKeyPairs": {
"name": "DescribeKeyPairs",
"input": {
"shape_name": "DescribeKeyPairsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"KeyNames": {
"shape_name": "KeyNameStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "KeyName"
},
"documentation": "\n <p>One or more key pair names.</p>\n <p>Default: Describes all your key pairs.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>fingerprint</code> - The fingerprint of the key pair.</p>\n </li>\n <li>\n <p><code>key-name</code> - The name of the key pair.</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeKeyPairsResult",
"type": "structure",
"members": {
"KeyPairs": {
"shape_name": "KeyPairList",
"type": "list",
"members": {
"shape_name": "KeyPairInfo",
"type": "structure",
"members": {
"KeyName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the key pair.</p>\n ",
"xmlname": "keyName"
},
"KeyFingerprint": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>If you used <a>CreateKeyPair</a> to create the key pair, this is the SHA-1 digest of the DER encoded private key. \n If you used <a>ImportKeyPair</a> to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.</p>\n ",
"xmlname": "keyFingerprint"
}
},
"documentation": "\n <p>Describes a key pair.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about one or more key pairs.</p>\n ",
"xmlname": "keySet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes one or more of your key pairs.</p>\n <p>For more information about key pairs, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Key Pairs</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes the keypair with name my-key-pair.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeKeyPairs\n&amp;KeyName.1=my-key-pair\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeKeyPairsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <keySet>\n <item>\n <keyName>my-key-pair</keyName>\n <keyFingerprint>1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f</keyFingerprint>\n </item>\n </keySet>\n</DescribeKeyPairsResponse></queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example filters the response to include only key pairs whose names include the string <code>Dave</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeKeyPairs\n&amp;Filter.1.Name=key-name\n&amp;Filter.1.Value.1=*Dave*\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DescribeNetworkAcls": {
"name": "DescribeNetworkAcls",
"input": {
"shape_name": "DescribeNetworkAclsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"NetworkAclIds": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "NetworkAclId"
},
"documentation": "\n\t\t <p>One or more network ACL IDs.</p>\n\t\t <p>Default: Describes all your network ACLs.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>association.association-id</code> - The ID of an association ID for the ACL.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.network-acl-id</code> - The ID of the network ACL involved in the association.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.subnet-id</code> - The ID of the subnet involved in the association.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>default</code> - Indicates whether the ACL is the default network ACL for the VPC.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>entry.cidr</code> - The CIDR range specified in the entry.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>entry.egress</code> - Indicates whether the entry applies to egress traffic.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>entry.icmp.code</code> - The ICMP code specified in the entry, if any.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>entry.icmp.type</code> - The ICMP type specified in the entry, if any.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>entry.port-range.from</code> - The start of the port range specified in the entry. </p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>entry.port-range.to</code> - The end of the port range specified in the entry. </p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>entry.protocol</code> - The protocol specified in the entry (<code>tcp</code> | <code>udp</code> | <code>icmp</code> or a protocol number).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>entry.rule-action</code> - Allows or denies the matching traffic (<code>allow</code> | <code>deny</code>).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>entry.rule-number</code> - The number of an entry (in other words, rule) in the ACL's set of entries.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>network-acl-id</code> - The ID of the network ACL.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>vpc-id</code> - The ID of the VPC for the network ACL.</p>\n\t\t </li>\n\t\t </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeNetworkAclsResult",
"type": "structure",
"members": {
"NetworkAcls": {
"shape_name": "NetworkAclList",
"type": "list",
"members": {
"shape_name": "NetworkAcl",
"type": "structure",
"members": {
"NetworkAclId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network ACL.</p>\n ",
"xmlname": "networkAclId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC for the network ACL.</p>\n ",
"xmlname": "vpcId"
},
"IsDefault": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether this is the default network ACL for the VPC.</p>\n ",
"xmlname": "default"
},
"Entries": {
"shape_name": "NetworkAclEntryList",
"type": "list",
"members": {
"shape_name": "NetworkAclEntry",
"type": "structure",
"members": {
"RuleNumber": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The rule number for the entry. ACL entries are processed in ascending order by rule number.</p>\n ",
"xmlname": "ruleNumber"
},
"Protocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The protocol. A value of <code>-1</code> means all protocols.</p>\n ",
"xmlname": "protocol"
},
"RuleAction": {
"shape_name": "RuleAction",
"type": "string",
"enum": [
"allow",
"deny"
],
"documentation": "\n\t\t <p>Indicates whether to allow or deny the traffic that matches the rule.</p>\n ",
"xmlname": "ruleAction"
},
"Egress": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).</p>\n ",
"xmlname": "egress"
},
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The network range to allow or deny, in CIDR notation.</p>\n ",
"xmlname": "cidrBlock"
},
"IcmpTypeCode": {
"shape_name": "IcmpTypeCode",
"type": "structure",
"members": {
"Type": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The ICMP code. A value of -1 means all codes for the specified ICMP type.</p>\n ",
"xmlname": "type"
},
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The ICMP type. A value of -1 means all types.</p>\n ",
"xmlname": "code"
}
},
"documentation": "\n\t\t <p>ICMP protocol: The ICMP type and code.</p>\n ",
"xmlname": "icmpTypeCode"
},
"PortRange": {
"shape_name": "PortRange",
"type": "structure",
"members": {
"From": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The first port in the range.</p>\n ",
"xmlname": "from"
},
"To": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The last port in the range.</p>\n ",
"xmlname": "to"
}
},
"documentation": "\n\t\t <p>TCP or UDP protocols: The range of ports the rule applies to.</p>\n ",
"xmlname": "portRange"
}
},
"documentation": "\n\t\t <p>Describes an entry in a network ACL.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more entries (rules) in the network ACL.</p>\n ",
"xmlname": "entrySet"
},
"Associations": {
"shape_name": "NetworkAclAssociationList",
"type": "list",
"members": {
"shape_name": "NetworkAclAssociation",
"type": "structure",
"members": {
"NetworkAclAssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the association between a network ACL and a subnet.</p>\n ",
"xmlname": "networkAclAssociationId"
},
"NetworkAclId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network ACL.</p>\n ",
"xmlname": "networkAclId"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet.</p>\n ",
"xmlname": "subnetId"
}
},
"documentation": "\n\t\t <p>Describes an association between a network ACL and a subnet.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any associations between the network ACL and one or more subnets</p>\n ",
"xmlname": "associationSet"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the network ACL.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n\t\t <p>Describes a network ACL.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Information about one or more network ACLs.</p>\n ",
"xmlname": "networkAclSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Describes one or more of your network ACLs.</p>\n\t\t <p>For more information about network ACLs, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html\">Network ACLs</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes all your network ACLs.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeNetworkAcls\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeNetworkAclsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <networkAclSet>\n <item>\n <networkAclId>acl-5566953c</networkAclId>\n <vpcId>vpc-5266953b</vpcId>\n <default>true</default>\n <entrySet>\n <item>\n <ruleNumber>100</ruleNumber>\n <protocol>all</protocol>\n <ruleAction>allow</ruleAction>\n <egress>true</egress>\n <cidrBlock>0.0.0.0/0</cidrBlock>\n </item>\n <item>\n <ruleNumber>32767</ruleNumber>\n <protocol>all</protocol>\n <ruleAction>deny</ruleAction>\n <egress>true</egress>\n <cidrBlock>0.0.0.0/0</cidrBlock>\n </item>\n <item>\n <ruleNumber>100</ruleNumber>\n <protocol>all</protocol>\n <ruleAction>allow</ruleAction>\n <egress>false</egress>\n <cidrBlock>0.0.0.0/0</cidrBlock>\n </item>\n <item>\n <ruleNumber>32767</ruleNumber>\n <protocol>all</protocol>\n <ruleAction>deny</ruleAction>\n <egress>false</egress>\n <cidrBlock>0.0.0.0/0</cidrBlock>\n </item>\n </entrySet>\n <associationSet/>\n <tagSet/>\n </item>\n <item>\n <networkAclId>acl-5d659634</networkAclId>\n <vpcId>vpc-5266953b</vpcId>\n <default>false</default>\n <entrySet>\n <item>\n <ruleNumber>110</ruleNumber>\n <protocol>6</protocol>\n <ruleAction>allow</ruleAction>\n <egress>true</egress>\n <cidrBlock>0.0.0.0/0</cidrBlock>\n <portRange>\n <from>49152</from>\n <to>65535</to>\n </portRange>\n </item>\n <item>\n <ruleNumber>32767</ruleNumber>\n <protocol>all</protocol>\n <ruleAction>deny</ruleAction>\n <egress>true</egress>\n <cidrBlock>0.0.0.0/0</cidrBlock>\n </item>\n <item>\n <ruleNumber>110</ruleNumber>\n <protocol>6</protocol>\n <ruleAction>allow</ruleAction>\n <egress>false</egress>\n <cidrBlock>0.0.0.0/0</cidrBlock>\n <portRange>\n <from>80</from>\n <to>80</to>\n </portRange>\n </item>\n <item>\n <ruleNumber>120</ruleNumber>\n <protocol>6</protocol>\n <ruleAction>allow</ruleAction>\n <egress>false</egress>\n <cidrBlock>0.0.0.0/0</cidrBlock>\n <portRange>\n <from>443</from>\n <to>443</to>\n </portRange>\n </item>\n <item>\n <ruleNumber>32767</ruleNumber>\n <protocol>all</protocol>\n <ruleAction>deny</ruleAction>\n <egress>false</egress>\n <cidrBlock>0.0.0.0/0</cidrBlock>\n </item>\n </entrySet>\n <associationSet>\n <item>\n <networkAclAssociationId>aclassoc-5c659635</networkAclAssociationId>\n <networkAclId>acl-5d659634</networkAclId>\n <subnetId>subnet-ff669596</subnetId>\n </item>\n <item>\n <networkAclAssociationId>aclassoc-c26596ab</networkAclAssociationId>\n <networkAclId>acl-5d659634</networkAclId>\n <subnetId>subnet-f0669599</subnetId>\n </item>\n </associationSet>\n <tagSet/>\n </item>\n </networkAclSet>\n</DescribeNetworkAclsResponse></queryresponse>\n </example>\n </examples>\n "
},
"DescribeNetworkInterfaceAttribute": {
"name": "DescribeNetworkInterfaceAttribute",
"input": {
"shape_name": "DescribeNetworkInterfaceAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"required": true
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The <code>description</code> attribute.</p>\n "
},
"SourceDestCheck": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The <code>sourceDestCheck</code> attribute.</p>\n "
},
"Groups": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The <code>groupSet</code> attribute.</p>\n ",
"xmlname": "GroupSet"
},
"Attachment": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The <code>attachment</code> attribute.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeNetworkInterfaceAttributeResult",
"type": "structure",
"members": {
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"xmlname": "networkInterfaceId"
},
"Description": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n\t\t <p>The description of the network interface.</p>\n ",
"xmlname": "description"
},
"SourceDestCheck": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n\t\t <p>Indicates whether source/destination checking is enabled.</p>\n ",
"xmlname": "sourceDestCheck"
},
"Groups": {
"shape_name": "GroupIdentifierList",
"type": "list",
"members": {
"shape_name": "GroupIdentifier",
"type": "structure",
"members": {
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>The security groups associated with the network interface.</p>\n ",
"xmlname": "groupSet"
},
"Attachment": {
"shape_name": "NetworkInterfaceAttachment",
"type": "structure",
"members": {
"AttachmentId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface attachment.</p>\n ",
"xmlname": "attachmentId"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"InstanceOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The AWS account ID of the owner of the instance.</p>\n ",
"xmlname": "instanceOwnerId"
},
"DeviceIndex": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The device index of the network interface attachment on the instance.</p>\n ",
"xmlname": "deviceIndex"
},
"Status": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n\t\t <p>The attachment state.</p>\n ",
"xmlname": "status"
},
"AttachTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n\t\t <p>The timestamp indicating when the attachment initiated.</p>\n ",
"xmlname": "attachTime"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the network interface is deleted when the instance is terminated.</p>\n ",
"xmlname": "deleteOnTermination"
}
},
"documentation": "\n\t\t <p>The attachment (if any) of the network interface.</p>\n ",
"xmlname": "attachment"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Describes a network interface attribute. You can specify only one attribute at a\n\t\t\t\ttime.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes the <code>sourceDestCheck</code> attribute of the specified network interface.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeNetworkInterfaceAttribute\n&amp;NetworkInterfaceId=eni-686ea200\n&amp;Attribute=sourceDestCheck\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeNetworkInterfaceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a20c6b2-d71c-45fb-bba7-37306850544b&lt;/requestId&gt;\n &lt;networkInterfaceId&gt;eni-686ea200&lt;/networkInterfaceId&gt;\n &lt;sourceDestCheck&gt;\n &lt;value&gt;true&lt;/value&gt;\n &lt;/sourceDestCheck&gt;\n&lt;/DescribeNetworkInterfaceAttributeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DescribeNetworkInterfaces": {
"name": "DescribeNetworkInterfaces",
"input": {
"shape_name": "DescribeNetworkInterfacesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"NetworkInterfaceIds": {
"shape_name": "NetworkInterfaceIdList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "NetworkInterfaceId"
},
"documentation": "\n\t\t <p>One or more network interface IDs.</p>\n\t\t <p>Default: Describes all your network interfaces.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>addresses.private-ip-address</code> - The private IP addresses associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>addresses.primary</code> - Whether the private IP address is the primary IP address associated with the network interface. </p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>addresses.association.public-ip</code> - The association ID returned when the network interface was associated with the Elastic IP address.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>addresses.association.owner-id</code> - The owner ID of the addresses associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.association-id</code> - The association ID returned when the network interface was associated with an IP address.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.allocation-id</code> - The allocation ID returned when you allocated the Elastic IP address for your network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.ip-owner-id</code> - The owner of the Elastic IP address associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.public-ip</code> - The address of the Elastic IP address bound to the network interface.</p>\n\t\t </li>\n\t\t \t<li>\n\t\t \t\t <p><code>association.public-dns-name</code> - The public DNS name for the network interface.</p>\n\t\t \t</li>\n\t\t <li>\n\t\t <p><code>attachment.attachment-id</code> - The ID of the interface attachment.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.instance-id</code> - The ID of the instance to which the network interface is attached.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.instance-owner-id</code> - The owner ID of the instance to which the network interface is attached.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.device-index</code> - The device index to which the network interface is attached.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.status</code> - The status of the attachment (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.attach.time</code> - The time that the network interface was attached to an instance.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.delete-on-termination</code> - Indicates whether the attachment is deleted when an instance is terminated.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>availability-zone</code> - The Availability Zone of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>description</code> - The description of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>group-id</code> - The ID of a security group associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>group-name</code> - The name of a security group associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>mac-address</code> - The MAC address of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>network-interface-id</code> - The ID of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>owner-id</code> - The AWS account ID of the network interface owner.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>private-ip-address</code> - The private IP address or addresses of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>private-dns-name</code> - The private DNS name of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>requester-id</code> - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>requester-managed</code> - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>source-desk-check</code> - Indicates whether the network interface performs source/destination checking. \n\t\t A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. \n\t\t The value must be <code>false</code> for the network interface to perform Network Address Translation (NAT) in your VPC. </p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>status</code> - The status of the network interface. If the network interface is not attached to an instance, the status is <code>available</code>; \n\t\t if a network interface is attached to an instance the status is <code>in-use</code>.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>subnet-id</code> - The ID of the subnet for the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>vpc-id</code> - The ID of the VPC for the network interface.</p>\n\t\t </li>\n\t\t </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeNetworkInterfacesResult",
"type": "structure",
"members": {
"NetworkInterfaces": {
"shape_name": "NetworkInterfaceList",
"type": "list",
"members": {
"shape_name": "NetworkInterface",
"type": "structure",
"members": {
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"xmlname": "networkInterfaceId"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet.</p>\n ",
"xmlname": "subnetId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Availability Zone.</p>\n ",
"xmlname": "availabilityZone"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>A description.</p>\n ",
"xmlname": "description"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The AWS account ID of the owner of the network interface.</p>\n ",
"xmlname": "ownerId"
},
"RequesterId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the entity that launched the instance on your behalf (for example, AWS\n\t\t\t\tManagement Console or Auto Scaling).</p>\n ",
"xmlname": "requesterId"
},
"RequesterManaged": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the network interface is being managed by AWS.</p>\n ",
"xmlname": "requesterManaged"
},
"Status": {
"shape_name": "NetworkInterfaceStatus",
"type": "string",
"enum": [
"available",
"attaching",
"in-use",
"detaching"
],
"documentation": "\n\t\t <p>The status of the network interface.</p>\n ",
"xmlname": "status"
},
"MacAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The MAC address.</p>\n ",
"xmlname": "macAddress"
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The IP address of the network interface within the subnet.</p>\n ",
"xmlname": "privateIpAddress"
},
"PrivateDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private DNS name.</p>\n ",
"xmlname": "privateDnsName"
},
"SourceDestCheck": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether traffic to or from the instance is validated.</p>\n ",
"xmlname": "sourceDestCheck"
},
"Groups": {
"shape_name": "GroupIdentifierList",
"type": "list",
"members": {
"shape_name": "GroupIdentifier",
"type": "structure",
"members": {
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any security groups for the network interface.</p>\n ",
"xmlname": "groupSet"
},
"Attachment": {
"shape_name": "NetworkInterfaceAttachment",
"type": "structure",
"members": {
"AttachmentId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface attachment.</p>\n ",
"xmlname": "attachmentId"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"InstanceOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The AWS account ID of the owner of the instance.</p>\n ",
"xmlname": "instanceOwnerId"
},
"DeviceIndex": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The device index of the network interface attachment on the instance.</p>\n ",
"xmlname": "deviceIndex"
},
"Status": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n\t\t <p>The attachment state.</p>\n ",
"xmlname": "status"
},
"AttachTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n\t\t <p>The timestamp indicating when the attachment initiated.</p>\n ",
"xmlname": "attachTime"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the network interface is deleted when the instance is terminated.</p>\n ",
"xmlname": "deleteOnTermination"
}
},
"documentation": "\n\t\t <p>The network interface attachment.</p>\n ",
"xmlname": "attachment"
},
"Association": {
"shape_name": "NetworkInterfaceAssociation",
"type": "structure",
"members": {
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The address of the Elastic IP address bound to the network interface.</p>\n ",
"xmlname": "publicIp"
},
"PublicDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t<p>The public DNS name.</p>\n\t",
"xmlname": "publicDnsName"
},
"IpOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the Elastic IP address owner.</p>\n ",
"xmlname": "ipOwnerId"
},
"AllocationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The allocation ID.</p>\n ",
"xmlname": "allocationId"
},
"AssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The association ID.</p>\n ",
"xmlname": "associationId"
}
},
"documentation": "\n\t\t <p>The association information for an Elastic IP associated with the network interface.</p>\n ",
"xmlname": "association"
},
"TagSet": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the network interface.</p>\n ",
"xmlname": "tagSet"
},
"PrivateIpAddresses": {
"shape_name": "NetworkInterfacePrivateIpAddressList",
"type": "list",
"members": {
"shape_name": "NetworkInterfacePrivateIpAddress",
"type": "structure",
"members": {
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP address.</p>\n ",
"xmlname": "privateIpAddress"
},
"PrivateDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private DNS name.</p>\n ",
"xmlname": "privateDnsName"
},
"Primary": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether this IP address is the primary private IP address of the network interface.</p>\n ",
"xmlname": "primary"
},
"Association": {
"shape_name": "NetworkInterfaceAssociation",
"type": "structure",
"members": {
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The address of the Elastic IP address bound to the network interface.</p>\n ",
"xmlname": "publicIp"
},
"PublicDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t<p>The public DNS name.</p>\n\t",
"xmlname": "publicDnsName"
},
"IpOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the Elastic IP address owner.</p>\n ",
"xmlname": "ipOwnerId"
},
"AllocationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The allocation ID.</p>\n ",
"xmlname": "allocationId"
},
"AssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The association ID.</p>\n ",
"xmlname": "associationId"
}
},
"documentation": "\n\t\t <p>The association information for an Elastic IP address associated with the network interface.</p>\n ",
"xmlname": "association"
}
},
"documentation": "\n\t\t <p>Describes the private IP address of a network interface.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>The private IP addresses associated with the network interface.</p>\n ",
"xmlname": "privateIpAddressesSet"
}
},
"documentation": "\n\t\t <p>Describes a network interface.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Information about one or more network interfaces.</p>\n ",
"xmlname": "networkInterfaceSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Describes one or more of your network interfaces.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes all your network interfaces.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeNetworkInterfaces\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeNetworkInterfacesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;fc45294c-006b-457b-bab9-012f5b3b0e40&lt;/requestId&gt;\n &lt;networkInterfaceSet&gt;\n &lt;item&gt;\n &lt;networkInterfaceId&gt;eni-0f62d866&lt;/networkInterfaceId&gt;\n &lt;subnetId&gt;subnet-c53c87ac&lt;/subnetId&gt;\n &lt;vpcId&gt;vpc-cc3c87a5&lt;/vpcId&gt;\n &lt;availabilityZone&gt;api-southeast-1b&lt;/availabilityZone&gt;\n &lt;description/&gt;\n &lt;ownerId&gt;053230519467&lt;/ownerId&gt;\n &lt;requesterManaged&gt;false&lt;/requesterManaged&gt;\n &lt;status&gt;in-use&lt;/status&gt;\n &lt;macAddress&gt;02:81:60:cb:27:37&lt;/macAddress&gt;\n &lt;privateIpAddress&gt;10.0.0.146&lt;/privateIpAddress&gt;\n &lt;sourceDestCheck&gt;true&lt;/sourceDestCheck&gt;\n &lt;groupSet&gt;\n &lt;item&gt;\n &lt;groupId&gt;sg-3f4b5653&lt;/groupId&gt;\n &lt;groupName&gt;default&lt;/groupName&gt;\n &lt;/item&gt;\n &lt;/groupSet&gt;\n &lt;attachment&gt;\n &lt;attachmentId&gt;eni-attach-6537fc0c&lt;/attachmentId&gt;\n &lt;instanceId&gt;i-22197876&lt;/instanceId&gt;\n &lt;instanceOwnerId&gt;053230519467&lt;/instanceOwnerId&gt;\n &lt;deviceIndex&gt;0&lt;/deviceIndex&gt;\n &lt;status&gt;attached&lt;/status&gt;\n &lt;attachTime&gt;2012-07-01T21:45:27.000Z&lt;/attachTime&gt;\n &lt;deleteOnTermination&gt;true&lt;/deleteOnTermination&gt;\n &lt;/attachment&gt;\n &lt;tagSet/&gt;\n &lt;privateIpAddressesSet&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.0.146&lt;/privateIpAddress&gt;\n &lt;primary&gt;true&lt;/primary&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.0.148&lt;/privateIpAddress&gt;\n &lt;primary&gt;false&lt;/primary&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.0.150&lt;/privateIpAddress&gt;\n &lt;primary&gt;false&lt;/primary&gt;\n &lt;/item&gt;\n &lt;/privateIpAddressesSet&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;networkInterfaceId&gt;eni-a66ed5cf&lt;/networkInterfaceId&gt;\n &lt;subnetId&gt;subnet-cd8a35a4&lt;/subnetId&gt;\n &lt;vpcId&gt;vpc-f28a359b&lt;/vpcId&gt;\n &lt;availabilityZone&gt;ap-southeast-1b&lt;/availabilityZone&gt;\n &lt;description&gt;Primary network interface&lt;/description&gt;\n &lt;ownerId&gt;053230519467&lt;/ownerId&gt;\n &lt;requesterManaged&gt;false&lt;/requesterManaged&gt;\n &lt;status&gt;in-use&lt;/status&gt;\n &lt;macAddress&gt;02:78:d7:00:8a:1e&lt;/macAddress&gt;\n &lt;privateIpAddress&gt;10.0.1.233&lt;/privateIpAddress&gt;\n &lt;sourceDestCheck&gt;true&lt;/sourceDestCheck&gt;\n &lt;groupSet&gt;\n &lt;item&gt;\n &lt;groupId&gt;sg-a2a0b2ce&lt;/groupId&gt;\n &lt;groupName&gt;quick-start-1&lt;/groupName&gt;\n &lt;/item&gt;\n &lt;/groupSet&gt;\n &lt;attachment&gt;\n &lt;attachmentId&gt;eni-attach-a99c57c0&lt;/attachmentId&gt;\n &lt;instanceId&gt;i-886401dc&lt;/instanceId&gt;\n &lt;instanceOwnerId&gt;053230519467&lt;/instanceOwnerId&gt;\n &lt;deviceIndex&gt;0&lt;/deviceIndex&gt;\n &lt;status&gt;attached&lt;/status&gt;\n &lt;attachTime&gt;2012-06-27T20:08:44.000Z&lt;/attachTime&gt;\n &lt;deleteOnTermination&gt;true&lt;/deleteOnTermination&gt;\n &lt;/attachment&gt;\n &lt;tagSet/&gt;\n &lt;privateIpAddressesSet&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.1.233&lt;/privateIpAddress&gt;\n &lt;primary&gt;true&lt;/primary&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;privateIpAddress&gt;10.0.1.20&lt;/privateIpAddress&gt;\n &lt;primary&gt;false&lt;/primary&gt;\n &lt;/item&gt;\n &lt;/privateIpAddressesSet&gt;\n &lt;/item&gt;\n &lt;/networkInterfaceSet&gt;\n&lt;/DescribeNetworkInterfacesResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DescribePlacementGroups": {
"name": "DescribePlacementGroups",
"input": {
"shape_name": "DescribePlacementGroupsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"GroupNames": {
"shape_name": "PlacementGroupStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "GroupName"
},
"documentation": "\n <p>One or more placement group names.</p>\n <p>Default: Describes all your placement groups, or only those otherwise specified.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>group-name</code> - The name of the placement group.</p>\n </li>\n <li>\n <p><code>state</code> - The state of the placement group (<code>pending</code> | <code>available</code> |\n <code>deleting</code> | <code>deleted</code>).</p>\n </li>\n <li>\n <p><code>strategy</code> - The strategy of the placement group (<code>cluster</code>).</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribePlacementGroupsResult",
"type": "structure",
"members": {
"PlacementGroups": {
"shape_name": "PlacementGroupList",
"type": "list",
"members": {
"shape_name": "PlacementGroup",
"type": "structure",
"members": {
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the placement group.</p>\n ",
"xmlname": "groupName"
},
"Strategy": {
"shape_name": "PlacementStrategy",
"type": "string",
"enum": [
"cluster"
],
"documentation": "\n <p>The placement strategy.</p>\n ",
"xmlname": "strategy"
},
"State": {
"shape_name": "PlacementGroupState",
"type": "string",
"enum": [
"pending",
"available",
"deleting",
"deleted"
],
"documentation": "\n <p>The state of the placement group.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n <p>Describes a placement group.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more placement groups.</p>\n ",
"xmlname": "placementGroupSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes one or more of your placement groups. For more information about\n\t\t\t\tplacement groups and cluster instances, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cluster_computing.html\">Cluster Instances</a>\n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes the placement group named XYZ-cluster.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribePlacementGroups\n&amp;GroupName.1=XYZ-cluster\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribePlacementGroupsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestID>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestID>\n <placementGroupSet>\n <item>\n <groupName>XYZ-cluster</groupName>\n <strategy>cluster</strategy>\n <state>available</state>\n </item>\n </placementGroupSet>\n</DescribePlacementGroupsResponse></queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example filters the response to include only placement groups that\n include the string <code>Project</code> in the name.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribePlacementGroups\n&amp;Filter.1.Name=group-name\n&amp;Filter.1.Value=*Project*\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribePlacementGroupsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestID>d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE</requestID>\n <placementGroupSet>\n <item>\n <groupName>Project-cluster</groupName>\n <strategy>cluster</strategy>\n <state>available</state>\n </item>\n </placementGroupSet>\n</DescribePlacementGroupsResponse></queryresponse>\n </example>\n </examples>\n "
},
"DescribeRegions": {
"name": "DescribeRegions",
"input": {
"shape_name": "DescribeRegionsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"RegionNames": {
"shape_name": "RegionNameStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "RegionName"
},
"documentation": "\n <p>The names of one or more regions.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>endpoint</code> - The endpoint of the region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p>\n </li>\n <li>\n <p><code>region-name</code> - The name of the region (for example, <code>us-east-1</code>).</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeRegionsResult",
"type": "structure",
"members": {
"Regions": {
"shape_name": "RegionList",
"type": "list",
"members": {
"shape_name": "Region",
"type": "structure",
"members": {
"RegionName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the region.</p>\n ",
"xmlname": "regionName"
},
"Endpoint": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The region service endpoint.</p>\n ",
"xmlname": "regionEndpoint"
}
},
"documentation": "\n <p>Describes a region.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about one or more regions.</p>\n ",
"xmlname": "regionInfo"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": " \n <p>Describes one or more regions that are currently available to you.</p>\n <p>For a list of the regions supported by Amazon EC2, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region\">Regions and Endpoints</a>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example displays information about all regions.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeRegions\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example displays information about the specified regions only.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeRegions\n&amp;RegionName.1=us-east-1\n&amp;RegionName.2=eu-west-1\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeRegionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <regionInfo>\n <item>\n <regionName>us-east-1</regionName>\n <regionEndpoint>ec2.us-east-1.amazonaws.com</regionEndpoint>\n </item>\n <item>\n <regionName>eu-west-1</regionName>\n <regionEndpoint>ec2.eu-west-1amazonaws.com</regionEndpoint>\n </item>\n </regionInfo>\n</DescribeRegionsResponse></queryresponse>\n </example>\n </examples>\n "
},
"DescribeReservedInstances": {
"name": "DescribeReservedInstances",
"input": {
"shape_name": "DescribeReservedInstancesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ReservedInstancesIds": {
"shape_name": "ReservedInstancesIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ReservedInstancesId"
},
"documentation": "\n <p>One or more Reserved Instance IDs.</p>\n <p>Default: Describes all your Reserved Instances, or only those otherwise specified.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used.</p>\n </li>\n <li>\n <p><code>duration</code> - The duration of the Reserved Instance (one year or three years), in seconds (<code>31536000</code> | <code>94608000</code>).</p>\n </li>\n <li>\n <p><code>end</code> - The time when the Reserved Instance expires.</p>\n </li>\n <li>\n <p><code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0).</p>\n </li>\n <li>\n <p><code>instance-type</code> - The instance type on which the Reserved Instance can be used.</p>\n </li>\n <li>\n <p><code>product-description</code> - The product description of the Reserved Instance (<code>Linux/UNIX</code> | <code>Linux/UNIX (Amazon VPC)</code> |\n <code>Windows</code> | <code>Windows (Amazon VPC)</code>).</p>\n </li>\n <li>\n <p><code>reserved-instances-id</code> - The ID of the Reserved Instance.</p>\n </li>\n <li>\n <p><code>start</code> - The time at which the Reserved Instance purchase request was placed.</p>\n </li>\n <li>\n <p><code>state</code> - The state of the Reserved Instance (<code>pending-payment</code> | <code>active</code> | <code>payment-failed</code> | <code>retired</code>).</p>\n </li>\n <li>\n <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n </li>\n <li>\n <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n </li>\n <li>\n <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n </li>\n <li>\n <p><code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84).</p>\n </li>\n </ul>\n ",
"flattened": true
},
"OfferingType": {
"shape_name": "OfferingTypeValues",
"type": "string",
"enum": [
"Heavy Utilization",
"Medium Utilization",
"Light Utilization"
],
"documentation": "\n <p>The Reserved Instance offering type.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeReservedInstancesResult",
"type": "structure",
"members": {
"ReservedInstances": {
"shape_name": "ReservedInstancesList",
"type": "list",
"members": {
"shape_name": "ReservedInstances",
"type": "structure",
"members": {
"ReservedInstancesId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Reserved Instance.</p>\n ",
"xmlname": "reservedInstancesId"
},
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type on which the Reserved Instance can be used.</p>\n ",
"xmlname": "instanceType"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone in which the Reserved Instance can be used.</p>\n ",
"xmlname": "availabilityZone"
},
"Start": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The date and time the Reserved Instance started.</p>\n ",
"xmlname": "start"
},
"End": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time when the Reserved Instance expires.</p>\n ",
"xmlname": "end"
},
"Duration": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The duration of the Reserved Instance, in seconds.</p>\n ",
"xmlname": "duration"
},
"UsagePrice": {
"shape_name": "Float",
"type": "float",
"documentation": "\n <p>The usage price of the Reserved Instance, per hour.</p>\n ",
"xmlname": "usagePrice"
},
"FixedPrice": {
"shape_name": "Float",
"type": "float",
"documentation": "\n <p>The purchase price of the Reserved Instance.</p>\n ",
"xmlname": "fixedPrice"
},
"InstanceCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of Reserved Instances purchased.</p>\n ",
"xmlname": "instanceCount"
},
"ProductDescription": {
"shape_name": "RIProductDescription",
"type": "string",
"enum": [
"Linux/UNIX",
"Linux/UNIX (Amazon VPC)",
"Windows",
"Windows (Amazon VPC)"
],
"documentation": "\n <p>The Reserved Instance description.</p>\n ",
"xmlname": "productDescription"
},
"State": {
"shape_name": "ReservedInstanceState",
"type": "string",
"enum": [
"payment-pending",
"active",
"payment-failed",
"retired"
],
"documentation": "\n <p>The state of the Reserved Instance purchase.</p>\n ",
"xmlname": "state"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the resource.</p>\n ",
"xmlname": "tagSet"
},
"InstanceTenancy": {
"shape_name": "Tenancy",
"type": "string",
"enum": [
"default",
"dedicated"
],
"documentation": "\n <p>The tenancy of the reserved instance.</p>\n ",
"xmlname": "instanceTenancy"
},
"CurrencyCode": {
"shape_name": "CurrencyCodeValues",
"type": "string",
"enum": [
"USD"
],
"documentation": "\n <p>The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.\n\t\t\t\tAt this time, the only supported currency is <code>USD</code>.</p>\n ",
"xmlname": "currencyCode"
},
"OfferingType": {
"shape_name": "OfferingTypeValues",
"type": "string",
"enum": [
"Heavy Utilization",
"Medium Utilization",
"Light Utilization"
],
"documentation": "\n <p>The Reserved Instance offering type.</p>\n ",
"xmlname": "offeringType"
},
"RecurringCharges": {
"shape_name": "RecurringChargesList",
"type": "list",
"members": {
"shape_name": "RecurringCharge",
"type": "structure",
"members": {
"Frequency": {
"shape_name": "RecurringChargeFrequency",
"type": "string",
"enum": [
"Hourly"
],
"documentation": "\n <p>The frequency of the recurring charge.</p>\n ",
"xmlname": "frequency"
},
"Amount": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>The amount of the recurring charge.</p>\n ",
"xmlname": "amount"
}
},
"documentation": "\n <p>Describes a recurring charge.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The recurring charge tag assigned to the resource.</p>\n ",
"xmlname": "recurringCharges"
}
},
"documentation": "\n <p>Describes a Reserved Instance.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>A list of Reserved Instances.</p>\n ",
"xmlname": "reservedInstancesSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes one or more of the Reserved Instances that you purchased.</p>\n <p>For more information about Reserved Instances, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html\">Reserved\n\t\t\t\tInstances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes Reserved Instances owned by your account.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeReservedInstances\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeReservedInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <reservedInstancesSet>\n ...\n <item>\n <reservedInstancesId>e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE</reservedInstancesId>\n <instanceType>m1.xlarge</instanceType>\n <availabilityZone>us-east-1b</availabilityZone>\n <duration>31536000</duration>\n <fixedPrice>61.0</fixedPrice>\n <usagePrice>0.034</usagePrice>\n <instanceCount>3</instanceCount>\n <productDescription>Linux/UNIX</productDescription>\n <state>active</state> \n <instanceTenancy>default</instanceTenancy>\n <currencyCode>USD</currencyCode>\n <offeringType>Light Utilization</offeringType>\n <recurringCharges/>\n </item>\n ...\n </reservedInstancesSet> \n</DescribeReservedInstancesResponse></queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example filters the response to include only one-year, <code>m1.small</code> Linux/UNIX Reserved Instances. \n If you want Linux/UNIX Reserved Instances specifically for use with a VPC, set the product description to \n <code>Linux/UNIX (Amazon VPC)</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeReservedInstances\n&amp;Filter.1.Name=duration\n&amp;Filter.1.Value.1=31536000\n&amp;Filter.2.Name=instance-type\n&amp;Filter.2.Value.1=m1.small\n&amp;Filter.3.Name=product-description\n&amp;Filter.3.Value.1=Linux%2FUNIX\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DescribeReservedInstancesListings": {
"name": "DescribeReservedInstancesListings",
"input": {
"shape_name": "DescribeReservedInstancesListingsRequest",
"type": "structure",
"members": {
"ReservedInstancesId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>One or more Reserved Instance IDs.</p>\n "
},
"ReservedInstancesListingId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>One or more Reserved Instance Listing IDs.</p>\n "
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>reserved-instances-id</code> - The ID of the Reserved Instances.</p>\n </li>\n <li>\n <p><code>reserved-instances-listing-id</code> - The ID of the Reserved Instances listing.</p>\n </li>\n <li>\n <p><code>status</code> - The status of the Reserved Instance listing (<code>pending</code> | <code>active</code> |\n <code>cancelled</code> | <code>closed</code>).</p>\n </li>\n <li>\n <p><code>status-message</code> - The reason for the status.</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeReservedInstancesListingsResult",
"type": "structure",
"members": {
"ReservedInstancesListings": {
"shape_name": "ReservedInstancesListingList",
"type": "list",
"members": {
"shape_name": "ReservedInstancesListing",
"type": "structure",
"members": {
"ReservedInstancesListingId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Reserved Instance listing.</p>\n ",
"xmlname": "reservedInstancesListingId"
},
"ReservedInstancesId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Reserved Instance.</p>\n ",
"xmlname": "reservedInstancesId"
},
"CreateDate": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time the listing was created.</p>\n ",
"xmlname": "createDate"
},
"UpdateDate": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The last modified timestamp of the listing.</p>\n ",
"xmlname": "updateDate"
},
"Status": {
"shape_name": "ListingStatus",
"type": "string",
"enum": [
"active",
"pending",
"cancelled",
"closed"
],
"documentation": "\n <p>The status of the Reserved Instance listing.</p>\n ",
"xmlname": "status"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason for the current status of the Reserved Instance listing. \n\t\t\t\tThe response can be blank.</p>\n ",
"xmlname": "statusMessage"
},
"InstanceCounts": {
"shape_name": "InstanceCountList",
"type": "list",
"members": {
"shape_name": "InstanceCount",
"type": "structure",
"members": {
"State": {
"shape_name": "ListingState",
"type": "string",
"enum": [
"available",
"sold",
"cancelled",
"pending"
],
"documentation": "\n <p>The states of the listed Reserved Instances.</p>\n ",
"xmlname": "state"
},
"InstanceCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>he number of listed Reserved Instances in the state specified by the <code>state</code>.</p>\n ",
"xmlname": "instanceCount"
}
},
"documentation": "\n <p>Describes a Reserved Instance listing state.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The number of instances in this state.</p>\n ",
"xmlname": "instanceCounts"
},
"PriceSchedules": {
"shape_name": "PriceScheduleList",
"type": "list",
"members": {
"shape_name": "PriceSchedule",
"type": "structure",
"members": {
"Term": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of months remaining in the reservation. For example, 2 is the second \n\t\t\t\tto the last month before the capacity reservation expires.</p>\n ",
"xmlname": "term"
},
"Price": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>The fixed price for the term.</p>\n ",
"xmlname": "price"
},
"CurrencyCode": {
"shape_name": "CurrencyCodeValues",
"type": "string",
"enum": [
"USD"
],
"documentation": "\n <p>The currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is <code>USD</code>.</p>\n ",
"xmlname": "currencyCode"
},
"Active": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>The current price schedule, as determined by the term remaining for the \n\t\t\t\tReserved Instance in the listing.</p>\n <p>A specific price schedule is always in effect, \n\t\t\t\tbut only one price schedule can be active at any time. Take, for example, a \n\t\t\t\tReserved Instance listing that has five months remaining in its term. When you \n\t\t\t\tspecify price schedules for five months and two months, this means that \n\t\t\t\tschedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. \n\t\t\t\tThen schedule 2, covering the last two months of the term, will be active for months 2 and 1.</p>\n ",
"xmlname": "active"
}
},
"documentation": "\n <p>Describes the price for a Reserved Instance.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The price of the Reserved Instance listing.</p>\n ",
"xmlname": "priceSchedules"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the resource.</p>\n ",
"xmlname": "tagSet"
},
"ClientToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The idempotency token you provided when you created the listing.</p>\n ",
"xmlname": "clientToken"
}
},
"documentation": "\n <p>Describes a Reserved Instance listing.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about the Reserved Instance listing.</p>\n ",
"xmlname": "reservedInstancesListingsSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html\">Reserved Instance Marketplace</a> \n in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example shows all the listings associated with your account.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeReservedInstancesListings\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeReservedInstancesListingsResponse>\n <requestId>cec5c904-8f3a-4de5-8f5a-ff7f9EXAMPLE</requestId>\n <reservedInstancesListingsSet>\n <item>\n <reservedInstancesListingId>253dfbf9-c335-4808-b956-d942cEXAMPLE</reservedInstancesListingId>\n <reservedInstancesId>e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE</reservedInstancesId>\n <createDate>2012-07-06T19:35:29.000Z</createDate>\n <updateDate>2012-07-06T19:35:30.000Z</updateDate>\n <status>active</status>\n <statusMessage>ACTIVE</statusMessage>\n <instanceCounts>\n <item>\n <state>Available</state>\n <instanceCount>20</instanceCount>\n </item>\n <item>\n <state>Sold</state>\n <instanceCount>0</instanceCount>\n </item>\n <item>\n <state>Cancelled</state>\n <instanceCount>0</instanceCount>\n </item>\n <item>\n <state>Pending</state>\n <instanceCount>0</instanceCount>\n </item>\n </instanceCounts>\n <priceSchedules>\n <item>\n <term>8</term>\n <price>480.0</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>7</term>\n <price>420.0</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>6</term>\n <price>360.0</price>\n <currencyCode>USD</currencyCode>\n <active>active</active>\n </item>\n <item>\n <term>5</term>\n <price>300.0</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>4</term>\n <price>240.0</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>3</term>\n <price>180.0</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>2</term>\n <price>120.0</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n <item>\n <term>1</term>\n <price>60.0</price>\n <currencyCode>USD</currencyCode>\n <active>false</active>\n </item>\n </priceSchedules>\n <tagSet/>\n <clientToken>myclienttoken1</clientToken>\n </item>\n </reservedInstancesListingsSet>\n</DescribeReservedInstancesListingsResponse></queryresponse>\n </example>\n </examples>\n "
},
"DescribeReservedInstancesModifications": {
"name": "DescribeReservedInstancesModifications",
"input": {
"shape_name": "DescribeReservedInstancesModificationsRequest",
"type": "structure",
"members": {
"ReservedInstancesModificationIds": {
"shape_name": "ReservedInstancesModificationIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ReservedInstancesModificationId"
},
"documentation": "\n <p>IDs for the submitted modification request.</p>\n ",
"flattened": true
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The token for the next page of data.</p>\n "
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>client-token</code> - The idempotency token for the modification request.</p>\n </li>\n <li>\n <p><code>create-date</code> - The time when the modification request was created.</p>\n </li>\n <li>\n <p><code>effective-date</code> - The time when the modification becomes effective.</p>\n </li>\n <li>\n <p><code>modification-result.reserved-instances-id</code> - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is <code>fulfilled</code>.</p>\n </li>\n <li>\n <p><code>modification-result.target-configuration.availability-zone</code> - The Availability Zone for the new Reserved Instances.</p>\n </li>\n <li>\n <p><code>modification-result.target-configuration.instance-count </code> - The number of new Reserved Instances.</p>\n </li>\n <li>\n <p><code>modification-result.target-configuration.instance-type</code> - The instance type of the new Reserved Instances.</p>\n </li>\n <li>\n <p><code>modification-result.target-configuration.platform</code> - The network platform of the new Reserved Instances (<code>EC2-Classic</code> | <code>EC2-VPC</code>).</p>\n </li>\n <li>\n <p><code>reserved-instances-id</code> - The ID of the Reserved Instances modified.</p>\n </li>\n <li>\n <p><code>reserved-instances-modification-id</code> - The ID of the modification request.</p>\n </li>\n <li>\n <p><code>status</code> - The status of the Reserved Instances modification request\n (<code>processing</code> | <code>fulfilled</code> | <code>failed</code>).</p>\n </li>\n <li>\n <p><code>status-message</code> - The reason for the status.</p>\n </li>\n <li>\n <p><code>update-date</code> - The time when the modification request was last updated.</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeReservedInstancesModificationsResult",
"type": "structure",
"members": {
"ReservedInstancesModifications": {
"shape_name": "ReservedInstancesModificationList",
"type": "list",
"members": {
"shape_name": "ReservedInstancesModification",
"type": "structure",
"members": {
"ReservedInstancesModificationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A unique ID for the Reserved Instance modification.</p>\n ",
"xmlname": "reservedInstancesModificationId"
},
"ReservedInstancesIds": {
"shape_name": "ReservedIntancesIds",
"type": "list",
"members": {
"shape_name": "ReservedInstancesId",
"type": "structure",
"members": {
"ReservedInstancesId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Reserved Instance.</p>\n ",
"xmlname": "reservedInstancesId"
}
},
"documentation": "\n <p>Describes the ID of a Reserved Instance.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The IDs of one or more Reserved Instances.</p>\n ",
"xmlname": "reservedInstancesSet"
},
"ModificationResults": {
"shape_name": "ReservedInstancesModificationResultList",
"type": "list",
"members": {
"shape_name": "ReservedInstancesModificationResult",
"type": "structure",
"members": {
"ReservedInstancesId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.</p>\n ",
"xmlname": "reservedInstancesId"
},
"TargetConfiguration": {
"shape_name": "ReservedInstancesConfiguration",
"type": "structure",
"members": {
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone for the modified Reserved Instances.</p>\n ",
"xmlname": "availabilityZone"
},
"Platform": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.</p>\n ",
"xmlname": "platform"
},
"InstanceCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of modified Reserved Instances.</p>\n ",
"xmlname": "instanceCount"
},
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type for the modified Reserved Instances.</p>\n ",
"xmlname": "instanceType"
}
},
"documentation": "\n <p>The target Reserved Instances configurations supplied as part of the modification request.</p>\n ",
"xmlname": "targetConfiguration"
}
},
"documentation": "\n ",
"xmlname": "item"
},
"documentation": "\n <p>Contains target configurations along with their corresponding new Reserved Instance IDs.</p>\n ",
"xmlname": "modificationResultSet"
},
"CreateDate": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time when the modification request was created.</p>\n ",
"xmlname": "createDate"
},
"UpdateDate": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time when the modification request was last updated.</p>\n ",
"xmlname": "updateDate"
},
"EffectiveDate": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time for the modification to become effective.</p>\n ",
"xmlname": "effectiveDate"
},
"Status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status of the Reserved Instances modification request.</p>\n ",
"xmlname": "status"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason for the status.</p>\n ",
"xmlname": "statusMessage"
},
"ClientToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A unique, case-sensitive key supplied by the client to ensure that the modification request is idempotent.</p>\n ",
"xmlname": "clientToken"
}
},
"documentation": "\n <p>Describes a Reserved Instance modification.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The Reserved Instance modification information.</p>\n ",
"xmlname": "reservedInstancesModificationsSet"
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The token for the next page of data.</p>\n ",
"xmlname": "nextToken"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeReservedInstancesModifications\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example filters the response to include only Reserved Instances modification requests with status processing.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeReservedInstancesModifications\n&amp;Filter.1.Name=status\n&amp;Filter.1.Value.1=processing\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n ",
"pagination": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "ReservedInstancesModifications",
"py_input_token": "next_token"
}
},
"DescribeReservedInstancesOfferings": {
"name": "DescribeReservedInstancesOfferings",
"input": {
"shape_name": "DescribeReservedInstancesOfferingsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ReservedInstancesOfferingIds": {
"shape_name": "ReservedInstancesOfferingIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ReservedInstancesOfferingId"
},
"documentation": "\n <p>One or more Reserved Instances offering IDs.</p>\n ",
"flattened": true
},
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type on which the Reserved Instance can be used.\n\t\t\t\tFor more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\">Instance Types</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n "
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone in which the Reserved Instance can be used.</p>\n "
},
"ProductDescription": {
"shape_name": "RIProductDescription",
"type": "string",
"enum": [
"Linux/UNIX",
"Linux/UNIX (Amazon VPC)",
"Windows",
"Windows (Amazon VPC)"
],
"documentation": "\n <p>The Reserved Instance description. Instances that include <code>(Amazon VPC)</code> \n in the description are for use with Amazon VPC.</p>\n "
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used.</p>\n </li>\n <li>\n <p><code>duration</code> - The duration of the Reserved Instance (for example, one year or three years), in seconds.</p>\n </li>\n <li>\n <p><code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0).</p>\n </li>\n <li>\n <p><code>instance-type</code> - The instance type on which the Reserved Instance can be used.</p>\n </li>\n <li>\n <p><code>marketplace</code> - Set to <code>true</code> to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.</p>\n </li>\n <li>\n <p><code>product-description</code> - The description of the Reserved Instance (<code>Linux/UNIX</code> | <code>Linux/UNIX (Amazon VPC)</code> |\n <code>Windows</code> | <code>Windows (Amazon VPC)</code>).</p>\n </li>\n <li>\n <p><code>reserved-instances-offering-id</code> - The Reserved Instances offering ID.</p>\n </li>\n <li>\n <p><code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84).</p>\n </li>\n </ul>\n ",
"flattened": true
},
"InstanceTenancy": {
"shape_name": "Tenancy",
"type": "string",
"enum": [
"default",
"dedicated"
],
"documentation": "\n <p>The tenancy of the Reserved Instance offering. A Reserved Instance\n\t\t\t\twith <code>dedicated</code> tenancy runs on single-tenant hardware and can\n\t\t\t\tonly be launched within a VPC.</p>\n <p>Default: <code>default</code></p>\n "
},
"OfferingType": {
"shape_name": "OfferingTypeValues",
"type": "string",
"enum": [
"Heavy Utilization",
"Medium Utilization",
"Light Utilization"
],
"documentation": "\n <p>The Reserved Instance offering type.</p>\n "
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The token to use when requesting the next paginated set of offerings.</p>\n "
},
"MaxResults": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The maximum number of offerings to return.</p>\n "
},
"IncludeMarketplace": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Include Marketplace offerings in the response.</p>\n "
},
"MinDuration": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The minimum duration (in seconds) to filter when searching for offerings.</p>\n "
},
"MaxDuration": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The maximum duration (in seconds) to filter when searching for offerings.</p>\n "
},
"MaxInstanceCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The maximum number of instances to filter when searching for offerings.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeReservedInstancesOfferingsResult",
"type": "structure",
"members": {
"ReservedInstancesOfferings": {
"shape_name": "ReservedInstancesOfferingList",
"type": "list",
"members": {
"shape_name": "ReservedInstancesOffering",
"type": "structure",
"members": {
"ReservedInstancesOfferingId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Reserved Instance offering.</p>\n ",
"xmlname": "reservedInstancesOfferingId"
},
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type on which the Reserved Instance can be used.</p>\n ",
"xmlname": "instanceType"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone in which the Reserved Instance can be used.</p>\n ",
"xmlname": "availabilityZone"
},
"Duration": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The duration of the Reserved Instance, in seconds.</p>\n ",
"xmlname": "duration"
},
"UsagePrice": {
"shape_name": "Float",
"type": "float",
"documentation": "\n <p>The usage price of the Reserved Instance, per hour.</p>\n ",
"xmlname": "usagePrice"
},
"FixedPrice": {
"shape_name": "Float",
"type": "float",
"documentation": "\n <p>The purchase price of the Reserved Instance.</p>\n ",
"xmlname": "fixedPrice"
},
"ProductDescription": {
"shape_name": "RIProductDescription",
"type": "string",
"enum": [
"Linux/UNIX",
"Linux/UNIX (Amazon VPC)",
"Windows",
"Windows (Amazon VPC)"
],
"documentation": "\n <p>The Reserved Instance description.</p>\n ",
"xmlname": "productDescription"
},
"InstanceTenancy": {
"shape_name": "Tenancy",
"type": "string",
"enum": [
"default",
"dedicated"
],
"documentation": "\n <p>The tenancy of the reserved instance.</p>\n ",
"xmlname": "instanceTenancy"
},
"CurrencyCode": {
"shape_name": "CurrencyCodeValues",
"type": "string",
"enum": [
"USD"
],
"documentation": "\n <p>The currency of the Reserved Instance offering you are purchasing. It's \n\t\t\t\tspecified using ISO 4217 standard currency codes. At this time, \n\t\t\t\tthe only supported currency is <code>USD</code>.</p>\n ",
"xmlname": "currencyCode"
},
"OfferingType": {
"shape_name": "OfferingTypeValues",
"type": "string",
"enum": [
"Heavy Utilization",
"Medium Utilization",
"Light Utilization"
],
"documentation": "\n <p>The Reserved Instance offering type.</p>\n ",
"xmlname": "offeringType"
},
"RecurringCharges": {
"shape_name": "RecurringChargesList",
"type": "list",
"members": {
"shape_name": "RecurringCharge",
"type": "structure",
"members": {
"Frequency": {
"shape_name": "RecurringChargeFrequency",
"type": "string",
"enum": [
"Hourly"
],
"documentation": "\n <p>The frequency of the recurring charge.</p>\n ",
"xmlname": "frequency"
},
"Amount": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>The amount of the recurring charge.</p>\n ",
"xmlname": "amount"
}
},
"documentation": "\n <p>Describes a recurring charge.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The recurring charge tag assigned to the resource.</p>\n ",
"xmlname": "recurringCharges"
},
"Marketplace": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. \n If it's a Reserved Instance Marketplace offering, this is <code>true</code>.</p>\n ",
"xmlname": "marketplace"
},
"PricingDetails": {
"shape_name": "PricingDetailsList",
"type": "list",
"members": {
"shape_name": "PricingDetail",
"type": "structure",
"members": {
"Price": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>The price per instance.</p>\n ",
"xmlname": "price"
},
"Count": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of instances available for the price.</p>\n ",
"xmlname": "count"
}
},
"documentation": "\n <p>Describes a Reserved Instance offering.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The pricing details of the Reserved Instance offering.</p>\n ",
"xmlname": "pricingDetailsSet"
}
},
"documentation": "\n <p>Describes a Reserved Instance offering.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>A list of Reserved Instances offerings.</p>\n ",
"xmlname": "reservedInstancesOfferingsSet"
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The next paginated set of results to return.</p>\n ",
"xmlname": "nextToken"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes Reserved Instance offerings that are available for purchase. With \n\t\t\t\tReserved Instances, you purchase the right to launch instances for a\n\t\t\t\tperiod of time. During that time period, you do not receive insufficient capacity\n\t\t\t\terrors, and you pay a lower usage rate than the rate charged for On-Demand\n\t\t\t\tinstances for the actual time used.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html\">Reserved Instance Marketplace</a>\n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example Describing Reserved Instance Marketplace Offerings Only</name>\n <description>This example requests a list of Linux/Unix, Light Utilization Reserved\n\t\t\t\t\tInstances that are available through the Reserved Instance Marketplace only.\n\t\t\t\t\tWhen using the Query API, all strings must be URL-encoded.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings\n&amp;Filter.0.Name=marketplace\n&amp;Filter.0.Value.1=true\n&amp;IncludeMarketplace=true\n&amp;OfferingType=Light+Utilization\n&amp;ProductDescription=Linux%2FUNIX\n&amp;Version=2013-10-01\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeReservedInstancesOfferingsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n <requestId>2bc7dafa-dafd-4257-bdf9-c0814EXAMPLE</requestId>\n <reservedInstancesOfferingsSet>\n <item>\n <reservedInstancesOfferingId>a6ce8269-7b8c-42cd-a7f5-0841cEXAMPLE</reservedInstancesOfferingId>\n <instanceType>m1.large</instanceType>\n <availabilityZone>us-east-1a</availabilityZone>\n <duration>90720000</duration>\n <fixedPrice>96.03</fixedPrice>\n <usagePrice>0.027</usagePrice>\n <productDescription>Linux/UNIX</productDescription>\n <instanceTenancy>default</instanceTenancy>\n <currencyCode>USD</currencyCode>\n <offeringType>Light Utilization</offeringType>\n <recurringCharges/>\n <marketplace>true</marketplace>\n <pricingDetailsSet>\n <item>\n <price>96.03</price>\n <count>1</count>\n </item>\n </pricingDetailsSet>\n </item>\n <item>\n <reservedInstancesOfferingId>2bc7dafa-dafd-4257-bdf9-c0814EXAMPLE</reservedInstancesOfferingId>\n <instanceType>m1.xlarge</instanceType>\n <availabilityZone>us-east-1b</availabilityZone>\n <duration>28512000</duration>\n <fixedPrice>61.0</fixedPrice>\n <usagePrice>0.034</usagePrice>\n <productDescription>Linux/UNIX</productDescription>\n <instanceTenancy>default</instanceTenancy>\n <currencyCode>USD</currencyCode>\n <offeringType>Light Utilization</offeringType>\n <recurringCharges>\n <item>\n <frequency>Hourly</frequency>\n <amount>0.29</amount>\n </item>\n </recurringCharges>\n <marketplace>true</marketplace>\n <pricingDetailsSet>\n <item>\n <price>61.0</price>\n <count>2</count>\n </item>\n </pricingDetailsSet>\n </item>\n </reservedInstancesOfferingsSet>\n</DescribeReservedInstancesOfferingsResponse></queryresponse>\n </example>\n <example>\n <name>Example Describing AWS Offerings Only</name>\n <description>This example lists AWS offerings only.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings\n&amp;IncludeMarketplace=false\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse></queryresponse>\n </example>\n <example>\n <name>Example Using Tokens to Manage Results</name>\n <description>You can use pagination support to query the results sequentially and in parts. \n Specify the maximum number of results that are returned in the response. Then, each paginated response \n contains a token that can be provided as input to a subsequent DescribeReservedInstancesOfferings call \n to fetch the next page. (Make sure that you use URL encoding for the token value.)</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings\n&amp;MaxResults=5\n&amp;AUTHPARAMS\n\n<DescribeReservedInstancesOfferingsResponse>\n <requestId>d072f652-cc57-458c-89e0-e6c02EXAMPLE</requestId>\n <reservedInstancesOfferingsSet>\n ...\n <item>\n <reservedInstancesOfferingId>649fd0c8-7846-46b8-8f84-a6400EXAMPLE</reservedInstancesOfferingId>\n <instanceType>m1.large</instanceType>\n <availabilityZone>us-east-1a</availabilityZone>\n <duration>94608000</duration>\n <fixedPrice>1200.0</fixedPrice>\n <usagePrice>0.0</usagePrice>\n <productDescription>Linux/UNIX (Amazon VPC)</productDescription>\n <instanceTenancy>default</instanceTenancy>\n <currencyCode>USD</currencyCode>\n <offeringType>Heavy Utilization</offeringType>\n <recurringCharges>\n <item>\n <frequency>Hourly</frequency>\n <amount>0.052</amount>\n </item>\n </recurringCharges>\n <marketplace>false</marketplace>\n <pricingDetailsSet/>\n </item>\n <item>\n <reservedInstancesOfferingId>e5a2ff3b-a4f3-477c-8928-dbd00EXAMPLE</reservedInstancesOfferingId>\n <instanceType>m1.large</instanceType>\n <availabilityZone>us-east-1a</availabilityZone>\n <duration>94608000</duration>\n <fixedPrice>1000.0</fixedPrice>\n <usagePrice>0.076</usagePrice>\n <productDescription>Linux/UNIX (Amazon VPC)</productDescription>\n <instanceTenancy>default</instanceTenancy>\n <currencyCode>USD</currencyCode>\n <offeringType>Medium Utilization</offeringType>\n <recurringCharges/>\n <marketplace>false</marketplace>\n <pricingDetailsSet/>\n </item>\n ...\n </reservedInstancesOfferingsSet>\n <nextToken>h/C8YKPQBHEjW8xKz1827/Zzyb0VqsqkjRo3TqhFYeE=</nextToken>\n</DescribeReservedInstancesOfferingsResponse>\n\nhttps://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings\n&amp;MaxResults=5\n&amp;NextToken=h%2FC8YKPQBHEjW8xKz1827%2FZzyb0VqsqkjRo3TqhFYeE%3D\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example Using Filters</name>\n <description>This example filters the response to include only one-year, <code>m1.small</code> or <code>m1.large</code> \n Linux/UNIX Reserved Instances. If you want Linux/UNIX Reserved Instances specifically for use with a VPC, \n set the product description to <code>Linux/UNIX (Amazon VPC)</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings\n&amp;Filter.1.Name=duration\n&amp;Filter.1.Value.1=31536000\n&amp;Filter.2.Name=instance-type\n&amp;Filter.2.Value.1=m1.small\n&amp;Filter.2.Value.2=m1.large\n&amp;Filter.3.Name=product-description\n&amp;Filter.3.Value.1=Linux%2FUNIX\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n ",
"pagination": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "ReservedInstancesOfferings",
"py_input_token": "next_token"
}
},
"DescribeRouteTables": {
"name": "DescribeRouteTables",
"input": {
"shape_name": "DescribeRouteTablesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"RouteTableIds": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "RouteTableId"
},
"documentation": "\n\t\t <p>One or more route table IDs.</p>\n\t\t <p>Default: Describes all your route tables.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>association.route-table-association-id</code> - The ID of an association ID for the route table.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.route-table-id</code> - The ID of the route table involved in the association.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.subnet-id</code> - The ID of the subnet involved in the association.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.main</code> - Indicates whether the route table is the main route table for the VPC.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>route-table-id</code> - The ID of the route table.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>route.destination-cidr-block</code> - The CIDR range specified in a route in the table.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>route.gateway-id</code> - The ID of a gateway specified in a route in the table.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>route.instance-id</code> - The ID of an instance specified in a route in the table.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>route.origin</code> - Describes how the route was created (<code>CreateRouteTable</code> | <code>CreateRoute</code> | <code>EnableVgwRoutePropagation</code>).</p>\n\t\t </li>\n\t\t <li>\n <p><code>route.state</code> - The state of a route in the route table (<code>active</code> |\n <code>blackhole</code>). The blackhole state indicates that the route's target isn't\n available (for example, the specified gateway isn't attached to the VPC, the specified NAT\n instance has been terminated, and so on).</p>\n </li>\n <li>\n <p><code>route.vpc-peering-connection-id</code> - The ID of a VPC peering connection\n specified in a route in the table.</p>\n </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>vpc-id</code> - The ID of the VPC for the route table.</p>\n\t\t </li>\n\t\t </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeRouteTablesResult",
"type": "structure",
"members": {
"RouteTables": {
"shape_name": "RouteTableList",
"type": "list",
"members": {
"shape_name": "RouteTable",
"type": "structure",
"members": {
"RouteTableId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the route table.</p>\n ",
"xmlname": "routeTableId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"Routes": {
"shape_name": "RouteList",
"type": "list",
"members": {
"shape_name": "Route",
"type": "structure",
"members": {
"DestinationCidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR block used for the destination match.</p>\n ",
"xmlname": "destinationCidrBlock"
},
"GatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of a gateway attached to your VPC.</p>\n ",
"xmlname": "gatewayId"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of a NAT instance in your VPC.</p>\n ",
"xmlname": "instanceId"
},
"InstanceOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The AWS account ID of the owner of the instance.</p>\n ",
"xmlname": "instanceOwnerId"
},
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"xmlname": "networkInterfaceId"
},
"VpcPeeringConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC peering connection.</p>\n ",
"xmlname": "vpcPeeringConnectionId"
},
"State": {
"shape_name": "RouteState",
"type": "string",
"enum": [
"active",
"blackhole"
],
"documentation": "\n\t\t <p>The state of the route. The <code>blackhole</code> state indicates that the\n\t\t\t\troute's target isn't available (for example, the specified gateway isn't attached to the\n\t\t\t\tVPC, or the specified NAT instance has been terminated).</p>\n ",
"xmlname": "state"
},
"Origin": {
"shape_name": "RouteOrigin",
"type": "string",
"enum": [
"CreateRouteTable",
"CreateRoute",
"EnableVgwRoutePropagation"
],
"documentation": "\n <p>Describes how the route was created.</p>\n <ul>\n <li>\n<code>CreateRouteTable</code> indicates that route was automatically created when the route table was created.</li>\n <li>\n<code>CreateRoute</code> indicates that the route was manually added to the route table.</li>\n <li>\n<code>EnableVgwRoutePropagation</code> indicates that the route was propagated by route propagation.</li>\n </ul>\n ",
"xmlname": "origin"
}
},
"documentation": "\n\t\t <p>Describes a route in a route table.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>The routes in the route table.</p>\n ",
"xmlname": "routeSet"
},
"Associations": {
"shape_name": "RouteTableAssociationList",
"type": "list",
"members": {
"shape_name": "RouteTableAssociation",
"type": "structure",
"members": {
"RouteTableAssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the association between a route table and a subnet.</p>\n ",
"xmlname": "routeTableAssociationId"
},
"RouteTableId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the route table.</p>\n ",
"xmlname": "routeTableId"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet.</p>\n ",
"xmlname": "subnetId"
},
"Main": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether this is the main route table.</p>\n ",
"xmlname": "main"
}
},
"documentation": "\n\t\t <p>Describes an association between a route table and a subnet.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>The associations between the route table and one or more subnets.</p>\n ",
"xmlname": "associationSet"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the route table.</p>\n ",
"xmlname": "tagSet"
},
"PropagatingVgws": {
"shape_name": "PropagatingVgwList",
"type": "list",
"members": {
"shape_name": "PropagatingVgw",
"type": "structure",
"members": {
"GatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the virtual private gateway (VGW).</p>\n ",
"xmlname": "gatewayId"
}
},
"documentation": "\n\t\t <p>Describes a virtual private gateway propagating route.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any virtual private gateway (VGW) propagating routes.</p>\n ",
"xmlname": "propagatingVgwSet"
}
},
"documentation": "\n\t\t <p>Describes a route table.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Information about one or more route tables.</p>\n ",
"xmlname": "routeTableSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Describes one or more of your route tables.</p>\n\t\t <p>For more information about route tables, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html\">Route Tables</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes all your route tables.\n The first route table in the returned list is the VPC's main route table. Its\n\t\t\t\t association ID represents the association between the table and the VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeRouteTables\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeRouteTablesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>6f570b0b-9c18-4b07-bdec-73740dcf861a</requestId>\n <routeTableSet>\n <item>\n <routeTableId>rtb-13ad487a</routeTableId>\n <vpcId>vpc-11ad4878</vpcId>\n <routeSet>\n <item>\n <destinationCidrBlock>10.0.0.0/22</destinationCidrBlock>\n <gatewayId>local</gatewayId>\n <state>active</state>\n <origin>CreateRouteTable</origin>\n </item>\n </routeSet>\n <associationSet>\n <item>\n <routeTableAssociationId>rtbassoc-12ad487b</routeTableAssociationId>\n <routeTableId>rtb-13ad487a</routeTableId>\n <main>true</main>\n </item>\n </associationSet>\n <tagSet/>\n </item>\n <item>\n <routeTableId>rtb-f9ad4890</routeTableId>\n <vpcId>vpc-11ad4878</vpcId>\n <routeSet>\n <item>\n <destinationCidrBlock>10.0.0.0/22</destinationCidrBlock>\n <gatewayId>local</gatewayId>\n <state>active</state>\n <origin>CreateRouteTable</origin>\n </item>\n <item>\n <destinationCidrBlock>0.0.0.0/0</destinationCidrBlock>\n <gatewayId>igw-eaad4883</gatewayId>\n <state>active</state>\n </item>\n </routeSet>\n <associationSet>\n <item>\n <routeTableAssociationId>rtbassoc-faad4893</routeTableAssociationId>\n <routeTableId>rtb-f9ad4890</routeTableId>\n <subnetId>subnet-15ad487c</subnetId>\n </item>\n </associationSet>\n <tagSet/>\n </item>\n </routeTableSet>\n</DescribeRouteTablesResponse></queryresponse>\n </example>\n </examples>\n "
},
"DescribeSecurityGroups": {
"name": "DescribeSecurityGroups",
"input": {
"shape_name": "DescribeSecurityGroupsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"GroupNames": {
"shape_name": "GroupNameStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "GroupName"
},
"documentation": "\n <p>[EC2-Classic, default VPC] One or more security group names.</p>\n <p>Default: Describes all your security groups.</p>\n ",
"flattened": true
},
"GroupIds": {
"shape_name": "GroupIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "GroupId"
},
"documentation": "\n <p>One or more security group IDs.</p>\n <p>Default: Describes all your security groups.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>description</code> - The description of the security group.</p>\n </li>\n <li>\n <p><code>group-id</code> - The ID of the security group.</p>\n </li>\n <li>\n <p><code>group-name</code> - The name of the security group.</p>\n </li>\n <li>\n <p><code>ip-permission.cidr</code> - A CIDR range that has been granted permission.</p>\n </li>\n <li>\n <p><code>ip-permission.from-port</code> - The start of port range for the TCP and UDP protocols, or an ICMP type number.</p>\n </li>\n <li>\n <p><code>ip-permission.group-id</code> - The ID of a security group that has been granted permission.</p>\n </li>\n <li>\n <p><code>ip-permission.group-name</code> - The name of a security group that has been granted permission.</p>\n </li>\n <li>\n <p><code>ip-permission.protocol</code> - The IP protocol for the permission (<code>tcp</code> | <code>udp</code> |\n <code>icmp</code> or a protocol number).</p>\n </li>\n <li>\n <p><code>ip-permission.to-port</code> - The end of port range for the TCP and UDP protocols, or an ICMP code.</p>\n </li>\n <li>\n <p><code>ip-permission.user-id</code> - The ID of an AWS account that has been granted permission.</p>\n </li>\n <li>\n <p><code>owner-id</code> - The AWS account ID of the owner of the security group.</p>\n </li>\n <li>\n <p><code>tag-key</code> - The key of a tag assigned to the security group.</p>\n </li>\n <li>\n <p><code>tag-value</code> - The value of a tag assigned to the security group.</p>\n </li>\n <li>\n <p><code>vpc-id</code> - The ID of the VPC specified when the security group was created.</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeSecurityGroupsResult",
"type": "structure",
"members": {
"SecurityGroups": {
"shape_name": "SecurityGroupList",
"type": "list",
"members": {
"shape_name": "SecurityGroup",
"type": "structure",
"members": {
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the owner of the security group.</p>\n ",
"xmlname": "ownerId"
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description of the security group.</p>\n ",
"xmlname": "groupDescription"
},
"IpPermissions": {
"shape_name": "IpPermissionList",
"type": "list",
"members": {
"shape_name": "IpPermission",
"type": "structure",
"members": {
"IpProtocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The protocol.</p>\n\t\t <p>When you call <a>DescribeSecurityGroups</a>, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, <code>tcp</code>,\n\t\t\t\t<code>udp</code>, or <code>icmp</code>). For a list of\n\t\t\t\tprotocol numbers, see <a href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Protocol Numbers</a>.</p>\n ",
"xmlname": "ipProtocol"
},
"FromPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of <code>-1</code> indicates all ICMP types.</p>\n ",
"xmlname": "fromPort"
},
"ToPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The end of port range for the TCP and UDP protocols, or an ICMP code. A value of <code>-1</code>\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.</p>\n ",
"xmlname": "toPort"
},
"UserIdGroupPairs": {
"shape_name": "UserIdGroupPairList",
"type": "list",
"members": {
"shape_name": "UserIdGroupPair",
"type": "structure",
"members": {
"UserId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of an AWS account.</p>\n ",
"xmlname": "userId"
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group owned by the specified AWS account.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group in the specified AWS account.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group and AWS account ID pair for EC2-Classic.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more security group and AWS account ID pairs.</p>\n ",
"xmlname": "groups"
},
"IpRanges": {
"shape_name": "IpRangeList",
"type": "list",
"members": {
"shape_name": "IpRange",
"type": "structure",
"members": {
"CidrIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR range. You can either specify a CIDR range or a source security group, not both.</p>\n ",
"xmlname": "cidrIp"
}
},
"documentation": "\n\t\t <p>Describes an IP range.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more IP ranges.</p>\n ",
"xmlname": "ipRanges"
}
},
"documentation": "\n\t\t <p>Describes a security group rule.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more inbound rules associated with the security group.</p>\n ",
"xmlname": "ipPermissions"
},
"IpPermissionsEgress": {
"shape_name": "IpPermissionList",
"type": "list",
"members": {
"shape_name": "IpPermission",
"type": "structure",
"members": {
"IpProtocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The protocol.</p>\n\t\t <p>When you call <a>DescribeSecurityGroups</a>, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, <code>tcp</code>,\n\t\t\t\t<code>udp</code>, or <code>icmp</code>). For a list of\n\t\t\t\tprotocol numbers, see <a href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Protocol Numbers</a>.</p>\n ",
"xmlname": "ipProtocol"
},
"FromPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of <code>-1</code> indicates all ICMP types.</p>\n ",
"xmlname": "fromPort"
},
"ToPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The end of port range for the TCP and UDP protocols, or an ICMP code. A value of <code>-1</code>\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.</p>\n ",
"xmlname": "toPort"
},
"UserIdGroupPairs": {
"shape_name": "UserIdGroupPairList",
"type": "list",
"members": {
"shape_name": "UserIdGroupPair",
"type": "structure",
"members": {
"UserId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of an AWS account.</p>\n ",
"xmlname": "userId"
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group owned by the specified AWS account.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group in the specified AWS account.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group and AWS account ID pair for EC2-Classic.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more security group and AWS account ID pairs.</p>\n ",
"xmlname": "groups"
},
"IpRanges": {
"shape_name": "IpRangeList",
"type": "list",
"members": {
"shape_name": "IpRange",
"type": "structure",
"members": {
"CidrIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR range. You can either specify a CIDR range or a source security group, not both.</p>\n ",
"xmlname": "cidrIp"
}
},
"documentation": "\n\t\t <p>Describes an IP range.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more IP ranges.</p>\n ",
"xmlname": "ipRanges"
}
},
"documentation": "\n\t\t <p>Describes a security group rule.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>[EC2-VPC] One or more outbound rules associated with the security group.</p>\n ",
"xmlname": "ipPermissionsEgress"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] The ID of the VPC for the security group.</p>\n ",
"xmlname": "vpcId"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the security group.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n <p>Describes a security group</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about one or more security groups.</p>\n ",
"xmlname": "securityGroupInfo"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes one or more of your security groups.</p>\n <p>A security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 Security Groups</a> in \n\t\t\t\tthe <i>Amazon Elastic Compute Cloud User Guide</i> and \n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example returns information about two security groups that are configured\n\t\t\t\t\tfor the account.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeSecurityGroups\n&amp;GroupName.1=WebServers\n&amp;GroupName.2=RangedPortsBySource\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeSecurityGroupsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <securityGroupInfo>\n <item>\n <ownerId>123456789012</ownerId>\n <groupId>sg-1a2b3c4d</groupId>\n <groupName>WebServers</groupName>\n <groupDescription>Web Servers</groupDescription>\n <vpcId/>\n <ipPermissions>\n <item>\n <ipProtocol>tcp</ipProtocol>\n <fromPort>80</fromPort>\n <toPort>80</toPort>\n <groups/>\n <ipRanges>\n <item>\n <cidrIp>0.0.0.0/0</cidrIp>\n </item>\n </ipRanges>\n </item>\n </ipPermissions>\n <ipPermissionsEgress/>\n </item>\n <item>\n <ownerId>123456789012</ownerId>\n <groupId>sg-2a2b3c4d</groupId>\n <groupName>RangedPortsBySource</groupName>\n <groupDescription>Group A</groupDescription>\n <ipPermissions>\n <item>\n <ipProtocol>tcp</ipProtocol>\n <fromPort>6000</fromPort>\n <toPort>7000</toPort>\n <groups>\n <item>\n <userId>123456789012</userId>\n <groupId>sg-3a2b3c4d</groupId>\n <groupName>Group B</groupName>\n </item>\n </groups>\n <ipRanges/>\n </item>\n </ipPermissions>\n <ipPermissionsEgress/>\n </item>\n </securityGroupInfo>\n</DescribeSecurityGroupsResponse></queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example describes all security groups that grant access over TCP specifically on port 22 \n from instances associated with <code>app_server_group</code> or <code>database_group</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeSecurityGroups\n&amp;Filter.1.Name=ip-permission.protocol\n&amp;Filter.1.Value.1=tcp\n&amp;Filter.2.Name=ip-permission.from-port\n&amp;Filter.2.Value.1=22\n&amp;Filter.3.Name=ip-permission.to-port\n&amp;Filter.3.Value.1=22\n&amp;Filter.4.Name=ip-permission.group-name\n&amp;Filter.4.Value.1=app_server_group\n&amp;Filter.4.Value.2=database_group\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DescribeSnapshotAttribute": {
"name": "DescribeSnapshotAttribute",
"input": {
"shape_name": "DescribeSnapshotAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Amazon EBS snapshot.</p>\n ",
"required": true
},
"Attribute": {
"shape_name": "SnapshotAttributeName",
"type": "string",
"enum": [
"productCodes",
"createVolumePermission"
],
"documentation": "\n <p>The snapshot attribute you would like to view.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeSnapshotAttributeResult",
"type": "structure",
"members": {
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Amazon EBS snapshot.</p>\n ",
"xmlname": "snapshotId"
},
"CreateVolumePermissions": {
"shape_name": "CreateVolumePermissionList",
"type": "list",
"members": {
"shape_name": "CreateVolumePermission",
"type": "structure",
"members": {
"UserId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The specific AWS account ID that is to be added or removed from a volume's list of create\n volume permissions.</p>\n ",
"xmlname": "userId"
},
"Group": {
"shape_name": "PermissionGroup",
"type": "string",
"enum": [
"all"
],
"documentation": "\n <p>The specific group that is to be added or removed from a volume's list of create volume\n permissions.</p>\n ",
"xmlname": "group"
}
},
"documentation": "\n ",
"xmlname": "item"
},
"documentation": "\n <p>A list of permissions for creating volumes from the snapshot.</p>\n ",
"xmlname": "createVolumePermission"
},
"ProductCodes": {
"shape_name": "ProductCodeList",
"type": "list",
"members": {
"shape_name": "ProductCode",
"type": "structure",
"members": {
"ProductCodeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The product code.</p>\n ",
"xmlname": "productCode"
},
"ProductCodeType": {
"shape_name": "ProductCodeValues",
"type": "string",
"enum": [
"devpay",
"marketplace"
],
"documentation": "\n <p>The type of product code.</p>\n ",
"xmlname": "type"
}
},
"documentation": "\n <p>Describes a product code.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>A list of product codes.</p>\n ",
"xmlname": "productCodes"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes the specified attribute of the specified snapshot. You can specify only one attribute at a\n time.</p>\n <p>For more information about Amazon EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes permissions for a snapshot with the ID of\n <code>snap-1a2b3c4d</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeSnapshotAttribute\n&amp;SnapshotId=snap-1a2b3c4d\n&amp;Attribute=createVolumePermission\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeSnapshotAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <snapshotId>snap-1a2b3c4d</snapshotId>\n <createVolumePermission>\n <item>\n <group>all</group>\n </item>\n </createVolumePermission>\n</DescribeSnapshotAttributeResponse></queryresponse>\n </example>\n </examples>\n "
},
"DescribeSnapshots": {
"name": "DescribeSnapshots",
"input": {
"shape_name": "DescribeSnapshotsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SnapshotIds": {
"shape_name": "SnapshotIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "SnapshotId"
},
"documentation": "\n <p>One or more snapshot IDs.</p>\n <p>Default: Describes snapshots for which you have launch permissions.</p>\n ",
"flattened": true
},
"OwnerIds": {
"shape_name": "OwnerStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Owner"
},
"documentation": "\n <p>Returns the snapshots owned by the specified owner. Multiple owners can be specified.</p>\n ",
"flattened": true
},
"RestorableByUserIds": {
"shape_name": "RestorableByStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "RestorableBy"
},
"documentation": "\n <p>One or more AWS accounts IDs that can create volumes from the snapshot.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>description</code> - A description of the snapshot.</p>\n </li>\n <li>\n <p><code>owner-alias</code> - The AWS account alias (for example, <code>amazon</code>) that owns the snapshot.</p>\n </li>\n <li>\n <p><code>owner-id</code> - The ID of the AWS account that owns the snapshot.</p>\n </li>\n <li>\n <p><code>progress</code> - The progress of the snapshot, as a percentage (for example, 80%).</p>\n </li>\n <li>\n <p><code>snapshot-id</code> - The snapshot ID.</p>\n </li>\n <li>\n <p><code>start-time</code> - The time stamp when the snapshot was initiated.</p>\n </li>\n <li>\n <p><code>status</code> - The status of the snapshot (<code>pending</code> | <code>completed</code> | <code>error</code>).</p>\n </li>\n <li>\n <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n </li>\n <li>\n <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n </li>\n <li>\n <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n </li>\n <li>\n <p><code>volume-id</code> - The ID of the volume the snapshot is for.</p>\n </li>\n <li>\n <p><code>volume-size</code> - The size of the volume, in GiB.</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeSnapshotsResult",
"type": "structure",
"members": {
"Snapshots": {
"shape_name": "SnapshotList",
"type": "list",
"members": {
"shape_name": "Snapshot",
"type": "structure",
"members": {
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the snapshot.</p>\n ",
"xmlname": "snapshotId"
},
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"xmlname": "volumeId"
},
"State": {
"shape_name": "SnapshotState",
"type": "string",
"enum": [
"pending",
"completed",
"error"
],
"documentation": "\n <p>The snapshot state.</p>\n ",
"xmlname": "status"
},
"StartTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when the snapshot was initiated.</p>\n ",
"xmlname": "startTime"
},
"Progress": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The progress of the snapshot, as a percentage.</p>\n ",
"xmlname": "progress"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the Amazon EBS snapshot owner.</p>\n ",
"xmlname": "ownerId"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The description for the snapshot.</p>\n ",
"xmlname": "description"
},
"VolumeSize": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiB.</p>\n ",
"xmlname": "volumeSize"
},
"OwnerAlias": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account alias (for example, <code>amazon</code>, <code>self</code>) or AWS account ID\n that owns the snapshot.</p>\n ",
"xmlname": "ownerAlias"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the snapshot.</p>\n ",
"xmlname": "tagSet"
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the snapshot is encrypted.</p>\n ",
"xmlname": "encrypted"
}
},
"documentation": "\n <p>Describes a snapshot.</p>\n ",
"xmlname": "item"
},
"documentation": "\n ",
"xmlname": "snapshotSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes one or more of the Amazon EBS snapshots available to you. Available snapshots include \n public snapshots available for any AWS account to launch, private\n snapshots that you own, and private snapshots owned by another AWS account but for which\n you've been given explicit create volume permissions.</p>\n <p>The create volume permissions fall into the following categories:</p>\n <ul>\n <li>\n<i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot\n to the <code>all</code> group. All AWS accounts have create volume permissions for these\n snapshots.</li>\n <li>\n<i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific\n AWS account.</li>\n <li>\n<i>implicit</i>: An AWS account has implicit create volume permissions for all snapshots it\n owns.</li>\n </ul>\n <p>The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or\n AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all\n snapshots for which you have create volume permissions.</p>\n <p>If you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot\n ID for which you do not have access, it is not included in the returned results.</p>\n <p>If you specify one or more snapshot owners, only snapshots from the specified owners and for\n which you have access are returned. The results can include the AWS account IDs of the specified\n owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots\n that you own.</p>\n <p>If you specify a list of restorable users, only snapshots with create snapshot permissions for\n those users are returned. You can specify AWS account IDs (if you own the snapshots),\n <code>self</code> for snapshots for which you own or have explicit permissions, or\n <code>all</code> for public snapshots.</p>\n <p>For more information about Amazon EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes a snapshot with an ID of\n <code>snap-1a2b3c4d</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeSnapshots\n&amp;SnapshotId=snap-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeSnapshotsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <snapshotSet>\n <item>\n <snapshotId>snap-1a2b3c4d</snapshotId>\n <volumeId>vol-1a2b3c4d</volumeId>\n <status>pending</status>\n <startTime>YYYY-MM-DDTHH:MM:SS.SSSZ</startTime>\n <progress>80%</progress>\n <ownerId>111122223333</ownerId>\n <volumeSize>15</volumeSize>\n <description>Daily Backup</description>\n <encrypted>true</encrypted>\n <tagSet/>\n </item>\n </snapshotSet>\n</DescribeSnapshotsResponse></queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example filters the response to include only snapshots with the\n <code>pending</code> status, and that are also tagged with a value that includes the string\n <code>db_</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeSnapshots\n&amp;Filter.1.Name=status\n&amp;Filter.1.Value.1=pending\n&amp;Filter.2.Name=tag-value\n&amp;Filter.2.Value.1=*db_*\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeSnapshotsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <snapshotSet>\n <item>\n <snapshotId>snap-1a2b3c4d</snapshotId>\n <volumeId>vol-1a2b3c4d</volumeId>\n <status>pending</status>\n <startTime>YYYY-MM-DDTHH:MM:SS.SSSZ</startTime>\n <progress>30%</progress>\n <ownerId>111122223333</ownerId>\n <volumeSize>15</volumeSize>\n <description>Daily Backup</description>\n <tagSet>\n <item>\n <key>Purpose</key>\n <value>demo_db_14_backup</value>\n </item>\n </tagSet>\n <encrypted>true</encrypted>\n </item>\n </snapshotSet>\n</DescribeSnapshotsResponse></queryresponse>\n </example>\n </examples>\n "
},
"DescribeSpotDatafeedSubscription": {
"name": "DescribeSpotDatafeedSubscription",
"input": {
"shape_name": "DescribeSpotDatafeedSubscriptionRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeSpotDatafeedSubscriptionResult",
"type": "structure",
"members": {
"SpotDatafeedSubscription": {
"shape_name": "SpotDatafeedSubscription",
"type": "structure",
"members": {
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the account.</p>\n ",
"xmlname": "ownerId"
},
"Bucket": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Amazon S3 bucket where the Spot Instance datafeed is located.</p>\n ",
"xmlname": "bucket"
},
"Prefix": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The prefix that is prepended to datafeed files.</p>\n ",
"xmlname": "prefix"
},
"State": {
"shape_name": "DatafeedSubscriptionState",
"type": "string",
"enum": [
"Active",
"Inactive"
],
"documentation": "\n <p>The state of the Spot Instance datafeed subscription.</p>\n ",
"xmlname": "state"
},
"Fault": {
"shape_name": "SpotInstanceStateFault",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason code for the Spot Instance state change.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The message for the Spot Instance state change.</p>\n ",
"xmlname": "message"
}
},
"documentation": "\n <p>The fault codes for the Spot Instance request, if any.</p>\n ",
"xmlname": "fault"
}
},
"documentation": "\n <p>The Spot Instance datafeed subscription.</p>\n ",
"xmlname": "spotDatafeedSubscription"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes the datafeed for Spot Instances. For more information, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html\">Spot Instances</a> in\n\t\t\t\tthe <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes the datafeed for the account.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeSpotDatafeedSubscription\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeSpotDatafeedSubscriptionResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <spotDatafeedSubscription>\n <ownerId>123456789012</ownerId>\n <bucket>my-s3-bucket</bucket>\n <prefix>spotdata_</prefix>\n <state>Active</state>\n </spotDatafeedSubscription>\n</DescribeSpotDatafeedSubscriptionResponse></queryresponse>\n </example>\n </examples>\n "
},
"DescribeSpotInstanceRequests": {
"name": "DescribeSpotInstanceRequests",
"input": {
"shape_name": "DescribeSpotInstanceRequestsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SpotInstanceRequestIds": {
"shape_name": "SpotInstanceRequestIdList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "SpotInstanceRequestId"
},
"documentation": "\n <p>One or more Spot Instance request IDs.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>availability-zone-group</code> - The Availability Zone group.</p>\n </li>\n <li>\n <p><code>create-time</code> - The time stamp when the Spot Instance request was created.</p>\n </li>\n <li>\n <p><code>fault-code</code> - The fault code related to the request.</p>\n </li>\n <li>\n <p><code>fault-message</code> - The fault message related to the request.</p>\n </li>\n <li>\n <p><code>instance-id</code> - The ID of the instance that fulfilled the request.</p>\n </li>\n <li>\n <p><code>launch-group</code> - The Spot Instance launch group.</p>\n </li>\n <li>\n <p><code>launch.block-device-mapping.delete-on-termination</code> - Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n </li>\n <li>\n <p><code>launch.block-device-mapping.device-name</code> - The device name for the Amazon EBS volume (for example, <code>/dev/sdh</code>).</p>\n </li>\n <li>\n <p><code>launch.block-device-mapping.snapshot-id</code> - The ID of the snapshot used for the Amazon EBS volume.</p>\n </li>\n <li>\n <p><code>launch.block-device-mapping.volume-size</code> - The size of the Amazon EBS volume, in GiB.</p>\n </li>\n <li>\n <p><code>launch.block-device-mapping.volume-type</code> - The type of the Amazon EBS volume\n (<code>gp2</code> | <code>standard</code> | <code>io1</code>).</p>\n </li>\n <li>\n <p><code>launch.group-id</code> - The security group for the instance.</p>\n </li>\n <li>\n <p><code>launch.image-id</code> - The ID of the AMI.</p>\n </li>\n <li>\n <p><code>launch.instance-type</code> - The type of instance (for example, <code>m1.small</code>).</p>\n </li>\n <li>\n <p><code>launch.kernel-id</code> - The kernel ID.</p>\n </li>\n <li>\n <p><code>launch.key-name</code> - The name of the key pair the instance launched with.</p>\n </li>\n <li>\n <p><code>launch.monitoring-enabled</code> - Whether monitoring is enabled for the Spot Instance.</p>\n </li>\n <li>\n <p><code>launch.ramdisk-id</code> - The RAM disk ID.</p>\n </li>\n <li>\n <p><code>launch.network-interface.network-interface-id</code> - The ID of the network interface.</p>\n </li>\n <li>\n <p><code>launch.network-interface.device-index</code> - The index of the device for the network interface attachment on the instance.</p>\n </li>\n <li>\n <p><code>launch.network-interface.subnet-id</code> - The ID of the subnet for the instance.</p>\n </li>\n <li>\n <p><code>launch.network-interface.description</code> - A description of the network interface.</p>\n </li>\n <li>\n <p><code>launch.network-interface.private-ip-address</code> - The primary private IP address of the network interface.</p>\n </li>\n <li>\n <p><code>launch.network-interface.delete-on-termination</code> - Indicates whether the network interface is deleted when the instance is terminated.</p>\n </li>\n <li>\n <p><code>launch.network-interface.group-id</code> - The ID of the security group associated with the network interface.</p>\n </li>\n <li>\n <p><code>launch.network-interface.group-name</code> - The name of the security group associated with the network interface.</p>\n </li>\n <li>\n <p><code>launch.network-interface.addresses.primary</code> - Indicates whether the IP address is the primary private IP address.</p>\n </li>\n <li>\n <p><code>product-description</code> - The product description associated with the instance (<code>Linux/UNIX</code> | <code>Windows</code>).</p>\n </li>\n <li>\n <p><code>spot-instance-request-id</code> - The Spot Instance request ID.</p>\n </li>\n <li>\n <p><code>spot-price</code> - The maximum hourly price for any Spot Instance launched to fulfill the request.</p>\n </li>\n <li>\n <p><code>state</code> - The state of the Spot Instance request (<code>open</code> | <code>active</code> | <code>closed</code> |\n <code>cancelled</code> | <code>failed</code>).</p>\n </li>\n <li>\n <p><code>status-code</code> - The short code describing the most recent evaluation of your Spot Instance request.</p>\n </li>\n <li>\n <p><code>status-message</code> - The message explaining the status of the Spot Instance request.</p>\n </li>\n <li>\n <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n </li>\n <li>\n <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n </li>\n <li>\n <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n </li>\n <li>\n <p><code>type</code> - The type of Spot Instance request (<code>one-time</code> | <code>persistent</code>).</p>\n </li>\n <li>\n <p><code>launched-availability-zone</code> - The Availability Zone in which the bid is launched.</p>\n </li>\n <li>\n <p><code>valid-from</code> - The start date of the request.</p>\n </li>\n <li>\n <p><code>valid-until</code> - The end date of the request.</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeSpotInstanceRequestsResult",
"type": "structure",
"members": {
"SpotInstanceRequests": {
"shape_name": "SpotInstanceRequestList",
"type": "list",
"members": {
"shape_name": "SpotInstanceRequest",
"type": "structure",
"members": {
"SpotInstanceRequestId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Spot Instance request.</p>\n ",
"xmlname": "spotInstanceRequestId"
},
"SpotPrice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The maximum hourly price for any Spot Instance launched to fulfill the request.</p>\n ",
"xmlname": "spotPrice"
},
"Type": {
"shape_name": "SpotInstanceType",
"type": "string",
"enum": [
"one-time",
"persistent"
],
"documentation": "\n <p>The Spot Instance request type.</p>\n ",
"xmlname": "type"
},
"State": {
"shape_name": "SpotInstanceState",
"type": "string",
"enum": [
"open",
"active",
"closed",
"cancelled",
"failed"
],
"documentation": "\n <p>The state of the Spot Instance request. Spot bid status information can help you track your \n\t\t\t\tSpot Instance requests. For information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-bid-status.html\">Tracking Spot Requests with Bid Status Codes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n ",
"xmlname": "state"
},
"Fault": {
"shape_name": "SpotInstanceStateFault",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason code for the Spot Instance state change.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The message for the Spot Instance state change.</p>\n ",
"xmlname": "message"
}
},
"documentation": "\n <p>The fault codes for the Spot Instance request, if any.</p>\n ",
"xmlname": "fault"
},
"Status": {
"shape_name": "SpotInstanceStatus",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status code of the request.</p>\n ",
"xmlname": "code"
},
"UpdateTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time of the most recent status update.</p>\n ",
"xmlname": "updateTime"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The description for the status code for the Spot request.</p>\n ",
"xmlname": "message"
}
},
"documentation": "\n <p>The status code and status message describing the Spot Instance request.</p>\n ",
"xmlname": "status"
},
"ValidFrom": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The start date of the request. If this is a one-time request, the request becomes\n\t\t\t\tactive at this date and time and remains active until all\n\t\t\t\tinstances launch, the request expires, or the request is\n\t\t\t\tcanceled. If the request is persistent, the request becomes\n\t\t\t\tactive at this date and time and remains active until it expires\n\t\t\t\tor is canceled.</p>\n ",
"xmlname": "validFrom"
},
"ValidUntil": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The end date of the request. If this is a one-time request, the request remains\n\t\t\t\tactive until all instances launch, the request is canceled, or\n\t\t\t\tthis date is reached. If the request is persistent, it remains\n\t\t\t\tactive until it is canceled or this date is reached.</p>\n ",
"xmlname": "validUntil"
},
"LaunchGroup": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The instance launch group. Launch groups are Spot Instances that launch\n\t\t\t\ttogether and terminate together.</p>\n ",
"xmlname": "launchGroup"
},
"AvailabilityZoneGroup": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone group. If you specify the same Availability Zone group\n\t\t\t\tfor all Spot Instance requests, all Spot Instances are launched in the same\n\t\t\t\tAvailability Zone.</p>\n ",
"xmlname": "availabilityZoneGroup"
},
"LaunchSpecification": {
"shape_name": "LaunchSpecification",
"type": "structure",
"members": {
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI.</p>\n ",
"xmlname": "imageId"
},
"KeyName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the key pair.</p>\n ",
"xmlname": "keyName"
},
"SecurityGroups": {
"shape_name": "GroupIdentifierList",
"type": "list",
"members": {
"shape_name": "GroupIdentifier",
"type": "structure",
"members": {
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more security groups.</p>\n ",
"xmlname": "groupSet"
},
"UserData": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Base64-encoded MIME user data to make available to the instances.</p>\n ",
"xmlname": "userData"
},
"AddressingType": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p></p>\n ",
"xmlname": "addressingType"
},
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type.</p>\n ",
"xmlname": "instanceType"
},
"Placement": {
"shape_name": "SpotPlacement",
"type": "structure",
"members": {
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone.</p>\n ",
"xmlname": "availabilityZone"
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone group name.</p>\n ",
"xmlname": "groupName"
}
},
"documentation": "\n <p>The placement information for the instance.</p>\n ",
"xmlname": "placement"
},
"KernelId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the kernel.</p>\n ",
"xmlname": "kernelId"
},
"RamdiskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the RAM disk.</p>\n ",
"xmlname": "ramdiskId"
},
"BlockDeviceMappings": {
"shape_name": "BlockDeviceMappingList",
"type": "list",
"members": {
"shape_name": "BlockDeviceMapping",
"type": "structure",
"members": {
"VirtualName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The virtual device name.</p>\n ",
"xmlname": "virtualName"
},
"DeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name exposed to the instance (for example, <code>/dev/sdh</code>).</p>\n ",
"xmlname": "deviceName"
},
"Ebs": {
"shape_name": "EbsBlockDevice",
"type": "structure",
"members": {
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the snapshot.</p>\n ",
"xmlname": "snapshotId"
},
"VolumeSize": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiB.</p>\n <p>Constraints: If the volume type is <code>io1</code>, the minimum size of the volume is 10 GiB.</p>\n <p>Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.</p>\n ",
"xmlname": "volumeSize"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n ",
"xmlname": "deleteOnTermination"
},
"VolumeType": {
"shape_name": "VolumeType",
"type": "string",
"enum": [
"standard",
"io1",
"gp2"
],
"documentation": "\n <p>The volume type.</p>\n <p>Default: <code>standard</code></p>\n ",
"xmlname": "volumeType"
},
"Iops": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of I/O operations per second (IOPS) that the\n volume supports.</p>\n <p>Constraint: Range is 100 to 4000.</p>\n <p>Condition: Required when the volume type is <code>io1</code>; not used with\n <code>standard</code> or <code>gp2</code> volumes.</p>\n ",
"xmlname": "iops"
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is encrypted.</p>\n ",
"xmlname": "encrypted"
}
},
"documentation": "\n <p>Parameters used to automatically set up Amazon EBS volumes when the instance is launched.</p>\n ",
"xmlname": "ebs"
},
"NoDevice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Suppresses the specified device included in the block device mapping of the AMI.</p>\n ",
"xmlname": "noDevice"
}
},
"documentation": "\n <p>Describes a block device mapping.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more block device mapping entries.</p>\n ",
"xmlname": "blockDeviceMapping"
},
"MonitoringEnabled": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Enables monitoring for the instance.</p>\n <p>Default: Disabled</p>\n ",
"xmlname": "monitoringEnabled"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the subnet in which to launch the Spot Instance.</p>\n ",
"xmlname": "subnetId"
},
"NetworkInterfaces": {
"shape_name": "InstanceNetworkInterfaceSpecificationList",
"type": "list",
"members": {
"shape_name": "InstanceNetworkInterfaceSpecification",
"type": "structure",
"members": {
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"xmlname": "networkInterfaceId"
},
"DeviceIndex": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The index of the device on the instance for the network interface attachment.</p>\n ",
"xmlname": "deviceIndex"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet associated with the network string.</p>\n ",
"xmlname": "subnetId"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The description of the network interface.</p>\n ",
"xmlname": "description"
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP address of the network interface.</p>\n ",
"xmlname": "privateIpAddress"
},
"Groups": {
"shape_name": "SecurityGroupIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "SecurityGroupId"
},
"documentation": "\n\t\t <p>The IDs of the security groups for the network interface.</p>\n ",
"xmlname": "SecurityGroupId"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>If set to <code>true</code>, the interface is deleted when the instance is terminated.</p>\n ",
"xmlname": "deleteOnTermination"
},
"PrivateIpAddresses": {
"shape_name": "PrivateIpAddressSpecificationList",
"type": "list",
"members": {
"shape_name": "PrivateIpAddressSpecification",
"type": "structure",
"members": {
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP addresses.</p>\n ",
"required": true,
"xmlname": "privateIpAddress"
},
"Primary": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the private IP address is the primary private IP address.</p>\n ",
"xmlname": "primary"
}
},
"documentation": "\n\t\t <p>Describes a secondary private IP address for a network interface.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more private IP addresses to assign to the network interface.</p>\n ",
"xmlname": "privateIpAddressesSet"
},
"SecondaryPrivateIpAddressCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The number of secondary private IP addresses.</p>\n ",
"xmlname": "secondaryPrivateIpAddressCount"
},
"AssociatePublicIpAddress": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether to auto-assign a public IP address to an instance in a VPC. This public IP address can be assigned to the network interface for eth0 only when you launch the instance. You must create the network interface instead of using an existing network interface for eth0, and you must not specify more than one network interface.</p>\n ",
"xmlname": "associatePublicIpAddress"
}
},
"documentation": "\n\t\t <p>Describes a network interface.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more network interfaces.</p>\n ",
"xmlname": "networkInterfaceSet"
},
"IamInstanceProfile": {
"shape_name": "IamInstanceProfileSpecification",
"type": "structure",
"members": {
"Arn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Amazon Resource Name (ARN) of the instance profile.</p>\n ",
"xmlname": "arn"
},
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the instance profile.</p>\n ",
"xmlname": "name"
}
},
"documentation": "\n <p>The IAM instance profile.</p>\n ",
"xmlname": "iamInstanceProfile"
},
"EbsOptimized": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal EBS I/O performance. This\n\t\t\t\toptimization isn't available with all instance types. Additional usage\n\t\t\t\tcharges apply when using an EBS Optimized instance.</p>\n <p>Default: <code>false</code></p>\n ",
"xmlname": "ebsOptimized"
}
},
"documentation": "\n <p>Additional information for launching instances.</p>\n ",
"xmlname": "launchSpecification"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The instance ID, if an instance has been launched to fulfill the Spot Instance\n\t\t\t\trequest.</p>\n ",
"xmlname": "instanceId"
},
"CreateTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when the Spot Instance request was created.</p>\n ",
"xmlname": "createTime"
},
"ProductDescription": {
"shape_name": "RIProductDescription",
"type": "string",
"enum": [
"Linux/UNIX",
"Linux/UNIX (Amazon VPC)",
"Windows",
"Windows (Amazon VPC)"
],
"documentation": "\n <p>The product description associated with the Spot Instance.</p>\n ",
"xmlname": "productDescription"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the resource.</p>\n ",
"xmlname": "tagSet"
},
"LaunchedAvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone in which the bid is launched.</p>\n ",
"xmlname": "launchedAvailabilityZone"
}
},
"documentation": "\n <p>Describe a Spot Instance request.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more Spot Instance requests.</p>\n ",
"xmlname": "spotInstanceRequestSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes the Spot Instance requests that belong to your account. Spot Instances\n\t\t\t\tare instances that Amazon EC2 starts on your behalf when the maximum price that you\n\t\t\t\tspecify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price\n\t\t\t\tbased on available Spot Instance capacity and current Spot Instance requests. For\n\t\t\t\tmore information about Spot Instances, see \n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html\">Spot Instances</a> in the\n\t\t\t\t<i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>You can use <code>DescribeSpotInstanceRequests</code> to find a\n\t\t\t\trunning Spot Instance by examining the response. If the status of\n\t\t\t\tthe Spot Instance is <code>fulfilled</code>, the instance ID \n\t\t\t\tappears in the response and contains the identifier of the instance.\n\t\t\t\tAlternatively, you can use <a>DescribeInstances</a> with a filter to\n\t\t\t\tlook for instances where the instance lifecycle is <code>spot</code>.</p>\n <examples>\n <example>\n <name>Example for DescribeSpotInstanceRequests</name>\n <description>This example returns information about current Spot Instance requests.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeSpotInstanceRequests\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeSpotInstanceRequestsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <spotInstanceRequestSet>\n <item>\n <spotInstanceRequestId>sir-1a2b3c4d</spotInstanceRequestId>\n <spotPrice>0.09</spotPrice>\n <type>one-time</type>\n <state>active</state>\n <status>\n <code>fulfilled</code>\n <updateTime>YYYY-MM-DDTHH:MM:SS.000Z</updateTime>\n <message>Your Spot request is fulfilled.</message>\n </status>\n <launchSpecification>\n <imageId>ami-1a2b3c4d</imageId>\n <keyName>my-key-pair</keyName>\n <groupSet>\n <item>\n <groupId>sg-1a2b3c4d</groupId>\n <groupName>websrv</groupName>\n </item>\n </groupSet>\n <instanceType>m1.small</instanceType>\n <monitoring>\n <enabled>false</enabled>\n </monitoring>\n <ebsOptimized>false</ebsOptimized>\n </launchSpecification>\n <instanceId>i-1a2b3c4d</instanceId>\n <createTime>YYYY-MM-DDTHH:MM:SS.000Z</createTime>\n <productDescription>Linux/UNIX</productDescription>\n <launchedAvailabilityZone>us-east-1a</launchedAvailabilityZone>\n </item>\n <spotInstanceRequestSet/>\n<DescribeSpotInstanceRequestsResponse></queryresponse>\n </example>\n <example>\n <name>Example for DescribeInstances</name>\n <description>Alternatively, you can use <a>DescribeInstances as follows</a>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeInstances\n&amp;Filter.1.Name=instance-lifecycle\n&amp;Filter.1.Value.1=spot\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DescribeSpotPriceHistory": {
"name": "DescribeSpotPriceHistory",
"input": {
"shape_name": "DescribeSpotPriceHistoryRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"StartTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The start date and time of the Spot Price history data.</p>\n "
},
"EndTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The end date and time of the Spot Price history data.</p>\n "
},
"InstanceTypes": {
"shape_name": "InstanceTypeList",
"type": "list",
"members": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": null,
"xmlname": "InstanceType"
},
"documentation": "\n <p>One or more instance types.</p>\n ",
"flattened": true
},
"ProductDescriptions": {
"shape_name": "ProductDescriptionList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ProductDescription"
},
"documentation": "\n <p>One or more basic product descriptions.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>availability-zone</code> - The Availability Zone for which prices should be returned.</p>\n </li>\n <li>\n <p><code>instance-type</code> - The type of instance (for example, <code>m1.small</code>).</p>\n </li>\n <li>\n <p><code>product-description</code> - The product description for the Spot Price\n (<code>Linux/UNIX</code> | <code>SUSE Linux</code> | <code>Windows</code> | <code>Linux/UNIX (Amazon VPC)</code> | <code>SUSE Linux (Amazon VPC)</code> | <code>Windows (Amazon VPC)</code>).</p>\n </li>\n <li>\n <p><code>spot-price</code> - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).</p>\n </li>\n <li>\n <p><code>timestamp</code> - The timestamp of the Spot Price history (for example, 2010-08-16T05:06:11.000Z). \n You can use wildcards (* and ?). Greater than or less than comparison is not supported.</p>\n </li>\n </ul>\n ",
"flattened": true
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone.</p>\n "
},
"MaxResults": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of rows to return.</p>\n "
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The next set of rows to return.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeSpotPriceHistoryResult",
"type": "structure",
"members": {
"SpotPriceHistory": {
"shape_name": "SpotPriceHistoryList",
"type": "list",
"members": {
"shape_name": "SpotPrice",
"type": "structure",
"members": {
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type.</p>\n ",
"xmlname": "instanceType"
},
"ProductDescription": {
"shape_name": "RIProductDescription",
"type": "string",
"enum": [
"Linux/UNIX",
"Linux/UNIX (Amazon VPC)",
"Windows",
"Windows (Amazon VPC)"
],
"documentation": "\n <p>A general description of the AMI.</p>\n ",
"xmlname": "productDescription"
},
"SpotPrice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The maximum price you will pay to launch one or more Spot Instances.</p>\n ",
"xmlname": "spotPrice"
},
"Timestamp": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The date and time the request was created.</p>\n ",
"xmlname": "timestamp"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone.</p>\n ",
"xmlname": "availabilityZone"
}
},
"documentation": "\n <p>Describes the Spot Price.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The historical Spot Prices.</p>\n ",
"xmlname": "spotPriceHistorySet"
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The string marking the next set of results. This is empty\n\t\t\t\tif there are no more results.</p>\n ",
"xmlname": "nextToken"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes the Spot Price history. Spot Instances are instances that Amazon EC2\n\t\t\t\tstarts on your behalf when the maximum price that you specify exceeds the current\n\t\t\t\tSpot Price. Amazon EC2 periodically sets the Spot Price based on available Spot\n\t\t\t\tInstance capacity and current Spot Instance requests. For more information about\n\t\t\t\tSpot Instances, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html\">Spot\n\t\t\t\tInstances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>When you specify an Availability Zone, this operation describes the price history \n for the specified Availability Zone with the most recent set of prices listed first. \n If you don't specify an Availability Zone, you get the prices across all Availability Zones, \n starting with the most recent set. However, if you're using an API version earlier than 2011-05-15,\n you get the lowest price across the region for the specified time period. The prices \n returned are listed in chronological order, from the oldest to the most recent.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example gets Spot Price history for a particular day in December 2009\n\t\t\t\t\tfor the specified Availability Zone.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeSpotPriceHistory\n&amp;StartTime=2009-12-04T00:00:00.000Z\n&amp;EndTime=2009-12-04T23:59:59.000Z\n&amp;AvailabilityZone=us-east-1a\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeSpotPriceHistoryResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <spotPriceHistorySet>\n <item>\n <instanceType>m1.small</instanceType>\n <productDescription>Linux/UNIX</productDescription>\n <spotPrice>0.287</spotPrice>\n <timestamp>2009-12-04T20:56:05.000Z</timestamp>\n <availabilityZone>us-east-1a</availabilityZone>\n </item>\n <item>\n <instanceType>m1.small</instanceType>\n <productDescription>Windows</productDescription>\n <spotPrice>0.033</spotPrice>\n <timestamp>2009-12-04T22:33:47.000Z</timestamp>\n <availabilityZone>us-east-1a</availabilityZone>\n </item>\n </spotPriceHistorySet>\n <nextToken/>\n</DescribeSpotPriceHistoryResponse></queryresponse>\n </example>\n <example>\n <name>Example with Filters</name>\n <description>This example uses filters to get the same results as the previous example.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeSpotPriceHistory\n&amp;Filter.1.Name=timestamp\n&amp;Filter.1.Value.1=2009-12-04*\n&amp;Filter.2.Name=availability-zone\n&amp;Filter.2.Value.1=us-east-1a\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n ",
"pagination": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "SpotPriceHistory",
"py_input_token": "next_token"
}
},
"DescribeSubnets": {
"name": "DescribeSubnets",
"input": {
"shape_name": "DescribeSubnetsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SubnetIds": {
"shape_name": "SubnetIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "SubnetId"
},
"documentation": "\n\t\t <p>One or more subnet IDs.</p>\n\t\t <p>Default: Describes all your subnets.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>availabilityZone</code> - The Availability Zone for the subnet. You can also use\n\t\t\t\t\t\t<code>availability-zone</code> as the filter name.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>available-ip-address-count</code> - The number of IP addresses in the subnet that are available.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>cidrBlock</code> - The CIDR block of the subnet. The CIDR block you specify must\n\t\t\t\t\texactly match the subnet's CIDR block for information to be returned for the subnet. You\n\t\t\t\t\tcan also use <code>cidr</code> or <code>cidr-block</code> as the filter names.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>defaultForAz</code> - Indicates whether this is the default subnet for the\n\t\t\t\t\tAvailability Zone. You can also use <code>default-for-az</code> as the filter name.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>state</code> - The state of the subnet (<code>pending</code> | <code>available</code>).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>subnet-id</code> - The ID of the subnet.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>vpc-id</code> - The ID of the VPC for the subnet.</p>\n\t\t </li>\n\t\t </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeSubnetsResult",
"type": "structure",
"members": {
"Subnets": {
"shape_name": "SubnetList",
"type": "list",
"members": {
"shape_name": "Subnet",
"type": "structure",
"members": {
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet.</p>\n ",
"xmlname": "subnetId"
},
"State": {
"shape_name": "SubnetState",
"type": "string",
"enum": [
"pending",
"available"
],
"documentation": "\n\t\t <p>The current state of the subnet.</p>\n ",
"xmlname": "state"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC the subnet is in.</p>\n ",
"xmlname": "vpcId"
},
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR block assigned to the subnet.</p>\n ",
"xmlname": "cidrBlock"
},
"AvailableIpAddressCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The number of unused IP addresses in the subnet. Note that the IP addresses for any\n\t\t\t\tstopped instances are considered unavailable.</p>\n ",
"xmlname": "availableIpAddressCount"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Availability Zone of the subnet.</p>\n ",
"xmlname": "availabilityZone"
},
"DefaultForAz": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether this is the default subnet for the Availability Zone.</p>\n ",
"xmlname": "defaultForAz"
},
"MapPublicIpOnLaunch": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether instances launched in this subnet receive a public IP address.</p>\n ",
"xmlname": "mapPublicIpOnLaunch"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the subnet.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n\t\t <p>Describes a subnet.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Information about one or more subnets.</p>\n ",
"xmlname": "subnetSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Describes one or more of your subnets.</p>\n\t\t <p>For more information about subnets, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html\">Your VPC and Subnets</a>\n\t\t\t in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes the subnets with the IDs <code>subnet-9d4a7b6c</code> and\n\t\t\t\t\t<code>subnet-6e7f829e</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeSubnets\n&amp;SubnetId.1=subnet-9d4a7b6c\n&amp;SubnetId.2=subnet-6e7f829e\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeSubnetsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;subnetSet&gt;\n &lt;item&gt;\n &lt;subnetId&gt;subnet-9d4a7b6c&lt;/subnetId&gt;\n &lt;state&gt;available&lt;/state&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&lt;/vpcId&gt;\n &lt;cidrBlock&gt;10.0.1.0/24&lt;/cidrBlock&gt;\n &lt;availableIpAddressCount&gt;251&lt;/availableIpAddressCount&gt;\n &lt;availabilityZone&gt;us-east-1a&lt;/availabilityZone&gt;\n &lt;defaultForAz&gt;false&lt;/defaultForAz&gt;\n &lt;mapPublicIpOnLaunch&gt;false&lt;/mapPublicIpOnLaunch&gt;\n &lt;tagSet/&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;subnetId&gt;subnet-6e7f829e&lt;/subnetId&gt;\n &lt;state&gt;available&lt;/state&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&gt;/vpcId&gt;\n &lt;cidrBlock&gt;10.0.0.0/24&lt;/cidrBlock&gt; \n &lt;availableIpAddressCount&gt;251&lt;/availableIpAddressCount&gt;\n &lt;availabilityZone&gt;us-east-1a&lt;/availabilityZone&gt;\n &lt;defaultForAz&gt;false&lt;/defaultForAz&gt;\n &lt;mapPublicIpOnLaunch&gt;false&lt;/mapPublicIpOnLaunch&gt;\n &lt;tagSet/&gt;\n &lt;/item&gt;\n &lt;subnetSet/&gt;\n&lt;/DescribeSubnetsResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example uses filters to describe any subnet you own that is\n\t\t\t\t\tin the VPC with the ID <code>vpc-1a2b3c4d</code> or <code>vpc-6e7f8a92</code>, and whose state is\n\t\t\t\t\t<code>available</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeSubnets\t\t\t\t\t\t\n&amp;Filter.1.Name=vpc-id\n&amp;Filter.1.Value.1=vpc-1a2b3c4d\n&amp;Filter.1.Value.2=vpc-6e7f8a92\n&amp;Filter.2.Name=state\n&amp;Filter.2.Value.1=available\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DescribeTags": {
"name": "DescribeTags",
"input": {
"shape_name": "DescribeTagsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>key</code> - The tag key.</p>\n </li>\n <li>\n <p><code>resource-id</code> - The resource ID.</p>\n </li>\n <li>\n <p><code>resource-type</code> - The resource type \n (<code>customer-gateway</code> |\n <code>dhcp-options</code> |\n <code>image</code> |\n <code>instance</code> |\n <code>internet-gateway</code> | \n <code>network-acl</code> | \n <code>network-interface</code> | \n <code>reserved-instances</code> | \n <code>route-table</code> | \n <code>security-group</code> | \n <code>snapshot</code> | <code>spot-instances-request</code> | \n <code>subnet</code> |\n <code>volume</code> | <code>vpc</code> |\n <code>vpn-connection</code> |\n <code>vpn-gateway</code>).</p>\n </li>\n <li>\n <p><code>value</code> - The tag value.</p>\n </li>\n </ul>\n ",
"flattened": true
},
"MaxResults": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.</p>\n "
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The token for the next set of items to return. (You received this token from a prior call.)</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeTagsResult",
"type": "structure",
"members": {
"Tags": {
"shape_name": "TagDescriptionList",
"type": "list",
"members": {
"shape_name": "TagDescription",
"type": "structure",
"members": {
"ResourceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the resource. For example, <code>ami-1a2b3c4d</code>.</p>\n ",
"xmlname": "resourceId"
},
"ResourceType": {
"shape_name": "ResourceType",
"type": "string",
"enum": [
"customer-gateway",
"dhcp-options",
"image",
"instance",
"internet-gateway",
"network-acl",
"network-interface",
"reserved-instances",
"route-table",
"snapshot",
"spot-instances-request",
"subnet",
"security-group",
"volume",
"vpc",
"vpn-connection",
"vpn-gateway"
],
"documentation": "\n <p>The type of resource.</p>\n ",
"xmlname": "resourceType"
},
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag.</p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>A list of tags.</p>\n ",
"xmlname": "tagSet"
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>\n ",
"xmlname": "nextToken"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes one or more of the tags for your EC2 resources.</p>\n <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging Your Resources</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes all the tags in your account.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeTags\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeTagsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <tagSet>\n <item>\n <resourceId>ami-1a2b3c4d</resourceId>\n <resourceType>image</resourceType>\n <key>webserver</key>\n <value/>\n </item>\n <item>\n <resourceId>ami-1a2b3c4d</resourceId>\n <resourceType>image</resourceType>\n <key>stack</key>\n <value>Production</value>\n </item>\n <item>\n <resourceId>i-5f4e3d2a</resourceId>\n <resourceType>instance</resourceType>\n <key>webserver</key>\n <value/>\n </item>\n <item>\n <resourceId>i-5f4e3d2a</resourceId>\n <resourceType>instance</resourceType>\n <key>stack</key>\n <value>Production</value>\n </item>\n <item>\n <resourceId>i-12345678</resourceId>\n <resourceType>instance</resourceType>\n <key>database_server</key>\n <value/>\n </item>\n <item> \n <resourceId>i-12345678</resourceId>\n <resourceType>instance</resourceType>\n <key>stack</key>\n <value>Test</value>\n </item>\n </tagSet>\n</DescribeTagsResponse></queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example describes only the tags for the AMI with ID ami-1a2b3c4d.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeTags\n&amp;Filter.1.Name=resource-id\n&amp;Filter.1.Value.1=ami-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeTagsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <tagSet>\n <item>\n <resourceId>ami-1a2b3c4d</resourceId>\n <resourceType>image</resourceType>\n <key>webserver</key>\n <value/>\n </item>\n <item>\n <resourceId>ami-1a2b3c4d</resourceId>\n <resourceType>image</resourceType>\n <key>stack</key>\n <value>Production</value>\n </item>\n </tagSet>\n</DescribeTagsResponse></queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example describes the tags for all your instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeTags\n&amp;Filter.1.Name=resource-type\n&amp;Filter.1.Value.1=instance\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeTagsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <tagSet>\n <item>\n <resourceId>i-5f4e3d2a</resourceId>\n <resourceType>instance</resourceType>\n <key>webserver</key>\n <value/>\n </item>\n <item>\n <resourceId>i-5f4e3d2a</resourceId>\n <resourceType>instance</resourceType>\n <key>stack</key>\n <value>Production</value>\n </item>\n <item>\n <resourceId>i-12345678</resourceId>\n <resourceType>instance</resourceType>\n <key>database_server</key>\n <value/>\n </item>\n <item>\n <resourceId>i-12345678</resourceId>\n <resourceType>instance</resourceType>\n <key>stack</key>\n <value>Test</value>\n </item>\n </tagSet>\n</DescribeTagsResponse></queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example describes the tags for all your instances tagged with the key\n <i>webserver</i>. Note that you can use wildcards with\n filters, so you could specify the value as <code>?ebserver</code> to\n find tags with the key <i>webserver</i> or\n <i>Webserver</i>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeTags\n&amp;Filter.1.Name=key\n&amp;Filter.1.Value.1=webserver\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeTagsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <tagSet>\n <item>\n <resourceId>i-5f4e3d2a</resourceId>\n <resourceType>instance</resourceType>\n <key>webserver</key>\n <value/>\n </item>\n </tagSet>\n</DescribeTagsResponse></queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example describes the tags for all your instances tagged with either\n stack=Test or stack=Production.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeTags\n&amp;Filter.1.Name=resource-type\n&amp;Filter.1.Value.1=instance\n&amp;Filter.2.Name=key\n&amp;Filter.2.Value.1=stack\n&amp;Filter.3.Name=value\n&amp;Filter.3.Value.1=Test\n&amp;Filter.3.Value.2=Production\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeTagsResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> \n <tagSet>\n <item>\n <resourceId>i-5f4e3d2a</resourceId>\n <resourceType>instance</resourceType>\n <key>stack</key>\n <value>Production</value>\n </item>\n <item>\n <resourceId>i-12345678</resourceId>\n <resourceType>instance</resourceType>\n <key>stack</key>\n <value>Test</value>\n </item>\n </tagSet>\n</DescribeTagsResponse></queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example describes the tags for all your instances tagged with Purpose=[empty\n string].</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeTags\n&amp;Filter.1.Name=resource-type\n&amp;Filter.1.Value.1=instance\n&amp;Filter.2.Name=key\n&amp;Filter.2.Value.1=Purpose\n&amp;Filter.3.Name=value\n&amp;Filter.3.Value.1=\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n ",
"pagination": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Tags",
"py_input_token": "next_token"
}
},
"DescribeVolumeAttribute": {
"name": "DescribeVolumeAttribute",
"input": {
"shape_name": "DescribeVolumeAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"required": true
},
"Attribute": {
"shape_name": "VolumeAttributeName",
"type": "string",
"enum": [
"autoEnableIO",
"productCodes"
],
"documentation": "\n <p>The instance attribute.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeVolumeAttributeResult",
"type": "structure",
"members": {
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"xmlname": "volumeId"
},
"AutoEnableIO": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n <p>The state of <code>autoEnableIO</code> attribute.</p>\n ",
"xmlname": "autoEnableIO"
},
"ProductCodes": {
"shape_name": "ProductCodeList",
"type": "list",
"members": {
"shape_name": "ProductCode",
"type": "structure",
"members": {
"ProductCodeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The product code.</p>\n ",
"xmlname": "productCode"
},
"ProductCodeType": {
"shape_name": "ProductCodeValues",
"type": "string",
"enum": [
"devpay",
"marketplace"
],
"documentation": "\n <p>The type of product code.</p>\n ",
"xmlname": "type"
}
},
"documentation": "\n <p>Describes a product code.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>A list of product codes.</p>\n ",
"xmlname": "productCodes"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes the specified attribute of the specified volume. You can specify only one attribute\n at a time.</p>\n <p>For more information about Amazon EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes the <code>autoEnableIO</code> attribute of the volume\n vol-12345678.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVolumeAttribute\n&amp;Attribute=autoEnableIO\n&amp;VolumeId=vol-12345678\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeVolumeAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE&lt;/requestId&gt; \n &lt;volumeId&gt;vol-12345678&lt;/volumeId&gt;\n &lt;autoEnableIO&gt;\n &lt;value&gt;false&lt;/value&gt;\n &lt;/autoEnableIO&gt;\n&lt;/DescribeVolumeAttributeResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example describes the <code>productCodes</code> attribute of the volume\n vol-12345678.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVolumeAttribute\n&amp;Attribute=productCodes\n&amp;VolumeId=vol-12345678\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeVolumeAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE&lt;/requestId&gt; \n &lt;volumeId&gt;vol-12345678&lt;/volumeId&gt;\n &lt;productCodes&gt;\n &lt;item&gt;\n &lt;productCode&gt;a1b2c3d4e5f6g7h8i9j10k11&lt;/productCode&gt;\n &lt;type&gt;marketplace&lt;/type&gt;\n &lt;/item&gt;\n &lt;/productCodes&gt;\n&lt;/DescribeVolumeAttributeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DescribeVolumeStatus": {
"name": "DescribeVolumeStatus",
"input": {
"shape_name": "DescribeVolumeStatusRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VolumeIds": {
"shape_name": "VolumeIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "VolumeId"
},
"documentation": "\n <p>One or more volume IDs.</p>\n <p>Default: Describes all your volumes.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>action.code</code> - The action code for the event (for example, <code>enable-volume-io</code>).</p>\n </li>\n <li>\n <p><code>action.description</code> - A description of the action.</p>\n </li>\n <li>\n <p><code>action.event-id</code> - The event ID associated with the action.</p>\n </li>\n <li>\n <p><code>availability-zone</code> - The Availability Zone of the instance.</p>\n </li>\n <li>\n <p><code>event.description</code> - A description of the event.</p>\n </li>\n <li>\n <p><code>event.event-id</code> - The event ID.</p>\n </li>\n <li>\n <p><code>event.event-type</code> - The event type (for <code>io-enabled</code>: <code>passed</code> | <code>failed</code>;\n for <code>io-performance</code>: <code>io-performance:degraded</code> | <code>io-performance:severely-degraded</code> | <code>io-performance:stalled</code>).</p>\n </li>\n <li>\n <p><code>event.not-after</code> - The latest end time for the event.</p>\n </li>\n <li>\n <p><code>event.not-before</code> - The earliest start time for the event.</p>\n </li>\n <li>\n <p><code>volume-status.details-name</code> - The cause for <code>volume-status.status</code> (<code>io-enabled</code> | <code>io-performance</code>).</p>\n </li>\n <li>\n <p><code>volume-status.details-status</code> - The status of <code>volume-status.details-name</code> (for <code>io-enabled</code>: <code>passed</code> | <code>failed</code>;\n for <code>io-performance</code>: <code>normal</code> | <code>degraded</code> | <code>severely-degraded</code> | <code>stalled</code>).</p>\n </li>\n <li>\n <p><code>volume-status.status</code> - The status of the volume (<code>ok</code> | <code>impaired</code> | <code>warning</code> | <code>insufficient-data</code>).</p>\n </li>\n </ul>\n ",
"flattened": true
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The next paginated set of results to return using the pagination token\n returned by a previous call.</p>\n "
},
"MaxResults": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The maximum number of paginated volume items per response.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeVolumeStatusResult",
"type": "structure",
"members": {
"VolumeStatuses": {
"shape_name": "VolumeStatusList",
"type": "list",
"members": {
"shape_name": "VolumeStatusItem",
"type": "structure",
"members": {
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The volume ID.</p>\n ",
"xmlname": "volumeId"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone of the volume.</p>\n ",
"xmlname": "availabilityZone"
},
"VolumeStatus": {
"shape_name": "VolumeStatusInfo",
"type": "structure",
"members": {
"Status": {
"shape_name": "VolumeStatusInfoStatus",
"type": "string",
"enum": [
"ok",
"impaired",
"insufficient-data"
],
"documentation": "\n <p>The status of the volume.</p>\n ",
"xmlname": "status"
},
"Details": {
"shape_name": "VolumeStatusDetailsList",
"type": "list",
"members": {
"shape_name": "VolumeStatusDetails",
"type": "structure",
"members": {
"Name": {
"shape_name": "VolumeStatusName",
"type": "string",
"enum": [
"io-enabled",
"io-performance"
],
"documentation": "\n <p>The name of the volume status.</p>\n ",
"xmlname": "name"
},
"Status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The intended status of the volume status.</p>\n ",
"xmlname": "status"
}
},
"documentation": "\n <p>Describes a volume status.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The details of the volume status.</p>\n ",
"xmlname": "details"
}
},
"documentation": "\n <p>The volume status.</p>\n ",
"xmlname": "volumeStatus"
},
"Events": {
"shape_name": "VolumeStatusEventsList",
"type": "list",
"members": {
"shape_name": "VolumeStatusEvent",
"type": "structure",
"members": {
"EventType": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The type of this event.</p>\n ",
"xmlname": "eventType"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description of the event.</p>\n ",
"xmlname": "description"
},
"NotBefore": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The earliest start time of the event.</p>\n ",
"xmlname": "notBefore"
},
"NotAfter": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The latest end time of the event.</p>\n ",
"xmlname": "notAfter"
},
"EventId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of this event.</p>\n ",
"xmlname": "eventId"
}
},
"documentation": "\n <p>Describes a volume status event.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>A list of events associated with the volume.</p>\n ",
"xmlname": "eventsSet"
},
"Actions": {
"shape_name": "VolumeStatusActionsList",
"type": "list",
"members": {
"shape_name": "VolumeStatusAction",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The code identifying the operation, for example, <code>enable-volume-io</code>.</p>\n ",
"xmlname": "code"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description of the operation.</p>\n ",
"xmlname": "description"
},
"EventType": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The event type associated with this operation.</p>\n ",
"xmlname": "eventType"
},
"EventId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the event associated with this operation.</p>\n ",
"xmlname": "eventId"
}
},
"documentation": "\n <p>Describes a volume status operation code.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The details of the operation.</p>\n ",
"xmlname": "actionsSet"
}
},
"documentation": "\n <p>Describes the volume status.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>A list of volumes.</p>\n ",
"xmlname": "volumeStatusSet"
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The next paginated set of results to return.</p>\n ",
"xmlname": "nextToken"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes the status of the specified volumes. Volume status provides the result of the\n checks performed on your volumes to determine events that can impair the performance of your\n volumes. The performance of a volume can be affected if an issue occurs on the volume's\n underlying host. If the volume's underlying host experiences a power outage or system issue,\n after the system is restored, there could be data inconsistencies on the volume. Volume events\n notify you if this occurs. Volume actions notify you if any action needs to be taken in\n response to the event.</p>\n <p>The <code>DescribeVolumeStatus</code> operation provides the following information about the\n specified volumes:</p>\n <p><i>Status</i>: Reflects the current status of the volume. The possible values are\n <code>ok</code>, <code>impaired</code> , <code>warning</code>, or\n <code>insufficient-data</code>. If all checks pass, the overall status of the volume is\n <code>ok</code>. If the check fails, the overall status is <code>impaired</code>. If the\n status is <code>insufficient-data</code>, then the checks may still be taking place on your\n volume at the time. We recommend that you retry the request. For more information on volume status,\n see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html\">Monitoring the Status of Your\n Volumes</a>.</p>\n <p><i>Events</i>: Reflect the cause of a volume status and may require you to take action.\n For example, if your volume returns an <code>impaired</code> status, then the volume event\n might be <code>potential-data-inconsistency</code>. This means that your volume has been\n affected by an issue with the underlying host, has all I/O operations disabled, and may have\n inconsistent data.</p>\n <p><i>Actions</i>: Reflect the actions you may have to take in response to an event. For\n example, if the status of the volume is <code>impaired</code> and the volume event shows\n <code>potential-data-inconsistency</code>, then the action shows\n <code>enable-volume-io</code>. This means that you may want to enable the I/O operations for\n the volume by calling the <a>EnableVolumeIO</a> action and then check the volume for data\n consistency.</p>\n <note>\n <p>Volume status is based on the volume status checks, and does not reflect the volume state.\n Therefore, volume status does not indicate volumes in the <code>error</code> state (for\n example, when a volume is incapable of accepting I/O.)</p>\n </note>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes the status of all the volumes associated with your\n account.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVolumeStatus\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><DescribeVolumeStatus xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\">\n <requestId>5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE</requestId>\n <volumeStatusSet>\n <item>\n <VolumeId>vol-11111111</volumeId>\n <availabilityZone>us-east-1d</availabilityZone>\n <volumeStatus>\n <status>ok</status>\n <details>\n <item>\n <name>io-enabled</name>\n <status>passed</status>\n </item>\n </details>\n </volumeStatus>\n </item>\n <item>\n <volumeId>vol-22222222</volumeId>\n <availabilityZone>us-east-1d</availabilityZone>\n <volumeStatus>\n <status>impaired</status>\n <details>\n <item>\n <name>io-enabled</name>\n <status>failed</status>\n </item>\n </details>\n </volumeStatus>\n <eventsSet>\n <item>\n <eventId>evol-61a54008</eventId>\n <eventType>potential-data-inconsistency</eventType>\n <description>THIS IS AN EXAMPLE</description>\n <notBefore>2011-12-01T14:00:00.000Z</notBefore>\n <notAfter>2011-12-01T15:00:00.000Z</notAfter>\n </item>\n </eventsSet>\n <actionsSet>\n <item>\n <code>enable-volume-io</code>\n <eventId> evol-61a54008</eventId>\n <eventType>potential-data-inconsistency</eventType>\n <description>THIS IS AN EXAMPLE</description> \n </item>\n </actionsSet>\n </item>\n </volumeStatusSet>\n</DescribeVolumesStatusResponse>\n</queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example describes all the volumes in the <code>us-east-1d</code>\n Availability Zone with <code>failed</code>\n <code>io-enabled</code> status.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVolumeStatus\n&amp;Filter.1.Name=availability-zone\n&amp;Filter.1.Value.1=us-east-1d\n&amp;Filter.2.Name=volume-status.details-name\n&amp;Filter.2.Value.1=io-enabled\n&amp;Filter.3.Name=volume-status.details-status\n&amp;Filter.3.Value.1=failed\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n ",
"pagination": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "VolumeStatuses",
"py_input_token": "next_token"
}
},
"DescribeVolumes": {
"name": "DescribeVolumes",
"input": {
"shape_name": "DescribeVolumesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VolumeIds": {
"shape_name": "VolumeIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "VolumeId"
},
"documentation": "\n <p>One or more volume IDs.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>attachment.attach-time</code> - The time stamp when the attachment initiated.</p>\n </li>\n <li>\n <p><code>attachment.delete-on-termination</code> - Whether the volume is deleted on instance termination.</p>\n </li>\n <li>\n <p><code>attachment.device</code> - The device name that is exposed to the instance (for example, <code>/dev/sda1</code>).</p>\n </li>\n <li>\n <p><code>attachment.instance-id</code> - The ID of the instance the volume is attached to.</p>\n </li>\n <li>\n <p><code>attachment.status</code> - The attachment state (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</p>\n </li>\n <li>\n <p><code>availability-zone</code> - The Availability Zone in which the volume was created.</p>\n </li>\n <li>\n <p><code>create-time</code> - The time stamp when the volume was created.</p>\n </li>\n <li>\n <p><code>encrypted</code> - The encryption status of the volume.</p>\n </li>\n <li>\n <p><code>size</code> - The size of the volume, in GiB.</p>\n </li>\n <li>\n <p><code>snapshot-id</code> - The snapshot from which the volume was created.</p>\n </li>\n <li>\n <p><code>status</code> - The status of the volume (<code>creating</code> | <code>available</code> | <code>in-use</code> | <code>deleting</code> | <code>deleted</code> | <code>error</code>).</p>\n </li>\n <li>\n <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n </li>\n <li>\n <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n </li>\n <li>\n <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n </li>\n <li>\n <p><code>volume-id</code> - The volume ID.</p>\n </li>\n <li>\n <p><code>volume-type</code> - The Amazon EBS volume type. This can be <code>gp2</code> for\n General Purpose (SSD) volumes, <code>io1</code> for Provisioned IOPS (SSD) volumes, or <code>standard</code> for\n Magnetic volumes.</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeVolumesResult",
"type": "structure",
"members": {
"Volumes": {
"shape_name": "VolumeList",
"type": "list",
"members": {
"shape_name": "Volume",
"type": "structure",
"members": {
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"xmlname": "volumeId"
},
"Size": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiBs.</p>\n ",
"xmlname": "size"
},
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The snapshot from which the volume was created, if applicable.</p>\n ",
"xmlname": "snapshotId"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone for the volume.</p>\n ",
"xmlname": "availabilityZone"
},
"State": {
"shape_name": "VolumeState",
"type": "string",
"enum": [
"creating",
"available",
"in-use",
"deleting",
"deleted",
"error"
],
"documentation": "\n <p>The volume state.</p>\n ",
"xmlname": "status"
},
"CreateTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when volume creation was initiated.</p>\n ",
"xmlname": "createTime"
},
"Attachments": {
"shape_name": "VolumeAttachmentList",
"type": "list",
"members": {
"shape_name": "VolumeAttachment",
"type": "structure",
"members": {
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"xmlname": "volumeId"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"Device": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name.</p>\n ",
"xmlname": "device"
},
"State": {
"shape_name": "VolumeAttachmentState",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n <p>The attachment state of the volume.</p>\n ",
"xmlname": "status"
},
"AttachTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when the attachment initiated.</p>\n ",
"xmlname": "attachTime"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n ",
"xmlname": "deleteOnTermination"
}
},
"documentation": "\n <p>Describes volume attachment details.</p>\n ",
"xmlname": "item"
},
"documentation": "\n ",
"xmlname": "attachmentSet"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the volume.</p>\n ",
"xmlname": "tagSet"
},
"VolumeType": {
"shape_name": "VolumeType",
"type": "string",
"enum": [
"standard",
"io1",
"gp2"
],
"documentation": "\n <p>The volume type. This can be <code>gp2</code> for General Purpose (SSD) volumes, <code>io1</code> for\n Provisioned IOPS (SSD) volumes, or <code>standard</code> for Magnetic volumes.</p>\n ",
"xmlname": "volumeType"
},
"Iops": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of I/O operations per second (IOPS) that the volume supports.</p>\n ",
"xmlname": "iops"
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the volume is encrypted.</p>\n ",
"xmlname": "encrypted"
}
},
"documentation": "\n <p>Describes a volume.</p>\n ",
"xmlname": "item"
},
"documentation": "\n ",
"xmlname": "volumeSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes the specified Amazon EBS volumes.</p>\n <p>For more information about Amazon EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example describes all volumes associated with your account.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVolumes\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeVolumesResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;volumeSet&gt;\n &lt;item&gt;\n &lt;volumeId&gt;vol-1a2b3c4d&lt;/volumeId&gt;\n &lt;size&gt;80&lt;/size&gt;\n &lt;snapshotId/&gt;\n &lt;availabilityZone&gt;us-east-1a&lt;/availabilityZone&gt;\n &lt;status&gt;in-use&lt;/status&gt;\n &lt;createTime&gt;YYYY-MM-DDTHH:MM:SS.SSSZ&lt;/createTime&gt;\n &lt;attachmentSet&gt;\n &lt;item&gt;\n &lt;volumeId&gt;vol-1a2b3c4d&lt;/volumeId&gt;\n &lt;instanceId&gt;i-1a2b3c4d&lt;/instanceId&gt;\n &lt;device&gt;/dev/sdh&lt;/device&gt;\n &lt;status&gt;attached&lt;/status&gt;\n &lt;attachTime&gt;YYYY-MM-DDTHH:MM:SS.SSSZ&lt;/attachTime&gt;\n &lt;deleteOnTermination&gt;false&lt;/deleteOnTermination&gt;\n &lt;/item&gt;\n &lt;/attachmentSet&gt;\n &lt;volumeType&gt;standard&lt;/volumeType&gt;\n &lt;encrypted&gt;true&lt;/encrypted&gt;\n &lt;/item&gt;\n &lt;/volumeSet&gt;\n&lt;/DescribeVolumesResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DescribeVpcAttribute": {
"name": "DescribeVpcAttribute",
"input": {
"shape_name": "DescribeVpcAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"required": true
},
"Attribute": {
"shape_name": "VpcAttributeName",
"type": "string",
"enum": [
"enableDnsSupport",
"enableDnsHostnames"
],
"documentation": "\n\t\t <p>The VPC attribute.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeVpcAttributeResult",
"type": "structure",
"members": {
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"EnableDnsSupport": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n\t\t <p>Indicates whether DNS resolution is enabled for\n\t\t\t\tthe VPC. If this attribute is <code>true</code>, the Amazon DNS server\n\t\t\t\tresolves DNS hostnames for your instances to their corresponding\n\t\t\t\tIP addresses; otherwise, it does not.</p>\n ",
"xmlname": "enableDnsSupport"
},
"EnableDnsHostnames": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n ",
"xmlname": "value"
}
},
"documentation": "\n\t\t <p>Indicates whether the instances launched in the VPC get DNS hostnames.\n\t\t\t\tIf this attribute is <code>true</code>, instances in the VPC get DNS hostnames;\n\t\t\t\totherwise, they do not.</p>\n ",
"xmlname": "enableDnsHostnames"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes the <code>enableDnsSupport</code> attribute of the specified VPC.\n The sample response indicates that DNS resolution is supported.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVpcAttribute\n&amp;VpcId=vpc-1a2b3c4d\n&amp;Attribute=enableDnsSupport\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeVpcAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&lt;/vpcId&gt;\n\u00a0 &lt;enableDnsSupport&gt;\n &lt;value&gt;true&lt;/value&gt;\n &lt;/enableDnsSupport&gt;\n&lt;/DescribeVpcAttributeResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This request describes the <code>enableDnsHostnames</code> attribute of the\n\t\t\t\t\tspecified VPC. The sample response indicates that DNS hostnames are supported.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVpcAttribute\n&amp;VpcId=vpc-1a2b3c4d\n&amp;Attribute=enableDnsHostnames\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeVpcAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&lt;/vpcId&gt;\n\u00a0 &lt;enableDnsHostnames&gt;\n &lt;value&gt;true&lt;/value&gt;\n &lt;/enableDnsHostnames&gt;\n&lt;/DescribeVpcAttributeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DescribeVpcPeeringConnections": {
"name": "DescribeVpcPeeringConnections",
"input": {
"shape_name": "DescribeVpcPeeringConnectionsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpcPeeringConnectionIds": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "VpcPeeringConnectionId"
},
"documentation": "\n <p>One or more VPC peering connection IDs.</p>\n <p>Default: Describes all your VPC peering connections.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n <p>One or more filters.</p>\n <ul>\n <li>\n <p><code>accepter-vpc-info.cidr-block</code> - The CIDR block of the peer VPC.</p>\n </li>\n <li>\n <p><code>accepter-vpc-info.owner-id</code> - The AWS account ID of the owner of the peer\n VPC.</p>\n </li>\n <li>\n <p><code>accepter-vpc-info.vpc-id</code> - The ID of the peer VPC.</p>\n </li>\n <li>\n <p><code>expiration-time</code> - The expiration date and time for the VPC peering\n connection.</p>\n </li>\n <li>\n <p><code>requester-vpc-info.cidr-block</code> - The CIDR block of the requester's\n VPC.</p>\n </li>\n <li>\n <p><code>requester-vpc-info.owner-id</code> - The AWS account ID of the owner of the\n requester VPC.</p>\n </li>\n <li>\n <p><code>requester-vpc-info.vpc-id</code> - The ID of the requester VPC.</p>\n </li>\n <li>\n <p><code>status-code</code> - The status of the VPC peering connection\n (<code>pending-acceptance</code> | <code>failed</code> | <code>expired</code> |\n <code>provisioning</code> | <code>active</code> | <code>deleted</code> |\n <code>rejected</code>).</p>\n </li>\n <li>\n <p><code>status-message</code> - A message that provides more information about the status\n of the VPC peering connection, if applicable.</p>\n </li>\n <li>\n <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n </li>\n <li>\n <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n </li>\n <li>\n <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n </li>\n <li>\n <p><code>vpc-peering-connection-id</code> - The ID of the VPC peering connection.</p>\n </li>\n </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeVpcPeeringConnectionsResult",
"type": "structure",
"members": {
"VpcPeeringConnections": {
"shape_name": "VpcPeeringConnectionList",
"type": "list",
"members": {
"shape_name": "VpcPeeringConnection",
"type": "structure",
"members": {
"AccepterVpcInfo": {
"shape_name": "VpcPeeringConnectionVpcInfo",
"type": "structure",
"members": {
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The CIDR block for the VPC.</p>\n ",
"xmlname": "cidrBlock"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the VPC owner.</p>\n ",
"xmlname": "ownerId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
}
},
"documentation": "\n <p>The information of the peer VPC.</p>\n ",
"xmlname": "accepterVpcInfo"
},
"ExpirationTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time that an unaccepted VPC peering connection will expire.</p>\n ",
"xmlname": "expirationTime"
},
"RequesterVpcInfo": {
"shape_name": "VpcPeeringConnectionVpcInfo",
"type": "structure",
"members": {
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The CIDR block for the VPC.</p>\n ",
"xmlname": "cidrBlock"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID of the VPC owner.</p>\n ",
"xmlname": "ownerId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
}
},
"documentation": "\n <p>The information of the requester VPC.</p>\n ",
"xmlname": "requesterVpcInfo"
},
"Status": {
"shape_name": "VpcPeeringConnectionStateReason",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status of the VPC peering connection.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A message that provides more information about the status, if applicable.</p>\n ",
"xmlname": "message"
}
},
"documentation": "\n <p>The status of the VPC peering connection.</p>\n ",
"xmlname": "status"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the resource.</p>\n ",
"xmlname": "tagSet"
},
"VpcPeeringConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC peering connection.</p>\n ",
"xmlname": "vpcPeeringConnectionId"
}
},
"documentation": "\n <p>Describes a VPC peering connection.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about the VPC peering connections</p>\n ",
"xmlname": "vpcPeeringConnectionSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Describes one or more of your VPC peering connections.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes all of your VPC peering connections.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVpcPeeringConnections\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeVpcPeeringConnectionsResponse xmlns=http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n&lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;vpcPeeringConnectionSet&gt;\n &lt;item&gt;\n &lt;vpcPeeringConnectionId&gt;pcx-111aaa22&lt;/vpcPeeringConnectionId&gt;\n &lt;requesterVpcInfo&gt;\n &lt;ownerId&gt;777788889999&lt;/ownerId&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&lt;/vpcId&gt;\n &lt;cidrBlock&gt;172.31.0.0/16&lt;/cidrBlock&gt;\n &lt;/requesterVpcInfo&gt;\n &lt;accepterVpcInfo&gt;\n &lt;ownerId&gt;123456789012&lt;/ownerId&gt;\n &lt;vpcId&gt;vpc-aa22cc33&lt;/vpcId&gt;\n &lt;/accepterVpcInfo&gt;\"\n &lt;status&gt;\n &lt;code&gt;pending-acceptance&lt;/code&gt;\n &lt;message&gt;Pending Acceptance by 123456789012&lt;/message&gt;\n &lt;/status&gt;\n &lt;expirationTime&gt;2014-02-17T16:00:50.000Z&lt;/expirationTime&gt;\n &lt;tagSet/&gt;\n &lt;/item&gt;\n &lt;/vpcPeeringConnectionSet&gt;\n&lt;/DescribeVpcPeeringConnectionsResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example describes all of your VPC peering connections that are in the\n <code>pending-acceptance</code> state.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVpcPeeringConnections\n&amp;Filter.1.Name=status-code\n&amp;Filter.1.Value=pending-acceptance\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example describes all of your VPC peering connections that have the tag\n <code>Name=Finance</code> or <code>Name=Accounts</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVpcPeeringConnections\n&amp;Filter.1.Name=tag:Name\n&amp;Filter.1.Value.1=Finance\n&amp;Filter.1.Value.2=Accounts\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 4</name>\n <description>This example describes all of the VPC peering connections for your specified VPC,\n <code>vpc-1a2b3c4d</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVpcPeeringConnections\n&amp;Filter.1.Name=requester-vpc-info.vpc-id\n&amp;Filter.1.Value=vpc-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DescribeVpcs": {
"name": "DescribeVpcs",
"input": {
"shape_name": "DescribeVpcsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpcIds": {
"shape_name": "VpcIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "VpcId"
},
"documentation": "\n\t\t <p>One or more VPC IDs.</p>\n\t\t <p>Default: Describes all your VPCs.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>cidr</code> - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>dhcp-options-id</code> - The ID of a set of DHCP options.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>isDefault</code> - Indicates whether the VPC is the default VPC.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>state</code> - The state of the VPC (<code>pending</code> | <code>available</code>).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>vpc-id</code> - The ID of the VPC.</p>\n\t\t </li>\n\t\t </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeVpcsResult",
"type": "structure",
"members": {
"Vpcs": {
"shape_name": "VpcList",
"type": "list",
"members": {
"shape_name": "Vpc",
"type": "structure",
"members": {
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"State": {
"shape_name": "VpcState",
"type": "string",
"enum": [
"pending",
"available"
],
"documentation": "\n\t\t <p>The current state of the VPC.</p>\n ",
"xmlname": "state"
},
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR block for the VPC.</p>\n ",
"xmlname": "cidrBlock"
},
"DhcpOptionsId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the set of DHCP options you've associated with the VPC (or <code>default</code>\n\t\t\t\tif the default options are associated with the VPC).</p>\n ",
"xmlname": "dhcpOptionsId"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the VPC.</p>\n ",
"xmlname": "tagSet"
},
"InstanceTenancy": {
"shape_name": "Tenancy",
"type": "string",
"enum": [
"default",
"dedicated"
],
"documentation": "\n\t\t <p>The allowed tenancy of instances launched into the VPC.</p>\n ",
"xmlname": "instanceTenancy"
},
"IsDefault": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the VPC is the default VPC.</p>\n ",
"xmlname": "isDefault"
}
},
"documentation": "\n\t\t <p>Describes a VPC.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Information about one or more VPCs.</p>\n ",
"xmlname": "vpcSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Describes one or more of your VPCs.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes the specified VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVpcs\n&amp;VpcId.1=vpc-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeVpcsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;vpcSet&gt;\n &lt;item&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&lt;/vpcId&gt;\n &lt;state&gt;available&lt;/state&gt;\n &lt;cidrBlock&gt;10.0.0.0/23&lt;/cidrBlock&gt; \n &lt;dhcpOptionsId&gt;dopt-7a8b9c2d&lt;/dhcpOptionsId&gt; \n &lt;instanceTenancy&gt;default&lt;/instanceTenancy&gt;\n &lt;isDefault&gt;false&lt;/isDefault&gt;\n &lt;tagSet/&gt;\n &lt;/item&gt;\n &lt;/vpcSet&gt;\n&lt;/DescribeVpcsResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example uses filters to describe any VPC you own that uses\n\t\t\t\t\tthe set of DHCP options with the ID <code>dopt-7a8b9c2d</code> or \n\t\t\t\t\t<code>dopt-2b2a3d3c</code> and whose state is <code>available</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVpcs\t\t\t\t\t\n&amp;Filter.1.Name=dhcp-options-id\n&amp;Filter.1.Value.1=dopt-7a8b9c2d\n&amp;Filter.1.Value.2=dopt-2b2a3d3c\n&amp;Filter.2.Name=state\n&amp;Filter.2.Value.1=available\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DescribeVpnConnections": {
"name": "DescribeVpnConnections",
"input": {
"shape_name": "DescribeVpnConnectionsRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpnConnectionIds": {
"shape_name": "VpnConnectionIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "VpnConnectionId"
},
"documentation": "\n\t\t <p>One or more VPN connection IDs.</p>\n\t\t <p>Default: Describes your VPN connections.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>customer-gateway-configuration</code> - The configuration information for the customer gateway.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>customer-gateway-id</code> - The ID of a customer gateway associated with the VPN connection.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>state</code> - The state of the VPN connection (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>option.static-routes-only</code> - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>route.destination-cidr-block</code> - The destination CIDR block. This corresponds to the subnet used in a customer data center.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>bgp-asn</code> - The BGP Autonomous System Number (ASN) associated with a BGP device.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>type</code> - The type of VPN connection. Currently the only supported type is <code>ipsec.1</code>.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>vpn-connection-id</code> - The ID of the VPN connection.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>vpn-gateway-id</code> - The ID of a virtual private gateway associated with the VPN connection.</p>\n\t\t </li>\n\t\t </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeVpnConnectionsResult",
"type": "structure",
"members": {
"VpnConnections": {
"shape_name": "VpnConnectionList",
"type": "list",
"members": {
"shape_name": "VpnConnection",
"type": "structure",
"members": {
"VpnConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPN connection.</p>\n ",
"xmlname": "vpnConnectionId"
},
"State": {
"shape_name": "VpnState",
"type": "string",
"enum": [
"pending",
"available",
"deleting",
"deleted"
],
"documentation": "\n\t\t <p>The current state of the VPN connection.</p>\n ",
"xmlname": "state"
},
"CustomerGatewayConfiguration": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The configuration information for the VPN connection's customer gateway (in the\n\t\t\t\tnative XML format). This element is always present in the\n\t\t\t\t<a>CreateVpnConnection</a> response; however, it's present in the\n\t\t\t\t<a>DescribeVpnConnections</a> response only if the VPN connection is in\n\t\t\t\tthe <code>pending</code> or <code>available</code> state.</p>\n ",
"xmlname": "customerGatewayConfiguration"
},
"Type": {
"shape_name": "GatewayType",
"type": "string",
"enum": [
"ipsec.1"
],
"documentation": "\n\t\t <p>The type of VPN connection.</p>\n ",
"xmlname": "type"
},
"CustomerGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the customer gateway at your end of the VPN connection.</p>\n ",
"xmlname": "customerGatewayId"
},
"VpnGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the virtual private gateway at the AWS side of the VPN connection.</p>\n ",
"xmlname": "vpnGatewayId"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the VPN connection.</p>\n ",
"xmlname": "tagSet"
},
"VgwTelemetry": {
"shape_name": "VgwTelemetryList",
"type": "list",
"members": {
"shape_name": "VgwTelemetry",
"type": "structure",
"members": {
"OutsideIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Internet-routable IP address of the virtual private gateway's outside interface.</p>\n ",
"xmlname": "outsideIpAddress"
},
"Status": {
"shape_name": "TelemetryStatus",
"type": "string",
"enum": [
"UP",
"DOWN"
],
"documentation": "\n\t\t <p>The status of the VPN tunnel.</p>\n ",
"xmlname": "status"
},
"LastStatusChange": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n\t\t <p>The date and time of the last change in status.</p>\n ",
"xmlname": "lastStatusChange"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>If an error occurs, a description of the error.</p>\n ",
"xmlname": "statusMessage"
},
"AcceptedRouteCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The number of accepted routes.</p>\n ",
"xmlname": "acceptedRouteCount"
}
},
"documentation": "\n\t\t <p>Describes telemetry for a VPN tunnel.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Information about the VPN tunnel.</p>\n ",
"xmlname": "vgwTelemetry"
},
"Options": {
"shape_name": "VpnConnectionOptions",
"type": "structure",
"members": {
"StaticRoutesOnly": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the VPN connection uses static routes only. \n\t\t Static routes must be used for devices that don't support BGP.</p>\n ",
"xmlname": "staticRoutesOnly"
}
},
"documentation": "\n\t\t <p>The VPN connection options.</p>\n ",
"xmlname": "options"
},
"Routes": {
"shape_name": "VpnStaticRouteList",
"type": "list",
"members": {
"shape_name": "VpnStaticRoute",
"type": "structure",
"members": {
"DestinationCidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR block associated with the local subnet of the customer data center.</p>\n ",
"xmlname": "destinationCidrBlock"
},
"Source": {
"shape_name": "VpnStaticRouteSource",
"type": "string",
"enum": [
"Static"
],
"documentation": "\n\t\t <p>Indicates how the routes were provided.</p>\n ",
"xmlname": "source"
},
"State": {
"shape_name": "VpnState",
"type": "string",
"enum": [
"pending",
"available",
"deleting",
"deleted"
],
"documentation": "\n\t\t <p>The current state of the static route.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n\t\t <p>Describes a static route for a VPN connection.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>The static routes associated with the VPN connection.</p>\n ",
"xmlname": "routes"
}
},
"documentation": "\n\t\t <p>Describes a VPN connection.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Information about one or more VPN connections.</p>\n ",
"xmlname": "vpnConnectionSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Describes one or more of your VPN connections.</p>\n\t\t <p>For more information about VPN connections, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html\">Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes the specified VPN connection. The response\n\t\t\t\t\tincludes the customer gateway configuration information. Because it's a long set\n\t\t\t\t\tof information, we haven't displayed it here. To see an example of the configuration information,\n\t\t\t\t see the <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/NetworkAdminGuide/\">Amazon Virtual Private Cloud Network Administrator Guide</a>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVpnConnections\n&amp;VpnConnectionId.1=vpn-44a8938f\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeVpnConnectionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;vpnConnectionSet&gt;\n &lt;item&gt;\n &lt;vpnConnectionId&gt;vpn-44a8938f&lt;/vpnConnectionId&gt;\n &lt;state&gt;available&lt;/state&gt;\n &lt;customerGatewayConfiguration&gt;\n ...Customer gateway configuration data in escaped XML format...\n &lt;/customerGatewayConfiguration&gt; \n &lt;type&gt;ipsec.1&lt;/type&gt;\n &lt;customerGatewayId&gt;cgw-b4dc3961&lt;/customerGatewayId&gt;\n &lt;vpnGatewayId&gt;vgw-8db04f81&lt;/vpnGatewayId&gt;\n &lt;tagSet/&gt;\n &lt;/item&gt;\n &lt;/vpnConnectionSet&gt;\n&lt;/DescribeVpnConnectionsResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example describes any VPN connection you own that is associated with the\n\t\t\t\t\tcustomer gateway with ID cgw-b4dc3961, and whose state is either\n\t\t\t\t\t<code>pending</code> or <code>available</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVpnConnections\t\t\t\t\t\t\t\n&amp;Filter.1.Name=customer-gateway-id\n&amp;Filter.1.Value.1=cgw-b4dc3961\n&amp;Filter.2.Name=state\n&amp;Filter.2.Value.1=pending\n&amp;Filter.2.Value.2=available\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DescribeVpnGateways": {
"name": "DescribeVpnGateways",
"input": {
"shape_name": "DescribeVpnGatewaysRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpnGatewayIds": {
"shape_name": "VpnGatewayIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "VpnGatewayId"
},
"documentation": "\n\t\t <p>One or more virtual private gateway IDs.</p>\n\t\t <p>Default: Describes all your virtual private gateways.</p>\n ",
"flattened": true
},
"Filters": {
"shape_name": "FilterList",
"type": "list",
"members": {
"shape_name": "Filter",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the filter.</p>\n "
},
"Values": {
"shape_name": "ValueStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "Value"
},
"documentation": "\n <p>One or more filter values.</p>\n ",
"flattened": true
}
},
"documentation": "\n ",
"xmlname": "Filter"
},
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>attachment.state</code> - The current state of the attachment between the gateway and the VPC (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.vpc-id</code> - The ID of an attached VPC.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>availability-zone</code> - The Availability Zone for the virtual private gateway.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>state</code> - The state of the virtual private gateway (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>type</code> - The type of virtual private gateway. Currently the only supported type is <code>ipsec.1</code>.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>vpn-gateway-id</code> - The ID of the virtual private gateway.</p>\n\t\t </li>\n\t\t </ul>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeVpnGatewaysResult",
"type": "structure",
"members": {
"VpnGateways": {
"shape_name": "VpnGatewayList",
"type": "list",
"members": {
"shape_name": "VpnGateway",
"type": "structure",
"members": {
"VpnGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the virtual private gateway.</p>\n ",
"xmlname": "vpnGatewayId"
},
"State": {
"shape_name": "VpnState",
"type": "string",
"enum": [
"pending",
"available",
"deleting",
"deleted"
],
"documentation": "\n\t\t <p>The current state of the virtual private gateway.</p>\n ",
"xmlname": "state"
},
"Type": {
"shape_name": "GatewayType",
"type": "string",
"enum": [
"ipsec.1"
],
"documentation": "\n\t\t <p>The type of VPN connection the virtual private gateway supports.</p>\n ",
"xmlname": "type"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The Availability Zone where the virtual private gateway was created.</p>\n ",
"xmlname": "availabilityZone"
},
"VpcAttachments": {
"shape_name": "VpcAttachmentList",
"type": "list",
"members": {
"shape_name": "VpcAttachment",
"type": "structure",
"members": {
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"State": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n\t\t <p>The current state of the attachment.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n\t\t <p>Describes an attachment between a virtual private gateway and a VPC.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any VPCs attached to the virtual private gateway.</p>\n ",
"xmlname": "attachments"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Any tags assigned to the virtual private gateway.</p>\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n\t\t <p>Describes a virtual private gateway.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>Information about one or more virtual private gateways.</p>\n ",
"xmlname": "vpnGatewaySet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Describes one or more of your virtual private gateways.</p>\n\t\t <p>For more information about virtual private gateways, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_VPN.html\">Adding an IPsec Hardware VPN\n\t\t\t\tto Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes the specified virtual private gateway.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVpnGateways\n&amp;VpnGatewayId.1=vgw-8db04f81\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DescribeVpnGatewaysResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;vpnGatewaySet&gt;\t\n &lt;item&gt;\n &lt;vpnGatewayId&gt;vgw-8db04f81&lt;/vpnGatewayId&gt;\n &lt;state&gt;available&lt;/state&gt;\n &lt;type&gt;ipsec.1&lt;/type&gt;\n &lt;availabilityZone&gt;us-east-1a&lt;/availabilityZone&gt; \n &lt;attachments&gt;\n &lt;item&gt;\n &lt;vpcId&gt;vpc-1a2b3c4d&lt;vpcId&gt;\n &lt;state&gt;attached&lt;/state&gt;\n &lt;/item&gt;\n &lt;/attachments&gt;\n &lt;tagSet/&gt;\n &lt;/item&gt;\n &lt;/vpnGatewaySet&gt;\n&lt;/DescribeVpnGatewaysResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example uses filters to describe any virtual private gateway you own\n\t\t\t\t\tthat is in the us-east-1a Availability Zone, and whose state is either\n\t\t\t\t\t<code>pending</code> or <code>available</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeVpnGateways\n&amp;Filter.1.Name=availability-zone\n&amp;Filter.1.Value.1=us-east-1a\n&amp;Filter.2.Name=state\n&amp;Filter.2.Value.1=pending\n&amp;Filter.2.Value.2=available\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DetachInternetGateway": {
"name": "DetachInternetGateway",
"input": {
"shape_name": "DetachInternetGatewayRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InternetGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the Internet gateway.</p>\n ",
"required": true
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Detaches an Internet gateway from a VPC, disabling connectivity between the\n\t\t\t\tInternet and the VPC. The VPC must not contain any running instances with Elastic IP\n\t\t\t\taddresses.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>The example detaches the specified Internet gateway from the specified VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DetachInternetGateway\n&amp;InternetGatewayId=igw-eaad4883\n&amp;VpcId=vpc-11ad4878\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DetachInternetGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DetachInternetGatewayResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DetachNetworkInterface": {
"name": "DetachNetworkInterface",
"input": {
"shape_name": "DetachNetworkInterfaceRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"AttachmentId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the attachment.</p>\n ",
"required": true
},
"Force": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Specifies whether to force a detachment.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Detaches a network interface from an instance.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example detaches the specified elastic network interface (ENI).</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DetachNetworkInterface\n&amp;AttachmentId=eni-attach-d94b09b0\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DetachNetworkInterfaceResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;ce540707-0635-46bc-97da-33a8a362a0e8&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/DetachNetworkInterfaceResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DetachVolume": {
"name": "DetachVolume",
"input": {
"shape_name": "DetachVolumeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"required": true
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n "
},
"Device": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name.</p>\n "
},
"Force": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Forces detachment if the previous detachment attempt did not occur cleanly (for example,\n logging into an instance, unmounting the volume, and detaching normally). This option can lead\n to data loss or a corrupted file system. Use this option only as a last resort to detach a\n volume from a failed instance. The instance won't have an opportunity to flush file system\n caches or file system metadata. If you use this option, you must perform file system check and\n repair procedures.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "VolumeAttachment",
"type": "structure",
"members": {
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"xmlname": "volumeId"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"Device": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name.</p>\n ",
"xmlname": "device"
},
"State": {
"shape_name": "VolumeAttachmentState",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n <p>The attachment state of the volume.</p>\n ",
"xmlname": "status"
},
"AttachTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when the attachment initiated.</p>\n ",
"xmlname": "attachTime"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n ",
"xmlname": "deleteOnTermination"
}
},
"documentation": "\n ",
"xmlname": "attachment"
},
"errors": [],
"documentation": "\n <p>Detaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the\n device within your operating system before detaching the volume. Failure to do so results in\n the volume being stuck in a busy state while detaching.</p>\n <p>If an Amazon EBS volume is the root device of an instance, it can't be detached while the\n instance is running. To detach the root volume, stop the instance\n first.</p>\n <p>If the root volume is detached from an instance with an AWS Marketplace product code, then\n the AWS Marketplace product codes from that volume are no longer associated with the\n instance.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html\">Detaching an\n Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description><para>This example detaches volume\n <code>vol-1a2b3c4d</code>.</para></description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DetachVolume\n&amp;VolumeId=vol-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DetachVolumeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;volumeId&gt;vol-1a2b3c4d&lt;/volumeId&gt;\n &lt;instanceId&gt;i-1a2b3c4d&lt;/instanceId&gt;\n &lt;device&gt;/dev/sdh&lt;/device&gt;\n &lt;status&gt;detaching&lt;/status&gt;\n &lt;attachTime&gt;YYYY-MM-DDTHH:MM:SS.000Z&lt;/attachTime&gt;\n&lt;/DetachVolumeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DetachVpnGateway": {
"name": "DetachVpnGateway",
"input": {
"shape_name": "DetachVpnGatewayRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpnGatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the virtual private gateway.</p>\n ",
"required": true
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the\n\t\t\t\tVPC and not use it anymore. You can confirm a virtual private gateway has been completely\n\t\t\t\tdetached from a VPC by describing the virtual private gateway (any attachments to the\n\t\t\t\tvirtual private gateway are also described).</p>\n\t\t <p>You must wait for the attachment's state to switch to <code>detached</code> before\n\t\t\t\tyou can delete the VPC or attach a different VPC to the virtual private gateway.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example detaches the specified virtual private gateway from the specified VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DetachVpnGateway\n&amp;VpnGatewayId=vgw-8db04f81\n&amp;VpcId=vpc-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DetachVpnGatewayResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/DetachVpnGatewayResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DisableVgwRoutePropagation": {
"name": "DisableVgwRoutePropagation",
"input": {
"shape_name": "DisableVgwRoutePropagationRequest",
"type": "structure",
"members": {
"RouteTableId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the routing table.</p>\n ",
"required": true
},
"GatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the virtual private gateway.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Disables a virtual private gateway (VGW) from propagating routes to the routing\n\t\t\t\ttables of a VPC.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example disables the virtual private gateway <code>vgw-d8e09e8a</code>\n\t\t\t\t\tfrom automatically propagating routes to the routing table with ID\n\t\t\t\t\t<code>rtb-c98a35a0</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DisableVgwRoutePropagationResponse\n&amp;RouteTableID=rtb-c98a35a0\n&amp;GatewayId= vgw-d8e09e8a\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DisableVgwRoutePropagationResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;4f35a1b2-c2c3-4093-b51f-abb9d7311990&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/DisableVgwRoutePropagationResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"DisassociateAddress": {
"name": "DisassociateAddress",
"input": {
"shape_name": "DisassociateAddressRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-Classic] The Elastic IP address.</p>\n "
},
"AssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] The association ID.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Disassociates an Elastic IP address from the instance or network interface it's\n\t\t\t\tassociated with.</p>\n <p>This is an idempotent operation. If you perform the operation more than once, Amazon EC2\n\t\t\t\tdoesn't return an error.</p>\n <examples>\n <example>\n <name>Example for EC2-Classic</name>\n <description>This example disassociates the specified Elastic IP address from\n\t\t\t\t\tthe instance in EC2-Classic to which it is associated.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DisassociateAddress\n&amp;PublicIp=192.0.2.1\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example for EC2-VPC</name>\n <description>This example disassociates the specified Elastic IP address from\n\t\t\t\t\t the instance in a VPC to which it is associated.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DisassociateAddress\n&amp;AssociationId=eipassoc-aa7486c3\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"DisassociateRouteTable": {
"name": "DisassociateRouteTable",
"input": {
"shape_name": "DisassociateRouteTableRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"AssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The association ID representing the current association between the route table and subnet.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Disassociates a subnet from a route table.</p>\n\t\t <p>After you perform this action, the subnet no longer uses the routes in the route table.\n\t\t\t\tInstead, it uses the routes in the VPC's main route table. For more information\n\t\t\t\tabout route tables, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html\">Route\n\t\t\t\tTables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example disassociates the specified route table from the subnet it's associated to.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DisassociateRouteTable\n&amp;AssociationId=rtbassoc-fdad4894\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;DisassociateRouteTableResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/DisassociateRouteTableResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"EnableVgwRoutePropagation": {
"name": "EnableVgwRoutePropagation",
"input": {
"shape_name": "EnableVgwRoutePropagationRequest",
"type": "structure",
"members": {
"RouteTableId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the routing table.</p>\n ",
"required": true
},
"GatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the virtual private gateway.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Enables a virtual private gateway (VGW) to propagate routes to the routing tables\n\t\t\t\tof a VPC.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example enables the specified virtual private gateway to propagate\n\t\t\t\t\troutes automatically to the routing table with the ID <code>rtb-c98a35a0</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=EnableVgwRoutePropagation\n&amp;RouteTableID=rtb-c98a35a0\n&amp;GatewayId= vgw-d8e09e8a\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;EnableVgwRoutePropagation xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;4f35a1b2-c2c3-4093-b51f-abb9d7311990&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/EnableVgwRoutePropagation&gt;</queryresponse>\n </example>\n </examples>\n "
},
"EnableVolumeIO": {
"name": "EnableVolumeIO",
"input": {
"shape_name": "EnableVolumeIORequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Enables I/O operations for a volume that had I/O operations disabled because the data on the\n volume was potentially inconsistent.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example enables the I/O operations of the volume\n vol-8888888.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=EnableVolumeIO\n&amp;VolumeId= vol-8888888\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;EnableVolumeIOResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/EnableVolumeIOResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"GetConsoleOutput": {
"name": "GetConsoleOutput",
"input": {
"shape_name": "GetConsoleOutputRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "GetConsoleOutputResult",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"Timestamp": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time the output was last updated.</p>\n ",
"xmlname": "timestamp"
},
"Output": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The console output, Base64 encoded.</p>\n ",
"xmlname": "output"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Gets the console output for the specified instance.</p>\n <p>Instances do not have a physical monitor through which you can view their\n console output. They also lack physical controls that allow you to power up, reboot,\n or shut them down. To allow these actions, we provide them through the Amazon EC2\n API and command line interface.</p>\n\t\t\t<p>Instance console output is buffered and posted shortly after instance boot,\n\t\t\t\treboot, and termination. Amazon EC2 preserves the most recent 64 KB output which\n\t\t\t\tis available for at least one hour after the most recent post.</p>\n\t\t\t<p>For Linux/Unix instances, the instance console output displays the\n\t\t\t\texact console output that would normally be displayed on a physical monitor attached\n\t\t\t\tto a machine. This output is buffered because the instance produces it and then\n\t\t\t\tposts it to a store where the instance's owner can retrieve it.</p>\n\t\t\t<p>For Windows instances, the instance console output displays the last\n\t\t\t\tthree system event log errors.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example retrieves the console output for the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=GetConsoleOutput\n&amp;InstanceId=i-10a64379\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;GetConsoleOutputResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;instanceId&gt;i-28a64341&lt;/instanceId&gt;\n &lt;timestamp&gt;2010-10-14T01:12:41.000Z&lt;/timestamp&gt;\n &lt;output&gt;TGludXggdmVyc2lvbiAyLjYuMTYteGVuVSAoYnVpbGRlckBwYXRjaGJhdC5hbWF6b25zYSkgKGdj\nYyB2ZXJzaW9uIDQuMC4xIDIwMDUwNzI3IChSZWQgSGF0IDQuMC4xLTUpKSAjMSBTTVAgVGh1IE9j\ndCAyNiAwODo0MToyNiBTQVNUIDIwMDYKQklPUy1wcm92aWRlZCBwaHlzaWNhbCBSQU0gbWFwOgpY\nZW46IDAwMDAwMDAwMDAwMDAwMDAgLSAwMDAwMDAwMDZhNDAwMDAwICh1c2FibGUpCjk4ME1CIEhJ\nR0hNRU0gYXZhaWxhYmxlLgo3MjdNQiBMT1dNRU0gYXZhaWxhYmxlLgpOWCAoRXhlY3V0ZSBEaXNh\nYmxlKSBwcm90ZWN0aW9uOiBhY3RpdmUKSVJRIGxvY2t1cCBkZXRlY3Rpb24gZGlzYWJsZWQKQnVp\nbHQgMSB6b25lbGlzdHMKS2VybmVsIGNvbW1hbmQgbGluZTogcm9vdD0vZGV2L3NkYTEgcm8gNApF\nbmFibGluZyBmYXN0IEZQVSBzYXZlIGFuZCByZXN0b3JlLi4uIGRvbmUuCg==&lt;/output&gt;\n&lt;/GetConsoleOutputResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"GetPasswordData": {
"name": "GetPasswordData",
"input": {
"shape_name": "GetPasswordDataRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Windows instance.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "GetPasswordDataResult",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Windows instance.</p>\n ",
"xmlname": "instanceId"
},
"Timestamp": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time the data was last updated.</p>\n ",
"xmlname": "timestamp"
},
"PasswordData": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The password of the instance.</p>\n ",
"xmlname": "passwordData"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t\t<p>Retrieves the encrypted administrator password for an instance running\n\t\t\t\tWindows.</p>\n\t\t\t<p>The Windows password is only generated the first time an AMI is launched.\n\t\t\t\tIt is not generated for rebundled AMIs or after the password is changed on an\n\t\t\t\tinstance.</p>\n\t\t\t<p>The password is encrypted using the key pair that you specified when you launched the instance.\n\t\t\t\tYou must provide the corresponding key pair file.</p>\n\t\t\t<p>Password generation and encryption takes a few moments. We recommend that you wait up to\n\t\t\t\t15 minutes after launching an instance before trying to retrieve the generated\n\t\t\t\tpassword.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example returns the encrypted version of the administrator password for\n\t\t\t\t\tthe specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=GetPasswordData\n&amp;InstanceId=i-10a64379\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;GetPasswordDataResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;instanceId&gt;i-2574e22a&lt;/instanceId&gt;\n &lt;timestamp&gt;2009-10-24 15:00:00&lt;/timestamp&gt;\n &lt;passwordData&gt;TGludXggdmVyc2lvbiAyLjYuMTYteGVuVSAoYnVpbGRlckBwYXRjaGJhdC5hbWF6b25zYSkgKGdj&lt;/passwordData&gt;\n&lt;/GetPasswordDataResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ImportInstance": {
"name": "ImportInstance",
"input": {
"shape_name": "ImportInstanceRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description for the instance being imported.</p>\n "
},
"LaunchSpecification": {
"shape_name": "ImportInstanceLaunchSpecification",
"type": "structure",
"members": {
"Architecture": {
"shape_name": "ArchitectureValues",
"type": "string",
"enum": [
"i386",
"x86_64"
],
"documentation": "\n <p>The architecture of the instance.</p>\n "
},
"GroupNames": {
"shape_name": "SecurityGroupStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "GroupName"
},
"documentation": "\n <p>One or more security group names.</p>\n ",
"flattened": true
},
"AdditionalInfo": {
"shape_name": "String",
"type": "string",
"documentation": "\n "
},
"UserData": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>User data to be made available to the instance.</p>\n "
},
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n "
},
"Placement": {
"shape_name": "Placement",
"type": "structure",
"members": {
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone of the instance.</p>\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the placement group the instance is in (for cluster compute instances).</p>\n "
},
"Tenancy": {
"shape_name": "Tenancy",
"type": "string",
"enum": [
"default",
"dedicated"
],
"documentation": "\n <p>The tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of <code>dedicated</code> runs\n on single-tenant hardware.</p>\n "
}
},
"documentation": "\n "
},
"Monitoring": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] The ID of the subnet to launch the instance\n into.</p>\n "
},
"InstanceInitiatedShutdownBehavior": {
"shape_name": "ShutdownBehavior",
"type": "string",
"enum": [
"stop",
"terminate"
],
"documentation": "\n <p>Indicates whether an instance stops or terminates when you initiate\n shutdown from the instance (using the operating system command for system shutdown).</p>\n "
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] Optionally, you can use this parameter to assign the\n instance a specific available IP address from the IP address range of\n the subnet.</p>\n "
}
},
"documentation": "\n <p></p>\n "
},
"DiskImages": {
"shape_name": "DiskImageList",
"type": "list",
"members": {
"shape_name": "DiskImage",
"type": "structure",
"members": {
"Image": {
"shape_name": "DiskImageDetail",
"type": "structure",
"members": {
"Format": {
"shape_name": "DiskImageFormat",
"type": "string",
"enum": [
"VMDK",
"RAW",
"VHD"
],
"documentation": "\n <p>The disk image format.</p>\n ",
"required": true
},
"Bytes": {
"shape_name": "Long",
"type": "long",
"documentation": "\n ",
"required": true
},
"ImportManifestUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">Authenticating REST Requests</a> topic in the\n <i>Amazon Simple Storage Service Developer Guide</i>.</p>\n ",
"required": true,
"no_paramfile": true
}
},
"documentation": "\n "
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n "
},
"Volume": {
"shape_name": "VolumeDetail",
"type": "structure",
"members": {
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the volume.</p>\n ",
"required": true
}
},
"documentation": "\n "
}
},
"documentation": "\n <p>Describes a disk image.</p>\n ",
"xmlname": "DiskImage"
},
"documentation": "\n ",
"flattened": true
},
"Platform": {
"shape_name": "PlatformValues",
"type": "string",
"enum": [
"Windows"
],
"documentation": "\n <p>The instance operating system.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "ImportInstanceResult",
"type": "structure",
"members": {
"ConversionTask": {
"shape_name": "ConversionTask",
"type": "structure",
"members": {
"ConversionTaskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the conversion task.</p>\n ",
"required": true,
"xmlname": "conversionTaskId"
},
"ExpirationTime": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.</p>\n ",
"xmlname": "expirationTime"
},
"ImportInstance": {
"shape_name": "ImportInstanceTaskDetails",
"type": "structure",
"members": {
"Volumes": {
"shape_name": "ImportInstanceVolumeDetailSet",
"type": "list",
"members": {
"shape_name": "ImportInstanceVolumeDetailItem",
"type": "structure",
"members": {
"BytesConverted": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of bytes converted so far.</p>\n ",
"required": true,
"xmlname": "bytesConverted"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone where the resulting instance will reside.</p>\n ",
"required": true,
"xmlname": "availabilityZone"
},
"Image": {
"shape_name": "DiskImageDescription",
"type": "structure",
"members": {
"Format": {
"shape_name": "DiskImageFormat",
"type": "string",
"enum": [
"VMDK",
"RAW",
"VHD"
],
"documentation": "\n <p>The disk image format.</p>\n ",
"required": true,
"xmlname": "format"
},
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the disk image.</p>\n ",
"required": true,
"xmlname": "size"
},
"ImportManifestUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">Authenticating REST Requests</a> topic in the\n <i>Amazon Simple Storage Service Developer Guide</i>.</p>\n ",
"required": true,
"xmlname": "importManifestUrl"
},
"Checksum": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The checksum computed for the disk image.</p>\n ",
"xmlname": "checksum"
}
},
"documentation": "\n <p>The image.</p>\n ",
"required": true,
"xmlname": "image"
},
"Volume": {
"shape_name": "DiskImageVolumeDescription",
"type": "structure",
"members": {
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the volume.</p>\n ",
"xmlname": "size"
},
"Id": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The volume identifier.</p>\n ",
"required": true,
"xmlname": "id"
}
},
"documentation": "\n <p>The volume.</p>\n ",
"required": true,
"xmlname": "volume"
},
"Status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status of the import of this particular disk image.</p>\n ",
"required": true,
"xmlname": "status"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status information or errors related to the disk image.</p>\n ",
"xmlname": "statusMessage"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n ",
"xmlname": "description"
}
},
"documentation": "\n <p>Describes an import volume task.</p>\n ",
"xmlname": "item"
},
"documentation": "\n ",
"required": true,
"xmlname": "volumes"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n ",
"xmlname": "instanceId"
},
"Platform": {
"shape_name": "PlatformValues",
"type": "string",
"enum": [
"Windows"
],
"documentation": "\n <p>The instance operating system.</p>\n ",
"xmlname": "platform"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n ",
"xmlname": "description"
}
},
"documentation": "\n <p>If the task is for importing an instance, this contains information about the import instance task.</p>\n ",
"xmlname": "importInstance"
},
"ImportVolume": {
"shape_name": "ImportVolumeTaskDetails",
"type": "structure",
"members": {
"BytesConverted": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of bytes converted so far.</p>\n ",
"required": true,
"xmlname": "bytesConverted"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone where the resulting volume will reside.</p>\n ",
"required": true,
"xmlname": "availabilityZone"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The description you provided when starting the import volume task.</p>\n ",
"xmlname": "description"
},
"Image": {
"shape_name": "DiskImageDescription",
"type": "structure",
"members": {
"Format": {
"shape_name": "DiskImageFormat",
"type": "string",
"enum": [
"VMDK",
"RAW",
"VHD"
],
"documentation": "\n <p>The disk image format.</p>\n ",
"required": true,
"xmlname": "format"
},
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the disk image.</p>\n ",
"required": true,
"xmlname": "size"
},
"ImportManifestUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">Authenticating REST Requests</a> topic in the\n <i>Amazon Simple Storage Service Developer Guide</i>.</p>\n ",
"required": true,
"xmlname": "importManifestUrl"
},
"Checksum": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The checksum computed for the disk image.</p>\n ",
"xmlname": "checksum"
}
},
"documentation": "\n <p>The image.</p>\n ",
"required": true,
"xmlname": "image"
},
"Volume": {
"shape_name": "DiskImageVolumeDescription",
"type": "structure",
"members": {
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the volume.</p>\n ",
"xmlname": "size"
},
"Id": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The volume identifier.</p>\n ",
"required": true,
"xmlname": "id"
}
},
"documentation": "\n <p>The volume.</p>\n ",
"required": true,
"xmlname": "volume"
}
},
"documentation": "\n <p>If the task is for importing a volume, this contains information about the import volume task.</p>\n ",
"xmlname": "importVolume"
},
"State": {
"shape_name": "ConversionTaskState",
"type": "string",
"enum": [
"active",
"cancelling",
"cancelled",
"completed"
],
"documentation": "\n <p>The state of the conversion task.</p>\n ",
"required": true,
"xmlname": "state"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status message related to the conversion task.</p>\n ",
"xmlname": "statusMessage"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n ",
"xmlname": "conversionTask"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Creates an import instance task using metadata from the specified disk image. After\n importing the image, you then upload it using the <function>ec2-import-volume</function> command in the EC2 command line\n tools. For more information, see <ulink url=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html\">Using the Command Line\n Tools to Import Your Virtual Machine to Amazon EC2</ulink> in the\n <emphasis>Amazon Elastic Compute Cloud User Guide</emphasis>.</p>\n \n \n <examples>\n <example>\n <name>Example</name>\n <description>This example creates an import instance task that migrates a Windows Server\n 2008 SP2 (32-bit) VM into the AWS <code>us-east-1</code> region.</description> \n <queryrequest>https://ec2.amazonaws.com/?Action=ImportInstance\n &amp;LaunchSpecification.Architecture=x86_64\n &amp;LaunchSpecification.InstanceType=m1.xlarge\n &amp;DiskImage.1.Image.Format=VMDK\n &amp;DiskImage.1.Image.Bytes=1179593728\n &amp;DiskImage.1.Image.ImportManifestUrl=https://s3.amazonaws.com/myawsbucket/\u200ba3a5e1b6-590d-43cc-97c1-15c7325d3f41/\u200bWin_2008_Server_Data_Center_SP2_32-bit.\u200bvmdkmanifest.xml?AWSAccessKeyId=\u200bAKIAIOSFODNN7EXAMPLE&amp;\u200bExpires=1294855591&amp;\u200bSignature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n &amp;DiskImage.1.Volume.Size=12\t\n &amp;Platform=Windows\n &amp;AUTHPARAMS</queryrequest>\n <queryresponse><ImportInstanceResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <conversionTask>\n <conversionTaskId>import-i-ffvko9js</conversionTaskId>\n <expirationTime>2010-12-22T12:01Z</expirationTime>\n <importInstance>\n <volumes>\n <item>\n <bytesConverted>0</bytesConverted>\n <availabilityZone>us-east-1a</availabilityZone>\n <image>\n <format>VMDK</format>\n <size>1179593728</size>\n <importManifestUrl>\n https://s3.amazonaws.com/myawsbucket/\u200ba3a5e1b6-590d-43cc-97c1-15c7325d3f41/\u200bWin_2008_Server_Data_Center_SP2_32-bit.\u200bvmdkmanifest.xml?AWSAccessKeyId=\u200bAKIAIOSFODNN7EXAMPLE&amp;\u200bExpires=1294855591&amp;\u200bSignature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n </importManifestUrl>\n </image>\n <description/>\n <volume>\n <size>12</size>\n <id>vol-1a2b3c4d</id>\n </volume>\n <status>active</status>\n <statusMessage/>\n </item>\n </volumes>\n <instanceId>i-12655a7f</instanceId>\n <description/>\n </importInstance>\n </conversionTask>\n</ImportInstanceResponse></queryresponse>\n </example>\n </examples>\n "
},
"ImportKeyPair": {
"name": "ImportKeyPair",
"input": {
"shape_name": "ImportKeyPairRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"KeyName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A unique name for the key pair.</p>\n ",
"required": true
},
"PublicKeyMaterial": {
"shape_name": "String",
"type": "blob",
"documentation": "\n <p>The public key. You must base64 encode the public key material before sending it to AWS.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "ImportKeyPairResult",
"type": "structure",
"members": {
"KeyName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key pair name you provided.</p>\n ",
"xmlname": "keyName"
},
"KeyFingerprint": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The MD5 public key fingerprint as specified in section 4 of RFC 4716.</p>\n ",
"xmlname": "keyFingerprint"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Imports the public key from an RSA key pair that you created with a third-party tool. \n Compare this with <a>CreateKeyPair</a>, in which AWS creates the key pair and gives the keys to you \n (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. \n The private key is never transferred between you and AWS.</p>\n <p>For more information about key pairs, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Key Pairs</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example imports the public key named my-key-pair.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ImportKeyPair\n&amp;KeyName=my-key-pair\n&amp;PublicKeyMaterial=MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6\nb24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd\nBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN\nMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD\nVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z\nb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt\nYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ\n21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T\nrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE\nIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4\nnUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb\nFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb\nNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ImportKeyPairResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n\t&lt;keyName&gt;my-key-pair&lt;/keyName&gt;\n\t&lt;keyFingerprint&gt;1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f&lt;/keyFingerprint&gt;\n&lt;/ImportKeyPairResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ImportVolume": {
"name": "ImportVolume",
"input": {
"shape_name": "ImportVolumeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone for the resulting Amazon EBS\n volume.</p>\n "
},
"Image": {
"shape_name": "DiskImageDetail",
"type": "structure",
"members": {
"Format": {
"shape_name": "DiskImageFormat",
"type": "string",
"enum": [
"VMDK",
"RAW",
"VHD"
],
"documentation": "\n <p>The disk image format.</p>\n ",
"required": true
},
"Bytes": {
"shape_name": "Long",
"type": "long",
"documentation": "\n ",
"required": true
},
"ImportManifestUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">Authenticating REST Requests</a> topic in the\n <i>Amazon Simple Storage Service Developer Guide</i>.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>An optional description for the volume being imported.</p>\n "
},
"Volume": {
"shape_name": "VolumeDetail",
"type": "structure",
"members": {
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the volume.</p>\n ",
"required": true
}
},
"documentation": "\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "ImportVolumeResult",
"type": "structure",
"members": {
"ConversionTask": {
"shape_name": "ConversionTask",
"type": "structure",
"members": {
"ConversionTaskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the conversion task.</p>\n ",
"required": true,
"xmlname": "conversionTaskId"
},
"ExpirationTime": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.</p>\n ",
"xmlname": "expirationTime"
},
"ImportInstance": {
"shape_name": "ImportInstanceTaskDetails",
"type": "structure",
"members": {
"Volumes": {
"shape_name": "ImportInstanceVolumeDetailSet",
"type": "list",
"members": {
"shape_name": "ImportInstanceVolumeDetailItem",
"type": "structure",
"members": {
"BytesConverted": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of bytes converted so far.</p>\n ",
"required": true,
"xmlname": "bytesConverted"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone where the resulting instance will reside.</p>\n ",
"required": true,
"xmlname": "availabilityZone"
},
"Image": {
"shape_name": "DiskImageDescription",
"type": "structure",
"members": {
"Format": {
"shape_name": "DiskImageFormat",
"type": "string",
"enum": [
"VMDK",
"RAW",
"VHD"
],
"documentation": "\n <p>The disk image format.</p>\n ",
"required": true,
"xmlname": "format"
},
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the disk image.</p>\n ",
"required": true,
"xmlname": "size"
},
"ImportManifestUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">Authenticating REST Requests</a> topic in the\n <i>Amazon Simple Storage Service Developer Guide</i>.</p>\n ",
"required": true,
"xmlname": "importManifestUrl"
},
"Checksum": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The checksum computed for the disk image.</p>\n ",
"xmlname": "checksum"
}
},
"documentation": "\n <p>The image.</p>\n ",
"required": true,
"xmlname": "image"
},
"Volume": {
"shape_name": "DiskImageVolumeDescription",
"type": "structure",
"members": {
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the volume.</p>\n ",
"xmlname": "size"
},
"Id": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The volume identifier.</p>\n ",
"required": true,
"xmlname": "id"
}
},
"documentation": "\n <p>The volume.</p>\n ",
"required": true,
"xmlname": "volume"
},
"Status": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status of the import of this particular disk image.</p>\n ",
"required": true,
"xmlname": "status"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status information or errors related to the disk image.</p>\n ",
"xmlname": "statusMessage"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n ",
"xmlname": "description"
}
},
"documentation": "\n <p>Describes an import volume task.</p>\n ",
"xmlname": "item"
},
"documentation": "\n ",
"required": true,
"xmlname": "volumes"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n ",
"xmlname": "instanceId"
},
"Platform": {
"shape_name": "PlatformValues",
"type": "string",
"enum": [
"Windows"
],
"documentation": "\n <p>The instance operating system.</p>\n ",
"xmlname": "platform"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n ",
"xmlname": "description"
}
},
"documentation": "\n <p>If the task is for importing an instance, this contains information about the import instance task.</p>\n ",
"xmlname": "importInstance"
},
"ImportVolume": {
"shape_name": "ImportVolumeTaskDetails",
"type": "structure",
"members": {
"BytesConverted": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The number of bytes converted so far.</p>\n ",
"required": true,
"xmlname": "bytesConverted"
},
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone where the resulting volume will reside.</p>\n ",
"required": true,
"xmlname": "availabilityZone"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The description you provided when starting the import volume task.</p>\n ",
"xmlname": "description"
},
"Image": {
"shape_name": "DiskImageDescription",
"type": "structure",
"members": {
"Format": {
"shape_name": "DiskImageFormat",
"type": "string",
"enum": [
"VMDK",
"RAW",
"VHD"
],
"documentation": "\n <p>The disk image format.</p>\n ",
"required": true,
"xmlname": "format"
},
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the disk image.</p>\n ",
"required": true,
"xmlname": "size"
},
"ImportManifestUrl": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html\">Authenticating REST Requests</a> topic in the\n <i>Amazon Simple Storage Service Developer Guide</i>.</p>\n ",
"required": true,
"xmlname": "importManifestUrl"
},
"Checksum": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The checksum computed for the disk image.</p>\n ",
"xmlname": "checksum"
}
},
"documentation": "\n <p>The image.</p>\n ",
"required": true,
"xmlname": "image"
},
"Volume": {
"shape_name": "DiskImageVolumeDescription",
"type": "structure",
"members": {
"Size": {
"shape_name": "Long",
"type": "long",
"documentation": "\n <p>The size of the volume.</p>\n ",
"xmlname": "size"
},
"Id": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The volume identifier.</p>\n ",
"required": true,
"xmlname": "id"
}
},
"documentation": "\n <p>The volume.</p>\n ",
"required": true,
"xmlname": "volume"
}
},
"documentation": "\n <p>If the task is for importing a volume, this contains information about the import volume task.</p>\n ",
"xmlname": "importVolume"
},
"State": {
"shape_name": "ConversionTaskState",
"type": "string",
"enum": [
"active",
"cancelling",
"cancelled",
"completed"
],
"documentation": "\n <p>The state of the conversion task.</p>\n ",
"required": true,
"xmlname": "state"
},
"StatusMessage": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status message related to the conversion task.</p>\n ",
"xmlname": "statusMessage"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n ",
"xmlname": "tagSet"
}
},
"documentation": "\n ",
"xmlname": "conversionTask"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Creates an import volume task using metadata from the specified disk image.\n After importing the image, you then upload it using the\n <function>ec2-import-volume</function> command in the Amazon EC2 command-line interface (CLI) tools. \n For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html\">Using the Command Line\n Tools to Import Your Virtual Machine to Amazon EC2</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates an import volume task that migrates a Windows Server 2008\n SP2 (32-bit) volume into the AWS <code>us-east-1</code> region.</description> \n <queryrequest>https://ec2.amazonaws.com/?Action=ImportVolume\n &amp;AvailabilityZone=us-east-1c\n &amp;Image.Format=VMDK\n &amp;Image.Bytes=128696320\n &amp;Image.ImportManifestUrl=https://s3.amazonaws.com/myawsbucket/\u200ba3a5e1b6-590d-43cc-97c1-15c7325d3f41/\u200bWin_2008_Server_Data_Center_SP2_32-bit.\u200bvmdkmanifest.xml?AWSAccessKeyId=\u200bAKIAIOSFODNN7EXAMPLE&amp;\u200bExpires=1294855591&amp;\u200bSignature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n &amp;VolumeSize=8\n &amp;AUTHPARAMS&gt;</queryrequest>\n <queryresponse><ImportVolumeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <conversionTask>\n <conversionTaskId>import-i-fh95npoc</conversionTaskId>\n <expirationTime>2010-12-22T12:01Z</expirationTime>\n <importVolume>\n <bytesConverted>0</bytesConverted>\n <availabilityZone>us-east-1c</availabilityZone>\n <description/>\n <image>\n <format>VDMK</format>\n <size>128696320</size>\n <importManifestUrl>\n https://s3.amazonaws.com/myawsbucket/\u200ba3a5e1b6-590d-43cc-97c1-15c7325d3f41/\u200bWin_2008_Server_Data_Center_SP2_32-bit.\u200bvmdkmanifest.xml?AWSAccessKeyId=\u200bAKIAIOSFODNN7EXAMPLE&amp;\u200bExpires=1294855591&amp;\u200bSignature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n </importManifestUrl>\n <checksum>ccb1b0536a4a70e86016b85229b5c6b10b14a4eb</checksum>\n </image>\n <volume>\n <size>8</size>\n <id>vol-34d8a2ff</id>\n </volume>\n </importVolume>\n <state>active</state>\n <statusMessage/>\n </conversionTask>\n</ImportVolumeResponse></queryresponse>\n </example>\n </examples>\n "
},
"ModifyImageAttribute": {
"name": "ModifyImageAttribute",
"input": {
"shape_name": "ModifyImageAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI.</p>\n ",
"required": true
},
"Attribute": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the attribute to modify.</p>\n "
},
"OperationType": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The operation type.</p>\n "
},
"UserIds": {
"shape_name": "UserIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "UserId"
},
"documentation": "\n <p>One or more AWS account IDs. This is only valid when modifying the <code>launchPermission</code> attribute.</p>\n ",
"flattened": true
},
"UserGroups": {
"shape_name": "UserGroupStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "UserGroup"
},
"documentation": "\n <p>One or more user groups. This is only valid when modifying the <code>launchPermission</code> attribute.</p>\n ",
"flattened": true
},
"ProductCodes": {
"shape_name": "ProductCodeStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ProductCode"
},
"documentation": "\n <p>One or more product codes. After you add a product code to an AMI, it can't be removed.\n This is only valid when modifying the <code>productCodes</code> attribute.</p>\n ",
"flattened": true
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the attribute being modified. This is only valid when modifying the <code>description</code> attribute.</p>\n "
},
"LaunchPermission": {
"shape_name": "LaunchPermissionModifications",
"type": "structure",
"members": {
"Add": {
"shape_name": "LaunchPermissionList",
"type": "list",
"members": {
"shape_name": "LaunchPermission",
"type": "structure",
"members": {
"UserId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID.</p>\n "
},
"Group": {
"shape_name": "PermissionGroup",
"type": "string",
"enum": [
"all"
],
"documentation": "\n <p>The name of the group.</p>\n "
}
},
"documentation": "\n <p>Describes a launch permission.</p>\n "
},
"documentation": "\n <p>The AWS account ID to add to the list of launch permissions for the AMI.</p>\n ",
"flattened": true
},
"Remove": {
"shape_name": "LaunchPermissionList",
"type": "list",
"members": {
"shape_name": "LaunchPermission",
"type": "structure",
"members": {
"UserId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The AWS account ID.</p>\n "
},
"Group": {
"shape_name": "PermissionGroup",
"type": "string",
"enum": [
"all"
],
"documentation": "\n <p>The name of the group.</p>\n "
}
},
"documentation": "\n <p>Describes a launch permission.</p>\n "
},
"documentation": "\n <p>The AWS account ID to remove from the list of launch permissions for the AMI.</p>\n ",
"flattened": true
}
},
"documentation": "\n <p></p>\n "
},
"Description": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n "
}
},
"documentation": "\n <p>A description for the AMI.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": " \n <p>Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.</p>\n <note><p>AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.</p></note>\n <examples>\n <example>\n <name>Example</name>\n <description></description>\n <queryrequest></queryrequest>\n <queryresponse></queryresponse>\n </example>\n </examples>\n "
},
"ModifyInstanceAttribute": {
"name": "ModifyInstanceAttribute",
"input": {
"shape_name": "ModifyInstanceAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"required": true
},
"Attribute": {
"shape_name": "InstanceAttributeName",
"type": "string",
"enum": [
"instanceType",
"kernel",
"ramdisk",
"userData",
"disableApiTermination",
"instanceInitiatedShutdownBehavior",
"rootDeviceName",
"blockDeviceMapping",
"productCodes",
"sourceDestCheck",
"groupSet",
"ebsOptimized",
"sriovNetSupport"
],
"documentation": "\n <p>The name of the attribute.</p>\n "
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A new value for the attribute. Use only with the <code>kernel</code>, <code>ramdisk</code>,\n <code>userData</code>, <code>disableApiTermination</code>, or\n <code>intanceInitiateShutdownBehavior</code> attribute.</p>\n "
},
"BlockDeviceMappings": {
"shape_name": "InstanceBlockDeviceMappingSpecificationList",
"type": "list",
"members": {
"shape_name": "InstanceBlockDeviceMappingSpecification",
"type": "structure",
"members": {
"DeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name exposed to the instance (for example, <filename>/dev/sdh</filename>).</p>\n "
},
"Ebs": {
"shape_name": "EbsInstanceBlockDeviceSpecification",
"type": "structure",
"members": {
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Amazon EBS volume.</p>\n "
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the volume is deleted on instance termination.</p>\n "
}
},
"documentation": "\n <p>Parameters used to automatically set up Amazon EBS volumes when the instance is launched.</p>\n "
},
"VirtualName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The virtual device name.</p>\n "
},
"NoDevice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>suppress the specified device included in the block device mapping.</p>\n "
}
},
"documentation": "\n <p>Describes a block device mapping entry.</p>\n ",
"xmlname": "BlockDeviceMapping"
},
"documentation": "\n\t\t\t<p>Modifies the <code>DeleteOnTermination</code> attribute for volumes\n\t\t\t\tthat are currently attached. The volume must be owned by the caller. If\n\t\t\t\tno value is specified for <code>DeleteOnTermination</code>, the default\n\t\t\t\tis <code>true</code> and the volume is deleted when the instance is\n\t\t\t\tterminated.</p>\n\t\t\t<p>To add instance store volumes to an Amazon EBS-backed instance,\n\t\t\t\tyou must add them when you launch the instance. For more\n\t\t\t\tinformation, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#Using_OverridingAMIBDM\">Updating the Block Device Mapping when Launching an Instance</a>\n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n ",
"flattened": true
},
"SourceDestCheck": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n "
}
},
"documentation": "\n <p>Specifies whether source/destination checking is enabled.\n\t\t\t\tA value of <code>true</code> means that checking is enabled, and\n\t\t\t\t<code>false</code> means checking is disabled. This value\n\t\t\t\tmust be <code>false</code> for a NAT instance to perform NAT.</p>\n "
},
"DisableApiTermination": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n "
}
},
"documentation": "\n <p>Specifies whether to disable the ability to terminate the instance using the Amazon EC2 console, CLI, and API.</p>\n "
},
"InstanceType": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n "
}
},
"documentation": "\n <p>Changes the instance type to the specified value. For more information, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\">Instance Types</a>.\n\t\t\t\tIf the instance type is not valid, the error returned is <code>InvalidInstanceAttributeValue</code>.</p>\n "
},
"Kernel": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n "
}
},
"documentation": "\n <p>Changes the instance's kernel to the specified value.</p>\n "
},
"Ramdisk": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n "
}
},
"documentation": "\n <p>Changes the instance's RAM disk to the specified value.</p>\n "
},
"UserData": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "blob",
"documentation": " \n "
}
},
"documentation": "\n <p>Changes the instance's user data to the specified value.</p>\n "
},
"InstanceInitiatedShutdownBehavior": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n "
}
},
"documentation": "\n <p>Specifies whether an instance stops or terminates when you initiate\n\t\t\t\tshutdown from the instance (using the operating system command for system shutdown).</p>\n "
},
"Groups": {
"shape_name": "GroupIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "GroupId"
},
"documentation": "\n\t\t\t<p>[EC2-VPC] Changes the security groups of the instance. You must specify\n\t\t\t\tat least one security group, even if it's just the default security\n\t\t\t\tgroup for the VPC. You must specify the security group ID, not the\n\t\t\t\tsecurity group name.</p>\n\t\t\t<p>For example, if you want the instance to be in sg-1a1a1a1a and\n\t\t\t\tsg-9b9b9b9b, specify <code>GroupId.1=sg-1a1a1a1a</code> and\n\t\t\t\t<code>GroupId.2=sg-9b9b9b9b</code>.</p>\n ",
"flattened": true
},
"EbsOptimized": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n "
}
},
"documentation": "\n <p>Specifies whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal EBS I/O performance. This\n\t\t\t\toptimization isn't available with all instance types. Additional usage\n\t\t\t\tcharges apply when using an EBS Optimized instance.</p>\n "
},
"SriovNetSupport": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n "
}
},
"documentation": "\n <p>Set to <code>simple</code> to enable enhanced networking for the instance.</p>\n <p>There is no way to disable enhanced networking at this time.</p>\n <p>This option is supported only for HVM instances. Specifying this option\n with a PV instance can make it unreachable.</p> \n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t\t<p>Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.</p>\n\t\t\t<p>To modify some attributes, the instance must be stopped. For more information, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html\">Modifying Attributes of a Stopped Instance</a>\n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example changes the instance type of the specified instance. The instance must be in the\n\t\t\t\t\t<code>stopped</code> state.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute\n&amp;InstanceId=i-10a64379\n&amp;InstanceType.Value=m1.small\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ModifyInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/ModifyInstanceAttributeResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example changes the <code>InstanceInitiatedShutdownBehavior</code> attribute of the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute\n&amp;InstanceId=i-10a64379\n&amp;InstanceInitiatedShutdownBehavior.Value=terminate\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ModifyInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/ModifyInstanceAttributeResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example changes the <code>DisableApiTermination</code> attribute of the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute\n&amp;InstanceId=i-10a64379\n&amp;DisableApiTermination.Value=true\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ModifyInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/ModifyInstanceAttributeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ModifyNetworkInterfaceAttribute": {
"name": "ModifyNetworkInterfaceAttribute",
"input": {
"shape_name": "ModifyNetworkInterfaceAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"required": true
},
"Description": {
"shape_name": "AttributeValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "String",
"type": "string",
"documentation": " \n "
}
},
"documentation": "\n\t\t <p>A description for the network interface.</p>\n "
},
"SourceDestCheck": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n "
}
},
"documentation": "\n\t\t <p>Indicates whether source/destination checking is enabled.\n\t\t\t\tA value of <code>true</code> means checking\n\t\t\t\tis enabled, and <code>false</code> means checking is disabled. This value\n\t\t\t\tmust be <code>false</code> for a NAT instance to perform NAT. For more\n\t\t\t\tinformation, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html\">NAT\n\t\t\t\tInstances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n "
},
"Groups": {
"shape_name": "SecurityGroupIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "SecurityGroupId"
},
"documentation": "\n\t\t <p>Changes the security groups for the network interface. The new\n\t\t\t\tset of groups you specify replaces the current set. You must specify at\n\t\t\t\tleast one group, even if it's just the default security group in the\n\t\t\t\tVPC. You must specify the ID of the security group, not the name.</p>\n ",
"flattened": true
},
"Attachment": {
"shape_name": "NetworkInterfaceAttachmentChanges",
"type": "structure",
"members": {
"AttachmentId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface attachment.</p>\n "
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the network interface is deleted when the instance is terminated.</p>\n "
}
},
"documentation": "\n\t\t <p>The ID of the interface attachment.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Modifies the specified network interface attribute. You can specify only one attribute at a time.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example sets source/destination checking to <code>false</code> for the\n\t\t\t\t\tspecified network interface.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ModifyNetworkInterfaceAttribute\n&amp;NetworkInterfaceId=eni-ffda3197\n&amp;SourceDestCheck.Value=false\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ModifyNetworkInterfaceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;657a4623-5620-4232-b03b-427e852d71cf&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/ModifyNetworkInterfaceAttributeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ModifyReservedInstances": {
"name": "ModifyReservedInstances",
"input": {
"shape_name": "ModifyReservedInstancesRequest",
"type": "structure",
"members": {
"ClientToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A unique, case-sensitive token you provide to ensure idempotency of your modification request.</p>\n "
},
"ReservedInstancesIds": {
"shape_name": "ReservedInstancesIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "ReservedInstancesId"
},
"documentation": "\n <p>The IDs of the Reserved Instances to modify.</p>\n ",
"required": true,
"flattened": true
},
"TargetConfigurations": {
"shape_name": "ReservedInstancesConfigurationList",
"type": "list",
"members": {
"shape_name": "ReservedInstancesConfiguration",
"type": "structure",
"members": {
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone for the modified Reserved Instances.</p>\n "
},
"Platform": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.</p>\n "
},
"InstanceCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of modified Reserved Instances.</p>\n "
},
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type for the modified Reserved Instances.</p>\n "
}
},
"documentation": "\n <p>Describes the configuration settings for the modified Reserved Instances.</p>\n ",
"xmlname": "ReservedInstancesConfigurationSetItemType"
},
"documentation": "\n <p>The configuration settings for the Reserved Instances to modify.</p>\n ",
"required": true,
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "ModifyReservedInstancesResult",
"type": "structure",
"members": {
"ReservedInstancesModificationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID for the modification.</p>\n ",
"xmlname": "reservedInstancesModificationId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.</p>\n <examples>\n <example>\n <name>Example</name>\n <queryrequest>https://ec2.amazonaws.com/?Action=ModifyReservedInstances\n&amp;ClientToken=myClientToken\n&amp;ReservedInstancesConfigurationSetItemType.0.AvailabilityZone=us-east-1a\n&amp;ReservedInstancesConfigurationSetItemType.0.InstanceCount=1\n&amp;ReservedInstancesConfigurationSetItemType.0.Platform=EC2-VPC\n&amp;ReservedInstancesConfigurationSetItemType.0.InstanceType=m1.small\n&amp;ReservedInstancesId.0=d16f7a91-4d0f-4f19-9d7f-a74d26b1ccfa\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><ModifyReservedInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n<requestId>bef729b6-0731-4489-8881-2258746ae163</requestId>\n<reservedInstancesModificationId>rimod-3aae219d-3d63-47a9-a7e9-e764example</reservedInstancesModificationId>\n</ModifyReservedInstancesResponse></queryresponse>\n </example>\n </examples>\n "
},
"ModifySnapshotAttribute": {
"name": "ModifySnapshotAttribute",
"input": {
"shape_name": "ModifySnapshotAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the snapshot.</p>\n ",
"required": true
},
"Attribute": {
"shape_name": "SnapshotAttributeName",
"type": "string",
"enum": [
"productCodes",
"createVolumePermission"
],
"documentation": "\n <p>The snapshot attribute to modify.</p>\n "
},
"OperationType": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The type of operation to perform to the attribute.</p>\n "
},
"UserIds": {
"shape_name": "UserIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "UserId"
},
"documentation": "\n <p>The account ID to modify for the snapshot.</p>\n ",
"flattened": true
},
"GroupNames": {
"shape_name": "GroupNameStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "UserGroup"
},
"documentation": "\n <p>The group to modify for the snapshot.</p>\n ",
"flattened": true
},
"CreateVolumePermission": {
"shape_name": "CreateVolumePermissionModifications",
"type": "structure",
"members": {
"Add": {
"shape_name": "CreateVolumePermissionList",
"type": "list",
"members": {
"shape_name": "CreateVolumePermission",
"type": "structure",
"members": {
"UserId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The specific AWS account ID that is to be added or removed from a volume's list of create\n volume permissions.</p>\n "
},
"Group": {
"shape_name": "PermissionGroup",
"type": "string",
"enum": [
"all"
],
"documentation": "\n <p>The specific group that is to be added or removed from a volume's list of create volume\n permissions.</p>\n "
}
},
"documentation": "\n "
},
"documentation": "\n <p>Adds a specific AWS account ID or group to a volume's list of create volume permissions.</p>\n ",
"flattened": true
},
"Remove": {
"shape_name": "CreateVolumePermissionList",
"type": "list",
"members": {
"shape_name": "CreateVolumePermission",
"type": "structure",
"members": {
"UserId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The specific AWS account ID that is to be added or removed from a volume's list of create\n volume permissions.</p>\n "
},
"Group": {
"shape_name": "PermissionGroup",
"type": "string",
"enum": [
"all"
],
"documentation": "\n <p>The specific group that is to be added or removed from a volume's list of create volume\n permissions.</p>\n "
}
},
"documentation": "\n "
},
"documentation": "\n <p>Removes a specific AWS account ID or group from a volume's list of create volume\n permissions.</p>\n ",
"flattened": true
}
},
"documentation": "\n <p>A JSON representation of the snapshot attribute modification.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Adds or removes permission settings for the specified snapshot.</p>\n <p>For more information on modifying snapshot permissions, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html\">Sharing Snapshots</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <note>\n <p>Snapshots with AWS Marketplace product codes cannot be made public.</p>\n </note>\n <examples>\n <example>\n <name>Example</name>\n <description>This example makes the <code>snap-1a2b3c4d</code> snapshot public, and gives\n the account with ID <code>111122223333</code> permission to create volumes from\n the snapshot.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ModifySnapshotAttribute\n&amp;snapshotId=snap-1a2b3c4d\n&amp;CreateVolumePermission.Add.1.UserId=111122223333\n&amp;CreateVolumePermission.Add.1.Group=all\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ModifySnapshotAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/ModifySnapshotAttributeResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example</name>\n <description>This example makes the <code>snap-1a2b3c4d</code> snapshot public, and removes\n the account with ID <code>111122223333</code> from the list of users with\n permission to create volumes from the snapshot.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ModifySnapshotAttribute\n&amp;snapshotId=snap-1a2b3c4d\n&amp;CreateVolumePermission.Remove.1.UserId=111122223333\n&amp;CreateVolumePermission.Add.1.Group=all\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ModifySnapshotAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/ModifySnapshotAttributeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ModifyVolumeAttribute": {
"name": "ModifyVolumeAttribute",
"input": {
"shape_name": "ModifyVolumeAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the volume.</p>\n ",
"required": true
},
"AutoEnableIO": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n "
}
},
"documentation": "\n <p>Indicates whether the volume should be auto-enabled for I/O operations.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Modifies a volume attribute.</p>\n <p>By default, all I/O operations for the volume are suspended when the data on the volume is\n determined to be potentially inconsistent, to prevent undetectable, latent data corruption.\n The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.</p>\n <p>You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes\n or for volumes that are stateless or disposable.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example modifies the attribute of the volume vol-12345678.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ModifyVolumeAttribute\n&amp;VolumeId=vol-12345678\n&amp;AutoEnableIO.Value=true\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ModifyVolumeAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/ModifyVolumeAttributeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ModifyVpcAttribute": {
"name": "ModifyVpcAttribute",
"input": {
"shape_name": "ModifyVpcAttributeRequest",
"type": "structure",
"members": {
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"required": true
},
"EnableDnsSupport": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n "
}
},
"documentation": "\n\t\t <p>Indicates whether the DNS resolution is supported for the VPC. If this attribute is\n <code>false</code>, the Amazon provided DNS service in the VPC that resolves public DNS\n hostnames to IP addresses is not enabled. If this attribute is <code>true</code>, queries to\n the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address\n at the base of the VPC network range \"plus two\" will succeed.</p>\n "
},
"EnableDnsHostnames": {
"shape_name": "AttributeBooleanValue",
"type": "structure",
"members": {
"Value": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": " \n "
}
},
"documentation": "\n\t\t <p>Indicates whether the instances launched in the VPC get DNS\n\t\t\t\thostnames. If this attribute is <code>true</code>, instances in the VPC\n\t\t\t\tget DNS hostnames; otherwise, they do not.</p>\n <p>You can only set <code>enableDnsHostnames</code> to <code>true</code> if you also\n\t\t\t\tset the <code>EnableDnsSupport</code> attribute to <code>true</code>.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Modifies the specified attribute of the specified VPC.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example disables support for DNS hostnames in the specified VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ModifyVpcAttribute \n&amp;VpcId=vpc-1a2b3c4d \n&amp;EnableDnsHostnames.Value=false \n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"MonitorInstances": {
"name": "MonitorInstances",
"input": {
"shape_name": "MonitorInstancesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceIds": {
"shape_name": "InstanceIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "InstanceId"
},
"documentation": "\n <p>One or more instance IDs.</p>\n ",
"required": true,
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "MonitorInstancesResult",
"type": "structure",
"members": {
"InstanceMonitorings": {
"shape_name": "InstanceMonitoringList",
"type": "list",
"members": {
"shape_name": "InstanceMonitoring",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"Monitoring": {
"shape_name": "Monitoring",
"type": "structure",
"members": {
"State": {
"shape_name": "MonitoringState",
"type": "string",
"enum": [
"disabled",
"enabled",
"pending"
],
"documentation": "\n <p>Indicates whether monitoring is enabled for the instance.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n <p>The monitoring information.</p>\n ",
"xmlname": "monitoring"
}
},
"documentation": "\n <p>Describes the monitoring information of the instance.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Monitoring information for one or more instances.</p>\n ",
"xmlname": "instancesSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Enables monitoring for a running instance. For more information about monitoring instances,\n\t\t\tsee <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html\">Monitoring Your Instances and Volumes</a>\n\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example enables monitoring for two instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=MonitorInstances\n&amp;InstanceId.1=i-43a4412a\n&amp;InstanceId.2=i-23a3397d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;MonitorInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;instancesSet&gt;\n &lt;item&gt;\n &lt;instanceId&gt;i-43a4412a&lt;/instanceId&gt;\n &lt;monitoring&gt;\n &lt;state&gt;pending&lt;/state&gt;\n &lt;/monitoring&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;instanceId&gt;i-23a3397d&lt;/instanceId&gt;\n &lt;monitoring&gt;\n &lt;state&gt;pending&lt;/state&gt;\n &lt;/monitoring&gt;\n &lt;/item&gt;\n &lt;/instancesSet&gt;\n&lt;/MonitorInstancesResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"PurchaseReservedInstancesOffering": {
"name": "PurchaseReservedInstancesOffering",
"input": {
"shape_name": "PurchaseReservedInstancesOfferingRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ReservedInstancesOfferingId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Reserved Instance offering to purchase.</p>\n ",
"required": true
},
"InstanceCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of Reserved Instances to purchase.</p>\n ",
"required": true
},
"LimitPrice": {
"shape_name": "ReservedInstanceLimitPrice",
"type": "structure",
"members": {
"Amount": {
"shape_name": "Double",
"type": "double",
"documentation": "\n <p>Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order\n\t\t\t\t(instanceCount * price).</p>\n "
},
"CurrencyCode": {
"shape_name": "CurrencyCodeValues",
"type": "string",
"enum": [
"USD"
],
"documentation": "\n <p>The currency in which the <code>limitPrice</code> amount is specified.\n\t\t\t\tAt this time, the only supported currency is <code>USD</code>.</p>\n "
}
},
"documentation": "\n <p>Specified for Reserved Instance Marketplace offerings to limit the total order and\n\t\t\t\tensure that the Reserved Instances are not purchased at unexpected prices.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "PurchaseReservedInstancesOfferingResult",
"type": "structure",
"members": {
"ReservedInstancesId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The IDs of the purchased Reserved Instances.</p>\n ",
"xmlname": "reservedInstancesId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved\n\t\t\t\tInstances, you obtain a capacity reservation for a certain instance configuration\n\t\t\t\tover a specified period of time. You pay a lower usage rate than with On-Demand\n\t\t\t\tinstances for the time that you actually use the capacity reservation.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html\">Reserved Instance Marketplace</a>\n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example uses a limit price to limit the total purchase order of \n Reserved Instances from Reserved Instance Marketplace.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=PurchaseReservedInstancesOffering\n&amp;ReservedInstancesOfferingId=4b2293b4-5813-4cc8-9ce3-1957fEXAMPLE\n&amp;LimitPrice.Amount=200\n&amp;InstanceCount=2\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><PurchaseReservedInstancesOfferingResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <reservedInstancesId>e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE</reservedInstancesId> \n</PurchaseReservedInstancesOfferingResponse></queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example illustrates a purchase of a Reserved Instances offering.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=PurchaseReservedInstancesOffering\n&amp;ReservedInstancesOfferingId=4b2293b4-5813-4cc8-9ce3-1957fEXAMPLE\n&amp;InstanceCount=2\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;PurchaseReservedInstancesOfferingResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;reservedInstancesId&gt;e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE&lt;/reservedInstancesId&gt; \n&lt;/PurchaseReservedInstancesOfferingResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"RebootInstances": {
"name": "RebootInstances",
"input": {
"shape_name": "RebootInstancesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceIds": {
"shape_name": "InstanceIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "InstanceId"
},
"documentation": "\n <p>One or more instance IDs.</p>\n ",
"required": true,
"flattened": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t\t<p>Requests a reboot of one or more instances. This operation is asynchronous; it\n\t\t\t\tonly queues a request to reboot the specified instances. The operation\n\t\t\t\tsucceeds if the instances are valid and belong to you. Requests to reboot terminated\n\t\t\t\tinstances are ignored.</p>\n\t\t\t<p>If a Linux/Unix instance does not cleanly shut down within four minutes,\n\t\t\t\tAmazon EC2 performs a hard reboot.</p>\n <p>For more information about troubleshooting, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html\">Getting Console Output and Rebooting Instances</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example reboots two instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RebootInstances\n&amp;InstanceId.1=i-1a2b3c4d\n&amp;InstanceId.2=i-4d3acf62\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;RebootInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/RebootInstancesResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"RegisterImage": {
"name": "RegisterImage",
"input": {
"shape_name": "RegisterImageRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ImageLocation": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The full path to your AMI manifest in Amazon S3 storage.</p>\n "
},
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A name for your AMI.</p>\n <p>Constraints: 3-128 alphanumeric characters, parenthesis (()),\n\t\t\t\tcommas (,), slashes (/), dashes (-), or underscores (_)</p>\n "
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>A description for your AMI.</p>\n "
},
"Architecture": {
"shape_name": "ArchitectureValues",
"type": "string",
"enum": [
"i386",
"x86_64"
],
"documentation": "\n <p>The architecture of the AMI.</p>\n <p>Default: For Amazon EBS-backed AMIs, <code>i386</code>.\n For instance store-backed AMIs, the architecture specified in the manifest file.</p>\n "
},
"KernelId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the kernel.</p>\n "
},
"RamdiskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the RAM disk.</p>\n "
},
"RootDeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the root device (for example, <code>/dev/sda1</code>, or\n\t\t\t\t<code>xvda</code>).</p>\n "
},
"BlockDeviceMappings": {
"shape_name": "BlockDeviceMappingRequestList",
"type": "list",
"members": {
"shape_name": "BlockDeviceMapping",
"type": "structure",
"members": {
"VirtualName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The virtual device name.</p>\n "
},
"DeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name exposed to the instance (for example, <code>/dev/sdh</code>).</p>\n "
},
"Ebs": {
"shape_name": "EbsBlockDevice",
"type": "structure",
"members": {
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the snapshot.</p>\n "
},
"VolumeSize": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiB.</p>\n <p>Constraints: If the volume type is <code>io1</code>, the minimum size of the volume is 10 GiB.</p>\n <p>Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.</p>\n "
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n "
},
"VolumeType": {
"shape_name": "VolumeType",
"type": "string",
"enum": [
"standard",
"io1",
"gp2"
],
"documentation": "\n <p>The volume type.</p>\n <p>Default: <code>standard</code></p>\n "
},
"Iops": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of I/O operations per second (IOPS) that the\n volume supports.</p>\n <p>Constraint: Range is 100 to 4000.</p>\n <p>Condition: Required when the volume type is <code>io1</code>; not used with\n <code>standard</code> or <code>gp2</code> volumes.</p>\n "
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is encrypted.</p>\n "
}
},
"documentation": "\n <p>Parameters used to automatically set up Amazon EBS volumes when the instance is launched.</p>\n "
},
"NoDevice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Suppresses the specified device included in the block device mapping of the AMI.</p>\n "
}
},
"documentation": "\n <p>Describes a block device mapping.</p>\n ",
"xmlname": "BlockDeviceMapping"
},
"documentation": "\n <p>One or more block device mapping entries.</p>\n ",
"flattened": true
},
"VirtualizationType": {
"shape_name": "String",
"type": "string",
"documentation": "The type of virtualization",
"enum": [
"paravirtual",
"hvm"
]
},
"SriovNetSupport": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Set to <code>simple</code> to enable enhanced networking for the AMI and any instances that you launch from the AMI.</p>\n <p>There is no way to disable enhanced networking at this time.</p>\n <p>This option is supported only for HVM AMIs. Specifying this option\n with a PV AMI can make instances launched from the AMI unreachable.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "RegisterImageResult",
"type": "structure",
"members": {
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the newly registered AMI.</p>\n ",
"xmlname": "imageId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": " \n <p>Registers an AMI. When you're creating an AMI, this is the final step\n\t\t\t\tyou must complete before you can launch an instance from the AMI. For more\n\t\t\t\tinformation about creating AMIs, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html\">Creating Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <note><p>For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI in a single request, so you don't have to register the AMI yourself.</p></note>\n <p>You can also use <code>RegisterImage</code> to create an Amazon EBS-backed AMI\n\t\t\t\tfrom a snapshot of a root device volume. For more information, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html\">Launching an\n\t\t\t\t\tInstance from a Snapshot</a> in the\n\t\t\t\t<i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>If needed, you can deregister an AMI at any time. Any modifications you make to an AMI\n\t\t\t\tbacked by an instance store volume invalidates its registration. If you make changes to an image,\n\t\t\t\tderegister the previous image and register the new image.</p>\n <note><p>You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.</p></note>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example registers the AMI specified in the\n\t\t\t\t\t<code>my-new-image.manifest.xml</code> manifest file, located in the bucket\n\t\t\t\t\tcalled <code>myawsbucket</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RegisterImage\n&amp;ImageLocation=myawsbucket/my-new-image.manifest.xml\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;RegisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;imageId&gt;ami-1a2b3c4d&lt;/imageId&gt;\n&lt;/RegisterImageResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example registers an Amazon EBS snapshot to create an AMI backed by\n\t\t\t\t\tAmazon EBS.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RegisterImage\n&amp;RootDeviceName=/dev/sda1 \n&amp;BlockDeviceMapping.1.DeviceName=/dev/sda1 \n&amp;BlockDeviceMapping.1.Ebs.SnapshotId=snap-1a2b3c4d \n&amp;Name=MyImage\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;RegisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;imageId&gt;ami-1a2b3c4d&lt;/imageId&gt;\n&lt;/RegisterImageResponse&gt;</queryresponse>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example registers the AMI with an Amazon EBS snapshot as the root device,\n\t\t\t\t\ta separate snapshot as a secondary device, and an empty 100 GiB Amazon EBS\n\t\t\t\t\tvolume as a storage device.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RegisterImage\n&amp;RootDeviceName=/dev/sda1\n&amp;BlockDeviceMapping.1.DeviceName=/dev/sda1\n&amp;BlockDeviceMapping.1.Ebs.SnapshotId=snap-1a2b3c4d\n&amp;BlockDeviceMapping.2.DeviceName=/dev/sdb\n&amp;BlockDeviceMapping.2.Ebs.SnapshotId=snap-2a2b3c4d\n&amp;BlockDeviceMapping.3.DeviceName=/dev/sdc\n&amp;BlockDeviceMapping.3.Ebs.VolumeSize=100\n&amp;Name=MyImage\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;RegisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;imageId&gt;ami-1a2b3c4d&lt;/imageId&gt;\n&lt;/RegisterImageResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"RejectVpcPeeringConnection": {
"name": "RejectVpcPeeringConnection",
"input": {
"shape_name": "RejectVpcPeeringConnectionRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"VpcPeeringConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC peering connection.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "RejectVpcPeeringConnectionResult",
"type": "structure",
"members": {
"Return": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Returns <code>true</code> if the request succeeds; otherwise, it returns an error.</p>\n ",
"xmlname": "return"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Rejects a VPC peering connection request. The VPC peering connection must be in the\n <code>pending-acceptance</code> state. Use the <code>DescribeVpcPeeringConnections</code> request to\n view your outstanding VPC peering connection requests.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example rejects the specified VPC peering connection\n request.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RejectVpcPeeringConnection\n&amp;vpcPeeringConnectionId=pcx-1a2b3c4d\n&amp;AUTHPARAMS \n </queryrequest>\n <queryresponse>&lt;RejectVpcPeeringConnectionResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;7a62c49f-347e-4fc4-9331-6e8eEXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/RejectVpcPeeringConnectionResponse&gt;\n </queryresponse>\n </example>\n </examples>\n "
},
"ReleaseAddress": {
"name": "ReleaseAddress",
"input": {
"shape_name": "ReleaseAddressRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-Classic] The Elastic IP address.</p>\n "
},
"AllocationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] The allocation ID.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Releases the specified Elastic IP address.</p>\n <p>After releasing an Elastic IP address, it is released to the IP address\n\t\t\t\tpool and might be unavailable to you. Be sure to update your DNS records and any\n\t\t\t\tservers or devices that communicate with the address. If you attempt to release\n\t\t\t\tan Elastic IP address that you already released, you'll get an\n\t\t\t\t<code>AuthFailure</code> error if the address is already allocated to\n\t\t\t\tanother AWS account.</p>\n <p>[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address\n\t\t\t\twithout releasing it, use <a>DisassociateAddress</a>.</p>\n <p>[Nondefault VPC] You must use the <a>DisassociateAddress</a> to\n\t\t\t\tdisassociate the Elastic IP address before you try to release it. Otherwise, \n\t\t\t\tAmazon EC2 returns an error (<code>InvalidIPAddress.InUse</code>).</p>\n <examples>\n <example>\n <name>Example for EC2-Classic</name>\n <description>This example releases the specified Elastic IP address for EC2-Classic.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ReleaseAddress\n&amp;PublicIp=192.0.2.1\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example for EC2-VPC</name>\n <description>This example releases the specified Elastic IP address for EC2-VPC.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ReleaseAddress\n&amp;AllocationId=eipalloc-5723d13e\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"ReplaceNetworkAclAssociation": {
"name": "ReplaceNetworkAclAssociation",
"input": {
"shape_name": "ReplaceNetworkAclAssociationRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"AssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the current association between the original\n\t\t\t\tnetwork ACL and the subnet.</p>\n ",
"required": true
},
"NetworkAclId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the new ACL to associate with the subnet.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "ReplaceNetworkAclAssociationResult",
"type": "structure",
"members": {
"NewAssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the new association.</p>\n ",
"xmlname": "newAssociationId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Changes which network ACL a subnet is associated with. By default when you create\n\t\t\t\ta subnet, it's automatically associated with the default network ACL. For more\n\t\t\t\tinformation about network ACLs, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html\">Network\n\t\t\t\tACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example starts with a network ACL associated with a subnet, and a\n\t\t\t\t\tcorresponding association ID <code>aclassoc-e5b95c8c</code>. You want to associate a\n\t\t\t\t\tdifferent network ACL (<code>acl-5fb85d36</code>) with the subnet. The result is a new\n\t\t\t\t\tassociation ID representing the new association.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ReplaceNetworkAclAssociation\n&amp;AssociationId=aclassoc-e5b95c8c\n&amp;NetworkAclId=acl-5fb85d36\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ReplaceNetworkAclAssociationResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;newAssociationId&gt;aclassoc-17b85d7e&lt;/newAssociationId&gt;\n&lt;/ReplaceNetworkAclAssociationResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ReplaceNetworkAclEntry": {
"name": "ReplaceNetworkAclEntry",
"input": {
"shape_name": "ReplaceNetworkAclEntryRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"NetworkAclId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the ACL.</p>\n ",
"required": true
},
"RuleNumber": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The rule number of the entry to replace.</p>\n ",
"required": true
},
"Protocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The IP protocol. You can specify <code>all</code> or <code>-1</code> to mean all protocols.</p>\n ",
"required": true
},
"RuleAction": {
"shape_name": "RuleAction",
"type": "string",
"enum": [
"allow",
"deny"
],
"documentation": "\n\t\t <p>Indicates whether to allow or deny the traffic that matches the rule.</p>\n ",
"required": true
},
"Egress": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether to replace the egress rule.</p>\n\t\t <p>Default: If no value is specified, we replace the ingress rule.</p>\n ",
"required": true
},
"CidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The network range to allow or deny, in CIDR notation.</p>\n ",
"required": true
},
"IcmpTypeCode": {
"shape_name": "IcmpTypeCode",
"type": "structure",
"members": {
"Type": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The ICMP code. A value of -1 means all codes for the specified ICMP type.</p>\n "
},
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The ICMP type. A value of -1 means all types.</p>\n "
}
},
"documentation": "\n\t\t <p>ICMP protocol: The ICMP type and code.</p>\n ",
"xmlname": "Icmp"
},
"PortRange": {
"shape_name": "PortRange",
"type": "structure",
"members": {
"From": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The first port in the range.</p>\n "
},
"To": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The last port in the range.</p>\n "
}
},
"documentation": "\n\t\t <p>TCP or UDP protocols: The range of ports the rule applies to.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Replaces an entry (rule) in a network ACL. For more information about network ACLs,\n\t\t\t\tsee <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html\">Network ACLs</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example replaces the egress entry numbered <code>110</code> in the network ACL with ID\n\t\t\t\t\t<code>acl-2cb85d45</code>. The new rule denies egress traffic destined for anywhere\n\t\t\t\t\t(<code>0.0.0.0/0</code>) on TCP port 139.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ReplaceNetworkAclEntry\n&amp;NetworkAclId=acl-2cb85d45\n&amp;RuleNumber=110\n&amp;Protocol=tcp\n&amp;RuleAction=deny\n&amp;Egress=true\n&amp;CidrBlock=0.0.0.0/0\n&amp;PortRange.From=139\n&amp;PortRange.To=139\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ReplaceNetworkAclEntryResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/ReplaceNetworkAclEntryResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ReplaceRoute": {
"name": "ReplaceRoute",
"input": {
"shape_name": "ReplaceRouteRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"RouteTableId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the route table.</p>\n ",
"required": true
},
"DestinationCidrBlock": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR address block used for the destination match. The value\n\t\t\t\tyou provide must match the CIDR of an existing route in the table.</p>\n ",
"required": true
},
"GatewayId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of an Internet gateway attached to your VPC.</p>\n "
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of a NAT instance in your VPC.</p>\n "
},
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of a network interface.</p>\n "
},
"VpcPeeringConnectionId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of a VPC peering connection.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Replaces an existing route within a route table in a VPC. You must provide only one of the following: \n\t\t Internet gateway, NAT instance, VPC peering connection, or network interface.</p>\n\t\t <p>For more information about route tables, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html\">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example replaces a route in the specified route table. The new\n\t\t\t\t\troute matches the CIDR <code>10.0.0.0/8</code> and sends the traffic to the virtual private gateway with\n\t\t\t\t\tthe ID <code>vgw-1d00376e</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ReplaceRoute\n&amp;RouteTableId=rtb-e4ad488d\n&amp;DestinationCidrBlock=10.0.0.0/8\n&amp;GatewayId=vgw-1d00376e\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ReplaceRouteResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/ReplaceRouteResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ReplaceRouteTableAssociation": {
"name": "ReplaceRouteTableAssociation",
"input": {
"shape_name": "ReplaceRouteTableAssociationRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"AssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The association ID.</p>\n ",
"required": true
},
"RouteTableId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the new route table to associate with the subnet.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "ReplaceRouteTableAssociationResult",
"type": "structure",
"members": {
"NewAssociationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the new association.</p>\n ",
"xmlname": "newAssociationId"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t <p>Changes the route table associated with a given subnet in a VPC. After the\n\t\t\t\toperation completes, the subnet uses the routes in the new route table it's associated with.\n\t\t\t\tFor more information about route tables, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html\">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <p>You can also use ReplaceRouteTableAssociation to change which table is the main route table in the\n\t\t\t\tVPC. You just specify the main route table's association ID and the route table to be the new main route table.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example starts with a route table associated with a subnet, and a\n\t\t\t\t\tcorresponding association ID <code>rtbassoc-f8ad4891</code>. You want to associate a\n\t\t\t\t\tdifferent route table (table <code>rtb-f9ad4890</code>) to the subnet. The result is a new\n\t\t\t\t\tassociation ID representing the new association.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ReplaceRouteTableAssociation\n&amp;AssociationId=rtbassoc-f8ad4891\n&amp;RouteTableId=rtb-f9ad4890\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse><ReplaceRouteTableAssociationResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <newAssociationId>rtbassoc-faad4893</newAssociationId>\n</ReplaceRouteTableAssociationResponse></queryresponse>\n </example>\n </examples>\n "
},
"ReportInstanceStatus": {
"name": "ReportInstanceStatus",
"input": {
"shape_name": "ReportInstanceStatusRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"Instances": {
"shape_name": "InstanceIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "InstanceId"
},
"documentation": "\n <p>One or more instances.</p>\n ",
"flattened": true
},
"Status": {
"shape_name": "ReportStatusType",
"type": "string",
"enum": [
"ok",
"impaired"
],
"documentation": "\n <p>The status of all instances listed.</p>\n "
},
"StartTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time at which the reported instance health state began.</p>\n "
},
"EndTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time at which the reported instance health state ended.</p>\n "
},
"ReasonCodes": {
"shape_name": "ReasonCodesList",
"type": "list",
"members": {
"shape_name": "ReportInstanceReasonCodes",
"type": "string",
"enum": [
"instance-stuck-in-state",
"unresponsive",
"not-accepting-credentials",
"password-not-available",
"performance-network",
"performance-instance-store",
"performance-ebs-volume",
"performance-other",
"other"
],
"documentation": null,
"xmlname": "ReasonCode"
},
"documentation": "\n <p>One or more reason codes that describes the health state of your instance.</p>\n <ul>\n <li><p><code>instance-stuck-in-state</code>: My instance is stuck in a state.</p></li>\n <li><p><code>unresponsive</code>: My instance is unresponsive.</p></li>\n <li><p><code>not-accepting-credentials</code>: My instance is not accepting my credentials.</p></li>\n <li><p><code>password-not-available</code>: A password is not available for my instance.</p></li>\n <li><p><code>performance-network</code>: My instance is experiencing performance problems which I believe are network related.</p></li>\n <li><p><code>performance-instance-store</code>: My instance is experiencing performance problems which I believe are related to the instance stores.</p></li>\n <li><p><code>performance-ebs-volume</code>: My instance is experiencing performance problems which I believe are related to an EBS volume.</p></li>\n <li><p><code>performance-other</code>: My instance is experiencing performance problems.</p></li>\n <li><p><code>other</code>: [explain using the description parameter]</p></li>\n </ul>\n ",
"flattened": true
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Descriptive text about the health state of your instance.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t\t<p>Submits feedback about the status of an instance. The instance\n\t\t\t\tmust be in the <code>running</code> state. If your experience\n\t\t\t\twith the instance differs from the instance status returned by\n\t\t\t\t<a>DescribeInstanceStatus</a>, use <a>ReportInstanceStatus</a>\n\t\t\t\tto report your experience with the instance. Amazon EC2 collects\n\t\t\t\tthis information to improve the accuracy of status checks.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example reports instance health state for two instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ReportInstanceStatus\n&amp;Status=impaired\n&amp;InstanceId.0=i-9440effb\n&amp;InstanceId.1=i-0cf27c63\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example reports instance health state for two instances with reason codes.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ReportInstanceStatus\n&amp;Description=Description+of+my+issue.\n&amp;Status=impaired\n&amp;InstanceId.0=i-9440effb\n&amp;InstanceId.1=i-0cf27c63\n&amp;ReasonCode.0=instance-performance-network\n&amp;ReasonCode.1=instance-performance-disk\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"RequestSpotInstances": {
"name": "RequestSpotInstances",
"input": {
"shape_name": "RequestSpotInstancesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SpotPrice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The maximum hourly price for any Spot Instance launched to fulfill the request.</p>\n ",
"required": true
},
"InstanceCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The maximum number of Spot Instances to launch.</p>\n <p>Default: 1</p>\n "
},
"Type": {
"shape_name": "SpotInstanceType",
"type": "string",
"enum": [
"one-time",
"persistent"
],
"documentation": "\n <p>The Spot Instance request type.</p>\n <p>Default: <code>one-time</code></p>\n "
},
"ValidFrom": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The start date of the request. If this is a one-time request, the\n\t\t\t\trequest becomes active at this date and time and remains active until\n\t\t\t\tall instances launch, the request expires, or the request is canceled.\n\t\t\t\tIf the request is persistent, the request becomes active at this date\n\t\t\t\tand time and remains active until it expires or is canceled.</p>\n <p>Default: The request is effective indefinitely.</p>\n "
},
"ValidUntil": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The end date of the request. If this is a one-time request, the\n\t\t\t\trequest remains active until all instances launch, the request is\n\t\t\t\tcanceled, or this date is reached. If the request is persistent, it\n\t\t\t\tremains active until it is canceled or this date and time is reached.</p>\n <p>Default: The request is effective indefinitely.</p>\n "
},
"LaunchGroup": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The instance launch group. Launch groups are Spot Instances that\n\t\t\t\tlaunch together and terminate together.</p>\n <p>Default: Instances are launched and terminated individually</p>\n "
},
"AvailabilityZoneGroup": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The user-specified name for a logical grouping of bids.</p>\n <p>When you specify an Availability Zone group in a Spot\n\t\t\t\tInstance request, all Spot Instances in the request are launched in the\n\t\t\t\tsame Availability Zone. Instance proximity is maintained with this\n\t\t\t\tparameter, but the choice of Availability Zone is not.\n\t\t\t\tThe group applies only to bids for Spot\tInstances of the same instance type. \n\t\t\t\tAny additional Spot Instance requests that are specified with the same\n\t\t\t\tAvailability Zone group name are launched in that\n\t\t\t\tsame Availability Zone, as long as at least one instance from the group\n\t\t\t\tis still active.</p>\n <p>If there is no active instance running in the Availability Zone\n\t\t\t\tgroup that you specify for a new Spot Instance request (all\n\t\t\t\tinstances are terminated, the bid is expired, or the bid falls below\n\t\t\t\tcurrent market), then Amazon EC2 launches the instance in any\n\t\t\t\tAvailability Zone where the constraint can be met. Consequently, the\n\t\t\t\tsubsequent set of Spot Instances could be placed in a different zone\n\t\t\t\tfrom the original request, even if you specified the same\n\t\t\t\tAvailability Zone group.</p>\n <p>Default: Instances are launched in any available Availability Zone.</p>\n "
},
"LaunchSpecification": {
"shape_name": "LaunchSpecification",
"type": "structure",
"members": {
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI.</p>\n "
},
"KeyName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the key pair.</p>\n "
},
"UserData": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Base64-encoded MIME user data to make available to the instances.</p>\n "
},
"AddressingType": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p></p>\n "
},
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type.</p>\n "
},
"Placement": {
"shape_name": "SpotPlacement",
"type": "structure",
"members": {
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone.</p>\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone group name.</p>\n "
}
},
"documentation": "\n <p>The placement information for the instance.</p>\n "
},
"KernelId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the kernel.</p>\n "
},
"RamdiskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the RAM disk.</p>\n "
},
"BlockDeviceMappings": {
"shape_name": "BlockDeviceMappingList",
"type": "list",
"members": {
"shape_name": "BlockDeviceMapping",
"type": "structure",
"members": {
"VirtualName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The virtual device name.</p>\n "
},
"DeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name exposed to the instance (for example, <code>/dev/sdh</code>).</p>\n "
},
"Ebs": {
"shape_name": "EbsBlockDevice",
"type": "structure",
"members": {
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the snapshot.</p>\n "
},
"VolumeSize": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiB.</p>\n <p>Constraints: If the volume type is <code>io1</code>, the minimum size of the volume is 10 GiB.</p>\n <p>Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.</p>\n "
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n "
},
"VolumeType": {
"shape_name": "VolumeType",
"type": "string",
"enum": [
"standard",
"io1",
"gp2"
],
"documentation": "\n <p>The volume type.</p>\n <p>Default: <code>standard</code></p>\n "
},
"Iops": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of I/O operations per second (IOPS) that the\n volume supports.</p>\n <p>Constraint: Range is 100 to 4000.</p>\n <p>Condition: Required when the volume type is <code>io1</code>; not used with\n <code>standard</code> or <code>gp2</code> volumes.</p>\n "
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is encrypted.</p>\n "
}
},
"documentation": "\n <p>Parameters used to automatically set up Amazon EBS volumes when the instance is launched.</p>\n "
},
"NoDevice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Suppresses the specified device included in the block device mapping of the AMI.</p>\n "
}
},
"documentation": "\n <p>Describes a block device mapping.</p>\n ",
"xmlname": "BlockDeviceMapping"
},
"documentation": "\n <p>One or more block device mapping entries.</p>\n ",
"flattened": true
},
"Monitoring": {
"type": "structure",
"members": {
"Enabled": {
"shape_name": "Boolean",
"type": "boolean",
"required": true,
"documentation": "\n <p>Enables monitoring for the instance.</p>\n <p>Default: Disabled</p>\n "
}
}
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the subnet in which to launch the Spot Instance.</p>\n "
},
"NetworkInterfaces": {
"shape_name": "InstanceNetworkInterfaceSpecificationList",
"type": "list",
"members": {
"shape_name": "InstanceNetworkInterfaceSpecification",
"type": "structure",
"members": {
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n "
},
"DeviceIndex": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The index of the device on the instance for the network interface attachment.</p>\n "
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet associated with the network string.</p>\n "
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The description of the network interface.</p>\n "
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP address of the network interface.</p>\n "
},
"Groups": {
"shape_name": "SecurityGroupIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "SecurityGroupId"
},
"documentation": "\n\t\t <p>The IDs of the security groups for the network interface.</p>\n ",
"flattened": true
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>If set to <code>true</code>, the interface is deleted when the instance is terminated.</p>\n "
},
"PrivateIpAddresses": {
"shape_name": "PrivateIpAddressSpecificationList",
"type": "list",
"members": {
"shape_name": "PrivateIpAddressSpecification",
"type": "structure",
"members": {
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP addresses.</p>\n ",
"required": true
},
"Primary": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the private IP address is the primary private IP address.</p>\n "
}
},
"documentation": "\n\t\t <p>Describes a secondary private IP address for a network interface.</p>\n "
},
"documentation": "\n\t\t <p>One or more private IP addresses to assign to the network interface.</p>\n ",
"flattened": true
},
"SecondaryPrivateIpAddressCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The number of secondary private IP addresses.</p>\n "
},
"AssociatePublicIpAddress": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether to auto-assign a public IP address to an instance in a VPC. This public IP address can be assigned to the network interface for eth0 only when you launch the instance. You must create the network interface instead of using an existing network interface for eth0, and you must not specify more than one network interface.</p>\n "
}
},
"documentation": "\n\t\t <p>Describes a network interface.</p>\n ",
"xmlname": "NetworkInterface"
},
"documentation": "\n <p>One or more network interfaces.</p>\n ",
"flattened": true
},
"IamInstanceProfile": {
"shape_name": "IamInstanceProfileSpecification",
"type": "structure",
"members": {
"Arn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Amazon Resource Name (ARN) of the instance profile.</p>\n "
},
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the instance profile.</p>\n "
}
},
"documentation": "\n <p>The IAM instance profile.</p>\n "
},
"EbsOptimized": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal EBS I/O performance. This\n\t\t\t\toptimization isn't available with all instance types. Additional usage\n\t\t\t\tcharges apply when using an EBS Optimized instance.</p>\n <p>Default: <code>false</code></p>\n "
},
"SecurityGroupIds": {
"type": "list",
"members": {
"type": "string",
"xmlname": "SecurityGroupId"
},
"flattened": true
},
"SecurityGroups": {
"type": "list",
"members": {
"type": "string",
"xmlname": "SecurityGroup"
},
"flattened": true
}
},
"documentation": "\n <p>The launch specification.</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "RequestSpotInstancesResult",
"type": "structure",
"members": {
"SpotInstanceRequests": {
"shape_name": "SpotInstanceRequestList",
"type": "list",
"members": {
"shape_name": "SpotInstanceRequest",
"type": "structure",
"members": {
"SpotInstanceRequestId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Spot Instance request.</p>\n ",
"xmlname": "spotInstanceRequestId"
},
"SpotPrice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The maximum hourly price for any Spot Instance launched to fulfill the request.</p>\n ",
"xmlname": "spotPrice"
},
"Type": {
"shape_name": "SpotInstanceType",
"type": "string",
"enum": [
"one-time",
"persistent"
],
"documentation": "\n <p>The Spot Instance request type.</p>\n ",
"xmlname": "type"
},
"State": {
"shape_name": "SpotInstanceState",
"type": "string",
"enum": [
"open",
"active",
"closed",
"cancelled",
"failed"
],
"documentation": "\n <p>The state of the Spot Instance request. Spot bid status information can help you track your \n\t\t\t\tSpot Instance requests. For information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-bid-status.html\">Tracking Spot Requests with Bid Status Codes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n ",
"xmlname": "state"
},
"Fault": {
"shape_name": "SpotInstanceStateFault",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason code for the Spot Instance state change.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The message for the Spot Instance state change.</p>\n ",
"xmlname": "message"
}
},
"documentation": "\n <p>The fault codes for the Spot Instance request, if any.</p>\n ",
"xmlname": "fault"
},
"Status": {
"shape_name": "SpotInstanceStatus",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The status code of the request.</p>\n ",
"xmlname": "code"
},
"UpdateTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time of the most recent status update.</p>\n ",
"xmlname": "updateTime"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The description for the status code for the Spot request.</p>\n ",
"xmlname": "message"
}
},
"documentation": "\n <p>The status code and status message describing the Spot Instance request.</p>\n ",
"xmlname": "status"
},
"ValidFrom": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The start date of the request. If this is a one-time request, the request becomes\n\t\t\t\tactive at this date and time and remains active until all\n\t\t\t\tinstances launch, the request expires, or the request is\n\t\t\t\tcanceled. If the request is persistent, the request becomes\n\t\t\t\tactive at this date and time and remains active until it expires\n\t\t\t\tor is canceled.</p>\n ",
"xmlname": "validFrom"
},
"ValidUntil": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The end date of the request. If this is a one-time request, the request remains\n\t\t\t\tactive until all instances launch, the request is canceled, or\n\t\t\t\tthis date is reached. If the request is persistent, it remains\n\t\t\t\tactive until it is canceled or this date is reached.</p>\n ",
"xmlname": "validUntil"
},
"LaunchGroup": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The instance launch group. Launch groups are Spot Instances that launch\n\t\t\t\ttogether and terminate together.</p>\n ",
"xmlname": "launchGroup"
},
"AvailabilityZoneGroup": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone group. If you specify the same Availability Zone group\n\t\t\t\tfor all Spot Instance requests, all Spot Instances are launched in the same\n\t\t\t\tAvailability Zone.</p>\n ",
"xmlname": "availabilityZoneGroup"
},
"LaunchSpecification": {
"shape_name": "LaunchSpecification",
"type": "structure",
"members": {
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI.</p>\n ",
"xmlname": "imageId"
},
"KeyName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the key pair.</p>\n ",
"xmlname": "keyName"
},
"SecurityGroups": {
"shape_name": "GroupIdentifierList",
"type": "list",
"members": {
"shape_name": "GroupIdentifier",
"type": "structure",
"members": {
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more security groups.</p>\n ",
"xmlname": "groupSet"
},
"UserData": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Base64-encoded MIME user data to make available to the instances.</p>\n ",
"xmlname": "userData"
},
"AddressingType": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p></p>\n ",
"xmlname": "addressingType"
},
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type.</p>\n ",
"xmlname": "instanceType"
},
"Placement": {
"shape_name": "SpotPlacement",
"type": "structure",
"members": {
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone.</p>\n ",
"xmlname": "availabilityZone"
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone group name.</p>\n ",
"xmlname": "groupName"
}
},
"documentation": "\n <p>The placement information for the instance.</p>\n ",
"xmlname": "placement"
},
"KernelId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the kernel.</p>\n ",
"xmlname": "kernelId"
},
"RamdiskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the RAM disk.</p>\n ",
"xmlname": "ramdiskId"
},
"BlockDeviceMappings": {
"shape_name": "BlockDeviceMappingList",
"type": "list",
"members": {
"shape_name": "BlockDeviceMapping",
"type": "structure",
"members": {
"VirtualName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The virtual device name.</p>\n ",
"xmlname": "virtualName"
},
"DeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name exposed to the instance (for example, <code>/dev/sdh</code>).</p>\n ",
"xmlname": "deviceName"
},
"Ebs": {
"shape_name": "EbsBlockDevice",
"type": "structure",
"members": {
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the snapshot.</p>\n ",
"xmlname": "snapshotId"
},
"VolumeSize": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiB.</p>\n <p>Constraints: If the volume type is <code>io1</code>, the minimum size of the volume is 10 GiB.</p>\n <p>Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.</p>\n ",
"xmlname": "volumeSize"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n ",
"xmlname": "deleteOnTermination"
},
"VolumeType": {
"shape_name": "VolumeType",
"type": "string",
"enum": [
"standard",
"io1",
"gp2"
],
"documentation": "\n <p>The volume type.</p>\n <p>Default: <code>standard</code></p>\n ",
"xmlname": "volumeType"
},
"Iops": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of I/O operations per second (IOPS) that the\n volume supports.</p>\n <p>Constraint: Range is 100 to 4000.</p>\n <p>Condition: Required when the volume type is <code>io1</code>; not used with\n <code>standard</code> or <code>gp2</code> volumes.</p>\n ",
"xmlname": "iops"
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is encrypted.</p>\n ",
"xmlname": "encrypted"
}
},
"documentation": "\n <p>Parameters used to automatically set up Amazon EBS volumes when the instance is launched.</p>\n ",
"xmlname": "ebs"
},
"NoDevice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Suppresses the specified device included in the block device mapping of the AMI.</p>\n ",
"xmlname": "noDevice"
}
},
"documentation": "\n <p>Describes a block device mapping.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more block device mapping entries.</p>\n ",
"xmlname": "blockDeviceMapping"
},
"MonitoringEnabled": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Enables monitoring for the instance.</p>\n <p>Default: Disabled</p>\n ",
"xmlname": "monitoringEnabled"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the subnet in which to launch the Spot Instance.</p>\n ",
"xmlname": "subnetId"
},
"NetworkInterfaces": {
"shape_name": "InstanceNetworkInterfaceSpecificationList",
"type": "list",
"members": {
"shape_name": "InstanceNetworkInterfaceSpecification",
"type": "structure",
"members": {
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"xmlname": "networkInterfaceId"
},
"DeviceIndex": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The index of the device on the instance for the network interface attachment.</p>\n ",
"xmlname": "deviceIndex"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet associated with the network string.</p>\n ",
"xmlname": "subnetId"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The description of the network interface.</p>\n ",
"xmlname": "description"
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP address of the network interface.</p>\n ",
"xmlname": "privateIpAddress"
},
"Groups": {
"shape_name": "SecurityGroupIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "SecurityGroupId"
},
"documentation": "\n\t\t <p>The IDs of the security groups for the network interface.</p>\n ",
"xmlname": "SecurityGroupId"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>If set to <code>true</code>, the interface is deleted when the instance is terminated.</p>\n ",
"xmlname": "deleteOnTermination"
},
"PrivateIpAddresses": {
"shape_name": "PrivateIpAddressSpecificationList",
"type": "list",
"members": {
"shape_name": "PrivateIpAddressSpecification",
"type": "structure",
"members": {
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP addresses.</p>\n ",
"required": true,
"xmlname": "privateIpAddress"
},
"Primary": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the private IP address is the primary private IP address.</p>\n ",
"xmlname": "primary"
}
},
"documentation": "\n\t\t <p>Describes a secondary private IP address for a network interface.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more private IP addresses to assign to the network interface.</p>\n ",
"xmlname": "privateIpAddressesSet"
},
"SecondaryPrivateIpAddressCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The number of secondary private IP addresses.</p>\n ",
"xmlname": "secondaryPrivateIpAddressCount"
},
"AssociatePublicIpAddress": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether to auto-assign a public IP address to an instance in a VPC. This public IP address can be assigned to the network interface for eth0 only when you launch the instance. You must create the network interface instead of using an existing network interface for eth0, and you must not specify more than one network interface.</p>\n ",
"xmlname": "associatePublicIpAddress"
}
},
"documentation": "\n\t\t <p>Describes a network interface.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more network interfaces.</p>\n ",
"xmlname": "networkInterfaceSet"
},
"IamInstanceProfile": {
"shape_name": "IamInstanceProfileSpecification",
"type": "structure",
"members": {
"Arn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Amazon Resource Name (ARN) of the instance profile.</p>\n ",
"xmlname": "arn"
},
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the instance profile.</p>\n ",
"xmlname": "name"
}
},
"documentation": "\n <p>The IAM instance profile.</p>\n ",
"xmlname": "iamInstanceProfile"
},
"EbsOptimized": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal EBS I/O performance. This\n\t\t\t\toptimization isn't available with all instance types. Additional usage\n\t\t\t\tcharges apply when using an EBS Optimized instance.</p>\n <p>Default: <code>false</code></p>\n ",
"xmlname": "ebsOptimized"
}
},
"documentation": "\n <p>Additional information for launching instances.</p>\n ",
"xmlname": "launchSpecification"
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The instance ID, if an instance has been launched to fulfill the Spot Instance\n\t\t\t\trequest.</p>\n ",
"xmlname": "instanceId"
},
"CreateTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when the Spot Instance request was created.</p>\n ",
"xmlname": "createTime"
},
"ProductDescription": {
"shape_name": "RIProductDescription",
"type": "string",
"enum": [
"Linux/UNIX",
"Linux/UNIX (Amazon VPC)",
"Windows",
"Windows (Amazon VPC)"
],
"documentation": "\n <p>The product description associated with the Spot Instance.</p>\n ",
"xmlname": "productDescription"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the resource.</p>\n ",
"xmlname": "tagSet"
},
"LaunchedAvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone in which the bid is launched.</p>\n ",
"xmlname": "launchedAvailabilityZone"
}
},
"documentation": "\n <p>Describe a Spot Instance request.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about the Spot Instance request.</p>\n ",
"xmlname": "spotInstanceRequestSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n <p>Creates a Spot Instance request. Spot Instances are instances that Amazon EC2\n\t\t\t\tstarts on your behalf when the maximum price that you specify exceeds the current\n\t\t\t\tSpot Price. Amazon EC2 periodically sets the Spot Price based on available Spot\n\t\t\t\tInstance capacity and current Spot Instance requests. For more information about\n\t\t\t\tSpot Instances, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html\">Spot\n\t\t\t\tInstances</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a Spot Instance request for two <code>m1.small</code>\n\t\t\t\t\tinstances and associates an IAM instance profile called <code>s3access</code>\n\t\t\t\t\twith them.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RequestSpotInstances\n&amp;SpotPrice=0.50\n&amp;InstanceCount=2\n&amp;Type=one-time\n&amp;AvailabilityZoneGroup=MyAzGroup\n&amp;LaunchSpecification.ImageId=ami-1a2b3c4d\n&amp;LaunchSpecification.KeyName=my-key-pair\n&amp;LaunchSpecification.SecurityGroup.1=websrv\n&amp;LaunchSpecification.InstanceType=m1.small\n&amp;LaunchSpecification.IamInstanceProfile.Name=s3access\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;RequestSpotInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n <spotInstanceRequestSet>\n <item>\n <spotInstanceRequestId>sir-1a2b3c4d</spotInstanceRequestId>\n <spotPrice>0.5</spotPrice>\n <type>one-time</type>\n <state>open</state>\n <status>\n <code>pending-evaluation</code>\n <updateTime>YYYY-MM-DDTHH:MM:SS.000Z</updateTime>\n <message>Your Spot request has been submitted for review, and is pending evaluation.</message>\n </status>\n <availabilityZoneGroup>MyAzGroup</availabilityZoneGroup>\n <launchSpecification>\n <imageId>ami-1a2b3c4d</imageId>\n <keyName>my-key-pair</keyName>\n <groupSet>\n <item>\n <groupId>sg-1a2b3c4d</groupId>\n <groupName>websrv</groupName>\n </item>\n </groupSet>\n <instanceType>m1.small</instanceType>\n <blockDeviceMapping/>\n <monitoring>\n <enabled>false</enabled>\n </monitoring>\n <ebsOptimized>false</ebsOptimized>\n </launchSpecification>\n <createTime>YYYY-MM-DDTHH:MM:SS.000Z</createTime>\n <productDescription>Linux/UNIX</productDescription>\n </item>\n </spotInstanceRequestSet>\n</RequestSpotInstancesResponse></queryresponse>\n </example>\n </examples>\n "
},
"ResetImageAttribute": {
"name": "ResetImageAttribute",
"input": {
"shape_name": "ResetImageAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI.</p>\n ",
"required": true
},
"Attribute": {
"shape_name": "ResetImageAttributeName",
"type": "string",
"enum": [
"launchPermission"
],
"documentation": "\n <p>The attribute to reset (currently you can only reset the launch\n\t\t\t\tpermission attribute).</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": " \n <p>Resets an attribute of an AMI to its default value.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example resets the <code>launchPermission</code> attribute for the\n\t\t\t\t\tspecified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ResetImageAttribute\n&amp;ImageId=ami-61a54008\n&amp;Attribute=launchPermission\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ResetImageAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/ResetImageAttributeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ResetInstanceAttribute": {
"name": "ResetInstanceAttribute",
"input": {
"shape_name": "ResetInstanceAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"required": true
},
"Attribute": {
"shape_name": "InstanceAttributeName",
"type": "string",
"enum": [
"instanceType",
"kernel",
"ramdisk",
"userData",
"disableApiTermination",
"instanceInitiatedShutdownBehavior",
"rootDeviceName",
"blockDeviceMapping",
"productCodes",
"sourceDestCheck",
"groupSet",
"ebsOptimized",
"sriovNetSupport"
],
"documentation": "\n <p>The attribute to reset.</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t\t<p>Resets an attribute of an instance to its default value. To reset the kernel or\n\t\t\t\tRAM disk, the instance must be in a stopped state. To reset the\n\t\t\t\t<code>SourceDestCheck</code>, the instance can be either running or stopped.</p>\n\t\t\t<p>The <code>SourceDestCheck</code> attribute controls whether\n\t\t\t\tsource/destination checking is enabled. The default value is\n\t\t\t\t<code>true</code>, which means checking is enabled. This value must be\n\t\t\t\t<code>false</code> for a NAT instance to perform NAT. For more information, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html\">NAT Instances</a> in the\n\t\t\t\t<i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example resets the <code>sourceDestCheck</code> attribute.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ResetInstanceAttribute\n&amp;InstanceId=i-1a2b3c4d\n&amp;Attribute=sourceDestCheck\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ResetInstanceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/ResetInstanceAttributeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ResetNetworkInterfaceAttribute": {
"name": "ResetNetworkInterfaceAttribute",
"input": {
"shape_name": "ResetNetworkInterfaceAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"required": true
},
"SourceDestCheck": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>Indicates whether source/destination checking is enabled. A value\n\t\t\t\tof <code>true</code> means checking is enabled, and\n\t\t\t\t<code>false</code> means checking is disabled. This value\n\t\t\t\tmust be <code>false</code> for a NAT instance to perform NAT.</p>\n "
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Resets a network interface attribute. You can specify only one attribute at a time.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example resets the <code>sourceDestCheck</code> attribute for the \n\t\t\t\t specified network interface.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ResetNetworkInterfaceAttribute\n&amp;NetworkInterfaceId=eni-ffda3197\n&amp;Attribute=sourceDestCheck\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ResetNetworkInterfaceAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;5187642e-3f16-44a3-b05f-24c3848b5162&lt;/requestId&gt;\n &lt;return&gt;true&lt;/return&gt;\n&lt;/ResetNetworkInterfaceAttributeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"ResetSnapshotAttribute": {
"name": "ResetSnapshotAttribute",
"input": {
"shape_name": "ResetSnapshotAttributeRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the snapshot.</p>\n ",
"required": true
},
"Attribute": {
"shape_name": "SnapshotAttributeName",
"type": "string",
"enum": [
"productCodes",
"createVolumePermission"
],
"documentation": "\n <p>The attribute to reset (currently only the attribute for permission to create volumes can be\n reset).</p>\n ",
"required": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Resets permission settings for the specified snapshot.</p>\n <p>For more information on modifying snapshot permissions, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html\">Sharing Snapshots</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example resets the permissions for <code>snap-1a2b3c4d</code>, making it a\n private snapshot that can only be used by the account that created it.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ResetSnapshotAttribute\n&amp;SnapshotId=snap-1a2b3c4d\n&amp;Attribute=createVolumePermission\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;ResetSnapshotAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-05-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/ResetSnapshotAttributeResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"RevokeSecurityGroupEgress": {
"name": "RevokeSecurityGroupEgress",
"input": {
"shape_name": "RevokeSecurityGroupEgressRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"required": true
},
"SourceSecurityGroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.</p>\n "
},
"SourceSecurityGroupOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the source security group. You can't specify a source security group and a CIDR IP address range.</p>\n "
},
"IpProtocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The IP protocol name (<code>tcp</code>, <code>udp</code>, <code>icmp</code>) or number \n (see <a href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Protocol Numbers</a>). \n Use <code>-1</code> to specify all.</p>\n "
},
"FromPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use <code>-1</code> to specify all ICMP types.</p>\n "
},
"ToPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use <code>-1</code> to specify all ICMP codes for the ICMP type.</p>\n "
},
"CidrIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The CIDR IP address range. You can't specify this parameter when specifying a source security group.</p>\n "
},
"IpPermissions": {
"shape_name": "IpPermissionList",
"type": "list",
"members": {
"shape_name": "IpPermission",
"type": "structure",
"members": {
"IpProtocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The protocol.</p>\n\t\t <p>When you call <a>DescribeSecurityGroups</a>, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, <code>tcp</code>,\n\t\t\t\t<code>udp</code>, or <code>icmp</code>). For a list of\n\t\t\t\tprotocol numbers, see <a href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Protocol Numbers</a>.</p>\n "
},
"FromPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of <code>-1</code> indicates all ICMP types.</p>\n "
},
"ToPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The end of port range for the TCP and UDP protocols, or an ICMP code. A value of <code>-1</code>\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.</p>\n "
},
"UserIdGroupPairs": {
"shape_name": "UserIdGroupPairList",
"type": "list",
"members": {
"shape_name": "UserIdGroupPair",
"type": "structure",
"members": {
"UserId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of an AWS account.</p>\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group owned by the specified AWS account.</p>\n "
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group in the specified AWS account.</p>\n "
}
},
"documentation": "\n <p>Describes a security group and AWS account ID pair for EC2-Classic.</p>\n ",
"xmlname": "Groups"
},
"documentation": "\n\t\t <p>One or more security group and AWS account ID pairs.</p>\n ",
"flattened": true
},
"IpRanges": {
"shape_name": "IpRangeList",
"type": "list",
"members": {
"shape_name": "IpRange",
"type": "structure",
"members": {
"CidrIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR range. You can either specify a CIDR range or a source security group, not both.</p>\n "
}
},
"documentation": "\n\t\t <p>Describes an IP range.</p>\n "
},
"documentation": "\n\t\t <p>One or more IP ranges.</p>\n ",
"flattened": true
}
},
"documentation": "\n\t\t <p>Describes a security group rule.</p>\n "
},
"documentation": "\n <p></p>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Removes one or more egress rules from a security group for EC2-VPC. The values\n\t\t\t\tthat you specify in the revoke request (for example, ports) must match the existing\n\t\t\t\trule's values for the rule to be revoked.</p>\n <p>Each rule consists of the protocol and the CIDR range or source security\n\t\t\t\tgroup. For the TCP and UDP protocols, you must also specify the destination port or\n\t\t\t\trange of ports. For the ICMP protocol, you must also specify the ICMP type and code.</p>\n <p>Rule changes are propagated to instances within the security group as quickly as\n\t\t\t\tpossible. However, a small delay might occur.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example revokes the access that the specified security group\n\t\t\t\t\thas to the <code>205.192.0.0/16</code> and <code>205.159.0.0/16</code>\n\t\t\t\t\taddress ranges on TCP port 80.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RevokeSecurityGroupEgress\n&amp;GroupId=sg-1a2b3c4d\n&amp;IpPermissions.1.IpProtocol=tcp\n&amp;IpPermissions.1.FromPort=80\n&amp;IpPermissions.1.ToPort=80\n&amp;IpPermissions.1.IpRanges.1.CidrIp=205.192.0.0/16\n&amp;IpPermissions.1.IpRanges.2.CidrIp=205.159.0.0/16\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example revokes the access that the specified security group \n\t\t\t\t\thas to the security group with the ID <code>sg-9a8d7f5c</code> on TCP\tport 1433.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RevokeSecurityGroupEgress\n&amp;GroupId=sg-1a2b3c4d\n&amp;IpPermissions.1.IpProtocol=tcp\n&amp;IpPermissions.1.FromPort=1433\n&amp;IpPermissions.1.ToPort=1433\n&amp;IpPermissions.1.Groups.1.GroupId=sg-9a8d7f5c\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"RevokeSecurityGroupIngress": {
"name": "RevokeSecurityGroupIngress",
"input": {
"shape_name": "RevokeSecurityGroupIngressRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-Classic, default VPC] The name of the security group.</p>\n "
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n "
},
"SourceSecurityGroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.</p>\n "
},
"SourceSecurityGroupOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the source security group. You can't specify a source security group and a CIDR IP address range.</p>\n "
},
"IpProtocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The IP protocol name (<code>tcp</code>, <code>udp</code>, <code>icmp</code>) or number \n (see <a href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Protocol Numbers</a>). \n Use <code>-1</code> to specify all.</p>\n "
},
"FromPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use <code>-1</code> to specify all ICMP types.</p>\n "
},
"ToPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use <code>-1</code> to specify all ICMP codes for the ICMP type.</p>\n "
},
"CidrIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The CIDR IP address range. You can't specify this parameter when specifying a source security group.</p>\n "
},
"IpPermissions": {
"shape_name": "IpPermissionList",
"type": "list",
"members": {
"shape_name": "IpPermission",
"type": "structure",
"members": {
"IpProtocol": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The protocol.</p>\n\t\t <p>When you call <a>DescribeSecurityGroups</a>, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, <code>tcp</code>,\n\t\t\t\t<code>udp</code>, or <code>icmp</code>). For a list of\n\t\t\t\tprotocol numbers, see <a href=\"http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml\">Protocol Numbers</a>.</p>\n "
},
"FromPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of <code>-1</code> indicates all ICMP types.</p>\n "
},
"ToPort": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The end of port range for the TCP and UDP protocols, or an ICMP code. A value of <code>-1</code>\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.</p>\n "
},
"UserIdGroupPairs": {
"shape_name": "UserIdGroupPairList",
"type": "list",
"members": {
"shape_name": "UserIdGroupPair",
"type": "structure",
"members": {
"UserId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of an AWS account.</p>\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group owned by the specified AWS account.</p>\n "
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group in the specified AWS account.</p>\n "
}
},
"documentation": "\n <p>Describes a security group and AWS account ID pair for EC2-Classic.</p>\n ",
"xmlname": "Groups"
},
"documentation": "\n\t\t <p>One or more security group and AWS account ID pairs.</p>\n ",
"flattened": true
},
"IpRanges": {
"shape_name": "IpRangeList",
"type": "list",
"members": {
"shape_name": "IpRange",
"type": "structure",
"members": {
"CidrIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The CIDR range. You can either specify a CIDR range or a source security group, not both.</p>\n "
}
},
"documentation": "\n\t\t <p>Describes an IP range.</p>\n "
},
"documentation": "\n\t\t <p>One or more IP ranges.</p>\n ",
"flattened": true
}
},
"documentation": "\n\t\t <p>Describes a security group rule.</p>\n "
},
"documentation": "\n <p></p>\n ",
"flattened": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n <p>Removes one or more ingress rules from a security group. The values\n\t\t\t\tthat you specify in the revoke request (for example, ports) must match the existing\n\t\t\t\trule's values for the rule to be removed.</p>\n <p>Each rule consists of the protocol and the CIDR range or source security\n\t\t\t\tgroup. For the TCP and UDP protocols, you must also specify the destination port or\n\t\t\t\trange of ports. For the ICMP protocol, you must also specify the ICMP type and code.</p>\n <p>Rule changes are propagated to instances within the security group as quickly as\n\t\t\t\tpossible. However, a small delay might occur.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example revokes TCP port 80 access from the <code>205.192.0.0/16</code> address range\n\t\t\t\t\tfor the security group named <code>websrv</code>. If the security group is for\n\t\t\t\t\ta VPC, specify the ID of the security group instead of the name.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RevokeSecurityGroupIngress\n&amp;GroupName=websrv\n&amp;IpProtocol=tcp\n&amp;FromPort=80\n&amp;ToPort=80\n&amp;CidrIp=205.192.0.0/16\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;RevokeSecurityGroupIngressResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/RevokeSecurityGroupIngressResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"RunInstances": {
"name": "RunInstances",
"input": {
"shape_name": "RunInstancesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI, which you can get by calling <a>DescribeImages</a>.</p>\n ",
"required": true
},
"MinCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The minimum number of instances to launch. If you specify a minimum that is more instances\n than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.</p>\n <p>Constraints: Between 1 and the maximum number you're allowed for the specified instance type. \n For more information about the default limits, and how to request an increase, see \n <a href=\"http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2\">How\n many instances can I run in Amazon EC2</a> in the Amazon EC2 General FAQ.</p>\n ",
"required": true
},
"MaxCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The maximum number of instances to launch. If you specify more instances\n than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the\n largest possible number of instances above <code>MinCount</code>.</p>\n <p>Constraints: Between 1 and the maximum number you're allowed for the specified instance type. \n For more information about the default limits, and how to request an increase, see \n <a href=\"http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2\">How\n many instances can I run in Amazon EC2</a> in the Amazon EC2 General FAQ.</p>\n ",
"required": true
},
"KeyName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the key pair. You can create a key pair using <a>CreateKeyPair</a> or <a>ImportKeyPair</a>.</p>\n <important>\n <p>If you launch an instance without specifying a key pair, you can't connect to the instance.</p>\n </important>\n "
},
"SecurityGroups": {
"shape_name": "SecurityGroupStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "SecurityGroup"
},
"documentation": "\n <p>[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use\n security group IDs instead.</p>\n <p>Default: Amazon EC2 uses the default security group.</p>\n ",
"flattened": true
},
"SecurityGroupIds": {
"shape_name": "SecurityGroupIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "SecurityGroupId"
},
"documentation": "\n <p>One or more security group IDs. You can create a security group using <a>CreateSecurityGroup</a>.</p>\n <p>Default: Amazon EC2 uses the default security group.</p>\n ",
"flattened": true
},
"UserData": {
"shape_name": "String",
"type": "blob",
"documentation": "\n <p>The user data for the instances. You can specify the user data as a string, or if the user data contents are in a file, you can use file://filename.</p>\n "
},
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html\">Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>Default: <code>m1.small</code></p>\n "
},
"Placement": {
"shape_name": "Placement",
"type": "structure",
"members": {
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone of the instance.</p>\n "
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the placement group the instance is in (for cluster compute instances).</p>\n "
},
"Tenancy": {
"shape_name": "Tenancy",
"type": "string",
"enum": [
"default",
"dedicated"
],
"documentation": "\n <p>The tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of <code>dedicated</code> runs\n on single-tenant hardware.</p>\n "
}
},
"documentation": "\n <p>The placement for the instance.</p>\n "
},
"KernelId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the kernel.</p>\n <important>\n <p>We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information,\n see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html#pv-grub-a-new-amazon-kernel-image\">\n PV-GRUB: A New Amazon Kernel Image</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n </important>\n "
},
"RamdiskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the RAM disk.</p>\n "
},
"BlockDeviceMappings": {
"shape_name": "BlockDeviceMappingRequestList",
"type": "list",
"members": {
"shape_name": "BlockDeviceMapping",
"type": "structure",
"members": {
"VirtualName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The virtual device name.</p>\n "
},
"DeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name exposed to the instance (for example, <code>/dev/sdh</code>).</p>\n "
},
"Ebs": {
"shape_name": "EbsBlockDevice",
"type": "structure",
"members": {
"SnapshotId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the snapshot.</p>\n "
},
"VolumeSize": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The size of the volume, in GiB.</p>\n <p>Constraints: If the volume type is <code>io1</code>, the minimum size of the volume is 10 GiB.</p>\n <p>Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.</p>\n "
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is deleted on instance termination.</p>\n "
},
"VolumeType": {
"shape_name": "VolumeType",
"type": "string",
"enum": [
"standard",
"io1",
"gp2"
],
"documentation": "\n <p>The volume type.</p>\n <p>Default: <code>standard</code></p>\n "
},
"Iops": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The number of I/O operations per second (IOPS) that the\n volume supports.</p>\n <p>Constraint: Range is 100 to 4000.</p>\n <p>Condition: Required when the volume type is <code>io1</code>; not used with\n <code>standard</code> or <code>gp2</code> volumes.</p>\n "
},
"Encrypted": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the Amazon EBS volume is encrypted.</p>\n "
}
},
"documentation": "\n <p>Parameters used to automatically set up Amazon EBS volumes when the instance is launched.</p>\n "
},
"NoDevice": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Suppresses the specified device included in the block device mapping of the AMI.</p>\n "
}
},
"documentation": "\n <p>Describes a block device mapping.</p>\n ",
"xmlname": "BlockDeviceMapping"
},
"documentation": "\n <p>The block device mapping.</p>\n ",
"flattened": true
},
"Monitoring": {
"shape_name": "RunInstancesMonitoringEnabled",
"type": "structure",
"members": {
"Enabled": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether monitoring is enabled for the instance.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The monitoring for the instance.</p>\n "
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] The ID of the subnet to launch the instance into.</p>\n "
},
"DisableApiTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>If you set this parameter to <code>true</code>, you can't terminate the instance using the Amazon EC2\n console, CLI, or API; otherwise, you can. If you set this parameter to <code>true</code> and then later want\n to be able to terminate the instance, you must first change the value of the\n <code>disableApiTermination</code> attribute to <code>false</code> using\n <a>ModifyInstanceAttribute</a>. Alternatively, if you set\n <code>InstanceInitiatedShutdownBehavior</code> to <code>terminate</code>,\n you can terminate the instance by running the shutdown command from the instance.</p>\n <p>Default: <code>false</code></p>\n "
},
"InstanceInitiatedShutdownBehavior": {
"shape_name": "ShutdownBehavior",
"type": "string",
"enum": [
"stop",
"terminate"
],
"documentation": "\n <p>Indicates whether an instance stops or terminates when you initiate\n shutdown from the instance (using the operating system command for system shutdown).</p>\n <p>Default: <code>stop</code></p>\n "
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>[EC2-VPC] The primary IP address. You must specify a value\n from the IP address range of the subnet.</p>\n <p>Only one private IP address can be designated as primary.\n Therefore, you can't specify this parameter if\n <code>PrivateIpAddresses.n.Primary</code> is set to\n <code>true</code> and <code>PrivateIpAddresses.n.PrivateIpAddress</code>\n is set to an IP address. </p>\n <p>Default: We select an IP address from the IP address range of the subnet.</p>\n "
},
"ClientToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information,\n see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html\">How to Ensure Idempotency</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>Constraints: Maximum 64 ASCII characters</p>\n "
},
"AdditionalInfo": {
"shape_name": "String",
"type": "string",
"documentation": "\n "
},
"NetworkInterfaces": {
"shape_name": "InstanceNetworkInterfaceSpecificationList",
"type": "list",
"members": {
"shape_name": "InstanceNetworkInterfaceSpecification",
"type": "structure",
"members": {
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n "
},
"DeviceIndex": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The index of the device on the instance for the network interface attachment.</p>\n "
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet associated with the network string.</p>\n "
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The description of the network interface.</p>\n "
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP address of the network interface.</p>\n "
},
"Groups": {
"shape_name": "SecurityGroupIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "SecurityGroupId"
},
"documentation": "\n\t\t <p>The IDs of the security groups for the network interface.</p>\n ",
"flattened": true
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>If set to <code>true</code>, the interface is deleted when the instance is terminated.</p>\n "
},
"PrivateIpAddresses": {
"shape_name": "PrivateIpAddressSpecificationList",
"type": "list",
"members": {
"shape_name": "PrivateIpAddressSpecification",
"type": "structure",
"members": {
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP addresses.</p>\n ",
"required": true
},
"Primary": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the private IP address is the primary private IP address.</p>\n "
}
},
"documentation": "\n\t\t <p>Describes a secondary private IP address for a network interface.</p>\n ",
"xmlname": "PrivateIpAddresses"
},
"documentation": "\n\t\t <p>One or more private IP addresses to assign to the network interface.</p>\n ",
"flattened": true
},
"SecondaryPrivateIpAddressCount": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The number of secondary private IP addresses.</p>\n "
},
"AssociatePublicIpAddress": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether to auto-assign a public IP address to an instance in a VPC. This public IP address can be assigned to the network interface for eth0 only when you launch the instance. You must create the network interface instead of using an existing network interface for eth0, and you must not specify more than one network interface.</p>\n "
}
},
"documentation": "\n\t\t <p>Describes a network interface.</p>\n ",
"xmlname": "NetworkInterface"
},
"documentation": "\n <p>One or more network interfaces.</p>\n ",
"flattened": true
},
"IamInstanceProfile": {
"shape_name": "IamInstanceProfileSpecification",
"type": "structure",
"members": {
"Arn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Amazon Resource Name (ARN) of the instance profile.</p>\n "
},
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the instance profile.</p>\n "
}
},
"documentation": "\n <p>The IAM instance profile.</p>\n "
},
"EbsOptimized": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the instance is optimized for EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized\n configuration stack to provide optimal Amazon EBS I/O performance. This\n optimization isn't available with all instance types. Additional usage\n charges apply when using an EBS-optimized instance.</p>\n <p>Default: <code>false</code></p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "Reservation",
"type": "structure",
"members": {
"ReservationId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the reservation.</p>\n ",
"xmlname": "reservationId"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AWS account that owns the reservation.</p>\n ",
"xmlname": "ownerId"
},
"RequesterId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the requester that launched the instances on your behalf (for example,\n\t\t\t\tAWS Management Console or Auto Scaling).</p>\n ",
"xmlname": "requesterId"
},
"Groups": {
"shape_name": "GroupIdentifierList",
"type": "list",
"members": {
"shape_name": "GroupIdentifier",
"type": "structure",
"members": {
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more security groups.</p>\n ",
"xmlname": "groupSet"
},
"Instances": {
"shape_name": "InstanceList",
"type": "list",
"members": {
"shape_name": "Instance",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"ImageId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the AMI used to launch the instance.</p>\n ",
"xmlname": "imageId"
},
"State": {
"shape_name": "InstanceState",
"type": "structure",
"members": {
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.</p>\n\t\t <ul>\n\t\t <li><p><code>0</code> : <code>pending</code></p></li>\n\t\t <li><p><code>16</code> : <code>running</code></p></li>\n\t\t <li><p><code>32</code> : <code>shutting-down</code></p></li>\n\t\t <li><p><code>48</code> : <code>terminated</code></p></li>\n\t\t <li><p><code>64</code> : <code>stopping</code></p></li>\n\t\t <li><p><code>80</code> : <code>stopped</code></p></li>\n\t\t </ul>\n ",
"xmlname": "code"
},
"Name": {
"shape_name": "InstanceStateName",
"type": "string",
"enum": [
"pending",
"running",
"shutting-down",
"terminated",
"stopping",
"stopped"
],
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "name"
}
},
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "instanceState"
},
"PrivateDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The private DNS name assigned to the instance. This DNS name can only be used\n\t\t\t\tinside the Amazon EC2 network. This name is not available until the instance enters\n\t\t\t\tthe <code>running</code> state.</p>\n ",
"xmlname": "privateDnsName"
},
"PublicDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The public DNS name assigned to the instance.\n\t\t\t\tThis name is not available until the instance enters the <code>running</code> state.</p>\n ",
"xmlname": "dnsName"
},
"StateTransitionReason": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason for the most recent state transition. This might be an empty string.</p>\n ",
"xmlname": "reason"
},
"KeyName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the key pair, if this instance was launched with an associated key pair.</p>\n ",
"xmlname": "keyName"
},
"AmiLaunchIndex": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The AMI launch index, which can be used to find this instance in the launch group.</p>\n ",
"xmlname": "amiLaunchIndex"
},
"ProductCodes": {
"shape_name": "ProductCodeList",
"type": "list",
"members": {
"shape_name": "ProductCode",
"type": "structure",
"members": {
"ProductCodeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The product code.</p>\n ",
"xmlname": "productCode"
},
"ProductCodeType": {
"shape_name": "ProductCodeValues",
"type": "string",
"enum": [
"devpay",
"marketplace"
],
"documentation": "\n <p>The type of product code.</p>\n ",
"xmlname": "type"
}
},
"documentation": "\n <p>Describes a product code.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>The product codes attached to this instance.</p>\n ",
"xmlname": "productCodes"
},
"InstanceType": {
"shape_name": "InstanceType",
"type": "string",
"enum": [
"t1.micro",
"m1.small",
"m1.medium",
"m1.large",
"m1.xlarge",
"m3.medium",
"m3.large",
"m3.xlarge",
"m3.2xlarge",
"t2.micro",
"t2.small",
"t2.medium",
"m2.xlarge",
"m2.2xlarge",
"m2.4xlarge",
"cr1.8xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
"i2.8xlarge",
"hi1.4xlarge",
"hs1.8xlarge",
"c1.medium",
"c1.xlarge",
"c3.large",
"c3.xlarge",
"c3.2xlarge",
"c3.4xlarge",
"c3.8xlarge",
"cc1.4xlarge",
"cc2.8xlarge",
"g2.2xlarge",
"cg1.4xlarge",
"r3.large",
"r3.xlarge",
"r3.2xlarge",
"r3.4xlarge",
"r3.8xlarge"
],
"documentation": "\n <p>The instance type.</p>\n ",
"xmlname": "instanceType"
},
"LaunchTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time the instance was launched.</p>\n ",
"xmlname": "launchTime"
},
"Placement": {
"shape_name": "Placement",
"type": "structure",
"members": {
"AvailabilityZone": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Availability Zone of the instance.</p>\n ",
"xmlname": "availabilityZone"
},
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the placement group the instance is in (for cluster compute instances).</p>\n ",
"xmlname": "groupName"
},
"Tenancy": {
"shape_name": "Tenancy",
"type": "string",
"enum": [
"default",
"dedicated"
],
"documentation": "\n <p>The tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of <code>dedicated</code> runs\n on single-tenant hardware.</p>\n ",
"xmlname": "tenancy"
}
},
"documentation": "\n <p>The location where the instance launched.</p>\n ",
"xmlname": "placement"
},
"KernelId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The kernel associated with this instance.</p>\n ",
"xmlname": "kernelId"
},
"RamdiskId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The RAM disk associated with this instance.</p>\n ",
"xmlname": "ramdiskId"
},
"Platform": {
"shape_name": "PlatformValues",
"type": "string",
"enum": [
"Windows"
],
"documentation": "\n <p>The value is <code>Windows</code> for Windows instances; otherwise blank.</p>\n ",
"xmlname": "platform"
},
"Monitoring": {
"shape_name": "Monitoring",
"type": "structure",
"members": {
"State": {
"shape_name": "MonitoringState",
"type": "string",
"enum": [
"disabled",
"enabled",
"pending"
],
"documentation": "\n <p>Indicates whether monitoring is enabled for the instance.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n <p>The monitoring information for the instance.</p>\n ",
"xmlname": "monitoring"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the subnet in which the instance is running.</p>\n ",
"xmlname": "subnetId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the VPC in which the instance is running.</p>\n ",
"xmlname": "vpcId"
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The private IP address assigned to the instance.</p>\n ",
"xmlname": "privateIpAddress"
},
"PublicIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The public IP address assigned to the instance.</p>\n ",
"xmlname": "ipAddress"
},
"StateReason": {
"shape_name": "StateReason",
"type": "structure",
"members": {
"Code": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The reason code for the state change.</p>\n ",
"xmlname": "code"
},
"Message": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The message for the state change.</p>\n <ul>\n <li><p><code>Server.SpotInstanceTermination</code>: A Spot Instance was terminated due to an increase in the market price.</p></li>\n <li><p><code>Server.InternalError</code>: An internal error occurred during instance launch, resulting in termination.</p></li>\n <li><p><code>Server.InsufficientInstanceCapacity</code>: There was insufficient instance capacity to satisfy the launch request.</p></li>\n <li><p><code>Client.InternalError</code>: A client error caused the instance to terminate on launch.</p></li>\n <li><p><code>Client.InstanceInitiatedShutdown</code>: The instance was shut down using the <code>shutdown -h</code> command from the instance.</p></li>\n <li><p><code>Client.UserInitiatedShutdown</code>: The instance was shut down using the Amazon EC2 API.</p></li>\n <li><p><code>Client.VolumeLimitExceeded</code>: The volume limit was exceeded.</p></li>\n <li><p><code>Client.InvalidSnapshot.NotFound</code>: The specified snapshot was not found.</p></li>\n </ul>\n ",
"xmlname": "message"
}
},
"documentation": "\n <p>The reason for the most recent state transition.</p>\n ",
"xmlname": "stateReason"
},
"Architecture": {
"shape_name": "ArchitectureValues",
"type": "string",
"enum": [
"i386",
"x86_64"
],
"documentation": "\n <p>The architecture of the image.</p>\n ",
"xmlname": "architecture"
},
"RootDeviceType": {
"shape_name": "DeviceType",
"type": "string",
"enum": [
"ebs",
"instance-store"
],
"documentation": "\n <p>The root device type used by the AMI. The AMI can use an Amazon EBS volume\n or an instance store volume.</p>\n ",
"xmlname": "rootDeviceType"
},
"RootDeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The root device name (for example, <code>/dev/sda1</code>).</p>\n ",
"xmlname": "rootDeviceName"
},
"BlockDeviceMappings": {
"shape_name": "InstanceBlockDeviceMappingList",
"type": "list",
"members": {
"shape_name": "InstanceBlockDeviceMapping",
"type": "structure",
"members": {
"DeviceName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The device name exposed to the instance (for example, <filename>/dev/sdh</filename>).</p>\n ",
"xmlname": "deviceName"
},
"Ebs": {
"shape_name": "EbsInstanceBlockDevice",
"type": "structure",
"members": {
"VolumeId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Amazon EBS volume.</p>\n ",
"xmlname": "volumeId"
},
"Status": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n <p>The attachment state.</p>\n ",
"xmlname": "status"
},
"AttachTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n <p>The time stamp when the attachment initiated.</p>\n ",
"xmlname": "attachTime"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the volume is deleted on instance termination.</p>\n ",
"xmlname": "deleteOnTermination"
}
},
"documentation": "\n <p>Parameters used to automatically set up Amazon EBS volumes when the instance is launched.</p>\n ",
"xmlname": "ebs"
}
},
"documentation": "\n <p>Describes a block device mapping.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any block device mapping entries for the instance.</p>\n ",
"xmlname": "blockDeviceMapping"
},
"VirtualizationType": {
"shape_name": "VirtualizationType",
"type": "string",
"enum": [
"hvm",
"paravirtual"
],
"documentation": "\n <p>The virtualization type of the instance.</p>\n ",
"xmlname": "virtualizationType"
},
"InstanceLifecycle": {
"shape_name": "InstanceLifecycleType",
"type": "string",
"enum": [
"spot"
],
"documentation": "\n <p>Indicates whether this is a Spot Instance.</p>\n ",
"xmlname": "instanceLifecycle"
},
"SpotInstanceRequestId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the Spot Instance request.</p>\n ",
"xmlname": "spotInstanceRequestId"
},
"ClientToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The idempotency token you provided when you launched the instance.</p>\n ",
"xmlname": "clientToken"
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The key of the tag. </p>\n <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with <code>aws:</code></p>\n ",
"xmlname": "key"
},
"Value": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The value of the tag.</p>\n <p>Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.</p>\n ",
"xmlname": "value"
}
},
"documentation": "\n <p>Describes a tag.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Any tags assigned to the instance.</p>\n ",
"xmlname": "tagSet"
},
"SecurityGroups": {
"shape_name": "GroupIdentifierList",
"type": "list",
"members": {
"shape_name": "GroupIdentifier",
"type": "structure",
"members": {
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more security groups for the instance.</p>\n ",
"xmlname": "groupSet"
},
"SourceDestCheck": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Specifies whether to enable an instance launched in a VPC to\n\t\t\t\tperform NAT. This controls whether source/destination checking\n\t\t\t\tis enabled on the instance. A value of <code>true</code> means\n\t\t\t\tchecking is enabled, and <code>false</code> means checking is\n\t\t\t\tdisabled. The value must be <code>false</code> for the instance\n\t\t\t\tto perform NAT. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html\">NAT\n\t\t\t\tInstances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n ",
"xmlname": "sourceDestCheck"
},
"Hypervisor": {
"shape_name": "HypervisorType",
"type": "string",
"enum": [
"ovm",
"xen"
],
"documentation": "\n <p>The hypervisor type of the instance.</p>\n ",
"xmlname": "hypervisor"
},
"NetworkInterfaces": {
"shape_name": "InstanceNetworkInterfaceList",
"type": "list",
"members": {
"shape_name": "InstanceNetworkInterface",
"type": "structure",
"members": {
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"xmlname": "networkInterfaceId"
},
"SubnetId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the subnet.</p>\n ",
"xmlname": "subnetId"
},
"VpcId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the VPC.</p>\n ",
"xmlname": "vpcId"
},
"Description": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The description.</p>\n ",
"xmlname": "description"
},
"OwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the AWS account that created the network interface.</p>\n ",
"xmlname": "ownerId"
},
"Status": {
"shape_name": "NetworkInterfaceStatus",
"type": "string",
"enum": [
"available",
"attaching",
"in-use",
"detaching"
],
"documentation": "\n\t\t <p>The status of the network interface.</p>\n ",
"xmlname": "status"
},
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The IP address of the network interface within the subnet.</p>\n ",
"xmlname": "privateIpAddress"
},
"PrivateDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private DNS name.</p>\n ",
"xmlname": "privateDnsName"
},
"SourceDestCheck": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether to validate network traffic to or from this network interface.</p>\n ",
"xmlname": "sourceDestCheck"
},
"Groups": {
"shape_name": "GroupIdentifierList",
"type": "list",
"members": {
"shape_name": "GroupIdentifier",
"type": "structure",
"members": {
"GroupName": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The name of the security group.</p>\n ",
"xmlname": "groupName"
},
"GroupId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the security group.</p>\n ",
"xmlname": "groupId"
}
},
"documentation": "\n <p>Describes a security group.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>One or more security groups.</p>\n ",
"xmlname": "groupSet"
},
"Attachment": {
"shape_name": "InstanceNetworkInterfaceAttachment",
"type": "structure",
"members": {
"AttachmentId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface attachment.</p>\n ",
"xmlname": "attachmentId"
},
"DeviceIndex": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n\t\t <p>The index of the device on the instance for the network interface attachment.</p>\n ",
"xmlname": "deviceIndex"
},
"Status": {
"shape_name": "AttachmentStatus",
"type": "string",
"enum": [
"attaching",
"attached",
"detaching",
"detached"
],
"documentation": "\n\t\t <p>The attachment state.</p>\n ",
"xmlname": "status"
},
"AttachTime": {
"shape_name": "DateTime",
"type": "timestamp",
"documentation": "\n\t\t <p>The time stamp when the attachment initiated.</p>\n ",
"xmlname": "attachTime"
},
"DeleteOnTermination": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether the network interface is deleted when the instance is terminated.</p>\n ",
"xmlname": "deleteOnTermination"
}
},
"documentation": "\n\t\t <p>The network interface attachment.</p>\n ",
"xmlname": "attachment"
},
"Association": {
"shape_name": "InstanceNetworkInterfaceAssociation",
"type": "structure",
"members": {
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The address of the Elastic IP address bound to the network interface.</p>\n ",
"xmlname": "publicIp"
},
"PublicDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The public DNS name.</p>\n ",
"xmlname": "publicDnsName"
},
"IpOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the owner of the Elastic IP address.</p>\n ",
"xmlname": "ipOwnerId"
}
},
"documentation": "\n\t\t <p>The association information for an Elastic IP associated with the network interface.</p>\n ",
"xmlname": "association"
},
"PrivateIpAddresses": {
"shape_name": "InstancePrivateIpAddressList",
"type": "list",
"members": {
"shape_name": "InstancePrivateIpAddress",
"type": "structure",
"members": {
"PrivateIpAddress": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private IP address of the network interface.</p>\n ",
"xmlname": "privateIpAddress"
},
"PrivateDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The private DNS name.</p>\n ",
"xmlname": "privateDnsName"
},
"Primary": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n\t\t <p>Indicates whether this IP address is the primary private IP address \n\t\t of the network interface.</p>\n ",
"xmlname": "primary"
},
"Association": {
"shape_name": "InstanceNetworkInterfaceAssociation",
"type": "structure",
"members": {
"PublicIp": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The address of the Elastic IP address bound to the network interface.</p>\n ",
"xmlname": "publicIp"
},
"PublicDnsName": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The public DNS name.</p>\n ",
"xmlname": "publicDnsName"
},
"IpOwnerId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the owner of the Elastic IP address.</p>\n ",
"xmlname": "ipOwnerId"
}
},
"documentation": "\n\t\t <p>The association information for an Elastic IP address for the network interface.</p>\n ",
"xmlname": "association"
}
},
"documentation": "\n\t\t <p>Describes a private IP address.</p>\n ",
"xmlname": "item"
},
"documentation": "\n\t\t <p>The private IP addresses associated with the network interface.</p>\n ",
"xmlname": "privateIpAddressesSet"
}
},
"documentation": "\n\t\t <p>Describes a network interface.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>[EC2-VPC] One or more network interfaces for the instance.</p>\n ",
"xmlname": "networkInterfaceSet"
},
"IamInstanceProfile": {
"shape_name": "IamInstanceProfile",
"type": "structure",
"members": {
"Arn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The Amazon Resource Name (ARN) of the instance profile.</p>\n ",
"xmlname": "arn"
},
"Id": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance profile.</p>\n ",
"xmlname": "id"
}
},
"documentation": "\n <p>The IAM instance profile associated with the instance.</p>\n ",
"xmlname": "iamInstanceProfile"
},
"EbsOptimized": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal I/O performance. This optimization\n\t\t\t\tisn't available with all instance types. Additional usage charges apply when\n\t\t\t\tusing an EBS Optimized instance.</p>\n ",
"xmlname": "ebsOptimized"
},
"SriovNetSupport": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Specifies whether enhanced networking is enabled.</p>\n ",
"xmlname": "sriovNetSupport"
}
},
"documentation": "\n <p>Describes an instance.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>One or more instances.</p>\n ",
"xmlname": "instancesSet"
}
},
"documentation": "\n <p>One or more reservations.</p>\n ",
"xmlname": "reservation"
},
"errors": [],
"documentation": "\n <p>Launches the specified number of instances using an AMI for which you have permissions.</p>\n <p>When you launch an instance, it enters the <code>pending</code> state.\n After the instance is ready for you, it enters the <code>running</code> state.\n To check the state of your instance, call <a>DescribeInstances</a>.</p>\n\n <p>If you don't specify a security group when launching an instance, Amazon EC2 uses\n the default security group. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Security Groups</a>\n in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n\n <p>Linux instances have access to the public key of the key pair at boot.\n You can use this key to provide secure access to the instance.\n Amazon EC2 public images use this feature to provide secure access without passwords.\n For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Key Pairs</a>\n in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n\n <p>You can provide optional user data when launching an instance. For more\n information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html\">Instance\n Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n\n\t\t<p>If any of the AMIs have a product code attached for which the user has not\n\t\t\tsubscribed, <code>RunInstances</code> fails.</p>\n \n <p>For more information about troubleshooting, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html\">What To Do If An\n Instance Immediately Terminates</a>, and <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html\">Troubleshooting Connecting to Your Instance</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n\n <examples>\n <example>\n <description>This example launches three instances using the AMI with the ID <code>ami-60a54009</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&amp;ImageId=ami-60a54009\n&amp;MaxCount=3\n&amp;MinCount=1\n&amp;KeyName=my-key-pair\n&amp;Placement.AvailabilityZone=us-east-1d\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This example launches an <code>m1.small</code> instance into a subnet.\n Because no network interface is specified, the default network interface is used.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&amp;ImageId=ami-31814f58\n&amp;InstanceType=m1.small\n&amp;MaxCount=1\n&amp;MinCount=1\n&amp;KeyName=my-key-pair\n&amp;SubnetId=subnet-b2a249da\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This example launches an <code>m1.large</code> instance into a subnet.\n The network interface specifies a primary private IP address of <code>10.0.2.106</code>\n and two secondary private IP addresses (<code>10.0.2.107</code> and <code>10.0.2.108</code>).</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&amp;ImageId=ami-beb0caec\n&amp;InstanceType=m1.large\n&amp;MaxCount=1\n&amp;MinCount=1\n&amp;KeyName=my-key-pair\n&amp;NetworkInterface.0.DeviceIndex=0\n&amp;NetworkInterface.0.PrivateIpAddresses.0.Primary=true\n&amp;NetworkInterface.0.PrivateIpAddresses.0.PrivateIpAddress=10.0.2.106\n&amp;NetworkInterface.0.PrivateIpAddresses.1.Primary=false\n&amp;NetworkInterface.0.PrivateIpAddresses.1.PrivateIpAddress=10.0.2.107\n&amp;NetworkInterface.0.PrivateIpAddresses.2.Primary=false\n&amp;NetworkInterface.0.PrivateIpAddresses.2.PrivateIpAddress=10.0.2.108\n&amp;NetworkInterface.0.SubnetId=subnet-a61dafcf\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This example launches a Dedicated Instance into the specified subnet.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&amp;ImageId=ami-2a1fec43\n&amp;MaxCount=1\n&amp;MinCount=1\n&amp;KeyName=my-key-pair\n&amp;SubnetId=subnet-dea63cb7\n&amp;Placement.Tenancy=dedicated\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This request launches an instance into a nondefault subnet, and requests a public IP\n address for a new network interface with the device index of 0.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&amp;ImageId=ami-1a2b3c4d\n&amp;MaxCount=1\n&amp;MinCount=1\n&amp;NetworkInterface.0.DeviceIndex=0\n&amp;NetworkInterface.0.AssociatePublicIpAddress=true\n&amp;NetworkInterface.0.SubnetId=subnet-1a2b3c4d\n&amp;AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This request launches an <code>m1.large</code> instance with a block device\n mapping. There are two instance store volumes mapped to <code>/dev/sdc</code> and\n <code>/dev/sdd</code>, and a 100 GB Amazon EBS volume mapped to\n <code>/dev/sdf</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&amp;ImageId=ami-1a2b3c4d\n&amp;InstanceType=m1.large\n&amp;BlockDeviceMapping.1.DeviceName=%2Fdev%2Fsdc\n&amp;BlockDeviceMapping.1.VirtualName=ephemeral0\n&amp;BlockDeviceMapping.2.DeviceName=%2Fdev%2Fsdd\n&amp;BlockDeviceMapping.2.VirtualName=ephemeral1\n&amp;BlockDeviceMapping.3.DeviceName=%2Fdev%2Fsdf\n&amp;BlockDeviceMapping.3.Ebs.DeleteOnTermination=false\n&amp;BlockDeviceMapping.3.Ebs.VolumeSize=100\n&amp;EbsOptimized=false\n&amp;MinCount=1\n&amp;MaxCount=1\n&amp;DisableApiTermination=false\n&amp;Monitoring.Enabled=false\n&amp;AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
},
"StartInstances": {
"name": "StartInstances",
"input": {
"shape_name": "StartInstancesRequest",
"type": "structure",
"members": {
"InstanceIds": {
"shape_name": "InstanceIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "InstanceId"
},
"documentation": "\n <p>One or more instance IDs.</p>\n ",
"required": true,
"flattened": true
},
"AdditionalInfo": {
"shape_name": "String",
"type": "string",
"documentation": "\n "
},
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "StartInstancesResult",
"type": "structure",
"members": {
"StartingInstances": {
"shape_name": "InstanceStateChangeList",
"type": "list",
"members": {
"shape_name": "InstanceStateChange",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"CurrentState": {
"shape_name": "InstanceState",
"type": "structure",
"members": {
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.</p>\n\t\t <ul>\n\t\t <li><p><code>0</code> : <code>pending</code></p></li>\n\t\t <li><p><code>16</code> : <code>running</code></p></li>\n\t\t <li><p><code>32</code> : <code>shutting-down</code></p></li>\n\t\t <li><p><code>48</code> : <code>terminated</code></p></li>\n\t\t <li><p><code>64</code> : <code>stopping</code></p></li>\n\t\t <li><p><code>80</code> : <code>stopped</code></p></li>\n\t\t </ul>\n ",
"xmlname": "code"
},
"Name": {
"shape_name": "InstanceStateName",
"type": "string",
"enum": [
"pending",
"running",
"shutting-down",
"terminated",
"stopping",
"stopped"
],
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "name"
}
},
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "currentState"
},
"PreviousState": {
"shape_name": "InstanceState",
"type": "structure",
"members": {
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.</p>\n\t\t <ul>\n\t\t <li><p><code>0</code> : <code>pending</code></p></li>\n\t\t <li><p><code>16</code> : <code>running</code></p></li>\n\t\t <li><p><code>32</code> : <code>shutting-down</code></p></li>\n\t\t <li><p><code>48</code> : <code>terminated</code></p></li>\n\t\t <li><p><code>64</code> : <code>stopping</code></p></li>\n\t\t <li><p><code>80</code> : <code>stopped</code></p></li>\n\t\t </ul>\n ",
"xmlname": "code"
},
"Name": {
"shape_name": "InstanceStateName",
"type": "string",
"enum": [
"pending",
"running",
"shutting-down",
"terminated",
"stopping",
"stopped"
],
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "name"
}
},
"documentation": "\n <p>The previous state of the instance.</p>\n ",
"xmlname": "previousState"
}
},
"documentation": "\n <p>Describes an instance state change.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about one or more started instances.</p>\n ",
"xmlname": "instancesSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t\t<p>Starts an Amazon EBS-backed AMI that you've previously stopped.</p>\n\t\t\t<p>Instances that use Amazon EBS volumes as their root devices can be quickly stopped\n\t\t\t\tand started. When an instance is stopped, the compute resources are released and you\n\t\t\t\tare not billed for hourly instance usage. However, your root partition Amazon EBS\n\t\t\t\tvolume remains, continues to persist your data, and you are charged for Amazon EBS\n\t\t\t\tvolume usage. You can restart your instance at any time. Each time you transition an\n\t\t\t\tinstance from stopped to started, Amazon EC2 charges a full instance hour, even if\n\t\t\t\ttransitions happen multiple times within a single hour.</p>\n\t\t\t<p>Before stopping an instance, make sure it is in a state from which it can\n\t\t\t\tbe restarted. Stopping an instance does not preserve data stored in RAM.</p>\n\t\t\t<p>Performing this operation on an instance that uses an instance store as its\n\t\t\t\troot device returns an error.</p>\n\t\t\t<p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html\">Stopping Instances</a>\n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example starts the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=StartInstances\n&amp;InstanceId.1=i-10a64379\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;StartInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;instancesSet&gt;\n &lt;item&gt;\n &lt;instanceId&gt;i-10a64379&lt;/instanceId&gt;\n &lt;currentState&gt;\n &lt;code&gt;0&lt;/code&gt;\n &lt;name&gt;pending&lt;/name&gt;\n &lt;/currentState&gt;\n &lt;previousState&gt;\n &lt;code&gt;80&lt;/code&gt;\n &lt;name&gt;stopped&lt;/name&gt;\n &lt;/previousState&gt;\n &lt;/item&gt;\n &lt;/instancesSet&gt;\n&lt;/StartInstancesResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"StopInstances": {
"name": "StopInstances",
"input": {
"shape_name": "StopInstancesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceIds": {
"shape_name": "InstanceIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "InstanceId"
},
"documentation": "\n <p>One or more instance IDs.</p>\n ",
"required": true,
"flattened": true
},
"Force": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n <p>Forces the instances to stop. The instances do not have an\n\t\t\t\topportunity to flush file system caches or file system metadata. If you\n\t\t\t\tuse this option, you must perform file system check and repair\n\t\t\t\tprocedures. This option is not recommended for Windows\n\t\t\t instances.</p>\n <p>Default: <code>false</code></p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "StopInstancesResult",
"type": "structure",
"members": {
"StoppingInstances": {
"shape_name": "InstanceStateChangeList",
"type": "list",
"members": {
"shape_name": "InstanceStateChange",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"CurrentState": {
"shape_name": "InstanceState",
"type": "structure",
"members": {
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.</p>\n\t\t <ul>\n\t\t <li><p><code>0</code> : <code>pending</code></p></li>\n\t\t <li><p><code>16</code> : <code>running</code></p></li>\n\t\t <li><p><code>32</code> : <code>shutting-down</code></p></li>\n\t\t <li><p><code>48</code> : <code>terminated</code></p></li>\n\t\t <li><p><code>64</code> : <code>stopping</code></p></li>\n\t\t <li><p><code>80</code> : <code>stopped</code></p></li>\n\t\t </ul>\n ",
"xmlname": "code"
},
"Name": {
"shape_name": "InstanceStateName",
"type": "string",
"enum": [
"pending",
"running",
"shutting-down",
"terminated",
"stopping",
"stopped"
],
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "name"
}
},
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "currentState"
},
"PreviousState": {
"shape_name": "InstanceState",
"type": "structure",
"members": {
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.</p>\n\t\t <ul>\n\t\t <li><p><code>0</code> : <code>pending</code></p></li>\n\t\t <li><p><code>16</code> : <code>running</code></p></li>\n\t\t <li><p><code>32</code> : <code>shutting-down</code></p></li>\n\t\t <li><p><code>48</code> : <code>terminated</code></p></li>\n\t\t <li><p><code>64</code> : <code>stopping</code></p></li>\n\t\t <li><p><code>80</code> : <code>stopped</code></p></li>\n\t\t </ul>\n ",
"xmlname": "code"
},
"Name": {
"shape_name": "InstanceStateName",
"type": "string",
"enum": [
"pending",
"running",
"shutting-down",
"terminated",
"stopping",
"stopped"
],
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "name"
}
},
"documentation": "\n <p>The previous state of the instance.</p>\n ",
"xmlname": "previousState"
}
},
"documentation": "\n <p>Describes an instance state change.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about one or more stopped instances.</p>\n ",
"xmlname": "instancesSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t\t<p>Stops an Amazon EBS-backed instance. Each time you transition an instance from\n\t\t\t\tstopped to started, Amazon EC2 charges a full instance hour, even if transitions happen\n\t\t\t\tmultiple times within a single hour.</p>\n\t\t\t<p>You can't start or stop Spot Instances.</p>\n\t\t\t<p>Instances that use Amazon EBS volumes as their root devices can be quickly stopped\n\t\t\t\tand started. When an instance is stopped, the compute resources are released and you\n\t\t\t\tare not billed for hourly instance usage. However, your root partition Amazon EBS\n\t\t\t\tvolume remains, continues to persist your data, and you are charged for Amazon EBS\n\t\t\t\tvolume usage. You can restart your instance at any time.</p>\n\t\t\t<p>Before stopping an instance, make sure it is in a state from which it can\n\t\t\t\tbe restarted. Stopping an instance does not preserve data stored in RAM.</p>\n\t\t\t<p>Performing this operation on an instance that uses an instance store as its\n\t\t\t\troot device returns an error.</p>\n <p>You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances.\n What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance,\n the root device and any other devices attached to the instance persist. When you terminate an instance, the root\n device and any other devices attached during the instance launch are automatically deleted. For more information\n about the differences between stopping and terminating instances, see\n <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html\">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>For more information about troubleshooting, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html\">Troubleshooting\n Stopping Your Instance</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example stops the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=StopInstances\n&amp;InstanceId.1=i-10a64379\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;StopInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;instancesSet&gt;\n &lt;item&gt;\n &lt;instanceId&gt;i-10a64379&lt;/instanceId&gt;\n &lt;currentState&gt;\n &lt;code&gt;64&lt;/code&gt;\n &lt;name&gt;stopping&lt;/name&gt;\n &lt;/currentState&gt;\n &lt;previousState&gt;\n &lt;code&gt;16&lt;/code&gt;\n &lt;name&gt;running&lt;/name&gt;\n &lt;/previousState&gt;\n &lt;/instancesSet&gt;\n&lt;/StopInstancesResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"TerminateInstances": {
"name": "TerminateInstances",
"input": {
"shape_name": "TerminateInstancesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceIds": {
"shape_name": "InstanceIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "InstanceId"
},
"documentation": "\n <p>One or more instance IDs.</p>\n ",
"required": true,
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "TerminateInstancesResult",
"type": "structure",
"members": {
"TerminatingInstances": {
"shape_name": "InstanceStateChangeList",
"type": "list",
"members": {
"shape_name": "InstanceStateChange",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"CurrentState": {
"shape_name": "InstanceState",
"type": "structure",
"members": {
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.</p>\n\t\t <ul>\n\t\t <li><p><code>0</code> : <code>pending</code></p></li>\n\t\t <li><p><code>16</code> : <code>running</code></p></li>\n\t\t <li><p><code>32</code> : <code>shutting-down</code></p></li>\n\t\t <li><p><code>48</code> : <code>terminated</code></p></li>\n\t\t <li><p><code>64</code> : <code>stopping</code></p></li>\n\t\t <li><p><code>80</code> : <code>stopped</code></p></li>\n\t\t </ul>\n ",
"xmlname": "code"
},
"Name": {
"shape_name": "InstanceStateName",
"type": "string",
"enum": [
"pending",
"running",
"shutting-down",
"terminated",
"stopping",
"stopped"
],
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "name"
}
},
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "currentState"
},
"PreviousState": {
"shape_name": "InstanceState",
"type": "structure",
"members": {
"Code": {
"shape_name": "Integer",
"type": "integer",
"documentation": "\n <p>The low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.</p>\n\t\t <ul>\n\t\t <li><p><code>0</code> : <code>pending</code></p></li>\n\t\t <li><p><code>16</code> : <code>running</code></p></li>\n\t\t <li><p><code>32</code> : <code>shutting-down</code></p></li>\n\t\t <li><p><code>48</code> : <code>terminated</code></p></li>\n\t\t <li><p><code>64</code> : <code>stopping</code></p></li>\n\t\t <li><p><code>80</code> : <code>stopped</code></p></li>\n\t\t </ul>\n ",
"xmlname": "code"
},
"Name": {
"shape_name": "InstanceStateName",
"type": "string",
"enum": [
"pending",
"running",
"shutting-down",
"terminated",
"stopping",
"stopped"
],
"documentation": "\n <p>The current state of the instance.</p>\n ",
"xmlname": "name"
}
},
"documentation": "\n <p>The previous state of the instance.</p>\n ",
"xmlname": "previousState"
}
},
"documentation": "\n <p>Describes an instance state change.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Information about one or more terminated instances.</p>\n ",
"xmlname": "instancesSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t\t<p>Shuts down one or more instances. This operation is idempotent; if you terminate\n\t\t\t\tan instance more than once, each call succeeds.</p>\n\t\t\t<p>Terminated instances remain visible after termination (for approximately one\n\t\t\t\thour).</p>\n\t\t\t<p>By default, Amazon EC2 deletes all Amazon EBS volumes that were attached\n\t\t\t\twhen the instance launched. Volumes attached after instance launch\n\t\t\t\tcontinue running.</p>\n <p>You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances.\n What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance,\n the root device and any other devices attached to the instance persist. When you terminate an instance, the root\n device and any other devices attached during the instance launch are automatically deleted. For more information\n about the differences between stopping and terminating instances, see\n <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html\">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>For more information about troubleshooting, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html\">Troubleshooting Terminating Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example terminates the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=TerminateInstances\n&amp;InstanceId.1=i-3ea74257\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;TerminateInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;instancesSet&gt;\n &lt;item&gt;\n &lt;instanceId&gt;i-3ea74257&lt;/instanceId&gt;\n &lt;currentState&gt;\n &lt;code&gt;32&lt;/code&gt;\n &lt;name&gt;shutting-down&lt;/name&gt;\n &lt;/currentState&gt;\n &lt;previousState&gt;\n &lt;code&gt;16&lt;/code&gt;\n &lt;name&gt;running&lt;/name&gt;\n &lt;/previousState&gt;\n &lt;/item&gt;\n &lt;/instancesSet&gt;\n&lt;/TerminateInstancesResponse&gt;</queryresponse>\n </example>\n </examples>\n "
},
"UnassignPrivateIpAddresses": {
"name": "UnassignPrivateIpAddresses",
"input": {
"shape_name": "UnassignPrivateIpAddressesRequest",
"type": "structure",
"members": {
"NetworkInterfaceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n\t\t <p>The ID of the network interface.</p>\n ",
"required": true
},
"PrivateIpAddresses": {
"shape_name": "PrivateIpAddressStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "PrivateIpAddress"
},
"documentation": "\n\t\t <p>The secondary private IP addresses to unassign from\n\t\t\t\tthe network interface. You can specify this option multiple times to\n\t\t\t\tunassign more than one IP address.</p>\n ",
"required": true,
"flattened": true
}
},
"documentation": "\n "
},
"output": null,
"errors": [],
"documentation": "\n\t\t <p>Unassigns one or more secondary private IP addresses from a network interface.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>The following example unassigns two secondary private IP addresses from the\n\t\t\t\t\tspecified network interface.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=UnassignPrivateIpAddresses\n&amp;NetworkInterfaceId=eni-197d9972\n&amp;PrivateIpAddress.0=10.0.2.60 \n&amp;PrivateIpAddress.1=10.0.2.65 \n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;UnassignPrivateIpAddresses xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt; \n &lt;return&gt;true&lt;/return&gt;\n&lt;/UnassignPrivateIpAddresses&gt;</queryresponse>\n </example>\n </examples>\n "
},
"UnmonitorInstances": {
"name": "UnmonitorInstances",
"input": {
"shape_name": "UnmonitorInstancesRequest",
"type": "structure",
"members": {
"DryRun": {
"shape_name": "Boolean",
"type": "boolean",
"documentation": "\n "
},
"InstanceIds": {
"shape_name": "InstanceIdStringList",
"type": "list",
"members": {
"shape_name": "String",
"type": "string",
"documentation": null,
"xmlname": "InstanceId"
},
"documentation": "\n <p>One or more instance IDs.</p>\n ",
"required": true,
"flattened": true
}
},
"documentation": "\n "
},
"output": {
"shape_name": "UnmonitorInstancesResult",
"type": "structure",
"members": {
"InstanceMonitorings": {
"shape_name": "InstanceMonitoringList",
"type": "list",
"members": {
"shape_name": "InstanceMonitoring",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The ID of the instance.</p>\n ",
"xmlname": "instanceId"
},
"Monitoring": {
"shape_name": "Monitoring",
"type": "structure",
"members": {
"State": {
"shape_name": "MonitoringState",
"type": "string",
"enum": [
"disabled",
"enabled",
"pending"
],
"documentation": "\n <p>Indicates whether monitoring is enabled for the instance.</p>\n ",
"xmlname": "state"
}
},
"documentation": "\n <p>The monitoring information.</p>\n ",
"xmlname": "monitoring"
}
},
"documentation": "\n <p>Describes the monitoring information of the instance.</p>\n ",
"xmlname": "item"
},
"documentation": "\n <p>Monitoring information for one or more instances.</p>\n ",
"xmlname": "instancesSet"
}
},
"documentation": "\n "
},
"errors": [],
"documentation": "\n\t\t\t<p>Disables monitoring for a running instance. For more information about monitoring\n\t\t\t\tinstances, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html\">Monitoring Your\n\t\t\t\tInstances and Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example disables monitoring for the specified instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=UnmonitorInstances\n&amp;InstanceId.1=i-43a4412a\n&amp;InstanceId.2=i-23a3397d\n&amp;AUTHPARAMS</queryrequest>\n <queryresponse>&lt;UnmonitorInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\"&gt;\n &lt;requestId&gt;59dbff89-35bd-4eac-99ed-be587EXAMPLE&lt;/requestId&gt;\n &lt;instancesSet&gt;\n &lt;item&gt;\n &lt;instanceId&gt;i-43a4412a&lt;/instanceId&gt;\n &lt;monitoring&gt;\n &lt;state&gt;disabled&lt;/state&gt;\n &lt;/monitoring&gt;\n &lt;/item&gt;\n &lt;item&gt;\n &lt;instanceId&gt;i-23a3397d&lt;/instanceId&gt;\n &lt;monitoring&gt;\n &lt;state&gt;disabled&lt;/state&gt;\n &lt;/monitoring&gt;\n &lt;/item&gt;\n &lt;/instancesSet&gt;\n&lt;/UnmonitorInstancesResponse&gt;</queryresponse>\n </example>\n </examples>\n "
}
},
"pagination": {
"DescribeInstanceStatus": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "InstanceStatuses",
"py_input_token": "next_token"
},
"DescribeInstances": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Reservations",
"py_input_token": "next_token"
},
"DescribeReservedInstancesModifications": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "ReservedInstancesModifications",
"py_input_token": "next_token"
},
"DescribeReservedInstancesOfferings": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "ReservedInstancesOfferings",
"py_input_token": "next_token"
},
"DescribeSpotPriceHistory": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "SpotPriceHistory",
"py_input_token": "next_token"
},
"DescribeTags": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Tags",
"py_input_token": "next_token"
},
"DescribeVolumeStatus": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "VolumeStatuses",
"py_input_token": "next_token"
}
},
"waiters": {
"ConversionTaskCancelled": {
"failure": {
"path": "ConversionTasks[].State",
"type": "output"
},
"operation": "DescribeConversionTasks",
"success": {
"path": "ConversionTasks[].State",
"type": "output",
"value": [
"cancelled"
]
},
"interval": 15,
"max_attempts": 40
},
"VolumeAvailable": {
"success": {
"path": "VolumeStatuses[].VolumeStatus.Status",
"type": "output",
"value": [
"available"
]
},
"interval": 15,
"failure": {
"path": "VolumeStatuses[].VolumeStatus.Status",
"type": "output",
"value": [
"deleted"
]
},
"operation": "DescribeVolumes",
"max_attempts": 40
},
"ExportTaskCancelled": {
"failure": {
"path": "ExportTasks[].State",
"type": "output"
},
"operation": "DescribeExportTasks",
"success": {
"path": "ExportTasks[].State",
"type": "output",
"value": [
"cancelled"
]
},
"interval": 15,
"max_attempts": 40
},
"CustomerGatewayAvailable": {
"success": {
"path": "CustomerGateways[].State",
"type": "output",
"value": [
"available"
]
},
"interval": 15,
"failure": {
"path": "CustomerGateways[].State",
"type": "output",
"value": [
"deleted",
"deleting"
]
},
"operation": "DescribeCustomerGateways",
"max_attempts": 40
},
"ConversionTaskCompleted": {
"success": {
"path": "ConversionTasks[].State",
"type": "output",
"value": [
"completed"
]
},
"interval": 15,
"failure": {
"path": "ConversionTasks[].State",
"type": "output",
"value": [
"cancelled",
"cancelling"
]
},
"operation": "DescribeConversionTasks",
"max_attempts": 40
},
"VpnConnectionDeleted": {
"success": {
"path": "VpnConnections[].State",
"type": "output",
"value": [
"deleted"
]
},
"interval": 15,
"failure": {
"path": "VpnConnections[].State",
"type": "output",
"value": [
"pending"
]
},
"operation": "DescribeVpnConnections",
"max_attempts": 40
},
"BundleTaskComplete": {
"failure": {
"path": "BundleTasks[].State",
"type": "output",
"value": [
"failed"
]
},
"operation": "DescribeBundleTasks",
"success": {
"path": "BundleTasks[].State",
"type": "output",
"value": [
"complete"
]
},
"interval": 15,
"max_attempts": 40
},
"VolumeInUse": {
"success": {
"path": "VolumeStatuses[].VolumeStatus.Status",
"type": "output",
"value": [
"in-use"
]
},
"interval": 15,
"failure": {
"path": "VolumeStatuses[].VolumeStatus.Status",
"type": "output",
"value": [
"deleted"
]
},
"operation": "DescribeVolumes",
"max_attempts": 40
},
"VpnConnectionAvailable": {
"success": {
"path": "VpnConnections[].State",
"type": "output",
"value": [
"available"
]
},
"interval": 15,
"failure": {
"path": "VpnConnections[].State",
"type": "output",
"value": [
"deleting",
"deleted"
]
},
"operation": "DescribeVpnConnections",
"max_attempts": 40
},
"InstanceRunning": {
"success": {
"path": "Reservations[].Instances[].State.Name",
"type": "output",
"value": [
"running"
]
},
"interval": 15,
"failure": {
"path": "Reservations[].Instances[].State.Name",
"type": "output",
"value": [
"shutting-down",
"terminated",
"stopping"
]
},
"operation": "DescribeInstances",
"max_attempts": 40
},
"ConversionTaskDeleted": {
"failure": {
"path": "CustomerGateways[].State",
"type": "output"
},
"operation": "DescribeCustomerGateways",
"success": {
"path": "CustomerGateways[].State",
"type": "output",
"value": [
"deleted"
]
},
"interval": 15,
"max_attempts": 40
},
"VpcAvailable": {
"success": {
"path": "Vpcs[].State",
"type": "output",
"value": [
"available"
]
},
"interval": 15,
"failure": {
"type": "output"
},
"operation": "DescribeVpcs",
"max_attempts": 40
},
"SubnetAvailable": {
"success": {
"path": "Subnets[].State",
"type": "output",
"value": [
"available"
]
},
"interval": 15,
"failure": {
"type": "output"
},
"operation": "DescribeSubnets",
"max_attempts": 40
},
"InstanceTerminated": {
"success": {
"path": "Reservations[].Instances[].State.Name",
"type": "output",
"value": [
"terminated"
]
},
"interval": 15,
"failure": {
"path": "Reservations[].Instances[].State.Name",
"type": "output",
"value": [
"pending",
"stopping"
]
},
"operation": "DescribeInstances",
"max_attempts": 40
},
"VolumeDeleted": {
"failure": {
"path": "VolumeStatuses[].VolumeStatus.Status",
"type": "output"
},
"operation": "DescribeVolumes",
"success": {
"path": "VolumeStatuses[].VolumeStatus.Status",
"type": "output",
"value": [
"deleted"
]
},
"interval": 15,
"max_attempts": 40
},
"InstanceStopped": {
"success": {
"path": "Reservations[].Instances[].State.Name",
"type": "output",
"value": [
"stopped"
]
},
"interval": 15,
"failure": {
"path": "Reservations[].Instances[].State.Name",
"type": "output",
"value": [
"pending",
"terminated"
]
},
"operation": "DescribeInstances",
"max_attempts": 40
},
"SnapshotCompleted": {
"success": {
"path": "Snapshots[].State",
"type": "output",
"value": [
"completed"
]
},
"interval": 15,
"failure": {
"type": "output"
},
"operation": "DescribeSnapshots",
"max_attempts": 40
},
"ExportTaskCompleted": {
"failure": {
"path": "ExportTasks[].State",
"type": "output"
},
"operation": "DescribeExportTasks",
"success": {
"path": "ExportTasks[].State",
"type": "output",
"value": [
"completed"
]
},
"interval": 15,
"max_attempts": 40
}
},
"retry": {
"__default__": {
"max_attempts": 5,
"delay": {
"type": "exponential",
"base": "rand",
"growth_factor": 2
},
"policies": {
"general_socket_errors": {
"applies_when": {
"socket_errors": [
"GENERAL_CONNECTION_ERROR"
]
}
},
"general_server_error": {
"applies_when": {
"response": {
"http_status_code": 500
}
}
},
"service_unavailable": {
"applies_when": {
"response": {
"http_status_code": 503
}
}
},
"limit_exceeded": {
"applies_when": {
"response": {
"http_status_code": 509
}
}
},
"request_limit_exceeded": {
"applies_when": {
"response": {
"service_error_code": "RequestLimitExceeded",
"http_status_code": 503
}
}
}
}
}
}
}
Reference in a new issue View git blame Copy permalink