awscli 1.38.15__py3-none-any.whl → 1.38.17__py3-none-any.whl

awscli/__init__.py

@@ -18,7 +18,7 @@ A Universal Command Line Environment for Amazon Web Services.
 
 import os
 
-__version__ = '1.38.15'
+__version__ = '1.38.17'
 
 #
 # Get our data path to be added to botocore's search path

awscli/examples/ecs/create-service.rst

@@ -9,7 +9,7 @@ The following ``create-service`` example shows how to create a service using a F
         --desired-count 2 \
         --launch-type FARGATE \
         --platform-version LATEST \
-        --network-configuration "awsvpcConfiguration={subnets=[subnet-12344321],securityGroups=[sg-12344321],assignPublicIp=ENABLED}" \
+        --network-configuration 'awsvpcConfiguration={subnets=[subnet-12344321],securityGroups=[sg-12344321],assignPublicIp=ENABLED}' \
         --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3
 
 Output::
@@ -93,6 +93,8 @@ Output::
         }
     }
 
+For more information, see `Creating a Service <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service-console-v2.html>`__ in the *Amazon ECS Developer Guide*.
+
 **Example 2: To create a service using the EC2 launch type**
 
 The following ``create-service`` example shows how to create a service called ``ecs-simple-service`` with a task that uses the EC2 launch type. The service uses the ``sleep360`` task definition and it maintains 1 instantiation of the task. ::
@@ -145,6 +147,8 @@ Output::
         }
     }
 
+For more information, see `Creating a Service <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service-console-v2.html>`__ in the *Amazon ECS Developer Guide*.
+
 **Example 3: To create a service that uses an external deployment controller**
 
 The following ``create-service`` example creates a service that uses an external deployment controller. ::
@@ -189,11 +193,20 @@ Output::
         }
     }
 
+For more information, see `Creating a Service <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service-console-v2.html>`__ in the *Amazon ECS Developer Guide*.
+
 **Example 4: To create a new service behind a load balancer**
 
-The following ``create-service`` example shows how to create a service that is behind a load balancer. You must have a load balancer configured in the same Region as your container instance. This example uses the ``--cli-input-json`` option and a JSON input file called ``ecs-simple-service-elb.json`` with the following content::
+The following ``create-service`` example shows how to create a service that is behind a load balancer. You must have a load balancer configured in the same Region as your container instance. This example uses the ``--cli-input-json`` option and a JSON input file called ``ecs-simple-service-elb.json`` with the following content. ::
 
