universal-s3
Version:
Universal S3 SDK for JavaScript, available for Node.js backends
1,769 lines (1,757 loc) • 148 kB
JSON
{
"version": "1.0",
"examples": {
"AllocateAddress": [
{
"input": {
"Domain": "vpc"
},
"output": {
"AllocationId": "eipalloc-64d5890a",
"Domain": "vpc",
"PublicIp": "203.0.113.0"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example allocates an Elastic IP address to use with an instance in a VPC.",
"id": "ec2-allocate-address-1",
"title": "To allocate an Elastic IP address for EC2-VPC"
},
{
"output": {
"Domain": "standard",
"PublicIp": "198.51.100.0"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example allocates an Elastic IP address to use with an instance in EC2-Classic.",
"id": "ec2-allocate-address-2",
"title": "To allocate an Elastic IP address for EC2-Classic"
}
],
"AssignPrivateIpAddresses": [
{
"input": {
"NetworkInterfaceId": "eni-e5aa89a3",
"PrivateIpAddresses": [
"10.0.0.82"
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example assigns the specified secondary private IP address to the specified network interface.",
"id": "ec2-assign-private-ip-addresses-1",
"title": "To assign a specific secondary private IP address to an interface"
},
{
"input": {
"NetworkInterfaceId": "eni-e5aa89a3",
"SecondaryPrivateIpAddressCount": 2
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with.",
"id": "ec2-assign-private-ip-addresses-2",
"title": "To assign secondary private IP addresses that Amazon EC2 selects to an interface"
}
],
"AssociateAddress": [
{
"input": {
"AllocationId": "eipalloc-64d5890a",
"InstanceId": "i-0b263919b6498b123"
},
"output": {
"AssociationId": "eipassoc-2bebb745"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example associates the specified Elastic IP address with the specified instance in a VPC.",
"id": "ec2-associate-address-1",
"title": "To associate an Elastic IP address in EC2-VPC"
},
{
"input": {
"AllocationId": "eipalloc-64d5890a",
"NetworkInterfaceId": "eni-1a2b3c4d"
},
"output": {
"AssociationId": "eipassoc-2bebb745"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example associates the specified Elastic IP address with the specified network interface.",
"id": "ec2-associate-address-2",
"title": "To associate an Elastic IP address with a network interface"
},
{
"input": {
"InstanceId": "i-07ffe74c7330ebf53",
"PublicIp": "198.51.100.0"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example associates an Elastic IP address with an instance in EC2-Classic.",
"id": "ec2-associate-address-3",
"title": "To associate an Elastic IP address in EC2-Classic"
}
],
"AssociateDhcpOptions": [
{
"input": {
"DhcpOptionsId": "dopt-d9070ebb",
"VpcId": "vpc-a01106c2"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example associates the specified DHCP options set with the specified VPC.",
"id": "ec2-associate-dhcp-options-1",
"title": "To associate a DHCP options set with a VPC"
},
{
"input": {
"DhcpOptionsId": "default",
"VpcId": "vpc-a01106c2"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example associates the default DHCP options set with the specified VPC.",
"id": "ec2-associate-dhcp-options-2",
"title": "To associate the default DHCP options set with a VPC"
}
],
"AssociateIamInstanceProfile": [
{
"input": {
"IamInstanceProfile": {
"Name": "admin-role"
},
"InstanceId": "i-123456789abcde123"
},
"output": {
"IamInstanceProfileAssociation": {
"AssociationId": "iip-assoc-0e7736511a163c209",
"IamInstanceProfile": {
"Arn": "arn:aws:iam::123456789012:instance-profile/admin-role",
"Id": "AIPAJBLK7RKJKWDXVHIEC"
},
"InstanceId": "i-123456789abcde123",
"State": "associating"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example associates an IAM instance profile named admin-role with the specified instance.",
"id": "to-associate-an-iam-instance-profile-with-an-instance-1528928429850",
"title": "To associate an IAM instance profile with an instance"
}
],
"AssociateRouteTable": [
{
"input": {
"RouteTableId": "rtb-22574640",
"SubnetId": "subnet-9d4a7b6"
},
"output": {
"AssociationId": "rtbassoc-781d0d1a"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example associates the specified route table with the specified subnet.",
"id": "ec2-associate-route-table-1",
"title": "To associate a route table with a subnet"
}
],
"AttachInternetGateway": [
{
"input": {
"InternetGatewayId": "igw-c0a643a9",
"VpcId": "vpc-a01106c2"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example attaches the specified Internet gateway to the specified VPC.",
"id": "ec2-attach-internet-gateway-1",
"title": "To attach an Internet gateway to a VPC"
}
],
"AttachNetworkInterface": [
{
"input": {
"DeviceIndex": 1,
"InstanceId": "i-1234567890abcdef0",
"NetworkInterfaceId": "eni-e5aa89a3"
},
"output": {
"AttachmentId": "eni-attach-66c4350a"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example attaches the specified network interface to the specified instance.",
"id": "ec2-attach-network-interface-1",
"title": "To attach a network interface to an instance"
}
],
"AttachVolume": [
{
"input": {
"Device": "/dev/sdf",
"InstanceId": "i-01474ef662b89480",
"VolumeId": "vol-1234567890abcdef0"
},
"output": {
"AttachTime": "2016-08-29T18:52:32.724Z",
"Device": "/dev/sdf",
"InstanceId": "i-01474ef662b89480",
"State": "attaching",
"VolumeId": "vol-1234567890abcdef0"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example attaches a volume (``vol-1234567890abcdef0``) to an instance (``i-01474ef662b89480``) as ``/dev/sdf``.",
"id": "to-attach-a-volume-to-an-instance-1472499213109",
"title": "To attach a volume to an instance"
}
],
"AuthorizeSecurityGroupEgress": [
{
"input": {
"GroupId": "sg-1a2b3c4d",
"IpPermissions": [
{
"FromPort": 80,
"IpProtocol": "tcp",
"IpRanges": [
{
"CidrIp": "10.0.0.0/16"
}
],
"ToPort": 80
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example adds a rule that grants access to the specified address ranges on TCP port 80.",
"id": "to-add-a-rule-that-allows-outbound-traffic-to-a-specific-address-range-1528929309636",
"title": "To add a rule that allows outbound traffic to a specific address range"
},
{
"input": {
"GroupId": "sg-1a2b3c4d",
"IpPermissions": [
{
"FromPort": 80,
"IpProtocol": "tcp",
"ToPort": 80,
"UserIdGroupPairs": [
{
"GroupId": "sg-4b51a32f"
}
]
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example adds a rule that grants access to the specified security group on TCP port 80.",
"id": "to-add-a-rule-that-allows-outbound-traffic-to-a-specific-security-group-1528929760260",
"title": "To add a rule that allows outbound traffic to a specific security group"
}
],
"AuthorizeSecurityGroupIngress": [
{
"input": {
"GroupId": "sg-903004f8",
"IpPermissions": [
{
"FromPort": 22,
"IpProtocol": "tcp",
"IpRanges": [
{
"CidrIp": "203.0.113.0/24",
"Description": "SSH access from the LA office"
}
],
"ToPort": 22
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example enables inbound traffic on TCP port 22 (SSH). The rule includes a description to help you identify it later.",
"id": "to-add-a-rule-that-allows-inbound-ssh-traffic-1529011610328",
"title": "To add a rule that allows inbound SSH traffic from an IPv4 address range"
},
{
"input": {
"GroupId": "sg-111aaa22",
"IpPermissions": [
{
"FromPort": 80,
"IpProtocol": "tcp",
"ToPort": 80,
"UserIdGroupPairs": [
{
"Description": "HTTP access from other instances",
"GroupId": "sg-1a2b3c4d"
}
]
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example enables inbound traffic on TCP port 80 from the specified security group. The group must be in the same VPC or a peer VPC. Incoming traffic is allowed based on the private IP addresses of instances that are associated with the specified security group.",
"id": "to-add-a-rule-that-allows-inbound-http-traffic-from-another-security-group-1529012163168",
"title": "To add a rule that allows inbound HTTP traffic from another security group"
},
{
"input": {
"GroupId": "sg-123abc12 ",
"IpPermissions": [
{
"FromPort": 3389,
"IpProtocol": "tcp",
"Ipv6Ranges": [
{
"CidrIpv6": "2001:db8:1234:1a00::/64",
"Description": "RDP access from the NY office"
}
],
"ToPort": 3389
}
]
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example adds an inbound rule that allows RDP traffic from the specified IPv6 address range. The rule includes a description to help you identify it later.",
"id": "to-add-a-rule-with-a-description-1529012418116",
"title": "To add a rule that allows inbound RDP traffic from an IPv6 address range"
}
],
"CancelSpotFleetRequests": [
{
"input": {
"SpotFleetRequestIds": [
"sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
],
"TerminateInstances": true
},
"output": {
"SuccessfulFleetRequests": [
{
"CurrentSpotFleetRequestState": "cancelled_running",
"PreviousSpotFleetRequestState": "active",
"SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example cancels the specified Spot fleet request and terminates its associated Spot Instances.",
"id": "ec2-cancel-spot-fleet-requests-1",
"title": "To cancel a Spot fleet request"
},
{
"input": {
"SpotFleetRequestIds": [
"sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
],
"TerminateInstances": false
},
"output": {
"SuccessfulFleetRequests": [
{
"CurrentSpotFleetRequestState": "cancelled_terminating",
"PreviousSpotFleetRequestState": "active",
"SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example cancels the specified Spot fleet request without terminating its associated Spot Instances.",
"id": "ec2-cancel-spot-fleet-requests-2",
"title": "To cancel a Spot fleet request without terminating its Spot Instances"
}
],
"CancelSpotInstanceRequests": [
{
"input": {
"SpotInstanceRequestIds": [
"sir-08b93456"
]
},
"output": {
"CancelledSpotInstanceRequests": [
{
"SpotInstanceRequestId": "sir-08b93456",
"State": "cancelled"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example cancels a Spot Instance request.",
"id": "ec2-cancel-spot-instance-requests-1",
"title": "To cancel Spot Instance requests"
}
],
"ConfirmProductInstance": [
{
"input": {
"InstanceId": "i-1234567890abcdef0",
"ProductCode": "774F4FF8"
},
"output": {
"OwnerId": "123456789012"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example determines whether the specified product code is associated with the specified instance.",
"id": "to-confirm-the-product-instance-1472712108494",
"title": "To confirm the product instance"
}
],
"CopyImage": [
{
"input": {
"Description": "",
"Name": "My server",
"SourceImageId": "ami-5731123e",
"SourceRegion": "us-east-1"
},
"output": {
"ImageId": "ami-438bea42"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example copies the specified AMI from the us-east-1 region to the current region.",
"id": "to-copy-an-ami-to-another-region-1529022820832",
"title": "To copy an AMI to another region"
}
],
"CopySnapshot": [
{
"input": {
"Description": "This is my copied snapshot.",
"DestinationRegion": "us-east-1",
"SourceRegion": "us-west-2",
"SourceSnapshotId": "snap-066877671789bd71b"
},
"output": {
"SnapshotId": "snap-066877671789bd71b"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example copies a snapshot with the snapshot ID of ``snap-066877671789bd71b`` from the ``us-west-2`` region to the ``us-east-1`` region and adds a short description to identify the snapshot.",
"id": "to-copy-a-snapshot-1472502259774",
"title": "To copy a snapshot"
}
],
"CreateCustomerGateway": [
{
"input": {
"BgpAsn": 65534,
"PublicIp": "12.1.2.3",
"Type": "ipsec.1"
},
"output": {
"CustomerGateway": {
"BgpAsn": "65534",
"CustomerGatewayId": "cgw-0e11f167",
"IpAddress": "12.1.2.3",
"State": "available",
"Type": "ipsec.1"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a customer gateway with the specified IP address for its outside interface.",
"id": "ec2-create-customer-gateway-1",
"title": "To create a customer gateway"
}
],
"CreateDhcpOptions": [
{
"input": {
"DhcpConfigurations": [
{
"Key": "domain-name-servers",
"Values": [
"10.2.5.1",
"10.2.5.2"
]
}
]
},
"output": {
"DhcpOptions": {
"DhcpConfigurations": [
{
"Key": "domain-name-servers",
"Values": [
{
"Value": "10.2.5.2"
},
{
"Value": "10.2.5.1"
}
]
}
],
"DhcpOptionsId": "dopt-d9070ebb"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a DHCP options set.",
"id": "ec2-create-dhcp-options-1",
"title": "To create a DHCP options set"
}
],
"CreateImage": [
{
"input": {
"BlockDeviceMappings": [
{
"DeviceName": "/dev/sdh",
"Ebs": {
"VolumeSize": "100"
}
},
{
"DeviceName": "/dev/sdc",
"VirtualName": "ephemeral1"
}
],
"Description": "An AMI for my server",
"InstanceId": "i-1234567890abcdef0",
"Name": "My server",
"NoReboot": true
},
"output": {
"ImageId": "ami-1a2b3c4d"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates an AMI from the specified instance and adds an EBS volume with the device name /dev/sdh and an instance store volume with the device name /dev/sdc.",
"id": "to-create-an-ami-from-an-amazon-ebs-backed-instance-1529023150636",
"title": "To create an AMI from an Amazon EBS-backed instance"
}
],
"CreateInternetGateway": [
{
"output": {
"InternetGateway": {
"Attachments": [
],
"InternetGatewayId": "igw-c0a643a9",
"Tags": [
]
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates an Internet gateway.",
"id": "ec2-create-internet-gateway-1",
"title": "To create an Internet gateway"
}
],
"CreateKeyPair": [
{
"input": {
"KeyName": "my-key-pair"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a key pair named my-key-pair.",
"id": "ec2-create-key-pair-1",
"title": "To create a key pair"
}
],
"CreateLaunchTemplate": [
{
"input": {
"LaunchTemplateData": {
"ImageId": "ami-8c1be5f6",
"InstanceType": "t2.small",
"NetworkInterfaces": [
{
"AssociatePublicIpAddress": true,
"DeviceIndex": 0,
"Ipv6AddressCount": 1,
"SubnetId": "subnet-7b16de0c"
}
],
"TagSpecifications": [
{
"ResourceType": "instance",
"Tags": [
{
"Key": "Name",
"Value": "webserver"
}
]
}
]
},
"LaunchTemplateName": "my-template",
"VersionDescription": "WebVersion1"
},
"output": {
"LaunchTemplate": {
"CreateTime": "2017-11-27T09:13:24.000Z",
"CreatedBy": "arn:aws:iam::123456789012:root",
"DefaultVersionNumber": 1,
"LatestVersionNumber": 1,
"LaunchTemplateId": "lt-01238c059e3466abc",
"LaunchTemplateName": "my-template"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a launch template that specifies the subnet in which to launch the instance, assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance.",
"id": "to-create-a-launch-template-1529023655488",
"title": "To create a launch template"
}
],
"CreateLaunchTemplateVersion": [
{
"input": {
"LaunchTemplateData": {
"ImageId": "ami-c998b6b2"
},
"LaunchTemplateId": "lt-0abcd290751193123",
"SourceVersion": "1",
"VersionDescription": "WebVersion2"
},
"output": {
"LaunchTemplateVersion": {
"CreateTime": "2017-12-01T13:35:46.000Z",
"CreatedBy": "arn:aws:iam::123456789012:root",
"DefaultVersion": false,
"LaunchTemplateData": {
"ImageId": "ami-c998b6b2",
"InstanceType": "t2.micro",
"NetworkInterfaces": [
{
"AssociatePublicIpAddress": true,
"DeviceIndex": 0,
"Ipv6Addresses": [
{
"Ipv6Address": "2001:db8:1234:1a00::123"
}
],
"SubnetId": "subnet-7b16de0c"
}
]
},
"LaunchTemplateId": "lt-0abcd290751193123",
"LaunchTemplateName": "my-template",
"VersionDescription": "WebVersion2",
"VersionNumber": 2
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a new launch template version based on version 1 of the specified launch template and specifies a different AMI ID.",
"id": "to-create-a-launch-template-version-1529024195702",
"title": "To create a launch template version"
}
],
"CreateNatGateway": [
{
"input": {
"AllocationId": "eipalloc-37fc1a52",
"SubnetId": "subnet-1a2b3c4d"
},
"output": {
"NatGateway": {
"CreateTime": "2015-12-17T12:45:26.732Z",
"NatGatewayAddresses": [
{
"AllocationId": "eipalloc-37fc1a52"
}
],
"NatGatewayId": "nat-08d48af2a8e83edfd",
"State": "pending",
"SubnetId": "subnet-1a2b3c4d",
"VpcId": "vpc-1122aabb"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc-37fc1a52 with the NAT gateway.",
"id": "ec2-create-nat-gateway-1",
"title": "To create a NAT gateway"
}
],
"CreateNetworkAcl": [
{
"input": {
"VpcId": "vpc-a01106c2"
},
"output": {
"NetworkAcl": {
"Associations": [
],
"Entries": [
{
"CidrBlock": "0.0.0.0/0",
"Egress": true,
"Protocol": "-1",
"RuleAction": "deny",
"RuleNumber": 32767
},
{
"CidrBlock": "0.0.0.0/0",
"Egress": false,
"Protocol": "-1",
"RuleAction": "deny",
"RuleNumber": 32767
}
],
"IsDefault": false,
"NetworkAclId": "acl-5fb85d36",
"Tags": [
],
"VpcId": "vpc-a01106c2"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a network ACL for the specified VPC.",
"id": "ec2-create-network-acl-1",
"title": "To create a network ACL"
}
],
"CreateNetworkAclEntry": [
{
"input": {
"CidrBlock": "0.0.0.0/0",
"Egress": false,
"NetworkAclId": "acl-5fb85d36",
"PortRange": {
"From": 53,
"To": 53
},
"Protocol": "17",
"RuleAction": "allow",
"RuleNumber": 100
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates an entry for the specified network ACL. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet.",
"id": "ec2-create-network-acl-entry-1",
"title": "To create a network ACL entry"
}
],
"CreateNetworkInterface": [
{
"input": {
"Description": "my network interface",
"Groups": [
"sg-903004f8"
],
"PrivateIpAddress": "10.0.2.17",
"SubnetId": "subnet-9d4a7b6c"
},
"output": {
"NetworkInterface": {
"AvailabilityZone": "us-east-1d",
"Description": "my network interface",
"Groups": [
{
"GroupId": "sg-903004f8",
"GroupName": "default"
}
],
"MacAddress": "02:1a:80:41:52:9c",
"NetworkInterfaceId": "eni-e5aa89a3",
"OwnerId": "123456789012",
"PrivateIpAddress": "10.0.2.17",
"PrivateIpAddresses": [
{
"Primary": true,
"PrivateIpAddress": "10.0.2.17"
}
],
"RequesterManaged": false,
"SourceDestCheck": true,
"Status": "pending",
"SubnetId": "subnet-9d4a7b6c",
"TagSet": [
],
"VpcId": "vpc-a01106c2"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a network interface for the specified subnet.",
"id": "ec2-create-network-interface-1",
"title": "To create a network interface"
}
],
"CreatePlacementGroup": [
{
"input": {
"GroupName": "my-cluster",
"Strategy": "cluster"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a placement group with the specified name.",
"id": "to-create-a-placement-group-1472712245768",
"title": "To create a placement group"
}
],
"CreateRoute": [
{
"input": {
"DestinationCidrBlock": "0.0.0.0/0",
"GatewayId": "igw-c0a643a9",
"RouteTableId": "rtb-22574640"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a route for the specified route table. The route matches all traffic (0.0.0.0/0) and routes it to the specified Internet gateway.",
"id": "ec2-create-route-1",
"title": "To create a route"
}
],
"CreateRouteTable": [
{
"input": {
"VpcId": "vpc-a01106c2"
},
"output": {
"RouteTable": {
"Associations": [
],
"PropagatingVgws": [
],
"RouteTableId": "rtb-22574640",
"Routes": [
{
"DestinationCidrBlock": "10.0.0.0/16",
"GatewayId": "local",
"State": "active"
}
],
"Tags": [
],
"VpcId": "vpc-a01106c2"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a route table for the specified VPC.",
"id": "ec2-create-route-table-1",
"title": "To create a route table"
}
],
"CreateSecurityGroup": [
{
"input": {
"Description": "My security group",
"GroupName": "my-security-group",
"VpcId": "vpc-1a2b3c4d"
},
"output": {
"GroupId": "sg-903004f8"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a security group for the specified VPC.",
"id": "to-create-a-security-group-for-a-vpc-1529024532716",
"title": "To create a security group for a VPC"
}
],
"CreateSnapshot": [
{
"input": {
"Description": "This is my root volume snapshot.",
"VolumeId": "vol-1234567890abcdef0"
},
"output": {
"Description": "This is my root volume snapshot.",
"OwnerId": "012345678910",
"SnapshotId": "snap-066877671789bd71b",
"StartTime": "2014-02-28T21:06:01.000Z",
"State": "pending",
"Tags": [
],
"VolumeId": "vol-1234567890abcdef0",
"VolumeSize": 8
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot.",
"id": "to-create-a-snapshot-1472502529790",
"title": "To create a snapshot"
}
],
"CreateSpotDatafeedSubscription": [
{
"input": {
"Bucket": "my-s3-bucket",
"Prefix": "spotdata"
},
"output": {
"SpotDatafeedSubscription": {
"Bucket": "my-s3-bucket",
"OwnerId": "123456789012",
"Prefix": "spotdata",
"State": "Active"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a Spot Instance data feed for your AWS account.",
"id": "ec2-create-spot-datafeed-subscription-1",
"title": "To create a Spot Instance datafeed"
}
],
"CreateSubnet": [
{
"input": {
"CidrBlock": "10.0.1.0/24",
"VpcId": "vpc-a01106c2"
},
"output": {
"Subnet": {
"AvailabilityZone": "us-west-2c",
"AvailableIpAddressCount": 251,
"CidrBlock": "10.0.1.0/24",
"State": "pending",
"SubnetId": "subnet-9d4a7b6c",
"VpcId": "vpc-a01106c2"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a subnet in the specified VPC with the specified CIDR block. We recommend that you let us select an Availability Zone for you.",
"id": "ec2-create-subnet-1",
"title": "To create a subnet"
}
],
"CreateTags": [
{
"input": {
"Resources": [
"ami-78a54011"
],
"Tags": [
{
"Key": "Stack",
"Value": "production"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example adds the tag Stack=production to the specified image, or overwrites an existing tag for the AMI where the tag key is Stack.",
"id": "ec2-create-tags-1",
"title": "To add a tag to a resource"
}
],
"CreateVolume": [
{
"input": {
"AvailabilityZone": "us-east-1a",
"Size": 80,
"VolumeType": "gp2"
},
"output": {
"AvailabilityZone": "us-east-1a",
"CreateTime": "2016-08-29T18:52:32.724Z",
"Encrypted": false,
"Iops": 240,
"Size": 80,
"SnapshotId": "",
"State": "creating",
"VolumeId": "vol-6b60b7c7",
"VolumeType": "gp2"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``.",
"id": "to-create-a-new-volume-1472496724296",
"title": "To create a new volume"
},
{
"input": {
"AvailabilityZone": "us-east-1a",
"Iops": 1000,
"SnapshotId": "snap-066877671789bd71b",
"VolumeType": "io1"
},
"output": {
"Attachments": [
],
"AvailabilityZone": "us-east-1a",
"CreateTime": "2016-08-29T18:52:32.724Z",
"Iops": 1000,
"Size": 500,
"SnapshotId": "snap-066877671789bd71b",
"State": "creating",
"Tags": [
],
"VolumeId": "vol-1234567890abcdef0",
"VolumeType": "io1"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone ``us-east-1a``.",
"id": "to-create-a-new-provisioned-iops-ssd-volume-from-a-snapshot-1472498975176",
"title": "To create a new Provisioned IOPS (SSD) volume from a snapshot"
}
],
"CreateVpc": [
{
"input": {
"CidrBlock": "10.0.0.0/16"
},
"output": {
"Vpc": {
"CidrBlock": "10.0.0.0/16",
"DhcpOptionsId": "dopt-7a8b9c2d",
"InstanceTenancy": "default",
"State": "pending",
"VpcId": "vpc-a01106c2"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a VPC with the specified CIDR block.",
"id": "ec2-create-vpc-1",
"title": "To create a VPC"
}
],
"DeleteCustomerGateway": [
{
"input": {
"CustomerGatewayId": "cgw-0e11f167"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified customer gateway.",
"id": "ec2-delete-customer-gateway-1",
"title": "To delete a customer gateway"
}
],
"DeleteDhcpOptions": [
{
"input": {
"DhcpOptionsId": "dopt-d9070ebb"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified DHCP options set.",
"id": "ec2-delete-dhcp-options-1",
"title": "To delete a DHCP options set"
}
],
"DeleteInternetGateway": [
{
"input": {
"InternetGatewayId": "igw-c0a643a9"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified Internet gateway.",
"id": "ec2-delete-internet-gateway-1",
"title": "To delete an Internet gateway"
}
],
"DeleteKeyPair": [
{
"input": {
"KeyName": "my-key-pair"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified key pair.",
"id": "ec2-delete-key-pair-1",
"title": "To delete a key pair"
}
],
"DeleteLaunchTemplate": [
{
"input": {
"LaunchTemplateId": "lt-0abcd290751193123"
},
"output": {
"LaunchTemplate": {
"CreateTime": "2017-11-23T16:46:25.000Z",
"CreatedBy": "arn:aws:iam::123456789012:root",
"DefaultVersionNumber": 2,
"LatestVersionNumber": 2,
"LaunchTemplateId": "lt-0abcd290751193123",
"LaunchTemplateName": "my-template"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified launch template.",
"id": "to-delete-a-launch-template-1529024658216",
"title": "To delete a launch template"
}
],
"DeleteLaunchTemplateVersions": [
{
"input": {
"LaunchTemplateId": "lt-0abcd290751193123",
"Versions": [
"1"
]
},
"output": {
"SuccessfullyDeletedLaunchTemplateVersions": [
{
"LaunchTemplateId": "lt-0abcd290751193123",
"LaunchTemplateName": "my-template",
"VersionNumber": 1
}
],
"UnsuccessfullyDeletedLaunchTemplateVersions": [
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified launch template version.",
"id": "to-delete-a-launch-template-version-1529024790864",
"title": "To delete a launch template version"
}
],
"DeleteNatGateway": [
{
"input": {
"NatGatewayId": "nat-04ae55e711cec5680"
},
"output": {
"NatGatewayId": "nat-04ae55e711cec5680"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified NAT gateway.",
"id": "ec2-delete-nat-gateway-1",
"title": "To delete a NAT gateway"
}
],
"DeleteNetworkAcl": [
{
"input": {
"NetworkAclId": "acl-5fb85d36"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified network ACL.",
"id": "ec2-delete-network-acl-1",
"title": "To delete a network ACL"
}
],
"DeleteNetworkAclEntry": [
{
"input": {
"Egress": true,
"NetworkAclId": "acl-5fb85d36",
"RuleNumber": 100
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes ingress rule number 100 from the specified network ACL.",
"id": "ec2-delete-network-acl-entry-1",
"title": "To delete a network ACL entry"
}
],
"DeleteNetworkInterface": [
{
"input": {
"NetworkInterfaceId": "eni-e5aa89a3"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified network interface.",
"id": "ec2-delete-network-interface-1",
"title": "To delete a network interface"
}
],
"DeletePlacementGroup": [
{
"input": {
"GroupName": "my-cluster"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified placement group.\n",
"id": "to-delete-a-placement-group-1472712349959",
"title": "To delete a placement group"
}
],
"DeleteRoute": [
{
"input": {
"DestinationCidrBlock": "0.0.0.0/0",
"RouteTableId": "rtb-22574640"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified route from the specified route table.",
"id": "ec2-delete-route-1",
"title": "To delete a route"
}
],
"DeleteRouteTable": [
{
"input": {
"RouteTableId": "rtb-22574640"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified route table.",
"id": "ec2-delete-route-table-1",
"title": "To delete a route table"
}
],
"DeleteSecurityGroup": [
{
"input": {
"GroupId": "sg-903004f8"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified security group.",
"id": "to-delete-a-security-group-1529024952972",
"title": "To delete a security group"
}
],
"DeleteSnapshot": [
{
"input": {
"SnapshotId": "snap-1234567890abcdef0"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.",
"id": "to-delete-a-snapshot-1472503042567",
"title": "To delete a snapshot"
}
],
"DeleteSpotDatafeedSubscription": [
{
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes a Spot data feed subscription for the account.",
"id": "ec2-delete-spot-datafeed-subscription-1",
"title": "To cancel a Spot Instance data feed subscription"
}
],
"DeleteSubnet": [
{
"input": {
"SubnetId": "subnet-9d4a7b6c"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified subnet.",
"id": "ec2-delete-subnet-1",
"title": "To delete a subnet"
}
],
"DeleteTags": [
{
"input": {
"Resources": [
"ami-78a54011"
],
"Tags": [
{
"Key": "Stack",
"Value": "test"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the tag Stack=test from the specified image.",
"id": "ec2-delete-tags-1",
"title": "To delete a tag from a resource"
}
],
"DeleteVolume": [
{
"input": {
"VolumeId": "vol-049df61146c4d7901"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes an available volume with the volume ID of ``vol-049df61146c4d7901``. If the command succeeds, no output is returned.",
"id": "to-delete-a-volume-1472503111160",
"title": "To delete a volume"
}
],
"DeleteVpc": [
{
"input": {
"VpcId": "vpc-a01106c2"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the specified VPC.",
"id": "ec2-delete-vpc-1",
"title": "To delete a VPC"
}
],
"DescribeAccountAttributes": [
{
"input": {
"AttributeNames": [
"supported-platforms"
]
},
"output": {
"AccountAttributes": [
{
"AttributeName": "supported-platforms",
"AttributeValues": [
{
"AttributeValue": "EC2"
},
{
"AttributeValue": "VPC"
}
]
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the supported-platforms attribute for your AWS account.",
"id": "ec2-describe-account-attributes-1",
"title": "To describe a single attribute for your AWS account"
},
{
"output": {
"AccountAttributes": [
{
"AttributeName": "supported-platforms",
"AttributeValues": [
{
"AttributeValue": "EC2"
},
{
"AttributeValue": "VPC"
}
]
},
{
"AttributeName": "vpc-max-security-groups-per-interface",
"AttributeValues": [
{
"AttributeValue": "5"
}
]
},
{
"AttributeName": "max-elastic-ips",
"AttributeValues": [
{
"AttributeValue": "5"
}
]
},
{
"AttributeName": "max-instances",
"AttributeValues": [
{
"AttributeValue": "20"
}
]
},
{
"AttributeName": "vpc-max-elastic-ips",
"AttributeValues": [
{
"AttributeValue": "5"
}
]
},
{
"AttributeName": "default-vpc",
"AttributeValues": [
{
"AttributeValue": "none"
}
]
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the attributes for your AWS account.",
"id": "ec2-describe-account-attributes-2",
"title": "To describe all attributes for your AWS account"
}
],
"DescribeAddresses": [
{
"output": {
"Addresses": [
{
"Domain": "standard",
"InstanceId": "i-1234567890abcdef0",
"PublicIp": "198.51.100.0"
},
{
"AllocationId": "eipalloc-12345678",
"AssociationId": "eipassoc-12345678",
"Domain": "vpc",
"InstanceId": "i-1234567890abcdef0",
"NetworkInterfaceId": "eni-12345678",
"NetworkInterfaceOwnerId": "123456789012",
"PrivateIpAddress": "10.0.1.241",
"PublicIp": "203.0.113.0"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes your Elastic IP addresses.",
"id": "ec2-describe-addresses-1",
"title": "To describe your Elastic IP addresses"
},
{
"input": {
"Filters": [
{
"Name": "domain",
"Values": [
"vpc"
]
}
]
},
"output": {
"Addresses": [
{
"AllocationId": "eipalloc-12345678",
"AssociationId": "eipassoc-12345678",
"Domain": "vpc",
"InstanceId": "i-1234567890abcdef0",
"NetworkInterfaceId": "eni-12345678",
"NetworkInterfaceOwnerId": "123456789012",
"PrivateIpAddress": "10.0.1.241",
"PublicIp": "203.0.113.0"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "