ECS

Table of Contents

Client

class ECS.Client

A low-level client representing Amazon EC2 Container Service (ECS):

import boto3

client = boto3.client('ecs')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters:operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns:True if the operation can be paginated, False otherwise.
create_cluster(**kwargs)

Creates a new Amazon ECS cluster. By default, your account will receive a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

Request Syntax

response = client.create_cluster(
    clusterName='string'
)
Parameters:clusterName (string) -- The name of your cluster. If you do not specify a name for your cluster, you will create a cluster named default . Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
Return type:dict
Returns:Response Syntax
{
    'cluster': {
        'clusterArn': 'string',
        'clusterName': 'string',
        'status': 'string',
        'registeredContainerInstancesCount': 123,
        'runningTasksCount': 123,
        'pendingTasksCount': 123,
        'activeServicesCount': 123
    }
}

Response Structure

  • (dict) --
    • cluster (dict) --

      The full description of your new cluster.

      • clusterArn (string) --

        The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region :012345678910 :cluster/test .

      • clusterName (string) --

        A user-generated string that you can use to identify your cluster.

      • status (string) --

        The status of the cluster. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

      • registeredContainerInstancesCount (integer) --

        The number of container instances registered into the cluster.

      • runningTasksCount (integer) --

        The number of tasks in the cluster that are in the RUNNING state.

      • pendingTasksCount (integer) --

        The number of tasks in the cluster that are in the PENDING state.

      • activeServicesCount (integer) --

        The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices .

create_service(**kwargs)

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount , Amazon ECS will spawn another instantiation of the task in the specified cluster.

Request Syntax