-    {
+    aws ecs create-service \
+        --cluster MyCluster \
+        --service-name ecs-simple-service-elb \
+        --cli-input-json file://ecs-simple-service-elb.json
+
+Contents of ``ecs-simple-service-elb.json``::
+
+     {
         "serviceName": "ecs-simple-service-elb",
         "taskDefinition": "ecs-demo",
         "loadBalancers": [
@@ -207,13 +220,6 @@ The following ``create-service`` example shows how to create a service that is b
         "role": "ecsServiceRole"
     }
 
-Command::
-
-    aws ecs create-service \
-        --cluster MyCluster \
-        --service-name ecs-simple-service-elb \
-        --cli-input-json file://ecs-simple-service-elb.json
-
 Output::
 
     {
@@ -231,7 +237,7 @@ Output::
             "roleArn": "arn:aws:iam::123456789012:role/ecsServiceRole",
             "desiredCount": 10,
             "serviceName": "ecs-simple-service-elb",
-            "clusterArn": "arn:aws:ecs:<us-west-2:123456789012:cluster/MyCluster",
+            "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
             "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/ecs-simple-service-elb",
             "deployments": [
                 {
@@ -250,4 +256,135 @@ Output::
         }
     }
 
-For more information, see `Creating a Service <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service.html>`_ in the *Amazon ECS Developer Guide*.
+For more information, see `Use load balancing to distribute Amazon ECS service traffic <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html>`__ in the *Amazon ECS Developer Guide*.
+
+**Example 5: To configure Amazon EBS volumes at service creation**
+
+The following ``create-service`` example shows how to configure Amazon EBS volumes for each task managed by the service. You must have an Amazon ECS infrastructure role configured with the ``AmazonECSInfrastructureRolePolicyForVolumes`` managed policy attached. You must specify a task definition with the same volume name as in the ``create-service`` request. This example uses the ``--cli-input-json`` option and a JSON input file called ``ecs-simple-service-ebs.json`` with the following content. ::
+
+    aws ecs create-service \
+        --cli-input-json file://ecs-simple-service-ebs.json
+
+Contents of ``ecs-simple-service-ebs.json``::
+
+    {
+        "cluster": "mycluster",
+        "taskDefinition": "mytaskdef",
+        "serviceName": "ecs-simple-service-ebs",
+        "desiredCount": 2,
+        "launchType": "FARGATE",
+        "networkConfiguration":{
+            "awsvpcConfiguration":{
+                "assignPublicIp": "ENABLED",
+                "securityGroups": ["sg-12344321"],
+                "subnets":["subnet-12344321"]
+            }
+        },
+        "volumeConfigurations": [
+            {
+                "name": "myEbsVolume",
+                "managedEBSVolume": {
+                    "roleArn":"arn:aws:iam::123456789012:role/ecsInfrastructureRole",
+                    "volumeType": "gp3",
+                    "sizeInGiB": 100,
+                    "iops": 3000, 
+                    "throughput": 125, 
+                    "filesystemType": "ext4"
+                }
+            }
+       ]
+    }
+
+Output::
+
+    {
+        "service": {
+            "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/mycluster/ecs-simple-service-ebs",
+            "serviceName": "ecs-simple-service-ebs",
+            "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/mycluster",
+            "loadBalancers": [],
+            "serviceRegistries": [],
+            "status": "ACTIVE",
+            "desiredCount": 2,
+            "runningCount": 0,
+            "pendingCount": 0,
+            "launchType": "EC2",
+            "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:3",
+            "deploymentConfiguration": {
+                "deploymentCircuitBreaker": {
+                    "enable": false,
+                    "rollback": false
+                },
+                "maximumPercent": 200,
+                "minimumHealthyPercent": 100
+            },
+            "deployments": [
+                {
+                    "id": "ecs-svc/7851020056849183687",
+                    "status": "PRIMARY",
+                    "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:3",
+                    "desiredCount": 0,
+                    "pendingCount": 0,
+                    "runningCount": 0,
+                    "failedTasks": 0,
+                    "createdAt": "2025-01-21T11:32:38.034000-06:00",
+                    "updatedAt": "2025-01-21T11:32:38.034000-06:00",
+                    "launchType": "EC2",
+                    "networkConfiguration": {
+                        "awsvpcConfiguration": {
+                            "subnets": [
+                                "subnet-12344321"
+                            ],
+                            "securityGroups": [
+                                "sg-12344321"
+                            ],
+                            "assignPublicIp": "DISABLED"
+                        }
+                    },
+                    "rolloutState": "IN_PROGRESS",
+                    "rolloutStateReason": "ECS deployment ecs-svc/7851020056849183687 in progress.",
+                    "volumeConfigurations": [
+                        {
+                            "name": "myEBSVolume",
+                            "managedEBSVolume": {
+                                "volumeType": "gp3",
+                                "sizeInGiB": 100,
+                                "iops": 3000,
+                                "throughput": 125,
+                                "roleArn": "arn:aws:iam::123456789012:role/ecsInfrastructureRole",
+                                "filesystemType": "ext4"
+                            }
+                        }
+                    ]
+                }
+            ],
+            "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS",
+            "events": [],
+            "createdAt": "2025-01-21T11:32:38.034000-06:00",
+            "placementConstraints": [],
+            "placementStrategy": [],
+            "networkConfiguration": {
+                "awsvpcConfiguration": {
+                    "subnets": [
+                        "subnet-12344321"
+                    ],
+                    "securityGroups": [
+                        "sg-12344321"
+                    ],
+                    "assignPublicIp": "DISABLED"
+                }
+            },
+            "healthCheckGracePeriodSeconds": 0,
+            "schedulingStrategy": "REPLICA",
+            "deploymentController": {
+                "type": "ECS"
+            },
+            "createdBy": "arn:aws:iam::123456789012:user/AIDACKCEVSQ6C2EXAMPLE",
+            "enableECSManagedTags": false,
+            "propagateTags": "NONE",
+            "enableExecuteCommand": false,
+            "availabilityZoneRebalancing": "DISABLED"
+        }
+    }
+
+For more information, see `Use Amazon EBS volumes with Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html>`__ in the *Amazon ECS Developer Guide*.

awscli/examples/ecs/run-task.rst

@@ -1,4 +1,4 @@
-**To run a task on your default cluster**
+**Example 1: To run a task on your default cluster**
 
 The following ``run-task`` example runs a task on the default cluster and uses a client token. ::
 
@@ -60,4 +60,129 @@ Output::
         "failures": []
     }
 
-For more information, see `Running Tasks <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_run_task.html>`__ in the *Amazon ECS Developer Guide*.
+For more information, see `Running an application as a standalone task <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/standalone-task-create.html>`__ in the *Amazon ECS Developer Guide*.
+
+**Example 2: To configure an Amazon EBS volume for a standalone task**
+
+The following ``run-task`` example configures an encrypted Amazon EBS volume for a Fargate task on the default cluster. You must have an Amazon ECS infrastructure role configured with the ``AmazonECSInfrastructureRolePolicyForVolumes`` managed policy attached. You must specify a task definition with the same volume name as in the ``run-task`` request. This example uses the ``--cli-input-json`` option and a JSON input file called ``ebs.json``. ::
+
+    aws ecs run-task \
+        --cli-input-json file://ebs.json
+
+Contents of ``ebs.json``::
+
+    {
+       "cluster": "default",
+       "taskDefinition": "mytaskdef",
+       "launchType": "FARGATE",
+       "networkConfiguration":{
+            "awsvpcConfiguration":{
+                "assignPublicIp": "ENABLED",
+                "securityGroups": ["sg-12344321"],
+                "subnets":["subnet-12344321"]
+            }
+        },
+       "volumeConfigurations": [
+            {
+                "name": "myEBSVolume",
+                "managedEBSVolume": {
+                    "volumeType": "gp3",
+                    "sizeInGiB": 100,
+                    "roleArn":"arn:aws:iam::1111222333:role/ecsInfrastructureRole",
+                    "encrypted": true,
+                    "kmsKeyId": "arn:aws:kms:region:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
+                }
+            }
+        ]
+    }
+
+Output::
+
+    {
+        "tasks": [
+            {
+                "attachments": [
+                    {
+                        "id": "ce868693-15ca-4083-91ac-f782f64000c9",
+                        "type": "ElasticNetworkInterface",
+                        "status": "PRECREATED",
+                        "details": [
+                            {
+                            "name": "subnetId",
+                            "value": "subnet-070982705451dad82"
+                            }
+                        ]
+                    },
+                    {
+                        "id": "a17ed863-786c-4372-b5b3-b23e53f37877",
+                        "type": "AmazonElasticBlockStorage",
+                        "status": "CREATED",
+                        "details": [
+                            {
+                                "name": "roleArn",
+                                "value": "arn:aws:iam::123456789012:role/ecsInfrastructureRole"
+                            },
+                            {
+                                "name": "volumeName",
+                                "value": "myEBSVolume"
+                            },
+                            {
+                                "name": "deleteOnTermination",
+                                "value": "true"
+                            }
+                        ]
+                    }
+                ],
+                "attributes": [
+                    {
+                        "name": "ecs.cpu-architecture",
+                        "value": "x86_64"
+                    }
+                ],
+                "availabilityZone": "us-west-2b",
+                "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default",
+                "containers": [
+                    {
+                        "containerArn": "arn:aws:ecs:us-west-2:123456789012:container/default/7f1fbd3629434cc4b82d72d2f09b67c9/e21962a2-f328-4699-98a3-5161ac2c186a",
+                        "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/7f1fbd3629434cc4b82d72d2f09b67c9",
+                        "name": "container-using-ebs",
+                        "image": "amazonlinux:2",
+                        "lastStatus": "PENDING",
+                        "networkInterfaces": [],
+                        "cpu": "0"
+                    }
+                ],
+                "cpu": "1024",
+                "createdAt": "2025-01-23T10:29:46.650000-06:00",
+                "desiredStatus": "RUNNING",
+                "enableExecuteCommand": false,
+                "group": "family:mytaskdef",
+                "lastStatus": "PROVISIONING",
+                "launchType": "FARGATE",
+                "memory": "3072",
+                "overrides": {
+                    "containerOverrides": [
+                        {
+                            "name": "container-using-ebs"
+                        }
+                    ],
+                    "inferenceAcceleratorOverrides": []
+                },
+                "platformVersion": "1.4.0",
+                "platformFamily": "Linux",
+                "tags": [],
+                "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/7f1fbd3629434cc4b82d72d2f09b67c9",
+                "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:4",
+                "version": 1,
+                "ephemeralStorage": {
+                    "sizeInGiB": 20
+                },
+                "fargateEphemeralStorage": {
+                    "sizeInGiB": 20
+                }
+            }
+        ],
+        "failures": []
+    }
+
+For more information, see `Use Amazon EBS volumes with Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html>`__ in the *Amazon ECS Developer Guide*.

awscli/examples/ecs/start-task.rst

@@ -1,6 +1,6 @@
-**To start a new task**
+**Example 1: To start a new task**
 
-The following ``start-task`` starts a task using the latest revision of the ``sleep360`` task definition on the specified container instance in the default cluster. ::
+The following ``start-task`` example starts a task using the latest revision of the ``sleep360`` task definition on the specified container instance in the default cluster. ::
 
     aws ecs start-task \
         --task-definition sleep360 \
@@ -11,10 +11,10 @@ Output::
     {
         "tasks": [
             {
-                "taskArn": "arn:aws:ecs:us-west-2:130757420319:task/default/666fdccc2e2d4b6894dd422f4eeee8f8",
-                "clusterArn": "arn:aws:ecs:us-west-2:130757420319:cluster/default",
-                "taskDefinitionArn": "arn:aws:ecs:us-west-2:130757420319:task-definition/sleep360:3",
-                "containerInstanceArn": "arn:aws:ecs:us-west-2:130757420319:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4",
+                "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/666fdccc2e2d4b6894dd422f4eeee8f8",
+                "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default",
+                "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:3",
+                "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4",
                 "overrides": {
                     "containerOverrides": [
                         {
@@ -28,8 +28,8 @@ Output::
                 "memory": "128",
                 "containers": [
                     {
-                        "containerArn": "arn:aws:ecs:us-west-2:130757420319:container/75f11ed4-8a3d-4f26-a33b-ad1db9e02d41",
-                        "taskArn": "arn:aws:ecs:us-west-2:130757420319:task/default/666fdccc2e2d4b6894dd422f4eeee8f8",
+                        "containerArn": "arn:aws:ecs:us-west-2:123456789012:container/75f11ed4-8a3d-4f26-a33b-ad1db9e02d41",
+                        "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/666fdccc2e2d4b6894dd422f4eeee8f8",
                         "name": "sleep",
                         "lastStatus": "PENDING",
                         "networkInterfaces": [],
@@ -47,3 +47,123 @@ Output::
         ],
         "failures": []
     }
+
+For more information, see `Schedule your containers on Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html>`__ in the *Amazon ECS Developer Guide*.
+
+**Example 2: To configure an Amazon EBS volume at task start**
+
+The following ``start-task`` example configures an encrypted Amazon EBS volume for a task on the specified container instance. You must have an Amazon ECS infrastructure role configured with the ``AmazonECSInfrastructureRolePolicyForVolumes`` managed policy attached. You must specify a task definition with the same volume name as in the ``start-task`` request. This example uses the ``--cli-input-json`` option and a JSON input file called ``ebs.json`` with the following content. ::
+
+    aws ecs start-task \
+        --cli-input-json file://ebs.json \
+        --container-instances 765936fadbdd46b5991a4bd70c2a43d4
+
+Contents of ``ebs.json``::
+
+    {
+       "cluster": "default",
+       "taskDefinition": "mytaskdef",
+       "networkConfiguration":{
+            "awsvpcConfiguration":{
+                "assignPublicIp": "ENABLED",
+                "securityGroups": ["sg-12344321"],
+                "subnets":["subnet-12344321"]
+            }
+        },
+       "volumeConfigurations": [
+            {
+                "name": "myEBSVolume",
+                "managedEBSVolume": {
+                    "volumeType": "gp3",
+                    "sizeInGiB": 100,
+                    "roleArn":"arn:aws:iam::123456789012:role/ecsInfrastructureRole",
+                    "encrypted": true,
+                    "kmsKeyId": "arn:aws:kms:region:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab"
+                }
+            }
+        ]
+    }
+
+Output::
+
+    {
+        "tasks": [
+            {
+                "attachments": [
+                    {
+                        "id": "aea29489-9dcd-49f1-8164-4d91566e1113",
+                        "type": "ElasticNetworkInterface",
+                        "status": "PRECREATED",
+                        "details": [
+                            {
+                                "name": "subnetId",
+                                "value": "subnet-12344321"
+                            }
+                        ]
+                    },
+                    {
+                        "id": "f29e1222-9a1e-410f-b499-a12a7cd6d42e",
+                        "type": "AmazonElasticBlockStorage",
+                        "status": "CREATED",
+                        "details": [
+                            {
+                                "name": "roleArn",
+                                "value": "arn:aws:iam::123456789012:role/ecsInfrastructureRole"
+                            },
+                            {
+                                "name": "volumeName",
+                                "value": "myEBSVolume"
+                            },
+                            {
+                                "name": "deleteOnTermination",
+                                "value": "true"
+                            }
+                        ]
+                    }
+                ],
+                "attributes": [
+                    {
+                        "name": "ecs.cpu-architecture",
+                        "value": "arm64"
+                    }
+                ],
+                "availabilityZone": "us-west-2c",
+                "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default",
+                "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4",
+                "containers": [
+                    {
+                        "containerArn": "arn:aws:ecs:us-west-2:123456789012:container/default/bb122ace3ed84add92c00a351a03c69e/a4a9ed10-51c7-4567-9653-50e71b94f867",
+                        "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/bb122ace3ed84add92c00a351a03c69e",
+                        "name": "container-using-ebs",
+                        "image": "amazonlinux:2",
+                        "lastStatus": "PENDING",
+                        "networkInterfaces": [],
+                        "cpu": "0"
+                    }
+                ],
+                "cpu": "1024",
+                "createdAt": "2025-01-23T14:51:05.191000-06:00",
+                "desiredStatus": "RUNNING",
+                "enableExecuteCommand": false,
+                "group": "family:mytaskdef",
+                "lastStatus": "PROVISIONING",
+                "launchType": "EC2",
+                "memory": "3072",
+                "overrides": {
+                    "containerOverrides": [
+                        {
+                            "name": "container-using-ebs"
+                        }
+                    ],
+                    "inferenceAcceleratorOverrides": []
+                },
+                 "tags": [],
+                "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/default/bb122ace3ed84add92c00a351a03c69e",
+                "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/mytaskdef:4",
+                "version": 1
+            }
+        ],
+        "failures": []
+    }
+
+For more information, see `Use Amazon EBS volumes with Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html>`__ in the *Amazon ECS Developer Guide*.