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.
\n ", "operations": { "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": "\nSet to vpc to allocate the address for use with instances in a VPC.
Default: The address is for use with instances in EC2-Classic.
\n " } }, "documentation": "\n " }, "output": { "shape_name": "AllocateAddressResult", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\nThe Elastic IP address.
\n ", "xmlname": "publicIp" }, "Domain": { "shape_name": "DomainType", "type": "string", "enum": [ "vpc", "standard" ], "documentation": "\nIndicates whether this Elastic IP address is for use with instances\n\t\t\t\tin EC2-Classic (standard) or instances in a VPC (vpc).
[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.
\n ", "xmlname": "allocationId" } }, "documentation": "\n " }, "errors": [], "documentation": "\nAcquires an Elastic IP address.
\nAn Elastic IP address is for use either in the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the network interface.
\n ", "required": true }, "PrivateIpAddresses": { "shape_name": "PrivateIpAddressStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "PrivateIpAddress" }, "documentation": "\nOne or more IP addresses to be assigned as a secondary private IP address to\n\t\t\t\tthe network interface.
\n\t\tIf you don't specify an IP address, Amazon EC2 automatically\n\t\t\t\tselects an IP address within the subnet range.
\n ", "flattened": true }, "SecondaryPrivateIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of secondary IP addresses to assign to the network interface.
\n " }, "AllowReassignment": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates 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.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nAssigns 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 Instance Types \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP\n\t\t\t\taddresses, see Elastic IP\n\t\t\t\tAddresses in the Amazon Elastic Compute Cloud User Guide.
\nAssignPrivateIpAddresses is available only in EC2-VPC.
\n10.0.2.1 and\n\t\t\t\t\t10.0.2.11) to the specified network interface.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.
\n " }, "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\nThe Elastic IP address.
\n " }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": "\n[EC2-VPC] The allocation ID. This is required for EC2-VPC.
\n " }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": "\n[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.
\n " }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n[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.
\n " }, "AllowReassociation": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n[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.
\nDefault: false
[EC2-VPC] The ID that represents the association of the Elastic IP\n\t\t\t\taddress with an instance.
\n ", "xmlname": "associationId" } }, "documentation": "\n " }, "errors": [], "documentation": "\nAssociates an Elastic IP address with an instance or a network interface.
\nAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\n[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.
\n[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.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2\n\t\t\t\tdoesn't return an error.
\nAllowReassignment 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.The ID of the DHCP options set, or default to associate \n no DHCP options with the VPC.
The ID of the VPC.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tAssociates 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.
\n\t\tAfter 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.
\n\t\tFor more information,\n\t\t\t see DHCP Options Sets \n\t\t\t in the Amazon Virtual Private Cloud User Guide.
\ndopt-7a8b9c2d with the VPC\n\t\t\t\t\twith the ID vpc-1a2b3c4d.vpc-1a2b3c4d to have no \n\t\t\t\t\tassociated DHCP options set.The ID of the subnet.
\n ", "required": true }, "RouteTableId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the route table.
\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "AssociateRouteTableResult", "type": "structure", "members": { "AssociationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe route table association ID (needed to disassociate the route table).
\n ", "xmlname": "associationId" } }, "documentation": "\n " }, "errors": [], "documentation": "\nAssociates 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.
\n\t\tFor more information about route tables, see Route Tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nrtb-e4ad488d with a subnet with\n\t\t\t\t\tthe ID subnet-15ad487c.The ID of the Internet gateway.
\n ", "required": true }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tAttaches 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\tAmazon Virtual Private Cloud User Guide.
\nigw-eaad4883 to the VPC with\n\t\t\t\t\tthe ID vpc-11ad4878.The ID of the network interface.
\n ", "required": true }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the instance.
\n ", "required": true }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe index of the device for the network interface attachment.
\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "AttachNetworkInterfaceResult", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the network interface attachment.
\n ", "xmlname": "attachmentId" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tAttaches a network interface to an instance.
\nThe ID of the Amazon EBS volume. The volume and instance must be within the same Availability\n Zone.
\n ", "required": true }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance.
\n ", "required": true }, "Device": { "shape_name": "String", "type": "string", "documentation": "\nThe device name to expose to the instance (for example, /dev/sdh or\n xvdh).
The ID of the volume.
\n ", "xmlname": "volumeId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance.
\n ", "xmlname": "instanceId" }, "Device": { "shape_name": "String", "type": "string", "documentation": "\nThe device name.
\n ", "xmlname": "device" }, "State": { "shape_name": "VolumeAttachmentState", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\nThe attachment state of the volume.
\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when the attachment initiated.
\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n ", "xmlname": "attachment" }, "errors": [], "documentation": "\nAttaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance\n with the specified device name.
\nFor a list of supported device names, see Attaching an Amazon EBS Volume to an Instance. Any device names that aren't reserved\n for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the\n Amazon Elastic Compute Cloud User Guide.
\nIf a volume has an AWS Marketplace product code:
\nFor an overview of the AWS Marketplace, see https://aws.amazon.com/marketplace/help/200900000. For more information about how to use the AWS\n Marketplace, see AWS Marketplace.
\nFor more information about Amazon EBS volumes, see Attaching Amazon EBS Volumes in the\n Amazon Elastic Compute Cloud User Guide.
\nvol-1a2b3c4d to\n the instance with the ID i-1a2b3c4d and exposes it as\n /dev/sdh.The ID of the virtual private gateway.
\n ", "required": true }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC.
\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\tThe ID of the VPC.
\n ", "xmlname": "vpcId" }, "State": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n\t\tThe current state of the attachment.
\n ", "xmlname": "state" } }, "documentation": "\n\t\tInformation about the attachment.
\n ", "xmlname": "attachment" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tAttaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway\n\t\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.
\nvgw-8db04f81 to the VPC with the ID\n\t\t\t\t\tvpc-1a2b3c4d.The ID of the security group.
\n ", "required": true }, "SourceSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n[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.
\n " }, "SourceSecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the source security group. You can't specify a source security group and a CIDR IP address range.
\n " }, "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\nThe IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
\n " }, "IpPermissions": { "shape_name": "IpPermissionList", "type": "list", "members": { "shape_name": "IpPermission", "type": "structure", "members": { "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe protocol.
\n\t\tWhen you call DescribeSecurityGroups, 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, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.
The ID of an AWS account.
\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group owned by the specified AWS account.
\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group in the specified AWS account.
\n " } }, "documentation": "\nDescribes a security group and AWS account ID pair for EC2-Classic.
\n ", "xmlname": "Groups" }, "documentation": "\n\t\tOne or more security group and AWS account ID pairs.
\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\tThe CIDR range. You can either specify a CIDR range or a source security group, not both.
\n " } }, "documentation": "\n\t\tDescribes an IP range.
\n " }, "documentation": "\n\t\tOne or more IP ranges.
\n ", "flattened": true } }, "documentation": "\n\t\tDescribes a security group rule.
\n " }, "documentation": "\n \n ", "flattened": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nAdds 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.
\n\t\t\tYou can have up to 50 rules per security group (covering both ingress and\n\t\t\t\t\tegress rules).
\n\t\t\tA 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 Security Groups for Your VPC in\n\t\t\t\tthe Amazon Virtual Private Cloud User Guide.
\nEach 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.
\nRule changes are propagated to affected instances as quickly as possible. However,\n\t\t\t\ta small delay might occur.
\nsg-1a2b3c4d access to the\n\t\t\t\t\t192.0.2.0/24 and 198.51.100.0/24 address ranges on TCP port 80.sg-1a2b3c4d \n\t\t\t\t\tto the security group with the ID sg-9a8d7f5c on TCP port 1433.[EC2-Classic, default VPC] The name of the security group.
\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n " }, "SourceSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n[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.
\n " }, "SourceSecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the source security group. You can't specify a source security group and a CIDR IP address range.
\n " }, "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\nThe IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
\n " }, "IpPermissions": { "shape_name": "IpPermissionList", "type": "list", "members": { "shape_name": "IpPermission", "type": "structure", "members": { "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe protocol.
\n\t\tWhen you call DescribeSecurityGroups, 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, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.
The ID of an AWS account.
\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group owned by the specified AWS account.
\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group in the specified AWS account.
\n " } }, "documentation": "\nDescribes a security group and AWS account ID pair for EC2-Classic.
\n ", "xmlname": "Groups" }, "documentation": "\n\t\tOne or more security group and AWS account ID pairs.
\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\tThe CIDR range. You can either specify a CIDR range or a source security group, not both.
\n " } }, "documentation": "\n\t\tDescribes an IP range.
\n " }, "documentation": "\n\t\tOne or more IP ranges.
\n ", "flattened": true } }, "documentation": "\n\t\tDescribes a security group rule.
\n " }, "documentation": "\n \n ", "flattened": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nAdds one or more ingress rules to a security group.
\n\t\t\tEC2-Classic: You can have up to 100 rules per group.
\n\t\t\t\tEC2-VPC: You can have up to 50 rules per group (covering both ingress and\n\t\t\t\t\tegress rules).
\n\t\t\tRule changes are propagated to instances within the security group as quickly as\n\t\t\t\tpossible. However, a small delay might occur.
\n[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 source groups) 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.
\n[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 source groups) permission to access a security\n\t\t\t\tgroup for your VPC. The security groups must all be for the same VPC.
\n192.0.2.0/24\n\t\t\t\t\tand 198.51.100.0/24 address ranges to the security group for EC2-Classic \n\t\t\t\t\tnamed websrv.OtherAccountGroup (in AWS\n\t\t\t\t\taccount 123456789012) to the security group for EC2-Classic named websrv.OtherGroupInMyVPC\n\t\t\t\t\t(with the ID sg-2a2b3c4d) to the security group named VpcWebServers \n\t\t\t\t\t(with the ID sg-1a2b3c4d). 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 123456789012.default.default.The ID of the instance to bundle.
\n ", "required": true }, "Storage": { "shape_name": "Storage", "type": "structure", "members": { "S3": { "shape_name": "S3Storage", "type": "structure", "members": { "Bucket": { "shape_name": "String", "type": "string", "documentation": "\nThe 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.
\n " }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\nThe beginning of the file name of the AMI.
\n " }, "AWSAccessKeyId": { "shape_name": "String", "type": "string", "documentation": "\nThe access key ID of the owner of the bucket.
\n " }, "UploadPolicy": { "shape_name": "String", "type": "blob", "documentation": "\nA Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
\n " }, "UploadPolicySignature": { "shape_name": "String", "type": "string", "documentation": "\nThe signature of the Base64 encoded JSON document.
\n " } }, "documentation": "\nAn Amazon S3 storage location.
\n " } }, "documentation": " \nThe 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.
\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": " \nThe ID of the instance associated with this bundle task.
\n ", "xmlname": "instanceId" }, "BundleId": { "shape_name": "String", "type": "string", "documentation": " \nThe ID for this bundle task.
\n ", "xmlname": "bundleId" }, "State": { "shape_name": "BundleTaskState", "type": "string", "enum": [ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ], "documentation": " \nThe state of the task.
\n ", "xmlname": "state" }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": " \nThe time this task started.
\n ", "xmlname": "startTime" }, "UpdateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": " \nThe time of the most recent update for the task.
\n ", "xmlname": "updateTime" }, "Storage": { "shape_name": "Storage", "type": "structure", "members": { "S3": { "shape_name": "S3Storage", "type": "structure", "members": { "Bucket": { "shape_name": "String", "type": "string", "documentation": "\nThe 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.
\n ", "xmlname": "bucket" }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\nThe beginning of the file name of the AMI.
\n ", "xmlname": "prefix" }, "AWSAccessKeyId": { "shape_name": "String", "type": "string", "documentation": "\nThe access key ID of the owner of the bucket.
\n " }, "UploadPolicy": { "shape_name": "String", "type": "string", "documentation": "\nA Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
\n ", "xmlname": "uploadPolicy" }, "UploadPolicySignature": { "shape_name": "String", "type": "string", "documentation": "\nThe signature of the Base64 encoded JSON document.
\n ", "xmlname": "uploadPolicySignature" } }, "documentation": "\nAn Amazon S3 storage location.
\n " } }, "documentation": " \nThe Amazon S3 storage locations.
\n ", "xmlname": "storage" }, "Progress": { "shape_name": "String", "type": "string", "documentation": " \nThe level of task completion, as a percent (for example, 20%).
\n ", "xmlname": "progress" }, "BundleTaskError": { "shape_name": "BundleTaskError", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": " \nThe error code.
\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": " \nThe error message.
\n ", "xmlname": "message" } }, "documentation": " \nIf the task fails, a description of the error.
\n ", "xmlname": "error" } }, "documentation": " \nInformation about the bundle task.
\n ", "xmlname": "bundleInstanceTask" } }, "documentation": " \n " }, "errors": [], "documentation": " \nBundles an Amazon instance store-backed Windows instance.
\nDuring bundling, only the root device volume (C:\\) is bundled. Data on other\n\t\t\t\tinstance store volumes is not preserved.
\nThis procedure is not applicable for Linux/Unix instances or Windows instances\n that are backed by Amazon EBS.
\n\t\t\tFor more information, see Creating an Instance Store-Backed Windows AMI.
\nThe ID of the bundle task.
\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": " \nThe ID of the instance associated with this bundle task.
\n ", "xmlname": "instanceId" }, "BundleId": { "shape_name": "String", "type": "string", "documentation": " \nThe ID for this bundle task.
\n ", "xmlname": "bundleId" }, "State": { "shape_name": "BundleTaskState", "type": "string", "enum": [ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ], "documentation": " \nThe state of the task.
\n ", "xmlname": "state" }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": " \nThe time this task started.
\n ", "xmlname": "startTime" }, "UpdateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": " \nThe time of the most recent update for the task.
\n ", "xmlname": "updateTime" }, "Storage": { "shape_name": "Storage", "type": "structure", "members": { "S3": { "shape_name": "S3Storage", "type": "structure", "members": { "Bucket": { "shape_name": "String", "type": "string", "documentation": "\nThe 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.
\n ", "xmlname": "bucket" }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\nThe beginning of the file name of the AMI.
\n ", "xmlname": "prefix" }, "AWSAccessKeyId": { "shape_name": "String", "type": "string", "documentation": "\nThe access key ID of the owner of the bucket.
\n " }, "UploadPolicy": { "shape_name": "String", "type": "string", "documentation": "\nA Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
\n ", "xmlname": "uploadPolicy" }, "UploadPolicySignature": { "shape_name": "String", "type": "string", "documentation": "\nThe signature of the Base64 encoded JSON document.
\n ", "xmlname": "uploadPolicySignature" } }, "documentation": "\nAn Amazon S3 storage location.
\n " } }, "documentation": " \nThe Amazon S3 storage locations.
\n ", "xmlname": "storage" }, "Progress": { "shape_name": "String", "type": "string", "documentation": " \nThe level of task completion, as a percent (for example, 20%).
\n ", "xmlname": "progress" }, "BundleTaskError": { "shape_name": "BundleTaskError", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": " \nThe error code.
\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": " \nThe error message.
\n ", "xmlname": "message" } }, "documentation": " \nIf the task fails, a description of the error.
\n ", "xmlname": "error" } }, "documentation": " \nThe bundle task.
\n ", "xmlname": "bundleInstanceTask" } }, "documentation": " \n " }, "errors": [], "documentation": " \nCancels a bundling operation for an instance store-backed Windows instance.
\nThe ID of the conversion task.
\n ", "required": true }, "ReasonMessage": { "shape_name": "String", "type": "string", "documentation": "\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nCancels 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.
\n \nFor more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon\n EC2 in the Amazon Elastic Compute Cloud User Guide.
\nimport-i-fh95npoc.The ID of the export task. This is the ID\n returned by CreateInstanceExportTask.
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.
\nexport-i-1234wxyz.The ID of the Reserved Instance listing.
\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": "\nThe ID of the Reserved Instance listing.
\n ", "xmlname": "reservedInstancesListingId" }, "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the Reserved Instance.
\n ", "xmlname": "reservedInstancesId" }, "CreateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time the listing was created.
\n ", "xmlname": "createDate" }, "UpdateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe last modified timestamp of the listing.
\n ", "xmlname": "updateDate" }, "Status": { "shape_name": "ListingStatus", "type": "string", "enum": [ "active", "pending", "cancelled", "closed" ], "documentation": "\nThe status of the Reserved Instance listing.
\n ", "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\nThe reason for the current status of the Reserved Instance listing. \n\t\t\t\tThe response can be blank.
\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": "\nThe states of the listed Reserved Instances.
\n ", "xmlname": "state" }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nhe number of listed Reserved Instances in the state specified by the state.
Describes a Reserved Instance listing state.
\n ", "xmlname": "item" }, "documentation": "\nThe number of instances in this state.
\n ", "xmlname": "instanceCounts" }, "PriceSchedules": { "shape_name": "PriceScheduleList", "type": "list", "members": { "shape_name": "PriceSchedule", "type": "structure", "members": { "Term": { "shape_name": "Long", "type": "long", "documentation": "\nThe 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.
\n ", "xmlname": "term" }, "Price": { "shape_name": "Double", "type": "double", "documentation": "\nThe fixed price for the term.
\n ", "xmlname": "price" }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": "\nThe currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.
The current price schedule, as determined by the term remaining for the \n\t\t\t\tReserved Instance in the listing.
\nA 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.
\n ", "xmlname": "active" } }, "documentation": "\nDescribes the price for a Reserved Instance.
\n ", "xmlname": "item" }, "documentation": "\nThe price of the Reserved Instance listing.
\n ", "xmlname": "priceSchedules" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the resource.
\n ", "xmlname": "tagSet" }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": "\nThe idempotency token you provided when you created the listing.
\n ", "xmlname": "clientToken" } }, "documentation": "\nDescribes a Reserved Instance listing.
\n ", "xmlname": "item" }, "documentation": "\nThe Reserved Instance listing.
\n ", "xmlname": "reservedInstancesListingsSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nCancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
\nFor more information, see \n Reserved Instance Marketplace \n in the Amazon Elastic Compute Cloud User Guide.
\nOne or more Spot Instance request IDs.
\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": "\nThe ID of the Spot Instance request.
\n ", "xmlname": "spotInstanceRequestId" }, "State": { "shape_name": "CancelSpotInstanceRequestState", "type": "string", "enum": [ "active", "open", "closed", "cancelled", "completed" ], "documentation": "\nThe state of the Spot Instance request.
\n ", "xmlname": "state" } }, "documentation": "\nDescribes a request to cancel a Spot Instance.
\n ", "xmlname": "item" }, "documentation": "\nOne or more Spot Instance requests.
\n ", "xmlname": "spotInstanceRequestSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nCancels 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 Spot\n\t\t\t\t\tInstances in the Amazon Elastic Compute Cloud User Guide.
\nCanceling a Spot Instance request does not terminate running Spot Instances\n\t\t\t\t\tassociated with the request.
\nThe product code. This must be an Amazon DevPay product code that you own.
\n ", "required": true }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance.
\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "ConfirmProductInstanceResult", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the instance owner. This is only present if the product code\n\t\t\t\tis attached to the instance.
\n ", "xmlname": "ownerId" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDetermines 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.
\nThe name of the region that contains the AMI to copy.
\n ", "required": true }, "SourceImageId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the AMI to copy.
\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the new AMI in the destination region.
\n ", "required": false }, "Description": { "shape_name": "String", "type": "string", "documentation": " \nA description for the new AMI in the destination region.
\n " }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": " \nUnique, case-sensitive identifier you provide to ensure\n\t\t\t\tidempotency of the request. For more information, see How to Ensure Idempotency in the \n\t\t\t Amazon Elastic Compute Cloud User Guide.
\n " } }, "documentation": " \n " }, "output": { "shape_name": "CopyImageResult", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": " \nThe ID of the new AMI.
\n ", "xmlname": "imageId" } }, "documentation": " \n " }, "errors": [], "documentation": " \nInitiates the copy of an AMI from the specified source region to the region in\n\t\t\t\twhich the request was made.
\nFor more information, see Copying AMIs\n in the Amazon Elastic Compute Cloud User Guide.
\nus-west-2 with the ID ami-1a2b3c4d,\n\t\t\t\t\tnaming the new AMI My-Standard-AMI.The ID of the region that contains the snapshot to be copied.
\n ", "required": true }, "SourceSnapshotId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the Amazon EBS snapshot to copy.
\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description for the new Amazon EBS snapshot.
\n " } }, "documentation": "\n\n " }, "output": { "shape_name": "CopySnapshotResult", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the new snapshot.
\n ", "xmlname": "snapshotId" } }, "documentation": "\n " }, "errors": [], "documentation": "\nCopies a point-in-time snapshot of an Amazon EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can\n use the snapshot to create Amazon EBS volumes or Amazon Machine Images (AMIs).
\nFor more information, see Copying an Amazon EBS Snapshot in the\n Amazon Elastic Compute Cloud User Guide.
\nsnap-1a2b3c4d.The type of VPN connection that this customer gateway supports.
\n ", "required": true }, "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe Internet-routable IP address for the customer gateway's outside\n\t\t\t\tinterface. The address must be static.
\n ", "required": true, "xmlname": "IpAddress" }, "BgpAsn": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tFor devices that support BGP, the customer gateway's BGP ASN.
\n\t\tDefault: 65000
\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\tThe ID of the customer gateway.
\n ", "xmlname": "customerGatewayId" }, "State": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe current state of the customer gateway.
\n ", "xmlname": "state" }, "Type": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe type of VPN connection the customer gateway supports.
\n ", "xmlname": "type" }, "IpAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe Internet-routable IP address of the customer gateway's outside interface.
\n ", "xmlname": "ipAddress" }, "BgpAsn": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
\n ", "xmlname": "bgpAsn" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the customer gateway.
\n ", "xmlname": "tagSet" } }, "documentation": "\n\t\tInformation about the customer gateway.
\n ", "xmlname": "customerGateway" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tProvides 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).
\n\t\tFor 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).
\n\t\t\tAmazon 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 us-east-1 region, and 9059, which is\n\t\t\t\t\treserved in the eu-west-1 region.
For more information about VPN customer gateways, see\n\t\t\t\t\tAdding a Hardware\n\t\t\t\t\tVirtual Private Gateway to Your VPC in the\n\t\t\t\t\tAmazon Virtual Private Cloud User Guide.
\n12.1.2.3 and BGP ASN 65534.The name of a DHCP option.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\n\t\tOne or more values for the DHCP option.
\n ", "flattened": true } }, "documentation": "\n\t\tDescribes a DHCP configuration option.
\n ", "xmlname": "DhcpConfiguration" }, "documentation": "\n\t\tA DHCP configuration option.
\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\tThe ID of the set of DHCP options.
\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\tThe name of a DHCP option.
\n ", "xmlname": "key" }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "item" }, "documentation": "\n\t\tOne or more values for the DHCP option.
\n ", "xmlname": "valueSet" } }, "documentation": "\n\t\tDescribes a DHCP configuration option.
\n ", "xmlname": "item" }, "documentation": "\n\t\tOne or more DHCP options in the set.
\n ", "xmlname": "dhcpConfigurationSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the DHCP options set.
\n ", "xmlname": "tagSet" } }, "documentation": "\n\t\tA set of DHCP options.
\n ", "xmlname": "dhcpOptions" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tCreates 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 RFC 2132.
\nFor more information about DHCP options, see DHCP Options Sets\n\t\t\t\tin the Amazon Virtual Private Cloud User Guide.
\nexample.com\n\t\t\t\t\tand two DNS servers (10.2.5.1 and 10.2.5.2).The ID of the instance.
\n ", "required": true }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nA name for the new image.
\nConstraints: 3-128 alphanumeric characters, parenthesis (()), periods (.), slashes\n\t\t\t\t(/), dashes (-), or underscores(_)
\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description for the new image.
\n " }, "NoReboot": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nBy default, this parameter is set to false, 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\ttrue, 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.
The virtual device name.
\n " }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n " }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n " }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n " }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": "\nThe volume type.
\nDefault: standard
The number of I/O operations per second (IOPS) that the\n volume supports.
\nConstraint: Range is 100 to 4000.
\nCondition: Required when the volume type is io1; not used with standard volumes.
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n " }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n " } }, "documentation": "\nDescribes a block device mapping.
\n ", "xmlname": "BlockDeviceMapping" }, "documentation": "\nInformation about one or more block device mappings.
\n ", "flattened": true } }, "documentation": "\n " }, "output": { "shape_name": "CreateImageResult", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the new AMI.
\n ", "xmlname": "imageId" } }, "documentation": "\n " }, "errors": [], "documentation": " \nCreates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either\n\t\t\t\trunning or stopped.
\nIf 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.
\nFor more information, see Creating Amazon EBS-Backed Linux AMIs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nA description for the conversion task or the resource being\n exported. The maximum length is 255 bytes.
\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance.
\n ", "required": true }, "TargetEnvironment": { "shape_name": "ExportEnvironment", "type": "string", "enum": [ "citrix", "vmware", "microsoft" ], "documentation": "\nThe target virtualization environment.
\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": "\nThe image is written to a single object in the Amazon S3 bucket at the S3 key\n s3prefix + exportTaskId + '.' + diskImageFormat.
\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": "\nThe ID of the export task.
\n ", "xmlname": "exportTaskId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description of the resource being exported.
\n ", "xmlname": "description" }, "State": { "shape_name": "ExportTaskState", "type": "string", "enum": [ "active", "cancelling", "cancelled", "completed" ], "documentation": "\nThe state of the conversion task.
\n ", "xmlname": "state" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\nThe status message related to the export task.
\n ", "xmlname": "statusMessage" }, "InstanceExportDetails": { "shape_name": "InstanceExportDetails", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the resource being exported.
\n ", "xmlname": "instanceId" }, "TargetEnvironment": { "shape_name": "ExportEnvironment", "type": "string", "enum": [ "citrix", "vmware", "microsoft" ], "documentation": "\nThe target virtualization environment.
\n ", "xmlname": "targetEnvironment" } }, "documentation": "\nThe instance being exported.
\n ", "xmlname": "instanceExport" }, "ExportToS3Task": { "shape_name": "ExportToS3Task", "type": "structure", "members": { "DiskImageFormat": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": "\nThe format for the exported image.
\n ", "xmlname": "diskImageFormat" }, "ContainerFormat": { "shape_name": "ContainerFormat", "type": "string", "enum": [ "ova" ], "documentation": "\nThe container format used to combine disk images with metadata (such as OVF). If absent, only\n the disk image is exported.
\n ", "xmlname": "containerFormat" }, "S3Bucket": { "shape_name": "String", "type": "string", "documentation": "\nThe 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 vm-import-export@amazon.com.
Exports a running or stopped instance to an Amazon S3 bucket.
\n \nFor information about the supported operating systems, image formats, and known limitations for the\n types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the Internet gateway.
\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\tThe ID of the VPC.
\n ", "xmlname": "vpcId" }, "State": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n\t\tThe current state of the attachment.
\n ", "xmlname": "state" } }, "documentation": "\n\t\tDescribes the attachment of a VPC to an Internet gateway.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny VPCs attached to the Internet gateway.
\n ", "xmlname": "attachmentSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the Internet gateway.
\n ", "xmlname": "tagSet" } }, "documentation": "\n\t\tInformation about the Internet gateway.
\n ", "xmlname": "internetGateway" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tCreates an Internet gateway for use with a VPC. After creating the Internet\n\t\t\t\tgateway, you attach it to a VPC using AttachInternetGateway.
\n\t\tFor more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.
\nA unique name for the key pair.
\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "CreateKeyPairResult", "type": "structure", "members": { "KeyName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the key pair.
\n ", "xmlname": "keyName" }, "KeyFingerprint": { "shape_name": "String", "type": "string", "documentation": "\nThe SHA-1 digest of the DER encoded private key.
\n ", "xmlname": "keyFingerprint" }, "KeyMaterial": { "shape_name": "String", "type": "string", "documentation": "\nAn unencrypted PEM encoded RSA private key.
\n ", "xmlname": "keyMaterial" } }, "documentation": "\n " }, "errors": [], "documentation": "\nCreates 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.
\nYou can have up to five thousand key pairs per region.
\nFor more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nmy-key-pair.The ID of the VPC.
\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\tThe ID of the network ACL.
\n ", "xmlname": "networkAclId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC for the network ACL.
\n ", "xmlname": "vpcId" }, "IsDefault": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether this is the default network ACL for the VPC.
\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\tThe rule number for the entry. ACL entries are processed in ascending order by rule number.
\n ", "xmlname": "ruleNumber" }, "Protocol": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe protocol. A value of -1 means all protocols.
Indicates whether to allow or deny the traffic that matches the rule.
\n ", "xmlname": "ruleAction" }, "Egress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the rule is an egress rule (applied to traffic leaving the subnet).
\n ", "xmlname": "egress" }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe network range to allow or deny, in CIDR notation.
\n ", "xmlname": "cidrBlock" }, "IcmpTypeCode": { "shape_name": "IcmpTypeCode", "type": "structure", "members": { "Type": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe ICMP code. A value of -1 means all codes for the specified ICMP type.
\n ", "xmlname": "type" }, "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe ICMP type. A value of -1 means all types.
\n ", "xmlname": "code" } }, "documentation": "\n\t\tICMP protocol: The ICMP type and code.
\n ", "xmlname": "icmpTypeCode" }, "PortRange": { "shape_name": "PortRange", "type": "structure", "members": { "From": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe first port in the range.
\n ", "xmlname": "from" }, "To": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe last port in the range.
\n ", "xmlname": "to" } }, "documentation": "\n\t\tTCP or UDP protocols: The range of ports the rule applies to.
\n ", "xmlname": "portRange" } }, "documentation": "\n\t\tDescribes an entry in a network ACL.
\n ", "xmlname": "item" }, "documentation": "\n\t\tOne or more entries (rules) in the network ACL.
\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\tThe ID of the association between a network ACL and a subnet.
\n ", "xmlname": "networkAclAssociationId" }, "NetworkAclId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the network ACL.
\n ", "xmlname": "networkAclId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the subnet.
\n ", "xmlname": "subnetId" } }, "documentation": "\n\t\tDescribes an association between a network ACL and a subnet.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny associations between the network ACL and one or more subnets
\n ", "xmlname": "associationSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the network ACL.
\n ", "xmlname": "tagSet" } }, "documentation": "\n\t\tInformation about the network ACL.
\n ", "xmlname": "networkAcl" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tCreates 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.
\n\t\tFor more information about network ACLs, see Network ACLs in\n\t\t\t\tthe Amazon Virtual Private Cloud User Guide.
\nThe ID of the ACL.
\n ", "required": true }, "RuleNumber": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe rule number for the entry (for example, 100). ACL\n\t\t\t\tentries are processed in ascending order by rule number.
\nConstraints: Positive integer from 1 to 32766
\n ", "required": true }, "Protocol": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe protocol. A value of -1 means all protocols.
\n ", "required": true }, "RuleAction": { "shape_name": "RuleAction", "type": "string", "enum": [ "allow", "deny" ], "documentation": "\n\t\tIndicates whether to allow or deny the traffic that matches the rule.
\n ", "required": true }, "Egress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
\n ", "required": true }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe network range to allow or deny, in CIDR notation.
\n ", "required": true }, "IcmpTypeCode": { "shape_name": "IcmpTypeCode", "type": "structure", "members": { "Type": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe ICMP code. A value of -1 means all codes for the specified ICMP type.
\n " }, "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe ICMP type. A value of -1 means all types.
\n " } }, "documentation": "\n\t\tICMP protocol: The ICMP type and code.
\n ", "xmlname": "Icmp" }, "PortRange": { "shape_name": "PortRange", "type": "structure", "members": { "From": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe first port in the range.
\n " }, "To": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe last port in the range.
\n " } }, "documentation": "\n\t\tTCP or UDP protocols: The range of ports the rule applies to.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tCreates 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.
\n\t\tWe 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.
\n\t\tAfter 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.
\n\t\tFor more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
\nacl-2cb85d45. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP\n\t\t\t\t\tport 53 into any associated subnet.The ID of the subnet to associate with the network interface.
\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n\t\tA description for the network interface.
\n " }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe 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.
\n " }, "Groups": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": "\n\t\tThe IDs of one or more security groups.
\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\tThe private IP addresses.
\n ", "required": true }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the private IP address is the primary private IP address.
\n " } }, "documentation": "\n\t\tDescribes a secondary private IP address for a network interface.
\n " }, "documentation": "\n\t\tOne or more private IP addresses.
\n ", "flattened": true }, "SecondaryPrivateIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe 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.
\nThe number of IP addresses you can assign to a network interface\n\t\t\t\tvaries by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.
\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\tThe ID of the network interface.
\n ", "xmlname": "networkInterfaceId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the subnet.
\n ", "xmlname": "subnetId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC.
\n ", "xmlname": "vpcId" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe Availability Zone.
\n ", "xmlname": "availabilityZone" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n\t\tA description.
\n ", "xmlname": "description" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe AWS account ID of the owner of the network interface.
\n ", "xmlname": "ownerId" }, "RequesterId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the entity that launched the instance on your behalf (for example, AWS\n\t\t\t\tManagement Console or Auto Scaling).
\n ", "xmlname": "requesterId" }, "RequesterManaged": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the network interface is being managed by AWS.
\n ", "xmlname": "requesterManaged" }, "Status": { "shape_name": "NetworkInterfaceStatus", "type": "string", "enum": [ "available", "attaching", "in-use", "detaching" ], "documentation": "\n\t\tThe status of the network interface.
\n ", "xmlname": "status" }, "MacAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe MAC address.
\n ", "xmlname": "macAddress" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe IP address of the network interface within the subnet.
\n ", "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe private DNS name.
\n ", "xmlname": "privateDnsName" }, "SourceDestCheck": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether traffic to or from the instance is validated.
\n ", "xmlname": "sourceDestCheck" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny security groups for the network interface.
\n ", "xmlname": "groupSet" }, "Attachment": { "shape_name": "NetworkInterfaceAttachment", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the network interface attachment.
\n ", "xmlname": "attachmentId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the instance.
\n ", "xmlname": "instanceId" }, "InstanceOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe AWS account ID of the owner of the instance.
\n ", "xmlname": "instanceOwnerId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe device index of the network interface attachment on the instance.
\n ", "xmlname": "deviceIndex" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n\t\tThe attachment state.
\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n\t\tThe timestamp indicating when the attachment initiated.
\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the network interface is deleted when the instance is terminated.
\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n\t\tThe network interface attachment.
\n ", "xmlname": "attachment" }, "Association": { "shape_name": "NetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", "xmlname": "publicIp" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the Elastic IP address owner.
\n ", "xmlname": "ipOwnerId" }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe allocation ID.
\n ", "xmlname": "allocationId" }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe association ID.
\n ", "xmlname": "associationId" } }, "documentation": "\n\t\tThe association information for an Elastic IP associated with the network interface.
\n ", "xmlname": "association" }, "TagSet": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the network interface.
\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\tThe private IP address.
\n ", "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe private DNS name.
\n ", "xmlname": "privateDnsName" }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether this IP address is the primary private IP address of the network interface.
\n ", "xmlname": "primary" }, "Association": { "shape_name": "NetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", "xmlname": "publicIp" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the Elastic IP address owner.
\n ", "xmlname": "ipOwnerId" }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe allocation ID.
\n ", "xmlname": "allocationId" }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe association ID.
\n ", "xmlname": "associationId" } }, "documentation": "\n\t\tThe association information for an Elastic IP address associated with the network interface.
\n ", "xmlname": "association" } }, "documentation": "\n\t\tDescribes the private IP address of a network interface.
\n ", "xmlname": "item" }, "documentation": "\n\t\tThe private IP addresses associated with the network interface.
\n ", "xmlname": "privateIpAddressesSet" } }, "documentation": "\n\t\tInformation about the network interface.
\n ", "xmlname": "networkInterface" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tCreates a network interface in the specified subnet.
\n\t\tFor more information about network interfaces, see Elastic Network Interfaces \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\n10.0.2.140 and four secondary private IP\n\t\t\t\t\taddresses that are automatically selected by Amazon EC2.A name for the placement group.
\nConstraints: Up to 255 ASCII characters
\n ", "required": true }, "Strategy": { "shape_name": "PlacementStrategy", "type": "string", "enum": [ "cluster" ], "documentation": "\nThe placement strategy.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nCreates 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.
\nFor more information about placement groups and cluster instances, see\n\t\t\t\tCluster Instances\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nXYZ-cluster.The ID of the active Reserved Instance.
\n ", "required": true }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe 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.
\n ", "required": true }, "PriceSchedules": { "shape_name": "PriceScheduleSpecificationList", "type": "list", "members": { "shape_name": "PriceScheduleSpecification", "type": "structure", "members": { "Term": { "shape_name": "Long", "type": "long", "documentation": "\nThe 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.
\n " }, "Price": { "shape_name": "Double", "type": "double", "documentation": "\nThe fixed price for the term.
\n " }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": "\nThe currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.
Describes the price for a Reserved Instance.
\n " }, "documentation": "\nA list specifying the price of the Reserved Instance for each month\n\t\t\t\tremaining in the Reserved Instance term.
\n ", "required": true, "flattened": true }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": "\nUnique, 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\tEnsuring Idempotency \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\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": "\nThe ID of the Reserved Instance listing.
\n ", "xmlname": "reservedInstancesListingId" }, "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the Reserved Instance.
\n ", "xmlname": "reservedInstancesId" }, "CreateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time the listing was created.
\n ", "xmlname": "createDate" }, "UpdateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe last modified timestamp of the listing.
\n ", "xmlname": "updateDate" }, "Status": { "shape_name": "ListingStatus", "type": "string", "enum": [ "active", "pending", "cancelled", "closed" ], "documentation": "\nThe status of the Reserved Instance listing.
\n ", "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\nThe reason for the current status of the Reserved Instance listing. \n\t\t\t\tThe response can be blank.
\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": "\nThe states of the listed Reserved Instances.
\n ", "xmlname": "state" }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nhe number of listed Reserved Instances in the state specified by the state.
Describes a Reserved Instance listing state.
\n ", "xmlname": "item" }, "documentation": "\nThe number of instances in this state.
\n ", "xmlname": "instanceCounts" }, "PriceSchedules": { "shape_name": "PriceScheduleList", "type": "list", "members": { "shape_name": "PriceSchedule", "type": "structure", "members": { "Term": { "shape_name": "Long", "type": "long", "documentation": "\nThe 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.
\n ", "xmlname": "term" }, "Price": { "shape_name": "Double", "type": "double", "documentation": "\nThe fixed price for the term.
\n ", "xmlname": "price" }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": "\nThe currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.
The current price schedule, as determined by the term remaining for the \n\t\t\t\tReserved Instance in the listing.
\nA 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.
\n ", "xmlname": "active" } }, "documentation": "\nDescribes the price for a Reserved Instance.
\n ", "xmlname": "item" }, "documentation": "\nThe price of the Reserved Instance listing.
\n ", "xmlname": "priceSchedules" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the resource.
\n ", "xmlname": "tagSet" }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": "\nThe idempotency token you provided when you created the listing.
\n ", "xmlname": "clientToken" } }, "documentation": "\nDescribes a Reserved Instance listing.
\n ", "xmlname": "item" }, "documentation": "\nInformation about the Reserved Instances listing.
\n ", "xmlname": "reservedInstancesListingsSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nCreates 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.
\nFor more information, see Reserved Instance Marketplace in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.
\nThe ID of the route table for the route.
\n ", "required": true }, "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe CIDR address block used for the destination match. Routing\n\t\t\t\tdecisions are based on the most specific match.
\n ", "required": true }, "GatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of an Internet gateway attached to your VPC.
\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe 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.
\n " }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of a network interface.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nCreates a route in a route table within a VPC.
\nYou must specify one of the following targets: Internet gateway, NAT instance, or network interface.
\nWhen 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 192.0.2.3, and the route\n\t\t\ttable includes the following two routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. 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.
For more information about route tables, see Route Tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nrtb-e4ad488d. The\n\t\t\t\t\troute matches all traffic (0.0.0.0/0) and routes it to the Internet gateway with the\n\t\t\t\t\tID igw-eaad4883.rtb-g8ff4ea2. The\n\t\t\t\t\troute sends all traffic (0.0.0.0/0) to the NAT instance with the ID\n\t\t\t\t\ti-1a2b3c4d.The ID of the VPC.
\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\tThe ID of the route table.
\n ", "xmlname": "routeTableId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC.
\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\tThe CIDR block used for the destination match.
\n ", "xmlname": "destinationCidrBlock" }, "GatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of a gateway attached to your VPC.
\n ", "xmlname": "gatewayId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of a NAT instance in your VPC.
\n ", "xmlname": "instanceId" }, "InstanceOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe AWS account ID of the owner of the instance.
\n ", "xmlname": "instanceOwnerId" }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the network interface.
\n ", "xmlname": "networkInterfaceId" }, "State": { "shape_name": "RouteState", "type": "string", "enum": [ "active", "blackhole" ], "documentation": "\n\t\tThe state of the route. The blackhole 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).
Describes a route in a route table.
\n ", "xmlname": "item" }, "documentation": "\n\t\tThe routes in the route table.
\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\tThe ID of the association between a route table and a subnet.
\n ", "xmlname": "routeTableAssociationId" }, "RouteTableId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the route table.
\n ", "xmlname": "routeTableId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the subnet.
\n ", "xmlname": "subnetId" }, "Main": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether this is the main route table.
\n ", "xmlname": "main" } }, "documentation": "\n\t\tDescribes an association between a route table and a subnet.
\n ", "xmlname": "item" }, "documentation": "\n\t\tThe associations between the route table and one or more subnets.
\n ", "xmlname": "associationSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the route table.
\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\tThe ID of the virtual private gateway (VGW).
\n ", "xmlname": "gatewayId" } }, "documentation": "\n\t\tDescribes a virtual private gateway propagating route.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny virtual private gateway (VGW) propagating routes.
\n ", "xmlname": "propagatingVgwSet" } }, "documentation": "\n\t\tInformation about the route table.
\n ", "xmlname": "routeTable" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tCreates 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.
\nFor more information about route tables, see Route Tables in\n\t\t\t\tthe Amazon Virtual Private Cloud User Guide.
\nvpc-11ad4878.\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.The name of the security group.
\nConstraints: Up to 255 characters in length
\nConstraints for EC2-Classic: ASCII characters
\nConstraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description for the security group. This is informational only.
\n ", "required": true, "xmlname": "GroupDescription" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n[EC2-VPC] The ID of the VPC.
\n " } }, "documentation": "\n " }, "output": { "shape_name": "CreateSecurityGroupResult", "type": "structure", "members": { "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" } }, "documentation": "\n " }, "errors": [], "documentation": "\nCreates a security group.
\nA 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\tAmazon EC2 Security Groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity Groups for Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nEC2-Classic: You can have up to 500 security groups.
\n\t\t\t\tEC2-VPC: You can create up to 100 security groups per VPC.
\n\t\t\tWhen 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.
\nYou 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.
\nYou can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.
\nwebsrv for EC2-Classic.WebServerSG for the specified VPC.The ID of the Amazon EBS volume.
\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description for the snapshot.
\n " } }, "documentation": "\n " }, "output": { "shape_name": "Snapshot", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the snapshot.
\n ", "xmlname": "snapshotId" }, "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the volume.
\n ", "xmlname": "volumeId" }, "State": { "shape_name": "SnapshotState", "type": "string", "enum": [ "pending", "completed", "error" ], "documentation": "\nThe snapshot state.
\n ", "xmlname": "status" }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when the snapshot was initiated.
\n ", "xmlname": "startTime" }, "Progress": { "shape_name": "String", "type": "string", "documentation": "\nThe progress of the snapshot, as a percentage.
\n ", "xmlname": "progress" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the Amazon EBS snapshot owner.
\n ", "xmlname": "ownerId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description for the snapshot.
\n ", "xmlname": "description" }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe size of the volume, in GiB.
\n ", "xmlname": "volumeSize" }, "OwnerAlias": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account alias (for example, amazon, self) or AWS account ID\n that owns the snapshot.
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.
\nWhen a snapshot is created, any AWS Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.
\nYou 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 pending.
To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance\n before taking the snapshot.
\nFor more information, see Creating an\n Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
\nvol-1a2b3c4d.The Amazon S3 bucket in which to store the Spot Instance datafeed.
\nConstraints: Must be a valid bucket associated with your AWS account.
\n ", "required": true }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\nA prefix for the datafeed file names.
\n " } }, "documentation": "\n " }, "output": { "shape_name": "CreateSpotDatafeedSubscriptionResult", "type": "structure", "members": { "SpotDatafeedSubscription": { "shape_name": "SpotDatafeedSubscription", "type": "structure", "members": { "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the account.
\n ", "xmlname": "ownerId" }, "Bucket": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon S3 bucket where the Spot Instance datafeed is located.
\n ", "xmlname": "bucket" }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\nThe prefix that is prepended to datafeed files.
\n ", "xmlname": "prefix" }, "State": { "shape_name": "DatafeedSubscriptionState", "type": "string", "enum": [ "Active", "Inactive" ], "documentation": "\nThe state of the Spot Instance datafeed subscription.
\n ", "xmlname": "state" }, "Fault": { "shape_name": "SpotInstanceStateFault", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\nThe reason code for the Spot Instance state change.
\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nThe message for the Spot Instance state change.
\n ", "xmlname": "message" } }, "documentation": "\nThe fault codes for the Spot Instance request, if any.
\n ", "xmlname": "fault" } }, "documentation": "\nThe Spot Instance datafeed subscription.
\n ", "xmlname": "spotDatafeedSubscription" } }, "documentation": "\n " }, "errors": [], "documentation": "\nCreates 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\tSpot Instances in\n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide.
\nThe ID of the VPC.
\n ", "required": true }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.
The Availability Zone for the subnet.
\n\t\tDefault: Amazon EC2 selects one for you (recommended).
\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\tThe ID of the subnet.
\n ", "xmlname": "subnetId" }, "State": { "shape_name": "SubnetState", "type": "string", "enum": [ "pending", "available" ], "documentation": "\n\t\tThe current state of the subnet.
\n ", "xmlname": "state" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC the subnet is in.
\n ", "xmlname": "vpcId" }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe CIDR block assigned to the subnet.
\n ", "xmlname": "cidrBlock" }, "AvailableIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe number of unused IP addresses in the subnet. Note that the IP addresses for any\n\t\t\t\tstopped instances are considered unavailable.
\n ", "xmlname": "availableIpAddressCount" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe Availability Zone of the subnet.
\n ", "xmlname": "availabilityZone" }, "DefaultForAz": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether this is the default subnet for the Availability Zone.
\n ", "xmlname": "defaultForAz" }, "MapPublicIpOnLaunch": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether instances launched in this subnet receive a public IP address.
\n ", "xmlname": "mapPublicIpOnLaunch" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the subnet.
\n ", "xmlname": "tagSet" } }, "documentation": "\n\t\tInformation about the subnet.
\n ", "xmlname": "subnet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nCreates a subnet in an existing VPC.
\nWhen 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).
\nAWS reserves both the first four and the last IP address in each subnet's\n CIDR block. They're not available for use.
\nIf 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.
\n\t\tFor more information about subnets, see Your VPC and Subnets\n\t\t\t in the Amazon Virtual Private Cloud User Guide.
\n10.0.1.0/24 in the VPC with the ID\n\t\t\t\t\tvpc-1a2b3c4d.The IDs of one or more resources to tag. For example, ami-1a2b3c4d.
\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": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n " } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "Tag" }, "documentation": "\nOne or more tags. The value 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.
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.
\nFor more information about tags, see Tagging\n Your Resources in the Amazon Elastic Compute Cloud User Guide.
\nwebserver), with no value (we set the value to an empty\n string). The other tag consists of a key (stack) and value\n (Production).The size of the volume, in GiBs.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10\n GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the\n default is the snapshot size.
\n " }, "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\nThe snapshot from which to create the volume.
\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone in which to create the volume. Use DescribeAvailabilityZones to\n list the Availability Zones that are currently available to you.
\n ", "required": true }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": "\nThe volume type.
\nDefault: standard
The number of I/O operations per second (IOPS) that the volume supports. This parameter is not\n used with standard volumes, but is required when the volume type is io1.
The ID of the volume.
\n ", "xmlname": "volumeId" }, "Size": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe size of the volume, in GiBs.
\n ", "xmlname": "size" }, "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\nThe snapshot from which the volume was created, if applicable.
\n ", "xmlname": "snapshotId" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone for the volume.
\n ", "xmlname": "availabilityZone" }, "State": { "shape_name": "VolumeState", "type": "string", "enum": [ "creating", "available", "in-use", "deleting", "deleted", "error" ], "documentation": "\nThe volume state.
\n ", "xmlname": "status" }, "CreateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when volume creation was initiated.
\n ", "xmlname": "createTime" }, "Attachments": { "shape_name": "VolumeAttachmentList", "type": "list", "members": { "shape_name": "VolumeAttachment", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the volume.
\n ", "xmlname": "volumeId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance.
\n ", "xmlname": "instanceId" }, "Device": { "shape_name": "String", "type": "string", "documentation": "\nThe device name.
\n ", "xmlname": "device" }, "State": { "shape_name": "VolumeAttachmentState", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\nThe attachment state of the volume.
\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when the attachment initiated.
\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\nDescribes volume attachment details.
\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": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the volume.
\n ", "xmlname": "tagSet" }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": "\nThe volume type.
\n ", "xmlname": "volumeType" }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of I/O operations per second (IOPS) that the volume supports.
\n ", "xmlname": "iops" } }, "documentation": "\n ", "xmlname": "volume" }, "errors": [], "documentation": "\nCreates an Amazon EBS volume that can be attached to any instance in the same Availability\n Zone.
\nAny AWS Marketplace product codes from the snapshot are propagated to the volume.
\nFor more information, see Creating or\n Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
\nus-east-1a.The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.
The supported tenancy options for instances launched into the VPC.\n\t\t\t\tA value of default means that instances can be launched\n\t\t\t\twith any tenancy; a value of dedicated 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.
Default: default
The ID of the VPC.
\n ", "xmlname": "vpcId" }, "State": { "shape_name": "VpcState", "type": "string", "enum": [ "pending", "available" ], "documentation": "\n\t\tThe current state of the VPC.
\n ", "xmlname": "state" }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe CIDR block for the VPC.
\n ", "xmlname": "cidrBlock" }, "DhcpOptionsId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the set of DHCP options you've associated with the VPC (or default\n\t\t\t\tif the default options are associated with the VPC).
The key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the VPC.
\n ", "xmlname": "tagSet" }, "InstanceTenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\n\t\tThe allowed tenancy of instances launched into the VPC.
\n ", "xmlname": "instanceTenancy" }, "IsDefault": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the VPC is the default VPC.
\n ", "xmlname": "isDefault" } }, "documentation": "\n\t\tInformation about the VPC.
\n ", "xmlname": "vpc" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tCreates a VPC with the specified CIDR block.
\n\t\tThe 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 Your VPC and Subnets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\n\t\tBy 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 DHCP Options Sets\n\t\t\t\tin the Amazon Virtual Private Cloud User Guide.
\n10.0.0.0/16.dedicated tenancy option.The type of VPN connection.
\n ", "required": true }, "CustomerGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the customer gateway.
\n ", "required": true }, "VpnGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the virtual private gateway.
\n ", "required": true }, "Options": { "shape_name": "VpnConnectionOptionsSpecification", "type": "structure", "members": { "StaticRoutesOnly": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the VPN connection uses static routes only. \n\t\t Static routes must be used for devices that don't support BGP.
\n " } }, "documentation": "\n\t\tIndicates 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 true.
Default: false
The ID of the VPN connection.
\n ", "xmlname": "vpnConnectionId" }, "State": { "shape_name": "VpnState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": "\n\t\tThe current state of the VPN connection.
\n ", "xmlname": "state" }, "CustomerGatewayConfiguration": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe 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\tCreateVpnConnection response; however, it's present in the\n\t\t\t\tDescribeVpnConnections response only if the VPN connection is in\n\t\t\t\tthe pending or available state.
The type of VPN connection.
\n ", "xmlname": "type" }, "CustomerGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the customer gateway at your end of the VPN connection.
\n ", "xmlname": "customerGatewayId" }, "VpnGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the virtual private gateway at the AWS side of the VPN connection.
\n ", "xmlname": "vpnGatewayId" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the VPN connection.
\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\tThe Internet-routable IP address of the virtual private gateway's outside interface.
\n ", "xmlname": "outsideIpAddress" }, "Status": { "shape_name": "TelemetryStatus", "type": "string", "enum": [ "UP", "DOWN" ], "documentation": "\n\t\tThe status of the VPN tunnel.
\n ", "xmlname": "status" }, "LastStatusChange": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n\t\tThe date and time of the last change in status.
\n ", "xmlname": "lastStatusChange" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\n\t\tIf an error occurs, a description of the error.
\n ", "xmlname": "statusMessage" }, "AcceptedRouteCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe number of accepted routes.
\n ", "xmlname": "acceptedRouteCount" } }, "documentation": "\n\t\tDescribes telemetry for a VPN tunnel.
\n ", "xmlname": "item" }, "documentation": "\n\t\tInformation about the VPN tunnel.
\n ", "xmlname": "vgwTelemetry" }, "Options": { "shape_name": "VpnConnectionOptions", "type": "structure", "members": { "StaticRoutesOnly": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the VPN connection uses static routes only. \n\t\t Static routes must be used for devices that don't support BGP.
\n ", "xmlname": "staticRoutesOnly" } }, "documentation": "\n\t\tThe VPN connection options.
\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\tThe CIDR block associated with the local subnet of the customer data center.
\n ", "xmlname": "destinationCidrBlock" }, "Source": { "shape_name": "VpnStaticRouteSource", "type": "string", "enum": [ "Static" ], "documentation": "\n\t\tIndicates how the routes were provided.
\n ", "xmlname": "source" }, "State": { "shape_name": "VpnState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": "\n\t\tThe current state of the static route.
\n ", "xmlname": "state" } }, "documentation": "\n\t\tDescribes a static route for a VPN connection.
\n ", "xmlname": "item" }, "documentation": "\n\t\tThe static routes assoicated with the VPN connection.
\n ", "xmlname": "routes" } }, "documentation": "\n\t\tInformation about the VPN connection.
\n ", "xmlname": "vpnConnection" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tCreates a VPN connection between an existing virtual private gateway and a VPN customer\n\t\t\t\tgateway. The only supported connection type is ipsec.1.
The response includes information that you need to give to your network administrator \n\t\t to configure your customer gateway.
\nWe 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.
\n\t\tIf 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.
\n\t\tFor more information about VPN connections, see Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.
\nvgw-8db04f81 and the customer gateway with the ID cgw-b4dc3961. 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 Amazon Virtual Private Cloud Network Administrator Guide.vgw-8db04f81, and the customer\n\t\t\t\t\tgateway with the ID cgw-b4dc3961, 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.The ID of the VPN connection.
\n ", "required": true }, "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe CIDR block associated with the local subnet of the customer network.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tCreates 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.
\n\t\tFor more information about VPN connections, see Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.
\nvpn-83ad48ea to the destination CIDR block 11.12.0.0/16. Note that\n\t\t\t\t\twhen using the Query API the \"/\" is denoted as \"%2F\".The type of VPN connection this virtual private gateway supports.
\n ", "required": true }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe Availability Zone for the virtual private gateway.
\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\tThe ID of the virtual private gateway.
\n ", "xmlname": "vpnGatewayId" }, "State": { "shape_name": "VpnState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": "\n\t\tThe current state of the virtual private gateway.
\n ", "xmlname": "state" }, "Type": { "shape_name": "GatewayType", "type": "string", "enum": [ "ipsec.1" ], "documentation": "\n\t\tThe type of VPN connection the virtual private gateway supports.
\n ", "xmlname": "type" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe Availability Zone where the virtual private gateway was created.
\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\tThe ID of the VPC.
\n ", "xmlname": "vpcId" }, "State": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n\t\tThe current state of the attachment.
\n ", "xmlname": "state" } }, "documentation": "\n\t\tDescribes an attachment between a virtual private gateway and a VPC.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny VPCs attached to the virtual private gateway.
\n ", "xmlname": "attachments" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the virtual private gateway.
\n ", "xmlname": "tagSet" } }, "documentation": "\n\t\tInformation about the virtual private gateway.
\n ", "xmlname": "vpnGateway" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tCreates 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.
\n\t\tFor more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.
\nThe ID of the customer gateway.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes the specified customer gateway. You must delete the VPN connection before you can delete\n\t\t\t\tthe customer gateway.
\nThe ID of the DHCP options set.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes 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.
\nThe ID of the Internet gateway.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes the specified Internet gateway. You must detach the Internet gateway \n\t\t\t\tfrom the VPC before you can delete it.
\nThe name of the key pair.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nDeletes the specified key pair, by removing the public key from Amazon EC2.
\nmy-key-pair.The ID of the network ACL.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes 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.
\nThe ID of the network ACL.
\n ", "required": true }, "RuleNumber": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe rule number of the entry to delete.
\n ", "required": true }, "Egress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the rule is an egress rule.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes the specified ingress or egress entry (rule) from the specified network ACL.
\nThe ID of the network interface.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes the specified network interface. You must detach the network interface\n\t\t\t before you can delete it.
\nThe name of the placement group.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nDeletes 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 Cluster Instances\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nXYZ-cluster.The ID of the route table.
\n ", "required": true }, "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe CIDR range for the route. The value you specify must\n\t\t\t\tmatch the CIDR for the route exactly.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes the specified route from the specified route table.
\n172.16.1.0/24 from the\n\t\t\t\t\tspecified route table.The ID of the route table.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes 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.
\n[EC2-Classic, default VPC] The name of the security group.
\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nDeletes a security group.
\nIf 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\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.
The ID of the Amazon EBS snapshot.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nDeletes the specified snapshot.
\nWhen 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.
\nYou 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.
\nFor more information, see Deleting an\n Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
\nsnap-1a2b3c4d.Deletes the datafeed for Spot Instances. For more information, see\n\t\t\t\tSpot Instances in\n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide.
\nThe ID of the subnet.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes the specified subnet. You must terminate all running instances in the\n\t\t\t\tsubnet before you can delete the subnet.
\nThe ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.
\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": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n " } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "Tag" }, "documentation": "\nOne or more tags to delete. If you omit the value 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.
Deletes the specified set of tags from the specified set of resources. This call is designed\n to follow a DescribeTags request.
For more information about tags, see Tagging\n Your Resources in the Amazon Elastic Compute Cloud User Guide.
\nami-1a2b3c4d.\n First, get a list of the tags by using the DescribeTags request, then delete\n them.stack and webserver tags for two\n particular instances.Purpose, regardless of the tag value.Purpose and the tag value is the empty string.The ID of the volume.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nDeletes the specified Amazon EBS volume. The volume must be in the available state (not\n attached to an instance).
The volume remains in the deleting state for several minutes.
For more information, see Deleting an Amazon EBS\n Volume in the Amazon Elastic Compute Cloud User Guide.
\nvol-1a2b3c4d.The ID of the VPC.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes 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.
\nThe ID of the VPN connection.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes the specified VPN connection.
\n\t\tIf 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.
\nThe ID of the VPN connection.
\n ", "required": true }, "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe CIDR block associated with the local subnet of the customer network.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes 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.
\n11.12.0.0/16 associated with the VPN connection with the ID\n\t\t\t\t\tvpn-83ad48ea. Note that when using the Query API, the \"/\" is\n\t\t\t\t\tdenoted as \"%2F\".The ID of the virtual private gateway.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDeletes 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.
\nThe ID of the AMI.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": " \nDeregisters the specified AMI. After you deregister an AMI, it can't be used to launch\n\t\t\t\tnew instances.
\nThis command does not delete the AMI.
\nOne or more account attribute names.
\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": " \nThe name of the account attribute.
\n ", "xmlname": "attributeName" }, "AttributeValues": { "shape_name": "AccountAttributeValueList", "type": "list", "members": { "shape_name": "AccountAttributeValue", "type": "structure", "members": { "AttributeValue": { "shape_name": "String", "type": "string", "documentation": " \nThe value.
\n ", "xmlname": "attributeValue" } }, "documentation": " \nDescribes a value of an account attribute.
\n ", "xmlname": "item" }, "documentation": " \nOne or more values for the account attribute.
\n ", "xmlname": "attributeValueSet" } }, "documentation": " \nDescribes an account attribute.
\n ", "xmlname": "item" }, "documentation": "\nInformation about one or more account attributes.
\n ", "xmlname": "accountAttributeSet" } }, "documentation": "\n " }, "errors": [], "documentation": " \nDescribes the specified attribute of your AWS account.
\n[EC2-Classic] One or more Elastic IP addresses.
\nDefault: Describes all your Elastic IP addresses.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\nallocation-id - [EC2-VPC] The allocation ID for the address.
association-id - [EC2-VPC] The association ID for the address.
domain - Indicates whether the address is for use in EC2-Classic (standard) \n or in a VPC (vpc).
instance-id - The ID of the instance the address is associated with, if any.
network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The AWS account ID of the owner.
private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address.
[EC2-VPC] One or more allocation IDs.
\nDefault: Describes all your Elastic IP addresses.
\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": "\nThe ID of the instance the address is associated with (if any).
\n ", "xmlname": "instanceId" }, "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\nThe Elastic IP address.
\n ", "xmlname": "publicIp" }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID representing the allocation of the address for use with EC2-VPC.
\n ", "xmlname": "allocationId" }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID representing the association of the address with an instance in a VPC.
\n ", "xmlname": "associationId" }, "Domain": { "shape_name": "DomainType", "type": "string", "enum": [ "vpc", "standard" ], "documentation": "\nIndicates whether this Elastic IP address is for use with instances\n\t\t\t\tin EC2-Classic (standard) or instances in a VPC (vpc).
The ID of the network interface.
\n ", "xmlname": "networkInterfaceId" }, "NetworkInterfaceOwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the AWS account that owns the network interface.
\n ", "xmlname": "networkInterfaceOwnerId" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\nThe private IP address associated with the Elastic IP address.
\n ", "xmlname": "privateIpAddress" } }, "documentation": "\nDescribes an Elastic IP address.
\n ", "xmlname": "item" }, "documentation": "\nInformation about one or more Elastic IP addresses.
\n ", "xmlname": "addressesSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes one or more of your Elastic IP addresses.
\nAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\n192.0.2.1 is assigned to instance i-f15ebb98, \n\t\t\t\t\tand 198.51.100.2 isn't assigned to an instance.The names of one or more Availability Zones.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\nmessage - Information about the Availability Zone.
region-name - The name of the region for the Availability Zone (for example, us-east-1).
state - The state of the Availability Zone\n (available | impaired | unavailable).
zone-name - The name of the Availability Zone (for example, us-east-1a).
The name of the Availability Zone.
\n ", "xmlname": "zoneName" }, "State": { "shape_name": "AvailabilityZoneState", "type": "string", "enum": [ "available" ], "documentation": " \nThe state of the Availability Zone.
\n ", "xmlname": "zoneState" }, "RegionName": { "shape_name": "String", "type": "string", "documentation": " \nThe name of the region.
\n ", "xmlname": "regionName" }, "Messages": { "shape_name": "AvailabilityZoneMessageList", "type": "list", "members": { "shape_name": "AvailabilityZoneMessage", "type": "structure", "members": { "Message": { "shape_name": "String", "type": "string", "documentation": " \nThe message about the Availability Zone.
\n ", "xmlname": "message" } }, "documentation": " \nDescribes a message about an Availability Zone.
\n ", "xmlname": "item" }, "documentation": " \nAny messages about the Availability Zone.
\n ", "xmlname": "messageSet" } }, "documentation": " \nDescribes an Availability Zone.
\n ", "xmlname": "item" }, "documentation": "\nInformation about one or more Availability Zones.
\n ", "xmlname": "availabilityZoneInfo" } }, "documentation": "\n " }, "errors": [], "documentation": " \nDescribes 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.
\nFor more information, see Regions and Availability Zones\n in the Amazon Elastic Compute Cloud User Guide.
\nOne or more bundle task IDs.
\nDefault: Describes all your bundle tasks.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\nbundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling |\n storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
The ID of the instance associated with this bundle task.
\n ", "xmlname": "instanceId" }, "BundleId": { "shape_name": "String", "type": "string", "documentation": " \nThe ID for this bundle task.
\n ", "xmlname": "bundleId" }, "State": { "shape_name": "BundleTaskState", "type": "string", "enum": [ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ], "documentation": " \nThe state of the task.
\n ", "xmlname": "state" }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": " \nThe time this task started.
\n ", "xmlname": "startTime" }, "UpdateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": " \nThe time of the most recent update for the task.
\n ", "xmlname": "updateTime" }, "Storage": { "shape_name": "Storage", "type": "structure", "members": { "S3": { "shape_name": "S3Storage", "type": "structure", "members": { "Bucket": { "shape_name": "String", "type": "string", "documentation": "\nThe 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.
\n ", "xmlname": "bucket" }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\nThe beginning of the file name of the AMI.
\n ", "xmlname": "prefix" }, "AWSAccessKeyId": { "shape_name": "String", "type": "string", "documentation": "\nThe access key ID of the owner of the bucket.
\n " }, "UploadPolicy": { "shape_name": "String", "type": "string", "documentation": "\nA Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
\n ", "xmlname": "uploadPolicy" }, "UploadPolicySignature": { "shape_name": "String", "type": "string", "documentation": "\nThe signature of the Base64 encoded JSON document.
\n ", "xmlname": "uploadPolicySignature" } }, "documentation": "\nAn Amazon S3 storage location.
\n " } }, "documentation": " \nThe Amazon S3 storage locations.
\n ", "xmlname": "storage" }, "Progress": { "shape_name": "String", "type": "string", "documentation": " \nThe level of task completion, as a percent (for example, 20%).
\n ", "xmlname": "progress" }, "BundleTaskError": { "shape_name": "BundleTaskError", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": " \nThe error code.
\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": " \nThe error message.
\n ", "xmlname": "message" } }, "documentation": " \nIf the task fails, a description of the error.
\n ", "xmlname": "error" } }, "documentation": " \nDescribes a bundle task.
\n ", "xmlname": "item" }, "documentation": "\nInformation about one or more bundle tasks.
\n ", "xmlname": "bundleInstanceTasksSet" } }, "documentation": "\n " }, "errors": [], "documentation": " \nDescribes one or more of your bundling tasks.
\nCompleted 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 RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.
complete or failed, and in addition are targeted for the Amazon S3 bucket named myawsbucket.The name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\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": "\nOne or more conversion task IDs.
\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": "\nThe ID of the conversion task.
\n ", "required": true, "xmlname": "conversionTaskId" }, "ExpirationTime": { "shape_name": "String", "type": "string", "documentation": "\nThe time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
\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": "\nThe number of bytes converted so far.
\n ", "required": true, "xmlname": "bytesConverted" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone where the resulting instance will reside.
\n ", "required": true, "xmlname": "availabilityZone" }, "Image": { "shape_name": "DiskImageDescription", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": "\nThe disk image format.
\n ", "required": true, "xmlname": "format" }, "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the disk image.
\n ", "required": true, "xmlname": "size" }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": "\nA 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 Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", "required": true, "xmlname": "importManifestUrl" }, "Checksum": { "shape_name": "String", "type": "string", "documentation": "\nThe checksum computed for the disk image.
\n ", "xmlname": "checksum" } }, "documentation": "\nThe image.
\n ", "required": true, "xmlname": "image" }, "Volume": { "shape_name": "DiskImageVolumeDescription", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the volume.
\n ", "xmlname": "size" }, "Id": { "shape_name": "String", "type": "string", "documentation": "\nThe volume identifier.
\n ", "required": true, "xmlname": "id" } }, "documentation": "\nThe volume.
\n ", "required": true, "xmlname": "volume" }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the import of this particular disk image.
\n ", "required": true, "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\nThe status information or errors related to the disk image.
\n ", "xmlname": "statusMessage" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n ", "xmlname": "description" } }, "documentation": "\nDescribes an import volume task.
\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": "\nThe instance operating system.
\n ", "xmlname": "platform" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n ", "xmlname": "description" } }, "documentation": "\nIf the task is for importing an instance, this contains information about the import instance task.
\n ", "xmlname": "importInstance" }, "ImportVolume": { "shape_name": "ImportVolumeTaskDetails", "type": "structure", "members": { "BytesConverted": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of bytes converted so far.
\n ", "required": true, "xmlname": "bytesConverted" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone where the resulting volume will reside.
\n ", "required": true, "xmlname": "availabilityZone" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description you provided when starting the import volume task.
\n ", "xmlname": "description" }, "Image": { "shape_name": "DiskImageDescription", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": "\nThe disk image format.
\n ", "required": true, "xmlname": "format" }, "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the disk image.
\n ", "required": true, "xmlname": "size" }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": "\nA 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 Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", "required": true, "xmlname": "importManifestUrl" }, "Checksum": { "shape_name": "String", "type": "string", "documentation": "\nThe checksum computed for the disk image.
\n ", "xmlname": "checksum" } }, "documentation": "\nThe image.
\n ", "required": true, "xmlname": "image" }, "Volume": { "shape_name": "DiskImageVolumeDescription", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the volume.
\n ", "xmlname": "size" }, "Id": { "shape_name": "String", "type": "string", "documentation": "\nThe volume identifier.
\n ", "required": true, "xmlname": "id" } }, "documentation": "\nThe volume.
\n ", "required": true, "xmlname": "volume" } }, "documentation": "\nIf the task is for importing a volume, this contains information about the import volume task.
\n ", "xmlname": "importVolume" }, "State": { "shape_name": "ConversionTaskState", "type": "string", "enum": [ "active", "cancelling", "cancelled", "completed" ], "documentation": "\nThe state of the conversion task.
\n ", "required": true, "xmlname": "state" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\nThe status message related to the conversion task.
\n ", "xmlname": "statusMessage" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n ", "xmlname": "tagSet" } }, "documentation": "\nDescribes a conversion task.
\n ", "xmlname": "item" }, "documentation": "\n ", "xmlname": "conversionTasks" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes one or more of your conversion tasks. For more information, see Using the Command Line\n Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
\nOne or more customer gateway IDs.
\n\t\tDefault: Describes all your customer gateways.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\n\t\tOne or more filters.
\n\t\tbgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway's Internet-routable external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
The ID of the customer gateway.
\n ", "xmlname": "customerGatewayId" }, "State": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe current state of the customer gateway.
\n ", "xmlname": "state" }, "Type": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe type of VPN connection the customer gateway supports.
\n ", "xmlname": "type" }, "IpAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe Internet-routable IP address of the customer gateway's outside interface.
\n ", "xmlname": "ipAddress" }, "BgpAsn": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
\n ", "xmlname": "bgpAsn" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the customer gateway.
\n ", "xmlname": "tagSet" } }, "documentation": "\n\t\tDescribes a customer gateway.
\n ", "xmlname": "item" }, "documentation": "\n\t\tInformation about one or more customer gateways.
\n ", "xmlname": "customerGatewaySet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tDescribes one or more of your VPN customer gateways.
\n\t\tFor more information about VPN customer gateways, see\n\t\t\t\tAdding a Hardware\n\t\t\t\tVirtual Private Gateway to Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\n12.1.2.3, and whose state is either pending\n\t\t\t\t\tor available.The IDs of one or more DHCP options sets.
\n\t\tDefault: Describes all your DHCP options sets.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\n\t\tOne or more filters.
\n\t\tdhcp-options-id - The ID of a set of DHCP options.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
The ID of the set of DHCP options.
\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\tThe name of a DHCP option.
\n ", "xmlname": "key" }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "item" }, "documentation": "\n\t\tOne or more values for the DHCP option.
\n ", "xmlname": "valueSet" } }, "documentation": "\n\t\tDescribes a DHCP configuration option.
\n ", "xmlname": "item" }, "documentation": "\n\t\tOne or more DHCP options in the set.
\n ", "xmlname": "dhcpConfigurationSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the DHCP options set.
\n ", "xmlname": "tagSet" } }, "documentation": "\n\t\tDescribes a set of DHCP options.
\n ", "xmlname": "item" }, "documentation": "\n\t\tInformation about one or more DHCP options sets.
\n ", "xmlname": "dhcpOptionsSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tDescribes one or more of your DHCP options sets.
\n\t\tFor more information about DHCP options sets, see DHCP Options Sets\n\t\t\t\tin the Amazon Virtual Private Cloud User Guide.
\ndomain-name option whose value includes the string\n\t\t\t\t\texample.One or more export task IDs.
\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": "\nThe ID of the export task.
\n ", "xmlname": "exportTaskId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description of the resource being exported.
\n ", "xmlname": "description" }, "State": { "shape_name": "ExportTaskState", "type": "string", "enum": [ "active", "cancelling", "cancelled", "completed" ], "documentation": "\nThe state of the conversion task.
\n ", "xmlname": "state" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\nThe status message related to the export task.
\n ", "xmlname": "statusMessage" }, "InstanceExportDetails": { "shape_name": "InstanceExportDetails", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the resource being exported.
\n ", "xmlname": "instanceId" }, "TargetEnvironment": { "shape_name": "ExportEnvironment", "type": "string", "enum": [ "citrix", "vmware", "microsoft" ], "documentation": "\nThe target virtualization environment.
\n ", "xmlname": "targetEnvironment" } }, "documentation": "\nThe instance being exported.
\n ", "xmlname": "instanceExport" }, "ExportToS3Task": { "shape_name": "ExportToS3Task", "type": "structure", "members": { "DiskImageFormat": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": "\nThe format for the exported image.
\n ", "xmlname": "diskImageFormat" }, "ContainerFormat": { "shape_name": "ContainerFormat", "type": "string", "enum": [ "ova" ], "documentation": "\nThe container format used to combine disk images with metadata (such as OVF). If absent, only\n the disk image is exported.
\n ", "xmlname": "containerFormat" }, "S3Bucket": { "shape_name": "String", "type": "string", "documentation": "\nThe 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 vm-import-export@amazon.com.
Describes an export task.
\n ", "xmlname": "item" }, "documentation": "\n ", "xmlname": "exportTaskSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes one or more of your export tasks.
\nThe ID of the AMI.
\n ", "required": true }, "Attribute": { "shape_name": "ImageAttributeName", "type": "string", "enum": [ "description", "kernel", "ramdisk", "launchPermission", "productCodes", "blockDeviceMapping" ], "documentation": "\nThe AMI attribute.
\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "ImageAttribute", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the AMI.
\n ", "xmlname": "imageId" }, "LaunchPermissions": { "shape_name": "LaunchPermissionList", "type": "list", "members": { "shape_name": "LaunchPermission", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID.
\n ", "xmlname": "userId" }, "Group": { "shape_name": "PermissionGroup", "type": "string", "enum": [ "all" ], "documentation": "\nThe name of the group.
\n ", "xmlname": "group" } }, "documentation": "\nDescribes a launch permission.
\n ", "xmlname": "item" }, "documentation": "\nOne or more launch permissions.
\n ", "xmlname": "launchPermission" }, "ProductCodes": { "shape_name": "ProductCodeList", "type": "list", "members": { "shape_name": "ProductCode", "type": "structure", "members": { "ProductCodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe product code.
\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": "\nThe type of product code.
\n ", "xmlname": "type" } }, "documentation": "\nDescribes a product code.
\n ", "xmlname": "item" }, "documentation": "\nOne or more product codes.
\n ", "xmlname": "productCodes" }, "KernelId": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\nThe kernel ID.
\n ", "xmlname": "kernel" }, "RamdiskId": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\nThe RAM disk ID.
\n ", "xmlname": "ramdisk" }, "Description": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\nA description for the AMI.
\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": "\nThe virtual device name.
\n ", "xmlname": "virtualName" }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n ", "xmlname": "snapshotId" }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n ", "xmlname": "volumeSize" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", "xmlname": "deleteOnTermination" }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": "\nThe volume type.
\nDefault: standard
The number of I/O operations per second (IOPS) that the\n volume supports.
\nConstraint: Range is 100 to 4000.
\nCondition: Required when the volume type is io1; not used with standard volumes.
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", "xmlname": "ebs" }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n ", "xmlname": "noDevice" } }, "documentation": "\nDescribes a block device mapping.
\n ", "xmlname": "item" }, "documentation": "\nOne or more block device mapping entries.
\n ", "xmlname": "blockDeviceMapping" } }, "documentation": "\nInformation about the image attribute.
\n ", "xmlname": "imageAttribute" }, "errors": [], "documentation": " \nDescribes an attributes of an AMI. You can specify only one attribute at a time.
\nOne or more image IDs.
\nDefault: Describes all images available to you.
\n ", "flattened": true }, "Owners": { "shape_name": "OwnerStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Owner" }, "documentation": "\nFilters the images by the owner. \n\t\t\t\tSpecify an AWS account ID, amazon (owner is Amazon), \n\t\t\t\taws-marketplace (owner is AWS Marketplace), \n\t\t\t\tself (owner is the sender of the request), or\n\t\t\t\tall (all owners).
Scopes the images by users with explicit launch permissions. \n\t\t\t\tSpecify an AWS account ID, self (the sender of the request),\n\t\t\t\tor all (public AMIs).
The name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\narchitecture - The image architecture (i386 | x86_64).
block-device-mapping.delete-on-termination - A Boolean value that indicates \n whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume (standard | io1).
description - The description of the image (provided during image creation).
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The AWS account alias (for example, amazon).
owner-id - The AWS account ID of the image owner.
platform - The platform. To only list Windows-based AMIs, use windows.
product-code - The product code.
product-code.type - The type of the product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
virtualization-type - The virtualization type (paravirtual | hvm).
The ID of the AMI.
\n ", "xmlname": "imageId" }, "ImageLocation": { "shape_name": "String", "type": "string", "documentation": "\nThe location of the AMI.
\n ", "xmlname": "imageLocation" }, "State": { "shape_name": "ImageState", "type": "string", "enum": [ "available", "deregistered" ], "documentation": "\nThe current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
The AWS account ID of the image owner.
\n ", "xmlname": "imageOwnerId" }, "Public": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the image has public launch permissions. The value is true if\n\t\t\t\tthis image has public launch permissions or false\n\t\t\t\tif it has only implicit and explicit launch permissions.
The product code.
\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": "\nThe type of product code.
\n ", "xmlname": "type" } }, "documentation": "\nDescribes a product code.
\n ", "xmlname": "item" }, "documentation": "\nAny product codes associated with the AMI.
\n ", "xmlname": "productCodes" }, "Architecture": { "shape_name": "ArchitectureValues", "type": "string", "enum": [ "i386", "x86_64" ], "documentation": "\nThe architecture of the image.
\n ", "xmlname": "architecture" }, "ImageType": { "shape_name": "ImageTypeValues", "type": "string", "enum": [ "machine", "kernel", "ramdisk" ], "documentation": "\nThe type of image.
\n ", "xmlname": "imageType" }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\nThe kernel associated with the image, if any. Only applicable for machine images.
\n ", "xmlname": "kernelId" }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\nThe RAM disk associated with the image, if any. Only applicable for machine images.
\n ", "xmlname": "ramdiskId" }, "Platform": { "shape_name": "PlatformValues", "type": "string", "enum": [ "Windows" ], "documentation": "\nThe value is Windows for Windows AMIs; otherwise blank.
Specifies whether enhanced networking is enabled.
\n ", "xmlname": "sriovNetSupport" }, "StateReason": { "shape_name": "StateReason", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\nThe reason code for the state change.
\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nThe message for the state change.
\nServer.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.
Server.InternalError: An internal error occurred during instance launch, resulting in termination.
Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.
Client.InternalError: A client error caused the instance to terminate on launch.
Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.
Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The volume limit was exceeded.
Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
The reason for the state change.
\n ", "xmlname": "stateReason" }, "ImageOwnerAlias": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account alias (for example, amazon, self) or\n the AWS account ID of the AMI owner.
The name of the AMI that was provided during image creation.
\n ", "xmlname": "name" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description of the AMI that was provided during image creation.
\n ", "xmlname": "description" }, "RootDeviceType": { "shape_name": "DeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\nThe 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.
\n ", "xmlname": "rootDeviceType" }, "RootDeviceName": { "shape_name": "String", "type": "string", "documentation": "\nThe device name of the root device (for example,
The virtual device name.
\n ", "xmlname": "virtualName" }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n ", "xmlname": "snapshotId" }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n ", "xmlname": "volumeSize" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", "xmlname": "deleteOnTermination" }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": "\nThe volume type.
\nDefault: standard
The number of I/O operations per second (IOPS) that the\n volume supports.
\nConstraint: Range is 100 to 4000.
\nCondition: Required when the volume type is io1; not used with standard volumes.
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", "xmlname": "ebs" }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n ", "xmlname": "noDevice" } }, "documentation": "\nDescribes a block device mapping.
\n ", "xmlname": "item" }, "documentation": "\nAny block device mapping entries.
\n ", "xmlname": "blockDeviceMapping" }, "VirtualizationType": { "shape_name": "VirtualizationType", "type": "string", "enum": [ "hvm", "paravirtual" ], "documentation": "\nThe type of virtualization of the AMI.
\n ", "xmlname": "virtualizationType" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the image.
\n ", "xmlname": "tagSet" }, "Hypervisor": { "shape_name": "HypervisorType", "type": "string", "enum": [ "ovm", "xen" ], "documentation": "\nThe hypervisor type of the image.
\n ", "xmlname": "hypervisor" } }, "documentation": "\nDescribes an image.
\n ", "xmlname": "item" }, "documentation": "\nInformation about one or more images.
\n ", "xmlname": "imagesSet" } }, "documentation": "\n " }, "errors": [], "documentation": " \nDescribes 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.
\nDeregistered images are included in the returned results for an unspecified interval after deregistration.
x86_64 architecture.aws-marketplace.The ID of the instance.
\n ", "required": true }, "Attribute": { "shape_name": "InstanceAttributeName", "type": "string", "enum": [ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized" ], "documentation": "\nThe instance attribute.
\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "InstanceAttribute", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance.
\n ", "xmlname": "instanceId" }, "InstanceType": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\nThe instance type.
\n ", "xmlname": "instanceType" }, "KernelId": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\nThe kernel ID.
\n ", "xmlname": "kernel" }, "RamdiskId": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\nThe RAM disk ID.
\n ", "xmlname": "ramdisk" }, "UserData": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\nThe Base64-encoded MIME user data.
\n ", "xmlname": "userData" }, "DisableApiTermination": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\nIf the value is true, you can't terminate the instance through the Amazon EC2\n\t\t\t\tconsole, CLI, or API; otherwise, you can.
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).
\n ", "xmlname": "instanceInitiatedShutdownBehavior" }, "RootDeviceName": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\nThe name of the root device (for example, /dev/sda1).
The device name exposed to the instance (for example,
The ID of the Amazon EBS volume.
\n ", "xmlname": "volumeId" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\nThe attachment state.
\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when the attachment initiated.
\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the volume is deleted on instance termination.
\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", "xmlname": "ebs" } }, "documentation": "\nDescribes a block device mapping.
\n ", "xmlname": "item" }, "documentation": "\nThe block device mapping of the instance.
\n ", "xmlname": "blockDeviceMapping" }, "ProductCodes": { "shape_name": "ProductCodeList", "type": "list", "members": { "shape_name": "ProductCode", "type": "structure", "members": { "ProductCodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe product code.
\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": "\nThe type of product code.
\n ", "xmlname": "type" } }, "documentation": "\nDescribes a product code.
\n ", "xmlname": "item" }, "documentation": "\nA list of product codes.
\n ", "xmlname": "productCodes" }, "EbsOptimized": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\nIndicates whether the instance is optimized for EBS I/O.
\n ", "xmlname": "ebsOptimized" }, "SriovNetSupport": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n ", "xmlname": "value" } }, "documentation": " \n ", "xmlname": "sriovNetSupport" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes an attribute of the specified instance. You can specify only one\n\t\t\t\tattribute at a time.
\nInstanceInitiatedShutdownBehavior attribute for the specified instance.DisableApiTermination attribute for the specified instance.One or more instance IDs.
\nDefault: Describes all your instances.
\nConstraints: Maximum 100 explicitly specified instance IDs.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\navailability-zone - The Availability Zone of the instance.
event.code - The code identifying the type of event (instance-reboot | system-reboot |\n system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.not-after - The latest end time for the scheduled event.
event.not-before - The earliest start time for the scheduled event.
instance-state-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).
instance-state-name - The state of the instance (pending | running | shutting-down |\n terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed |\n failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing |\n insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed |\n failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing |\n insufficient-data | not-applicable).
The next paginated set of results to return.
\n " }, "MaxResults": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe maximum number of paginated instance items per response.
\nDefault: 1000
\n " }, "IncludeAllInstances": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nWhen true, includes the health status for all instances.\n\t\t\t\tWhen false, includes the health status for running instances only.
Default: false
The ID of the instance.
\n ", "xmlname": "instanceId" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone of the instance.
\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": "\nThe associated code of the event.
\n ", "xmlname": "code" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description of the event.
\n ", "xmlname": "description" }, "NotBefore": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe earliest scheduled start time for the event.
\n ", "xmlname": "notBefore" }, "NotAfter": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe latest scheduled end time for the event.
\n ", "xmlname": "notAfter" } }, "documentation": "\nDescribes an instance event.
\n ", "xmlname": "item" }, "documentation": "\nExtra information regarding events associated with the instance.
\n ", "xmlname": "eventsSet" }, "InstanceState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", "xmlname": "name" } }, "documentation": "\nThe intended state of the instance.\n\t\t\t\tDescribeInstanceStatus requires that an\n\t\t\t\tinstance be in the running state.
The status.
\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": "\nThe type of instance status.
\n ", "xmlname": "name" }, "Status": { "shape_name": "StatusType", "type": "string", "enum": [ "passed", "failed", "insufficient-data" ], "documentation": "\nThe status.
\n ", "xmlname": "status" }, "ImpairedSince": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe 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.
\n ", "xmlname": "impairedSince" } }, "documentation": "\nDescribes the instance status.
\n ", "xmlname": "item" }, "documentation": "\nThe system instance health or application instance health.
\n ", "xmlname": "details" } }, "documentation": "\nReports 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.
\n ", "xmlname": "systemStatus" }, "InstanceStatus": { "shape_name": "InstanceStatusSummary", "type": "structure", "members": { "Status": { "shape_name": "SummaryStatus", "type": "string", "enum": [ "ok", "impaired", "insufficient-data", "not-applicable" ], "documentation": "\nThe status.
\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": "\nThe type of instance status.
\n ", "xmlname": "name" }, "Status": { "shape_name": "StatusType", "type": "string", "enum": [ "passed", "failed", "insufficient-data" ], "documentation": "\nThe status.
\n ", "xmlname": "status" }, "ImpairedSince": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe 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.
\n ", "xmlname": "impairedSince" } }, "documentation": "\nDescribes the instance status.
\n ", "xmlname": "item" }, "documentation": "\nThe system instance health or application instance health.
\n ", "xmlname": "details" } }, "documentation": "\nReports impaired functionality that stems from issues internal to the instance,\n\t\t\t\tsuch as impaired reachability.
\n ", "xmlname": "instanceStatus" } }, "documentation": "\nDescribes the status of an instance.
\n ", "xmlname": "item" }, "documentation": "\nOne or more instance status descriptions.
\n ", "xmlname": "instanceStatusSet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nThe next paginated set of results to return.
\n ", "xmlname": "nextToken" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes the status of one or more instances, including any scheduled events.
\n\t\t\tInstance status has two main components:
\n\t\t\tSystem 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.
\n\t\t\t\tInstance 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.
\n\t\t\t\tInstance status provides information about four types of scheduled events for an\n instance that may require your attention:
\n\t\t\tScheduled 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\tsystem-reboot or instance-reboot. 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.
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 system-maintenance. 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.
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\tinstance-retirement. 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.
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 instance-stop.\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.
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 instance-retirement. This ensures that your\n\t\t\t\tinstance is started on a different underlying host.
16\n instance-retirement\n 16\n instance-reboot\n 16\n 16\n One or more instance IDs.
\nDefault: Describes all your instances.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\narchitecture - The instance architecture (i386 | x86_64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an Amazon EBS volume mapped to the instance.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached |\n detaching | detached).
block-device-mapping.volume-id - The volume ID of the Amazon EBS volume.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use group-name instead.
group-name - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use group-id instead.
hypervisor - The hypervisor type of the instance (ovm | xen).
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance (spot).
instance-state-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).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, m1.small).
instance.group-id - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use instance.group-name instead.
instance.group-name - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use instance.group-id instead.
ip-address - The public IP address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched.
monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).
owner-id - The AWS account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.
private-dns-name - The private DNS name of the instance.
private-ip-address - The private IP address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - 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.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
reservation-id - 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.
root-device-name - The name of the root device for the instance (for example, /dev/sda1).
root-device-type - The type of root device that the instance uses (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - 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 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
network-interface.description - The description of the network interface.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
network-interface.network-interface.id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.mac-address - The MAC address of the network interface.
network-interface-private-dns-name - The private DNS name of the network interface.
network-interface.source-destination-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.addresses.private-ip-address - The private IP address associated with the network interface.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.
association.public-ip - The address of the Elastic IP address bound to the network interface.
association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.
association.association-id - The association ID returned when the network interface was associated with an IP address.
The token for the next set of items to return. (You received this token from a prior call.)
\n " }, "MaxResults": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe 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.
\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": "\nThe ID of the reservation.
\n ", "xmlname": "reservationId" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the AWS account that owns the reservation.
\n ", "xmlname": "ownerId" }, "RequesterId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the requester that launched the instances on your behalf (for example,\n\t\t\t\tAWS Management Console or Auto Scaling).
\n ", "xmlname": "requesterId" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group.
\n ", "xmlname": "item" }, "documentation": "\nOne or more security groups.
\n ", "xmlname": "groupSet" }, "Instances": { "shape_name": "InstanceList", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance.
\n ", "xmlname": "instanceId" }, "ImageId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the AMI used to launch the instance.
\n ", "xmlname": "imageId" }, "State": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", "xmlname": "name" } }, "documentation": "\nThe current state of the instance.
\n ", "xmlname": "instanceState" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\nThe 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 running state.
The public DNS name assigned to the instance.\n\t\t\t\tThis name is not available until the instance enters the running state.
The reason for the most recent state transition. This might be an empty string.
\n ", "xmlname": "reason" }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the key pair, if this instance was launched with an associated key pair.
\n ", "xmlname": "keyName" }, "AmiLaunchIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe AMI launch index, which can be used to find this instance in the launch group.
\n ", "xmlname": "amiLaunchIndex" }, "ProductCodes": { "shape_name": "ProductCodeList", "type": "list", "members": { "shape_name": "ProductCode", "type": "structure", "members": { "ProductCodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe product code.
\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": "\nThe type of product code.
\n ", "xmlname": "type" } }, "documentation": "\nDescribes a product code.
\n ", "xmlname": "item" }, "documentation": "\nThe product codes attached to this instance.
\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", "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" ], "documentation": "\nThe instance type.
\n ", "xmlname": "instanceType" }, "LaunchTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time the instance was launched.
\n ", "xmlname": "launchTime" }, "Placement": { "shape_name": "Placement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone of the instance.
\n ", "xmlname": "availabilityZone" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the placement group the instance is in (for cluster compute instances).
\n ", "xmlname": "groupName" }, "Tenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\nThe tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of dedicated runs\n on single-tenant hardware.
The location where the instance launched.
\n ", "xmlname": "placement" }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\nThe kernel associated with this instance.
\n ", "xmlname": "kernelId" }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\nThe RAM disk associated with this instance.
\n ", "xmlname": "ramdiskId" }, "Platform": { "shape_name": "PlatformValues", "type": "string", "enum": [ "Windows" ], "documentation": "\nThe value is Windows for Windows instances; otherwise blank.
Indicates whether monitoring is enabled for the instance.
\n ", "xmlname": "state" } }, "documentation": "\nThe monitoring information for the instance.
\n ", "xmlname": "monitoring" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the subnet in which the instance is running.
\n ", "xmlname": "subnetId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the VPC in which the instance is running.
\n ", "xmlname": "vpcId" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\nThe private IP address assigned to the instance.
\n ", "xmlname": "privateIpAddress" }, "PublicIpAddress": { "shape_name": "String", "type": "string", "documentation": "\nThe public IP address assigned to the instance.
\n ", "xmlname": "ipAddress" }, "StateReason": { "shape_name": "StateReason", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\nThe reason code for the state change.
\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nThe message for the state change.
\nServer.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.
Server.InternalError: An internal error occurred during instance launch, resulting in termination.
Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.
Client.InternalError: A client error caused the instance to terminate on launch.
Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.
Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The volume limit was exceeded.
Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
The reason for the most recent state transition.
\n ", "xmlname": "stateReason" }, "Architecture": { "shape_name": "ArchitectureValues", "type": "string", "enum": [ "i386", "x86_64" ], "documentation": "\nThe architecture of the image.
\n ", "xmlname": "architecture" }, "RootDeviceType": { "shape_name": "DeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\nThe root device type used by the AMI. The AMI can use an Amazon EBS volume\n or an instance store volume.
\n ", "xmlname": "rootDeviceType" }, "RootDeviceName": { "shape_name": "String", "type": "string", "documentation": "\nThe root device name (for example, /dev/sda1).
The device name exposed to the instance (for example,
The ID of the Amazon EBS volume.
\n ", "xmlname": "volumeId" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\nThe attachment state.
\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when the attachment initiated.
\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the volume is deleted on instance termination.
\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", "xmlname": "ebs" } }, "documentation": "\nDescribes a block device mapping.
\n ", "xmlname": "item" }, "documentation": "\nAny block device mapping entries for the instance.
\n ", "xmlname": "blockDeviceMapping" }, "VirtualizationType": { "shape_name": "VirtualizationType", "type": "string", "enum": [ "hvm", "paravirtual" ], "documentation": "\nThe virtualization type of the instance.
\n ", "xmlname": "virtualizationType" }, "InstanceLifecycle": { "shape_name": "InstanceLifecycleType", "type": "string", "enum": [ "spot" ], "documentation": "\nIndicates whether this is a Spot Instance.
\n ", "xmlname": "instanceLifecycle" }, "SpotInstanceRequestId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the Spot Instance request.
\n ", "xmlname": "spotInstanceRequestId" }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": "\nThe idempotency token you provided when you launched the instance.
\n ", "xmlname": "clientToken" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the instance.
\n ", "xmlname": "tagSet" }, "SecurityGroups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group.
\n ", "xmlname": "item" }, "documentation": "\nOne or more security groups for the instance.
\n ", "xmlname": "groupSet" }, "SourceDestCheck": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies 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 true means\n\t\t\t\tchecking is enabled, and false means checking is\n\t\t\t\tdisabled. The value must be false for the instance\n\t\t\t\tto perform NAT. For more information, see NAT\n\t\t\t\tInstances in the Amazon Virtual Private Cloud User Guide.
The hypervisor type of the instance.
\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\tThe ID of the network interface.
\n ", "xmlname": "networkInterfaceId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the subnet.
\n ", "xmlname": "subnetId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC.
\n ", "xmlname": "vpcId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe description.
\n ", "xmlname": "description" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the AWS account that created the network interface.
\n ", "xmlname": "ownerId" }, "Status": { "shape_name": "NetworkInterfaceStatus", "type": "string", "enum": [ "available", "attaching", "in-use", "detaching" ], "documentation": "\n\t\tThe status of the network interface.
\n ", "xmlname": "status" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe IP address of the network interface within the subnet.
\n ", "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe private DNS name.
\n ", "xmlname": "privateDnsName" }, "SourceDestCheck": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether to validate network traffic to or from this network interface.
\n ", "xmlname": "sourceDestCheck" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group.
\n ", "xmlname": "item" }, "documentation": "\n\t\tOne or more security groups.
\n ", "xmlname": "groupSet" }, "Attachment": { "shape_name": "InstanceNetworkInterfaceAttachment", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the network interface attachment.
\n ", "xmlname": "attachmentId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe index of the device on the instance for the network interface attachment.
\n ", "xmlname": "deviceIndex" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n\t\tThe attachment state.
\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n\t\tThe time stamp when the attachment initiated.
\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the network interface is deleted when the instance is terminated.
\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n\t\tThe network interface attachment.
\n ", "xmlname": "attachment" }, "Association": { "shape_name": "InstanceNetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", "xmlname": "publicIp" }, "PublicDnsName": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe public DNS name.
\n ", "xmlname": "publicDnsName" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the owner of the Elastic IP address.
\n ", "xmlname": "ipOwnerId" } }, "documentation": "\n\t\tThe association information for an Elastic IP associated with the network interface.
\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\tThe private IP address of the network interface.
\n ", "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe private DNS name.
\n ", "xmlname": "privateDnsName" }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether this IP address is the primary private IP address \n\t\t of the network interface.
\n ", "xmlname": "primary" }, "Association": { "shape_name": "InstanceNetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", "xmlname": "publicIp" }, "PublicDnsName": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe public DNS name.
\n ", "xmlname": "publicDnsName" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the owner of the Elastic IP address.
\n ", "xmlname": "ipOwnerId" } }, "documentation": "\n\t\tThe association information for an Elastic IP address for the network interface.
\n ", "xmlname": "association" } }, "documentation": "\n\t\tDescribes a private IP address.
\n ", "xmlname": "item" }, "documentation": "\n\t\tThe private IP addresses associated with the network interface.
\n ", "xmlname": "privateIpAddressesSet" } }, "documentation": "\n\t\tDescribes a network interface.
\n ", "xmlname": "item" }, "documentation": "\n[EC2-VPC] One or more network interfaces for the instance.
\n ", "xmlname": "networkInterfaceSet" }, "IamInstanceProfile": { "shape_name": "IamInstanceProfile", "type": "structure", "members": { "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the instance profile.
\n ", "xmlname": "arn" }, "Id": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance profile.
\n ", "xmlname": "id" } }, "documentation": "\nThe IAM instance profile associated with the instance.
\n ", "xmlname": "iamInstanceProfile" }, "EbsOptimized": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates 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.
\n ", "xmlname": "ebsOptimized" }, "SriovNetSupport": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies whether enhanced networking is enabled.
\n ", "xmlname": "sriovNetSupport" } }, "documentation": "\nDescribes an instance.
\n ", "xmlname": "item" }, "documentation": "\nOne or more instances.
\n ", "xmlname": "instancesSet" } }, "documentation": "\nDescribes a reservation.
\n ", "xmlname": "item" }, "documentation": "\nOne or more reservations.
\n ", "xmlname": "reservationSet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nThe token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
\n ", "xmlname": "nextToken" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes one or more of your instances.
\nIf 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.
\nRecently terminated instances might appear in the returned results. This interval\n is usually less than one hour.
\nm1.small or m1.large instance type and an attached Amazon EBS volume that will be deleted on termination.Owner,\n regardless of the value of the tag.Owner and the value DbAdmin.One or more Internet gateway IDs.
\n\t\tDefault: Describes all your Internet gateways.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\n\t\tOne or more filters.
\n\t\tattachment.state - The current state of the attachment between the gateway and the VPC. Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
The ID of the Internet gateway.
\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\tThe ID of the VPC.
\n ", "xmlname": "vpcId" }, "State": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n\t\tThe current state of the attachment.
\n ", "xmlname": "state" } }, "documentation": "\n\t\tDescribes the attachment of a VPC to an Internet gateway.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny VPCs attached to the Internet gateway.
\n ", "xmlname": "attachmentSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the Internet gateway.
\n ", "xmlname": "tagSet" } }, "documentation": "\n\t\tDescribes an Internet gateway.
\n ", "xmlname": "item" }, "documentation": "\n\t\tInformation about one or more Internet gateways.
\n ", "xmlname": "internetGatewaySet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tDescribes one or more of your Internet gateways.
\nOne or more key pair names.
\nDefault: Describes all your key pairs.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\nfingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
The name of the key pair.
\n ", "xmlname": "keyName" }, "KeyFingerprint": { "shape_name": "String", "type": "string", "documentation": "\nIf you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. \n If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.
\n ", "xmlname": "keyFingerprint" } }, "documentation": "\nDescribes a key pair.
\n ", "xmlname": "item" }, "documentation": "\nInformation about one or more key pairs.
\n ", "xmlname": "keySet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes one or more of your key pairs.
\nFor more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nDave.One or more network ACL IDs.
\n\t\tDefault: Describes all your network ACLs.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\n\t\tOne or more filters.
\n\t\tassociation.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The CIDR range specified in the entry.
entry.egress - Indicates whether the entry applies to egress traffic.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.
network-acl-id - The ID of the network ACL.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the network ACL.
The ID of the network ACL.
\n ", "xmlname": "networkAclId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC for the network ACL.
\n ", "xmlname": "vpcId" }, "IsDefault": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether this is the default network ACL for the VPC.
\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\tThe rule number for the entry. ACL entries are processed in ascending order by rule number.
\n ", "xmlname": "ruleNumber" }, "Protocol": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe protocol. A value of -1 means all protocols.
Indicates whether to allow or deny the traffic that matches the rule.
\n ", "xmlname": "ruleAction" }, "Egress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the rule is an egress rule (applied to traffic leaving the subnet).
\n ", "xmlname": "egress" }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe network range to allow or deny, in CIDR notation.
\n ", "xmlname": "cidrBlock" }, "IcmpTypeCode": { "shape_name": "IcmpTypeCode", "type": "structure", "members": { "Type": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe ICMP code. A value of -1 means all codes for the specified ICMP type.
\n ", "xmlname": "type" }, "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe ICMP type. A value of -1 means all types.
\n ", "xmlname": "code" } }, "documentation": "\n\t\tICMP protocol: The ICMP type and code.
\n ", "xmlname": "icmpTypeCode" }, "PortRange": { "shape_name": "PortRange", "type": "structure", "members": { "From": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe first port in the range.
\n ", "xmlname": "from" }, "To": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe last port in the range.
\n ", "xmlname": "to" } }, "documentation": "\n\t\tTCP or UDP protocols: The range of ports the rule applies to.
\n ", "xmlname": "portRange" } }, "documentation": "\n\t\tDescribes an entry in a network ACL.
\n ", "xmlname": "item" }, "documentation": "\n\t\tOne or more entries (rules) in the network ACL.
\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\tThe ID of the association between a network ACL and a subnet.
\n ", "xmlname": "networkAclAssociationId" }, "NetworkAclId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the network ACL.
\n ", "xmlname": "networkAclId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the subnet.
\n ", "xmlname": "subnetId" } }, "documentation": "\n\t\tDescribes an association between a network ACL and a subnet.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny associations between the network ACL and one or more subnets
\n ", "xmlname": "associationSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the network ACL.
\n ", "xmlname": "tagSet" } }, "documentation": "\n\t\tDescribes a network ACL.
\n ", "xmlname": "item" }, "documentation": "\n\t\tInformation about one or more network ACLs.
\n ", "xmlname": "networkAclSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tDescribes one or more of your network ACLs.
\n\t\tFor more information about network ACLs, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nThe ID of the network interface.
\n ", "required": true }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe description attribute.
The sourceDestCheck attribute.
The groupSet attribute.
The attachment attribute.
The ID of the network interface.
\n ", "xmlname": "networkInterfaceId" }, "Description": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\n\t\tThe description of the network interface.
\n ", "xmlname": "description" }, "SourceDestCheck": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\n\t\tIndicates whether source/destination checking is enabled.
\n ", "xmlname": "sourceDestCheck" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group.
\n ", "xmlname": "item" }, "documentation": "\n\t\tThe security groups associated with the network interface.
\n ", "xmlname": "groupSet" }, "Attachment": { "shape_name": "NetworkInterfaceAttachment", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the network interface attachment.
\n ", "xmlname": "attachmentId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the instance.
\n ", "xmlname": "instanceId" }, "InstanceOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe AWS account ID of the owner of the instance.
\n ", "xmlname": "instanceOwnerId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe device index of the network interface attachment on the instance.
\n ", "xmlname": "deviceIndex" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n\t\tThe attachment state.
\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n\t\tThe timestamp indicating when the attachment initiated.
\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the network interface is deleted when the instance is terminated.
\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n\t\tThe attachment (if any) of the network interface.
\n ", "xmlname": "attachment" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tDescribes a network interface attribute. You can specify only one attribute at a\n\t\t\t\ttime.
\nsourceDestCheck attribute of the specified network interface.One or more network interface IDs.
\n\t\tDefault: Describes all your network interfaces.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\n\t\tOne or more filters.
\n\t\taddresses.private-ip-address - The private IP addresses associated with the network interface.
addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IP address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.
association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.
association.public-ip - The address of the Elastic IP address bound to the network interface.
attachment.attachment-id - The ID of the interface attachment.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.device-index - The device index to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
attachment.attach.time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The AWS account ID of the network interface owner.
private-ip-address - The private IP address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).
source-desk-check - Indicates whether the network interface performs source/destination checking. \n\t\t A value of true means checking is enabled, and false means checking is disabled. \n\t\t The value must be false for the network interface to perform Network Address Translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; \n\t\t if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the network interface.
The ID of the network interface.
\n ", "xmlname": "networkInterfaceId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the subnet.
\n ", "xmlname": "subnetId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC.
\n ", "xmlname": "vpcId" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe Availability Zone.
\n ", "xmlname": "availabilityZone" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n\t\tA description.
\n ", "xmlname": "description" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe AWS account ID of the owner of the network interface.
\n ", "xmlname": "ownerId" }, "RequesterId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the entity that launched the instance on your behalf (for example, AWS\n\t\t\t\tManagement Console or Auto Scaling).
\n ", "xmlname": "requesterId" }, "RequesterManaged": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the network interface is being managed by AWS.
\n ", "xmlname": "requesterManaged" }, "Status": { "shape_name": "NetworkInterfaceStatus", "type": "string", "enum": [ "available", "attaching", "in-use", "detaching" ], "documentation": "\n\t\tThe status of the network interface.
\n ", "xmlname": "status" }, "MacAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe MAC address.
\n ", "xmlname": "macAddress" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe IP address of the network interface within the subnet.
\n ", "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe private DNS name.
\n ", "xmlname": "privateDnsName" }, "SourceDestCheck": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether traffic to or from the instance is validated.
\n ", "xmlname": "sourceDestCheck" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny security groups for the network interface.
\n ", "xmlname": "groupSet" }, "Attachment": { "shape_name": "NetworkInterfaceAttachment", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the network interface attachment.
\n ", "xmlname": "attachmentId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the instance.
\n ", "xmlname": "instanceId" }, "InstanceOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe AWS account ID of the owner of the instance.
\n ", "xmlname": "instanceOwnerId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe device index of the network interface attachment on the instance.
\n ", "xmlname": "deviceIndex" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n\t\tThe attachment state.
\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n\t\tThe timestamp indicating when the attachment initiated.
\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the network interface is deleted when the instance is terminated.
\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n\t\tThe network interface attachment.
\n ", "xmlname": "attachment" }, "Association": { "shape_name": "NetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", "xmlname": "publicIp" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the Elastic IP address owner.
\n ", "xmlname": "ipOwnerId" }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe allocation ID.
\n ", "xmlname": "allocationId" }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe association ID.
\n ", "xmlname": "associationId" } }, "documentation": "\n\t\tThe association information for an Elastic IP associated with the network interface.
\n ", "xmlname": "association" }, "TagSet": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the network interface.
\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\tThe private IP address.
\n ", "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe private DNS name.
\n ", "xmlname": "privateDnsName" }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether this IP address is the primary private IP address of the network interface.
\n ", "xmlname": "primary" }, "Association": { "shape_name": "NetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", "xmlname": "publicIp" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the Elastic IP address owner.
\n ", "xmlname": "ipOwnerId" }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe allocation ID.
\n ", "xmlname": "allocationId" }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe association ID.
\n ", "xmlname": "associationId" } }, "documentation": "\n\t\tThe association information for an Elastic IP address associated with the network interface.
\n ", "xmlname": "association" } }, "documentation": "\n\t\tDescribes the private IP address of a network interface.
\n ", "xmlname": "item" }, "documentation": "\n\t\tThe private IP addresses associated with the network interface.
\n ", "xmlname": "privateIpAddressesSet" } }, "documentation": "\n\t\tDescribes a network interface.
\n ", "xmlname": "item" }, "documentation": "\n\t\tInformation about one or more network interfaces.
\n ", "xmlname": "networkInterfaceSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tDescribes one or more of your network interfaces.
\nOne or more placement group names.
\nDefault: Describes all your placement groups, or only those otherwise specified.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\ngroup-name - The name of the placement group.
state - The state of the placement group (pending | available |\n deleting | deleted).
strategy - The strategy of the placement group (cluster).
The name of the placement group.
\n ", "xmlname": "groupName" }, "Strategy": { "shape_name": "PlacementStrategy", "type": "string", "enum": [ "cluster" ], "documentation": "\nThe placement strategy.
\n ", "xmlname": "strategy" }, "State": { "shape_name": "PlacementGroupState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": "\nThe state of the placement group.
\n ", "xmlname": "state" } }, "documentation": "\nDescribes a placement group.
\n ", "xmlname": "item" }, "documentation": "\nOne or more placement groups.
\n ", "xmlname": "placementGroupSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes 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\tCluster Instances\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nProject in the name.The names of one or more regions.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\nendpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).
region-name - The name of the region (for example, us-east-1).
The name of the region.
\n ", "xmlname": "regionName" }, "Endpoint": { "shape_name": "String", "type": "string", "documentation": "\nThe region service endpoint.
\n ", "xmlname": "regionEndpoint" } }, "documentation": "\nDescribes a region.
\n ", "xmlname": "item" }, "documentation": "\nInformation about one or more regions.
\n ", "xmlname": "regionInfo" } }, "documentation": "\n " }, "errors": [], "documentation": " \nDescribes one or more regions that are currently available to you.
\nFor a list of the regions supported by Amazon EC2, see Regions and Endpoints.
\nOne or more Reserved Instance IDs.
\nDefault: Describes all your Reserved Instances, or only those otherwise specified.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\navailability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires.
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type on which the Reserved Instance can be used.
product-description - The product description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) |\n Windows | Windows (Amazon VPC)).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed.
state - The state of the Reserved Instance (pending-payment | active | payment-failed | retired).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - 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 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
The Reserved Instance offering type.
\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": "\nThe ID of the Reserved Instance.
\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", "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" ], "documentation": "\nThe instance type on which the Reserved Instance can be used.
\n ", "xmlname": "instanceType" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone in which the Reserved Instance can be used.
\n ", "xmlname": "availabilityZone" }, "Start": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe date and time the Reserved Instance started.
\n ", "xmlname": "start" }, "End": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time when the Reserved Instance expires.
\n ", "xmlname": "end" }, "Duration": { "shape_name": "Long", "type": "long", "documentation": "\nThe duration of the Reserved Instance, in seconds.
\n ", "xmlname": "duration" }, "UsagePrice": { "shape_name": "Float", "type": "float", "documentation": "\nThe usage price of the Reserved Instance, per hour.
\n ", "xmlname": "usagePrice" }, "FixedPrice": { "shape_name": "Float", "type": "float", "documentation": "\nThe purchase price of the Reserved Instance.
\n ", "xmlname": "fixedPrice" }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of Reserved Instances purchased.
\n ", "xmlname": "instanceCount" }, "ProductDescription": { "shape_name": "RIProductDescription", "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": "\nThe Reserved Instance description.
\n ", "xmlname": "productDescription" }, "State": { "shape_name": "ReservedInstanceState", "type": "string", "enum": [ "payment-pending", "active", "payment-failed", "retired" ], "documentation": "\nThe state of the Reserved Instance purchase.
\n ", "xmlname": "state" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the resource.
\n ", "xmlname": "tagSet" }, "InstanceTenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\nThe tenancy of the reserved instance.
\n ", "xmlname": "instanceTenancy" }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": "\nThe 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 USD.
The Reserved Instance offering type.
\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": "\nThe frequency of the recurring charge.
\n ", "xmlname": "frequency" }, "Amount": { "shape_name": "Double", "type": "double", "documentation": "\nThe amount of the recurring charge.
\n ", "xmlname": "amount" } }, "documentation": "\nDescribes a recurring charge.
\n ", "xmlname": "item" }, "documentation": "\nThe recurring charge tag assigned to the resource.
\n ", "xmlname": "recurringCharges" } }, "documentation": "\nDescribes a Reserved Instance.
\n ", "xmlname": "item" }, "documentation": "\nA list of Reserved Instances.
\n ", "xmlname": "reservedInstancesSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes one or more of the Reserved Instances that you purchased.
\nFor more information about Reserved Instances, see Reserved\n\t\t\t\tInstances in the Amazon Elastic Compute Cloud User Guide.
\nm1.small Linux/UNIX Reserved Instances. \n If you want Linux/UNIX Reserved Instances specifically for use with a VPC, set the product description to \n Linux/UNIX (Amazon VPC).One or more Reserved Instance IDs.
\n " }, "ReservedInstancesListingId": { "shape_name": "String", "type": "string", "documentation": "\nOne or more Reserved Instance Listing IDs.
\n " }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n " }, "documentation": "\nOne or more filters.
\nreserved-instances-id - The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active |\n cancelled | closed).
status-message - The reason for the status.
The ID of the Reserved Instance listing.
\n ", "xmlname": "reservedInstancesListingId" }, "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the Reserved Instance.
\n ", "xmlname": "reservedInstancesId" }, "CreateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time the listing was created.
\n ", "xmlname": "createDate" }, "UpdateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe last modified timestamp of the listing.
\n ", "xmlname": "updateDate" }, "Status": { "shape_name": "ListingStatus", "type": "string", "enum": [ "active", "pending", "cancelled", "closed" ], "documentation": "\nThe status of the Reserved Instance listing.
\n ", "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\nThe reason for the current status of the Reserved Instance listing. \n\t\t\t\tThe response can be blank.
\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": "\nThe states of the listed Reserved Instances.
\n ", "xmlname": "state" }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nhe number of listed Reserved Instances in the state specified by the state.
Describes a Reserved Instance listing state.
\n ", "xmlname": "item" }, "documentation": "\nThe number of instances in this state.
\n ", "xmlname": "instanceCounts" }, "PriceSchedules": { "shape_name": "PriceScheduleList", "type": "list", "members": { "shape_name": "PriceSchedule", "type": "structure", "members": { "Term": { "shape_name": "Long", "type": "long", "documentation": "\nThe 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.
\n ", "xmlname": "term" }, "Price": { "shape_name": "Double", "type": "double", "documentation": "\nThe fixed price for the term.
\n ", "xmlname": "price" }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": "\nThe currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.
The current price schedule, as determined by the term remaining for the \n\t\t\t\tReserved Instance in the listing.
\nA 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.
\n ", "xmlname": "active" } }, "documentation": "\nDescribes the price for a Reserved Instance.
\n ", "xmlname": "item" }, "documentation": "\nThe price of the Reserved Instance listing.
\n ", "xmlname": "priceSchedules" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the resource.
\n ", "xmlname": "tagSet" }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": "\nThe idempotency token you provided when you created the listing.
\n ", "xmlname": "clientToken" } }, "documentation": "\nDescribes a Reserved Instance listing.
\n ", "xmlname": "item" }, "documentation": "\nInformation about the Reserved Instance listing.
\n ", "xmlname": "reservedInstancesListingsSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes your account's Reserved Instance listings in the Reserved Instance Marketplace.
\nFor more information, see Reserved Instance Marketplace \n in the Amazon Elastic Compute Cloud User Guide.
\nIDs for the submitted modification request.
\n ", "flattened": true }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nThe token for the next page of data.
\n " }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\nclient-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - 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 fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request\n (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
A unique ID for the Reserved Instance modification.
\n ", "xmlname": "reservedInstancesModificationId" }, "ReservedInstancesIds": { "shape_name": "ReservedIntancesIds", "type": "list", "members": { "shape_name": "ReservedInstancesId", "type": "structure", "members": { "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the Reserved Instance.
\n ", "xmlname": "reservedInstancesId" } }, "documentation": "\nDescribes the ID of a Reserved Instance.
\n ", "xmlname": "item" }, "documentation": "\nThe IDs of one or more Reserved Instances.
\n ", "xmlname": "reservedInstancesSet" }, "ModificationResults": { "shape_name": "ReservedInstancesModificationResultList", "type": "list", "members": { "shape_name": "ReservedInstancesModificationResult", "type": "structure", "members": { "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
\n ", "xmlname": "reservedInstancesId" }, "TargetConfiguration": { "shape_name": "ReservedInstancesConfiguration", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone for the modified Reserved Instances.
\n ", "xmlname": "availabilityZone" }, "Platform": { "shape_name": "String", "type": "string", "documentation": "\nThe network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
\n ", "xmlname": "platform" }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of modified Reserved Instances.
\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", "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" ], "documentation": "\nThe instance type for the modified Reserved Instances.
\n ", "xmlname": "instanceType" } }, "documentation": "\nThe target Reserved Instances configurations supplied as part of the modification request.
\n ", "xmlname": "targetConfiguration" } }, "documentation": "\n ", "xmlname": "item" }, "documentation": "\nContains target configurations along with their corresponding new Reserved Instance IDs.
\n ", "xmlname": "modificationResultSet" }, "CreateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time when the modification request was created.
\n ", "xmlname": "createDate" }, "UpdateDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time when the modification request was last updated.
\n ", "xmlname": "updateDate" }, "EffectiveDate": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time for the modification to become effective.
\n ", "xmlname": "effectiveDate" }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the Reserved Instances modification request.
\n ", "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\nThe reason for the status.
\n ", "xmlname": "statusMessage" }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": "\nA unique, case-sensitive key supplied by the client to ensure that the modification request is idempotent.
\n ", "xmlname": "clientToken" } }, "documentation": "\nDescribes a Reserved Instance modification.
\n ", "xmlname": "item" }, "documentation": "\nThe Reserved Instance modification information.
\n ", "xmlname": "reservedInstancesModificationsSet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nThe token for the next page of data.
\n ", "xmlname": "nextToken" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes 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.
\nOne or more Reserved Instances offering IDs.
\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", "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" ], "documentation": "\nThe instance type on which the Reserved Instance can be used.\n\t\t\t\tFor more information, see Instance Types \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\n " }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone in which the Reserved Instance can be used.
\n " }, "ProductDescription": { "shape_name": "RIProductDescription", "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": "\nThe Reserved Instance description. Instances that include (Amazon VPC) \n in the description are for use with Amazon VPC.
The name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\navailability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds.
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type on which the Reserved Instance can be used.
marketplace - Set to true 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.
product-description - The description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) |\n Windows | Windows (Amazon VPC)).
reserved-instances-offering-id - The Reserved Instances offering ID.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
The tenancy of the Reserved Instance offering. A Reserved Instance\n\t\t\t\twith dedicated tenancy runs on single-tenant hardware and can\n\t\t\t\tonly be launched within a VPC.
Default: default
The Reserved Instance offering type.
\n " }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nThe token to use when requesting the next paginated set of offerings.
\n " }, "MaxResults": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe maximum number of offerings to return.
\n " }, "IncludeMarketplace": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nInclude Marketplace offerings in the response.
\n " }, "MinDuration": { "shape_name": "Long", "type": "long", "documentation": "\nThe minimum duration (in seconds) to filter when searching for offerings.
\n " }, "MaxDuration": { "shape_name": "Long", "type": "long", "documentation": "\nThe maximum duration (in seconds) to filter when searching for offerings.
\n " }, "MaxInstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe maximum number of instances to filter when searching for offerings.
\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": "\nThe ID of the Reserved Instance offering.
\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", "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" ], "documentation": "\nThe instance type on which the Reserved Instance can be used.
\n ", "xmlname": "instanceType" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone in which the Reserved Instance can be used.
\n ", "xmlname": "availabilityZone" }, "Duration": { "shape_name": "Long", "type": "long", "documentation": "\nThe duration of the Reserved Instance, in seconds.
\n ", "xmlname": "duration" }, "UsagePrice": { "shape_name": "Float", "type": "float", "documentation": "\nThe usage price of the Reserved Instance, per hour.
\n ", "xmlname": "usagePrice" }, "FixedPrice": { "shape_name": "Float", "type": "float", "documentation": "\nThe purchase price of the Reserved Instance.
\n ", "xmlname": "fixedPrice" }, "ProductDescription": { "shape_name": "RIProductDescription", "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": "\nThe Reserved Instance description.
\n ", "xmlname": "productDescription" }, "InstanceTenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\nThe tenancy of the reserved instance.
\n ", "xmlname": "instanceTenancy" }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": "\nThe 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 USD.
The Reserved Instance offering type.
\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": "\nThe frequency of the recurring charge.
\n ", "xmlname": "frequency" }, "Amount": { "shape_name": "Double", "type": "double", "documentation": "\nThe amount of the recurring charge.
\n ", "xmlname": "amount" } }, "documentation": "\nDescribes a recurring charge.
\n ", "xmlname": "item" }, "documentation": "\nThe recurring charge tag assigned to the resource.
\n ", "xmlname": "recurringCharges" }, "Marketplace": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. \n If it's a Reserved Instance Marketplace offering, this is true.
The price per instance.
\n ", "xmlname": "price" }, "Count": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of instances available for the price.
\n ", "xmlname": "count" } }, "documentation": "\nDescribes a Reserved Instance offering.
\n ", "xmlname": "item" }, "documentation": "\nThe pricing details of the Reserved Instance offering.
\n ", "xmlname": "pricingDetailsSet" } }, "documentation": "\nDescribes a Reserved Instance offering.
\n ", "xmlname": "item" }, "documentation": "\nA list of Reserved Instances offerings.
\n ", "xmlname": "reservedInstancesOfferingsSet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nThe next paginated set of results to return.
\n ", "xmlname": "nextToken" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes 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.
\nFor more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nm1.small or m1.large \n Linux/UNIX Reserved Instances. If you want Linux/UNIX Reserved Instances specifically for use with a VPC, \n set the product description to Linux/UNIX (Amazon VPC).One or more route table IDs.
\n\t\tDefault: Describes all your route tables.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\n\t\tOne or more filters.
\n\t\tassociation.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC.
route-table-id - The ID of the route table.
route.destination-cidr-block - The CIDR range specified in a route in the table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.origin - Describes how the route was created (CreateRouteTable | CreateRoute | EnableVgwRoutePropagation).
route.state - The state of a route in the route table (active | blackhole). \n\t\t The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the route table.
The ID of the route table.
\n ", "xmlname": "routeTableId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC.
\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\tThe CIDR block used for the destination match.
\n ", "xmlname": "destinationCidrBlock" }, "GatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of a gateway attached to your VPC.
\n ", "xmlname": "gatewayId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of a NAT instance in your VPC.
\n ", "xmlname": "instanceId" }, "InstanceOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe AWS account ID of the owner of the instance.
\n ", "xmlname": "instanceOwnerId" }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the network interface.
\n ", "xmlname": "networkInterfaceId" }, "State": { "shape_name": "RouteState", "type": "string", "enum": [ "active", "blackhole" ], "documentation": "\n\t\tThe state of the route. The blackhole 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).
Describes a route in a route table.
\n ", "xmlname": "item" }, "documentation": "\n\t\tThe routes in the route table.
\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\tThe ID of the association between a route table and a subnet.
\n ", "xmlname": "routeTableAssociationId" }, "RouteTableId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the route table.
\n ", "xmlname": "routeTableId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the subnet.
\n ", "xmlname": "subnetId" }, "Main": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether this is the main route table.
\n ", "xmlname": "main" } }, "documentation": "\n\t\tDescribes an association between a route table and a subnet.
\n ", "xmlname": "item" }, "documentation": "\n\t\tThe associations between the route table and one or more subnets.
\n ", "xmlname": "associationSet" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the route table.
\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\tThe ID of the virtual private gateway (VGW).
\n ", "xmlname": "gatewayId" } }, "documentation": "\n\t\tDescribes a virtual private gateway propagating route.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny virtual private gateway (VGW) propagating routes.
\n ", "xmlname": "propagatingVgwSet" } }, "documentation": "\n\t\tDescribes a route table.
\n ", "xmlname": "item" }, "documentation": "\n\t\tInformation about one or more route tables.
\n ", "xmlname": "routeTableSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tDescribes one or more of your route tables.
\n\t\tFor more information about route tables, see Route Tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\n[EC2-Classic, default VPC] One or more security group names.
\nDefault: Describes all your security groups.
\n ", "flattened": true }, "GroupIds": { "shape_name": "GroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "GroupId" }, "documentation": "\nOne or more security group IDs.
\nDefault: Describes all your security groups.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\ndescription - The description of the security group.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - A CIDR range that has been granted permission.
ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been granted permission.
ip-permission.group-name - The name of a security group that has been granted permission.
ip-permission.protocol - The IP protocol for the permission (tcp | udp |\n icmp or a protocol number).
ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an AWS account that has been granted permission.
owner-id - The AWS account ID of the owner of the security group.
tag-key - The key of a tag assigned to the security group.
tag-value - The value of a tag assigned to the security group.
vpc-id - The ID of the VPC specified when the security group was created.
The AWS account ID of the owner of the security group.
\n ", "xmlname": "ownerId" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description of the security group.
\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\tThe protocol.
\n\t\tWhen you call DescribeSecurityGroups, 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, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.
The ID of an AWS account.
\n ", "xmlname": "userId" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group owned by the specified AWS account.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group in the specified AWS account.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group and AWS account ID pair for EC2-Classic.
\n ", "xmlname": "item" }, "documentation": "\n\t\tOne or more security group and AWS account ID pairs.
\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\tThe CIDR range. You can either specify a CIDR range or a source security group, not both.
\n ", "xmlname": "cidrIp" } }, "documentation": "\n\t\tDescribes an IP range.
\n ", "xmlname": "item" }, "documentation": "\n\t\tOne or more IP ranges.
\n ", "xmlname": "ipRanges" } }, "documentation": "\n\t\tDescribes a security group rule.
\n ", "xmlname": "item" }, "documentation": "\nOne or more inbound rules associated with the security group.
\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\tThe protocol.
\n\t\tWhen you call DescribeSecurityGroups, 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, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.
The ID of an AWS account.
\n ", "xmlname": "userId" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group owned by the specified AWS account.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group in the specified AWS account.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group and AWS account ID pair for EC2-Classic.
\n ", "xmlname": "item" }, "documentation": "\n\t\tOne or more security group and AWS account ID pairs.
\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\tThe CIDR range. You can either specify a CIDR range or a source security group, not both.
\n ", "xmlname": "cidrIp" } }, "documentation": "\n\t\tDescribes an IP range.
\n ", "xmlname": "item" }, "documentation": "\n\t\tOne or more IP ranges.
\n ", "xmlname": "ipRanges" } }, "documentation": "\n\t\tDescribes a security group rule.
\n ", "xmlname": "item" }, "documentation": "\n[EC2-VPC] One or more outbound rules associated with the security group.
\n ", "xmlname": "ipPermissionsEgress" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n[EC2-VPC] The ID of the VPC for the security group.
\n ", "xmlname": "vpcId" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the security group.
\n ", "xmlname": "tagSet" } }, "documentation": "\nDescribes a security group
\n ", "xmlname": "item" }, "documentation": "\nInformation about one or more security groups.
\n ", "xmlname": "securityGroupInfo" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes one or more of your security groups.
\nA 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\tAmazon EC2 Security Groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity Groups for Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\napp_server_group or database_group.The ID of the Amazon EBS snapshot.
\n ", "required": true }, "Attribute": { "shape_name": "SnapshotAttributeName", "type": "string", "enum": [ "productCodes", "createVolumePermission" ], "documentation": "\nThe snapshot attribute.
\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "DescribeSnapshotAttributeResult", "type": "structure", "members": { "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the Amazon EBS snapshot.
\n ", "xmlname": "snapshotId" }, "CreateVolumePermissions": { "shape_name": "CreateVolumePermissionList", "type": "list", "members": { "shape_name": "CreateVolumePermission", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\nThe specific AWS account ID that is to be added or removed from a volume's list of create\n volume permissions.
\n ", "xmlname": "userId" }, "Group": { "shape_name": "PermissionGroup", "type": "string", "enum": [ "all" ], "documentation": "\nThe specific group that is to be added or removed from a volume's list of create volume\n permissions.
\n ", "xmlname": "group" } }, "documentation": "\n ", "xmlname": "item" }, "documentation": "\nA list of permissions for creating volumes from the snapshot.
\n ", "xmlname": "createVolumePermission" }, "ProductCodes": { "shape_name": "ProductCodeList", "type": "list", "members": { "shape_name": "ProductCode", "type": "structure", "members": { "ProductCodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe product code.
\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": "\nThe type of product code.
\n ", "xmlname": "type" } }, "documentation": "\nDescribes a product code.
\n ", "xmlname": "item" }, "documentation": "\nA list of product codes.
\n ", "xmlname": "productCodes" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes an attribute of the specified snapshot. You can specify only one attribute at a\n time.
\nFor more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
\nsnap-1a2b3c4d.One or more snapshot IDs.
\nDefault: Describes snapshots for which you have launch permissions.
\n ", "flattened": true }, "OwnerIds": { "shape_name": "OwnerStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Owner" }, "documentation": "\nReturns the snapshots owned by the specified owner. Multiple owners can be specified.
\n ", "flattened": true }, "RestorableByUserIds": { "shape_name": "RestorableByStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "RestorableBy" }, "documentation": "\nOne or more AWS accounts IDs that can create volumes from the snapshot.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\ndescription - A description of the snapshot.
owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.
owner-id - The ID of the AWS account that owns the snapshot.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - 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 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
The ID of the snapshot.
\n ", "xmlname": "snapshotId" }, "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the volume.
\n ", "xmlname": "volumeId" }, "State": { "shape_name": "SnapshotState", "type": "string", "enum": [ "pending", "completed", "error" ], "documentation": "\nThe snapshot state.
\n ", "xmlname": "status" }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when the snapshot was initiated.
\n ", "xmlname": "startTime" }, "Progress": { "shape_name": "String", "type": "string", "documentation": "\nThe progress of the snapshot, as a percentage.
\n ", "xmlname": "progress" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID of the Amazon EBS snapshot owner.
\n ", "xmlname": "ownerId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description for the snapshot.
\n ", "xmlname": "description" }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe size of the volume, in GiB.
\n ", "xmlname": "volumeSize" }, "OwnerAlias": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account alias (for example, amazon, self) or AWS account ID\n that owns the snapshot.
The key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the snapshot.
\n ", "xmlname": "tagSet" } }, "documentation": "\nDescribes a snapshot.
\n ", "xmlname": "item" }, "documentation": "\n ", "xmlname": "snapshotSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes 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.
\nThe create volume permissions fall into the following categories:
\nall group. All AWS accounts have create volume permissions for these\n snapshots.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.
\nIf 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.
\nIf 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, amazon for snapshots owned by Amazon, or self for snapshots\n that you own.
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 self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.
For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
\nsnap-1a2b3c4d.pending status, and that are also tagged with a value that includes the string\n db_.The AWS account ID of the account.
\n ", "xmlname": "ownerId" }, "Bucket": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon S3 bucket where the Spot Instance datafeed is located.
\n ", "xmlname": "bucket" }, "Prefix": { "shape_name": "String", "type": "string", "documentation": "\nThe prefix that is prepended to datafeed files.
\n ", "xmlname": "prefix" }, "State": { "shape_name": "DatafeedSubscriptionState", "type": "string", "enum": [ "Active", "Inactive" ], "documentation": "\nThe state of the Spot Instance datafeed subscription.
\n ", "xmlname": "state" }, "Fault": { "shape_name": "SpotInstanceStateFault", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\nThe reason code for the Spot Instance state change.
\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nThe message for the Spot Instance state change.
\n ", "xmlname": "message" } }, "documentation": "\nThe fault codes for the Spot Instance request, if any.
\n ", "xmlname": "fault" } }, "documentation": "\nThe Spot Instance datafeed subscription.
\n ", "xmlname": "spotDatafeedSubscription" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes the datafeed for Spot Instances. For more information, see\n\t\t\t\tSpot Instances in\n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide.
\nOne or more Spot Instance request IDs.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\navailability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (standard | io1).
launch.group-id - The security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m1.small).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
launch.network-interface.network-interface-id - The ID of the network interface.
launch.network-interface.device-index - The index of the device for the network interface attachment on the instance.
launch.network-interface.subnet-id - The ID of the subnet for the instance.
launch.network-interface.description - A description of the network interface.
launch.network-interface.private-ip-address - The primary private IP address of the network interface.
launch.network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
launch.network-interface.group-id - The ID of the security group associated with the network interface.
launch.network-interface.group-name - The name of the security group associated with the network interface.
launch.network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
product-description - The product description associated with the instance (Linux/UNIX | Windows).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request (open | active | closed |\n cancelled | failed).
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - 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 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of Spot Instance request (one-time | persistent).
launched-availability-zone - The Availability Zone in which the bid is launched.
valid-from - The start date of the request.
valid-until - The end date of the request.
The ID of the Spot Instance request.
\n ", "xmlname": "spotInstanceRequestId" }, "SpotPrice": { "shape_name": "String", "type": "string", "documentation": "\nThe maximum hourly price for any Spot Instance launched to fulfill the request.
\n ", "xmlname": "spotPrice" }, "Type": { "shape_name": "SpotInstanceType", "type": "string", "enum": [ "one-time", "persistent" ], "documentation": "\nThe Spot Instance request type.
\n ", "xmlname": "type" }, "State": { "shape_name": "SpotInstanceState", "type": "string", "enum": [ "open", "active", "closed", "cancelled", "failed" ], "documentation": "\nThe 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 Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.
\n ", "xmlname": "state" }, "Fault": { "shape_name": "SpotInstanceStateFault", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\nThe reason code for the Spot Instance state change.
\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nThe message for the Spot Instance state change.
\n ", "xmlname": "message" } }, "documentation": "\nThe fault codes for the Spot Instance request, if any.
\n ", "xmlname": "fault" }, "Status": { "shape_name": "SpotInstanceStatus", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\nThe status code of the request.
\n ", "xmlname": "code" }, "UpdateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time of the most recent status update.
\n ", "xmlname": "updateTime" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nThe description for the status code for the Spot request.
\n ", "xmlname": "message" } }, "documentation": "\nThe status code and status message describing the Spot Instance request.
\n ", "xmlname": "status" }, "ValidFrom": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe 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.
\n ", "xmlname": "validFrom" }, "ValidUntil": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe 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.
\n ", "xmlname": "validUntil" }, "LaunchGroup": { "shape_name": "String", "type": "string", "documentation": "\nThe instance launch group. Launch groups are Spot Instances that launch\n\t\t\t\ttogether and terminate together.
\n ", "xmlname": "launchGroup" }, "AvailabilityZoneGroup": { "shape_name": "String", "type": "string", "documentation": "\nThe 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.
\n ", "xmlname": "availabilityZoneGroup" }, "LaunchSpecification": { "shape_name": "LaunchSpecification", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the AMI.
\n ", "xmlname": "imageId" }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the key pair.
\n ", "xmlname": "keyName" }, "SecurityGroups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group.
\n ", "xmlname": "item" }, "documentation": "\nOne or more security groups.
\n ", "xmlname": "groupSet" }, "UserData": { "shape_name": "String", "type": "string", "documentation": "\nThe Base64-encoded MIME user data to make available to the instances.
\n ", "xmlname": "userData" }, "AddressingType": { "shape_name": "String", "type": "string", "documentation": "\n \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", "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" ], "documentation": "\nThe instance type.
\n ", "xmlname": "instanceType" }, "Placement": { "shape_name": "SpotPlacement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone.
\n ", "xmlname": "availabilityZone" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone group name.
\n ", "xmlname": "groupName" } }, "documentation": "\nThe placement information for the instance.
\n ", "xmlname": "placement" }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the kernel.
\n ", "xmlname": "kernelId" }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the RAM disk.
\n ", "xmlname": "ramdiskId" }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappingList", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\nThe virtual device name.
\n ", "xmlname": "virtualName" }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n ", "xmlname": "snapshotId" }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n ", "xmlname": "volumeSize" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", "xmlname": "deleteOnTermination" }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": "\nThe volume type.
\nDefault: standard
The number of I/O operations per second (IOPS) that the\n volume supports.
\nConstraint: Range is 100 to 4000.
\nCondition: Required when the volume type is io1; not used with standard volumes.
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", "xmlname": "ebs" }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n ", "xmlname": "noDevice" } }, "documentation": "\nDescribes a block device mapping.
\n ", "xmlname": "item" }, "documentation": "\nOne or more block device mapping entries.
\n ", "xmlname": "blockDeviceMapping" }, "MonitoringEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nEnables monitoring for the instance.
\nDefault: Disabled
\n ", "xmlname": "monitoringEnabled" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the subnet in which to launch the Spot Instance.
\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\tThe ID of the network interface.
\n ", "xmlname": "networkInterfaceId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe index of the device on the instance for the network interface attachment.
\n ", "xmlname": "deviceIndex" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the subnet associated with the network string.
\n ", "xmlname": "subnetId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe description of the network interface.
\n ", "xmlname": "description" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe private IP address of the network interface.
\n ", "xmlname": "privateIpAddress" }, "Groups": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": "\n\t\tThe IDs of the security groups for the network interface.
\n ", "xmlname": "SecurityGroupId" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIf set to true, the interface is deleted when the instance is terminated.
The private IP addresses.
\n ", "required": true, "xmlname": "privateIpAddress" }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the private IP address is the primary private IP address.
\n ", "xmlname": "primary" } }, "documentation": "\n\t\tDescribes a secondary private IP address for a network interface.
\n ", "xmlname": "item" }, "documentation": "\n\t\tOne or more private IP addresses to assign to the network interface.
\n ", "xmlname": "privateIpAddressesSet" }, "SecondaryPrivateIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe number of secondary private IP addresses.
\n ", "xmlname": "secondaryPrivateIpAddressCount" }, "AssociatePublicIpAddress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates 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.
\n ", "xmlname": "associatePublicIpAddress" } }, "documentation": "\n\t\tDescribes a network interface.
\n ", "xmlname": "item" }, "documentation": "\nOne or more network interfaces.
\n ", "xmlname": "networkInterfaceSet" }, "IamInstanceProfile": { "shape_name": "IamInstanceProfileSpecification", "type": "structure", "members": { "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the instance profile.
\n ", "xmlname": "arn" }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the instance profile.
\n ", "xmlname": "name" } }, "documentation": "\nThe IAM instance profile.
\n ", "xmlname": "iamInstanceProfile" }, "EbsOptimized": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates 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.
\nDefault: false
Additional information for launching instances.
\n ", "xmlname": "launchSpecification" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID, if an instance has been launched to fulfill the Spot Instance\n\t\t\t\trequest.
\n ", "xmlname": "instanceId" }, "CreateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when the Spot Instance request was created.
\n ", "xmlname": "createTime" }, "ProductDescription": { "shape_name": "RIProductDescription", "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": "\nThe product description associated with the Spot Instance.
\n ", "xmlname": "productDescription" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the resource.
\n ", "xmlname": "tagSet" }, "LaunchedAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone in which the bid is launched.
\n ", "xmlname": "launchedAvailabilityZone" } }, "documentation": "\nDescribe a Spot Instance request.
\n ", "xmlname": "item" }, "documentation": "\nOne or more Spot Instance requests.
\n ", "xmlname": "spotInstanceRequestSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes 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\tSpot Instances in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.
\nYou can use DescribeSpotInstanceRequests 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 fulfilled, 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 DescribeInstances with a filter to\n\t\t\t\tlook for instances where the instance lifecycle is spot.
fulfilled\n The start date and time of the Spot Price history data.
\n " }, "EndTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe end date and time of the Spot Price history data.
\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", "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" ], "documentation": null, "xmlname": "InstanceType" }, "documentation": "\nOne or more instance types.
\n ", "flattened": true }, "ProductDescriptions": { "shape_name": "ProductDescriptionList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ProductDescription" }, "documentation": "\nOne or more basic product descriptions.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\navailability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m1.small).
product-description - The product description for the Spot Price\n (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - 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.
The Availability Zone.
\n " }, "MaxResults": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of rows to return.
\n " }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nThe next set of rows to return.
\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", "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" ], "documentation": "\nThe instance type.
\n ", "xmlname": "instanceType" }, "ProductDescription": { "shape_name": "RIProductDescription", "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": "\nA general description of the AMI.
\n ", "xmlname": "productDescription" }, "SpotPrice": { "shape_name": "String", "type": "string", "documentation": "\nThe maximum price you will pay to launch one or more Spot Instances.
\n ", "xmlname": "spotPrice" }, "Timestamp": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe date and time the request was created.
\n ", "xmlname": "timestamp" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone.
\n ", "xmlname": "availabilityZone" } }, "documentation": "\nDescribes the Spot Price.
\n ", "xmlname": "item" }, "documentation": "\nThe historical Spot Prices.
\n ", "xmlname": "spotPriceHistorySet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nThe string marking the next set of results. This is empty\n\t\t\t\tif there are no more results.
\n ", "xmlname": "nextToken" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes 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 Spot\n\t\t\t\tInstances in the Amazon Elastic Compute Cloud User Guide.
\nWhen 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.
\nOne or more subnet IDs.
\n\t\tDefault: Describes all your subnets.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\n\t\tOne or more filters.
\n\t\tavailability-zone - The Availability Zone for the subnet.
available-ip-address-count - The number of IP addresses in the subnet that are available.
cidr - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet.
defaultForAz - Indicates whether this is the default subnet for the Availability Zone.
state - The state of the subnet (pending | available).
subnet-id - The ID of the subnet.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the subnet.
The ID of the subnet.
\n ", "xmlname": "subnetId" }, "State": { "shape_name": "SubnetState", "type": "string", "enum": [ "pending", "available" ], "documentation": "\n\t\tThe current state of the subnet.
\n ", "xmlname": "state" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC the subnet is in.
\n ", "xmlname": "vpcId" }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe CIDR block assigned to the subnet.
\n ", "xmlname": "cidrBlock" }, "AvailableIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe number of unused IP addresses in the subnet. Note that the IP addresses for any\n\t\t\t\tstopped instances are considered unavailable.
\n ", "xmlname": "availableIpAddressCount" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe Availability Zone of the subnet.
\n ", "xmlname": "availabilityZone" }, "DefaultForAz": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether this is the default subnet for the Availability Zone.
\n ", "xmlname": "defaultForAz" }, "MapPublicIpOnLaunch": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether instances launched in this subnet receive a public IP address.
\n ", "xmlname": "mapPublicIpOnLaunch" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the subnet.
\n ", "xmlname": "tagSet" } }, "documentation": "\n\t\tDescribes a subnet.
\n ", "xmlname": "item" }, "documentation": "\n\t\tInformation about one or more subnets.
\n ", "xmlname": "subnetSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tDescribes one or more of your subnets.
\n\t\tFor more information about subnets, see Your VPC and Subnets\n\t\t\t in the Amazon Virtual Private Cloud User Guide.
\nsubnet-9d4a7b6c and\n\t\t\t\t\tsubnet-6e7f829e.vpc-1a2b3c4d or vpc-6e7f8a92, and whose state is\n\t\t\t\t\tavailable.The name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\nkey - The tag key.
resource-id - The resource ID.
resource-type - The resource type \n (customer-gateway |\n dhcp-options |\n image |\n instance |\n internet-gateway | \n network-acl | \n network-interface | \n reserved-instances | \n route-table | \n security-group | \n snapshot | spot-instances-request | \n subnet |\n volume | vpc |\n vpn-connection |\n vpn-gateway).
value - The tag value.
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.
\n " }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nThe token for the next set of items to return. (You received this token from a prior call.)
\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": "\nThe ID of the resource. For example, ami-1a2b3c4d.
The type of resource.
\n ", "xmlname": "resourceType" }, "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\n ", "xmlname": "key" }, "Value": { "shape_name": "String", "type": "string", "documentation": "\nThe value of the tag.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nA list of tags.
\n ", "xmlname": "tagSet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nThe token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
\n ", "xmlname": "nextToken" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes one or more of the tags for your EC2 resources.
\nFor more information about tags, see Tagging Your Resources in the\n Amazon Elastic Compute Cloud User Guide.
\n?ebserver to\n find tags with the key webserver or\n Webserver.The ID of the volume.
\n ", "required": true }, "Attribute": { "shape_name": "VolumeAttributeName", "type": "string", "enum": [ "autoEnableIO", "productCodes" ], "documentation": "\nThe instance attribute.
\n " } }, "documentation": "\n " }, "output": { "shape_name": "DescribeVolumeAttributeResult", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the volume.
\n ", "xmlname": "volumeId" }, "AutoEnableIO": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\nThe state of autoEnableIO attribute.
The product code.
\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": "\nThe type of product code.
\n ", "xmlname": "type" } }, "documentation": "\nDescribes a product code.
\n ", "xmlname": "item" }, "documentation": "\nA list of product codes.
\n ", "xmlname": "productCodes" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes the specified attribute of the specified volume. You can specify only one attribute\n at a time.
\nFor more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
\nautoEnableIO attribute of the volume\n vol-12345678.productCodes attribute of the volume\n vol-12345678.One or more volume IDs.
\nDefault: Describes all your volumes.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\naction.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed;\n for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed;\n for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
The next paginated set of results to return using the pagination token\n returned by a previous call.
\n " }, "MaxResults": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe maximum number of paginated volume items per response.
\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": "\nThe volume ID.
\n ", "xmlname": "volumeId" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone of the volume.
\n ", "xmlname": "availabilityZone" }, "VolumeStatus": { "shape_name": "VolumeStatusInfo", "type": "structure", "members": { "Status": { "shape_name": "VolumeStatusInfoStatus", "type": "string", "enum": [ "ok", "impaired", "insufficient-data" ], "documentation": "\nThe status of the volume.
\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": "\nThe name of the volume status.
\n ", "xmlname": "name" }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe intended status of the volume status.
\n ", "xmlname": "status" } }, "documentation": "\nDescribes a volume status.
\n ", "xmlname": "item" }, "documentation": "\nThe details of the volume status.
\n ", "xmlname": "details" } }, "documentation": "\nThe volume status.
\n ", "xmlname": "volumeStatus" }, "Events": { "shape_name": "VolumeStatusEventsList", "type": "list", "members": { "shape_name": "VolumeStatusEvent", "type": "structure", "members": { "EventType": { "shape_name": "String", "type": "string", "documentation": "\nThe type of this event.
\n ", "xmlname": "eventType" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description of the event.
\n ", "xmlname": "description" }, "NotBefore": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe earliest start time of the event.
\n ", "xmlname": "notBefore" }, "NotAfter": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe latest end time of the event.
\n ", "xmlname": "notAfter" }, "EventId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of this event.
\n ", "xmlname": "eventId" } }, "documentation": "\nDescribes a volume status event.
\n ", "xmlname": "item" }, "documentation": "\nA list of events associated with the volume.
\n ", "xmlname": "eventsSet" }, "Actions": { "shape_name": "VolumeStatusActionsList", "type": "list", "members": { "shape_name": "VolumeStatusAction", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\nThe code identifying the operation, for example, enable-volume-io.
A description of the operation.
\n ", "xmlname": "description" }, "EventType": { "shape_name": "String", "type": "string", "documentation": "\nThe event type associated with this operation.
\n ", "xmlname": "eventType" }, "EventId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the event associated with this operation.
\n ", "xmlname": "eventId" } }, "documentation": "\nDescribes a volume status operation code.
\n ", "xmlname": "item" }, "documentation": "\nThe details of the operation.
\n ", "xmlname": "actionsSet" } }, "documentation": "\nDescribes the volume status.
\n ", "xmlname": "item" }, "documentation": "\nA list of volumes.
\n ", "xmlname": "volumeStatusSet" }, "NextToken": { "shape_name": "String", "type": "string", "documentation": "\nThe next paginated set of results to return.
\n ", "xmlname": "nextToken" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes 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.
\nThe DescribeVolumeStatus operation provides the following information about the\n specified volumes:
Status: Reflects the current status of the volume. The possible values are\n ok, impaired , warning, or\n insufficient-data. If all checks pass, the overall status of the volume is\n ok. If the check fails, the overall status is impaired. If the\n status is insufficient-data, 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 Monitoring the Status of Your\n Volumes.
Events: Reflect the cause of a volume status and may require you to take action.\n For example, if your volume returns an impaired status, then the volume event\n might be potential-data-inconsistency. 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.
Actions: Reflect the actions you may have to take in response to an event. For\n example, if the status of the volume is impaired and the volume event shows\n potential-data-inconsistency, then the action shows\n enable-volume-io. This means that you may want to enable the I/O operations for\n the volume by calling the EnableVolumeIO action and then check the volume for data\n consistency.
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 error state (for\n example, when a volume is incapable of accepting I/O.)
enable-volume-io\n us-east-1d\n Availability Zone with failed\n io-enabled status.One or more volume IDs.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\nOne or more filters.
\nattachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching | detached).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The status of the volume (creating | available | in-use | deleting | deleted | error).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - 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 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type (standard | io1).
The ID of the volume.
\n ", "xmlname": "volumeId" }, "Size": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe size of the volume, in GiBs.
\n ", "xmlname": "size" }, "SnapshotId": { "shape_name": "String", "type": "string", "documentation": "\nThe snapshot from which the volume was created, if applicable.
\n ", "xmlname": "snapshotId" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone for the volume.
\n ", "xmlname": "availabilityZone" }, "State": { "shape_name": "VolumeState", "type": "string", "enum": [ "creating", "available", "in-use", "deleting", "deleted", "error" ], "documentation": "\nThe volume state.
\n ", "xmlname": "status" }, "CreateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when volume creation was initiated.
\n ", "xmlname": "createTime" }, "Attachments": { "shape_name": "VolumeAttachmentList", "type": "list", "members": { "shape_name": "VolumeAttachment", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the volume.
\n ", "xmlname": "volumeId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance.
\n ", "xmlname": "instanceId" }, "Device": { "shape_name": "String", "type": "string", "documentation": "\nThe device name.
\n ", "xmlname": "device" }, "State": { "shape_name": "VolumeAttachmentState", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\nThe attachment state of the volume.
\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when the attachment initiated.
\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\nDescribes volume attachment details.
\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": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the volume.
\n ", "xmlname": "tagSet" }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": "\nThe volume type.
\n ", "xmlname": "volumeType" }, "Iops": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of I/O operations per second (IOPS) that the volume supports.
\n ", "xmlname": "iops" } }, "documentation": "\nDescribes a volume.
\n ", "xmlname": "item" }, "documentation": "\n ", "xmlname": "volumeSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nDescribes the specified Amazon EBS volumes.
\nFor more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
\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\tThe ID of the VPC.
\n ", "required": true }, "Attribute": { "shape_name": "VpcAttributeName", "type": "string", "enum": [ "enableDnsSupport", "enableDnsHostnames" ], "documentation": "\n\t\tThe VPC attribute.
\n " } }, "documentation": "\n " }, "output": { "shape_name": "DescribeVpcAttributeResult", "type": "structure", "members": { "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC.
\n ", "xmlname": "vpcId" }, "EnableDnsSupport": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n ", "xmlname": "value" } }, "documentation": "\n\t\tIndicates whether DNS resolution is enabled for\n\t\t\t\tthe VPC. If this attribute is true, 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.
Indicates whether the instances launched in the VPC get DNS hostnames.\n\t\t\t\tIf this attribute is true, instances in the VPC get DNS hostnames;\n\t\t\t\totherwise, they do not.
Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
\nenableDnsSupport attribute of the specified VPC.\n The sample response indicates that DNS resolution is supported.enableDnsHostnames attribute of the\n\t\t\t\t\tspecified VPC. The sample response indicates that DNS hostnames are supported.One or more VPC IDs.
\n\t\tDefault: Describes all your VPCs.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\n\t\tOne or more filters.
\n\t\tcidr - 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.
dhcp-options-id - The ID of a set of DHCP options.
isDefault - Indicates whether the VPC is the default VPC.
state - The state of the VPC (pending | available).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC.
The ID of the VPC.
\n ", "xmlname": "vpcId" }, "State": { "shape_name": "VpcState", "type": "string", "enum": [ "pending", "available" ], "documentation": "\n\t\tThe current state of the VPC.
\n ", "xmlname": "state" }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe CIDR block for the VPC.
\n ", "xmlname": "cidrBlock" }, "DhcpOptionsId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the set of DHCP options you've associated with the VPC (or default\n\t\t\t\tif the default options are associated with the VPC).
The key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the VPC.
\n ", "xmlname": "tagSet" }, "InstanceTenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\n\t\tThe allowed tenancy of instances launched into the VPC.
\n ", "xmlname": "instanceTenancy" }, "IsDefault": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the VPC is the default VPC.
\n ", "xmlname": "isDefault" } }, "documentation": "\n\t\tDescribes a VPC.
\n ", "xmlname": "item" }, "documentation": "\n\t\tInformation about one or more VPCs.
\n ", "xmlname": "vpcSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tDescribes one or more of your VPCs.
\ndopt-7a8b9c2d or \n\t\t\t\t\tdopt-2b2a3d3c and whose state is available.One or more VPN connection IDs.
\n\t\tDefault: Describes your VPN connections.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\n\t\tOne or more filters.
\n\t\tcustomer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
The ID of the VPN connection.
\n ", "xmlname": "vpnConnectionId" }, "State": { "shape_name": "VpnState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": "\n\t\tThe current state of the VPN connection.
\n ", "xmlname": "state" }, "CustomerGatewayConfiguration": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe 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\tCreateVpnConnection response; however, it's present in the\n\t\t\t\tDescribeVpnConnections response only if the VPN connection is in\n\t\t\t\tthe pending or available state.
The type of VPN connection.
\n ", "xmlname": "type" }, "CustomerGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the customer gateway at your end of the VPN connection.
\n ", "xmlname": "customerGatewayId" }, "VpnGatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the virtual private gateway at the AWS side of the VPN connection.
\n ", "xmlname": "vpnGatewayId" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the VPN connection.
\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\tThe Internet-routable IP address of the virtual private gateway's outside interface.
\n ", "xmlname": "outsideIpAddress" }, "Status": { "shape_name": "TelemetryStatus", "type": "string", "enum": [ "UP", "DOWN" ], "documentation": "\n\t\tThe status of the VPN tunnel.
\n ", "xmlname": "status" }, "LastStatusChange": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n\t\tThe date and time of the last change in status.
\n ", "xmlname": "lastStatusChange" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\n\t\tIf an error occurs, a description of the error.
\n ", "xmlname": "statusMessage" }, "AcceptedRouteCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe number of accepted routes.
\n ", "xmlname": "acceptedRouteCount" } }, "documentation": "\n\t\tDescribes telemetry for a VPN tunnel.
\n ", "xmlname": "item" }, "documentation": "\n\t\tInformation about the VPN tunnel.
\n ", "xmlname": "vgwTelemetry" }, "Options": { "shape_name": "VpnConnectionOptions", "type": "structure", "members": { "StaticRoutesOnly": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the VPN connection uses static routes only. \n\t\t Static routes must be used for devices that don't support BGP.
\n ", "xmlname": "staticRoutesOnly" } }, "documentation": "\n\t\tThe VPN connection options.
\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\tThe CIDR block associated with the local subnet of the customer data center.
\n ", "xmlname": "destinationCidrBlock" }, "Source": { "shape_name": "VpnStaticRouteSource", "type": "string", "enum": [ "Static" ], "documentation": "\n\t\tIndicates how the routes were provided.
\n ", "xmlname": "source" }, "State": { "shape_name": "VpnState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": "\n\t\tThe current state of the static route.
\n ", "xmlname": "state" } }, "documentation": "\n\t\tDescribes a static route for a VPN connection.
\n ", "xmlname": "item" }, "documentation": "\n\t\tThe static routes assoicated with the VPN connection.
\n ", "xmlname": "routes" } }, "documentation": "\n\t\tDescribes a VPN connection.
\n ", "xmlname": "item" }, "documentation": "\n\t\tInformation about one or more VPN connections.
\n ", "xmlname": "vpnConnectionSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tDescribes one or more of your VPN connections.
\n\t\tFor more information about VPN connections, see Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.
\npending or available.One or more virtual private gateway IDs.
\n\t\tDefault: Describes all your virtual private gateways.
\n ", "flattened": true }, "Filters": { "shape_name": "FilterList", "type": "list", "members": { "shape_name": "Filter", "type": "structure", "members": { "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the filter.
\n " }, "Values": { "shape_name": "ValueStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "Value" }, "documentation": "\nOne or more filter values.
\n ", "flattened": true } }, "documentation": "\n ", "xmlname": "Filter" }, "documentation": "\n\t\tOne or more filters.
\n\t\tattachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway.
state - The state of the virtual private gateway (pending | available | deleting | deleted).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value 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 tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
The ID of the virtual private gateway.
\n ", "xmlname": "vpnGatewayId" }, "State": { "shape_name": "VpnState", "type": "string", "enum": [ "pending", "available", "deleting", "deleted" ], "documentation": "\n\t\tThe current state of the virtual private gateway.
\n ", "xmlname": "state" }, "Type": { "shape_name": "GatewayType", "type": "string", "enum": [ "ipsec.1" ], "documentation": "\n\t\tThe type of VPN connection the virtual private gateway supports.
\n ", "xmlname": "type" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe Availability Zone where the virtual private gateway was created.
\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\tThe ID of the VPC.
\n ", "xmlname": "vpcId" }, "State": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n\t\tThe current state of the attachment.
\n ", "xmlname": "state" } }, "documentation": "\n\t\tDescribes an attachment between a virtual private gateway and a VPC.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny VPCs attached to the virtual private gateway.
\n ", "xmlname": "attachments" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n\t\tAny tags assigned to the virtual private gateway.
\n ", "xmlname": "tagSet" } }, "documentation": "\n\t\tDescribes a virtual private gateway.
\n ", "xmlname": "item" }, "documentation": "\n\t\tInformation about one or more virtual private gateways.
\n ", "xmlname": "vpnGatewaySet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tDescribes one or more of your virtual private gateways.
\n\t\tFor more information about virtual private gateways, see Adding an IPsec Hardware VPN\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.
\npending or available.The ID of the Internet gateway.
\n ", "required": true }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDetaches 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.
\nThe ID of the attachment.
\n ", "required": true }, "Force": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tSpecifies whether to force a detachment.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDetaches a network interface from an instance.
\nThe ID of the volume.
\n ", "required": true }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance.
\n " }, "Device": { "shape_name": "String", "type": "string", "documentation": "\nThe device name.
\n " }, "Force": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nForces 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.
\n " } }, "documentation": "\n " }, "output": { "shape_name": "VolumeAttachment", "type": "structure", "members": { "VolumeId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the volume.
\n ", "xmlname": "volumeId" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance.
\n ", "xmlname": "instanceId" }, "Device": { "shape_name": "String", "type": "string", "documentation": "\nThe device name.
\n ", "xmlname": "device" }, "State": { "shape_name": "VolumeAttachmentState", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\nThe attachment state of the volume.
\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when the attachment initiated.
\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n ", "xmlname": "attachment" }, "errors": [], "documentation": "\nDetaches 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.
\nIf 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.
\nIf 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.
\nFor more information, see Detaching an\n Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
\nvol-1a2b3c4d.The ID of the virtual private gateway.
\n ", "required": true }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDetaches 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).
\n\t\tYou must wait for the attachment's state to switch to detached before\n\t\t\t\tyou can delete the VPC or attach a different VPC to the virtual private gateway.
The ID of the routing table.
\n ", "required": true }, "GatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the virtual private gateway.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nDisables a virtual private gateway (VGW) from propagating routes to the routing\n\t\t\t\ttables of a VPC.
\nvgw-d8e09e8a\n\t\t\t\t\tfrom automatically propagating routes to the routing table with ID\n\t\t\t\t\trtb-c98a35a0.[EC2-Classic] The Elastic IP address.
\n " }, "AssociationId": { "shape_name": "String", "type": "string", "documentation": "\n[EC2-VPC] The association ID.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nDisassociates an Elastic IP address from the instance or network interface it's\n\t\t\t\tassociated with.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2\n\t\t\t\tdoesn't return an error.
\nThe association ID representing the current association between the route table and subnet.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tDisassociates a subnet from a route table.
\n\t\tAfter 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 Route\n\t\t\t\tTables in the Amazon Virtual Private Cloud User Guide.
\nThe ID of the routing table.
\n ", "required": true }, "GatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the virtual private gateway.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tEnables a virtual private gateway (VGW) to propagate routes to the routing tables\n\t\t\t\tof a VPC.
\nrtb-c98a35a0.The ID of the volume.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nEnables I/O operations for a volume that had I/O operations disabled because the data on the\n volume was potentially inconsistent.
\nThe ID of the instance.
\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "GetConsoleOutputResult", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance.
\n ", "xmlname": "instanceId" }, "Timestamp": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time the output was last updated.
\n ", "xmlname": "timestamp" }, "Output": { "shape_name": "String", "type": "string", "documentation": "\nThe console output, Base64 encoded.
\n ", "xmlname": "output" } }, "documentation": "\n " }, "errors": [], "documentation": "\nGets the console output for the specified instance.
\nInstances 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.
\n\t\t\tInstance 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.
\n\t\t\tFor 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.
\n\t\t\tFor Windows instances, the instance console output displays the last\n\t\t\t\tthree system event log errors.
\nThe ID of the Windows instance.
\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "GetPasswordDataResult", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the Windows instance.
\n ", "xmlname": "instanceId" }, "Timestamp": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time the data was last updated.
\n ", "xmlname": "timestamp" }, "PasswordData": { "shape_name": "String", "type": "string", "documentation": "\nThe password of the instance.
\n ", "xmlname": "passwordData" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\t\tRetrieves the encrypted administrator password for an instance running\n\t\t\t\tWindows.
\n\t\t\tThe 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.
\n\t\t\tThe 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.
\n\t\t\tPassword 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.
\nA description for the instance being imported.
\n " }, "LaunchSpecification": { "shape_name": "ImportInstanceLaunchSpecification", "type": "structure", "members": { "Architecture": { "shape_name": "ArchitectureValues", "type": "string", "enum": [ "i386", "x86_64" ], "documentation": "\nThe architecture of the instance.
\n " }, "GroupNames": { "shape_name": "SecurityGroupStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "GroupName" }, "documentation": "\nOne or more security group names.
\n ", "flattened": true }, "AdditionalInfo": { "shape_name": "String", "type": "string", "documentation": "\n " }, "UserData": { "shape_name": "String", "type": "string", "documentation": "\nUser data to be made available to the instance.
\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", "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" ], "documentation": "\nThe instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
\n " }, "Placement": { "shape_name": "Placement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone of the instance.
\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the placement group the instance is in (for cluster compute instances).
\n " }, "Tenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\nThe tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of dedicated runs\n on single-tenant hardware.
[EC2-VPC] The ID of the subnet to launch the instance\n into.
\n " }, "InstanceInitiatedShutdownBehavior": { "shape_name": "ShutdownBehavior", "type": "string", "enum": [ "stop", "terminate" ], "documentation": "\nIndicates whether an instance stops or terminates when you initiate\n shutdown from the instance (using the operating system command for system shutdown).
\n " }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n[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.
\n " } }, "documentation": "\n \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": "\nThe disk image format.
\n ", "required": true }, "Bytes": { "shape_name": "Long", "type": "long", "documentation": "\n ", "required": true }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": "\nA 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 Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\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": "\nThe size of the volume.
\n ", "required": true } }, "documentation": "\n " } }, "documentation": "\nDescribes a disk image.
\n ", "xmlname": "DiskImage" }, "documentation": "\n ", "flattened": true }, "Platform": { "shape_name": "PlatformValues", "type": "string", "enum": [ "Windows" ], "documentation": "\nThe instance operating system.
\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": "\nThe ID of the conversion task.
\n ", "required": true, "xmlname": "conversionTaskId" }, "ExpirationTime": { "shape_name": "String", "type": "string", "documentation": "\nThe time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
\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": "\nThe number of bytes converted so far.
\n ", "required": true, "xmlname": "bytesConverted" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone where the resulting instance will reside.
\n ", "required": true, "xmlname": "availabilityZone" }, "Image": { "shape_name": "DiskImageDescription", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": "\nThe disk image format.
\n ", "required": true, "xmlname": "format" }, "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the disk image.
\n ", "required": true, "xmlname": "size" }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": "\nA 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 Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", "required": true, "xmlname": "importManifestUrl" }, "Checksum": { "shape_name": "String", "type": "string", "documentation": "\nThe checksum computed for the disk image.
\n ", "xmlname": "checksum" } }, "documentation": "\nThe image.
\n ", "required": true, "xmlname": "image" }, "Volume": { "shape_name": "DiskImageVolumeDescription", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the volume.
\n ", "xmlname": "size" }, "Id": { "shape_name": "String", "type": "string", "documentation": "\nThe volume identifier.
\n ", "required": true, "xmlname": "id" } }, "documentation": "\nThe volume.
\n ", "required": true, "xmlname": "volume" }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the import of this particular disk image.
\n ", "required": true, "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\nThe status information or errors related to the disk image.
\n ", "xmlname": "statusMessage" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n ", "xmlname": "description" } }, "documentation": "\nDescribes an import volume task.
\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": "\nThe instance operating system.
\n ", "xmlname": "platform" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n ", "xmlname": "description" } }, "documentation": "\nIf the task is for importing an instance, this contains information about the import instance task.
\n ", "xmlname": "importInstance" }, "ImportVolume": { "shape_name": "ImportVolumeTaskDetails", "type": "structure", "members": { "BytesConverted": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of bytes converted so far.
\n ", "required": true, "xmlname": "bytesConverted" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone where the resulting volume will reside.
\n ", "required": true, "xmlname": "availabilityZone" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description you provided when starting the import volume task.
\n ", "xmlname": "description" }, "Image": { "shape_name": "DiskImageDescription", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": "\nThe disk image format.
\n ", "required": true, "xmlname": "format" }, "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the disk image.
\n ", "required": true, "xmlname": "size" }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": "\nA 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 Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", "required": true, "xmlname": "importManifestUrl" }, "Checksum": { "shape_name": "String", "type": "string", "documentation": "\nThe checksum computed for the disk image.
\n ", "xmlname": "checksum" } }, "documentation": "\nThe image.
\n ", "required": true, "xmlname": "image" }, "Volume": { "shape_name": "DiskImageVolumeDescription", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the volume.
\n ", "xmlname": "size" }, "Id": { "shape_name": "String", "type": "string", "documentation": "\nThe volume identifier.
\n ", "required": true, "xmlname": "id" } }, "documentation": "\nThe volume.
\n ", "required": true, "xmlname": "volume" } }, "documentation": "\nIf the task is for importing a volume, this contains information about the import volume task.
\n ", "xmlname": "importVolume" }, "State": { "shape_name": "ConversionTaskState", "type": "string", "enum": [ "active", "cancelling", "cancelled", "completed" ], "documentation": "\nThe state of the conversion task.
\n ", "required": true, "xmlname": "state" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\nThe status message related to the conversion task.
\n ", "xmlname": "statusMessage" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n ", "xmlname": "tagSet" } }, "documentation": "\n ", "xmlname": "conversionTask" } }, "documentation": "\n " }, "errors": [], "documentation": "\nCreates an import instance task using metadata from the specified disk image.\n After importing the image, you then upload it using the\n
us-east-1 region.A unique name for the key pair.
\n ", "required": true }, "PublicKeyMaterial": { "shape_name": "String", "type": "blob", "documentation": "\nThe public key. You must base64 encode the public key material before sending it to AWS.
\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "ImportKeyPairResult", "type": "structure", "members": { "KeyName": { "shape_name": "String", "type": "string", "documentation": "\nThe key pair name you provided.
\n ", "xmlname": "keyName" }, "KeyFingerprint": { "shape_name": "String", "type": "string", "documentation": "\nThe MD5 public key fingerprint as specified in section 4 of RFC 4716.
\n ", "xmlname": "keyFingerprint" } }, "documentation": "\n " }, "errors": [], "documentation": "\nImports the public key from an RSA key pair that you created with a third-party tool. \n Compare this with CreateKeyPair, 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.
\nFor more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nThe Availability Zone for the resulting Amazon EBS\n volume.
\n " }, "Image": { "shape_name": "DiskImageDetail", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": "\nThe disk image format.
\n ", "required": true }, "Bytes": { "shape_name": "Long", "type": "long", "documentation": "\n ", "required": true }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": "\nA 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 Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", "required": true } }, "documentation": "\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nAn optional description for the volume being imported.
\n " }, "Volume": { "shape_name": "VolumeDetail", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the volume.
\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": "\nThe ID of the conversion task.
\n ", "required": true, "xmlname": "conversionTaskId" }, "ExpirationTime": { "shape_name": "String", "type": "string", "documentation": "\nThe time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
\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": "\nThe number of bytes converted so far.
\n ", "required": true, "xmlname": "bytesConverted" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone where the resulting instance will reside.
\n ", "required": true, "xmlname": "availabilityZone" }, "Image": { "shape_name": "DiskImageDescription", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": "\nThe disk image format.
\n ", "required": true, "xmlname": "format" }, "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the disk image.
\n ", "required": true, "xmlname": "size" }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": "\nA 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 Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", "required": true, "xmlname": "importManifestUrl" }, "Checksum": { "shape_name": "String", "type": "string", "documentation": "\nThe checksum computed for the disk image.
\n ", "xmlname": "checksum" } }, "documentation": "\nThe image.
\n ", "required": true, "xmlname": "image" }, "Volume": { "shape_name": "DiskImageVolumeDescription", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the volume.
\n ", "xmlname": "size" }, "Id": { "shape_name": "String", "type": "string", "documentation": "\nThe volume identifier.
\n ", "required": true, "xmlname": "id" } }, "documentation": "\nThe volume.
\n ", "required": true, "xmlname": "volume" }, "Status": { "shape_name": "String", "type": "string", "documentation": "\nThe status of the import of this particular disk image.
\n ", "required": true, "xmlname": "status" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\nThe status information or errors related to the disk image.
\n ", "xmlname": "statusMessage" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n ", "xmlname": "description" } }, "documentation": "\nDescribes an import volume task.
\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": "\nThe instance operating system.
\n ", "xmlname": "platform" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n ", "xmlname": "description" } }, "documentation": "\nIf the task is for importing an instance, this contains information about the import instance task.
\n ", "xmlname": "importInstance" }, "ImportVolume": { "shape_name": "ImportVolumeTaskDetails", "type": "structure", "members": { "BytesConverted": { "shape_name": "Long", "type": "long", "documentation": "\nThe number of bytes converted so far.
\n ", "required": true, "xmlname": "bytesConverted" }, "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone where the resulting volume will reside.
\n ", "required": true, "xmlname": "availabilityZone" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nThe description you provided when starting the import volume task.
\n ", "xmlname": "description" }, "Image": { "shape_name": "DiskImageDescription", "type": "structure", "members": { "Format": { "shape_name": "DiskImageFormat", "type": "string", "enum": [ "VMDK", "RAW", "VHD" ], "documentation": "\nThe disk image format.
\n ", "required": true, "xmlname": "format" }, "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the disk image.
\n ", "required": true, "xmlname": "size" }, "ImportManifestUrl": { "shape_name": "String", "type": "string", "documentation": "\nA 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 Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", "required": true, "xmlname": "importManifestUrl" }, "Checksum": { "shape_name": "String", "type": "string", "documentation": "\nThe checksum computed for the disk image.
\n ", "xmlname": "checksum" } }, "documentation": "\nThe image.
\n ", "required": true, "xmlname": "image" }, "Volume": { "shape_name": "DiskImageVolumeDescription", "type": "structure", "members": { "Size": { "shape_name": "Long", "type": "long", "documentation": "\nThe size of the volume.
\n ", "xmlname": "size" }, "Id": { "shape_name": "String", "type": "string", "documentation": "\nThe volume identifier.
\n ", "required": true, "xmlname": "id" } }, "documentation": "\nThe volume.
\n ", "required": true, "xmlname": "volume" } }, "documentation": "\nIf the task is for importing a volume, this contains information about the import volume task.
\n ", "xmlname": "importVolume" }, "State": { "shape_name": "ConversionTaskState", "type": "string", "enum": [ "active", "cancelling", "cancelled", "completed" ], "documentation": "\nThe state of the conversion task.
\n ", "required": true, "xmlname": "state" }, "StatusMessage": { "shape_name": "String", "type": "string", "documentation": "\nThe status message related to the conversion task.
\n ", "xmlname": "statusMessage" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\n ", "xmlname": "tagSet" } }, "documentation": "\n ", "xmlname": "conversionTask" } }, "documentation": "\n " }, "errors": [], "documentation": "\nCreates an import volume task using metadata from the specified disk image.\n After importing the image, you then upload it using the\n
us-east-1 region.The ID of the AMI.
\n ", "required": true }, "Attribute": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the attribute to modify.
\n " }, "OperationType": { "shape_name": "String", "type": "string", "documentation": "\nThe operation type.
\n " }, "UserIds": { "shape_name": "UserIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "UserId" }, "documentation": "\nOne or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
One or more user groups. This is only valid when modifying the launchPermission attribute.
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 productCodes attribute.
The value of the attribute being modified. This is only valid when modifying the description attribute.
The AWS account ID.
\n " }, "Group": { "shape_name": "PermissionGroup", "type": "string", "enum": [ "all" ], "documentation": "\nThe name of the group.
\n " } }, "documentation": "\nDescribes a launch permission.
\n " }, "documentation": "\nThe AWS account ID to add to the list of launch permissions for the AMI.
\n ", "flattened": true }, "Remove": { "shape_name": "LaunchPermissionList", "type": "list", "members": { "shape_name": "LaunchPermission", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\nThe AWS account ID.
\n " }, "Group": { "shape_name": "PermissionGroup", "type": "string", "enum": [ "all" ], "documentation": "\nThe name of the group.
\n " } }, "documentation": "\nDescribes a launch permission.
\n " }, "documentation": "\nThe AWS account ID to remove from the list of launch permissions for the AMI.
\n ", "flattened": true } }, "documentation": "\n \n " }, "Description": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n " } }, "documentation": "\nA description for the AMI.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": " \nModifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
\nAWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.
The ID of the instance.
\n ", "required": true }, "Attribute": { "shape_name": "InstanceAttributeName", "type": "string", "enum": [ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized" ], "documentation": "\nThe name of the attribute.
\n " }, "Value": { "shape_name": "String", "type": "string", "documentation": "\nA new value for the attribute. Use only with the kernel, ramdisk,\n userData, disableApiTermination, or\n intanceInitiateShutdownBehavior attribute.
The device name exposed to the instance (for example,
The ID of the Amazon EBS volume.
\n " }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the volume is deleted on instance termination.
\n " } }, "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n " }, "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\nThe virtual device name.
\n " }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\nsuppress the specified device included in the block device mapping.
\n " } }, "documentation": "\nDescribes a block device mapping entry.
\n ", "xmlname": "BlockDeviceMapping" }, "documentation": "\n\t\t\tModifies the DeleteOnTermination 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 DeleteOnTermination, the default\n\t\t\t\tis true and the volume is deleted when the instance is\n\t\t\t\tterminated.
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 Updating the Block Device Mapping when Launching an Instance\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\n ", "flattened": true }, "SourceDestCheck": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n " } }, "documentation": "\nSpecifies whether source/destination checking is enabled.\n\t\t\t\tA value of true means that checking is enabled, and\n\t\t\t\tfalse means checking is disabled. This value\n\t\t\t\tmust be false for a NAT instance to perform NAT.
Specifies whether to disable the ability to terminate the instance using the Amazon EC2 console, CLI, and API.
\n " }, "InstanceType": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n " } }, "documentation": "\nChanges the instance type to the specified value. For more information, see\n\t\t\t\tInstance Types.\n\t\t\t\tIf the instance type is not valid, the error returned is InvalidInstanceAttributeValue.
Changes the instance's kernel to the specified value.
\n " }, "Ramdisk": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n " } }, "documentation": "\nChanges the instance's RAM disk to the specified value.
\n " }, "UserData": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "blob", "documentation": " \n " } }, "documentation": "\nChanges the instance's user data to the specified value.
\n " }, "InstanceInitiatedShutdownBehavior": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n " } }, "documentation": "\nSpecifies 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).
\n " }, "Groups": { "shape_name": "GroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "GroupId" }, "documentation": "\n\t\t\t[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.
\n\t\t\tFor example, if you want the instance to be in sg-1a1a1a1a and\n\t\t\t\tsg-9b9b9b9b, specify GroupId.1=sg-1a1a1a1a and\n\t\t\t\tGroupId.2=sg-9b9b9b9b.
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.
\n " }, "SriovNetSupport": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n " } }, "documentation": " \n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\t\tModifies the specified attribute of the specified instance. You can specify only one attribute at a time.
\n\t\t\tTo modify some attributes, the instance must be stopped. For more information, see\n\t\t\t\tModifying Attributes of a Stopped Instance\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nstopped state.InstanceInitiatedShutdownBehavior attribute of the specified instance.DisableApiTermination attribute of the specified instance.The ID of the network interface.
\n ", "required": true }, "Description": { "shape_name": "AttributeValue", "type": "structure", "members": { "Value": { "shape_name": "String", "type": "string", "documentation": " \n " } }, "documentation": "\n\t\tA description for the network interface.
\n " }, "SourceDestCheck": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n " } }, "documentation": "\n\t\tIndicates whether source/destination checking is enabled.\n\t\t\t\tA value of true means checking\n\t\t\t\tis enabled, and false means checking is disabled. This value\n\t\t\t\tmust be false for a NAT instance to perform NAT. For more\n\t\t\t\tinformation, see NAT\n\t\t\t\tInstances in the Amazon Virtual Private Cloud User Guide.
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.
\n ", "flattened": true }, "Attachment": { "shape_name": "NetworkInterfaceAttachmentChanges", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the network interface attachment.
\n " }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the network interface is deleted when the instance is terminated.
\n " } }, "documentation": "\n\t\tThe ID of the interface attachment.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tModifies the specified network interface attribute. You can specify only one attribute at a time.
\nfalse for the\n\t\t\t\t\tspecified network interface.A unique, case-sensitive token you provide to ensure idempotency of your modification request.
\n " }, "ReservedInstancesIds": { "shape_name": "ReservedInstancesIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "ReservedInstancesId" }, "documentation": "\nThe IDs of the Reserved Instances to modify.
\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": "\nThe Availability Zone for the modified Reserved Instances.
\n " }, "Platform": { "shape_name": "String", "type": "string", "documentation": "\nThe network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
\n " }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of modified Reserved Instances.
\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", "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" ], "documentation": "\nThe instance type for the modified Reserved Instances.
\n " } }, "documentation": "\nDescribes the configuration settings for the modified Reserved Instances.
\n ", "xmlname": "ReservedInstancesConfigurationSetItemType" }, "documentation": "\nThe configuration settings for the Reserved Instances to modify.
\n ", "required": true, "flattened": true } }, "documentation": "\n " }, "output": { "shape_name": "ModifyReservedInstancesResult", "type": "structure", "members": { "ReservedInstancesModificationId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID for the modification.
\n ", "xmlname": "reservedInstancesModificationId" } }, "documentation": "\n " }, "errors": [], "documentation": "\nModifies 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.
\nThe ID of the snapshot.
\n ", "required": true }, "Attribute": { "shape_name": "SnapshotAttributeName", "type": "string", "enum": [ "productCodes", "createVolumePermission" ], "documentation": "\n " }, "OperationType": { "shape_name": "String", "type": "string", "documentation": "\n " }, "UserIds": { "shape_name": "UserIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "UserId" }, "documentation": "\n ", "flattened": true }, "GroupNames": { "shape_name": "GroupNameStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "UserGroup" }, "documentation": "\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": "\nThe specific AWS account ID that is to be added or removed from a volume's list of create\n volume permissions.
\n " }, "Group": { "shape_name": "PermissionGroup", "type": "string", "enum": [ "all" ], "documentation": "\nThe specific group that is to be added or removed from a volume's list of create volume\n permissions.
\n " } }, "documentation": "\n " }, "documentation": "\nAdds a specific AWS account ID or group to a volume's list of create volume permissions.
\n ", "flattened": true }, "Remove": { "shape_name": "CreateVolumePermissionList", "type": "list", "members": { "shape_name": "CreateVolumePermission", "type": "structure", "members": { "UserId": { "shape_name": "String", "type": "string", "documentation": "\nThe specific AWS account ID that is to be added or removed from a volume's list of create\n volume permissions.
\n " }, "Group": { "shape_name": "PermissionGroup", "type": "string", "enum": [ "all" ], "documentation": "\nThe specific group that is to be added or removed from a volume's list of create volume\n permissions.
\n " } }, "documentation": "\n " }, "documentation": "\nRemoves a specific AWS account ID or group from a volume's list of create volume\n permissions.
\n ", "flattened": true } }, "documentation": "\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nAdds or removes permission settings for the specified snapshot.
\nFor more information on modifying snapshot permissions, see Sharing Snapshots in the\n Amazon Elastic Compute Cloud User Guide.
\nSnapshots with AWS Marketplace product codes cannot be made public.
\nsnap-1a2b3c4d snapshot public, and gives\n the account with ID 111122223333 permission to create volumes from\n the snapshot.snap-1a2b3c4d snapshot public, and removes\n the account with ID 111122223333 from the list of users with\n permission to create volumes from the snapshot.The ID of the volume.
\n ", "required": true }, "AutoEnableIO": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the volume should be auto-enabled for I/O operations.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nModifies a volume attribute.
\nBy 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.
\nYou 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.
\nThe ID of the VPC.
\n ", "required": true }, "EnableDnsSupport": { "shape_name": "AttributeBooleanValue", "type": "structure", "members": { "Value": { "shape_name": "Boolean", "type": "boolean", "documentation": " \n " } }, "documentation": "\n\t\tIndicates whether DNS resolution is supported for the VPC. If\n\t\t\t\tthis attribute is true, the Amazon DNS server resolves DNS\n\t\t\t\thostnames for your instances to their corresponding IP addresses;\n\t\t\t\totherwise, it does not.
Indicates whether the instances launched in the VPC get DNS\n\t\t\t\thostnames. If this attribute is true, instances in the VPC\n\t\t\t\tget DNS hostnames; otherwise, they do not.
You can only set enableDnsHostnames to true if you also\n\t\t\t\tset the EnableDnsSupport attribute to true.
Modifies the specified attribute of the specified VPC.
\nOne or more instance IDs.
\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": "\nThe ID of the instance.
\n ", "xmlname": "instanceId" }, "Monitoring": { "shape_name": "Monitoring", "type": "structure", "members": { "State": { "shape_name": "MonitoringState", "type": "string", "enum": [ "disabled", "enabled", "pending" ], "documentation": "\nIndicates whether monitoring is enabled for the instance.
\n ", "xmlname": "state" } }, "documentation": "\nThe monitoring information.
\n ", "xmlname": "monitoring" } }, "documentation": "\nDescribes the monitoring information of the instance.
\n ", "xmlname": "item" }, "documentation": "\nMonitoring information for one or more instances.
\n ", "xmlname": "instancesSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nEnables monitoring for a running instance. For more information about monitoring instances,\n\t\t\tsee Monitoring Your Instances and Volumes\n\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the Reserved Instance offering to purchase.
\n ", "required": true }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe number of Reserved Instances to purchase.
\n ", "required": true }, "LimitPrice": { "shape_name": "ReservedInstanceLimitPrice", "type": "structure", "members": { "Amount": { "shape_name": "Double", "type": "double", "documentation": "\nUsed for Reserved Instance Marketplace offerings. Specifies the limit price on the total order\n\t\t\t\t(instanceCount * price).
\n " }, "CurrencyCode": { "shape_name": "CurrencyCodeValues", "type": "string", "enum": [ "USD" ], "documentation": "\nThe currency in which the limitPrice amount is specified.\n\t\t\t\tAt this time, the only supported currency is USD.
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.
\n " } }, "documentation": "\n " }, "output": { "shape_name": "PurchaseReservedInstancesOfferingResult", "type": "structure", "members": { "ReservedInstancesId": { "shape_name": "String", "type": "string", "documentation": "\nThe IDs of the purchased Reserved Instances.
\n ", "xmlname": "reservedInstancesId" } }, "documentation": "\n " }, "errors": [], "documentation": "\nPurchases 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.
\nFor more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nOne or more instance IDs.
\n ", "required": true, "flattened": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\t\tRequests 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.
\n\t\t\tIf a Linux/Unix instance does not cleanly shut down within four minutes,\n\t\t\t\tAmazon EC2 performs a hard reboot.
\nThe full path to your AMI manifest in Amazon S3 storage.
\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nA name for your AMI.
\nConstraints: 3-128 alphanumeric characters, parenthesis (()),\n\t\t\t\tcommas (,), slashes (/), dashes (-), or underscores (_)
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\nA description for your AMI.
\n " }, "Architecture": { "shape_name": "ArchitectureValues", "type": "string", "enum": [ "i386", "x86_64" ], "documentation": "\nThe architecture of the AMI.
\nDefault: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.
The ID of the kernel.
\n " }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the RAM disk.
\n " }, "RootDeviceName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the root device (for example, /dev/sda1, or\n\t\t\t\txvda).
The virtual device name.
\n " }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n " }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n " }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n " }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": "\nThe volume type.
\nDefault: standard
The number of I/O operations per second (IOPS) that the\n volume supports.
\nConstraint: Range is 100 to 4000.
\nCondition: Required when the volume type is io1; not used with standard volumes.
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n " }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n " } }, "documentation": "\nDescribes a block device mapping.
\n ", "xmlname": "BlockDeviceMapping" }, "documentation": "\nOne or more block device mapping entries.
\n ", "flattened": true }, "VirtualizationType": { "shape_name": "String", "type": "string", "documentation": "The type of virtualization", "enum": [ "paravirtual", "hvm" ] }, "SriovNetSupport": { "shape_name": "String", "type": "string", "documentation": "\nSet to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.
The ID of the newly registered AMI.
\n ", "xmlname": "imageId" } }, "documentation": "\n " }, "errors": [], "documentation": " \nRegisters 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 Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.
\nFor Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.
You can also use RegisterImage 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\tLaunching an\n\t\t\t\t\tInstance from a Snapshot in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.
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.
\nYou can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.
my-new-image.manifest.xml manifest file, located in the bucket\n\t\t\t\t\tcalled myawsbucket.[EC2-Classic] The Elastic IP address.
\n " }, "AllocationId": { "shape_name": "String", "type": "string", "documentation": "\n[EC2-VPC] The allocation ID.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nReleases the specified Elastic IP address.
\nAfter 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\tAuthFailure error if the address is already allocated to\n\t\t\t\tanother AWS account.
[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 DisassociateAddress.
\n[Nondefault VPC] You must use the DisassociateAddress 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 (InvalidIPAddress.InUse).
The ID of the current association between the original\n\t\t\t\tnetwork ACL and the subnet.
\n ", "required": true }, "NetworkAclId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the new ACL to associate with the subnet.
\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "ReplaceNetworkAclAssociationResult", "type": "structure", "members": { "NewAssociationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the new association.
\n ", "xmlname": "newAssociationId" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tChanges 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 Network\n\t\t\t\tACLs in the Amazon Virtual Private Cloud User Guide.
\naclassoc-e5b95c8c. You want to associate a\n\t\t\t\t\tdifferent network ACL (acl-5fb85d36) with the subnet. The result is a new\n\t\t\t\t\tassociation ID representing the new association.The ID of the ACL.
\n ", "required": true }, "RuleNumber": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe rule number of the entry to replace.
\n ", "required": true }, "Protocol": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe IP protocol. You can specify all or -1 to mean all protocols.
Indicates whether to allow or deny the traffic that matches the rule.
\n ", "required": true }, "Egress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether to replace the egress rule.
\n\t\tDefault: If no value is specified, we replace the ingress rule.
\n ", "required": true }, "CidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe network range to allow or deny, in CIDR notation.
\n ", "required": true }, "IcmpTypeCode": { "shape_name": "IcmpTypeCode", "type": "structure", "members": { "Type": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe ICMP code. A value of -1 means all codes for the specified ICMP type.
\n " }, "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe ICMP type. A value of -1 means all types.
\n " } }, "documentation": "\n\t\tICMP protocol: The ICMP type and code.
\n ", "xmlname": "Icmp" }, "PortRange": { "shape_name": "PortRange", "type": "structure", "members": { "From": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe first port in the range.
\n " }, "To": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe last port in the range.
\n " } }, "documentation": "\n\t\tTCP or UDP protocols: The range of ports the rule applies to.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tReplaces an entry (rule) in a network ACL. For more information about network ACLs,\n\t\t\t\tsee Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\n110 in the network ACL with ID\n\t\t\t\t\tacl-2cb85d45. The new rule denies egress traffic destined for anywhere\n\t\t\t\t\t(0.0.0.0/0) on TCP port 139.The ID of the route table.
\n ", "required": true }, "DestinationCidrBlock": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe 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.
\n ", "required": true }, "GatewayId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of an Internet gateway attached to your VPC.
\n " }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of a NAT instance in your VPC.
\n " }, "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of a network interface.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tReplaces 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, or network interface.
\n\t\tFor more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
\n10.0.0.0/8 and sends the traffic to the virtual private gateway with\n\t\t\t\t\tthe ID vgw-1d00376e.The association ID.
\n ", "required": true }, "RouteTableId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the new route table to associate with the subnet.
\n ", "required": true } }, "documentation": "\n " }, "output": { "shape_name": "ReplaceRouteTableAssociationResult", "type": "structure", "members": { "NewAssociationId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the new association.
\n ", "xmlname": "newAssociationId" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\tChanges 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 Route Tables in the Amazon Virtual Private Cloud User Guide.
\nYou 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.
\nrtbassoc-f8ad4891. You want to associate a\n\t\t\t\t\tdifferent route table (table rtb-f9ad4890) to the subnet. The result is a new\n\t\t\t\t\tassociation ID representing the new association.One or more instances.
\n ", "flattened": true }, "Status": { "shape_name": "ReportStatusType", "type": "string", "enum": [ "ok", "impaired" ], "documentation": "\nThe status of all instances listed.
\n " }, "StartTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time at which the reported instance health state began.
\n " }, "EndTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time at which the reported instance health state ended.
\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": "\nOne or more reason codes that describes the health state of your instance.
\ninstance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems which I believe are network related.
performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
Descriptive text about the health state of your instance.
\n " } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\t\tSubmits feedback about the status of an instance. The instance\n\t\t\t\tmust be in the running state. If your experience\n\t\t\t\twith the instance differs from the instance status returned by\n\t\t\t\tDescribeInstanceStatus, use ReportInstanceStatus\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.
The maximum hourly price for any Spot Instance launched to fulfill the request.
\n ", "required": true }, "InstanceCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe maximum number of Spot Instances to launch.
\nDefault: 1
\n " }, "Type": { "shape_name": "SpotInstanceType", "type": "string", "enum": [ "one-time", "persistent" ], "documentation": "\nThe Spot Instance request type.
\nDefault: one-time
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.
\nDefault: The request is effective indefinitely.
\n " }, "ValidUntil": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe 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.
\nDefault: The request is effective indefinitely.
\n " }, "LaunchGroup": { "shape_name": "String", "type": "string", "documentation": "\nThe instance launch group. Launch groups are Spot Instances that\n\t\t\t\tlaunch together and terminate together.
\nDefault: Instances are launched and terminated individually
\n " }, "AvailabilityZoneGroup": { "shape_name": "String", "type": "string", "documentation": "\nThe user-specified name for a logical grouping of bids.
\nWhen 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.
\nIf 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.
\nDefault: Instances are launched in any available Availability Zone.
\n " }, "LaunchSpecification": { "shape_name": "LaunchSpecification", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the AMI.
\n " }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the key pair.
\n " }, "UserData": { "shape_name": "String", "type": "string", "documentation": "\nThe Base64-encoded MIME user data to make available to the instances.
\n " }, "AddressingType": { "shape_name": "String", "type": "string", "documentation": "\n \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", "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" ], "documentation": "\nThe instance type.
\n " }, "Placement": { "shape_name": "SpotPlacement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone.
\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone group name.
\n " } }, "documentation": "\nThe placement information for the instance.
\n " }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the kernel.
\n " }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the RAM disk.
\n " }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappingList", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\nThe virtual device name.
\n " }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n " }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n " }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n " }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": "\nThe volume type.
\nDefault: standard
The number of I/O operations per second (IOPS) that the\n volume supports.
\nConstraint: Range is 100 to 4000.
\nCondition: Required when the volume type is io1; not used with standard volumes.
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n " }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n " } }, "documentation": "\nDescribes a block device mapping.
\n ", "xmlname": "BlockDeviceMapping" }, "documentation": "\nOne or more block device mapping entries.
\n ", "flattened": true }, "Monitoring": { "type": "structure", "members": { "Enabled": { "shape_name": "Boolean", "type": "boolean", "required": true, "documentation": "\nEnables monitoring for the instance.
\nDefault: Disabled
\n " } } }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the subnet in which to launch the Spot Instance.
\n " }, "NetworkInterfaces": { "shape_name": "InstanceNetworkInterfaceSpecificationList", "type": "list", "members": { "shape_name": "InstanceNetworkInterfaceSpecification", "type": "structure", "members": { "NetworkInterfaceId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the network interface.
\n " }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe index of the device on the instance for the network interface attachment.
\n " }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the subnet associated with the network string.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe description of the network interface.
\n " }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe private IP address of the network interface.
\n " }, "Groups": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": "\n\t\tThe IDs of the security groups for the network interface.
\n ", "flattened": true }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIf set to true, the interface is deleted when the instance is terminated.
The private IP addresses.
\n ", "required": true }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the private IP address is the primary private IP address.
\n " } }, "documentation": "\n\t\tDescribes a secondary private IP address for a network interface.
\n " }, "documentation": "\n\t\tOne or more private IP addresses to assign to the network interface.
\n ", "flattened": true }, "SecondaryPrivateIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe number of secondary private IP addresses.
\n " }, "AssociatePublicIpAddress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates 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.
\n " } }, "documentation": "\n\t\tDescribes a network interface.
\n ", "xmlname": "NetworkInterface" }, "documentation": "\nOne or more network interfaces.
\n ", "flattened": true }, "IamInstanceProfile": { "shape_name": "IamInstanceProfileSpecification", "type": "structure", "members": { "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the instance profile.
\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the instance profile.
\n " } }, "documentation": "\nThe IAM instance profile.
\n " }, "EbsOptimized": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates 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.
\nDefault: false
The launch specification.
\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": "\nThe ID of the Spot Instance request.
\n ", "xmlname": "spotInstanceRequestId" }, "SpotPrice": { "shape_name": "String", "type": "string", "documentation": "\nThe maximum hourly price for any Spot Instance launched to fulfill the request.
\n ", "xmlname": "spotPrice" }, "Type": { "shape_name": "SpotInstanceType", "type": "string", "enum": [ "one-time", "persistent" ], "documentation": "\nThe Spot Instance request type.
\n ", "xmlname": "type" }, "State": { "shape_name": "SpotInstanceState", "type": "string", "enum": [ "open", "active", "closed", "cancelled", "failed" ], "documentation": "\nThe 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 Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.
\n ", "xmlname": "state" }, "Fault": { "shape_name": "SpotInstanceStateFault", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\nThe reason code for the Spot Instance state change.
\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nThe message for the Spot Instance state change.
\n ", "xmlname": "message" } }, "documentation": "\nThe fault codes for the Spot Instance request, if any.
\n ", "xmlname": "fault" }, "Status": { "shape_name": "SpotInstanceStatus", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\nThe status code of the request.
\n ", "xmlname": "code" }, "UpdateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time of the most recent status update.
\n ", "xmlname": "updateTime" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nThe description for the status code for the Spot request.
\n ", "xmlname": "message" } }, "documentation": "\nThe status code and status message describing the Spot Instance request.
\n ", "xmlname": "status" }, "ValidFrom": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe 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.
\n ", "xmlname": "validFrom" }, "ValidUntil": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe 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.
\n ", "xmlname": "validUntil" }, "LaunchGroup": { "shape_name": "String", "type": "string", "documentation": "\nThe instance launch group. Launch groups are Spot Instances that launch\n\t\t\t\ttogether and terminate together.
\n ", "xmlname": "launchGroup" }, "AvailabilityZoneGroup": { "shape_name": "String", "type": "string", "documentation": "\nThe 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.
\n ", "xmlname": "availabilityZoneGroup" }, "LaunchSpecification": { "shape_name": "LaunchSpecification", "type": "structure", "members": { "ImageId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the AMI.
\n ", "xmlname": "imageId" }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the key pair.
\n ", "xmlname": "keyName" }, "SecurityGroups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group.
\n ", "xmlname": "item" }, "documentation": "\nOne or more security groups.
\n ", "xmlname": "groupSet" }, "UserData": { "shape_name": "String", "type": "string", "documentation": "\nThe Base64-encoded MIME user data to make available to the instances.
\n ", "xmlname": "userData" }, "AddressingType": { "shape_name": "String", "type": "string", "documentation": "\n \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", "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" ], "documentation": "\nThe instance type.
\n ", "xmlname": "instanceType" }, "Placement": { "shape_name": "SpotPlacement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone.
\n ", "xmlname": "availabilityZone" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone group name.
\n ", "xmlname": "groupName" } }, "documentation": "\nThe placement information for the instance.
\n ", "xmlname": "placement" }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the kernel.
\n ", "xmlname": "kernelId" }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the RAM disk.
\n ", "xmlname": "ramdiskId" }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappingList", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\nThe virtual device name.
\n ", "xmlname": "virtualName" }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n ", "xmlname": "snapshotId" }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n ", "xmlname": "volumeSize" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", "xmlname": "deleteOnTermination" }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": "\nThe volume type.
\nDefault: standard
The number of I/O operations per second (IOPS) that the\n volume supports.
\nConstraint: Range is 100 to 4000.
\nCondition: Required when the volume type is io1; not used with standard volumes.
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", "xmlname": "ebs" }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n ", "xmlname": "noDevice" } }, "documentation": "\nDescribes a block device mapping.
\n ", "xmlname": "item" }, "documentation": "\nOne or more block device mapping entries.
\n ", "xmlname": "blockDeviceMapping" }, "MonitoringEnabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nEnables monitoring for the instance.
\nDefault: Disabled
\n ", "xmlname": "monitoringEnabled" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the subnet in which to launch the Spot Instance.
\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\tThe ID of the network interface.
\n ", "xmlname": "networkInterfaceId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe index of the device on the instance for the network interface attachment.
\n ", "xmlname": "deviceIndex" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the subnet associated with the network string.
\n ", "xmlname": "subnetId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe description of the network interface.
\n ", "xmlname": "description" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe private IP address of the network interface.
\n ", "xmlname": "privateIpAddress" }, "Groups": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": "\n\t\tThe IDs of the security groups for the network interface.
\n ", "xmlname": "SecurityGroupId" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIf set to true, the interface is deleted when the instance is terminated.
The private IP addresses.
\n ", "required": true, "xmlname": "privateIpAddress" }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the private IP address is the primary private IP address.
\n ", "xmlname": "primary" } }, "documentation": "\n\t\tDescribes a secondary private IP address for a network interface.
\n ", "xmlname": "item" }, "documentation": "\n\t\tOne or more private IP addresses to assign to the network interface.
\n ", "xmlname": "privateIpAddressesSet" }, "SecondaryPrivateIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe number of secondary private IP addresses.
\n ", "xmlname": "secondaryPrivateIpAddressCount" }, "AssociatePublicIpAddress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates 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.
\n ", "xmlname": "associatePublicIpAddress" } }, "documentation": "\n\t\tDescribes a network interface.
\n ", "xmlname": "item" }, "documentation": "\nOne or more network interfaces.
\n ", "xmlname": "networkInterfaceSet" }, "IamInstanceProfile": { "shape_name": "IamInstanceProfileSpecification", "type": "structure", "members": { "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the instance profile.
\n ", "xmlname": "arn" }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the instance profile.
\n ", "xmlname": "name" } }, "documentation": "\nThe IAM instance profile.
\n ", "xmlname": "iamInstanceProfile" }, "EbsOptimized": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates 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.
\nDefault: false
Additional information for launching instances.
\n ", "xmlname": "launchSpecification" }, "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe instance ID, if an instance has been launched to fulfill the Spot Instance\n\t\t\t\trequest.
\n ", "xmlname": "instanceId" }, "CreateTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when the Spot Instance request was created.
\n ", "xmlname": "createTime" }, "ProductDescription": { "shape_name": "RIProductDescription", "type": "string", "enum": [ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ], "documentation": "\nThe product description associated with the Spot Instance.
\n ", "xmlname": "productDescription" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the resource.
\n ", "xmlname": "tagSet" }, "LaunchedAvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone in which the bid is launched.
\n ", "xmlname": "launchedAvailabilityZone" } }, "documentation": "\nDescribe a Spot Instance request.
\n ", "xmlname": "item" }, "documentation": "\nInformation about the Spot Instance request.
\n ", "xmlname": "spotInstanceRequestSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\nCreates 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 Spot\n\t\t\t\tInstances in the Amazon Elastic Compute Cloud User Guide.
\nm1.small\n\t\t\t\t\tinstances and associates an IAM instance profile called s3access\n\t\t\t\t\twith them.pending-evaluation\n The ID of the AMI.
\n ", "required": true }, "Attribute": { "shape_name": "ResetImageAttributeName", "type": "string", "enum": [ "launchPermission" ], "documentation": "\nThe attribute to reset (currently you can only reset the launch\n\t\t\t\tpermission attribute).
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": " \nResets an attribute of an AMI to its default value.
\nlaunchPermission attribute for the\n\t\t\t\t\tspecified AMI.The ID of the instance.
\n ", "required": true }, "Attribute": { "shape_name": "InstanceAttributeName", "type": "string", "enum": [ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized" ], "documentation": "\nThe attribute to reset.
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\t\tResets 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\tSourceDestCheck, the instance can be either running or stopped.
The SourceDestCheck attribute controls whether\n\t\t\t\tsource/destination checking is enabled. The default value is\n\t\t\t\ttrue, which means checking is enabled. This value must be\n\t\t\t\tfalse for a NAT instance to perform NAT. For more information, see\n\t\t\t\tNAT Instances in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
sourceDestCheck attribute.The ID of the network interface.
\n ", "required": true }, "SourceDestCheck": { "shape_name": "String", "type": "string", "documentation": "\n\t\tIndicates whether source/destination checking is enabled. A value\n\t\t\t\tof true means checking is enabled, and\n\t\t\t\tfalse means checking is disabled. This value\n\t\t\t\tmust be false for a NAT instance to perform NAT.
Resets a network interface attribute. You can specify only one attribute at a time.
\nsourceDestCheck attribute for the \n\t\t\t\t specified network interface.The ID of the snapshot.
\n ", "required": true }, "Attribute": { "shape_name": "SnapshotAttributeName", "type": "string", "enum": [ "productCodes", "createVolumePermission" ], "documentation": "\nThe attribute to reset (currently only the attribute for permission to create volumes can be\n reset).
\n ", "required": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nResets permission settings for the specified snapshot.
\nFor more information on modifying snapshot permissions, see Sharing Snapshots in the\n Amazon Elastic Compute Cloud User Guide.
\nsnap-1a2b3c4d, making it a\n private snapshot that can only be used by the account that created it.The ID of the security group.
\n ", "required": true }, "SourceSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n[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.
\n " }, "SourceSecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the source security group. You can't specify a source security group and a CIDR IP address range.
\n " }, "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\nThe IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
\n " }, "IpPermissions": { "shape_name": "IpPermissionList", "type": "list", "members": { "shape_name": "IpPermission", "type": "structure", "members": { "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe protocol.
\n\t\tWhen you call DescribeSecurityGroups, 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, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.
The ID of an AWS account.
\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group owned by the specified AWS account.
\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group in the specified AWS account.
\n " } }, "documentation": "\nDescribes a security group and AWS account ID pair for EC2-Classic.
\n ", "xmlname": "Groups" }, "documentation": "\n\t\tOne or more security group and AWS account ID pairs.
\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\tThe CIDR range. You can either specify a CIDR range or a source security group, not both.
\n " } }, "documentation": "\n\t\tDescribes an IP range.
\n " }, "documentation": "\n\t\tOne or more IP ranges.
\n ", "flattened": true } }, "documentation": "\n\t\tDescribes a security group rule.
\n " }, "documentation": "\n \n ", "flattened": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nRemoves 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.
\nEach 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.
\nRule changes are propagated to instances within the security group as quickly as\n\t\t\t\tpossible. However, a small delay might occur.
\n205.192.0.0/16 and 205.159.0.0/16\n\t\t\t\t\taddress ranges on TCP port 80.sg-9a8d7f5c on TCP\tport 1433.[EC2-Classic, default VPC] The name of the security group.
\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n " }, "SourceSecurityGroupName": { "shape_name": "String", "type": "string", "documentation": "\n[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.
\n " }, "SourceSecurityGroupOwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the source security group. You can't specify a source security group and a CIDR IP address range.
\n " }, "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\nThe IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
\n " }, "IpPermissions": { "shape_name": "IpPermissionList", "type": "list", "members": { "shape_name": "IpPermission", "type": "structure", "members": { "IpProtocol": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe protocol.
\n\t\tWhen you call DescribeSecurityGroups, 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, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.
The ID of an AWS account.
\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group owned by the specified AWS account.
\n " }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group in the specified AWS account.
\n " } }, "documentation": "\nDescribes a security group and AWS account ID pair for EC2-Classic.
\n ", "xmlname": "Groups" }, "documentation": "\n\t\tOne or more security group and AWS account ID pairs.
\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\tThe CIDR range. You can either specify a CIDR range or a source security group, not both.
\n " } }, "documentation": "\n\t\tDescribes an IP range.
\n " }, "documentation": "\n\t\tOne or more IP ranges.
\n ", "flattened": true } }, "documentation": "\n\t\tDescribes a security group rule.
\n " }, "documentation": "\n \n ", "flattened": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\nRemoves 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.
\nEach 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.
\nRule changes are propagated to instances within the security group as quickly as\n\t\t\t\tpossible. However, a small delay might occur.
\n205.192.0.0/16 address range\n\t\t\t\t\tfor the security group named websrv. If the security group is for\n\t\t\t\t\ta VPC, specify the ID of the security group instead of the name.The ID of the AMI, which you can get by calling DescribeImages.
\n ", "required": true }, "MinCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe 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.
\nConstraints: 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 How\n many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
\n ", "required": true }, "MaxCount": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe 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 MinCount.
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 How\n many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
\n ", "required": true }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
\nIf you launch an instance without specifying a key pair, you can't connect to the instance.
\n[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use\n security group IDs instead.
\nDefault: Amazon EC2 uses the default security group.
\n ", "flattened": true }, "SecurityGroupIds": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": "\nOne or more security group IDs. You can create a security group using CreateSecurityGroup.
\nDefault: Amazon EC2 uses the default security group.
\n ", "flattened": true }, "UserData": { "shape_name": "String", "type": "blob", "documentation": "\nThe 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.
\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", "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" ], "documentation": "\nThe instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
\nDefault: m1.small
The Availability Zone of the instance.
\n " }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the placement group the instance is in (for cluster compute instances).
\n " }, "Tenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\nThe tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of dedicated runs\n on single-tenant hardware.
The placement for the instance.
\n " }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the kernel.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more information,\n see \n PV-GRUB: A New Amazon Kernel Image in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the RAM disk.
\n " }, "BlockDeviceMappings": { "shape_name": "BlockDeviceMappingRequestList", "type": "list", "members": { "shape_name": "BlockDeviceMapping", "type": "structure", "members": { "VirtualName": { "shape_name": "String", "type": "string", "documentation": "\nThe virtual device name.
\n " }, "DeviceName": { "shape_name": "String", "type": "string", "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n " }, "VolumeSize": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n " }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n " }, "VolumeType": { "shape_name": "VolumeType", "type": "string", "enum": [ "standard", "io1" ], "documentation": "\nThe volume type.
\nDefault: standard
The number of I/O operations per second (IOPS) that the\n volume supports.
\nConstraint: Range is 100 to 4000.
\nCondition: Required when the volume type is io1; not used with standard volumes.
Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n " }, "NoDevice": { "shape_name": "String", "type": "string", "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n " } }, "documentation": "\nDescribes a block device mapping.
\n ", "xmlname": "BlockDeviceMapping" }, "documentation": "\nThe block device mapping.
\n ", "flattened": true }, "Monitoring": { "shape_name": "RunInstancesMonitoringEnabled", "type": "structure", "members": { "Enabled": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether monitoring is enabled for the instance.
\n ", "required": true } }, "documentation": "\nThe monitoring for the instance.
\n " }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n[EC2-VPC] The ID of the subnet to launch the instance into.
\n " }, "DisableApiTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIf you set this parameter to true, you can't terminate the instance using the Amazon EC2\n console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want\n to be able to terminate the instance, you must first change the value of the\n disableApiTermination attribute to false using\n ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate,\n you can terminate the instance by running the shutdown command from the instance.
Default: false
Indicates whether an instance stops or terminates when you initiate\n shutdown from the instance (using the operating system command for system shutdown).
\nDefault: stop
[EC2-VPC] The primary IP address. You must specify a value\n from the IP address range of the subnet.
\nOnly one private IP address can be designated as primary.\n Therefore, you can't specify this parameter if\n PrivateIpAddresses.n.Primary is set to\n true and PrivateIpAddresses.n.PrivateIpAddress\n is set to an IP address.
Default: We select an IP address from the IP address range of the subnet.
\n " }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": "\nUnique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information,\n see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
\nConstraints: Maximum 64 ASCII characters
\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\tThe ID of the network interface.
\n " }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe index of the device on the instance for the network interface attachment.
\n " }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the subnet associated with the network string.
\n " }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe description of the network interface.
\n " }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe private IP address of the network interface.
\n " }, "Groups": { "shape_name": "SecurityGroupIdStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "SecurityGroupId" }, "documentation": "\n\t\tThe IDs of the security groups for the network interface.
\n ", "flattened": true }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIf set to true, the interface is deleted when the instance is terminated.
The private IP addresses.
\n ", "required": true }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the private IP address is the primary private IP address.
\n " } }, "documentation": "\n\t\tDescribes a secondary private IP address for a network interface.
\n ", "xmlname": "PrivateIpAddresses" }, "documentation": "\n\t\tOne or more private IP addresses to assign to the network interface.
\n ", "flattened": true }, "SecondaryPrivateIpAddressCount": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe number of secondary private IP addresses.
\n " }, "AssociatePublicIpAddress": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates 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.
\n " } }, "documentation": "\n\t\tDescribes a network interface.
\n ", "xmlname": "NetworkInterface" }, "documentation": "\nOne or more network interfaces.
\n ", "flattened": true }, "IamInstanceProfile": { "shape_name": "IamInstanceProfileSpecification", "type": "structure", "members": { "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the instance profile.
\n " }, "Name": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the instance profile.
\n " } }, "documentation": "\nThe IAM instance profile.
\n " }, "EbsOptimized": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates 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.
\nDefault: false
The ID of the reservation.
\n ", "xmlname": "reservationId" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the AWS account that owns the reservation.
\n ", "xmlname": "ownerId" }, "RequesterId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the requester that launched the instances on your behalf (for example,\n\t\t\t\tAWS Management Console or Auto Scaling).
\n ", "xmlname": "requesterId" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group.
\n ", "xmlname": "item" }, "documentation": "\nOne or more security groups.
\n ", "xmlname": "groupSet" }, "Instances": { "shape_name": "InstanceList", "type": "list", "members": { "shape_name": "Instance", "type": "structure", "members": { "InstanceId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance.
\n ", "xmlname": "instanceId" }, "ImageId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the AMI used to launch the instance.
\n ", "xmlname": "imageId" }, "State": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", "xmlname": "name" } }, "documentation": "\nThe current state of the instance.
\n ", "xmlname": "instanceState" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\nThe 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 running state.
The public DNS name assigned to the instance.\n\t\t\t\tThis name is not available until the instance enters the running state.
The reason for the most recent state transition. This might be an empty string.
\n ", "xmlname": "reason" }, "KeyName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the key pair, if this instance was launched with an associated key pair.
\n ", "xmlname": "keyName" }, "AmiLaunchIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe AMI launch index, which can be used to find this instance in the launch group.
\n ", "xmlname": "amiLaunchIndex" }, "ProductCodes": { "shape_name": "ProductCodeList", "type": "list", "members": { "shape_name": "ProductCode", "type": "structure", "members": { "ProductCodeId": { "shape_name": "String", "type": "string", "documentation": "\nThe product code.
\n ", "xmlname": "productCode" }, "ProductCodeType": { "shape_name": "ProductCodeValues", "type": "string", "enum": [ "devpay", "marketplace" ], "documentation": "\nThe type of product code.
\n ", "xmlname": "type" } }, "documentation": "\nDescribes a product code.
\n ", "xmlname": "item" }, "documentation": "\nThe product codes attached to this instance.
\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", "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" ], "documentation": "\nThe instance type.
\n ", "xmlname": "instanceType" }, "LaunchTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time the instance was launched.
\n ", "xmlname": "launchTime" }, "Placement": { "shape_name": "Placement", "type": "structure", "members": { "AvailabilityZone": { "shape_name": "String", "type": "string", "documentation": "\nThe Availability Zone of the instance.
\n ", "xmlname": "availabilityZone" }, "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the placement group the instance is in (for cluster compute instances).
\n ", "xmlname": "groupName" }, "Tenancy": { "shape_name": "Tenancy", "type": "string", "enum": [ "default", "dedicated" ], "documentation": "\nThe tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of dedicated runs\n on single-tenant hardware.
The location where the instance launched.
\n ", "xmlname": "placement" }, "KernelId": { "shape_name": "String", "type": "string", "documentation": "\nThe kernel associated with this instance.
\n ", "xmlname": "kernelId" }, "RamdiskId": { "shape_name": "String", "type": "string", "documentation": "\nThe RAM disk associated with this instance.
\n ", "xmlname": "ramdiskId" }, "Platform": { "shape_name": "PlatformValues", "type": "string", "enum": [ "Windows" ], "documentation": "\nThe value is Windows for Windows instances; otherwise blank.
Indicates whether monitoring is enabled for the instance.
\n ", "xmlname": "state" } }, "documentation": "\nThe monitoring information for the instance.
\n ", "xmlname": "monitoring" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the subnet in which the instance is running.
\n ", "xmlname": "subnetId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the VPC in which the instance is running.
\n ", "xmlname": "vpcId" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\nThe private IP address assigned to the instance.
\n ", "xmlname": "privateIpAddress" }, "PublicIpAddress": { "shape_name": "String", "type": "string", "documentation": "\nThe public IP address assigned to the instance.
\n ", "xmlname": "ipAddress" }, "StateReason": { "shape_name": "StateReason", "type": "structure", "members": { "Code": { "shape_name": "String", "type": "string", "documentation": "\nThe reason code for the state change.
\n ", "xmlname": "code" }, "Message": { "shape_name": "String", "type": "string", "documentation": "\nThe message for the state change.
\nServer.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.
Server.InternalError: An internal error occurred during instance launch, resulting in termination.
Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.
Client.InternalError: A client error caused the instance to terminate on launch.
Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.
Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The volume limit was exceeded.
Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
The reason for the most recent state transition.
\n ", "xmlname": "stateReason" }, "Architecture": { "shape_name": "ArchitectureValues", "type": "string", "enum": [ "i386", "x86_64" ], "documentation": "\nThe architecture of the image.
\n ", "xmlname": "architecture" }, "RootDeviceType": { "shape_name": "DeviceType", "type": "string", "enum": [ "ebs", "instance-store" ], "documentation": "\nThe root device type used by the AMI. The AMI can use an Amazon EBS volume\n or an instance store volume.
\n ", "xmlname": "rootDeviceType" }, "RootDeviceName": { "shape_name": "String", "type": "string", "documentation": "\nThe root device name (for example, /dev/sda1).
The device name exposed to the instance (for example,
The ID of the Amazon EBS volume.
\n ", "xmlname": "volumeId" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\nThe attachment state.
\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\nThe time stamp when the attachment initiated.
\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates whether the volume is deleted on instance termination.
\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", "xmlname": "ebs" } }, "documentation": "\nDescribes a block device mapping.
\n ", "xmlname": "item" }, "documentation": "\nAny block device mapping entries for the instance.
\n ", "xmlname": "blockDeviceMapping" }, "VirtualizationType": { "shape_name": "VirtualizationType", "type": "string", "enum": [ "hvm", "paravirtual" ], "documentation": "\nThe virtualization type of the instance.
\n ", "xmlname": "virtualizationType" }, "InstanceLifecycle": { "shape_name": "InstanceLifecycleType", "type": "string", "enum": [ "spot" ], "documentation": "\nIndicates whether this is a Spot Instance.
\n ", "xmlname": "instanceLifecycle" }, "SpotInstanceRequestId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the Spot Instance request.
\n ", "xmlname": "spotInstanceRequestId" }, "ClientToken": { "shape_name": "String", "type": "string", "documentation": "\nThe idempotency token you provided when you launched the instance.
\n ", "xmlname": "clientToken" }, "Tags": { "shape_name": "TagList", "type": "list", "members": { "shape_name": "Tag", "type": "structure", "members": { "Key": { "shape_name": "String", "type": "string", "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", "xmlname": "value" } }, "documentation": "\nDescribes a tag.
\n ", "xmlname": "item" }, "documentation": "\nAny tags assigned to the instance.
\n ", "xmlname": "tagSet" }, "SecurityGroups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group.
\n ", "xmlname": "item" }, "documentation": "\nOne or more security groups for the instance.
\n ", "xmlname": "groupSet" }, "SourceDestCheck": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies 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 true means\n\t\t\t\tchecking is enabled, and false means checking is\n\t\t\t\tdisabled. The value must be false for the instance\n\t\t\t\tto perform NAT. For more information, see NAT\n\t\t\t\tInstances in the Amazon Virtual Private Cloud User Guide.
The hypervisor type of the instance.
\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\tThe ID of the network interface.
\n ", "xmlname": "networkInterfaceId" }, "SubnetId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the subnet.
\n ", "xmlname": "subnetId" }, "VpcId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the VPC.
\n ", "xmlname": "vpcId" }, "Description": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe description.
\n ", "xmlname": "description" }, "OwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the AWS account that created the network interface.
\n ", "xmlname": "ownerId" }, "Status": { "shape_name": "NetworkInterfaceStatus", "type": "string", "enum": [ "available", "attaching", "in-use", "detaching" ], "documentation": "\n\t\tThe status of the network interface.
\n ", "xmlname": "status" }, "PrivateIpAddress": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe IP address of the network interface within the subnet.
\n ", "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe private DNS name.
\n ", "xmlname": "privateDnsName" }, "SourceDestCheck": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether to validate network traffic to or from this network interface.
\n ", "xmlname": "sourceDestCheck" }, "Groups": { "shape_name": "GroupIdentifierList", "type": "list", "members": { "shape_name": "GroupIdentifier", "type": "structure", "members": { "GroupName": { "shape_name": "String", "type": "string", "documentation": "\nThe name of the security group.
\n ", "xmlname": "groupName" }, "GroupId": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the security group.
\n ", "xmlname": "groupId" } }, "documentation": "\nDescribes a security group.
\n ", "xmlname": "item" }, "documentation": "\n\t\tOne or more security groups.
\n ", "xmlname": "groupSet" }, "Attachment": { "shape_name": "InstanceNetworkInterfaceAttachment", "type": "structure", "members": { "AttachmentId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the network interface attachment.
\n ", "xmlname": "attachmentId" }, "DeviceIndex": { "shape_name": "Integer", "type": "integer", "documentation": "\n\t\tThe index of the device on the instance for the network interface attachment.
\n ", "xmlname": "deviceIndex" }, "Status": { "shape_name": "AttachmentStatus", "type": "string", "enum": [ "attaching", "attached", "detaching", "detached" ], "documentation": "\n\t\tThe attachment state.
\n ", "xmlname": "status" }, "AttachTime": { "shape_name": "DateTime", "type": "timestamp", "documentation": "\n\t\tThe time stamp when the attachment initiated.
\n ", "xmlname": "attachTime" }, "DeleteOnTermination": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether the network interface is deleted when the instance is terminated.
\n ", "xmlname": "deleteOnTermination" } }, "documentation": "\n\t\tThe network interface attachment.
\n ", "xmlname": "attachment" }, "Association": { "shape_name": "InstanceNetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", "xmlname": "publicIp" }, "PublicDnsName": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe public DNS name.
\n ", "xmlname": "publicDnsName" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the owner of the Elastic IP address.
\n ", "xmlname": "ipOwnerId" } }, "documentation": "\n\t\tThe association information for an Elastic IP associated with the network interface.
\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\tThe private IP address of the network interface.
\n ", "xmlname": "privateIpAddress" }, "PrivateDnsName": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe private DNS name.
\n ", "xmlname": "privateDnsName" }, "Primary": { "shape_name": "Boolean", "type": "boolean", "documentation": "\n\t\tIndicates whether this IP address is the primary private IP address \n\t\t of the network interface.
\n ", "xmlname": "primary" }, "Association": { "shape_name": "InstanceNetworkInterfaceAssociation", "type": "structure", "members": { "PublicIp": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", "xmlname": "publicIp" }, "PublicDnsName": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe public DNS name.
\n ", "xmlname": "publicDnsName" }, "IpOwnerId": { "shape_name": "String", "type": "string", "documentation": "\n\t\tThe ID of the owner of the Elastic IP address.
\n ", "xmlname": "ipOwnerId" } }, "documentation": "\n\t\tThe association information for an Elastic IP address for the network interface.
\n ", "xmlname": "association" } }, "documentation": "\n\t\tDescribes a private IP address.
\n ", "xmlname": "item" }, "documentation": "\n\t\tThe private IP addresses associated with the network interface.
\n ", "xmlname": "privateIpAddressesSet" } }, "documentation": "\n\t\tDescribes a network interface.
\n ", "xmlname": "item" }, "documentation": "\n[EC2-VPC] One or more network interfaces for the instance.
\n ", "xmlname": "networkInterfaceSet" }, "IamInstanceProfile": { "shape_name": "IamInstanceProfile", "type": "structure", "members": { "Arn": { "shape_name": "String", "type": "string", "documentation": "\nThe Amazon Resource Name (ARN) of the instance profile.
\n ", "xmlname": "arn" }, "Id": { "shape_name": "String", "type": "string", "documentation": "\nThe ID of the instance profile.
\n ", "xmlname": "id" } }, "documentation": "\nThe IAM instance profile associated with the instance.
\n ", "xmlname": "iamInstanceProfile" }, "EbsOptimized": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nIndicates 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.
\n ", "xmlname": "ebsOptimized" }, "SriovNetSupport": { "shape_name": "String", "type": "string", "documentation": "\nSpecifies whether enhanced networking is enabled.
\n ", "xmlname": "sriovNetSupport" } }, "documentation": "\nDescribes an instance.
\n ", "xmlname": "item" }, "documentation": "\nOne or more instances.
\n ", "xmlname": "instancesSet" } }, "documentation": "\nOne or more reservations.
\n ", "xmlname": "reservation" }, "errors": [], "documentation": "\nLaunches the specified number of instances using an AMI for which you have permissions.
\nWhen you launch an instance, it enters the pending state.\n After the instance is ready for you, it enters the running state.\n To check the state of your instance, call DescribeInstances.
If you don't specify a security group when launching an instance, Amazon EC2 uses\n the default security group. For more information, see Security Groups\n in the Amazon Elastic Compute Cloud User Guide.
\n\nLinux 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 Key Pairs\n in the Amazon Elastic Compute Cloud User Guide.
\n\nYou can provide optional user data when launching an instance. For more\n information, see Instance\n Metadata in the Amazon Elastic Compute Cloud User Guide.
\n\n\t\tIf any of the AMIs have a product code attached for which the user has not\n\t\t\tsubscribed, RunInstances fails.
ami-60a54009.m1.small instance into a subnet.\n Because no network interface is specified, the default network interface is used.m1.large instance into a subnet.\n The network interface specifies a primary private IP address of 10.0.2.106\n and two secondary private IP addresses (10.0.2.107 and 10.0.2.108).m1.large instance with a block device\n mapping. There are two instance store volumes mapped to /dev/sdc and\n /dev/sdd, and a 100 GB Amazon EBS volume mapped to\n /dev/sdf.One or more instance IDs.
\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": "\nThe ID of the instance.
\n ", "xmlname": "instanceId" }, "CurrentState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", "xmlname": "name" } }, "documentation": "\nThe current state of the instance.
\n ", "xmlname": "currentState" }, "PreviousState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", "xmlname": "name" } }, "documentation": "\nThe previous state of the instance.
\n ", "xmlname": "previousState" } }, "documentation": "\nDescribes an instance state change.
\n ", "xmlname": "item" }, "documentation": "\nInformation about one or more started instances.
\n ", "xmlname": "instancesSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\t\tStarts an Amazon EBS-backed AMI that you've previously stopped.
\n\t\t\tInstances 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.
\n\t\t\tBefore 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.
\n\t\t\tPerforming this operation on an instance that uses an instance store as its\n\t\t\t\troot device returns an error.
\n\t\t\tFor more information, see Stopping Instances\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nOne or more instance IDs.
\n ", "required": true, "flattened": true }, "Force": { "shape_name": "Boolean", "type": "boolean", "documentation": "\nForces 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.
\nDefault: false
The ID of the instance.
\n ", "xmlname": "instanceId" }, "CurrentState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", "xmlname": "name" } }, "documentation": "\nThe current state of the instance.
\n ", "xmlname": "currentState" }, "PreviousState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", "xmlname": "name" } }, "documentation": "\nThe previous state of the instance.
\n ", "xmlname": "previousState" } }, "documentation": "\nDescribes an instance state change.
\n ", "xmlname": "item" }, "documentation": "\nInformation about one or more stopped instances.
\n ", "xmlname": "instancesSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\t\tStops 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.
\n\t\t\tYou can't start or stop Spot Instances.
\n\t\t\tInstances 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.
\n\t\t\tBefore 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.
\n\t\t\tPerforming this operation on an instance that uses an instance store as its\n\t\t\t\troot device returns an error.
\nYou 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 Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.
\nOne or more instance IDs.
\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": "\nThe ID of the instance.
\n ", "xmlname": "instanceId" }, "CurrentState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", "xmlname": "name" } }, "documentation": "\nThe current state of the instance.
\n ", "xmlname": "currentState" }, "PreviousState": { "shape_name": "InstanceState", "type": "structure", "members": { "Code": { "shape_name": "Integer", "type": "integer", "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", "xmlname": "name" } }, "documentation": "\nThe previous state of the instance.
\n ", "xmlname": "previousState" } }, "documentation": "\nDescribes an instance state change.
\n ", "xmlname": "item" }, "documentation": "\nInformation about one or more terminated instances.
\n ", "xmlname": "instancesSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\t\tShuts down one or more instances. This operation is idempotent; if you terminate\n\t\t\t\tan instance more than once, each call succeeds.
\n\t\t\tTerminated instances remain visible after termination (for approximately one\n\t\t\t\thour).
\n\t\t\tBy 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.
\nYou 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 Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the network interface.
\n ", "required": true }, "PrivateIpAddresses": { "shape_name": "PrivateIpAddressStringList", "type": "list", "members": { "shape_name": "String", "type": "string", "documentation": null, "xmlname": "PrivateIpAddress" }, "documentation": "\n\t\tThe 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.
\n ", "required": true, "flattened": true } }, "documentation": "\n " }, "output": null, "errors": [], "documentation": "\n\t\tUnassigns one or more secondary private IP addresses from a network interface.
\nOne or more instance IDs.
\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": "\nThe ID of the instance.
\n ", "xmlname": "instanceId" }, "Monitoring": { "shape_name": "Monitoring", "type": "structure", "members": { "State": { "shape_name": "MonitoringState", "type": "string", "enum": [ "disabled", "enabled", "pending" ], "documentation": "\nIndicates whether monitoring is enabled for the instance.
\n ", "xmlname": "state" } }, "documentation": "\nThe monitoring information.
\n ", "xmlname": "monitoring" } }, "documentation": "\nDescribes the monitoring information of the instance.
\n ", "xmlname": "item" }, "documentation": "\nMonitoring information for one or more instances.
\n ", "xmlname": "instancesSet" } }, "documentation": "\n " }, "errors": [], "documentation": "\n\t\t\tDisables monitoring for a running instance. For more information about monitoring\n\t\t\t\tinstances, see Monitoring Your\n\t\t\t\tInstances and Volumes in the Amazon Elastic Compute Cloud User Guide.
\n