response = client.create_service(
    cluster='string',
    serviceName='string',
    taskDefinition='string',
    loadBalancers=[
        {
            'loadBalancerName': 'string',
            'containerName': 'string',
            'containerPort': 123
        },
    ],
    desiredCount=123,
    clientToken='string',
    role='string'
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your service on. If you do not specify a cluster, the default cluster is assumed.
  • serviceName (string) --

    [REQUIRED]

    The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

  • taskDefinition (string) --

    [REQUIRED]

    The family and revision (family:revision ) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

  • loadBalancers (list) --

    A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

    • (dict) --

      Details on a load balancer that is used with a service.

      • loadBalancerName (string) --

        The name of the load balancer.

      • containerName (string) --

        The name of the container to associate with the load balancer.

      • containerPort (integer) --

        The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.

  • desiredCount (integer) --

    [REQUIRED]

    The number of instantiations of the specified task definition that you would like to place and keep running on your cluster.

  • clientToken (string) -- Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
  • role (string) -- The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.
Return type:

dict

Returns:

Response Syntax

{
    'service': {
        'serviceArn': 'string',
        'serviceName': 'string',
        'clusterArn': 'string',
        'loadBalancers': [
            {
                'loadBalancerName': 'string',
                'containerName': 'string',
                'containerPort': 123
            },
        ],
        'status': 'string',
        'desiredCount': 123,
        'runningCount': 123,
        'pendingCount': 123,
        'taskDefinition': 'string',
        'deployments': [
            {
                'id': 'string',
                'status': 'string',
                'taskDefinition': 'string',
                'desiredCount': 123,
                'pendingCount': 123,
                'runningCount': 123,
                'createdAt': datetime(2015, 1, 1),
                'updatedAt': datetime(2015, 1, 1)
            },
        ],
        'roleArn': 'string',
        'events': [
            {
                'id': 'string',
                'createdAt': datetime(2015, 1, 1),
                'message': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • service (dict) --

      The full description of your service following the create call.

      • serviceArn (string) --

        The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region :012345678910 :service/my-service .

      • serviceName (string) --

        A user-generated string that you can use to identify your service.

      • clusterArn (string) --

        The Amazon Resource Name (ARN) of the of the cluster that hosts the service.

      • loadBalancers (list) --

        A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

        • (dict) --

          Details on a load balancer that is used with a service.

          • loadBalancerName (string) --

            The name of the load balancer.

          • containerName (string) --

            The name of the container to associate with the load balancer.

          • containerPort (integer) --

            The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.

      • status (string) --

        The status of the service. The valid values are ACTIVE , DRAINING , or INACTIVE .

      • desiredCount (integer) --

        The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .

      • runningCount (integer) --

        The number of tasks in the cluster that are in the RUNNING state.

      • pendingCount (integer) --

        The number of tasks in the cluster that are in the PENDING state.

      • taskDefinition (string) --

        The task definition to use for tasks in the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .

      • deployments (list) --

        The current state of deployments for the service.

        • (dict) --

          The details of an Amazon ECS service deployment.

          • id (string) --

            The ID of the deployment.

          • status (string) --

            The status of the deployment. Valid values are PRIMARY (for the most recent deployment), ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments that have been completely replaced).

          • taskDefinition (string) --

            The most recent task definition that was specified for the service to use.

          • desiredCount (integer) --

            The most recent desired count of tasks that was specified for the service to deploy and/or maintain.

          • pendingCount (integer) --

            The number of tasks in the deployment that are in the PENDING status.

          • runningCount (integer) --

            The number of tasks in the deployment that are in the RUNNING status.

          • createdAt (datetime) --

            The Unix time in seconds and milliseconds when the service was created.

          • updatedAt (datetime) --

            The Unix time in seconds and milliseconds when the service was last updated.

      • roleArn (string) --

        The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

      • events (list) --

        The event stream for your service. A maximum of 100 of the latest events are displayed.

        • (dict) --

          Details on an event associated with a service.

          • id (string) --

            The ID string of the event.

          • createdAt (datetime) --

            The Unix time in seconds and milliseconds when the event was triggered.

          • message (string) --

            The event message.

delete_cluster(**kwargs)

Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance .

Request Syntax

response = client.delete_cluster(
    cluster='string'
)
Parameters:cluster (string) --

[REQUIRED]

The short name or full Amazon Resource Name (ARN) of the cluster that you want to delete.

Return type:dict
Returns:Response Syntax
{
    'cluster': {
        'clusterArn': 'string',
        'clusterName': 'string',
        'status': 'string',
        'registeredContainerInstancesCount': 123,
        'runningTasksCount': 123,
        'pendingTasksCount': 123,
        'activeServicesCount': 123
    }
}

Response Structure

  • (dict) --
    • cluster (dict) --

      The full description of the deleted cluster.

      • clusterArn (string) --

        The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region :012345678910 :cluster/test .

      • clusterName (string) --

        A user-generated string that you can use to identify your cluster.

      • status (string) --

        The status of the cluster. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

      • registeredContainerInstancesCount (integer) --

        The number of container instances registered into the cluster.

      • runningTasksCount (integer) --

        The number of tasks in the cluster that are in the RUNNING state.

      • pendingTasksCount (integer) --

        The number of tasks in the cluster that are in the PENDING state.

      • activeServicesCount (integer) --

        The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices .

delete_service(**kwargs)

Deletes a specified service within a cluster.

Request Syntax

response = client.delete_service(
    cluster='string',
    service='string'
)
Parameters:
  • cluster (string) -- The name of the cluster that hosts the service you want to delete.
  • service (string) --

    [REQUIRED]

    The name of the service you want to delete.

Return type:

dict

Returns:

Response Syntax

{
    'service': {
        'serviceArn': 'string',
        'serviceName': 'string',
        'clusterArn': 'string',
        'loadBalancers': [
            {
                'loadBalancerName': 'string',
                'containerName': 'string',
                'containerPort': 123
            },
        ],
        'status': 'string',
        'desiredCount': 123,
        'runningCount': 123,
        'pendingCount': 123,
        'taskDefinition': 'string',
        'deployments': [
            {
                'id': 'string',
                'status': 'string',
                'taskDefinition': 'string',
                'desiredCount': 123,
                'pendingCount': 123,
                'runningCount': 123,
                'createdAt': datetime(2015, 1, 1),
                'updatedAt': datetime(2015, 1, 1)
            },
        ],
        'roleArn': 'string',
        'events': [
            {
                'id': 'string',
                'createdAt': datetime(2015, 1, 1),
                'message': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • service (dict) --

      Details on a service within a cluster

      • serviceArn (string) --

        The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region :012345678910 :service/my-service .

      • serviceName (string) --

        A user-generated string that you can use to identify your service.

      • clusterArn (string) --

        The Amazon Resource Name (ARN) of the of the cluster that hosts the service.

      • loadBalancers (list) --

        A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

        • (dict) --

          Details on a load balancer that is used with a service.

          • loadBalancerName (string) --

            The name of the load balancer.

          • containerName (string) --

            The name of the container to associate with the load balancer.

          • containerPort (integer) --

            The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.

      • status (string) --

        The status of the service. The valid values are ACTIVE , DRAINING , or INACTIVE .

      • desiredCount (integer) --

        The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .

      • runningCount (integer) --

        The number of tasks in the cluster that are in the RUNNING state.

      • pendingCount (integer) --

        The number of tasks in the cluster that are in the PENDING state.

      • taskDefinition (string) --

        The task definition to use for tasks in the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .

      • deployments (list) --

        The current state of deployments for the service.

        • (dict) --

          The details of an Amazon ECS service deployment.

          • id (string) --

            The ID of the deployment.

          • status (string) --

            The status of the deployment. Valid values are PRIMARY (for the most recent deployment), ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments that have been completely replaced).

          • taskDefinition (string) --

            The most recent task definition that was specified for the service to use.

          • desiredCount (integer) --

            The most recent desired count of tasks that was specified for the service to deploy and/or maintain.

          • pendingCount (integer) --

            The number of tasks in the deployment that are in the PENDING status.

          • runningCount (integer) --

            The number of tasks in the deployment that are in the RUNNING status.

          • createdAt (datetime) --

            The Unix time in seconds and milliseconds when the service was created.

          • updatedAt (datetime) --

            The Unix time in seconds and milliseconds when the service was last updated.

      • roleArn (string) --

        The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

      • events (list) --

        The event stream for your service. A maximum of 100 of the latest events are displayed.

        • (dict) --

          Details on an event associated with a service.

          • id (string) --

            The ID string of the event.

          • createdAt (datetime) --

            The Unix time in seconds and milliseconds when the event was triggered.

          • message (string) --

            The event message.

deregister_container_instance(**kwargs)

Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be available to run tasks.

If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

Note

When you terminate a container instance, it is automatically deregistered from your cluster.

Request Syntax

response = client.deregister_container_instance(
    cluster='string',
    containerInstance='string',
    force=True|False
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance you want to deregister. If you do not specify a cluster, the default cluster is assumed.
  • containerInstance (string) --

    [REQUIRED]

    The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region :aws_account_id :container-instance/container_instance_UUID .

  • force (boolean) -- Force the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running and they will continue to pass Elastic Load Balancing load balancer health checks until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler will start another copy of that task on a different container instance if possible.
Return type:

dict

Returns:

Response Syntax

{
    'containerInstance': {
        'containerInstanceArn': 'string',
        'ec2InstanceId': 'string',
        'versionInfo': {
            'agentVersion': 'string',
            'agentHash': 'string',
            'dockerVersion': 'string'
        },
        'remainingResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'registeredResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'status': 'string',
        'agentConnected': True|False,
        'runningTasksCount': 123,
        'pendingTasksCount': 123,
        'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED'
    }
}

Response Structure

  • (dict) --

    • containerInstance (dict) --

      An Amazon EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

      • containerInstanceArn (string) --

        The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region :aws_account_id :container-instance/container_instance_UUID .

      • ec2InstanceId (string) --

        The Amazon EC2 instance ID of the container instance.

      • versionInfo (dict) --

        The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

        • agentVersion (string) --

          The version number of the Amazon ECS container agent.

        • agentHash (string) --

          The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

        • dockerVersion (string) --

          The Docker version running on the container instance.

      • remainingResources (list) --

        The remaining resources of the container instance that are available for new tasks.

        • (dict) --

          Describes the resources available for a container instance.

          • name (string) --

            The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.

          • type (string) --

            The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .

          • doubleValue (float) --

            When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

          • longValue (integer) --

            When the longValue type is set, the value of the resource must be an extended precision floating-point type.

          • integerValue (integer) --

            When the integerValue type is set, the value of the resource must be an integer.

          • stringSetValue (list) --

            When the stringSetValue type is set, the value of the resource must be a string type.

            • (string) --
      • registeredResources (list) --

        The registered resources on the container instance that are in use by current tasks.

        • (dict) --

          Describes the resources available for a container instance.

          • name (string) --

            The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.

          • type (string) --

            The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .

          • doubleValue (float) --

            When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

          • longValue (integer) --

            When the longValue type is set, the value of the resource must be an extended precision floating-point type.

          • integerValue (integer) --

            When the integerValue type is set, the value of the resource must be an integer.

          • stringSetValue (list) --

            When the stringSetValue type is set, the value of the resource must be a string type.

            • (string) --
      • status (string) --

        The status of the container instance. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that the container instance can accept tasks.

      • agentConnected (boolean) --

        This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped will return false , and instances without a connected agent cannot accept placement request.

      • runningTasksCount (integer) --

        The number of tasks on the container instance that are in the RUNNING status.

      • pendingTasksCount (integer) --

        The number of tasks on the container instance that are in the PENDING status.

      • agentUpdateStatus (string) --

        The status of the most recent agent update. If an update has never been requested, this value is NULL .

deregister_task_definition(**kwargs)

Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE . Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count.

You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).

Request Syntax

response = client.deregister_task_definition(
    taskDefinition='string'
)
Parameters:taskDefinition (string) --

[REQUIRED]

The family and revision (family:revision ) or full Amazon Resource Name (ARN) of the task definition that you want to deregister. You must specify a revision .

Return type:dict
Returns:Response Syntax
{
    'taskDefinition': {
        'taskDefinitionArn': 'string',
        'containerDefinitions': [
            {
                'name': 'string',
                'image': 'string',
                'cpu': 123,
                'memory': 123,
                'links': [
                    'string',
                ],
                'portMappings': [
                    {
                        'containerPort': 123,
                        'hostPort': 123,
                        'protocol': 'tcp'|'udp'
                    },
                ],
                'essential': True|False,
                'entryPoint': [
                    'string',
                ],
                'command': [
                    'string',
                ],
                'environment': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'mountPoints': [
                    {
                        'sourceVolume': 'string',
                        'containerPath': 'string',
                        'readOnly': True|False
                    },
                ],
                'volumesFrom': [
                    {
                        'sourceContainer': 'string',
                        'readOnly': True|False
                    },
                ]
            },
        ],
        'family': 'string',
        'revision': 123,
        'volumes': [
            {
                'name': 'string',
                'host': {
                    'sourcePath': 'string'
                }
            },
        ],
        'status': 'ACTIVE'|'INACTIVE'
    }
}

Response Structure

  • (dict) --
    • taskDefinition (dict) --

      The full description of the deregistered task.

      • taskDefinitionArn (string) --

        The full Amazon Resource Name (ARN) of the of the task definition.

      • containerDefinitions (list) --

        A list of container definitions in JSON format that describe the different containers that make up your task. For more information on container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .

        • (dict) --

          Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

          • name (string) --

            The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers.

          • image (string) --

            The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with *repository-url* /*image* :*tag* .

          • cpu (integer) --

            The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount.

            For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

            The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel will allow is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

            • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
            • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
          • memory (integer) --

            The number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated here, the container is killed.

          • links (list) --

            The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. The name:internalName construct is analogous to name:alias in Docker links. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/ .

            Warning

            Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

            • (string) --
          • portMappings (list) --

            The list of port mappings for the container.

            • (dict) --

              Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

              • containerPort (integer) --

                The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container will automatically receive a host port in the ephemeral port range (for more information, see hostPort ).

              • hostPort (integer) --

                The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0 ) while specifying a containerPort and your container will automatically receive a port in the ephemeral port range for your container instance operating system and Docker version.

                The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range ; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, since these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

                The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS Container Agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (once a task stops, the host port is released).The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit).

              • protocol (string) --

                The protocol used for the port mapping. Valid values are tcp and udp . The default is tcp .

          • essential (boolean) --

            If the essential parameter of a container is marked as true , the failure of that container will stop the task. If the essential parameter of a container is marked as false , then its failure will not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

            Note

            All tasks must have at least one essential container.

          • entryPoint (list) --

            Warning

            Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint , update your container agent or enter your commands and arguments as command array items instead.

            The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint .

            • (string) --
          • command (list) --

            The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd .

            • (string) --
          • environment (list) --

            The environment variables to pass to a container.

            • (dict) --

              A key and value pair object.

              • name (string) --

                The name of the key value pair. For environment variables, this is the name of the environment variable.

              • value (string) --

                The value of the key value pair. For environment variables, this is the value of the environment variable.

          • mountPoints (list) --

            The mount points for data volumes in your container.

            • (dict) --

              Details on a volume mount point that is used in a container definition.

              • sourceVolume (string) --

                The name of the volume to mount.

              • containerPath (string) --

                The path on the container to mount the host volume at.

              • readOnly (boolean) --

                If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .

          • volumesFrom (list) --

            Data volumes to mount from another container.

            • (dict) --

              Details on a data volume from another container.

              • sourceContainer (string) --

                The name of the container to mount volumes from.

              • readOnly (boolean) --

                If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .

      • family (string) --

        The family of your task definition. You can think of the family as the name of your task definition.

      • revision (integer) --

        The revision of the task in a particular family. You can think of the revision as a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1 , and each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).

      • volumes (list) --

        The list of volumes in a task. For more information on volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .

        • (dict) --

          A data volume used in a task definition.

          • name (string) --

            The name of the volume. This name is referenced in the sourceVolume parameter of container definition mountPoints .

          • host (dict) --

            The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.

            • sourcePath (string) --

              The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you.

      • status (string) --

        The status of the task definition.

describe_clusters(**kwargs)

Describes one or more of your clusters.

Request Syntax

response = client.describe_clusters(
    clusters=[
        'string',
    ]
)
Parameters:clusters (list) --

A space-separated list of cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

  • (string) --
Return type:dict
Returns:Response Syntax
{
    'clusters': [
        {
            'clusterArn': 'string',
            'clusterName': 'string',
            'status': 'string',
            'registeredContainerInstancesCount': 123,
            'runningTasksCount': 123,
            'pendingTasksCount': 123,
            'activeServicesCount': 123
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • clusters (list) --

      The list of clusters.

      • (dict) --

        A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

        • clusterArn (string) --

          The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region :012345678910 :cluster/test .

        • clusterName (string) --

          A user-generated string that you can use to identify your cluster.

        • status (string) --

          The status of the cluster. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

        • registeredContainerInstancesCount (integer) --

          The number of container instances registered into the cluster.

        • runningTasksCount (integer) --

          The number of tasks in the cluster that are in the RUNNING state.

        • pendingTasksCount (integer) --

          The number of tasks in the cluster that are in the PENDING state.

        • activeServicesCount (integer) --

          The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices .

    • failures (list) --
      • (dict) --

        A failed resource.

        • arn (string) --

          The Amazon Resource Name (ARN) of the failed resource.

        • reason (string) --

          The reason for the failure.

describe_container_instances(**kwargs)

Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.

Request Syntax

response = client.describe_container_instances(
    cluster='string',
    containerInstances=[
        'string',
    ]
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances you want to describe. If you do not specify a cluster, the default cluster is assumed.
  • containerInstances (list) --

    [REQUIRED]

    A space-separated list of container instance UUIDs or full Amazon Resource Name (ARN) entries.

    • (string) --
Return type:

dict

Returns:

Response Syntax

{
    'containerInstances': [
        {
            'containerInstanceArn': 'string',
            'ec2InstanceId': 'string',
            'versionInfo': {
                'agentVersion': 'string',
                'agentHash': 'string',
                'dockerVersion': 'string'
            },
            'remainingResources': [
                {
                    'name': 'string',
                    'type': 'string',
                    'doubleValue': 123.0,
                    'longValue': 123,
                    'integerValue': 123,
                    'stringSetValue': [
                        'string',
                    ]
                },
            ],
            'registeredResources': [
                {
                    'name': 'string',
                    'type': 'string',
                    'doubleValue': 123.0,
                    'longValue': 123,
                    'integerValue': 123,
                    'stringSetValue': [
                        'string',
                    ]
                },
            ],
            'status': 'string',
            'agentConnected': True|False,
            'runningTasksCount': 123,
            'pendingTasksCount': 123,
            'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED'
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • containerInstances (list) --

      The list of container instances.

      • (dict) --

        An Amazon EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

        • containerInstanceArn (string) --

          The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region :aws_account_id :container-instance/container_instance_UUID .

        • ec2InstanceId (string) --

          The Amazon EC2 instance ID of the container instance.

        • versionInfo (dict) --

          The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

          • agentVersion (string) --

            The version number of the Amazon ECS container agent.

          • agentHash (string) --

            The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

          • dockerVersion (string) --

            The Docker version running on the container instance.

        • remainingResources (list) --

          The remaining resources of the container instance that are available for new tasks.

          • (dict) --

            Describes the resources available for a container instance.

            • name (string) --

              The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.

            • type (string) --

              The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .

            • doubleValue (float) --

              When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

            • longValue (integer) --

              When the longValue type is set, the value of the resource must be an extended precision floating-point type.

            • integerValue (integer) --

              When the integerValue type is set, the value of the resource must be an integer.

            • stringSetValue (list) --

              When the stringSetValue type is set, the value of the resource must be a string type.

              • (string) --
        • registeredResources (list) --

          The registered resources on the container instance that are in use by current tasks.

          • (dict) --

            Describes the resources available for a container instance.

            • name (string) --

              The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.

            • type (string) --

              The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .

            • doubleValue (float) --

              When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

            • longValue (integer) --

              When the longValue type is set, the value of the resource must be an extended precision floating-point type.

            • integerValue (integer) --

              When the integerValue type is set, the value of the resource must be an integer.

            • stringSetValue (list) --

              When the stringSetValue type is set, the value of the resource must be a string type.

              • (string) --
        • status (string) --

          The status of the container instance. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that the container instance can accept tasks.

        • agentConnected (boolean) --

          This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped will return false , and instances without a connected agent cannot accept placement request.

        • runningTasksCount (integer) --

          The number of tasks on the container instance that are in the RUNNING status.

        • pendingTasksCount (integer) --

          The number of tasks on the container instance that are in the PENDING status.

        • agentUpdateStatus (string) --

          The status of the most recent agent update. If an update has never been requested, this value is NULL .

    • failures (list) --

      • (dict) --

        A failed resource.

        • arn (string) --

          The Amazon Resource Name (ARN) of the failed resource.

        • reason (string) --

          The reason for the failure.

describe_services(**kwargs)

Describes the specified services running in your cluster.

Request Syntax

response = client.describe_services(
    cluster='string',
    services=[
        'string',
    ]
)
Parameters:
  • cluster (string) -- The name of the cluster that hosts the service you want to describe.
  • services (list) --

    [REQUIRED]

    A list of services you want to describe.

    • (string) --
Return type:

dict

Returns:

Response Syntax

{
    'services': [
        {
            'serviceArn': 'string',
            'serviceName': 'string',
            'clusterArn': 'string',
            'loadBalancers': [
                {
                    'loadBalancerName': 'string',
                    'containerName': 'string',
                    'containerPort': 123
                },
            ],
            'status': 'string',
            'desiredCount': 123,
            'runningCount': 123,
            'pendingCount': 123,
            'taskDefinition': 'string',
            'deployments': [
                {
                    'id': 'string',
                    'status': 'string',
                    'taskDefinition': 'string',
                    'desiredCount': 123,
                    'pendingCount': 123,
                    'runningCount': 123,
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1)
                },
            ],
            'roleArn': 'string',
            'events': [
                {
                    'id': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'message': 'string'
                },
            ]
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • services (list) --

      The list of services described.

      • (dict) --

        Details on a service within a cluster

        • serviceArn (string) --

          The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region :012345678910 :service/my-service .

        • serviceName (string) --

          A user-generated string that you can use to identify your service.

        • clusterArn (string) --

          The Amazon Resource Name (ARN) of the of the cluster that hosts the service.

        • loadBalancers (list) --

          A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

          • (dict) --

            Details on a load balancer that is used with a service.

            • loadBalancerName (string) --

              The name of the load balancer.

            • containerName (string) --

              The name of the container to associate with the load balancer.

            • containerPort (integer) --

              The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.

        • status (string) --

          The status of the service. The valid values are ACTIVE , DRAINING , or INACTIVE .

        • desiredCount (integer) --

          The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .

        • runningCount (integer) --

          The number of tasks in the cluster that are in the RUNNING state.

        • pendingCount (integer) --

          The number of tasks in the cluster that are in the PENDING state.

        • taskDefinition (string) --

          The task definition to use for tasks in the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .

        • deployments (list) --

          The current state of deployments for the service.

          • (dict) --

            The details of an Amazon ECS service deployment.

            • id (string) --

              The ID of the deployment.

            • status (string) --

              The status of the deployment. Valid values are PRIMARY (for the most recent deployment), ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments that have been completely replaced).

            • taskDefinition (string) --

              The most recent task definition that was specified for the service to use.

            • desiredCount (integer) --

              The most recent desired count of tasks that was specified for the service to deploy and/or maintain.

            • pendingCount (integer) --

              The number of tasks in the deployment that are in the PENDING status.

            • runningCount (integer) --

              The number of tasks in the deployment that are in the RUNNING status.

            • createdAt (datetime) --

              The Unix time in seconds and milliseconds when the service was created.

            • updatedAt (datetime) --

              The Unix time in seconds and milliseconds when the service was last updated.

        • roleArn (string) --

          The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

        • events (list) --

          The event stream for your service. A maximum of 100 of the latest events are displayed.

          • (dict) --

            Details on an event associated with a service.

            • id (string) --

              The ID string of the event.

            • createdAt (datetime) --

              The Unix time in seconds and milliseconds when the event was triggered.

            • message (string) --

              The event message.

    • failures (list) --

      Any failures associated with the call.

      • (dict) --

        A failed resource.

        • arn (string) --

          The Amazon Resource Name (ARN) of the failed resource.

        • reason (string) --

          The reason for the failure.

describe_task_definition(**kwargs)

Describes a task definition. You can specify a family and revision to find information on a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

Note

You can only describe INACTIVE task definitions while an active task or service references them.

Request Syntax

response = client.describe_task_definition(
    taskDefinition='string'
)
Parameters:taskDefinition (string) --

[REQUIRED]

The family for the latest ACTIVE revision, family and revision (family:revision ) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition that you want to describe.

Return type:dict
Returns:Response Syntax
{
    'taskDefinition': {
        'taskDefinitionArn': 'string',
        'containerDefinitions': [
            {
                'name': 'string',
                'image': 'string',
                'cpu': 123,
                'memory': 123,
                'links': [
                    'string',
                ],
                'portMappings': [
                    {
                        'containerPort': 123,
                        'hostPort': 123,
                        'protocol': 'tcp'|'udp'
                    },
                ],
                'essential': True|False,
                'entryPoint': [
                    'string',
                ],
                'command': [
                    'string',
                ],
                'environment': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'mountPoints': [
                    {
                        'sourceVolume': 'string',
                        'containerPath': 'string',
                        'readOnly': True|False
                    },
                ],
                'volumesFrom': [
                    {
                        'sourceContainer': 'string',
                        'readOnly': True|False
                    },
                ]
            },
        ],
        'family': 'string',
        'revision': 123,
        'volumes': [
            {
                'name': 'string',
                'host': {
                    'sourcePath': 'string'
                }
            },
        ],
        'status': 'ACTIVE'|'INACTIVE'
    }
}

Response Structure

  • (dict) --
    • taskDefinition (dict) --

      The full task definition description.

      • taskDefinitionArn (string) --

        The full Amazon Resource Name (ARN) of the of the task definition.

      • containerDefinitions (list) --

        A list of container definitions in JSON format that describe the different containers that make up your task. For more information on container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .

        • (dict) --

          Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

          • name (string) --

            The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers.

          • image (string) --

            The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with *repository-url* /*image* :*tag* .

          • cpu (integer) --

            The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount.

            For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

            The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel will allow is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

            • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
            • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
          • memory (integer) --

            The number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated here, the container is killed.

          • links (list) --

            The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. The name:internalName construct is analogous to name:alias in Docker links. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/ .

            Warning

            Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

            • (string) --
          • portMappings (list) --

            The list of port mappings for the container.

            • (dict) --

              Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

              • containerPort (integer) --

                The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container will automatically receive a host port in the ephemeral port range (for more information, see hostPort ).

              • hostPort (integer) --

                The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0 ) while specifying a containerPort and your container will automatically receive a port in the ephemeral port range for your container instance operating system and Docker version.

                The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range ; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, since these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

                The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS Container Agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (once a task stops, the host port is released).The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit).

              • protocol (string) --

                The protocol used for the port mapping. Valid values are tcp and udp . The default is tcp .

          • essential (boolean) --

            If the essential parameter of a container is marked as true , the failure of that container will stop the task. If the essential parameter of a container is marked as false , then its failure will not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

            Note

            All tasks must have at least one essential container.

          • entryPoint (list) --

            Warning

            Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint , update your container agent or enter your commands and arguments as command array items instead.

            The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint .

            • (string) --
          • command (list) --

            The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd .

            • (string) --
          • environment (list) --

            The environment variables to pass to a container.

            • (dict) --

              A key and value pair object.

              • name (string) --

                The name of the key value pair. For environment variables, this is the name of the environment variable.

              • value (string) --

                The value of the key value pair. For environment variables, this is the value of the environment variable.

          • mountPoints (list) --

            The mount points for data volumes in your container.

            • (dict) --

              Details on a volume mount point that is used in a container definition.

              • sourceVolume (string) --

                The name of the volume to mount.

              • containerPath (string) --

                The path on the container to mount the host volume at.

              • readOnly (boolean) --

                If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .

          • volumesFrom (list) --

            Data volumes to mount from another container.

            • (dict) --

              Details on a data volume from another container.

              • sourceContainer (string) --

                The name of the container to mount volumes from.

              • readOnly (boolean) --

                If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .

      • family (string) --

        The family of your task definition. You can think of the family as the name of your task definition.

      • revision (integer) --

        The revision of the task in a particular family. You can think of the revision as a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1 , and each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).

      • volumes (list) --

        The list of volumes in a task. For more information on volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .

        • (dict) --

          A data volume used in a task definition.

          • name (string) --

            The name of the volume. This name is referenced in the sourceVolume parameter of container definition mountPoints .

          • host (dict) --

            The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.

            • sourcePath (string) --

              The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you.

      • status (string) --

        The status of the task definition.

describe_tasks(**kwargs)

Describes a specified task or tasks.

Request Syntax

response = client.describe_tasks(
    cluster='string',
    tasks=[
        'string',
    ]
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task you want to describe. If you do not specify a cluster, the default cluster is assumed.
  • tasks (list) --

    [REQUIRED]

    A space-separated list of task UUIDs or full Amazon Resource Name (ARN) entries.

    • (string) --
Return type:

dict

Returns:

Response Syntax

{
    'tasks': [
        {
            'taskArn': 'string',
            'clusterArn': 'string',
            'taskDefinitionArn': 'string',
            'containerInstanceArn': 'string',
            'overrides': {
                'containerOverrides': [
                    {
                        'name': 'string',
                        'command': [
                            'string',
                        ],
                        'environment': [
                            {
                                'name': 'string',
                                'value': 'string'
                            },
                        ]
                    },
                ]
            },
            'lastStatus': 'string',
            'desiredStatus': 'string',
            'containers': [
                {
                    'containerArn': 'string',
                    'taskArn': 'string',
                    'name': 'string',
                    'lastStatus': 'string',
                    'exitCode': 123,
                    'reason': 'string',
                    'networkBindings': [
                        {
                            'bindIP': 'string',
                            'containerPort': 123,
                            'hostPort': 123,
                            'protocol': 'tcp'|'udp'
                        },
                    ]
                },
            ],
            'startedBy': 'string'
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • tasks (list) --

      The list of tasks.

      • (dict) --

        Details on a task in a cluster.

        • taskArn (string) --

          The Amazon Resource Name (ARN) of the task.

        • clusterArn (string) --

          The Amazon Resource Name (ARN) of the of the cluster that hosts the task.

        • taskDefinitionArn (string) --

          The Amazon Resource Name (ARN) of the of the task definition that creates the task.

        • containerInstanceArn (string) --

          The Amazon Resource Name (ARN) of the container instances that host the task.

        • overrides (dict) --

          One or more container overrides.

          • containerOverrides (list) --

            One or more container overrides sent to a task.

            • (dict) --

              The overrides that should be sent to a container.

              • name (string) --

                The name of the container that receives the override.

              • command (list) --

                The command to send to the container that overrides the default command from the Docker image or the task definition.

                • (string) --
              • environment (list) --

                The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.

                • (dict) --

                  A key and value pair object.

                  • name (string) --

                    The name of the key value pair. For environment variables, this is the name of the environment variable.

                  • value (string) --

                    The value of the key value pair. For environment variables, this is the value of the environment variable.

        • lastStatus (string) --

          The last known status of the task.

        • desiredStatus (string) --

          The desired status of the task.

        • containers (list) --

          The containers associated with the task.

          • (dict) --

            A docker container that is part of a task.

            • containerArn (string) --

              The Amazon Resource Name (ARN) of the container.

            • taskArn (string) --

              The Amazon Resource Name (ARN) of the task.

            • name (string) --

              The name of the container.

            • lastStatus (string) --

              The last known status of the container.

            • exitCode (integer) --

              The exit code returned from the container.

            • reason (string) --

              A short (255 max characters) human-readable string to provide additional detail about a running or stopped container.

            • networkBindings (list) --

              The network bindings associated with the container.

              • (dict) --

                Details on the network bindings between a container and its host container instance.

                • bindIP (string) --

                  The IP address that the container is bound to on the container instance.

                • containerPort (integer) --

                  The port number on the container that is be used with the network binding.

                • hostPort (integer) --

                  The port number on the host that is used with the network binding.

                • protocol (string) --

                  The protocol used for the network binding.

        • startedBy (string) --

          The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

    • failures (list) --

      • (dict) --

        A failed resource.

        • arn (string) --

          The Amazon Resource Name (ARN) of the failed resource.

        • reason (string) --

          The reason for the failure.

discover_poll_endpoint(**kwargs)

Note

This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.

Request Syntax

response = client.discover_poll_endpoint(
    containerInstance='string',
    cluster='string'
)
Parameters:
  • containerInstance (string) -- The container instance UUID or full Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region :aws_account_id :container-instance/container_instance_UUID .
  • cluster (string) -- The cluster that the container instance belongs to.
Return type:

dict

Returns:

Response Syntax

{
    'endpoint': 'string',
    'telemetryEndpoint': 'string'
}

Response Structure

  • (dict) --

    • endpoint (string) --

      The endpoint for the Amazon ECS agent to poll.

    • telemetryEndpoint (string) --

      The telemetry endpoint for the Amazon ECS agent.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters:
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns:

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters:operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError:
 Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type:L{botocore.paginate.Paginator}
Returns:A paginator object.
get_waiter(waiter_name)
list_clusters(**kwargs)

Returns a list of existing clusters.

Request Syntax

response = client.list_clusters(
    nextToken='string',
    maxResults=123
)
Parameters:
  • nextToken (string) -- The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
  • maxResults (integer) -- The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.
Return type:

dict

Returns:

Response Syntax

{
    'clusterArns': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • clusterArns (list) --

      The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.

      • (string) --
    • nextToken (string) --

      The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

list_container_instances(**kwargs)

Returns a list of container instances in a specified cluster.

Request Syntax

response = client.list_container_instances(
    cluster='string',
    nextToken='string',
    maxResults=123
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances you want to list. If you do not specify a cluster, the default cluster is assumed..
  • nextToken (string) -- The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
  • maxResults (integer) -- The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.
Return type:

dict

Returns:

Response Syntax

{
    'containerInstanceArns': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • containerInstanceArns (list) --

      The list of container instance full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.

      • (string) --
    • nextToken (string) --

      The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

list_services(**kwargs)

Lists the services that are running in a specified cluster.

Request Syntax

response = client.list_services(
    cluster='string',
    nextToken='string',
    maxResults=123
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services you want to list. If you do not specify a cluster, the default cluster is assumed..
  • nextToken (string) -- The nextToken value returned from a previous paginated ListServices request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
  • maxResults (integer) -- The maximum number of container instance results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListServices returns up to 100 results and a nextToken value if applicable.
Return type:

dict

Returns:

Response Syntax

{
    'serviceArns': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • serviceArns (list) --

      The list of full Amazon Resource Name (ARN) entries for each service associated with the specified cluster.

      • (string) --
    • nextToken (string) --

      The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

list_task_definition_families(**kwargs)

Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definitions). You can filter the results with the familyPrefix parameter.

Request Syntax

response = client.list_task_definition_families(
    familyPrefix='string',
    nextToken='string',
    maxResults=123
)
Parameters:
  • familyPrefix (string) -- The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies . If you specify a familyPrefix , only task definition family names that begin with the familyPrefix string are returned.
  • nextToken (string) -- The nextToken value returned from a previous paginated ListTaskDefinitionFamilies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
  • maxResults (integer) -- The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.
Return type:

dict

Returns:

Response Syntax

{
    'families': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • families (list) --

      The list of task definition family names that match the ListTaskDefinitionFamilies request.

      • (string) --
    • nextToken (string) --

      The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

list_task_definitions(**kwargs)

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

Request Syntax

response = client.list_task_definitions(
    familyPrefix='string',
    status='ACTIVE'|'INACTIVE',
    sort='ASC'|'DESC',
    nextToken='string',
    maxResults=123
)
Parameters:
  • familyPrefix (string) -- The full family name that you want to filter the ListTaskDefinitions results with. Specifying a familyPrefix will limit the listed task definitions to task definition revisions that belong to that family.
  • status (string) -- The task definition status that you want to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE , you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
  • sort (string) -- The order in which to sort the results. Valid values are ASC and DESC . By default (ASC ), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.
  • nextToken (string) -- The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
  • maxResults (integer) -- The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.
Return type:

dict

Returns:

Response Syntax

{
    'taskDefinitionArns': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • taskDefinitionArns (list) --

      The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefintions request.

      • (string) --
    • nextToken (string) --

      The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

list_tasks(**kwargs)

Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family , containerInstance , and desiredStatus parameters.

Request Syntax

response = client.list_tasks(
    cluster='string',
    containerInstance='string',
    family='string',
    nextToken='string',
    maxResults=123,
    startedBy='string',
    serviceName='string',
    desiredStatus='RUNNING'|'PENDING'|'STOPPED'
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want to list. If you do not specify a cluster, the default cluster is assumed..
  • containerInstance (string) -- The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.
  • family (string) -- The name of the family that you want to filter the ListTasks results with. Specifying a family will limit the results to tasks that belong to that family.
  • nextToken (string) -- The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
  • maxResults (integer) -- The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.
  • startedBy (string) -- The startedBy value that you want to filter the task results with. Specifying a startedBy value will limit the results to tasks that were started with that value.
  • serviceName (string) -- The name of the service that you want to filter the ListTasks results with. Specifying a serviceName will limit the results to tasks that belong to that service.
  • desiredStatus (string) -- The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING .
Return type:

dict

Returns:

Response Syntax

{
    'taskArns': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • taskArns (list) --

      The list of task Amazon Resource Name (ARN) entries for the ListTasks request.

      • (string) --
    • nextToken (string) --

      The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

register_container_instance(**kwargs)

Note

This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.

Registers an Amazon EC2 instance into the specified cluster. This instance will become available to place containers on.

Request Syntax

response = client.register_container_instance(
    cluster='string',
    instanceIdentityDocument='string',
    instanceIdentityDocumentSignature='string',
    totalResources=[
        {
            'name': 'string',
            'type': 'string',
            'doubleValue': 123.0,
            'longValue': 123,
            'integerValue': 123,
            'stringSetValue': [
                'string',
            ]
        },
    ],
    versionInfo={
        'agentVersion': 'string',
        'agentHash': 'string',
        'dockerVersion': 'string'
    },
    containerInstanceArn='string'
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that you want to register your container instance with. If you do not specify a cluster, the default cluster is assumed..
  • instanceIdentityDocument (string) -- The instance identity document for the Amazon EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/
  • instanceIdentityDocumentSignature (string) -- The instance identity document signature for the Amazon EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
  • totalResources (list) --

    The resources available on the instance.

    • (dict) --

      Describes the resources available for a container instance.

      • name (string) --

        The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.

      • type (string) --

        The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .

      • doubleValue (float) --

        When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

      • longValue (integer) --

        When the longValue type is set, the value of the resource must be an extended precision floating-point type.

      • integerValue (integer) --

        When the integerValue type is set, the value of the resource must be an integer.

      • stringSetValue (list) --

        When the stringSetValue type is set, the value of the resource must be a string type.

        • (string) --
  • versionInfo (dict) --

    The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

    • agentVersion (string) --

      The version number of the Amazon ECS container agent.

    • agentHash (string) --

      The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

    • dockerVersion (string) --

      The Docker version running on the container instance.

  • containerInstanceArn (string) -- The Amazon Resource Name (ARN) of the container instance (if it was previously registered).
Return type:

dict

Returns:

Response Syntax

{
    'containerInstance': {
        'containerInstanceArn': 'string',
        'ec2InstanceId': 'string',
        'versionInfo': {
            'agentVersion': 'string',
            'agentHash': 'string',
            'dockerVersion': 'string'
        },
        'remainingResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'registeredResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'status': 'string',
        'agentConnected': True|False,
        'runningTasksCount': 123,
        'pendingTasksCount': 123,
        'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED'
    }
}

Response Structure

  • (dict) --

    • containerInstance (dict) --

      An Amazon EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

      • containerInstanceArn (string) --

        The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region :aws_account_id :container-instance/container_instance_UUID .

      • ec2InstanceId (string) --

        The Amazon EC2 instance ID of the container instance.

      • versionInfo (dict) --

        The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

        • agentVersion (string) --

          The version number of the Amazon ECS container agent.

        • agentHash (string) --

          The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

        • dockerVersion (string) --

          The Docker version running on the container instance.

      • remainingResources (list) --

        The remaining resources of the container instance that are available for new tasks.

        • (dict) --

          Describes the resources available for a container instance.

          • name (string) --

            The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.

          • type (string) --

            The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .

          • doubleValue (float) --

            When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

          • longValue (integer) --

            When the longValue type is set, the value of the resource must be an extended precision floating-point type.

          • integerValue (integer) --

            When the integerValue type is set, the value of the resource must be an integer.

          • stringSetValue (list) --

            When the stringSetValue type is set, the value of the resource must be a string type.

            • (string) --
      • registeredResources (list) --

        The registered resources on the container instance that are in use by current tasks.

        • (dict) --

          Describes the resources available for a container instance.

          • name (string) --

            The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.

          • type (string) --

            The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .

          • doubleValue (float) --

            When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

          • longValue (integer) --

            When the longValue type is set, the value of the resource must be an extended precision floating-point type.

          • integerValue (integer) --

            When the integerValue type is set, the value of the resource must be an integer.

          • stringSetValue (list) --

            When the stringSetValue type is set, the value of the resource must be a string type.

            • (string) --
      • status (string) --

        The status of the container instance. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that the container instance can accept tasks.

      • agentConnected (boolean) --

        This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped will return false , and instances without a connected agent cannot accept placement request.

      • runningTasksCount (integer) --

        The number of tasks on the container instance that are in the RUNNING status.

      • pendingTasksCount (integer) --

        The number of tasks on the container instance that are in the PENDING status.

      • agentUpdateStatus (string) --

        The status of the most recent agent update. If an update has never been requested, this value is NULL .

register_task_definition(**kwargs)

Registers a new task definition from the supplied family and containerDefinitions . Optionally, you can add data volumes to your containers with the volumes parameter. For more information on task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .

Request Syntax

response = client.register_task_definition(
    family='string',
    containerDefinitions=[
        {
            'name': 'string',
            'image': 'string',
            'cpu': 123,
            'memory': 123,
            'links': [
                'string',
            ],
            'portMappings': [
                {
                    'containerPort': 123,
                    'hostPort': 123,
                    'protocol': 'tcp'|'udp'
                },
            ],
            'essential': True|False,
            'entryPoint': [
                'string',
            ],
            'command': [
                'string',
            ],
            'environment': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'mountPoints': [
                {
                    'sourceVolume': 'string',
                    'containerPath': 'string',
                    'readOnly': True|False
                },
            ],
            'volumesFrom': [
                {
                    'sourceContainer': 'string',
                    'readOnly': True|False
                },
            ]
        },
    ],
    volumes=[
        {
            'name': 'string',
            'host': {
                'sourcePath': 'string'
            }
        },
    ]
)
Parameters:
  • family (string) --

    [REQUIRED]

    You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. You can think of the family as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

  • containerDefinitions (list) --

    [REQUIRED]

    A list of container definitions in JSON format that describe the different containers that make up your task.

    • (dict) --

      Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

      • name (string) --

        The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers.

      • image (string) --

        The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with *repository-url* /*image* :*tag* .

      • cpu (integer) --

        The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount.

        For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

        The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel will allow is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

        • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
        • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
      • memory (integer) --

        The number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated here, the container is killed.

      • links (list) --

        The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. The name:internalName construct is analogous to name:alias in Docker links. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/ .

        Warning

        Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

        • (string) --
      • portMappings (list) --

        The list of port mappings for the container.

        • (dict) --

          Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

          • containerPort (integer) --

            The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container will automatically receive a host port in the ephemeral port range (for more information, see hostPort ).

          • hostPort (integer) --

            The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0 ) while specifying a containerPort and your container will automatically receive a port in the ephemeral port range for your container instance operating system and Docker version.

            The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range ; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, since these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

            The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS Container Agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (once a task stops, the host port is released).The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit).

          • protocol (string) --

            The protocol used for the port mapping. Valid values are tcp and udp . The default is tcp .

      • essential (boolean) --

        If the essential parameter of a container is marked as true , the failure of that container will stop the task. If the essential parameter of a container is marked as false , then its failure will not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

        Note

        All tasks must have at least one essential container.

      • entryPoint (list) --

        Warning

        Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint , update your container agent or enter your commands and arguments as command array items instead.

        The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint .

        • (string) --
      • command (list) --

        The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd .

        • (string) --
      • environment (list) --

        The environment variables to pass to a container.

        • (dict) --

          A key and value pair object.

          • name (string) --

            The name of the key value pair. For environment variables, this is the name of the environment variable.

          • value (string) --

            The value of the key value pair. For environment variables, this is the value of the environment variable.

      • mountPoints (list) --

        The mount points for data volumes in your container.

        • (dict) --

          Details on a volume mount point that is used in a container definition.

          • sourceVolume (string) --

            The name of the volume to mount.

          • containerPath (string) --

            The path on the container to mount the host volume at.

          • readOnly (boolean) --

            If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .

      • volumesFrom (list) --

        Data volumes to mount from another container.

        • (dict) --

          Details on a data volume from another container.

          • sourceContainer (string) --

            The name of the container to mount volumes from.

          • readOnly (boolean) --

            If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .

  • volumes (list) --

    A list of volume definitions in JSON format that containers in your task may use.

    • (dict) --

      A data volume used in a task definition.

      • name (string) --

        The name of the volume. This name is referenced in the sourceVolume parameter of container definition mountPoints .

      • host (dict) --

        The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.

        • sourcePath (string) --

          The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you.

Return type:

dict

Returns:

Response Syntax

{
    'taskDefinition': {
        'taskDefinitionArn': 'string',
        'containerDefinitions': [
            {
                'name': 'string',
                'image': 'string',
                'cpu': 123,
                'memory': 123,
                'links': [
                    'string',
                ],
                'portMappings': [
                    {
                        'containerPort': 123,
                        'hostPort': 123,
                        'protocol': 'tcp'|'udp'
                    },
                ],
                'essential': True|False,
                'entryPoint': [
                    'string',
                ],
                'command': [
                    'string',
                ],
                'environment': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'mountPoints': [
                    {
                        'sourceVolume': 'string',
                        'containerPath': 'string',
                        'readOnly': True|False
                    },
                ],
                'volumesFrom': [
                    {
                        'sourceContainer': 'string',
                        'readOnly': True|False
                    },
                ]
            },
        ],
        'family': 'string',
        'revision': 123,
        'volumes': [
            {
                'name': 'string',
                'host': {
                    'sourcePath': 'string'
                }
            },
        ],
        'status': 'ACTIVE'|'INACTIVE'
    }
}

Response Structure

  • (dict) --

    • taskDefinition (dict) --

      Details of a task definition.

      • taskDefinitionArn (string) --

        The full Amazon Resource Name (ARN) of the of the task definition.

      • containerDefinitions (list) --

        A list of container definitions in JSON format that describe the different containers that make up your task. For more information on container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .

        • (dict) --

          Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

          • name (string) --

            The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers.

          • image (string) --

            The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with *repository-url* /*image* :*tag* .

          • cpu (integer) --

            The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount.

            For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

            The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel will allow is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

            • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.
            • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
          • memory (integer) --

            The number of MiB of memory reserved for the container. If your container attempts to exceed the memory allocated here, the container is killed.

          • links (list) --

            The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter. The name:internalName construct is analogous to name:alias in Docker links. For more information on linking Docker containers, see https://docs.docker.com/userguide/dockerlinks/ .

            Warning

            Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

            • (string) --
          • portMappings (list) --

            The list of port mappings for the container.

            • (dict) --

              Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

              • containerPort (integer) --

                The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container will automatically receive a host port in the ephemeral port range (for more information, see hostPort ).

              • hostPort (integer) --

                The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0 ) while specifying a containerPort and your container will automatically receive a port in the ephemeral port range for your container instance operating system and Docker version.

                The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range ; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, since these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

                The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS Container Agent port 51678. Any host port that was previously specified in a running task is also reserved while the task is running (once a task stops, the host port is released).The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 50 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward this limit).

              • protocol (string) --

                The protocol used for the port mapping. Valid values are tcp and udp . The default is tcp .

          • essential (boolean) --

            If the essential parameter of a container is marked as true , the failure of that container will stop the task. If the essential parameter of a container is marked as false , then its failure will not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

            Note

            All tasks must have at least one essential container.

          • entryPoint (list) --

            Warning

            Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint , update your container agent or enter your commands and arguments as command array items instead.

            The ENTRYPOINT that is passed to the container. For more information on the Docker ENTRYPOINT parameter, see https://docs.docker.com/reference/builder/#entrypoint .

            • (string) --
          • command (list) --

            The CMD that is passed to the container. For more information on the Docker CMD parameter, see https://docs.docker.com/reference/builder/#cmd .

            • (string) --
          • environment (list) --

            The environment variables to pass to a container.

            • (dict) --

              A key and value pair object.

              • name (string) --

                The name of the key value pair. For environment variables, this is the name of the environment variable.

              • value (string) --

                The value of the key value pair. For environment variables, this is the value of the environment variable.

          • mountPoints (list) --

            The mount points for data volumes in your container.

            • (dict) --

              Details on a volume mount point that is used in a container definition.

              • sourceVolume (string) --

                The name of the volume to mount.

              • containerPath (string) --

                The path on the container to mount the host volume at.

              • readOnly (boolean) --

                If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .

          • volumesFrom (list) --

            Data volumes to mount from another container.

            • (dict) --

              Details on a data volume from another container.

              • sourceContainer (string) --

                The name of the container to mount volumes from.

              • readOnly (boolean) --

                If this value is true , the container has read-only access to the volume. If this value is false , then the container can write to the volume. The default value is false .

      • family (string) --

        The family of your task definition. You can think of the family as the name of your task definition.

      • revision (integer) --

        The revision of the task in a particular family. You can think of the revision as a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1 , and each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).

      • volumes (list) --

        The list of volumes in a task. For more information on volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .

        • (dict) --

          A data volume used in a task definition.

          • name (string) --

            The name of the volume. This name is referenced in the sourceVolume parameter of container definition mountPoints .

          • host (dict) --

            The path on the host container instance that is presented to the containers which access the volume. If this parameter is empty, then the Docker daemon assigns a host path for you.

            • sourcePath (string) --

              The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you.

      • status (string) --

        The status of the task definition.

run_task(**kwargs)

Start a task using random placement and the default Amazon ECS scheduler. If you want to use your own scheduler or place a task on a specific container instance, use StartTask instead.

Warning

The count parameter is limited to 10 tasks per call.

Request Syntax

response = client.run_task(
    cluster='string',
    taskDefinition='string',
    overrides={
        'containerOverrides': [
            {
                'name': 'string',
                'command': [
                    'string',
                ],
                'environment': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ]
            },
        ]
    },
    count=123,
    startedBy='string'
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your task on. If you do not specify a cluster, the default cluster is assumed..
  • taskDefinition (string) --

    [REQUIRED]

    The family and revision (family:revision ) or full Amazon Resource Name (ARN) of the task definition that you want to run. If a revision is not specified, the latest ACTIVE revision is used.

  • overrides (dict) --

    A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

    Note

    A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

    • containerOverrides (list) --

      One or more container overrides sent to a task.

      • (dict) --

        The overrides that should be sent to a container.

        • name (string) --

          The name of the container that receives the override.

        • command (list) --

          The command to send to the container that overrides the default command from the Docker image or the task definition.

          • (string) --
        • environment (list) --

          The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.

          • (dict) --

            A key and value pair object.

            • name (string) --

              The name of the key value pair. For environment variables, this is the name of the environment variable.

            • value (string) --

              The value of the key value pair. For environment variables, this is the value of the environment variable.

  • count (integer) --

    The number of instantiations of the specified task that you would like to place on your cluster.

    Warning

    The count parameter is limited to 10 tasks per call.

  • startedBy (string) --

    An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value.

    If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Return type:

dict

Returns:

Response Syntax

{
    'tasks': [
        {
            'taskArn': 'string',
            'clusterArn': 'string',
            'taskDefinitionArn': 'string',
            'containerInstanceArn': 'string',
            'overrides': {
                'containerOverrides': [
                    {
                        'name': 'string',
                        'command': [
                            'string',
                        ],
                        'environment': [
                            {
                                'name': 'string',
                                'value': 'string'
                            },
                        ]
                    },
                ]
            },
            'lastStatus': 'string',
            'desiredStatus': 'string',
            'containers': [
                {
                    'containerArn': 'string',
                    'taskArn': 'string',
                    'name': 'string',
                    'lastStatus': 'string',
                    'exitCode': 123,
                    'reason': 'string',
                    'networkBindings': [
                        {
                            'bindIP': 'string',
                            'containerPort': 123,
                            'hostPort': 123,
                            'protocol': 'tcp'|'udp'
                        },
                    ]
                },
            ],
            'startedBy': 'string'
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • tasks (list) --

      A full description of the tasks that were run. Each task that was successfully placed on your cluster will be described here.

      • (dict) --

        Details on a task in a cluster.

        • taskArn (string) --

          The Amazon Resource Name (ARN) of the task.

        • clusterArn (string) --

          The Amazon Resource Name (ARN) of the of the cluster that hosts the task.

        • taskDefinitionArn (string) --

          The Amazon Resource Name (ARN) of the of the task definition that creates the task.

        • containerInstanceArn (string) --

          The Amazon Resource Name (ARN) of the container instances that host the task.

        • overrides (dict) --

          One or more container overrides.

          • containerOverrides (list) --

            One or more container overrides sent to a task.

            • (dict) --

              The overrides that should be sent to a container.

              • name (string) --

                The name of the container that receives the override.

              • command (list) --

                The command to send to the container that overrides the default command from the Docker image or the task definition.

                • (string) --
              • environment (list) --

                The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.

                • (dict) --

                  A key and value pair object.

                  • name (string) --

                    The name of the key value pair. For environment variables, this is the name of the environment variable.

                  • value (string) --

                    The value of the key value pair. For environment variables, this is the value of the environment variable.

        • lastStatus (string) --

          The last known status of the task.

        • desiredStatus (string) --

          The desired status of the task.

        • containers (list) --

          The containers associated with the task.

          • (dict) --

            A docker container that is part of a task.

            • containerArn (string) --

              The Amazon Resource Name (ARN) of the container.

            • taskArn (string) --

              The Amazon Resource Name (ARN) of the task.

            • name (string) --

              The name of the container.

            • lastStatus (string) --

              The last known status of the container.

            • exitCode (integer) --

              The exit code returned from the container.

            • reason (string) --

              A short (255 max characters) human-readable string to provide additional detail about a running or stopped container.

            • networkBindings (list) --

              The network bindings associated with the container.

              • (dict) --

                Details on the network bindings between a container and its host container instance.

                • bindIP (string) --

                  The IP address that the container is bound to on the container instance.

                • containerPort (integer) --

                  The port number on the container that is be used with the network binding.

                • hostPort (integer) --

                  The port number on the host that is used with the network binding.

                • protocol (string) --

                  The protocol used for the network binding.

        • startedBy (string) --

          The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

    • failures (list) --

      Any failed tasks from your RunTask action are listed here.

      • (dict) --

        A failed resource.

        • arn (string) --

          The Amazon Resource Name (ARN) of the failed resource.

        • reason (string) --

          The reason for the failure.

start_task(**kwargs)

Starts a new task from the specified task definition on the specified container instance or instances. If you want to use the default Amazon ECS scheduler to place your task, use RunTask instead.

Warning

The list of container instances to start tasks on is limited to 10.

Request Syntax

response = client.start_task(
    cluster='string',
    taskDefinition='string',
    overrides={
        'containerOverrides': [
            {
                'name': 'string',
                'command': [
                    'string',
                ],
                'environment': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ]
            },
        ]
    },
    containerInstances=[
        'string',
    ],
    startedBy='string'
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that you want to start your task on. If you do not specify a cluster, the default cluster is assumed..
  • taskDefinition (string) --

    [REQUIRED]

    The family and revision (family:revision ) or full Amazon Resource Name (ARN) of the task definition that you want to start. If a revision is not specified, the latest ACTIVE revision is used.

  • overrides (dict) --

    A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

    Note

    A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

    • containerOverrides (list) --

      One or more container overrides sent to a task.

      • (dict) --

        The overrides that should be sent to a container.

        • name (string) --

          The name of the container that receives the override.

        • command (list) --

          The command to send to the container that overrides the default command from the Docker image or the task definition.

          • (string) --
        • environment (list) --

          The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.

          • (dict) --

            A key and value pair object.

            • name (string) --

              The name of the key value pair. For environment variables, this is the name of the environment variable.

            • value (string) --

              The value of the key value pair. For environment variables, this is the value of the environment variable.

  • containerInstances (list) --

    [REQUIRED]

    The container instance UUIDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.

    Warning

    The list of container instances to start tasks on is limited to 10.

    • (string) --
  • startedBy (string) --

    An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value.

    If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

Return type:

dict

Returns:

Response Syntax

{
    'tasks': [
        {
            'taskArn': 'string',
            'clusterArn': 'string',
            'taskDefinitionArn': 'string',
            'containerInstanceArn': 'string',
            'overrides': {
                'containerOverrides': [
                    {
                        'name': 'string',
                        'command': [
                            'string',
                        ],
                        'environment': [
                            {
                                'name': 'string',
                                'value': 'string'
                            },
                        ]
                    },
                ]
            },
            'lastStatus': 'string',
            'desiredStatus': 'string',
            'containers': [
                {
                    'containerArn': 'string',
                    'taskArn': 'string',
                    'name': 'string',
                    'lastStatus': 'string',
                    'exitCode': 123,
                    'reason': 'string',
                    'networkBindings': [
                        {
                            'bindIP': 'string',
                            'containerPort': 123,
                            'hostPort': 123,
                            'protocol': 'tcp'|'udp'
                        },
                    ]
                },
            ],
            'startedBy': 'string'
        },
    ],
    'failures': [
        {
            'arn': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • tasks (list) --

      A full description of the tasks that were started. Each task that was successfully placed on your container instances will be described here.

      • (dict) --

        Details on a task in a cluster.

        • taskArn (string) --

          The Amazon Resource Name (ARN) of the task.

        • clusterArn (string) --

          The Amazon Resource Name (ARN) of the of the cluster that hosts the task.

        • taskDefinitionArn (string) --

          The Amazon Resource Name (ARN) of the of the task definition that creates the task.

        • containerInstanceArn (string) --

          The Amazon Resource Name (ARN) of the container instances that host the task.

        • overrides (dict) --

          One or more container overrides.

          • containerOverrides (list) --

            One or more container overrides sent to a task.

            • (dict) --

              The overrides that should be sent to a container.

              • name (string) --

                The name of the container that receives the override.

              • command (list) --

                The command to send to the container that overrides the default command from the Docker image or the task definition.

                • (string) --
              • environment (list) --

                The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.

                • (dict) --

                  A key and value pair object.

                  • name (string) --

                    The name of the key value pair. For environment variables, this is the name of the environment variable.

                  • value (string) --

                    The value of the key value pair. For environment variables, this is the value of the environment variable.

        • lastStatus (string) --

          The last known status of the task.

        • desiredStatus (string) --

          The desired status of the task.

        • containers (list) --

          The containers associated with the task.

          • (dict) --

            A docker container that is part of a task.

            • containerArn (string) --

              The Amazon Resource Name (ARN) of the container.

            • taskArn (string) --

              The Amazon Resource Name (ARN) of the task.

            • name (string) --

              The name of the container.

            • lastStatus (string) --

              The last known status of the container.

            • exitCode (integer) --

              The exit code returned from the container.

            • reason (string) --

              A short (255 max characters) human-readable string to provide additional detail about a running or stopped container.

            • networkBindings (list) --

              The network bindings associated with the container.

              • (dict) --

                Details on the network bindings between a container and its host container instance.

                • bindIP (string) --

                  The IP address that the container is bound to on the container instance.

                • containerPort (integer) --

                  The port number on the container that is be used with the network binding.

                • hostPort (integer) --

                  The port number on the host that is used with the network binding.

                • protocol (string) --

                  The protocol used for the network binding.

        • startedBy (string) --

          The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

    • failures (list) --

      Any failed tasks from your StartTask action are listed here.

      • (dict) --

        A failed resource.

        • arn (string) --

          The Amazon Resource Name (ARN) of the failed resource.

        • reason (string) --

          The reason for the failure.

stop_task(**kwargs)

Stops a running task.

Request Syntax

response = client.stop_task(
    cluster='string',
    task='string'
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task you want to stop. If you do not specify a cluster, the default cluster is assumed..
  • task (string) --

    [REQUIRED]

    The task UUIDs or full Amazon Resource Name (ARN) entry of the task you would like to stop.

Return type:

dict

Returns:

Response Syntax

{
    'task': {
        'taskArn': 'string',
        'clusterArn': 'string',
        'taskDefinitionArn': 'string',
        'containerInstanceArn': 'string',
        'overrides': {
            'containerOverrides': [
                {
                    'name': 'string',
                    'command': [
                        'string',
                    ],
                    'environment': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ]
                },
            ]
        },
        'lastStatus': 'string',
        'desiredStatus': 'string',
        'containers': [
            {
                'containerArn': 'string',
                'taskArn': 'string',
                'name': 'string',
                'lastStatus': 'string',
                'exitCode': 123,
                'reason': 'string',
                'networkBindings': [
                    {
                        'bindIP': 'string',
                        'containerPort': 123,
                        'hostPort': 123,
                        'protocol': 'tcp'|'udp'
                    },
                ]
            },
        ],
        'startedBy': 'string'
    }
}

Response Structure

  • (dict) --

    • task (dict) --

      Details on a task in a cluster.

      • taskArn (string) --

        The Amazon Resource Name (ARN) of the task.

      • clusterArn (string) --

        The Amazon Resource Name (ARN) of the of the cluster that hosts the task.

      • taskDefinitionArn (string) --

        The Amazon Resource Name (ARN) of the of the task definition that creates the task.

      • containerInstanceArn (string) --

        The Amazon Resource Name (ARN) of the container instances that host the task.

      • overrides (dict) --

        One or more container overrides.

        • containerOverrides (list) --

          One or more container overrides sent to a task.

          • (dict) --

            The overrides that should be sent to a container.

            • name (string) --

              The name of the container that receives the override.

            • command (list) --

              The command to send to the container that overrides the default command from the Docker image or the task definition.

              • (string) --
            • environment (list) --

              The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.

              • (dict) --

                A key and value pair object.

                • name (string) --

                  The name of the key value pair. For environment variables, this is the name of the environment variable.

                • value (string) --

                  The value of the key value pair. For environment variables, this is the value of the environment variable.

      • lastStatus (string) --

        The last known status of the task.

      • desiredStatus (string) --

        The desired status of the task.

      • containers (list) --

        The containers associated with the task.

        • (dict) --

          A docker container that is part of a task.

          • containerArn (string) --

            The Amazon Resource Name (ARN) of the container.

          • taskArn (string) --

            The Amazon Resource Name (ARN) of the task.

          • name (string) --

            The name of the container.

          • lastStatus (string) --

            The last known status of the container.

          • exitCode (integer) --

            The exit code returned from the container.

          • reason (string) --

            A short (255 max characters) human-readable string to provide additional detail about a running or stopped container.

          • networkBindings (list) --

            The network bindings associated with the container.

            • (dict) --

              Details on the network bindings between a container and its host container instance.

              • bindIP (string) --

                The IP address that the container is bound to on the container instance.

              • containerPort (integer) --

                The port number on the container that is be used with the network binding.

              • hostPort (integer) --

                The port number on the host that is used with the network binding.

              • protocol (string) --

                The protocol used for the network binding.

      • startedBy (string) --

        The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

submit_container_state_change(**kwargs)

Note

This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a container changed states.

Request Syntax

response = client.submit_container_state_change(
    cluster='string',
    task='string',
    containerName='string',
    status='string',
    exitCode=123,
    reason='string',
    networkBindings=[
        {
            'bindIP': 'string',
            'containerPort': 123,
            'hostPort': 123,
            'protocol': 'tcp'|'udp'
        },
    ]
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container.
  • task (string) -- The task UUID or full Amazon Resource Name (ARN) of the task that hosts the container.
  • containerName (string) -- The name of the container.
  • status (string) -- The status of the state change request.
  • exitCode (integer) -- The exit code returned for the state change request.
  • reason (string) -- The reason for the state change request.
  • networkBindings (list) --

    The network bindings of the container.

    • (dict) --

      Details on the network bindings between a container and its host container instance.

      • bindIP (string) --

        The IP address that the container is bound to on the container instance.

      • containerPort (integer) --

        The port number on the container that is be used with the network binding.

      • hostPort (integer) --

        The port number on the host that is used with the network binding.

      • protocol (string) --

        The protocol used for the network binding.

Return type:

dict

Returns:

Response Syntax

{
    'acknowledgment': 'string'
}

Response Structure

  • (dict) --

    • acknowledgment (string) --

      Acknowledgement of the state change.

submit_task_state_change(**kwargs)

Note

This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

Request Syntax

response = client.submit_task_state_change(
    cluster='string',
    task='string',
    status='string',
    reason='string'
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
  • task (string) -- The task UUID or full Amazon Resource Name (ARN) of the task in the state change request.
  • status (string) -- The status of the state change request.
  • reason (string) -- The reason for the state change request.
Return type:

dict

Returns:

Response Syntax

{
    'acknowledgment': 'string'
}

Response Structure

  • (dict) --

    • acknowledgment (string) --

      Acknowledgement of the state change.

update_container_agent(**kwargs)

Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.

UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon EC2 Container Service Developer Guide .

Request Syntax

response = client.update_container_agent(
    cluster='string',
    containerInstance='string'
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
  • containerInstance (string) --

    [REQUIRED]

    The container instance UUID or full Amazon Resource Name (ARN) entries for the container instance on which you would like to update the Amazon ECS container agent.

Return type:

dict

Returns:

Response Syntax

{
    'containerInstance': {
        'containerInstanceArn': 'string',
        'ec2InstanceId': 'string',
        'versionInfo': {
            'agentVersion': 'string',
            'agentHash': 'string',
            'dockerVersion': 'string'
        },
        'remainingResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'registeredResources': [
            {
                'name': 'string',
                'type': 'string',
                'doubleValue': 123.0,
                'longValue': 123,
                'integerValue': 123,
                'stringSetValue': [
                    'string',
                ]
            },
        ],
        'status': 'string',
        'agentConnected': True|False,
        'runningTasksCount': 123,
        'pendingTasksCount': 123,
        'agentUpdateStatus': 'PENDING'|'STAGING'|'STAGED'|'UPDATING'|'UPDATED'|'FAILED'
    }
}

Response Structure

  • (dict) --

    • containerInstance (dict) --

      An Amazon EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

      • containerInstanceArn (string) --

        The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance UUID. For example, arn:aws:ecs:region :aws_account_id :container-instance/container_instance_UUID .

      • ec2InstanceId (string) --

        The Amazon EC2 instance ID of the container instance.

      • versionInfo (dict) --

        The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

        • agentVersion (string) --

          The version number of the Amazon ECS container agent.

        • agentHash (string) --

          The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

        • dockerVersion (string) --

          The Docker version running on the container instance.

      • remainingResources (list) --

        The remaining resources of the container instance that are available for new tasks.

        • (dict) --

          Describes the resources available for a container instance.

          • name (string) --

            The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.

          • type (string) --

            The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .

          • doubleValue (float) --

            When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

          • longValue (integer) --

            When the longValue type is set, the value of the resource must be an extended precision floating-point type.

          • integerValue (integer) --

            When the integerValue type is set, the value of the resource must be an integer.

          • stringSetValue (list) --

            When the stringSetValue type is set, the value of the resource must be a string type.

            • (string) --
      • registeredResources (list) --

        The registered resources on the container instance that are in use by current tasks.

        • (dict) --

          Describes the resources available for a container instance.

          • name (string) --

            The name of the resource, such as CPU , MEMORY , PORTS , or a user-defined resource.

          • type (string) --

            The type of the resource, such as INTEGER , DOUBLE , LONG , or STRINGSET .

          • doubleValue (float) --

            When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

          • longValue (integer) --

            When the longValue type is set, the value of the resource must be an extended precision floating-point type.

          • integerValue (integer) --

            When the integerValue type is set, the value of the resource must be an integer.

          • stringSetValue (list) --

            When the stringSetValue type is set, the value of the resource must be a string type.

            • (string) --
      • status (string) --

        The status of the container instance. The valid values are ACTIVE or INACTIVE . ACTIVE indicates that the container instance can accept tasks.

      • agentConnected (boolean) --

        This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped will return false , and instances without a connected agent cannot accept placement request.

      • runningTasksCount (integer) --

        The number of tasks on the container instance that are in the RUNNING status.

      • pendingTasksCount (integer) --

        The number of tasks on the container instance that are in the PENDING status.

      • agentUpdateStatus (string) --

        The status of the most recent agent update. If an update has never been requested, this value is NULL .

update_service(**kwargs)

Modify the desired count or task definition used in a service.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

You can use UpdateService to modify your task definition and deploy a new version of your service, one task at a time. If you modify the task definition with UpdateService , Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.

Request Syntax

response = client.update_service(
    cluster='string',
    service='string',
    desiredCount=123,
    taskDefinition='string'
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
  • service (string) --

    [REQUIRED]

    The name of the service that you want to update.

  • desiredCount (integer) -- The number of instantiations of the task that you would like to place and keep running in your service.
  • taskDefinition (string) -- The family and revision (family:revision ) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService , Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.
Return type:

dict

Returns:

Response Syntax

{
    'service': {
        'serviceArn': 'string',
        'serviceName': 'string',
        'clusterArn': 'string',
        'loadBalancers': [
            {
                'loadBalancerName': 'string',
                'containerName': 'string',
                'containerPort': 123
            },
        ],
        'status': 'string',
        'desiredCount': 123,
        'runningCount': 123,
        'pendingCount': 123,
        'taskDefinition': 'string',
        'deployments': [
            {
                'id': 'string',
                'status': 'string',
                'taskDefinition': 'string',
                'desiredCount': 123,
                'pendingCount': 123,
                'runningCount': 123,
                'createdAt': datetime(2015, 1, 1),
                'updatedAt': datetime(2015, 1, 1)
            },
        ],
        'roleArn': 'string',
        'events': [
            {
                'id': 'string',
                'createdAt': datetime(2015, 1, 1),
                'message': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • service (dict) --

      The full description of your service following the update call.

      • serviceArn (string) --

        The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region :012345678910 :service/my-service .

      • serviceName (string) --

        A user-generated string that you can use to identify your service.

      • clusterArn (string) --

        The Amazon Resource Name (ARN) of the of the cluster that hosts the service.

      • loadBalancers (list) --

        A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

        • (dict) --

          Details on a load balancer that is used with a service.

          • loadBalancerName (string) --

            The name of the load balancer.

          • containerName (string) --

            The name of the container to associate with the load balancer.

          • containerPort (integer) --

            The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.

      • status (string) --

        The status of the service. The valid values are ACTIVE , DRAINING , or INACTIVE .

      • desiredCount (integer) --

        The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .

      • runningCount (integer) --

        The number of tasks in the cluster that are in the RUNNING state.

      • pendingCount (integer) --

        The number of tasks in the cluster that are in the PENDING state.

      • taskDefinition (string) --

        The task definition to use for tasks in the service. This value is specified when the service is created with CreateService , and it can be modified with UpdateService .

      • deployments (list) --

        The current state of deployments for the service.

        • (dict) --

          The details of an Amazon ECS service deployment.

          • id (string) --

            The ID of the deployment.

          • status (string) --

            The status of the deployment. Valid values are PRIMARY (for the most recent deployment), ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments that have been completely replaced).

          • taskDefinition (string) --

            The most recent task definition that was specified for the service to use.

          • desiredCount (integer) --

            The most recent desired count of tasks that was specified for the service to deploy and/or maintain.

          • pendingCount (integer) --

            The number of tasks in the deployment that are in the PENDING status.

          • runningCount (integer) --

            The number of tasks in the deployment that are in the RUNNING status.

          • createdAt (datetime) --

            The Unix time in seconds and milliseconds when the service was created.

          • updatedAt (datetime) --

            The Unix time in seconds and milliseconds when the service was last updated.

      • roleArn (string) --

        The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with a load balancer.

      • events (list) --

        The event stream for your service. A maximum of 100 of the latest events are displayed.

        • (dict) --

          Details on an event associated with a service.

          • id (string) --

            The ID string of the event.

          • createdAt (datetime) --

            The Unix time in seconds and milliseconds when the event was triggered.

          • message (string) --

            The event message.

Paginators

The available paginators are:

class ECS.Paginator.list_clusters
paginator = client.get_paginator('list_clusters')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ECS.Client.list_clusters().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:dict
Returns:Response Syntax
{
    'clusterArns': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • clusterArns (list) --

      The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.

class ECS.Paginator.list_container_instances
paginator = client.get_paginator('list_container_instances')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ECS.Client.list_container_instances().

Request Syntax

response_iterator = paginator.paginate(
    cluster='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances you want to list. If you do not specify a cluster, the default cluster is assumed..
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'containerInstanceArns': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • containerInstanceArns (list) --

      The list of container instance full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.

class ECS.Paginator.list_services
paginator = client.get_paginator('list_services')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ECS.Client.list_services().

Request Syntax

response_iterator = paginator.paginate(
    cluster='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services you want to list. If you do not specify a cluster, the default cluster is assumed..
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'serviceArns': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • serviceArns (list) --

      The list of full Amazon Resource Name (ARN) entries for each service associated with the specified cluster.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.

class ECS.Paginator.list_task_definition_families
paginator = client.get_paginator('list_task_definition_families')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ECS.Client.list_task_definition_families().

Request Syntax

response_iterator = paginator.paginate(
    familyPrefix='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • familyPrefix (string) -- The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies . If you specify a familyPrefix , only task definition family names that begin with the familyPrefix string are returned.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'families': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • families (list) --

      The list of task definition family names that match the ListTaskDefinitionFamilies request.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.

class ECS.Paginator.list_task_definitions
paginator = client.get_paginator('list_task_definitions')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ECS.Client.list_task_definitions().

Request Syntax

response_iterator = paginator.paginate(
    familyPrefix='string',
    status='ACTIVE'|'INACTIVE',
    sort='ASC'|'DESC',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • familyPrefix (string) -- The full family name that you want to filter the ListTaskDefinitions results with. Specifying a familyPrefix will limit the listed task definitions to task definition revisions that belong to that family.
  • status (string) -- The task definition status that you want to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE , you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
  • sort (string) -- The order in which to sort the results. Valid values are ASC and DESC . By default (ASC ), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'taskDefinitionArns': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • taskDefinitionArns (list) --

      The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefintions request.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.

class ECS.Paginator.list_tasks
paginator = client.get_paginator('list_tasks')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ECS.Client.list_tasks().

Request Syntax

response_iterator = paginator.paginate(
    cluster='string',
    containerInstance='string',
    family='string',
    startedBy='string',
    serviceName='string',
    desiredStatus='RUNNING'|'PENDING'|'STOPPED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want to list. If you do not specify a cluster, the default cluster is assumed..
  • containerInstance (string) -- The container instance UUID or full Amazon Resource Name (ARN) of the container instance that you want to filter the ListTasks results with. Specifying a containerInstance will limit the results to tasks that belong to that container instance.
  • family (string) -- The name of the family that you want to filter the ListTasks results with. Specifying a family will limit the results to tasks that belong to that family.
  • startedBy (string) -- The startedBy value that you want to filter the task results with. Specifying a startedBy value will limit the results to tasks that were started with that value.
  • serviceName (string) -- The name of the service that you want to filter the ListTasks results with. Specifying a serviceName will limit the results to tasks that belong to that service.
  • desiredStatus (string) -- The task status that you want to filter the ListTasks results with. Specifying a desiredStatus of STOPPED will limit the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING .
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'taskArns': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • taskArns (list) --

      The list of task Amazon Resource Name (ARN) entries for the ListTasks request.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.

Waiters

The available waiters are:

class ECS.Waiter.services_inactive
waiter = client.get_waiter('services_inactive')
wait(**kwargs)

This polls ECS.Client.describe_services() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

Request Syntax

waiter.wait(
    cluster='string',
    services=[
        'string',
    ]
)
Parameters:
  • cluster (string) -- The name of the cluster that hosts the service you want to describe.
  • services (list) --

    [REQUIRED]

    A list of services you want to describe.

    • (string) --
Returns:

None

class ECS.Waiter.services_stable
waiter = client.get_waiter('services_stable')
wait(**kwargs)

This polls ECS.Client.describe_services() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

Request Syntax

waiter.wait(
    cluster='string',
    services=[
        'string',
    ]
)
Parameters:
  • cluster (string) -- The name of the cluster that hosts the service you want to describe.
  • services (list) --

    [REQUIRED]

    A list of services you want to describe.

    • (string) --
Returns:

None

class ECS.Waiter.tasks_running
waiter = client.get_waiter('tasks_running')
wait(**kwargs)

This polls ECS.Client.describe_tasks() every 6 seconds until a successful state is reached. An error is returned after 100 failed checks.

Request Syntax

waiter.wait(
    cluster='string',
    tasks=[
        'string',
    ]
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task you want to describe. If you do not specify a cluster, the default cluster is assumed.
  • tasks (list) --

    [REQUIRED]

    A space-separated list of task UUIDs or full Amazon Resource Name (ARN) entries.

    • (string) --
Returns:

None

class ECS.Waiter.tasks_stopped
waiter = client.get_waiter('tasks_stopped')
wait(**kwargs)

This polls ECS.Client.describe_tasks() every 6 seconds until a successful state is reached. An error is returned after 100 failed checks.

Request Syntax

waiter.wait(
    cluster='string',
    tasks=[
        'string',
    ]
)
Parameters:
  • cluster (string) -- The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task you want to describe. If you do not specify a cluster, the default cluster is assumed.
  • tasks (list) --

    [REQUIRED]

    A space-separated list of task UUIDs or full Amazon Resource Name (ARN) entries.

    • (string) --
Returns:

None