diff --git a/awscli/examples/ec2/create-network-interface.rst b/awscli/examples/ec2/create-network-interface.rst index 5c898f4e92de..dfecc39796da 100644 --- a/awscli/examples/ec2/create-network-interface.rst +++ b/awscli/examples/ec2/create-network-interface.rst @@ -1,39 +1,194 @@ -**To create a network interface** - -This example creates a network interface for the specified subnet. - -Command:: - - aws ec2 create-network-interface --subnet-id subnet-9d4a7b6c --description "my network interface" --groups sg-903004f8 --private-ip-address 10.0.2.17 - -Output:: - - { - "NetworkInterface": { - "Status": "pending", - "MacAddress": "02:1a:80:41:52:9c", - "SourceDestCheck": true, - "VpcId": "vpc-a01106c2", - "Description": "my network interface", - "NetworkInterfaceId": "eni-e5aa89a3", - "PrivateIpAddresses": [ - { - "Primary": true, - "PrivateIpAddress": "10.0.2.17" - } - ], - "RequesterManaged": false, - "AvailabilityZone": "us-east-1d", - "Ipv6Addresses": [], - "Groups": [ - { - "GroupName": "default", - "GroupId": "sg-903004f8" - } - ], - "SubnetId": "subnet-9d4a7b6c", - "OwnerId": "123456789012", - "TagSet": [], - "PrivateIpAddress": "10.0.2.17" - } - } \ No newline at end of file +**Example 1: To specify an IPv4 address for a network interface** + +The following ``create-network-interface`` example creates a network interface for the specified subnet with the specified primary IPv4 address. :: + + aws ec2 create-network-interface \ + --subnet-id subnet-00a24d0d67acf6333 \ + --description "my network interface" \ + --groups sg-09dfba7ed20cda78b \ + --private-ip-address 10.0.8.17 + +Output:: + + { + "NetworkInterface": { + "AvailabilityZone": "us-west-2a", + "Description": "my network interface", + "Groups": [ + { + "GroupName": "my-security-group", + "GroupId": "sg-09dfba7ed20cda78b" + } + ], + "InterfaceType": "interface", + "Ipv6Addresses": [], + "MacAddress": "06:6a:0f:9a:49:37", + "NetworkInterfaceId": "eni-0492b355f0cf3b3f8", + "OwnerId": "123456789012", + "PrivateDnsName": "ip-10-0-8-18.us-west-2.compute.internal", + "PrivateIpAddress": "10.0.8.17", + "PrivateIpAddresses": [ + { + "Primary": true, + "PrivateDnsName": "ip-10-0-8-17.us-west-2.compute.internal", + "PrivateIpAddress": "10.0.8.17" + } + ], + "RequesterId": "AIDA4Z3Y7GSXTMEXAMPLE", + "RequesterManaged": false, + "SourceDestCheck": true, + "Status": "pending", + "SubnetId": "subnet-00a24d0d67acf6333", + "TagSet": [], + "VpcId": "vpc-02723a0feeeb9d57b" + } + } + +**Example 2: To create a network interface with an IPv4 address and an IPv6 address** + +The following ``create-network-interface`` example creates a network interface for the specified subnet with an IPv4 address and an IPv6 address that are selected by Amazon EC2. :: + + aws ec2 create-network-interface \ + --subnet-id subnet-00a24d0d67acf6333 \ + --description "my dual stack network interface" \ + --ipv6-address-count 1 \ + --groups sg-09dfba7ed20cda78b + +Output:: + + { + "NetworkInterface": { + "AvailabilityZone": "us-west-2a", + "Description": "my dual stack network interface", + "Groups": [ + { + "GroupName": "my-security-group", + "GroupId": "sg-09dfba7ed20cda78b" + } + ], + "InterfaceType": "interface", + "Ipv6Addresses": [ + { + "Ipv6Address": "2600:1f13:cfe:3650:a1dc:237c:393a:4ba7", + "IsPrimaryIpv6": false + } + ], + "MacAddress": "06:b8:68:d2:b2:2d", + "NetworkInterfaceId": "eni-05da417453f9a84bf", + "OwnerId": "123456789012", + "PrivateDnsName": "ip-10-0-8-18.us-west-2.compute.internal", + "PrivateIpAddress": "10.0.8.18", + "PrivateIpAddresses": [ + { + "Primary": true, + "PrivateDnsName": "ip-10-0-8-18.us-west-2.compute.internal", + "PrivateIpAddress": "10.0.8.18" + } + ], + "RequesterId": "AIDA4Z3Y7GSXTMEXAMPLE", + "RequesterManaged": false, + "SourceDestCheck": true, + "Status": "pending", + "SubnetId": "subnet-00a24d0d67acf6333", + "TagSet": [], + "VpcId": "vpc-02723a0feeeb9d57b", + "Ipv6Address": "2600:1f13:cfe:3650:a1dc:237c:393a:4ba7" + } + } + +**Example 3: To create a network interface with connection tracking configuration options** + +The following ``create-network-interface`` example creates a network interface and configures the idle connection tracking timeouts. :: + + aws ec2 create-network-interface \ + --subnet-id subnet-00a24d0d67acf6333 \ + --groups sg-02e57dbcfe0331c1b \ + --connection-tracking-specification TcpEstablishedTimeout=86400,UdpTimeout=60 + +Output:: + + { + "NetworkInterface": { + "AvailabilityZone": "us-west-2a", + "ConnectionTrackingConfiguration": { + "TcpEstablishedTimeout": 86400, + "UdpTimeout": 60 + }, + "Description": "", + "Groups": [ + { + "GroupName": "my-security-group", + "GroupId": "sg-02e57dbcfe0331c1b" + } + ], + "InterfaceType": "interface", + "Ipv6Addresses": [], + "MacAddress": "06:4c:53:de:6d:91", + "NetworkInterfaceId": "eni-0c133586e08903d0b", + "OwnerId": "123456789012", + "PrivateDnsName": "ip-10-0-8-94.us-west-2.compute.internal", + "PrivateIpAddress": "10.0.8.94", + "PrivateIpAddresses": [ + { + "Primary": true, + "PrivateDnsName": "ip-10-0-8-94.us-west-2.compute.internal", + "PrivateIpAddress": "10.0.8.94" + } + ], + "RequesterId": "AIDA4Z3Y7GSXTMEXAMPLE", + "RequesterManaged": false, + "SourceDestCheck": true, + "Status": "pending", + "SubnetId": "subnet-00a24d0d67acf6333", + "TagSet": [], + "VpcId": "vpc-02723a0feeeb9d57b" + } + } + +**Example 4: To create an Elastic Fabric Adapter** + +The following ``create-network-interface`` example creates an EFA. :: + + aws ec2 create-network-interface \ + --interface-type efa \ + --subnet-id subnet-00a24d0d67acf6333 \ + --description "my efa" \ + --groups sg-02e57dbcfe0331c1b + +Output:: + + { + "NetworkInterface": { + "AvailabilityZone": "us-west-2a", + "Description": "my efa", + "Groups": [ + { + "GroupName": "my-efa-sg", + "GroupId": "sg-02e57dbcfe0331c1b" + } + ], + "InterfaceType": "efa", + "Ipv6Addresses": [], + "MacAddress": "06:d7:a4:f7:4d:57", + "NetworkInterfaceId": "eni-034acc2885e862b65", + "OwnerId": "123456789012", + "PrivateDnsName": "ip-10-0-8-180.us-west-2.compute.internal", + "PrivateIpAddress": "10.0.8.180", + "PrivateIpAddresses": [ + { + "Primary": true, + "PrivateDnsName": "ip-10-0-8-180.us-west-2.compute.internal", + "PrivateIpAddress": "10.0.8.180" + } + ], + "RequesterId": "AIDA4Z3Y7GSXTMEXAMPLE", + "RequesterManaged": false, + "SourceDestCheck": true, + "Status": "pending", + "SubnetId": "subnet-00a24d0d67acf6333", + "TagSet": [], + "VpcId": "vpc-02723a0feeeb9d57b" + } + } + +For more information, see `Elastic network interfaces `__ in the *Amazon EC2 User Guide*. diff --git a/awscli/examples/ec2/create-store-image-task.rst b/awscli/examples/ec2/create-store-image-task.rst index a44f839119ec..6ce408b519d8 100644 --- a/awscli/examples/ec2/create-store-image-task.rst +++ b/awscli/examples/ec2/create-store-image-task.rst @@ -12,4 +12,5 @@ Output:: "ObjectKey": "ami-1234567890abcdef0.bin" } -For more information about storing and restoring an AMI using S3, see `Store and restore an AMI using S3 ` in the *Amazon EC2 User Guide*. \ No newline at end of file +For more information, see `Store and restore an AMI using S3 `__ in the *Amazon EC2 User Guide*. + diff --git a/awscli/examples/ec2/create-transit-gateway-policy-table.rst b/awscli/examples/ec2/create-transit-gateway-policy-table.rst new file mode 100644 index 000000000000..d299ee491245 --- /dev/null +++ b/awscli/examples/ec2/create-transit-gateway-policy-table.rst @@ -0,0 +1,19 @@ +**To create a transit gateway policy table** + +The following ``create-transit-gateway-policy-table`` example creates a transit gateway policy table for the specified transit gateway. :: + + aws ec2 create-transit-gateway-policy-table \ + --transit-gateway-id tgw-067f8505c18f0bd6e + +Output:: + + { + "TransitGatewayPolicyTable": { + "TransitGatewayPolicyTableId": "tgw-ptb-0a16f134b78668a81", + "TransitGatewayId": "tgw-067f8505c18f0bd6e", + "State": "pending", + "CreationTime": "2023-11-28T16:36:43+00:00" + } + } + +For more information, see `Transit gateway policy tables `__ in the *Transit Gateway User Guide*. diff --git a/awscli/examples/ec2/delete-key-pair.rst b/awscli/examples/ec2/delete-key-pair.rst index 4cd64fdd6a10..770a74e2139a 100644 --- a/awscli/examples/ec2/delete-key-pair.rst +++ b/awscli/examples/ec2/delete-key-pair.rst @@ -1,12 +1,15 @@ -**To delete a key pair** - -This example deletes the key pair named ``MyKeyPair``. If the command succeeds, no output is returned. - -Command:: - - aws ec2 delete-key-pair --key-name MyKeyPair - -For more information, see `Using Key Pairs`_ in the *AWS Command Line Interface User Guide*. - -.. _`Using Key Pairs`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-keypairs.html - +**To delete a key pair** + +The following ``delete-key-pair`` example deletes the specified key pair. :: + + aws ec2 delete-key-pair \ + --key-name my-key-pair + +Output:: + + { + "Return": true, + "KeyPairId": "key-03c8d3aceb53b507" + } + +For more information, see `Create and delete key pairs `__ in the *AWS Command Line Interface User Guide*. diff --git a/awscli/examples/ec2/delete-transit-gateway-policy-table.rst b/awscli/examples/ec2/delete-transit-gateway-policy-table.rst new file mode 100644 index 000000000000..f609140b3044 --- /dev/null +++ b/awscli/examples/ec2/delete-transit-gateway-policy-table.rst @@ -0,0 +1,22 @@ +**To delete a transit gateway policy table** + +The following ``delete-transit-gateway-policy-table`` example deletes the specified transit gateway policy table. :: + + aws ec2 delete-transit-gateway-policy-table \ + --transit-gateway-policy-table-id tgw-ptb-0a16f134b78668a81 + +Output:: + + { + "TransitGatewayPolicyTables": [ + { + "TransitGatewayPolicyTableId": "tgw-ptb-0a16f134b78668a81", + "TransitGatewayId": "tgw-067f8505c18f0bd6e", + "State": "deleting", + "CreationTime": "2023-11-28T16:36:43+00:00", + "Tags": [] + } + ] + } + +For more information, see `Transit gateway policy tables `__ in the *Transit Gateway User Guide*. diff --git a/awscli/examples/ec2/describe-aws-network-performance-metric-subscriptions.rst b/awscli/examples/ec2/describe-aws-network-performance-metric-subscriptions.rst new file mode 100644 index 000000000000..3477c32faf5c --- /dev/null +++ b/awscli/examples/ec2/describe-aws-network-performance-metric-subscriptions.rst @@ -0,0 +1,21 @@ +**To describe your metric subscriptions** + +The following ``describe-aws-network-performance-metric-subscriptions`` example describes your metric subscriptions. :: + + aws ec2 describe-aws-network-performance-metric-subscriptions + +Output:: + + { + "Subscriptions": [ + { + "Source": "us-east-1", + "Destination": "eu-west-1", + "Metric": "aggregate-latency", + "Statistic": "p50", + "Period": "five-minutes" + } + ] + } + +For more information, see `Manage subscriptions `__ in the *Infrastructure Performance User Guide*. \ No newline at end of file diff --git a/awscli/examples/ec2/describe-instance-topology.rst b/awscli/examples/ec2/describe-instance-topology.rst new file mode 100644 index 000000000000..ce501365ed50 --- /dev/null +++ b/awscli/examples/ec2/describe-instance-topology.rst @@ -0,0 +1,61 @@ +**To describe the instance topology of all your instances** + +The following ``describe-instance-topology`` example describes the topology of all your instances that match the supported instance types for this command. :: + + aws ec2 describe-instance-topology \ + --region us-west-2 + +Output:: + + { + "Instances": [ + { + "InstanceId": "i-1111111111example", + "InstanceType": "p4d.24xlarge", + "GroupName": "my-ml-cpg", + "NetworkNodes": [ + "nn-1111111111example", + "nn-2222222222example", + "nn-3333333333example" + ], + "ZoneId": "usw2-az2", + "AvailabilityZone": "us-west-2a" + }, + { + "InstanceId": "i-2222222222example", + "InstanceType": "p4d.24xlarge", + "NetworkNodes": [ + "nn-1111111111example", + "nn-2222222222example", + "nn-3333333333example" + ], + "ZoneId": "usw2-az2", + "AvailabilityZone": "us-west-2a" + }, + { + "InstanceId": "i-3333333333example", + "InstanceType": "trn1.32xlarge", + "NetworkNodes": [ + "nn-1212121212example", + "nn-1211122211example", + "nn-1311133311example" + ], + "ZoneId": "usw2-az4", + "AvailabilityZone": "us-west-2d" + }, + { + "InstanceId": "i-444444444example", + "InstanceType": "trn1.2xlarge", + "NetworkNodes": [ + "nn-1111111111example", + "nn-5434334334example", + "nn-1235301234example" + ], + "ZoneId": "usw2-az2", + "AvailabilityZone": "us-west-2a" + } + ], + "NextToken": "SomeEncryptedToken" + } + +For more information, including more examples, see `Amazon EC2 instance topology `__ in the *Amazon EC2 User Guide*. \ No newline at end of file diff --git a/awscli/examples/ec2/describe-transit-gateway-policy-tables.rst b/awscli/examples/ec2/describe-transit-gateway-policy-tables.rst new file mode 100644 index 000000000000..27475aa04c71 --- /dev/null +++ b/awscli/examples/ec2/describe-transit-gateway-policy-tables.rst @@ -0,0 +1,22 @@ +**To describe a transit gateway policy table** + +The following ``describe-transit-gateway-policy-tables`` example describes the specified transit gateway policy table. :: + + aws ec2 describe-transit-gateway-policy-tables \ + --transit-gateway-policy-table-ids tgw-ptb-0a16f134b78668a81 + +Output:: + + { + "TransitGatewayPolicyTables": [ + { + "TransitGatewayPolicyTableId": "tgw-ptb-0a16f134b78668a81", + "TransitGatewayId": "tgw-067f8505c18f0bd6e", + "State": "available", + "CreationTime": "2023-11-28T16:36:43+00:00", + "Tags": [] + } + ] + } + +For more information, see `Transit gateway policy tables `__ in the *Transit Gateway User Guide*. diff --git a/awscli/examples/ec2/wait/snapshot-imported.rst b/awscli/examples/ec2/wait/snapshot-imported.rst new file mode 100644 index 000000000000..50f9abc99c7a --- /dev/null +++ b/awscli/examples/ec2/wait/snapshot-imported.rst @@ -0,0 +1,10 @@ +**To wait until a snapshot import task is completed** + +The following ``wait snapshot-imported`` example pauses and resumes only after the specified snapshot import task is completed. :: + + aws ec2 wait snapshot-imported \ + --import-task-ids import-snap-1234567890abcdef0 + +This command produces no output. + +For more information, see `Snapshot import `__ in the *VM Import/Export User Guide*. \ No newline at end of file diff --git a/awscli/examples/ec2/wait/store-image-task-complete.rst b/awscli/examples/ec2/wait/store-image-task-complete.rst new file mode 100644 index 000000000000..ff04f361973a --- /dev/null +++ b/awscli/examples/ec2/wait/store-image-task-complete.rst @@ -0,0 +1,10 @@ +**To wait until a store image task is completed** + +The following ``wait store-image-task-complete`` example pauses and resumes after the store image task for the specified image is completed. :: + + aws ec2 wait store-image-task-complete \ + --image-ids ami-1234567890abcdef0 + +This command produces no output. + +For more information, see `Store and restore an AMI `__ in the *Amazon EC2 User Guide*. \ No newline at end of file diff --git a/awscli/examples/elbv2/create-target-group.rst b/awscli/examples/elbv2/create-target-group.rst index 23fe4c30ee75..40d60d49d79a 100644 --- a/awscli/examples/elbv2/create-target-group.rst +++ b/awscli/examples/elbv2/create-target-group.rst @@ -1,139 +1,183 @@ -**Example 1: To create a target group to route traffic to instances registered by instance ID** - -The following ``create-target-group`` example creates a target group for an Application Load Balancer where you register targets by instance ID (the target type is ``instance``). This target group uses the HTTP protocol, port 80, and the default health check settings for an HTTP target group. :: - - aws elbv2 create-target-group \ - --name my-targets \ - --protocol HTTP \ - --port 80 \ - --target-type instance \ - --vpc-id vpc-3ac0fb5f - -Output:: - - { - "TargetGroups": [ - { - "TargetGroupName": "my-targets", - "Protocol": "HTTP", - "Port": 80, - "VpcId": "vpc-3ac0fb5f", - "TargetType": "instance", - "HealthCheckEnabled": true, - "UnhealthyThresholdCount": 2, - "HealthyThresholdCount": 5, - "HealthCheckPath": "/", - "Matcher": { - "HttpCode": "200" - }, - "HealthCheckProtocol": "HTTP", - "HealthCheckPort": "traffic-port", - "HealthCheckIntervalSeconds": 30, - "HealthCheckTimeoutSeconds": 5, - "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" - } - ] - } - -For more information, see `Create a target group `__ in the *User Guide for Application Load Balancers*. - -**Example 2: To create a target group to route traffic to an IP addresses** - -The following ``create-target-group`` example creates a target group for a Network Load Balancer where you register targets by IP address (the target type is ``ip``). This target group uses the TCP protocol, port 80, and the default health check settings for a TCP target group. :: - - aws elbv2 create-target-group \ - --name my-ip-targets \ - --protocol TCP \ - --port 80 \ - --target-type ip \ - --vpc-id vpc-3ac0fb5f - -Output:: - - { - "TargetGroups": [ - { - "TargetGroupName": "my-ip-targets", - "Protocol": "TCP", - "Port": 80, - "VpcId": "vpc-3ac0fb5f", - "TargetType": "ip", - "HealthCheckEnabled": true, - "UnhealthyThresholdCount": 3, - "HealthyThresholdCount": 3, - "HealthCheckProtocol": "TCP", - "HealthCheckPort": "traffic-port", - "HealthCheckIntervalSeconds": 30, - "HealthCheckTimeoutSeconds": 10, - "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ip-targets/b6bba954d1361c78" - } - ] - } - -For more information, see `Create a target group for your Network Load Balancer `__ in the *User Guide for Network Load Balancers*. - -**Example 3: To create a target group to route traffic to a Lambda function** - -The following ``create-target-group`` example creates a target group for an Application Load Balancer where the target is a Lambda function (the target type is ``lambda``). Health checks are disabled for this target group by default. :: - - aws elbv2 create-target-group \ - --name my-lambda-target \ - --target-type lambda - -Output:: - - { - "TargetGroups": [ - { - "TargetGroupName": "my-lambda-target", - "TargetType": "lambda", - "HealthCheckEnabled": false, - "UnhealthyThresholdCount": 2, - "HealthyThresholdCount": 5, - "HealthCheckPath": "/", - "Matcher": { - "HttpCode": "200" - }, - "HealthCheckIntervalSeconds": 35, - "HealthCheckTimeoutSeconds": 30, - "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-lambda-target/a3003e085dbb8ddc" - } - ] - } - -For more information, see `Lambda functions as targets `__ in the *User Guide for Application Load Balancers*. - -**Example 4: To create a target group to route traffic to a Gateway Load Balancer** - -The following ``create-target-group`` example creates a target group for a Gateway Load Balancer where the target is an instance, and the target group protocol is GENEVE. :: - - aws elbv2 create-target-group \ - --name my-glb-targetgroup \ - --protocol GENEVE \ - --port 6081 \ - --target-type instance \ - --vpc-id vpc-838475fe - -Output:: - - { - "TargetGroups": [ - { - "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-glb-targetgroup/00c3d57eacd6f40b6f", - "TargetGroupName": "my-glb-targetgroup", - "Protocol": "GENEVE", - "Port": 6081, - "VpcId": "vpc-838475fe", - "HealthCheckProtocol": "TCP", - "HealthCheckPort": "80", - "HealthCheckEnabled": true, - "HealthCheckIntervalSeconds": 10, - "HealthCheckTimeoutSeconds": 5, - "HealthyThresholdCount": 5, - "UnhealthyThresholdCount": 2, - "TargetType": "instance" - } - ] - } - -For more information, see `Create a target group for your Gateway Load Balancer `__ in the *User Guide for Gateway Load Balancers*. \ No newline at end of file +**Example 1: To create a target group for an Application Load Balancer** + +The following ``create-target-group`` example creates a target group for an Application Load Balancer where you register targets by instance ID (the target type is ``instance``). This target group uses the HTTP protocol, port 80, and the default health check settings for an HTTP target group. :: + + aws elbv2 create-target-group \ + --name my-targets \ + --protocol HTTP \ + --port 80 \ + --target-type instance \ + --vpc-id vpc-3ac0fb5f + +Output:: + + { + "TargetGroups": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "TargetGroupName": "my-targets", + "Protocol": "HTTP", + "Port": 80, + "VpcId": "vpc-3ac0fb5f", + "HealthCheckProtocol": "HTTP", + "HealthCheckPort": "traffic-port", + "HealthCheckEnabled": true, + "HealthCheckIntervalSeconds": 30, + "HealthCheckTimeoutSeconds": 5, + "HealthyThresholdCount": 5, + "UnhealthyThresholdCount": 2, + "HealthCheckPath": "/", + "Matcher": { + "HttpCode": "200" + }, + "TargetType": "instance", + "ProtocolVersion": "HTTP1", + "IpAddressType": "ipv4" + } + ] + } + +For more information, see `Create a target group `__ in the *User Guide for Application Load Balancers*. + +**Example 2: To create a target group to route traffic from an Application Load Balancer to a Lambda function** + +The following ``create-target-group`` example creates a target group for an Application Load Balancer where the target is a Lambda function (the target type is ``lambda``). Health checks are disabled for this target group by default. :: + + aws elbv2 create-target-group \ + --name my-lambda-target \ + --target-type lambda + +Output:: + + { + "TargetGroups": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-lambda-target/a3003e085dbb8ddc", + "TargetGroupName": "my-lambda-target", + "HealthCheckEnabled": false, + "HealthCheckIntervalSeconds": 35, + "HealthCheckTimeoutSeconds": 30, + "HealthyThresholdCount": 5, + "UnhealthyThresholdCount": 2, + "HealthCheckPath": "/", + "Matcher": { + "HttpCode": "200" + }, + "TargetType": "lambda", + "IpAddressType": "ipv4" + } + ] + } + +For more information, see `Lambda functions as targets `__ in the *User Guide for Application Load Balancers*. + +**Example 3: To create a target group for a Network Load Balancer** + +The following ``create-target-group`` example creates a target group for a Network Load Balancer where you register targets by IP address (the target type is ``ip``). This target group uses the TCP protocol, port 80, and the default health check settings for a TCP target group. :: + + aws elbv2 create-target-group \ + --name my-ip-targets \ + --protocol TCP \ + --port 80 \ + --target-type ip \ + --vpc-id vpc-3ac0fb5f + +Output:: + + { + "TargetGroups": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ip-targets/b6bba954d1361c78", + "TargetGroupName": "my-ip-targets", + "Protocol": "TCP", + "Port": 80, + "VpcId": "vpc-3ac0fb5f", + "HealthCheckEnabled": true, + "HealthCheckProtocol": "TCP", + "HealthCheckPort": "traffic-port", + "HealthCheckIntervalSeconds": 30, + "HealthCheckTimeoutSeconds": 10, + "HealthyThresholdCount": 5, + "UnhealthyThresholdCount": 2, + "TargetType": "ip", + "IpAddressType": "ipv4" + } + ] + } + +For more information, see `Create a target group `__ in the *User Guide for Network Load Balancers*. + +**Example 4: To create a target group to route traffic from a Network Load Balancer to an Application Load Balancer** + +The following ``create-target-group`` example creates a target group for a Network Load Balancer where you register an Application Load Balazncer as a target (the target type is ``alb``). + + aws elbv2 create-target-group \ + --name my-alb-target \ + --protocol TCP \ + --port 80 \ + --target-type alb \ + --vpc-id vpc-3ac0fb5f + +Output:: + + { + "TargetGroups": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-alb-target/a3003e085dbb8ddc", + "TargetGroupName": "my-alb-target", + "Protocol": "TCP", + "Port": 80, + "VpcId": "vpc-838475fe", + "HealthCheckProtocol": "HTTP", + "HealthCheckPort": "traffic-port", + "HealthCheckEnabled": true, + "HealthCheckIntervalSeconds": 30, + "HealthCheckTimeoutSeconds": 6, + "HealthyThresholdCount": 5, + "UnhealthyThresholdCount": 2, + "HealthCheckPath": "/", + "Matcher": { + "HttpCode": "200-399" + }, + "TargetType": "alb", + "IpAddressType": "ipv4" + } + ] + } + +For more information, see `Create a target group with an Application Load Balancer as the target `__ in the *User Guide for Network Load Balancers*. + +**Example 5: To create a target group for a Gateway Load Balancer** + +The following ``create-target-group`` example creates a target group for a Gateway Load Balancer where the target is an instance, and the target group protocol is ``GENEVE``. :: + + aws elbv2 create-target-group \ + --name my-glb-targetgroup \ + --protocol GENEVE \ + --port 6081 \ + --target-type instance \ + --vpc-id vpc-838475fe + +Output:: + + { + "TargetGroups": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-glb-targetgroup/00c3d57eacd6f40b6f", + "TargetGroupName": "my-glb-targetgroup", + "Protocol": "GENEVE", + "Port": 6081, + "VpcId": "vpc-838475fe", + "HealthCheckProtocol": "TCP", + "HealthCheckPort": "80", + "HealthCheckEnabled": true, + "HealthCheckIntervalSeconds": 10, + "HealthCheckTimeoutSeconds": 5, + "HealthyThresholdCount": 5, + "UnhealthyThresholdCount": 2, + "TargetType": "instance" + } + ] + } + +For more information, see Create a target group `__ in the *Gateway Load Balancer User Guide*. \ No newline at end of file diff --git a/awscli/examples/elbv2/delete-target-group.rst b/awscli/examples/elbv2/delete-target-group.rst index fd2b84d2bf3d..63fdf94306ab 100644 --- a/awscli/examples/elbv2/delete-target-group.rst +++ b/awscli/examples/elbv2/delete-target-group.rst @@ -4,3 +4,7 @@ The following ``delete-target-group`` example deletes the specified target group aws elbv2 delete-target-group \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 + +This command produces no output. + +For more information, see `Delete a load balancer `__ in the *Application Load Balancer Guide*. \ No newline at end of file diff --git a/awscli/examples/elbv2/describe-account-limits.rst b/awscli/examples/elbv2/describe-account-limits.rst index 8cb3d9e83c2a..1a607e1fe789 100644 --- a/awscli/examples/elbv2/describe-account-limits.rst +++ b/awscli/examples/elbv2/describe-account-limits.rst @@ -8,49 +8,99 @@ Output:: { "Limits": [ - { - "Name": "application-load-balancers", - "Max": "20" - }, - { - "Name": "target-groups", - "Max": "3000" - }, - { - "Name": "targets-per-application-load-balancer", - "Max": "1000" - }, - { - "Name": "listeners-per-application-load-balancer", - "Max": "50" - }, - { - "Name": "rules-per-application-load-balancer", - "Max": "100" - }, - { - "Name": "network-load-balancers", - "Max": "20" - }, - { - "Name": "targets-per-network-load-balancer", - "Max": "3000" - }, - { - "Name": "targets-per-availability-zone-per-network-load-balancer", - "Max": "500" - }, - { - "Name": "listeners-per-network-load-balancer", - "Max": "50" - }, - { - "Name": "condition-values-per-alb-rule", - "Max": "5" - }, - { - "Name": "condition-wildcards-per-alb-rule", - "Max": "5" - } + { + "Name": "target-groups", + "Max": "3000" + }, + { + "Name": "targets-per-application-load-balancer", + "Max": "1000" + }, + { + "Name": "listeners-per-application-load-balancer", + "Max": "50" + }, + { + "Name": "rules-per-application-load-balancer", + "Max": "100" + }, + { + "Name": "network-load-balancers", + "Max": "50" + }, + { + "Name": "targets-per-network-load-balancer", + "Max": "3000" + }, + { + "Name": "targets-per-availability-zone-per-network-load-balancer", + "Max": "500" + }, + { + "Name": "listeners-per-network-load-balancer", + "Max": "50" + }, + { + "Name": "condition-values-per-alb-rule", + "Max": "5" + }, + { + "Name": "condition-wildcards-per-alb-rule", + "Max": "5" + }, + { + "Name": "target-groups-per-application-load-balancer", + "Max": "100" + }, + { + "Name": "target-groups-per-action-on-application-load-balancer", + "Max": "5" + }, + { + "Name": "target-groups-per-action-on-network-load-balancer", + "Max": "1" + }, + { + "Name": "certificates-per-application-load-balancer", + "Max": "25" + }, + { + "Name": "certificates-per-network-load-balancer", + "Max": "25" + }, + { + "Name": "targets-per-target-group", + "Max": "1000" + }, + { + "Name": "target-id-registrations-per-application-load-balancer", + "Max": "1000" + }, + { + "Name": "network-load-balancer-enis-per-vpc", + "Max": "1200" + }, + { + "Name": "application-load-balancers", + "Max": "50" + }, + { + "Name": "gateway-load-balancers", + "Max": "100" + }, + { + "Name": "gateway-load-balancers-per-vpc", + "Max": "100" + }, + { + "Name": "geneve-target-groups", + "Max": "100" + }, + { + "Name": "targets-per-availability-zone-per-gateway-load-balancer", + "Max": "300" + } ] } + +For more information, see `Quotas `__ in the *AWS General Reference*. \ No newline at end of file diff --git a/awscli/examples/elbv2/describe-ssl-policies.rst b/awscli/examples/elbv2/describe-ssl-policies.rst index 97c26454788e..eb8255b29cc1 100644 --- a/awscli/examples/elbv2/describe-ssl-policies.rst +++ b/awscli/examples/elbv2/describe-ssl-policies.rst @@ -1,48 +1,76 @@ -**To describe a policy used for SSL negotiation** +**Example 1: To list the policies used for SSL negotiation by load balancer type** -The following ``describe-ssl-policies`` example displays details of the specified policy used for SSL negotiation. :: +The following ``describe-ssl-policies`` example displays the names of the polices that you can use for SSL negotiation with an Application Load Balancer. The example uses the ``--query`` parameter to display only the names of the policies. :: aws elbv2 describe-ssl-policies \ - --names ELBSecurityPolicy-2016-08 - + --load-balancer-type application \ + --query SslPolicies[*].Name + +Output:: + + [ + "ELBSecurityPolicy-2016-08", + "ELBSecurityPolicy-TLS13-1-2-2021-06", + "ELBSecurityPolicy-TLS13-1-2-Res-2021-06", + "ELBSecurityPolicy-TLS13-1-2-Ext1-2021-06", + "ELBSecurityPolicy-TLS13-1-2-Ext2-2021-06", + "ELBSecurityPolicy-TLS13-1-1-2021-06", + "ELBSecurityPolicy-TLS13-1-0-2021-06", + "ELBSecurityPolicy-TLS13-1-3-2021-06", + "ELBSecurityPolicy-TLS-1-2-2017-01", + "ELBSecurityPolicy-TLS-1-1-2017-01", + "ELBSecurityPolicy-TLS-1-2-Ext-2018-06", + "ELBSecurityPolicy-FS-2018-06", + "ELBSecurityPolicy-2015-05", + "ELBSecurityPolicy-TLS-1-0-2015-04", + "ELBSecurityPolicy-FS-1-2-Res-2019-08", + "ELBSecurityPolicy-FS-1-1-2019-08", + "ELBSecurityPolicy-FS-1-2-2019-08", + "ELBSecurityPolicy-FS-1-2-Res-2020-10" + ] + +**Example 2: To list the policies that support a specific protocol** + +The following ``describe-ssl-policies`` example displays the names of the polices that support the TLS 1.3 protocol. The example uses the ``--query`` parameter to display only the names of the policies. :: + + aws elbv2 describe-ssl-policies \ + --load-balancer-type application \ + --query SslPolicies[?contains(SslProtocols,'TLSv1.3')].Name + Output:: - { - "SslPolicies": [ - { - "SslProtocols": [ - "TLSv1", - "TLSv1.1", - "TLSv1.2" - ], - "Ciphers": [ - { - "Priority": 1, - "Name": "ECDHE-ECDSA-AES128-GCM-SHA256" - }, - { - "Priority": 2, - "Name": "ECDHE-RSA-AES128-GCM-SHA256" - }, - { - "Priority": 3, - "Name": "ECDHE-ECDSA-AES128-SHA256" - }, - - ...some output truncated... - - { - "Priority": 18, - "Name": "AES256-SHA" - } - ], - "Name": "ELBSecurityPolicy-2016-08" - } - ] - } - -**To describe all policies used for SSL negotiation** - -The following ``describe-ssl-policies`` example displays details for all the policies that you can use for SSL negotiation. :: - - aws elbv2 describe-ssl-policies + [ + "ELBSecurityPolicy-TLS13-1-2-2021-06", + "ELBSecurityPolicy-TLS13-1-2-Res-2021-06", + "ELBSecurityPolicy-TLS13-1-2-Ext1-2021-06", + "ELBSecurityPolicy-TLS13-1-2-Ext2-2021-06", + "ELBSecurityPolicy-TLS13-1-1-2021-06", + "ELBSecurityPolicy-TLS13-1-0-2021-06", + "ELBSecurityPolicy-TLS13-1-3-2021-06" + ] + +**Example 3: To display the ciphers for a policy** + +The following ``describe-ssl-policies`` example displays the names of the ciphers for the specified policy. The example uses the ``--query`` parameter to display only the cipher names. The first cipher in the list has priority 1, and the remaining ciphers are in priority order. :: + + aws elbv2 describe-ssl-policies \ + --names ELBSecurityPolicy-TLS13-1-2-2021-06 \ + --query SslPolicies[*].Ciphers[*].Name + +Output:: + + [ + "TLS_AES_128_GCM_SHA256", + "TLS_AES_256_GCM_SHA384", + "TLS_CHACHA20_POLY1305_SHA256", + "ECDHE-ECDSA-AES128-GCM-SHA256", + "ECDHE-RSA-AES128-GCM-SHA256", + "ECDHE-ECDSA-AES128-SHA256", + "ECDHE-RSA-AES128-SHA256", + "ECDHE-ECDSA-AES256-GCM-SHA384", + "ECDHE-RSA-AES256-GCM-SHA384", + "ECDHE-ECDSA-AES256-SHA384", + "ECDHE-RSA-AES256-SHA384" + ] + +For more information, see `Security policies `__ in the *User Guide for Application Load Balancers*. \ No newline at end of file diff --git a/awscli/examples/elbv2/describe-target-groups.rst b/awscli/examples/elbv2/describe-target-groups.rst index 0cf323988fc0..c947472f304e 100644 --- a/awscli/examples/elbv2/describe-target-groups.rst +++ b/awscli/examples/elbv2/describe-target-groups.rst @@ -10,39 +10,46 @@ Output:: { "TargetGroups": [ { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "TargetGroupName": "my-targets", "Protocol": "HTTP", "Port": 80, "VpcId": "vpc-3ac0fb5f", - "TargetType": "instance", + "HealthCheckProtocol": "HTTP", + "HealthCheckPort": "traffic-port", "HealthCheckEnabled": true, - "UnhealthyThresholdCount": 2, + "HealthCheckIntervalSeconds": 30, + "HealthCheckTimeoutSeconds": 5, "HealthyThresholdCount": 5, + "UnhealthyThresholdCount": 2, "HealthCheckPath": "/", "Matcher": { "HttpCode": "200" }, - "HealthCheckProtocol": "HTTP", - "HealthCheckPort": "traffic-port", - "HealthCheckIntervalSeconds": 30, - "HealthCheckTimeoutSeconds": 5, - "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "LoadBalancerArns": [ "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" - ] + ], + "TargetType": "instance", + "ProtocolVersion": "HTTP1", + "IpAddressType": "ipv4" } ] } **Example 2: To describe all target groups for a load balancer** -The following ``describe-target-groups`` example displays details for all target groups for the specified load balancer. :: +The following ``describe-target-groups`` example displays details for all target groups for the specified load balancer. The example uses the ``--query`` parameter to display only the target group names. :: aws elbv2 describe-target-groups \ - --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 + --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ + --query TargetGroups[*].TargetGroupName -**Example 3: To describe all target groups** +Output:: -The following ``describe-target-groups`` example dislplays details for all of your target groups. :: + [ + "my-instance-targets", + "my-ip-targets", + "my-lambda-target" + ] - aws elbv2 describe-target-groups +For more information, see `Target groups `__ in the *Applicaion Load Balancers Guide*. \ No newline at end of file diff --git a/awscli/examples/elbv2/modify-target-group.rst b/awscli/examples/elbv2/modify-target-group.rst index d967e47c11a0..359b5f387191 100644 --- a/awscli/examples/elbv2/modify-target-group.rst +++ b/awscli/examples/elbv2/modify-target-group.rst @@ -1,33 +1,41 @@ **To modify the health check configuration for a target group** -This example changes the configuration of the health checks used to evaluate the health of the targets for the specified target group. +The following ``modify-target-group`` example changes the configuration of the health checks used to evaluate the health of the targets for the specified target group. Note that due to the way the CLI parses commas, you must surround the range for the ``--matcher`` option with single quotes instead of double quotes. :: -Command:: + aws elbv2 modify-target-group \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f \ + --health-check-protocol HTTPS \ + --health-check-port 443 \ + --matcher HttpCode='200,299' - aws elbv2 modify-target-group --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f --health-check-protocol HTTPS --health-check-port 443 - Output:: - { - "TargetGroups": [ - { - "HealthCheckIntervalSeconds": 30, - "VpcId": "vpc-3ac0fb5f", - "Protocol": "HTTPS", - "HealthCheckTimeoutSeconds": 5, - "HealthCheckProtocol": "HTTPS", - "LoadBalancerArns": [ - "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" - ], - "UnhealthyThresholdCount": 2, - "HealthyThresholdCount": 5, - "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f", - "Matcher": { - "HttpCode": "200" - }, - "HealthCheckPort": "443", - "Port": 443, - "TargetGroupName": "my-https-targets" - } - ] - } + { + "TargetGroups": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f", + "TargetGroupName": "my-https-targets", + "Protocol": "HTTPS", + "Port": 443, + "VpcId": "vpc-3ac0fb5f", + "HealthCheckProtocol": "HTTPS", + "HealthCheckPort": "443", + "HealthCheckEnabled": true, + "HealthCheckIntervalSeconds": 30, + "HealthCheckTimeoutSeconds": 5, + "HealthyThresholdCount": 5, + "UnhealthyThresholdCount": 2, + "Matcher": { + "HttpCode": "200,299" + }, + "LoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ], + "TargetType": "instance", + "ProtocolVersion": "HTTP1", + "IpAddressType": "ipv4" + } + ] + } + +For more information, see `Target groups `__ in the *Applicaion Load Balancers Guide*. \ No newline at end of file diff --git a/awscli/examples/iot/create-stream.rst b/awscli/examples/iot/create-stream.rst index 107f9f421e9f..1e7db3b6d2c2 100644 --- a/awscli/examples/iot/create-stream.rst +++ b/awscli/examples/iot/create-stream.rst @@ -18,7 +18,7 @@ Contents of ``create-stream.json``:: "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" } } - ] + ], "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role" } @@ -31,4 +31,4 @@ Output:: "streamVersion": "1" } -For more information, see `CreateStream `__ in the *AWS IoT API Reference*. +For more information, see `CreateStream `__ in the *AWS IoT API Reference*. \ No newline at end of file diff --git a/awscli/examples/iot/list-job-executions-for-job.rst b/awscli/examples/iot/list-job-executions-for-job.rst index 910d99931565..1a5b97f201ae 100644 --- a/awscli/examples/iot/list-job-executions-for-job.rst +++ b/awscli/examples/iot/list-job-executions-for-job.rst @@ -1,22 +1,25 @@ **To list the jobs in your AWS account** -The following ``list-job-executions-for-job`` example lists all jobs in your AWS account, sorted by the job status. :: +The following ``list-job-executions-for-job`` example lists all job executions for a job in your AWS account, specified by the jobId. :: - aws iot list-jobs + aws iot list-job-executions-for-job \ + --job-id my-ota-job Output:: { - "jobs": [ - { - "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", - "jobId": "example-job-01", - "targetSelection": "SNAPSHOT", - "status": "IN_PROGRESS", - "createdAt": 1560787022.733, - "lastUpdatedAt": 1560787026.294 - } - ] - } + "executionSummaries": [ + { + "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/my_thing", + "jobExecutionSummary": { + "status": "QUEUED", + "queuedAt": "2022-03-07T15:58:42.195000-08:00", + "lastUpdatedAt": "2022-03-07T15:58:42.195000-08:00", + "executionNumber": 1, + "retryAttempt": 0 + } + } + ] + } -For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/create-encoder-configuration.rst b/awscli/examples/ivs-realtime/create-encoder-configuration.rst new file mode 100644 index 000000000000..9ec953bae8f6 --- /dev/null +++ b/awscli/examples/ivs-realtime/create-encoder-configuration.rst @@ -0,0 +1,24 @@ +**To create a composition encoder configuration** + +The following ``create-encoder-configuration`` example creates a composition encoder configuration with the specified properties. :: + + aws ivs-realtime create-encoder-configuration \ + --name test-ec --video bitrate=3500000,framerate=30.0,height=1080,width=1920 + +Output:: + + { + "encoderConfiguration": { + "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef", + "name": "test-ec", + "tags": {}, + "video": { + "bitrate": 3500000, + "framerate": 30, + "height": 1080, + "width": 1920 + } + } + } + +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/create-storage-configuration.rst b/awscli/examples/ivs-realtime/create-storage-configuration.rst new file mode 100644 index 000000000000..09d535e6c4a8 --- /dev/null +++ b/awscli/examples/ivs-realtime/create-storage-configuration.rst @@ -0,0 +1,21 @@ +**To create a composition storage configuration** + +The following ``create-storage-configuration`` example creates a composition storage configuration with the specified properties. :: + + aws ivs-realtime create-storage-configuration \ + --name "test-sc" --s3 "bucketName=test-bucket-name" + +Output:: + + { + "storageConfiguration": { + "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef", + "name": "test-sc", + "s3": { + "bucketName": "test-bucket-name" + }, + "tags": {} + } + } + +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/delete-encoder-configuration.rst b/awscli/examples/ivs-realtime/delete-encoder-configuration.rst new file mode 100644 index 000000000000..0826c5e30972 --- /dev/null +++ b/awscli/examples/ivs-realtime/delete-encoder-configuration.rst @@ -0,0 +1,10 @@ +**To delete a composition encoder configuration** + +The following ``delete-encoder-configuration`` deletes the composition encoder configuration specified by the given ARN (Amazon Resource Name). :: + + aws ivs-realtime delete-encoder-configuration \ + --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" + +This command produces no output. + +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/delete-storage-configuration.rst b/awscli/examples/ivs-realtime/delete-storage-configuration.rst new file mode 100644 index 000000000000..fc532178008e --- /dev/null +++ b/awscli/examples/ivs-realtime/delete-storage-configuration.rst @@ -0,0 +1,10 @@ +**To delete a composition storage configuration** + +The following ``delete-storage-configuration`` deletes the composition storage configuration specified by the given ARN (Amazon Resource Name). :: + + aws ivs-realtime delete-storage-configuration \ + --arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef" + +This command produces no output. + +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/get-composition.rst b/awscli/examples/ivs-realtime/get-composition.rst new file mode 100644 index 000000000000..400ca707883d --- /dev/null +++ b/awscli/examples/ivs-realtime/get-composition.rst @@ -0,0 +1,61 @@ +**To get a composition** + +The following ``get-composition`` example gets the composition for the ARN (Amazon Resource Name) specified. :: + + aws ivs-realtime get-composition \ + --name arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh" + +Output:: + + { + "composition": { + "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", + "destinations": [ + { + "configuration": { + "channel": { + "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", + "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" + }, + "name": "" + }, + "id": "AabBCcdDEefF", + "startTime": "2023-10-16T23:26:00+00:00", + "state": "ACTIVE" + }, + { + "configuration": { + "name": "", + "s3": { + "encoderConfigurationArns": [ + "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" + ], + "recordingConfiguration": { + "format": "HLS" + }, + "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE" + } + }, + "detail": { + "s3": { + "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" + } + }, + "id": "GHFabcgefABC", + "startTime": "2023-10-16T23:26:00+00:00", + "state": "STARTING" + } + ], + "layout": { + "grid": { + "featuredParticipantAttribute": "" + } + }, + "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", + "startTime": "2023-10-16T23:24:00+00:00", + "state": "ACTIVE", + "tags": {} + } + } + +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/get-encoder-configuration.rst b/awscli/examples/ivs-realtime/get-encoder-configuration.rst new file mode 100644 index 000000000000..b8990199847b --- /dev/null +++ b/awscli/examples/ivs-realtime/get-encoder-configuration.rst @@ -0,0 +1,24 @@ +**To get a composition encoder configuration** + +The following ``get-encoder-configuration`` example gets the composition encoder configuration specified by the given ARN (Amazon Resource Name). :: + + aws ivs-realtime get-encoder-configuration \ + --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh" + +Output:: + + { + "encoderConfiguration": { + "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh", + "name": "test-ec", + "tags": {}, + "video": { + "bitrate": 3500000, + "framerate": 30, + "height": 1080, + "width": 1920 + } + } + } + +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/get-storage-configuration.rst b/awscli/examples/ivs-realtime/get-storage-configuration.rst new file mode 100644 index 000000000000..4d21230d8388 --- /dev/null +++ b/awscli/examples/ivs-realtime/get-storage-configuration.rst @@ -0,0 +1,21 @@ +**To get a composition storage configuration** + +The following ``get-storage-configuration`` example gets the composition storage configuration specified by the given ARN (Amazon Resource Name). :: + + aws ivs-realtime get-storage-configuration \ + --name arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh" + +Output:: + + { + "storageConfiguration": { + "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh", + "name": "test-sc", + "s3": { + "bucketName": "test-bucket-name" + }, + "tags": {} + } + } + +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/list-compositions.rst b/awscli/examples/ivs-realtime/list-compositions.rst new file mode 100644 index 000000000000..9a0409bcee91 --- /dev/null +++ b/awscli/examples/ivs-realtime/list-compositions.rst @@ -0,0 +1,50 @@ +**To get a list of compositions** + +The following ``list-compositions`` lists all compositions for your AWS account, in the AWS region where the API request is processed. :: + + aws ivs-realtime list-compositions + +Output:: + + { + "compositions": [ + { + "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", + "destinations": [ + { + "id": "AabBCcdDEefF", + "startTime": "2023-10-16T23:25:23+00:00", + "state": "ACTIVE" + } + ], + "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", + "startTime": "2023-10-16T23:25:21+00:00", + "state": "ACTIVE", + "tags": {} + }, + { + "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/ABcdabCDefgh", + "destinations": [ + { + "endTime": "2023-10-16T23:25:00.786512+00:00", + "id": "aABbcCDdeEFf", + "startTime": "2023-10-16T23:24:01+00:00", + "state": "STOPPED" + }, + { + "endTime": "2023-10-16T23:25:00.786512+00:00", + "id": "deEFfaABbcCD", + "startTime": "2023-10-16T23:24:01+00:00", + "state": "STOPPED" + } + ], + "endTime": "2023-10-16T23:25:00+00:00", + "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/efghabcdABCD", + "startTime": "2023-10-16T23:24:00+00:00", + "state": "STOPPED", + "tags": {} + } + ] + } + +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/list-encoder-configurations.rst b/awscli/examples/ivs-realtime/list-encoder-configurations.rst new file mode 100644 index 000000000000..3bbcbe2654fc --- /dev/null +++ b/awscli/examples/ivs-realtime/list-encoder-configurations.rst @@ -0,0 +1,24 @@ +**To list composition encoder configurations** + +The following ``list-encoder-configurations`` lists all composition encoder configurations for your AWS account, in the AWS region where the API request is processed. :: + + aws ivs-realtime list-encoder-configurations + +Output:: + + { + "encoderConfigurations": [ + { + "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh", + "name": "test-ec-1", + "tags": {} + }, + { + "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABCefgEFGabc", + "name": "test-ec-2", + "tags": {} + } + ] + } + +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/list-stages.rst b/awscli/examples/ivs-realtime/list-stages.rst index eead7899740f..4aa41e517476 100644 --- a/awscli/examples/ivs-realtime/list-stages.rst +++ b/awscli/examples/ivs-realtime/list-stages.rst @@ -1,6 +1,6 @@ **To get summary information about all stages** -The following ``list-stages`` example lists all channels for your AWS account, in the AWS region where the API request is processed. :: +The following ``list-stages`` example lists all stages for your AWS account, in the AWS region where the API request is processed. :: aws ivs-realtime list-stages @@ -29,4 +29,4 @@ Output:: ] } -For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/list-storage-configurations.rst b/awscli/examples/ivs-realtime/list-storage-configurations.rst new file mode 100644 index 000000000000..dbcbc29fa946 --- /dev/null +++ b/awscli/examples/ivs-realtime/list-storage-configurations.rst @@ -0,0 +1,30 @@ +**To list composition storage configurations** + +The following ``list-storage-configurations`` lists all composition storage configurations for your AWS account, in the AWS region where the API request is processed. :: + + aws ivs-realtime list-storage-configurations + +Output:: + + { + "storageConfigurations": [ + { + "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh", + "name": "test-sc-1", + "s3": { + "bucketName": "test-bucket-1-name" + }, + "tags": {} + }, + { + "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABCefgEFGabc", + "name": "test-sc-2", + "s3": { + "bucketName": "test-bucket-2-name" + }, + "tags": {} + } + ] + } + +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/start-composition.rst b/awscli/examples/ivs-realtime/start-composition.rst new file mode 100644 index 000000000000..0274eab05d8f --- /dev/null +++ b/awscli/examples/ivs-realtime/start-composition.rst @@ -0,0 +1,63 @@ +**To start a composition** + +The following ``start-composition`` example starts a composition for the specified stage to be streamed to the specified locations. :: + + aws ivs-realtime start-composition \ + --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \ + --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \ + "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \ + {"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \ + "storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]' + +Output:: + + { + "composition": { + "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh", + "destinations": [ + { + "configuration": { + "channel": { + "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", + "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" + }, + "name": "" + }, + "id": "AabBCcdDEefF", + "state": "STARTING" + }, + { + "configuration": { + "name": "", + "s3": { + "encoderConfigurationArns": [ + "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" + ], + "recordingConfiguration": { + "format": "HLS" + }, + "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE" + } + }, + "detail": { + "s3": { + "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite" + } + }, + "id": "GHFabcgefABC", + "state": "STARTING" + } + ], + "layout": { + "grid": { + "featuredParticipantAttribute": "" + } + }, + "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd", + "startTime": "2023-10-16T23:24:00+00:00", + "state": "STARTING", + "tags": {} + } + } + +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/ivs-realtime/stop-composition.rst b/awscli/examples/ivs-realtime/stop-composition.rst new file mode 100644 index 000000000000..e88e78bdc5dc --- /dev/null +++ b/awscli/examples/ivs-realtime/stop-composition.rst @@ -0,0 +1,10 @@ +**To stop a composition** + +The following ``stop-composition`` stops the composition specified by the given ARN (Amazon Resource Name). :: + + aws ivs-realtime stop-composition \ + --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh" + +This command produces no output. + +For more information, see `Enabling Multiple Hosts on an Amazon IVS Stream `__ in the *Amazon Interactive Video Service User Guide*. \ No newline at end of file diff --git a/awscli/examples/lambda/create-function.rst b/awscli/examples/lambda/create-function.rst index eda3aca47dce..40fe331b8775 100755 --- a/awscli/examples/lambda/create-function.rst +++ b/awscli/examples/lambda/create-function.rst @@ -4,13 +4,14 @@ The following ``create-function`` example creates a Lambda function named ``my-f aws lambda create-function \ --function-name my-function \ - --runtime nodejs14.x \ + --runtime nodejs18.x \ --zip-file fileb://my-function.zip \ --handler my-function.handler \ --role arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-tges6bf4 -Contents of ``my-function.zip``: -This file is a deployment package that contains your function code and any dependencies. +Contents of ``my-function.zip``:: + + This file is a deployment package that contains your function code and any dependencies. Output:: @@ -27,9 +28,9 @@ Output:: "Version": "$LATEST", "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", "Timeout": 3, - "LastModified": "2019-08-14T22:26:11.234+0000", + "LastModified": "2023-10-14T22:26:11.234+0000", "Handler": "my-function.handler", - "Runtime": "nodejs14.x", + "Runtime": "nodejs18.x", "Description": "" } diff --git a/awscli/examples/lambda/get-layer-version-by-arn.rst b/awscli/examples/lambda/get-layer-version-by-arn.rst index 643f3ec7d4a5..3d589e820d9b 100755 --- a/awscli/examples/lambda/get-layer-version-by-arn.rst +++ b/awscli/examples/lambda/get-layer-version-by-arn.rst @@ -3,15 +3,15 @@ The following ``get-layer-version-by-arn`` example displays information about the layer version with the specified Amazon Resource Name (ARN). :: aws lambda get-layer-version-by-arn \ - --arn "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python37-SciPy1x:2" + --arn "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python311-SciPy1x:2" Output:: { - "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python37-SciPy1x:2", - "Description": "AWS Lambda SciPy layer for Python 3.7 (scipy-1.1.0, numpy-1.15.4) https://github.com/scipy/scipy/releases/tag/v1.1.0 https://github.com/numpy/numpy/releases/tag/v1.15.4", - "CreatedDate": "2018-11-12T10:09:38.398+0000", - "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python37-SciPy1x", + "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python311-SciPy1x:2", + "Description": "AWS Lambda SciPy layer for Python 3.11 (scipy-1.1.0, numpy-1.15.4) https://github.com/scipy/scipy/releases/tag/v1.1.0 https://github.com/numpy/numpy/releases/tag/v1.15.4", + "CreatedDate": "2023-10-12T10:09:38.398+0000", + "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python311-SciPy1x", "Content": { "CodeSize": 41784542, "CodeSha256": "GGmv8ocUw4cly0T8HL0Vx/f5V4RmSCGNjDIslY4VskM=", @@ -19,9 +19,9 @@ Output:: }, "Version": 2, "CompatibleRuntimes": [ - "python3.7" + "python3.11" ], "LicenseInfo": "SciPy: https://github.com/scipy/scipy/blob/main/LICENSE.txt, NumPy: https://github.com/numpy/numpy/blob/main/LICENSE.txt" } -For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. \ No newline at end of file diff --git a/awscli/examples/lambda/get-layer-version.rst b/awscli/examples/lambda/get-layer-version.rst index ac2bb5a27e24..690f9e26ca0e 100755 --- a/awscli/examples/lambda/get-layer-version.rst +++ b/awscli/examples/lambda/get-layer-version.rst @@ -21,9 +21,9 @@ Output:: "Version": 1, "LicenseInfo": "MIT", "CompatibleRuntimes": [ - "python3.6", - "python3.7" + "python3.10", + "python3.11" ] } -For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. \ No newline at end of file diff --git a/awscli/examples/lambda/list-functions.rst b/awscli/examples/lambda/list-functions.rst index 83576e9a35ff..7cf2d23e10cc 100755 --- a/awscli/examples/lambda/list-functions.rst +++ b/awscli/examples/lambda/list-functions.rst @@ -22,8 +22,8 @@ Output:: "Handler": "helloworld.handler", "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", "Timeout": 3, - "LastModified": "2019-09-23T18:32:33.857+0000", - "Runtime": "nodejs10.x", + "LastModified": "2023-09-23T18:32:33.857+0000", + "Runtime": "nodejs18.x", "Description": "" }, { @@ -45,8 +45,8 @@ Output:: "Handler": "index.handler", "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", "Timeout": 3, - "LastModified": "2019-10-01T16:47:28.490+0000", - "Runtime": "nodejs10.x", + "LastModified": "2023-10-01T16:47:28.490+0000", + "Runtime": "nodejs18.x", "Description": "" }, { @@ -78,11 +78,11 @@ Output:: "Handler": "lambda_function.lambda_handler", "Role": "arn:aws:iam::123456789012:role/service-role/my-python-function-role-z5g7dr6n", "Timeout": 3, - "LastModified": "2019-10-01T19:40:41.643+0000", - "Runtime": "python3.7", + "LastModified": "2023-10-01T19:40:41.643+0000", + "Runtime": "python3.11", "Description": "" } ] } -For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. \ No newline at end of file diff --git a/awscli/examples/lambda/list-layer-versions.rst b/awscli/examples/lambda/list-layer-versions.rst index a78bf4b98261..1511430d125f 100755 --- a/awscli/examples/lambda/list-layer-versions.rst +++ b/awscli/examples/lambda/list-layer-versions.rst @@ -10,18 +10,16 @@ Output:: { "Layers": [ { - "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", "Version": 2, "Description": "My layer", - "CreatedDate": "2018-11-15T00:37:46.592+0000", + "CreatedDate": "2023-11-15T00:37:46.592+0000", "CompatibleRuntimes": [ - "python3.6", - "python3.7" + "python3.10", + "python3.11" ] - } ] } -For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. \ No newline at end of file diff --git a/awscli/examples/lambda/list-layers.rst b/awscli/examples/lambda/list-layers.rst index d633f50e4beb..b57fcb7c2003 100755 --- a/awscli/examples/lambda/list-layers.rst +++ b/awscli/examples/lambda/list-layers.rst @@ -1,9 +1,9 @@ **To list the layers that are compatible with your function's runtime** -The following ``list-layers`` example displays information about layers that are compatible with the Python 3.7 runtime. :: +The following ``list-layers`` example displays information about layers that are compatible with the Python 3.11 runtime. :: aws lambda list-layers \ - --compatible-runtime python3.7 + --compatible-runtime python3.11 Output:: @@ -16,15 +16,14 @@ Output:: "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", "Version": 2, "Description": "My layer", - "CreatedDate": "2018-11-15T00:37:46.592+0000", + "CreatedDate": "2023-11-15T00:37:46.592+0000", "CompatibleRuntimes": [ - "python3.6", - "python3.7" + "python3.10", + "python3.11" ] } } ] } - -For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. \ No newline at end of file diff --git a/awscli/examples/lambda/publish-layer-version.rst b/awscli/examples/lambda/publish-layer-version.rst index 00e4efbf8b5d..daf955176ef4 100755 --- a/awscli/examples/lambda/publish-layer-version.rst +++ b/awscli/examples/lambda/publish-layer-version.rst @@ -7,7 +7,7 @@ The following ``publish-layer-version`` example creates a new Python library lay --description "My Python layer" \ --license-info "MIT" \ --content S3Bucket=lambda-layers-us-west-2-123456789012,S3Key=layer.zip \ - --compatible-runtimes python3.6 python3.7 + --compatible-runtimes python3.10 python3.11 Output:: @@ -20,13 +20,13 @@ Output:: "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer", "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1", "Description": "My Python layer", - "CreatedDate": "2018-11-14T23:03:52.894+0000", + "CreatedDate": "2023-11-14T23:03:52.894+0000", "Version": 1, "LicenseInfo": "MIT", "CompatibleRuntimes": [ - "python3.6", - "python3.7" + "python3.10", + "python3.11" ] } -For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/abort-multipart-read-set-upload.rst b/awscli/examples/omics/abort-multipart-read-set-upload.rst new file mode 100644 index 000000000000..c4f8795a176b --- /dev/null +++ b/awscli/examples/omics/abort-multipart-read-set-upload.rst @@ -0,0 +1,11 @@ +**To stop a multipart read set upload** + +The following ``abort-multipart-read-set-upload`` example stops a multipart read set upload into your HealthOmics sequence store. :: + + aws omics abort-multipart-read-set-upload \ + --sequence-store-id 0123456789 \ + --upload-id 1122334455 + +This command produces no output. + +For more information, see `Direct upload to a sequence store `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/accept-share.rst b/awscli/examples/omics/accept-share.rst new file mode 100644 index 000000000000..6bc9d062641d --- /dev/null +++ b/awscli/examples/omics/accept-share.rst @@ -0,0 +1,14 @@ +**To accept a share of analytics store data** + +The following ``accept-share`` example accepts a share of HealthOmics analytics store data. :: + + aws omics accept-share \ + ----share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a" + +Output:: + + { + "status": "ACTIVATING" + } + +For more information, see `Cross-account sharing `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/complete-multipart-read-set-upload.rst b/awscli/examples/omics/complete-multipart-read-set-upload.rst new file mode 100644 index 000000000000..cc253f1b805d --- /dev/null +++ b/awscli/examples/omics/complete-multipart-read-set-upload.rst @@ -0,0 +1,19 @@ +**To conclude a multipart upload once you have uploaded all of the components.** + +The following ``complete-multipart-read-set-upload`` example concludes a multipart upload into a sequence store once all of the components have been uploaded. :: + + aws omics complete-multipart-read-set-upload \ + --sequence-store-id 0123456789 \ + --upload-id 1122334455 \ + --parts '[{"checksum":"gaCBQMe+rpCFZxLpoP6gydBoXaKKDA/Vobh5zBDb4W4=","partNumber":1,"partSource":"SOURCE1"}]' + + +Output:: + + { + "readSetId": "0000000001" + "readSetId": "0000000002" + "readSetId": "0000000003" + } + +For more information, see `Direct upload to a sequence store `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/create-annotation-store-version.rst b/awscli/examples/omics/create-annotation-store-version.rst new file mode 100644 index 000000000000..0e7f37021596 --- /dev/null +++ b/awscli/examples/omics/create-annotation-store-version.rst @@ -0,0 +1,22 @@ +**To create a new version of an annotation store** + +The following ``create-annotation-store-version`` example creates a new version of an annotation store. :: + + aws omics create-annotation-store-version \ + --name my_annotation_store \ + --version-name my_version + +Output:: + + { + "creationTime": "2023-07-21T17:15:49.251040+00:00", + "id": "3b93cdef69d2", + "name": "my_annotation_store", + "reference": { + "referenceArn": "arn:aws:omics:us-west-2:555555555555:referenceStore/6505293348/reference/5987565360" + }, + "status": "CREATING", + "versionName": "my_version" + } + +For more information, see `Creating new versions of annotation stores `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/create-multipart-read-set-upload.rst b/awscli/examples/omics/create-multipart-read-set-upload.rst new file mode 100644 index 000000000000..327ecd1ef8da --- /dev/null +++ b/awscli/examples/omics/create-multipart-read-set-upload.rst @@ -0,0 +1,29 @@ +**To begin a multipart read set upload.** + +The following ``create-multipart-read-set-upload`` example initiates a multipart read set upload. :: + + aws omics create-multipart-read-set-upload \ + --sequence-store-id 0123456789 \ + --name HG00146 \ + --source-file-type FASTQ \ + --subject-id mySubject\ + --sample-id mySample\ + --description "FASTQ for HG00146"\ + --generated-from "1000 Genomes" + + +Output:: + + { + "creationTime": "2022-07-13T23:25:20Z", + "description": "FASTQ for HG00146", + "generatedFrom": "1000 Genomes", + "name": "HG00146", + "sampleId": "mySample", + "sequenceStoreId": "0123456789", + "sourceFileType": "FASTQ", + "subjectId": "mySubject", + "uploadId": "1122334455" + } + +For more information, see `Direct upload to a sequence store `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/create-share.rst b/awscli/examples/omics/create-share.rst new file mode 100644 index 000000000000..d4778e6bb261 --- /dev/null +++ b/awscli/examples/omics/create-share.rst @@ -0,0 +1,18 @@ +**To create a share of a HealthOmics analytics store** + +The following ``create-share`` example shows how to create a share of a HealthOmics analytics store that can be accepted by a subscriber outside the account. :: + + aws omics create-share \ + --resource-arn "arn:aws:omics:us-west-2:555555555555:variantStore/omics_dev_var_store" \ + --principal-subscriber "123456789012" \ + --name "my_Share-123" + +Output:: + + { + "shareId": "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a", + "name": "my_Share-123", + "status": "PENDING" + } + +For more information, see `Cross-acount sharing `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/delete-annotation-store-versions.rst b/awscli/examples/omics/delete-annotation-store-versions.rst new file mode 100644 index 000000000000..44aa2c7beab7 --- /dev/null +++ b/awscli/examples/omics/delete-annotation-store-versions.rst @@ -0,0 +1,15 @@ +**To delete an annotation store version** + +The following ``delete-annotation-store-versions`` example deletes an annotation store version. :: + + aws omics delete-annotation-store-versions \ + --name my_annotation_store \ + --versions my_version + +Output:: + + { + "errors": [] + } + +For more information, see `Creating new versions of annotation stores `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/delete-share.rst b/awscli/examples/omics/delete-share.rst new file mode 100644 index 000000000000..b8b089c6f96f --- /dev/null +++ b/awscli/examples/omics/delete-share.rst @@ -0,0 +1,14 @@ +**To delete a share of HealthOmics analytics data** + +The following ``delete-share`` example deletes a cross-account share of analytics data. :: + + aws omics delete-share \ + --share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a" + +Output:: + + { + "status": "DELETING" + } + +For more information, see `Cross-account sharing `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/get-annotation-store-version.rst b/awscli/examples/omics/get-annotation-store-version.rst new file mode 100644 index 000000000000..5ef9c5e86def --- /dev/null +++ b/awscli/examples/omics/get-annotation-store-version.rst @@ -0,0 +1,24 @@ +**To retrieve the metadata for an annotation store version** + +The following ``get-annotation-store-version`` example retrieves the metadata for the requested annotation store version. :: + + aws omics get-annotation-store-version \ + --name my_annotation_store \ + --version-name my_version + +Output:: + + { + "storeId": "4934045d1c6d", + "id": "2a3f4a44aa7b", + "status": "ACTIVE", + "versionArn": "arn:aws:omics:us-west-2:555555555555:annotationStore/my_annotation_store/version/my_version", + "name": "my_annotation_store", + "versionName": "my_version", + "creationTime": "2023-07-21T17:15:49.251040+00:00", + "updateTime": "2023-07-21T17:15:56.434223+00:00", + "statusMessage": "", + "versionSizeBytes": 0 + } + +For more information, see `Creating new versions of annotation stores `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/get-share.rst b/awscli/examples/omics/get-share.rst new file mode 100644 index 000000000000..118bf4c95049 --- /dev/null +++ b/awscli/examples/omics/get-share.rst @@ -0,0 +1,21 @@ +**To retrieves the metadata about a share of a HealthOmics analytics data** + +The following ``get-share`` example retrieves the metadata for a cross-account share of analytics data. :: + + aws omics get-share \ + --share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a" + +Output:: + + { + "share": { + "shareId": "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a", + "name": "my_Share-123", + "resourceArn": "arn:aws:omics:us-west-2:555555555555:variantStore/omics_dev_var_store", + "principalSubscriber": "123456789012", + "ownerId": "555555555555", + "status": "PENDING" + } + } + +For more information, see `Cross-account sharing `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/list-annotation-store-versions.rst b/awscli/examples/omics/list-annotation-store-versions.rst new file mode 100644 index 000000000000..cfc251b7642d --- /dev/null +++ b/awscli/examples/omics/list-annotation-store-versions.rst @@ -0,0 +1,37 @@ +**To list all the versions of an annotation store.** + +The following ``list-annotation-store-versions`` example lists all versions that exist of an annotation store. :: + + aws omics list-annotation-store-versions \ + --name my_annotation_store + +Output:: + + { + "annotationStoreVersions": [ + { + "storeId": "4934045d1c6d", + "id": "2a3f4a44aa7b", + "status": "CREATING", + "versionArn": "arn:aws:omics:us-west-2:555555555555:annotationStore/my_annotation_store/version/my_version_2", + "name": "my_annotation_store", + "versionName": "my_version_2", + "creation Time": "2023-07-21T17:20:59.380043+00:00", + "versionSizeBytes": 0 + }, + { + "storeId": "4934045d1c6d", + "id": "4934045d1c6d", + "status": "ACTIVE", + "versionArn": "arn:aws:omics:us-west-2:555555555555:annotationStore/my_annotation_store/version/my_version_1", + "name": "my_annotation_store", + "versionName": "my_version_1", + "creationTime": "2023-07-21T17:15:49.251040+00:00", + "updateTime": "2023-07-21T17:15:56.434223+00:00", + "statusMessage": "", + "versionSizeBytes": 0 + } + + } + +For more information, see `Creating new versions of annotation stores `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/list-multipart-read-set-uploads.rst b/awscli/examples/omics/list-multipart-read-set-uploads.rst new file mode 100644 index 000000000000..51e7c221183a --- /dev/null +++ b/awscli/examples/omics/list-multipart-read-set-uploads.rst @@ -0,0 +1,51 @@ +**To list all multipart read set uploads and their statuses.** + +The following ``list-multipart-read-set-uploads`` example lists all multipart read set uploads and their statuses. :: + + aws omics list-multipart-read-set-uploads \ + --sequence-store-id 0123456789 + +Output:: + + { + "uploads": + [ + { + "sequenceStoreId": "0123456789", + "uploadId": "8749584421", + "sourceFileType": "FASTQ", + "subjectId": "mySubject", + "sampleId": "mySample", + "generatedFrom": "1000 Genomes", + "name": "HG00146", + "description": "FASTQ for HG00146", + "creationTime": "2023-11-29T19:22:51.349298+00:00" + }, + { + "sequenceStoreId": "0123456789", + "uploadId": "5290538638", + "sourceFileType": "BAM", + "subjectId": "mySubject", + "sampleId": "mySample", + "generatedFrom": "1000 Genomes", + "referenceArn": "arn:aws:omics:us-west-2:845448930428:referenceStore/8168613728/reference/2190697383", + "name": "HG00146", + "description": "BAM for HG00146", + "creationTime": "2023-11-29T19:23:33.116516+00:00" + }, + { + "sequenceStoreId": "0123456789", + "uploadId": "4174220862", + "sourceFileType": "BAM", + "subjectId": "mySubject", + "sampleId": "mySample", + "generatedFrom": "1000 Genomes", + "referenceArn": "arn:aws:omics:us-west-2:845448930428:referenceStore/8168613728/reference/2190697383", + "name": "HG00147", + "description": "BAM for HG00147", + "creationTime": "2023-11-29T19:23:47.007866+00:00" + } + ] + } + +For more information, see `Direct upload to a sequence store `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/list-read-set-upload-parts.rst b/awscli/examples/omics/list-read-set-upload-parts.rst new file mode 100644 index 000000000000..50def7b31604 --- /dev/null +++ b/awscli/examples/omics/list-read-set-upload-parts.rst @@ -0,0 +1,32 @@ +**To list all parts in a requested multipart upload for a sequence store.** + +The following ``list-read-set-upload-parts`` example list all parts in a requested multipart upload for a sequence store. :: + + aws omics list-read-set-upload-parts \ + --sequence-store-id 0123456789 \ + --upload-id 1122334455 \ + --part-source SOURCE1 + +Output:: + + { + "parts": [ + { + "partNumber": 1, + "partSize": 94371840, + "file": "SOURCE1", + "checksum": "984979b9928ae8d8622286c4a9cd8e99d964a22d59ed0f5722e1733eb280e635", + "lastUpdatedTime": "2023-02-02T20:14:47.533000+00:00" + } + { + "partNumber": 2, + "partSize": 10471840, + "file": "SOURCE1", + "checksum": "984979b9928ae8d8622286c4a9cd8e99d964a22d59ed0f5722e1733eb280e635", + "lastUpdatedTime": "2023-02-02T20:14:47.533000+00:00" + } + ] + + } + +For more information, see `Direct upload to a sequence store `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/list-shares.rst b/awscli/examples/omics/list-shares.rst new file mode 100644 index 000000000000..755e470aba0d --- /dev/null +++ b/awscli/examples/omics/list-shares.rst @@ -0,0 +1,41 @@ +**To list the available shares of a HealthOmics analytics data** + +The following ``list-shares`` example lists all shares that have been created for a resource-owner. :: + + aws omics list-shares \ + --resource-owner SELF + +Output:: + + { + "shares": [ + { + "shareId": "595c1cbd-a008-4eca-a887-954d30c91c6e", + "name": "myShare", + "resourceArn": "arn:aws:omics:us-west-2:555555555555:variantStore/store_1", + "principalSubscriber": "123456789012", + "ownerId": "555555555555", + "status": "PENDING" + } + { + "shareId": "39b65d0d-4368-4a19-9814-b0e31d73c10a", + "name": "myShare3456", + "resourceArn": "arn:aws:omics:us-west-2:555555555555:variantStore/store_2", + "principalSubscriber": "123456789012", + "ownerId": "555555555555", + "status": "ACTIVE" + }, + { + "shareId": "203152f5-eef9-459d-a4e0-a691668d44ef", + "name": "myShare4", + "resourceArn": "arn:aws:omics:us-west-2:555555555555:variantStore/store_3", + "principalSubscriber": "123456789012", + "ownerId": "555555555555", + "status": "ACTIVE" + } + ] + } + + + +For more information, see `Cross-account sharing `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/omics/upload-read-set-part.rst b/awscli/examples/omics/upload-read-set-part.rst new file mode 100644 index 000000000000..ef9f5458819d --- /dev/null +++ b/awscli/examples/omics/upload-read-set-part.rst @@ -0,0 +1,18 @@ +**To upload a read set part.** + +The following ``upload-read-set-part`` example uploads a specified part of a read set. :: + + aws omics upload-read-set-part \ + --sequence-store-id 0123456789 \ + --upload-id 1122334455 \ + --part-source SOURCE1 \ + --part-number 1 \ + --payload /path/to/file/read_1_part_1.fastq.gz + +Output:: + + { + "checksum": "984979b9928ae8d8622286c4a9cd8e99d964a22d59ed0f5722e1733eb280e635" + } + +For more information, see `Direct upload to a sequence store `__ in the *AWS HealthOmics User Guide*. \ No newline at end of file diff --git a/awscli/examples/secretsmanager/batch-get-secret-value.rst b/awscli/examples/secretsmanager/batch-get-secret-value.rst new file mode 100644 index 000000000000..05ed420d21ef --- /dev/null +++ b/awscli/examples/secretsmanager/batch-get-secret-value.rst @@ -0,0 +1,94 @@ +**Example 1: To retrieve the secret value for a group of secrets listed by name** + +The following ``batch-get-secret-value`` example gets the secret value secrets for three secrets. :: + + aws secretsmanager batch-get-secret-value \ + --secret-id-list MySecret1 MySecret2 MySecret3 + +Output:: + + + { + "SecretValues": [ + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MySecret1-a1b2c3", + "Name": "MySecret1", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", + "SecretString": "{\"username\":\"diego_ramirez\",\"password\":\"EXAMPLE-PASSWORD\",\"engine\":\"mysql\",\"host\":\"secretsmanagertutorial.cluster.us-west-2.rds.amazonaws.com\",\"port\":3306,\"dbClusterIdentifier\":\"secretsmanagertutorial\"}", + "VersionStages": [ + "AWSCURRENT" + ], + "CreatedDate": "1523477145.729" + }, + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MySecret2-a1b2c3", + "Name": "MySecret2", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", + "SecretString": "{\"username\":\"akua_mansa\",\"password\":\"EXAMPLE-PASSWORD\"", + "VersionStages": [ + "AWSCURRENT" + ], + "CreatedDate": "1673477781.275" + }, + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MySecret3-a1b2c3", + "Name": "MySecret3", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEccccc", + "SecretString": "{\"username\":\"jie_liu\",\"password\":\"EXAMPLE-PASSWORD\"", + "VersionStages": [ + "AWSCURRENT" + ], + "CreatedDate": "1373477721.124" + } + ], + "Errors": [] + } + +For more information, see `Retrieve a group of secrets in a batch `__ in the *AWS Secrets Manager User Guide*. + +**Example 2: To retrieve the secret value for a group of secrets selected by filter** + +The following ``batch-get-secret-value`` example gets the secret value secrets in your account that have ``MySecret`` in the name. Filtering by name is case sensitive. :: + + aws secretsmanager batch-get-secret-value \ + --filters Key="name",Values="MySecret" + +Output:: + + { + "SecretValues": [ + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MySecret1-a1b2c3", + "Name": "MySecret1", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", + "SecretString": "{\"username\":\"diego_ramirez\",\"password\":\"EXAMPLE-PASSWORD\",\"engine\":\"mysql\",\"host\":\"secretsmanagertutorial.cluster.us-west-2.rds.amazonaws.com\",\"port\":3306,\"dbClusterIdentifier\":\"secretsmanagertutorial\"}", + "VersionStages": [ + "AWSCURRENT" + ], + "CreatedDate": "1523477145.729" + }, + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MySecret2-a1b2c3", + "Name": "MySecret2", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", + "SecretString": "{\"username\":\"akua_mansa\",\"password\":\"EXAMPLE-PASSWORD\"", + "VersionStages": [ + "AWSCURRENT" + ], + "CreatedDate": "1673477781.275" + }, + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MySecret3-a1b2c3", + "Name": "MySecret3", + "VersionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEccccc", + "SecretString": "{\"username\":\"jie_liu\",\"password\":\"EXAMPLE-PASSWORD\"", + "VersionStages": [ + "AWSCURRENT" + ], + "CreatedDate": "1373477721.124" + } + ], + "Errors": [] + } + +For more information, see `Retrieve a group of secrets in a batch `__ in the *AWS Secrets Manager User Guide*. \ No newline at end of file