Amazon EC2 Container Service 2014-11-13

CreateCluster

$result = $client->createCluster([/* ... */]);
$promise = $client->createClusterAsync([/* ... */]);

Parameter Syntax

$result = $client->createCluster([
    'clusterName' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'cluster' => [
        'activeServicesCount' => <integer>,
        'clusterArn' => '<string>',
        'clusterName' => '<string>',
        'pendingTasksCount' => <integer>,
        'registeredContainerInstancesCount' => <integer>,
        'runningTasksCount' => <integer>,
        'statistics' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To create a new cluster

This example creates a cluster in your default region.

$result = $client->createCluster([
    'clusterName' => 'my_cluster',
]);

Result syntax:

[
    'cluster' => [
        'activeServicesCount' => 0,
        'clusterArn' => 'arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster',
        'clusterName' => 'my_cluster',
        'pendingTasksCount' => 0,
        'registeredContainerInstancesCount' => 0,
        'runningTasksCount' => 0,
        'status' => 'ACTIVE',
    ],
]

CreateService

$result = $client->createService([/* ... */]);
$promise = $client->createServiceAsync([/* ... */]);

Parameter Syntax

$result = $client->createService([
    'clientToken' => '<string>',
    'cluster' => '<string>',
    'deploymentConfiguration' => [
        'maximumPercent' => <integer>,
        'minimumHealthyPercent' => <integer>,
    ],
    'deploymentController' => [
        'type' => 'ECS|CODE_DEPLOY|EXTERNAL', // REQUIRED
    ],
    'desiredCount' => <integer>,
    'enableECSManagedTags' => true || false,
    'healthCheckGracePeriodSeconds' => <integer>,
    'launchType' => 'EC2|FARGATE',
    'loadBalancers' => [
        [
            'containerName' => '<string>',
            'containerPort' => <integer>,
            'loadBalancerName' => '<string>',
            'targetGroupArn' => '<string>',
        ],
        // ...
    ],
    'networkConfiguration' => [
        'awsvpcConfiguration' => [
            'assignPublicIp' => 'ENABLED|DISABLED',
            'securityGroups' => ['<string>', ...],
            'subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'placementConstraints' => [
        [
            'expression' => '<string>',
            'type' => 'distinctInstance|memberOf',
        ],
        // ...
    ],
    'placementStrategy' => [
        [
            'field' => '<string>',
            'type' => 'random|spread|binpack',
        ],
        // ...
    ],
    'platformVersion' => '<string>',
    'propagateTags' => 'TASK_DEFINITION|SERVICE',
    'role' => '<string>',
    'schedulingStrategy' => 'REPLICA|DAEMON',
    'serviceName' => '<string>', // REQUIRED
    'serviceRegistries' => [
        [
            'containerName' => '<string>',
            'containerPort' => <integer>,
            'port' => <integer>,
            'registryArn' => '<string>',
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'taskDefinition' => '<string>',
]);

Parameter Details

Result Syntax

[
    'service' => [
        'clusterArn' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'deploymentConfiguration' => [
            'maximumPercent' => <integer>,
            'minimumHealthyPercent' => <integer>,
        ],
        'deploymentController' => [
            'type' => 'ECS|CODE_DEPLOY|EXTERNAL',
        ],
        'deployments' => [
            [
                'createdAt' => <DateTime>,
                'desiredCount' => <integer>,
                'id' => '<string>',
                'launchType' => 'EC2|FARGATE',
                'networkConfiguration' => [
                    'awsvpcConfiguration' => [
                        'assignPublicIp' => 'ENABLED|DISABLED',
                        'securityGroups' => ['<string>', ...],
                        'subnets' => ['<string>', ...],
                    ],
                ],
                'pendingCount' => <integer>,
                'platformVersion' => '<string>',
                'runningCount' => <integer>,
                'status' => '<string>',
                'taskDefinition' => '<string>',
                'updatedAt' => <DateTime>,
            ],
            // ...
        ],
        'desiredCount' => <integer>,
        'enableECSManagedTags' => true || false,
        'events' => [
            [
                'createdAt' => <DateTime>,
                'id' => '<string>',
                'message' => '<string>',
            ],
            // ...
        ],
        'healthCheckGracePeriodSeconds' => <integer>,
        'launchType' => 'EC2|FARGATE',
        'loadBalancers' => [
            [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'loadBalancerName' => '<string>',
                'targetGroupArn' => '<string>',
            ],
            // ...
        ],
        'networkConfiguration' => [
            'awsvpcConfiguration' => [
                'assignPublicIp' => 'ENABLED|DISABLED',
                'securityGroups' => ['<string>', ...],
                'subnets' => ['<string>', ...],
            ],
        ],
        'pendingCount' => <integer>,
        'placementConstraints' => [
            [
                'expression' => '<string>',
                'type' => 'distinctInstance|memberOf',
            ],
            // ...
        ],
        'placementStrategy' => [
            [
                'field' => '<string>',
                'type' => 'random|spread|binpack',
            ],
            // ...
        ],
        'platformVersion' => '<string>',
        'propagateTags' => 'TASK_DEFINITION|SERVICE',
        'roleArn' => '<string>',
        'runningCount' => <integer>,
        'schedulingStrategy' => 'REPLICA|DAEMON',
        'serviceArn' => '<string>',
        'serviceName' => '<string>',
        'serviceRegistries' => [
            [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'port' => <integer>,
                'registryArn' => '<string>',
            ],
            // ...
        ],
        'status' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'taskDefinition' => '<string>',
        'taskSets' => [
            [
                'clusterArn' => '<string>',
                'computedDesiredCount' => <integer>,
                'createdAt' => <DateTime>,
                'externalId' => '<string>',
                'id' => '<string>',
                'launchType' => 'EC2|FARGATE',
                'loadBalancers' => [
                    [
                        'containerName' => '<string>',
                        'containerPort' => <integer>,
                        'loadBalancerName' => '<string>',
                        'targetGroupArn' => '<string>',
                    ],
                    // ...
                ],
                'networkConfiguration' => [
                    'awsvpcConfiguration' => [
                        'assignPublicIp' => 'ENABLED|DISABLED',
                        'securityGroups' => ['<string>', ...],
                        'subnets' => ['<string>', ...],
                    ],
                ],
                'pendingCount' => <integer>,
                'platformVersion' => '<string>',
                'runningCount' => <integer>,
                'scale' => [
                    'unit' => 'PERCENT',
                    'value' => <float>,
                ],
                'serviceArn' => '<string>',
                'serviceRegistries' => [
                    [
                        'containerName' => '<string>',
                        'containerPort' => <integer>,
                        'port' => <integer>,
                        'registryArn' => '<string>',
                    ],
                    // ...
                ],
                'stabilityStatus' => 'STEADY_STATE|STABILIZING',
                'stabilityStatusAt' => <DateTime>,
                'startedBy' => '<string>',
                'status' => '<string>',
                'taskDefinition' => '<string>',
                'taskSetArn' => '<string>',
                'updatedAt' => <DateTime>,
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• UnsupportedFeatureException:

  The specified task is not supported in this Region.

• PlatformUnknownException:

  The specified platform version does not exist.

• PlatformTaskDefinitionIncompatibilityException:

  The specified platform version does not satisfy the task definition's required capabilities.

• AccessDeniedException:

  You do not have authorization to perform the requested action.

Examples

Example 1: To create a new service

This example creates a service in your default region called ``ecs-simple-service``. The service uses the ``hello_world`` task definition and it maintains 10 copies of that task.

$result = $client->createService([
    'desiredCount' => 10,
    'serviceName' => 'ecs-simple-service',
    'taskDefinition' => 'hello_world',
]);

Result syntax:

[
    'service' => [
        'clusterArn' => 'arn:aws:ecs:us-east-1:012345678910:cluster/default',
        'createdAt' => ,
        'deploymentConfiguration' => [
            'maximumPercent' => 200,
            'minimumHealthyPercent' => 100,
        ],
        'deployments' => [
            [
                'createdAt' => ,
                'desiredCount' => 10,
                'id' => 'ecs-svc/9223370564342348388',
                'pendingCount' => 0,
                'runningCount' => 0,
                'status' => 'PRIMARY',
                'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6',
                'updatedAt' => ,
            ],
            [
                'createdAt' => ,
                'desiredCount' => 0,
                'id' => 'ecs-svc/9223370564343611322',
                'pendingCount' => 0,
                'runningCount' => 0,
                'status' => 'ACTIVE',
                'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6',
                'updatedAt' => ,
            ],
        ],
        'desiredCount' => 10,
        'events' => [
        ],
        'loadBalancers' => [
        ],
        'pendingCount' => 0,
        'runningCount' => 0,
        'serviceArn' => 'arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service',
        'serviceName' => 'ecs-simple-service',
        'status' => 'ACTIVE',
        'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6',
    ],
]

Example 2: To create a new service behind a load balancer

This example creates a service in your default region called ``ecs-simple-service-elb``. The service uses the ``ecs-demo`` task definition and it maintains 10 copies of that task. You must reference an existing load balancer in the same region by its name.

$result = $client->createService([
    'desiredCount' => 10,
    'loadBalancers' => [
        [
            'containerName' => 'simple-app',
            'containerPort' => 80,
            'loadBalancerName' => 'EC2Contai-EcsElast-15DCDAURT3ZO2',
        ],
    ],
    'role' => 'ecsServiceRole',
    'serviceName' => 'ecs-simple-service-elb',
    'taskDefinition' => 'console-sample-app-static',
]);

Result syntax:

[
    'service' => [
        'clusterArn' => 'arn:aws:ecs:us-east-1:012345678910:cluster/default',
        'createdAt' => ,
        'deploymentConfiguration' => [
            'maximumPercent' => 200,
            'minimumHealthyPercent' => 100,
        ],
        'deployments' => [
            [
                'createdAt' => ,
                'desiredCount' => 10,
                'id' => 'ecs-svc/9223370564343000923',
                'pendingCount' => 0,
                'runningCount' => 0,
                'status' => 'PRIMARY',
                'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6',
                'updatedAt' => ,
            ],
        ],
        'desiredCount' => 10,
        'events' => [
        ],
        'loadBalancers' => [
            [
                'containerName' => 'simple-app',
                'containerPort' => 80,
                'loadBalancerName' => 'EC2Contai-EcsElast-15DCDAURT3ZO2',
            ],
        ],
        'pendingCount' => 0,
        'roleArn' => 'arn:aws:iam::012345678910:role/ecsServiceRole',
        'runningCount' => 0,
        'serviceArn' => 'arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service-elb',
        'serviceName' => 'ecs-simple-service-elb',
        'status' => 'ACTIVE',
        'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6',
    ],
]

CreateTaskSet

$result = $client->createTaskSet([/* ... */]);
$promise = $client->createTaskSetAsync([/* ... */]);

Parameter Syntax

$result = $client->createTaskSet([
    'clientToken' => '<string>',
    'cluster' => '<string>', // REQUIRED
    'externalId' => '<string>',
    'launchType' => 'EC2|FARGATE',
    'loadBalancers' => [
        [
            'containerName' => '<string>',
            'containerPort' => <integer>,
            'loadBalancerName' => '<string>',
            'targetGroupArn' => '<string>',
        ],
        // ...
    ],
    'networkConfiguration' => [
        'awsvpcConfiguration' => [
            'assignPublicIp' => 'ENABLED|DISABLED',
            'securityGroups' => ['<string>', ...],
            'subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'platformVersion' => '<string>',
    'scale' => [
        'unit' => 'PERCENT',
        'value' => <float>,
    ],
    'service' => '<string>', // REQUIRED
    'serviceRegistries' => [
        [
            'containerName' => '<string>',
            'containerPort' => <integer>,
            'port' => <integer>,
            'registryArn' => '<string>',
        ],
        // ...
    ],
    'taskDefinition' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'taskSet' => [
        'clusterArn' => '<string>',
        'computedDesiredCount' => <integer>,
        'createdAt' => <DateTime>,
        'externalId' => '<string>',
        'id' => '<string>',
        'launchType' => 'EC2|FARGATE',
        'loadBalancers' => [
            [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'loadBalancerName' => '<string>',
                'targetGroupArn' => '<string>',
            ],
            // ...
        ],
        'networkConfiguration' => [
            'awsvpcConfiguration' => [
                'assignPublicIp' => 'ENABLED|DISABLED',
                'securityGroups' => ['<string>', ...],
                'subnets' => ['<string>', ...],
            ],
        ],
        'pendingCount' => <integer>,
        'platformVersion' => '<string>',
        'runningCount' => <integer>,
        'scale' => [
            'unit' => 'PERCENT',
            'value' => <float>,
        ],
        'serviceArn' => '<string>',
        'serviceRegistries' => [
            [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'port' => <integer>,
                'registryArn' => '<string>',
            ],
            // ...
        ],
        'stabilityStatus' => 'STEADY_STATE|STABILIZING',
        'stabilityStatusAt' => <DateTime>,
        'startedBy' => '<string>',
        'status' => '<string>',
        'taskDefinition' => '<string>',
        'taskSetArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• UnsupportedFeatureException:

  The specified task is not supported in this Region.

• PlatformUnknownException:

  The specified platform version does not exist.

• PlatformTaskDefinitionIncompatibilityException:

  The specified platform version does not satisfy the task definition's required capabilities.

• AccessDeniedException:

  You do not have authorization to perform the requested action.

• ServiceNotFoundException:

  The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.

• ServiceNotActiveException:

  The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.

DeleteAccountSetting

$result = $client->deleteAccountSetting([/* ... */]);
$promise = $client->deleteAccountSettingAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteAccountSetting([
    'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking', // REQUIRED
    'principalArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'setting' => [
        'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking',
        'principalArn' => '<string>',
        'value' => '<string>',
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To delete your account setting

This example deletes the account setting for your user for the specified resource type.

$result = $client->deleteAccountSetting([
    'name' => 'serviceLongArnFormat',
]);

Result syntax:

[
    'setting' => [
        'name' => 'serviceLongArnFormat',
        'value' => 'enabled',
        'principalArn' => 'arn:aws:iam:::user/principalName',
    ],
]

Example 2: To delete the account settings for a specific IAM user or IAM role

This example deletes the account setting for a specific IAM user or IAM role for the specified resource type. Only the root user can view or modify the account settings for another user.

$result = $client->deleteAccountSetting([
    'name' => 'containerInstanceLongArnFormat',
    'principalArn' => 'arn:aws:iam:::user/principalName',
]);

Result syntax:

[
    'setting' => [
        'name' => 'containerInstanceLongArnFormat',
        'value' => 'enabled',
        'principalArn' => 'arn:aws:iam:::user/principalName',
    ],
]

DeleteAttributes

$result = $client->deleteAttributes([/* ... */]);
$promise = $client->deleteAttributesAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteAttributes([
    'attributes' => [ // REQUIRED
        [
            'name' => '<string>', // REQUIRED
            'targetId' => '<string>',
            'targetType' => 'container-instance',
            'value' => '<string>',
        ],
        // ...
    ],
    'cluster' => '<string>',
]);

Parameter Details

Result Syntax

[
    'attributes' => [
        [
            'name' => '<string>',
            'targetId' => '<string>',
            'targetType' => 'container-instance',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• TargetNotFoundException:

  The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

DeleteCluster

$result = $client->deleteCluster([/* ... */]);
$promise = $client->deleteClusterAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteCluster([
    'cluster' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'cluster' => [
        'activeServicesCount' => <integer>,
        'clusterArn' => '<string>',
        'clusterName' => '<string>',
        'pendingTasksCount' => <integer>,
        'registeredContainerInstancesCount' => <integer>,
        'runningTasksCount' => <integer>,
        'statistics' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'status' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• ClusterContainsContainerInstancesException:

  You cannot delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

• ClusterContainsServicesException:

  You cannot delete a cluster that contains services. First, update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.

• ClusterContainsTasksException:

  You cannot delete a cluster that has active tasks.

Examples

Example 1: To delete an empty cluster

This example deletes an empty cluster in your default region.

$result = $client->deleteCluster([
    'cluster' => 'my_cluster',
]);

Result syntax:

[
    'cluster' => [
        'activeServicesCount' => 0,
        'clusterArn' => 'arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster',
        'clusterName' => 'my_cluster',
        'pendingTasksCount' => 0,
        'registeredContainerInstancesCount' => 0,
        'runningTasksCount' => 0,
        'status' => 'INACTIVE',
    ],
]

DeleteService

$result = $client->deleteService([/* ... */]);
$promise = $client->deleteServiceAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteService([
    'cluster' => '<string>',
    'force' => true || false,
    'service' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'service' => [
        'clusterArn' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'deploymentConfiguration' => [
            'maximumPercent' => <integer>,
            'minimumHealthyPercent' => <integer>,
        ],
        'deploymentController' => [
            'type' => 'ECS|CODE_DEPLOY|EXTERNAL',
        ],
        'deployments' => [
            [
                'createdAt' => <DateTime>,
                'desiredCount' => <integer>,
                'id' => '<string>',
                'launchType' => 'EC2|FARGATE',
                'networkConfiguration' => [
                    'awsvpcConfiguration' => [
                        'assignPublicIp' => 'ENABLED|DISABLED',
                        'securityGroups' => ['<string>', ...],
                        'subnets' => ['<string>', ...],
                    ],
                ],
                'pendingCount' => <integer>,
                'platformVersion' => '<string>',
                'runningCount' => <integer>,
                'status' => '<string>',
                'taskDefinition' => '<string>',
                'updatedAt' => <DateTime>,
            ],
            // ...
        ],
        'desiredCount' => <integer>,
        'enableECSManagedTags' => true || false,
        'events' => [
            [
                'createdAt' => <DateTime>,
                'id' => '<string>',
                'message' => '<string>',
            ],
            // ...
        ],
        'healthCheckGracePeriodSeconds' => <integer>,
        'launchType' => 'EC2|FARGATE',
        'loadBalancers' => [
            [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'loadBalancerName' => '<string>',
                'targetGroupArn' => '<string>',
            ],
            // ...
        ],
        'networkConfiguration' => [
            'awsvpcConfiguration' => [
                'assignPublicIp' => 'ENABLED|DISABLED',
                'securityGroups' => ['<string>', ...],
                'subnets' => ['<string>', ...],
            ],
        ],
        'pendingCount' => <integer>,
        'placementConstraints' => [
            [
                'expression' => '<string>',
                'type' => 'distinctInstance|memberOf',
            ],
            // ...
        ],
        'placementStrategy' => [
            [
                'field' => '<string>',
                'type' => 'random|spread|binpack',
            ],
            // ...
        ],
        'platformVersion' => '<string>',
        'propagateTags' => 'TASK_DEFINITION|SERVICE',
        'roleArn' => '<string>',
        'runningCount' => <integer>,
        'schedulingStrategy' => 'REPLICA|DAEMON',
        'serviceArn' => '<string>',
        'serviceName' => '<string>',
        'serviceRegistries' => [
            [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'port' => <integer>,
                'registryArn' => '<string>',
            ],
            // ...
        ],
        'status' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'taskDefinition' => '<string>',
        'taskSets' => [
            [
                'clusterArn' => '<string>',
                'computedDesiredCount' => <integer>,
                'createdAt' => <DateTime>,
                'externalId' => '<string>',
                'id' => '<string>',
                'launchType' => 'EC2|FARGATE',
                'loadBalancers' => [
                    [
                        'containerName' => '<string>',
                        'containerPort' => <integer>,
                        'loadBalancerName' => '<string>',
                        'targetGroupArn' => '<string>',
                    ],
                    // ...
                ],
                'networkConfiguration' => [
                    'awsvpcConfiguration' => [
                        'assignPublicIp' => 'ENABLED|DISABLED',
                        'securityGroups' => ['<string>', ...],
                        'subnets' => ['<string>', ...],
                    ],
                ],
                'pendingCount' => <integer>,
                'platformVersion' => '<string>',
                'runningCount' => <integer>,
                'scale' => [
                    'unit' => 'PERCENT',
                    'value' => <float>,
                ],
                'serviceArn' => '<string>',
                'serviceRegistries' => [
                    [
                        'containerName' => '<string>',
                        'containerPort' => <integer>,
                        'port' => <integer>,
                        'registryArn' => '<string>',
                    ],
                    // ...
                ],
                'stabilityStatus' => 'STEADY_STATE|STABILIZING',
                'stabilityStatusAt' => <DateTime>,
                'startedBy' => '<string>',
                'status' => '<string>',
                'taskDefinition' => '<string>',
                'taskSetArn' => '<string>',
                'updatedAt' => <DateTime>,
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• ServiceNotFoundException:

  The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.

Examples

Example 1: To delete a service

This example deletes the my-http-service service. The service must have a desired count and running count of 0 before you can delete it.

$result = $client->deleteService([
    'service' => 'my-http-service',
]);

Result syntax:

[
]

DeleteTaskSet

$result = $client->deleteTaskSet([/* ... */]);
$promise = $client->deleteTaskSetAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteTaskSet([
    'cluster' => '<string>', // REQUIRED
    'force' => true || false,
    'service' => '<string>', // REQUIRED
    'taskSet' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'taskSet' => [
        'clusterArn' => '<string>',
        'computedDesiredCount' => <integer>,
        'createdAt' => <DateTime>,
        'externalId' => '<string>',
        'id' => '<string>',
        'launchType' => 'EC2|FARGATE',
        'loadBalancers' => [
            [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'loadBalancerName' => '<string>',
                'targetGroupArn' => '<string>',
            ],
            // ...
        ],
        'networkConfiguration' => [
            'awsvpcConfiguration' => [
                'assignPublicIp' => 'ENABLED|DISABLED',
                'securityGroups' => ['<string>', ...],
                'subnets' => ['<string>', ...],
            ],
        ],
        'pendingCount' => <integer>,
        'platformVersion' => '<string>',
        'runningCount' => <integer>,
        'scale' => [
            'unit' => 'PERCENT',
            'value' => <float>,
        ],
        'serviceArn' => '<string>',
        'serviceRegistries' => [
            [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'port' => <integer>,
                'registryArn' => '<string>',
            ],
            // ...
        ],
        'stabilityStatus' => 'STEADY_STATE|STABILIZING',
        'stabilityStatusAt' => <DateTime>,
        'startedBy' => '<string>',
        'status' => '<string>',
        'taskDefinition' => '<string>',
        'taskSetArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• UnsupportedFeatureException:

  The specified task is not supported in this Region.

• AccessDeniedException:

  You do not have authorization to perform the requested action.

• ServiceNotFoundException:

  The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.

• ServiceNotActiveException:

  The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.

• TaskSetNotFoundException:

  The specified task set could not be found. You can view your available container instances with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

DeregisterContainerInstance

$result = $client->deregisterContainerInstance([/* ... */]);
$promise = $client->deregisterContainerInstanceAsync([/* ... */]);

Parameter Syntax

$result = $client->deregisterContainerInstance([
    'cluster' => '<string>',
    'containerInstance' => '<string>', // REQUIRED
    'force' => true || false,
]);

Parameter Details

Result Syntax

[
    'containerInstance' => [
        'agentConnected' => true || false,
        'agentUpdateStatus' => 'PENDING|STAGING|STAGED|UPDATING|UPDATED|FAILED',
        'attachments' => [
            [
                'details' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'id' => '<string>',
                'status' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'attributes' => [
            [
                'name' => '<string>',
                'targetId' => '<string>',
                'targetType' => 'container-instance',
                'value' => '<string>',
            ],
            // ...
        ],
        'containerInstanceArn' => '<string>',
        'ec2InstanceId' => '<string>',
        'pendingTasksCount' => <integer>,
        'registeredAt' => <DateTime>,
        'registeredResources' => [
            [
                'doubleValue' => <float>,
                'integerValue' => <integer>,
                'longValue' => <integer>,
                'name' => '<string>',
                'stringSetValue' => ['<string>', ...],
                'type' => '<string>',
            ],
            // ...
        ],
        'remainingResources' => [
            [
                'doubleValue' => <float>,
                'integerValue' => <integer>,
                'longValue' => <integer>,
                'name' => '<string>',
                'stringSetValue' => ['<string>', ...],
                'type' => '<string>',
            ],
            // ...
        ],
        'runningTasksCount' => <integer>,
        'status' => '<string>',
        'statusReason' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'version' => <integer>,
        'versionInfo' => [
            'agentHash' => '<string>',
            'agentVersion' => '<string>',
            'dockerVersion' => '<string>',
        ],
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

Examples

Example 1: To deregister a container instance from a cluster

This example deregisters a container instance from the specified cluster in your default region. If there are still tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option.

$result = $client->deregisterContainerInstance([
    'cluster' => 'default',
    'containerInstance' => 'container_instance_UUID',
    'force' => 1,
]);

Result syntax:

[
]

DeregisterTaskDefinition

$result = $client->deregisterTaskDefinition([/* ... */]);
$promise = $client->deregisterTaskDefinitionAsync([/* ... */]);

Parameter Syntax

$result = $client->deregisterTaskDefinition([
    'taskDefinition' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'taskDefinition' => [
        'compatibilities' => ['<string>', ...],
        'containerDefinitions' => [
            [
                'command' => ['<string>', ...],
                'cpu' => <integer>,
                'dependsOn' => [
                    [
                        'condition' => 'START|COMPLETE|SUCCESS|HEALTHY',
                        'containerName' => '<string>',
                    ],
                    // ...
                ],
                'disableNetworking' => true || false,
                'dnsSearchDomains' => ['<string>', ...],
                'dnsServers' => ['<string>', ...],
                'dockerLabels' => ['<string>', ...],
                'dockerSecurityOptions' => ['<string>', ...],
                'entryPoint' => ['<string>', ...],
                'environment' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'essential' => true || false,
                'extraHosts' => [
                    [
                        'hostname' => '<string>',
                        'ipAddress' => '<string>',
                    ],
                    // ...
                ],
                'healthCheck' => [
                    'command' => ['<string>', ...],
                    'interval' => <integer>,
                    'retries' => <integer>,
                    'startPeriod' => <integer>,
                    'timeout' => <integer>,
                ],
                'hostname' => '<string>',
                'image' => '<string>',
                'interactive' => true || false,
                'links' => ['<string>', ...],
                'linuxParameters' => [
                    'capabilities' => [
                        'add' => ['<string>', ...],
                        'drop' => ['<string>', ...],
                    ],
                    'devices' => [
                        [
                            'containerPath' => '<string>',
                            'hostPath' => '<string>',
                            'permissions' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'initProcessEnabled' => true || false,
                    'sharedMemorySize' => <integer>,
                    'tmpfs' => [
                        [
                            'containerPath' => '<string>',
                            'mountOptions' => ['<string>', ...],
                            'size' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'logConfiguration' => [
                    'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk',
                    'options' => ['<string>', ...],
                    'secretOptions' => [
                        [
                            'name' => '<string>',
                            'valueFrom' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'memory' => <integer>,
                'memoryReservation' => <integer>,
                'mountPoints' => [
                    [
                        'containerPath' => '<string>',
                        'readOnly' => true || false,
                        'sourceVolume' => '<string>',
                    ],
                    // ...
                ],
                'name' => '<string>',
                'portMappings' => [
                    [
                        'containerPort' => <integer>,
                        'hostPort' => <integer>,
                        'protocol' => 'tcp|udp',
                    ],
                    // ...
                ],
                'privileged' => true || false,
                'pseudoTerminal' => true || false,
                'readonlyRootFilesystem' => true || false,
                'repositoryCredentials' => [
                    'credentialsParameter' => '<string>',
                ],
                'resourceRequirements' => [
                    [
                        'type' => 'GPU',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'secrets' => [
                    [
                        'name' => '<string>',
                        'valueFrom' => '<string>',
                    ],
                    // ...
                ],
                'startTimeout' => <integer>,
                'stopTimeout' => <integer>,
                'systemControls' => [
                    [
                        'namespace' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'ulimits' => [
                    [
                        'hardLimit' => <integer>,
                        'name' => 'core|cpu|data|fsize|locks|memlock|msgqueue|nice|nofile|nproc|rss|rtprio|rttime|sigpending|stack',
                        'softLimit' => <integer>,
                    ],
                    // ...
                ],
                'user' => '<string>',
                'volumesFrom' => [
                    [
                        'readOnly' => true || false,
                        'sourceContainer' => '<string>',
                    ],
                    // ...
                ],
                'workingDirectory' => '<string>',
            ],
            // ...
        ],
        'cpu' => '<string>',
        'executionRoleArn' => '<string>',
        'family' => '<string>',
        'ipcMode' => 'host|task|none',
        'memory' => '<string>',
        'networkMode' => 'bridge|host|awsvpc|none',
        'pidMode' => 'host|task',
        'placementConstraints' => [
            [
                'expression' => '<string>',
                'type' => 'memberOf',
            ],
            // ...
        ],
        'proxyConfiguration' => [
            'containerName' => '<string>',
            'properties' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'type' => 'APPMESH',
        ],
        'requiresAttributes' => [
            [
                'name' => '<string>',
                'targetId' => '<string>',
                'targetType' => 'container-instance',
                'value' => '<string>',
            ],
            // ...
        ],
        'requiresCompatibilities' => ['<string>', ...],
        'revision' => <integer>,
        'status' => 'ACTIVE|INACTIVE',
        'taskDefinitionArn' => '<string>',
        'taskRoleArn' => '<string>',
        'volumes' => [
            [
                'dockerVolumeConfiguration' => [
                    'autoprovision' => true || false,
                    'driver' => '<string>',
                    'driverOpts' => ['<string>', ...],
                    'labels' => ['<string>', ...],
                    'scope' => 'task|shared',
                ],
                'host' => [
                    'sourcePath' => '<string>',
                ],
                'name' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

DescribeClusters

$result = $client->describeClusters([/* ... */]);
$promise = $client->describeClustersAsync([/* ... */]);

Parameter Syntax

$result = $client->describeClusters([
    'clusters' => ['<string>', ...],
    'include' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'clusters' => [
        [
            'activeServicesCount' => <integer>,
            'clusterArn' => '<string>',
            'clusterName' => '<string>',
            'pendingTasksCount' => <integer>,
            'registeredContainerInstancesCount' => <integer>,
            'runningTasksCount' => <integer>,
            'statistics' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'status' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'failures' => [
        [
            'arn' => '<string>',
            'reason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To describe a cluster

This example provides a description of the specified cluster in your default region.

$result = $client->describeClusters([
    'clusters' => [
        'default',
    ],
]);

Result syntax:

[
    'clusters' => [
        [
            'clusterArn' => 'arn:aws:ecs:us-east-1:aws_account_id:cluster/default',
            'clusterName' => 'default',
            'status' => 'ACTIVE',
        ],
    ],
    'failures' => [
    ],
]

DescribeContainerInstances

$result = $client->describeContainerInstances([/* ... */]);
$promise = $client->describeContainerInstancesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeContainerInstances([
    'cluster' => '<string>',
    'containerInstances' => ['<string>', ...], // REQUIRED
    'include' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'containerInstances' => [
        [
            'agentConnected' => true || false,
            'agentUpdateStatus' => 'PENDING|STAGING|STAGED|UPDATING|UPDATED|FAILED',
            'attachments' => [
                [
                    'details' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'id' => '<string>',
                    'status' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
            'attributes' => [
                [
                    'name' => '<string>',
                    'targetId' => '<string>',
                    'targetType' => 'container-instance',
                    'value' => '<string>',
                ],
                // ...
            ],
            'containerInstanceArn' => '<string>',
            'ec2InstanceId' => '<string>',
            'pendingTasksCount' => <integer>,
            'registeredAt' => <DateTime>,
            'registeredResources' => [
                [
                    'doubleValue' => <float>,
                    'integerValue' => <integer>,
                    'longValue' => <integer>,
                    'name' => '<string>',
                    'stringSetValue' => ['<string>', ...],
                    'type' => '<string>',
                ],
                // ...
            ],
            'remainingResources' => [
                [
                    'doubleValue' => <float>,
                    'integerValue' => <integer>,
                    'longValue' => <integer>,
                    'name' => '<string>',
                    'stringSetValue' => ['<string>', ...],
                    'type' => '<string>',
                ],
                // ...
            ],
            'runningTasksCount' => <integer>,
            'status' => '<string>',
            'statusReason' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'version' => <integer>,
            'versionInfo' => [
                'agentHash' => '<string>',
                'agentVersion' => '<string>',
                'dockerVersion' => '<string>',
            ],
        ],
        // ...
    ],
    'failures' => [
        [
            'arn' => '<string>',
            'reason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

Examples

Example 1: To describe container instance

This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier.

$result = $client->describeContainerInstances([
    'cluster' => 'default',
    'containerInstances' => [
        'f2756532-8f13-4d53-87c9-aed50dc94cd7',
    ],
]);

Result syntax:

[
    'containerInstances' => [
        [
            'agentConnected' => 1,
            'containerInstanceArn' => 'arn:aws:ecs:us-east-1:012345678910:container-instance/f2756532-8f13-4d53-87c9-aed50dc94cd7',
            'ec2InstanceId' => 'i-807f3249',
            'pendingTasksCount' => 0,
            'registeredResources' => [
                [
                    'name' => 'CPU',
                    'type' => 'INTEGER',
                    'doubleValue' => 0,
                    'integerValue' => 2048,
                    'longValue' => 0,
                ],
                [
                    'name' => 'MEMORY',
                    'type' => 'INTEGER',
                    'doubleValue' => 0,
                    'integerValue' => 3768,
                    'longValue' => 0,
                ],
                [
                    'name' => 'PORTS',
                    'type' => 'STRINGSET',
                    'doubleValue' => 0,
                    'integerValue' => 0,
                    'longValue' => 0,
                    'stringSetValue' => [
                        '2376',
                        '22',
                        '51678',
                        '2375',
                    ],
                ],
            ],
            'remainingResources' => [
                [
                    'name' => 'CPU',
                    'type' => 'INTEGER',
                    'doubleValue' => 0,
                    'integerValue' => 1948,
                    'longValue' => 0,
                ],
                [
                    'name' => 'MEMORY',
                    'type' => 'INTEGER',
                    'doubleValue' => 0,
                    'integerValue' => 3668,
                    'longValue' => 0,
                ],
                [
                    'name' => 'PORTS',
                    'type' => 'STRINGSET',
                    'doubleValue' => 0,
                    'integerValue' => 0,
                    'longValue' => 0,
                    'stringSetValue' => [
                        '2376',
                        '22',
                        '80',
                        '51678',
                        '2375',
                    ],
                ],
            ],
            'runningTasksCount' => 1,
            'status' => 'ACTIVE',
        ],
    ],
    'failures' => [
    ],
]

DescribeServices

$result = $client->describeServices([/* ... */]);
$promise = $client->describeServicesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeServices([
    'cluster' => '<string>',
    'include' => ['<string>', ...],
    'services' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failures' => [
        [
            'arn' => '<string>',
            'reason' => '<string>',
        ],
        // ...
    ],
    'services' => [
        [
            'clusterArn' => '<string>',
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'deploymentConfiguration' => [
                'maximumPercent' => <integer>,
                'minimumHealthyPercent' => <integer>,
            ],
            'deploymentController' => [
                'type' => 'ECS|CODE_DEPLOY|EXTERNAL',
            ],
            'deployments' => [
                [
                    'createdAt' => <DateTime>,
                    'desiredCount' => <integer>,
                    'id' => '<string>',
                    'launchType' => 'EC2|FARGATE',
                    'networkConfiguration' => [
                        'awsvpcConfiguration' => [
                            'assignPublicIp' => 'ENABLED|DISABLED',
                            'securityGroups' => ['<string>', ...],
                            'subnets' => ['<string>', ...],
                        ],
                    ],
                    'pendingCount' => <integer>,
                    'platformVersion' => '<string>',
                    'runningCount' => <integer>,
                    'status' => '<string>',
                    'taskDefinition' => '<string>',
                    'updatedAt' => <DateTime>,
                ],
                // ...
            ],
            'desiredCount' => <integer>,
            'enableECSManagedTags' => true || false,
            'events' => [
                [
                    'createdAt' => <DateTime>,
                    'id' => '<string>',
                    'message' => '<string>',
                ],
                // ...
            ],
            'healthCheckGracePeriodSeconds' => <integer>,
            'launchType' => 'EC2|FARGATE',
            'loadBalancers' => [
                [
                    'containerName' => '<string>',
                    'containerPort' => <integer>,
                    'loadBalancerName' => '<string>',
                    'targetGroupArn' => '<string>',
                ],
                // ...
            ],
            'networkConfiguration' => [
                'awsvpcConfiguration' => [
                    'assignPublicIp' => 'ENABLED|DISABLED',
                    'securityGroups' => ['<string>', ...],
                    'subnets' => ['<string>', ...],
                ],
            ],
            'pendingCount' => <integer>,
            'placementConstraints' => [
                [
                    'expression' => '<string>',
                    'type' => 'distinctInstance|memberOf',
                ],
                // ...
            ],
            'placementStrategy' => [
                [
                    'field' => '<string>',
                    'type' => 'random|spread|binpack',
                ],
                // ...
            ],
            'platformVersion' => '<string>',
            'propagateTags' => 'TASK_DEFINITION|SERVICE',
            'roleArn' => '<string>',
            'runningCount' => <integer>,
            'schedulingStrategy' => 'REPLICA|DAEMON',
            'serviceArn' => '<string>',
            'serviceName' => '<string>',
            'serviceRegistries' => [
                [
                    'containerName' => '<string>',
                    'containerPort' => <integer>,
                    'port' => <integer>,
                    'registryArn' => '<string>',
                ],
                // ...
            ],
            'status' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'taskDefinition' => '<string>',
            'taskSets' => [
                [
                    'clusterArn' => '<string>',
                    'computedDesiredCount' => <integer>,
                    'createdAt' => <DateTime>,
                    'externalId' => '<string>',
                    'id' => '<string>',
                    'launchType' => 'EC2|FARGATE',
                    'loadBalancers' => [
                        [
                            'containerName' => '<string>',
                            'containerPort' => <integer>,
                            'loadBalancerName' => '<string>',
                            'targetGroupArn' => '<string>',
                        ],
                        // ...
                    ],
                    'networkConfiguration' => [
                        'awsvpcConfiguration' => [
                            'assignPublicIp' => 'ENABLED|DISABLED',
                            'securityGroups' => ['<string>', ...],
                            'subnets' => ['<string>', ...],
                        ],
                    ],
                    'pendingCount' => <integer>,
                    'platformVersion' => '<string>',
                    'runningCount' => <integer>,
                    'scale' => [
                        'unit' => 'PERCENT',
                        'value' => <float>,
                    ],
                    'serviceArn' => '<string>',
                    'serviceRegistries' => [
                        [
                            'containerName' => '<string>',
                            'containerPort' => <integer>,
                            'port' => <integer>,
                            'registryArn' => '<string>',
                        ],
                        // ...
                    ],
                    'stabilityStatus' => 'STEADY_STATE|STABILIZING',
                    'stabilityStatusAt' => <DateTime>,
                    'startedBy' => '<string>',
                    'status' => '<string>',
                    'taskDefinition' => '<string>',
                    'taskSetArn' => '<string>',
                    'updatedAt' => <DateTime>,
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

Examples

Example 1: To describe a service

This example provides descriptive information about the service named ``ecs-simple-service``.

$result = $client->describeServices([
    'services' => [
        'ecs-simple-service',
    ],
]);

Result syntax:

[
    'failures' => [
    ],
    'services' => [
        [
            'clusterArn' => 'arn:aws:ecs:us-east-1:012345678910:cluster/default',
            'createdAt' => ,
            'deploymentConfiguration' => [
                'maximumPercent' => 200,
                'minimumHealthyPercent' => 100,
            ],
            'deployments' => [
                [
                    'createdAt' => ,
                    'desiredCount' => 1,
                    'id' => 'ecs-svc/9223370564341623665',
                    'pendingCount' => 0,
                    'runningCount' => 0,
                    'status' => 'PRIMARY',
                    'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6',
                    'updatedAt' => ,
                ],
            ],
            'desiredCount' => 1,
            'events' => [
                [
                    'createdAt' => ,
                    'id' => '38c285e5-d335-4b68-8b15-e46dedc8e88d',
                    'message' => '(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide.',
                ],
            ],
            'loadBalancers' => [
            ],
            'pendingCount' => 0,
            'runningCount' => 0,
            'serviceArn' => 'arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service',
            'serviceName' => 'ecs-simple-service',
            'status' => 'ACTIVE',
            'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6',
        ],
    ],
]

DescribeTaskDefinition

$result = $client->describeTaskDefinition([/* ... */]);
$promise = $client->describeTaskDefinitionAsync([/* ... */]);

Parameter Syntax

$result = $client->describeTaskDefinition([
    'include' => ['<string>', ...],
    'taskDefinition' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'taskDefinition' => [
        'compatibilities' => ['<string>', ...],
        'containerDefinitions' => [
            [
                'command' => ['<string>', ...],
                'cpu' => <integer>,
                'dependsOn' => [
                    [
                        'condition' => 'START|COMPLETE|SUCCESS|HEALTHY',
                        'containerName' => '<string>',
                    ],
                    // ...
                ],
                'disableNetworking' => true || false,
                'dnsSearchDomains' => ['<string>', ...],
                'dnsServers' => ['<string>', ...],
                'dockerLabels' => ['<string>', ...],
                'dockerSecurityOptions' => ['<string>', ...],
                'entryPoint' => ['<string>', ...],
                'environment' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'essential' => true || false,
                'extraHosts' => [
                    [
                        'hostname' => '<string>',
                        'ipAddress' => '<string>',
                    ],
                    // ...
                ],
                'healthCheck' => [
                    'command' => ['<string>', ...],
                    'interval' => <integer>,
                    'retries' => <integer>,
                    'startPeriod' => <integer>,
                    'timeout' => <integer>,
                ],
                'hostname' => '<string>',
                'image' => '<string>',
                'interactive' => true || false,
                'links' => ['<string>', ...],
                'linuxParameters' => [
                    'capabilities' => [
                        'add' => ['<string>', ...],
                        'drop' => ['<string>', ...],
                    ],
                    'devices' => [
                        [
                            'containerPath' => '<string>',
                            'hostPath' => '<string>',
                            'permissions' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'initProcessEnabled' => true || false,
                    'sharedMemorySize' => <integer>,
                    'tmpfs' => [
                        [
                            'containerPath' => '<string>',
                            'mountOptions' => ['<string>', ...],
                            'size' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'logConfiguration' => [
                    'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk',
                    'options' => ['<string>', ...],
                    'secretOptions' => [
                        [
                            'name' => '<string>',
                            'valueFrom' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'memory' => <integer>,
                'memoryReservation' => <integer>,
                'mountPoints' => [
                    [
                        'containerPath' => '<string>',
                        'readOnly' => true || false,
                        'sourceVolume' => '<string>',
                    ],
                    // ...
                ],
                'name' => '<string>',
                'portMappings' => [
                    [
                        'containerPort' => <integer>,
                        'hostPort' => <integer>,
                        'protocol' => 'tcp|udp',
                    ],
                    // ...
                ],
                'privileged' => true || false,
                'pseudoTerminal' => true || false,
                'readonlyRootFilesystem' => true || false,
                'repositoryCredentials' => [
                    'credentialsParameter' => '<string>',
                ],
                'resourceRequirements' => [
                    [
                        'type' => 'GPU',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'secrets' => [
                    [
                        'name' => '<string>',
                        'valueFrom' => '<string>',
                    ],
                    // ...
                ],
                'startTimeout' => <integer>,
                'stopTimeout' => <integer>,
                'systemControls' => [
                    [
                        'namespace' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'ulimits' => [
                    [
                        'hardLimit' => <integer>,
                        'name' => 'core|cpu|data|fsize|locks|memlock|msgqueue|nice|nofile|nproc|rss|rtprio|rttime|sigpending|stack',
                        'softLimit' => <integer>,
                    ],
                    // ...
                ],
                'user' => '<string>',
                'volumesFrom' => [
                    [
                        'readOnly' => true || false,
                        'sourceContainer' => '<string>',
                    ],
                    // ...
                ],
                'workingDirectory' => '<string>',
            ],
            // ...
        ],
        'cpu' => '<string>',
        'executionRoleArn' => '<string>',
        'family' => '<string>',
        'ipcMode' => 'host|task|none',
        'memory' => '<string>',
        'networkMode' => 'bridge|host|awsvpc|none',
        'pidMode' => 'host|task',
        'placementConstraints' => [
            [
                'expression' => '<string>',
                'type' => 'memberOf',
            ],
            // ...
        ],
        'proxyConfiguration' => [
            'containerName' => '<string>',
            'properties' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'type' => 'APPMESH',
        ],
        'requiresAttributes' => [
            [
                'name' => '<string>',
                'targetId' => '<string>',
                'targetType' => 'container-instance',
                'value' => '<string>',
            ],
            // ...
        ],
        'requiresCompatibilities' => ['<string>', ...],
        'revision' => <integer>,
        'status' => 'ACTIVE|INACTIVE',
        'taskDefinitionArn' => '<string>',
        'taskRoleArn' => '<string>',
        'volumes' => [
            [
                'dockerVolumeConfiguration' => [
                    'autoprovision' => true || false,
                    'driver' => '<string>',
                    'driverOpts' => ['<string>', ...],
                    'labels' => ['<string>', ...],
                    'scope' => 'task|shared',
                ],
                'host' => [
                    'sourcePath' => '<string>',
                ],
                'name' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To describe a task definition

This example provides a description of the specified task definition.

$result = $client->describeTaskDefinition([
    'taskDefinition' => 'hello_world:8',
]);

Result syntax:

[
    'taskDefinition' => [
        'containerDefinitions' => [
            [
                'name' => 'wordpress',
                'cpu' => 10,
                'environment' => [
                ],
                'essential' => 1,
                'image' => 'wordpress',
                'links' => [
                    'mysql',
                ],
                'memory' => 500,
                'mountPoints' => [
                ],
                'portMappings' => [
                    [
                        'containerPort' => 80,
                        'hostPort' => 80,
                    ],
                ],
                'volumesFrom' => [
                ],
            ],
            [
                'name' => 'mysql',
                'cpu' => 10,
                'environment' => [
                    [
                        'name' => 'MYSQL_ROOT_PASSWORD',
                        'value' => 'password',
                    ],
                ],
                'essential' => 1,
                'image' => 'mysql',
                'memory' => 500,
                'mountPoints' => [
                ],
                'portMappings' => [
                ],
                'volumesFrom' => [
                ],
            ],
        ],
        'family' => 'hello_world',
        'revision' => 8,
        'taskDefinitionArn' => 'arn:aws:ecs:us-east-1::task-definition/hello_world:8',
        'volumes' => [
        ],
    ],
]

DescribeTaskSets

$result = $client->describeTaskSets([/* ... */]);
$promise = $client->describeTaskSetsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeTaskSets([
    'cluster' => '<string>', // REQUIRED
    'service' => '<string>', // REQUIRED
    'taskSets' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'failures' => [
        [
            'arn' => '<string>',
            'reason' => '<string>',
        ],
        // ...
    ],
    'taskSets' => [
        [
            'clusterArn' => '<string>',
            'computedDesiredCount' => <integer>,
            'createdAt' => <DateTime>,
            'externalId' => '<string>',
            'id' => '<string>',
            'launchType' => 'EC2|FARGATE',
            'loadBalancers' => [
                [
                    'containerName' => '<string>',
                    'containerPort' => <integer>,
                    'loadBalancerName' => '<string>',
                    'targetGroupArn' => '<string>',
                ],
                // ...
            ],
            'networkConfiguration' => [
                'awsvpcConfiguration' => [
                    'assignPublicIp' => 'ENABLED|DISABLED',
                    'securityGroups' => ['<string>', ...],
                    'subnets' => ['<string>', ...],
                ],
            ],
            'pendingCount' => <integer>,
            'platformVersion' => '<string>',
            'runningCount' => <integer>,
            'scale' => [
                'unit' => 'PERCENT',
                'value' => <float>,
            ],
            'serviceArn' => '<string>',
            'serviceRegistries' => [
                [
                    'containerName' => '<string>',
                    'containerPort' => <integer>,
                    'port' => <integer>,
                    'registryArn' => '<string>',
                ],
                // ...
            ],
            'stabilityStatus' => 'STEADY_STATE|STABILIZING',
            'stabilityStatusAt' => <DateTime>,
            'startedBy' => '<string>',
            'status' => '<string>',
            'taskDefinition' => '<string>',
            'taskSetArn' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• UnsupportedFeatureException:

  The specified task is not supported in this Region.

• AccessDeniedException:

  You do not have authorization to perform the requested action.

• ServiceNotFoundException:

  The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.

• ServiceNotActiveException:

  The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.

DescribeTasks

$result = $client->describeTasks([/* ... */]);
$promise = $client->describeTasksAsync([/* ... */]);

Parameter Syntax

$result = $client->describeTasks([
    'cluster' => '<string>',
    'include' => ['<string>', ...],
    'tasks' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failures' => [
        [
            'arn' => '<string>',
            'reason' => '<string>',
        ],
        // ...
    ],
    'tasks' => [
        [
            'attachments' => [
                [
                    'details' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'id' => '<string>',
                    'status' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
            'clusterArn' => '<string>',
            'connectivity' => 'CONNECTED|DISCONNECTED',
            'connectivityAt' => <DateTime>,
            'containerInstanceArn' => '<string>',
            'containers' => [
                [
                    'containerArn' => '<string>',
                    'cpu' => '<string>',
                    'exitCode' => <integer>,
                    'gpuIds' => ['<string>', ...],
                    'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN',
                    'lastStatus' => '<string>',
                    'memory' => '<string>',
                    'memoryReservation' => '<string>',
                    'name' => '<string>',
                    'networkBindings' => [
                        [
                            'bindIP' => '<string>',
                            'containerPort' => <integer>,
                            'hostPort' => <integer>,
                            'protocol' => 'tcp|udp',
                        ],
                        // ...
                    ],
                    'networkInterfaces' => [
                        [
                            'attachmentId' => '<string>',
                            'ipv6Address' => '<string>',
                            'privateIpv4Address' => '<string>',
                        ],
                        // ...
                    ],
                    'reason' => '<string>',
                    'taskArn' => '<string>',
                ],
                // ...
            ],
            'cpu' => '<string>',
            'createdAt' => <DateTime>,
            'desiredStatus' => '<string>',
            'executionStoppedAt' => <DateTime>,
            'group' => '<string>',
            'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN',
            'lastStatus' => '<string>',
            'launchType' => 'EC2|FARGATE',
            'memory' => '<string>',
            'overrides' => [
                'containerOverrides' => [
                    [
                        'command' => ['<string>', ...],
                        'cpu' => <integer>,
                        'environment' => [
                            [
                                'name' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'memory' => <integer>,
                        'memoryReservation' => <integer>,
                        'name' => '<string>',
                        'resourceRequirements' => [
                            [
                                'type' => 'GPU',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'executionRoleArn' => '<string>',
                'taskRoleArn' => '<string>',
            ],
            'platformVersion' => '<string>',
            'pullStartedAt' => <DateTime>,
            'pullStoppedAt' => <DateTime>,
            'startedAt' => <DateTime>,
            'startedBy' => '<string>',
            'stopCode' => 'TaskFailedToStart|EssentialContainerExited|UserInitiated',
            'stoppedAt' => <DateTime>,
            'stoppedReason' => '<string>',
            'stoppingAt' => <DateTime>,
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'taskArn' => '<string>',
            'taskDefinitionArn' => '<string>',
            'version' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

Examples

Example 1: To describe a task

This example provides a description of the specified task, using the task UUID as an identifier.

$result = $client->describeTasks([
    'tasks' => [
        'c5cba4eb-5dad-405e-96db-71ef8eefe6a8',
    ],
]);

Result syntax:

[
    'failures' => [
    ],
    'tasks' => [
        [
            'clusterArn' => 'arn:aws:ecs:::cluster/default',
            'containerInstanceArn' => 'arn:aws:ecs:::container-instance/18f9eda5-27d7-4c19-b133-45adc516e8fb',
            'containers' => [
                [
                    'name' => 'ecs-demo',
                    'containerArn' => 'arn:aws:ecs:::container/7c01765b-c588-45b3-8290-4ba38bd6c5a6',
                    'lastStatus' => 'RUNNING',
                    'networkBindings' => [
                        [
                            'bindIP' => '0.0.0.0',
                            'containerPort' => 80,
                            'hostPort' => 80,
                        ],
                    ],
                    'taskArn' => 'arn:aws:ecs:::task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8',
                ],
            ],
            'desiredStatus' => 'RUNNING',
            'lastStatus' => 'RUNNING',
            'overrides' => [
                'containerOverrides' => [
                    [
                        'name' => 'ecs-demo',
                    ],
                ],
            ],
            'startedBy' => 'ecs-svc/9223370608528463088',
            'taskArn' => 'arn:aws:ecs:::task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8',
            'taskDefinitionArn' => 'arn:aws:ecs:::task-definition/amazon-ecs-sample:1',
        ],
    ],
]

DiscoverPollEndpoint

$result = $client->discoverPollEndpoint([/* ... */]);
$promise = $client->discoverPollEndpointAsync([/* ... */]);

Parameter Syntax

$result = $client->discoverPollEndpoint([
    'cluster' => '<string>',
    'containerInstance' => '<string>',
]);

Parameter Details

Result Syntax

[
    'endpoint' => '<string>',
    'telemetryEndpoint' => '<string>',
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

ListAccountSettings

$result = $client->listAccountSettings([/* ... */]);
$promise = $client->listAccountSettingsAsync([/* ... */]);

Parameter Syntax

$result = $client->listAccountSettings([
    'effectiveSettings' => true || false,
    'maxResults' => <integer>,
    'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking',
    'nextToken' => '<string>',
    'principalArn' => '<string>',
    'value' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'settings' => [
        [
            'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking',
            'principalArn' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To view your effective account settings

This example displays the effective account settings for your account.

$result = $client->listAccountSettings([
    'effectiveSettings' => 1,
]);

Result syntax:

[
    'settings' => [
        [
            'name' => 'containerInstanceLongArnFormat',
            'value' => 'disabled',
            'principalArn' => 'arn:aws:iam:::user/principalName',
        ],
        [
            'name' => 'serviceLongArnFormat',
            'value' => 'enabled',
            'principalArn' => 'arn:aws:iam:::user/principalName',
        ],
        [
            'name' => 'taskLongArnFormat',
            'value' => 'disabled',
            'principalArn' => 'arn:aws:iam:::user/principalName',
        ],
    ],
]

Example 2: To view the effective account settings for a specific IAM user or IAM role

This example displays the effective account settings for the specified user or role.

$result = $client->listAccountSettings([
    'effectiveSettings' => 1,
    'principalArn' => 'arn:aws:iam:::user/principalName',
]);

Result syntax:

[
    'settings' => [
        [
            'name' => 'containerInstanceLongArnFormat',
            'value' => 'disabled',
            'principalArn' => 'arn:aws:iam:::user/principalName',
        ],
        [
            'name' => 'serviceLongArnFormat',
            'value' => 'enabled',
            'principalArn' => 'arn:aws:iam:::user/principalName',
        ],
        [
            'name' => 'taskLongArnFormat',
            'value' => 'disabled',
            'principalArn' => 'arn:aws:iam:::user/principalName',
        ],
    ],
]

ListAttributes

$result = $client->listAttributes([/* ... */]);
$promise = $client->listAttributesAsync([/* ... */]);

Parameter Syntax

$result = $client->listAttributes([
    'attributeName' => '<string>',
    'attributeValue' => '<string>',
    'cluster' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'targetType' => 'container-instance', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'attributes' => [
        [
            'name' => '<string>',
            'targetId' => '<string>',
            'targetType' => 'container-instance',
            'value' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

ListClusters

$result = $client->listClusters([/* ... */]);
$promise = $client->listClustersAsync([/* ... */]);

Parameter Syntax

$result = $client->listClusters([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'clusterArns' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To list your available clusters

This example lists all of your available clusters in your default region.

$result = $client->listClusters([
]);

Result syntax:

[
    'clusterArns' => [
        'arn:aws:ecs:us-east-1::cluster/test',
        'arn:aws:ecs:us-east-1::cluster/default',
    ],
]

ListContainerInstances

$result = $client->listContainerInstances([/* ... */]);
$promise = $client->listContainerInstancesAsync([/* ... */]);

Parameter Syntax

$result = $client->listContainerInstances([
    'cluster' => '<string>',
    'filter' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'ACTIVE|DRAINING|REGISTERING|DEREGISTERING|REGISTRATION_FAILED',
]);

Parameter Details

Result Syntax

[
    'containerInstanceArns' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

Examples

Example 1: To list your available container instances in a cluster

This example lists all of your available container instances in the specified cluster in your default region.

$result = $client->listContainerInstances([
    'cluster' => 'default',
]);

Result syntax:

[
    'containerInstanceArns' => [
        'arn:aws:ecs:us-east-1::container-instance/f6bbb147-5370-4ace-8c73-c7181ded911f',
        'arn:aws:ecs:us-east-1::container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb',
    ],
]

ListServices

$result = $client->listServices([/* ... */]);
$promise = $client->listServicesAsync([/* ... */]);

Parameter Syntax

$result = $client->listServices([
    'cluster' => '<string>',
    'launchType' => 'EC2|FARGATE',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'schedulingStrategy' => 'REPLICA|DAEMON',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'serviceArns' => ['<string>', ...],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

Examples

Example 1: To list the services in a cluster

This example lists the services running in the default cluster for an account.

$result = $client->listServices([
]);

Result syntax:

[
    'serviceArns' => [
        'arn:aws:ecs:us-east-1:012345678910:service/my-http-service',
    ],
]

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To list the tags for a cluster.

This example lists the tags for the 'dev' cluster.

$result = $client->listTagsForResource([
    'resourceArn' => 'arn:aws:ecs:region:aws_account_id:cluster/dev',
]);

Result syntax:

[
    'tags' => [
        [
            'key' => 'team',
            'value' => 'dev',
        ],
    ],
]

ListTaskDefinitionFamilies

$result = $client->listTaskDefinitionFamilies([/* ... */]);
$promise = $client->listTaskDefinitionFamiliesAsync([/* ... */]);

Parameter Syntax

$result = $client->listTaskDefinitionFamilies([
    'familyPrefix' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'ACTIVE|INACTIVE|ALL',
]);

Parameter Details

Result Syntax

[
    'families' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To list your registered task definition families

This example lists all of your registered task definition families.

$result = $client->listTaskDefinitionFamilies([
]);

Result syntax:

[
    'families' => [
        'node-js-app',
        'web-timer',
        'hpcc',
        'hpcc-c4-8xlarge',
    ],
]

Example 2: To filter your registered task definition families

This example lists the task definition revisions that start with "hpcc".

$result = $client->listTaskDefinitionFamilies([
    'familyPrefix' => 'hpcc',
]);

Result syntax:

[
    'families' => [
        'hpcc',
        'hpcc-c4-8xlarge',
    ],
]

ListTaskDefinitions

$result = $client->listTaskDefinitions([/* ... */]);
$promise = $client->listTaskDefinitionsAsync([/* ... */]);

Parameter Syntax

$result = $client->listTaskDefinitions([
    'familyPrefix' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sort' => 'ASC|DESC',
    'status' => 'ACTIVE|INACTIVE',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'taskDefinitionArns' => ['<string>', ...],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To list your registered task definitions

This example lists all of your registered task definitions.

$result = $client->listTaskDefinitions([
]);

Result syntax:

[
    'taskDefinitionArns' => [
        'arn:aws:ecs:us-east-1::task-definition/sleep300:2',
        'arn:aws:ecs:us-east-1::task-definition/sleep360:1',
        'arn:aws:ecs:us-east-1::task-definition/wordpress:3',
        'arn:aws:ecs:us-east-1::task-definition/wordpress:4',
        'arn:aws:ecs:us-east-1::task-definition/wordpress:5',
        'arn:aws:ecs:us-east-1::task-definition/wordpress:6',
    ],
]

Example 2: To list the registered task definitions in a family

This example lists the task definition revisions of a specified family.

$result = $client->listTaskDefinitions([
    'familyPrefix' => 'wordpress',
]);

Result syntax:

[
    'taskDefinitionArns' => [
        'arn:aws:ecs:us-east-1::task-definition/wordpress:3',
        'arn:aws:ecs:us-east-1::task-definition/wordpress:4',
        'arn:aws:ecs:us-east-1::task-definition/wordpress:5',
        'arn:aws:ecs:us-east-1::task-definition/wordpress:6',
    ],
]

ListTasks

$result = $client->listTasks([/* ... */]);
$promise = $client->listTasksAsync([/* ... */]);

Parameter Syntax

$result = $client->listTasks([
    'cluster' => '<string>',
    'containerInstance' => '<string>',
    'desiredStatus' => 'RUNNING|PENDING|STOPPED',
    'family' => '<string>',
    'launchType' => 'EC2|FARGATE',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'serviceName' => '<string>',
    'startedBy' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'taskArns' => ['<string>', ...],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• ServiceNotFoundException:

  The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.

Examples

Example 1: To list the tasks in a cluster

This example lists all of the tasks in a cluster.

$result = $client->listTasks([
    'cluster' => 'default',
]);

Result syntax:

[
    'taskArns' => [
        'arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84',
        'arn:aws:ecs:us-east-1:012345678910:task/6b809ef6-c67e-4467-921f-ee261c15a0a1',
    ],
]

Example 2: To list the tasks on a particular container instance

This example lists the tasks of a specified container instance. Specifying a ``containerInstance`` value limits the results to tasks that belong to that container instance.

$result = $client->listTasks([
    'cluster' => 'default',
    'containerInstance' => 'f6bbb147-5370-4ace-8c73-c7181ded911f',
]);

Result syntax:

[
    'taskArns' => [
        'arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84',
    ],
]

PutAccountSetting

$result = $client->putAccountSetting([/* ... */]);
$promise = $client->putAccountSettingAsync([/* ... */]);

Parameter Syntax

$result = $client->putAccountSetting([
    'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking', // REQUIRED
    'principalArn' => '<string>',
    'value' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'setting' => [
        'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking',
        'principalArn' => '<string>',
        'value' => '<string>',
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To modify your account settings

This example modifies your account settings to opt in to the new ARN and resource ID format for Amazon ECS services. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.

$result = $client->putAccountSetting([
    'name' => 'serviceLongArnFormat',
    'value' => 'enabled',
]);

Result syntax:

[
    'setting' => [
        'name' => 'serviceLongArnFormat',
        'value' => 'enabled',
        'principalArn' => 'arn:aws:iam:::user/principalName',
    ],
]

Example 2: To modify the account settings for a specific IAM user or IAM role

This example modifies the account setting for a specific IAM user or IAM role to opt in to the new ARN and resource ID format for Amazon ECS container instances. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.

$result = $client->putAccountSetting([
    'name' => 'containerInstanceLongArnFormat',
    'value' => 'enabled',
    'principalArn' => 'arn:aws:iam:::user/principalName',
]);

Result syntax:

[
    'setting' => [
        'name' => 'containerInstanceLongArnFormat',
        'value' => 'enabled',
        'principalArn' => 'arn:aws:iam:::user/principalName',
    ],
]

PutAccountSettingDefault

$result = $client->putAccountSettingDefault([/* ... */]);
$promise = $client->putAccountSettingDefaultAsync([/* ... */]);

Parameter Syntax

$result = $client->putAccountSettingDefault([
    'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking', // REQUIRED
    'value' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'setting' => [
        'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking',
        'principalArn' => '<string>',
        'value' => '<string>',
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To modify the default account settings for all IAM users or roles on an account

This example modifies the default account setting for the specified resource for all IAM users or roles on an account. These changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.

$result = $client->putAccountSettingDefault([
    'name' => 'serviceLongArnFormat',
    'value' => 'enabled',
]);

Result syntax:

[
    'setting' => [
        'name' => 'serviceLongArnFormat',
        'value' => 'enabled',
        'principalArn' => 'arn:aws:iam:::root',
    ],
]

PutAttributes

$result = $client->putAttributes([/* ... */]);
$promise = $client->putAttributesAsync([/* ... */]);

Parameter Syntax

$result = $client->putAttributes([
    'attributes' => [ // REQUIRED
        [
            'name' => '<string>', // REQUIRED
            'targetId' => '<string>',
            'targetType' => 'container-instance',
            'value' => '<string>',
        ],
        // ...
    ],
    'cluster' => '<string>',
]);

Parameter Details

Result Syntax

[
    'attributes' => [
        [
            'name' => '<string>',
            'targetId' => '<string>',
            'targetType' => 'container-instance',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• TargetNotFoundException:

  The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

• AttributeLimitExceededException:

  You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

RegisterContainerInstance

$result = $client->registerContainerInstance([/* ... */]);
$promise = $client->registerContainerInstanceAsync([/* ... */]);

Parameter Syntax

$result = $client->registerContainerInstance([
    'attributes' => [
        [
            'name' => '<string>', // REQUIRED
            'targetId' => '<string>',
            'targetType' => 'container-instance',
            'value' => '<string>',
        ],
        // ...
    ],
    'cluster' => '<string>',
    'containerInstanceArn' => '<string>',
    'instanceIdentityDocument' => '<string>',
    'instanceIdentityDocumentSignature' => '<string>',
    'platformDevices' => [
        [
            'id' => '<string>', // REQUIRED
            'type' => 'GPU', // REQUIRED
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'totalResources' => [
        [
            'doubleValue' => <float>,
            'integerValue' => <integer>,
            'longValue' => <integer>,
            'name' => '<string>',
            'stringSetValue' => ['<string>', ...],
            'type' => '<string>',
        ],
        // ...
    ],
    'versionInfo' => [
        'agentHash' => '<string>',
        'agentVersion' => '<string>',
        'dockerVersion' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'containerInstance' => [
        'agentConnected' => true || false,
        'agentUpdateStatus' => 'PENDING|STAGING|STAGED|UPDATING|UPDATED|FAILED',
        'attachments' => [
            [
                'details' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'id' => '<string>',
                'status' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'attributes' => [
            [
                'name' => '<string>',
                'targetId' => '<string>',
                'targetType' => 'container-instance',
                'value' => '<string>',
            ],
            // ...
        ],
        'containerInstanceArn' => '<string>',
        'ec2InstanceId' => '<string>',
        'pendingTasksCount' => <integer>,
        'registeredAt' => <DateTime>,
        'registeredResources' => [
            [
                'doubleValue' => <float>,
                'integerValue' => <integer>,
                'longValue' => <integer>,
                'name' => '<string>',
                'stringSetValue' => ['<string>', ...],
                'type' => '<string>',
            ],
            // ...
        ],
        'remainingResources' => [
            [
                'doubleValue' => <float>,
                'integerValue' => <integer>,
                'longValue' => <integer>,
                'name' => '<string>',
                'stringSetValue' => ['<string>', ...],
                'type' => '<string>',
            ],
            // ...
        ],
        'runningTasksCount' => <integer>,
        'status' => '<string>',
        'statusReason' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'version' => <integer>,
        'versionInfo' => [
            'agentHash' => '<string>',
            'agentVersion' => '<string>',
            'dockerVersion' => '<string>',
        ],
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

RegisterTaskDefinition

$result = $client->registerTaskDefinition([/* ... */]);
$promise = $client->registerTaskDefinitionAsync([/* ... */]);

Parameter Syntax

$result = $client->registerTaskDefinition([
    'containerDefinitions' => [ // REQUIRED
        [
            'command' => ['<string>', ...],
            'cpu' => <integer>,
            'dependsOn' => [
                [
                    'condition' => 'START|COMPLETE|SUCCESS|HEALTHY', // REQUIRED
                    'containerName' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'disableNetworking' => true || false,
            'dnsSearchDomains' => ['<string>', ...],
            'dnsServers' => ['<string>', ...],
            'dockerLabels' => ['<string>', ...],
            'dockerSecurityOptions' => ['<string>', ...],
            'entryPoint' => ['<string>', ...],
            'environment' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'essential' => true || false,
            'extraHosts' => [
                [
                    'hostname' => '<string>', // REQUIRED
                    'ipAddress' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'healthCheck' => [
                'command' => ['<string>', ...], // REQUIRED
                'interval' => <integer>,
                'retries' => <integer>,
                'startPeriod' => <integer>,
                'timeout' => <integer>,
            ],
            'hostname' => '<string>',
            'image' => '<string>',
            'interactive' => true || false,
            'links' => ['<string>', ...],
            'linuxParameters' => [
                'capabilities' => [
                    'add' => ['<string>', ...],
                    'drop' => ['<string>', ...],
                ],
                'devices' => [
                    [
                        'containerPath' => '<string>',
                        'hostPath' => '<string>', // REQUIRED
                        'permissions' => ['<string>', ...],
                    ],
                    // ...
                ],
                'initProcessEnabled' => true || false,
                'sharedMemorySize' => <integer>,
                'tmpfs' => [
                    [
                        'containerPath' => '<string>', // REQUIRED
                        'mountOptions' => ['<string>', ...],
                        'size' => <integer>, // REQUIRED
                    ],
                    // ...
                ],
            ],
            'logConfiguration' => [
                'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk', // REQUIRED
                'options' => ['<string>', ...],
                'secretOptions' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'valueFrom' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'memory' => <integer>,
            'memoryReservation' => <integer>,
            'mountPoints' => [
                [
                    'containerPath' => '<string>',
                    'readOnly' => true || false,
                    'sourceVolume' => '<string>',
                ],
                // ...
            ],
            'name' => '<string>',
            'portMappings' => [
                [
                    'containerPort' => <integer>,
                    'hostPort' => <integer>,
                    'protocol' => 'tcp|udp',
                ],
                // ...
            ],
            'privileged' => true || false,
            'pseudoTerminal' => true || false,
            'readonlyRootFilesystem' => true || false,
            'repositoryCredentials' => [
                'credentialsParameter' => '<string>', // REQUIRED
            ],
            'resourceRequirements' => [
                [
                    'type' => 'GPU', // REQUIRED
                    'value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'secrets' => [
                [
                    'name' => '<string>', // REQUIRED
                    'valueFrom' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'startTimeout' => <integer>,
            'stopTimeout' => <integer>,
            'systemControls' => [
                [
                    'namespace' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'ulimits' => [
                [
                    'hardLimit' => <integer>, // REQUIRED
                    'name' => 'core|cpu|data|fsize|locks|memlock|msgqueue|nice|nofile|nproc|rss|rtprio|rttime|sigpending|stack', // REQUIRED
                    'softLimit' => <integer>, // REQUIRED
                ],
                // ...
            ],
            'user' => '<string>',
            'volumesFrom' => [
                [
                    'readOnly' => true || false,
                    'sourceContainer' => '<string>',
                ],
                // ...
            ],
            'workingDirectory' => '<string>',
        ],
        // ...
    ],
    'cpu' => '<string>',
    'executionRoleArn' => '<string>',
    'family' => '<string>', // REQUIRED
    'ipcMode' => 'host|task|none',
    'memory' => '<string>',
    'networkMode' => 'bridge|host|awsvpc|none',
    'pidMode' => 'host|task',
    'placementConstraints' => [
        [
            'expression' => '<string>',
            'type' => 'memberOf',
        ],
        // ...
    ],
    'proxyConfiguration' => [
        'containerName' => '<string>', // REQUIRED
        'properties' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'type' => 'APPMESH',
    ],
    'requiresCompatibilities' => ['<string>', ...],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'taskRoleArn' => '<string>',
    'volumes' => [
        [
            'dockerVolumeConfiguration' => [
                'autoprovision' => true || false,
                'driver' => '<string>',
                'driverOpts' => ['<string>', ...],
                'labels' => ['<string>', ...],
                'scope' => 'task|shared',
            ],
            'host' => [
                'sourcePath' => '<string>',
            ],
            'name' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'taskDefinition' => [
        'compatibilities' => ['<string>', ...],
        'containerDefinitions' => [
            [
                'command' => ['<string>', ...],
                'cpu' => <integer>,
                'dependsOn' => [
                    [
                        'condition' => 'START|COMPLETE|SUCCESS|HEALTHY',
                        'containerName' => '<string>',
                    ],
                    // ...
                ],
                'disableNetworking' => true || false,
                'dnsSearchDomains' => ['<string>', ...],
                'dnsServers' => ['<string>', ...],
                'dockerLabels' => ['<string>', ...],
                'dockerSecurityOptions' => ['<string>', ...],
                'entryPoint' => ['<string>', ...],
                'environment' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'essential' => true || false,
                'extraHosts' => [
                    [
                        'hostname' => '<string>',
                        'ipAddress' => '<string>',
                    ],
                    // ...
                ],
                'healthCheck' => [
                    'command' => ['<string>', ...],
                    'interval' => <integer>,
                    'retries' => <integer>,
                    'startPeriod' => <integer>,
                    'timeout' => <integer>,
                ],
                'hostname' => '<string>',
                'image' => '<string>',
                'interactive' => true || false,
                'links' => ['<string>', ...],
                'linuxParameters' => [
                    'capabilities' => [
                        'add' => ['<string>', ...],
                        'drop' => ['<string>', ...],
                    ],
                    'devices' => [
                        [
                            'containerPath' => '<string>',
                            'hostPath' => '<string>',
                            'permissions' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'initProcessEnabled' => true || false,
                    'sharedMemorySize' => <integer>,
                    'tmpfs' => [
                        [
                            'containerPath' => '<string>',
                            'mountOptions' => ['<string>', ...],
                            'size' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'logConfiguration' => [
                    'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk',
                    'options' => ['<string>', ...],
                    'secretOptions' => [
                        [
                            'name' => '<string>',
                            'valueFrom' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'memory' => <integer>,
                'memoryReservation' => <integer>,
                'mountPoints' => [
                    [
                        'containerPath' => '<string>',
                        'readOnly' => true || false,
                        'sourceVolume' => '<string>',
                    ],
                    // ...
                ],
                'name' => '<string>',
                'portMappings' => [
                    [
                        'containerPort' => <integer>,
                        'hostPort' => <integer>,
                        'protocol' => 'tcp|udp',
                    ],
                    // ...
                ],
                'privileged' => true || false,
                'pseudoTerminal' => true || false,
                'readonlyRootFilesystem' => true || false,
                'repositoryCredentials' => [
                    'credentialsParameter' => '<string>',
                ],
                'resourceRequirements' => [
                    [
                        'type' => 'GPU',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'secrets' => [
                    [
                        'name' => '<string>',
                        'valueFrom' => '<string>',
                    ],
                    // ...
                ],
                'startTimeout' => <integer>,
                'stopTimeout' => <integer>,
                'systemControls' => [
                    [
                        'namespace' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'ulimits' => [
                    [
                        'hardLimit' => <integer>,
                        'name' => 'core|cpu|data|fsize|locks|memlock|msgqueue|nice|nofile|nproc|rss|rtprio|rttime|sigpending|stack',
                        'softLimit' => <integer>,
                    ],
                    // ...
                ],
                'user' => '<string>',
                'volumesFrom' => [
                    [
                        'readOnly' => true || false,
                        'sourceContainer' => '<string>',
                    ],
                    // ...
                ],
                'workingDirectory' => '<string>',
            ],
            // ...
        ],
        'cpu' => '<string>',
        'executionRoleArn' => '<string>',
        'family' => '<string>',
        'ipcMode' => 'host|task|none',
        'memory' => '<string>',
        'networkMode' => 'bridge|host|awsvpc|none',
        'pidMode' => 'host|task',
        'placementConstraints' => [
            [
                'expression' => '<string>',
                'type' => 'memberOf',
            ],
            // ...
        ],
        'proxyConfiguration' => [
            'containerName' => '<string>',
            'properties' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'type' => 'APPMESH',
        ],
        'requiresAttributes' => [
            [
                'name' => '<string>',
                'targetId' => '<string>',
                'targetType' => 'container-instance',
                'value' => '<string>',
            ],
            // ...
        ],
        'requiresCompatibilities' => ['<string>', ...],
        'revision' => <integer>,
        'status' => 'ACTIVE|INACTIVE',
        'taskDefinitionArn' => '<string>',
        'taskRoleArn' => '<string>',
        'volumes' => [
            [
                'dockerVolumeConfiguration' => [
                    'autoprovision' => true || false,
                    'driver' => '<string>',
                    'driverOpts' => ['<string>', ...],
                    'labels' => ['<string>', ...],
                    'scope' => 'task|shared',
                ],
                'host' => [
                    'sourcePath' => '<string>',
                ],
                'name' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To register a task definition

This example registers a task definition to the specified family.

$result = $client->registerTaskDefinition([
    'containerDefinitions' => [
        [
            'name' => 'sleep',
            'command' => [
                'sleep',
                '360',
            ],
            'cpu' => 10,
            'essential' => 1,
            'image' => 'busybox',
            'memory' => 10,
        ],
    ],
    'family' => 'sleep360',
    'taskRoleArn' => '',
    'volumes' => [
    ],
]);

Result syntax:

[
    'taskDefinition' => [
        'containerDefinitions' => [
            [
                'name' => 'sleep',
                'command' => [
                    'sleep',
                    '360',
                ],
                'cpu' => 10,
                'environment' => [
                ],
                'essential' => 1,
                'image' => 'busybox',
                'memory' => 10,
                'mountPoints' => [
                ],
                'portMappings' => [
                ],
                'volumesFrom' => [
                ],
            ],
        ],
        'family' => 'sleep360',
        'revision' => 1,
        'taskDefinitionArn' => 'arn:aws:ecs:us-east-1::task-definition/sleep360:19',
        'volumes' => [
        ],
    ],
]

RunTask

$result = $client->runTask([/* ... */]);
$promise = $client->runTaskAsync([/* ... */]);

Parameter Syntax

$result = $client->runTask([
    'cluster' => '<string>',
    'count' => <integer>,
    'enableECSManagedTags' => true || false,
    'group' => '<string>',
    'launchType' => 'EC2|FARGATE',
    'networkConfiguration' => [
        'awsvpcConfiguration' => [
            'assignPublicIp' => 'ENABLED|DISABLED',
            'securityGroups' => ['<string>', ...],
            'subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'overrides' => [
        'containerOverrides' => [
            [
                'command' => ['<string>', ...],
                'cpu' => <integer>,
                'environment' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'memory' => <integer>,
                'memoryReservation' => <integer>,
                'name' => '<string>',
                'resourceRequirements' => [
                    [
                        'type' => 'GPU', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'executionRoleArn' => '<string>',
        'taskRoleArn' => '<string>',
    ],
    'placementConstraints' => [
        [
            'expression' => '<string>',
            'type' => 'distinctInstance|memberOf',
        ],
        // ...
    ],
    'placementStrategy' => [
        [
            'field' => '<string>',
            'type' => 'random|spread|binpack',
        ],
        // ...
    ],
    'platformVersion' => '<string>',
    'propagateTags' => 'TASK_DEFINITION|SERVICE',
    'startedBy' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'taskDefinition' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failures' => [
        [
            'arn' => '<string>',
            'reason' => '<string>',
        ],
        // ...
    ],
    'tasks' => [
        [
            'attachments' => [
                [
                    'details' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'id' => '<string>',
                    'status' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
            'clusterArn' => '<string>',
            'connectivity' => 'CONNECTED|DISCONNECTED',
            'connectivityAt' => <DateTime>,
            'containerInstanceArn' => '<string>',
            'containers' => [
                [
                    'containerArn' => '<string>',
                    'cpu' => '<string>',
                    'exitCode' => <integer>,
                    'gpuIds' => ['<string>', ...],
                    'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN',
                    'lastStatus' => '<string>',
                    'memory' => '<string>',
                    'memoryReservation' => '<string>',
                    'name' => '<string>',
                    'networkBindings' => [
                        [
                            'bindIP' => '<string>',
                            'containerPort' => <integer>,
                            'hostPort' => <integer>,
                            'protocol' => 'tcp|udp',
                        ],
                        // ...
                    ],
                    'networkInterfaces' => [
                        [
                            'attachmentId' => '<string>',
                            'ipv6Address' => '<string>',
                            'privateIpv4Address' => '<string>',
                        ],
                        // ...
                    ],
                    'reason' => '<string>',
                    'taskArn' => '<string>',
                ],
                // ...
            ],
            'cpu' => '<string>',
            'createdAt' => <DateTime>,
            'desiredStatus' => '<string>',
            'executionStoppedAt' => <DateTime>,
            'group' => '<string>',
            'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN',
            'lastStatus' => '<string>',
            'launchType' => 'EC2|FARGATE',
            'memory' => '<string>',
            'overrides' => [
                'containerOverrides' => [
                    [
                        'command' => ['<string>', ...],
                        'cpu' => <integer>,
                        'environment' => [
                            [
                                'name' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'memory' => <integer>,
                        'memoryReservation' => <integer>,
                        'name' => '<string>',
                        'resourceRequirements' => [
                            [
                                'type' => 'GPU',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'executionRoleArn' => '<string>',
                'taskRoleArn' => '<string>',
            ],
            'platformVersion' => '<string>',
            'pullStartedAt' => <DateTime>,
            'pullStoppedAt' => <DateTime>,
            'startedAt' => <DateTime>,
            'startedBy' => '<string>',
            'stopCode' => 'TaskFailedToStart|EssentialContainerExited|UserInitiated',
            'stoppedAt' => <DateTime>,
            'stoppedReason' => '<string>',
            'stoppingAt' => <DateTime>,
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'taskArn' => '<string>',
            'taskDefinitionArn' => '<string>',
            'version' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• UnsupportedFeatureException:

  The specified task is not supported in this Region.

• PlatformUnknownException:

  The specified platform version does not exist.

• PlatformTaskDefinitionIncompatibilityException:

  The specified platform version does not satisfy the task definition's required capabilities.

• AccessDeniedException:

  You do not have authorization to perform the requested action.

• BlockedException:

  Your AWS account has been blocked. For more information, contact AWS Support.

Examples

Example 1: To run a task on your default cluster

This example runs the specified task definition on your default cluster.

$result = $client->runTask([
    'cluster' => 'default',
    'taskDefinition' => 'sleep360:1',
]);

Result syntax:

[
    'tasks' => [
        [
            'containerInstanceArn' => 'arn:aws:ecs:us-east-1::container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb',
            'containers' => [
                [
                    'name' => 'sleep',
                    'containerArn' => 'arn:aws:ecs:us-east-1::container/58591c8e-be29-4ddf-95aa-ee459d4c59fd',
                    'lastStatus' => 'PENDING',
                    'taskArn' => 'arn:aws:ecs:us-east-1::task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0',
                ],
            ],
            'desiredStatus' => 'RUNNING',
            'lastStatus' => 'PENDING',
            'overrides' => [
                'containerOverrides' => [
                    [
                        'name' => 'sleep',
                    ],
                ],
            ],
            'taskArn' => 'arn:aws:ecs:us-east-1::task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0',
            'taskDefinitionArn' => 'arn:aws:ecs:us-east-1::task-definition/sleep360:1',
        ],
    ],
]

StartTask

$result = $client->startTask([/* ... */]);
$promise = $client->startTaskAsync([/* ... */]);

Parameter Syntax

$result = $client->startTask([
    'cluster' => '<string>',
    'containerInstances' => ['<string>', ...], // REQUIRED
    'enableECSManagedTags' => true || false,
    'group' => '<string>',
    'networkConfiguration' => [
        'awsvpcConfiguration' => [
            'assignPublicIp' => 'ENABLED|DISABLED',
            'securityGroups' => ['<string>', ...],
            'subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'overrides' => [
        'containerOverrides' => [
            [
                'command' => ['<string>', ...],
                'cpu' => <integer>,
                'environment' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'memory' => <integer>,
                'memoryReservation' => <integer>,
                'name' => '<string>',
                'resourceRequirements' => [
                    [
                        'type' => 'GPU', // REQUIRED
                        'value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'executionRoleArn' => '<string>',
        'taskRoleArn' => '<string>',
    ],
    'propagateTags' => 'TASK_DEFINITION|SERVICE',
    'startedBy' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'taskDefinition' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failures' => [
        [
            'arn' => '<string>',
            'reason' => '<string>',
        ],
        // ...
    ],
    'tasks' => [
        [
            'attachments' => [
                [
                    'details' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'id' => '<string>',
                    'status' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
            'clusterArn' => '<string>',
            'connectivity' => 'CONNECTED|DISCONNECTED',
            'connectivityAt' => <DateTime>,
            'containerInstanceArn' => '<string>',
            'containers' => [
                [
                    'containerArn' => '<string>',
                    'cpu' => '<string>',
                    'exitCode' => <integer>,
                    'gpuIds' => ['<string>', ...],
                    'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN',
                    'lastStatus' => '<string>',
                    'memory' => '<string>',
                    'memoryReservation' => '<string>',
                    'name' => '<string>',
                    'networkBindings' => [
                        [
                            'bindIP' => '<string>',
                            'containerPort' => <integer>,
                            'hostPort' => <integer>,
                            'protocol' => 'tcp|udp',
                        ],
                        // ...
                    ],
                    'networkInterfaces' => [
                        [
                            'attachmentId' => '<string>',
                            'ipv6Address' => '<string>',
                            'privateIpv4Address' => '<string>',
                        ],
                        // ...
                    ],
                    'reason' => '<string>',
                    'taskArn' => '<string>',
                ],
                // ...
            ],
            'cpu' => '<string>',
            'createdAt' => <DateTime>,
            'desiredStatus' => '<string>',
            'executionStoppedAt' => <DateTime>,
            'group' => '<string>',
            'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN',
            'lastStatus' => '<string>',
            'launchType' => 'EC2|FARGATE',
            'memory' => '<string>',
            'overrides' => [
                'containerOverrides' => [
                    [
                        'command' => ['<string>', ...],
                        'cpu' => <integer>,
                        'environment' => [
                            [
                                'name' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'memory' => <integer>,
                        'memoryReservation' => <integer>,
                        'name' => '<string>',
                        'resourceRequirements' => [
                            [
                                'type' => 'GPU',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'executionRoleArn' => '<string>',
                'taskRoleArn' => '<string>',
            ],
            'platformVersion' => '<string>',
            'pullStartedAt' => <DateTime>,
            'pullStoppedAt' => <DateTime>,
            'startedAt' => <DateTime>,
            'startedBy' => '<string>',
            'stopCode' => 'TaskFailedToStart|EssentialContainerExited|UserInitiated',
            'stoppedAt' => <DateTime>,
            'stoppedReason' => '<string>',
            'stoppingAt' => <DateTime>,
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'taskArn' => '<string>',
            'taskDefinitionArn' => '<string>',
            'version' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

StopTask

$result = $client->stopTask([/* ... */]);
$promise = $client->stopTaskAsync([/* ... */]);

Parameter Syntax

$result = $client->stopTask([
    'cluster' => '<string>',
    'reason' => '<string>',
    'task' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'task' => [
        'attachments' => [
            [
                'details' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'id' => '<string>',
                'status' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'clusterArn' => '<string>',
        'connectivity' => 'CONNECTED|DISCONNECTED',
        'connectivityAt' => <DateTime>,
        'containerInstanceArn' => '<string>',
        'containers' => [
            [
                'containerArn' => '<string>',
                'cpu' => '<string>',
                'exitCode' => <integer>,
                'gpuIds' => ['<string>', ...],
                'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN',
                'lastStatus' => '<string>',
                'memory' => '<string>',
                'memoryReservation' => '<string>',
                'name' => '<string>',
                'networkBindings' => [
                    [
                        'bindIP' => '<string>',
                        'containerPort' => <integer>,
                        'hostPort' => <integer>,
                        'protocol' => 'tcp|udp',
                    ],
                    // ...
                ],
                'networkInterfaces' => [
                    [
                        'attachmentId' => '<string>',
                        'ipv6Address' => '<string>',
                        'privateIpv4Address' => '<string>',
                    ],
                    // ...
                ],
                'reason' => '<string>',
                'taskArn' => '<string>',
            ],
            // ...
        ],
        'cpu' => '<string>',
        'createdAt' => <DateTime>,
        'desiredStatus' => '<string>',
        'executionStoppedAt' => <DateTime>,
        'group' => '<string>',
        'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN',
        'lastStatus' => '<string>',
        'launchType' => 'EC2|FARGATE',
        'memory' => '<string>',
        'overrides' => [
            'containerOverrides' => [
                [
                    'command' => ['<string>', ...],
                    'cpu' => <integer>,
                    'environment' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'memory' => <integer>,
                    'memoryReservation' => <integer>,
                    'name' => '<string>',
                    'resourceRequirements' => [
                        [
                            'type' => 'GPU',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'executionRoleArn' => '<string>',
            'taskRoleArn' => '<string>',
        ],
        'platformVersion' => '<string>',
        'pullStartedAt' => <DateTime>,
        'pullStoppedAt' => <DateTime>,
        'startedAt' => <DateTime>,
        'startedBy' => '<string>',
        'stopCode' => 'TaskFailedToStart|EssentialContainerExited|UserInitiated',
        'stoppedAt' => <DateTime>,
        'stoppedReason' => '<string>',
        'stoppingAt' => <DateTime>,
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'taskArn' => '<string>',
        'taskDefinitionArn' => '<string>',
        'version' => <integer>,
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

SubmitAttachmentStateChanges

$result = $client->submitAttachmentStateChanges([/* ... */]);
$promise = $client->submitAttachmentStateChangesAsync([/* ... */]);

Parameter Syntax

$result = $client->submitAttachmentStateChanges([
    'attachments' => [ // REQUIRED
        [
            'attachmentArn' => '<string>', // REQUIRED
            'status' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'cluster' => '<string>',
]);

Parameter Details

Result Syntax

[
    'acknowledgment' => '<string>',
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• AccessDeniedException:

  You do not have authorization to perform the requested action.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

SubmitContainerStateChange

$result = $client->submitContainerStateChange([/* ... */]);
$promise = $client->submitContainerStateChangeAsync([/* ... */]);

Parameter Syntax

$result = $client->submitContainerStateChange([
    'cluster' => '<string>',
    'containerName' => '<string>',
    'exitCode' => <integer>,
    'networkBindings' => [
        [
            'bindIP' => '<string>',
            'containerPort' => <integer>,
            'hostPort' => <integer>,
            'protocol' => 'tcp|udp',
        ],
        // ...
    ],
    'reason' => '<string>',
    'status' => '<string>',
    'task' => '<string>',
]);

Parameter Details

Result Syntax

[
    'acknowledgment' => '<string>',
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• AccessDeniedException:

  You do not have authorization to perform the requested action.

SubmitTaskStateChange

$result = $client->submitTaskStateChange([/* ... */]);
$promise = $client->submitTaskStateChangeAsync([/* ... */]);

Parameter Syntax

$result = $client->submitTaskStateChange([
    'attachments' => [
        [
            'attachmentArn' => '<string>', // REQUIRED
            'status' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'cluster' => '<string>',
    'containers' => [
        [
            'containerName' => '<string>',
            'exitCode' => <integer>,
            'networkBindings' => [
                [
                    'bindIP' => '<string>',
                    'containerPort' => <integer>,
                    'hostPort' => <integer>,
                    'protocol' => 'tcp|udp',
                ],
                // ...
            ],
            'reason' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'executionStoppedAt' => <integer || string || DateTime>,
    'pullStartedAt' => <integer || string || DateTime>,
    'pullStoppedAt' => <integer || string || DateTime>,
    'reason' => '<string>',
    'status' => '<string>',
    'task' => '<string>',
]);

Parameter Details

Result Syntax

[
    'acknowledgment' => '<string>',
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• AccessDeniedException:

  You do not have authorization to perform the requested action.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• ResourceNotFoundException:

  The specified resource could not be found.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To tag a cluster.

This example tags the 'dev' cluster with key 'team' and value 'dev'.

$result = $client->tagResource([
    'resourceArn' => 'arn:aws:ecs:region:aws_account_id:cluster/dev',
    'tags' => [
        [
            'key' => 'team',
            'value' => 'dev',
        ],
    ],
]);

Result syntax:

[
]

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• ResourceNotFoundException:

  The specified resource could not be found.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

Examples

Example 1: To untag a cluster.

This example deletes the 'team' tag from the 'dev' cluster.

$result = $client->untagResource([
    'resourceArn' => 'arn:aws:ecs:region:aws_account_id:cluster/dev',
    'tagKeys' => [
        'team',
    ],
]);

Result syntax:

[
]

UpdateContainerAgent

$result = $client->updateContainerAgent([/* ... */]);
$promise = $client->updateContainerAgentAsync([/* ... */]);

Parameter Syntax

$result = $client->updateContainerAgent([
    'cluster' => '<string>',
    'containerInstance' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'containerInstance' => [
        'agentConnected' => true || false,
        'agentUpdateStatus' => 'PENDING|STAGING|STAGED|UPDATING|UPDATED|FAILED',
        'attachments' => [
            [
                'details' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'id' => '<string>',
                'status' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'attributes' => [
            [
                'name' => '<string>',
                'targetId' => '<string>',
                'targetType' => 'container-instance',
                'value' => '<string>',
            ],
            // ...
        ],
        'containerInstanceArn' => '<string>',
        'ec2InstanceId' => '<string>',
        'pendingTasksCount' => <integer>,
        'registeredAt' => <DateTime>,
        'registeredResources' => [
            [
                'doubleValue' => <float>,
                'integerValue' => <integer>,
                'longValue' => <integer>,
                'name' => '<string>',
                'stringSetValue' => ['<string>', ...],
                'type' => '<string>',
            ],
            // ...
        ],
        'remainingResources' => [
            [
                'doubleValue' => <float>,
                'integerValue' => <integer>,
                'longValue' => <integer>,
                'name' => '<string>',
                'stringSetValue' => ['<string>', ...],
                'type' => '<string>',
            ],
            // ...
        ],
        'runningTasksCount' => <integer>,
        'status' => '<string>',
        'statusReason' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'version' => <integer>,
        'versionInfo' => [
            'agentHash' => '<string>',
            'agentVersion' => '<string>',
            'dockerVersion' => '<string>',
        ],
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• UpdateInProgressException:

  There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

• NoUpdateAvailableException:

  There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.

• MissingVersionException:

  Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.

UpdateContainerInstancesState

$result = $client->updateContainerInstancesState([/* ... */]);
$promise = $client->updateContainerInstancesStateAsync([/* ... */]);

Parameter Syntax

$result = $client->updateContainerInstancesState([
    'cluster' => '<string>',
    'containerInstances' => ['<string>', ...], // REQUIRED
    'status' => 'ACTIVE|DRAINING|REGISTERING|DEREGISTERING|REGISTRATION_FAILED', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'containerInstances' => [
        [
            'agentConnected' => true || false,
            'agentUpdateStatus' => 'PENDING|STAGING|STAGED|UPDATING|UPDATED|FAILED',
            'attachments' => [
                [
                    'details' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'id' => '<string>',
                    'status' => '<string>',
                    'type' => '<string>',
                ],
                // ...
            ],
            'attributes' => [
                [
                    'name' => '<string>',
                    'targetId' => '<string>',
                    'targetType' => 'container-instance',
                    'value' => '<string>',
                ],
                // ...
            ],
            'containerInstanceArn' => '<string>',
            'ec2InstanceId' => '<string>',
            'pendingTasksCount' => <integer>,
            'registeredAt' => <DateTime>,
            'registeredResources' => [
                [
                    'doubleValue' => <float>,
                    'integerValue' => <integer>,
                    'longValue' => <integer>,
                    'name' => '<string>',
                    'stringSetValue' => ['<string>', ...],
                    'type' => '<string>',
                ],
                // ...
            ],
            'remainingResources' => [
                [
                    'doubleValue' => <float>,
                    'integerValue' => <integer>,
                    'longValue' => <integer>,
                    'name' => '<string>',
                    'stringSetValue' => ['<string>', ...],
                    'type' => '<string>',
                ],
                // ...
            ],
            'runningTasksCount' => <integer>,
            'status' => '<string>',
            'statusReason' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'version' => <integer>,
            'versionInfo' => [
                'agentHash' => '<string>',
                'agentVersion' => '<string>',
                'dockerVersion' => '<string>',
            ],
        ],
        // ...
    ],
    'failures' => [
        [
            'arn' => '<string>',
            'reason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

UpdateService

$result = $client->updateService([/* ... */]);
$promise = $client->updateServiceAsync([/* ... */]);

Parameter Syntax

$result = $client->updateService([
    'cluster' => '<string>',
    'deploymentConfiguration' => [
        'maximumPercent' => <integer>,
        'minimumHealthyPercent' => <integer>,
    ],
    'desiredCount' => <integer>,
    'forceNewDeployment' => true || false,
    'healthCheckGracePeriodSeconds' => <integer>,
    'networkConfiguration' => [
        'awsvpcConfiguration' => [
            'assignPublicIp' => 'ENABLED|DISABLED',
            'securityGroups' => ['<string>', ...],
            'subnets' => ['<string>', ...], // REQUIRED
        ],
    ],
    'platformVersion' => '<string>',
    'service' => '<string>', // REQUIRED
    'taskDefinition' => '<string>',
]);

Parameter Details

Result Syntax

[
    'service' => [
        'clusterArn' => '<string>',
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'deploymentConfiguration' => [
            'maximumPercent' => <integer>,
            'minimumHealthyPercent' => <integer>,
        ],
        'deploymentController' => [
            'type' => 'ECS|CODE_DEPLOY|EXTERNAL',
        ],
        'deployments' => [
            [
                'createdAt' => <DateTime>,
                'desiredCount' => <integer>,
                'id' => '<string>',
                'launchType' => 'EC2|FARGATE',
                'networkConfiguration' => [
                    'awsvpcConfiguration' => [
                        'assignPublicIp' => 'ENABLED|DISABLED',
                        'securityGroups' => ['<string>', ...],
                        'subnets' => ['<string>', ...],
                    ],
                ],
                'pendingCount' => <integer>,
                'platformVersion' => '<string>',
                'runningCount' => <integer>,
                'status' => '<string>',
                'taskDefinition' => '<string>',
                'updatedAt' => <DateTime>,
            ],
            // ...
        ],
        'desiredCount' => <integer>,
        'enableECSManagedTags' => true || false,
        'events' => [
            [
                'createdAt' => <DateTime>,
                'id' => '<string>',
                'message' => '<string>',
            ],
            // ...
        ],
        'healthCheckGracePeriodSeconds' => <integer>,
        'launchType' => 'EC2|FARGATE',
        'loadBalancers' => [
            [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'loadBalancerName' => '<string>',
                'targetGroupArn' => '<string>',
            ],
            // ...
        ],
        'networkConfiguration' => [
            'awsvpcConfiguration' => [
                'assignPublicIp' => 'ENABLED|DISABLED',
                'securityGroups' => ['<string>', ...],
                'subnets' => ['<string>', ...],
            ],
        ],
        'pendingCount' => <integer>,
        'placementConstraints' => [
            [
                'expression' => '<string>',
                'type' => 'distinctInstance|memberOf',
            ],
            // ...
        ],
        'placementStrategy' => [
            [
                'field' => '<string>',
                'type' => 'random|spread|binpack',
            ],
            // ...
        ],
        'platformVersion' => '<string>',
        'propagateTags' => 'TASK_DEFINITION|SERVICE',
        'roleArn' => '<string>',
        'runningCount' => <integer>,
        'schedulingStrategy' => 'REPLICA|DAEMON',
        'serviceArn' => '<string>',
        'serviceName' => '<string>',
        'serviceRegistries' => [
            [
                'containerName' => '<string>',
                'containerPort' => <integer>,
                'port' => <integer>,
                'registryArn' => '<string>',
            ],
            // ...
        ],
        'status' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'taskDefinition' => '<string>',
        'taskSets' => [
            [
                'clusterArn' => '<string>',
                'computedDesiredCount' => <integer>,
                'createdAt' => <DateTime>,
                'externalId' => '<string>',
                'id' => '<string>',
                'launchType' => 'EC2|FARGATE',
                'loadBalancers' => [
                    [
                        'containerName' => '<string>',
                        'containerPort' => <integer>,
                        'loadBalancerName' => '<string>',
                        'targetGroupArn' => '<string>',
                    ],
                    // ...
                ],
                'networkConfiguration' => [
                    'awsvpcConfiguration' => [
                        'assignPublicIp' => 'ENABLED|DISABLED',
                        'securityGroups' => ['<string>', ...],
                        'subnets' => ['<string>', ...],
                    ],
                ],
                'pendingCount' => <integer>,
                'platformVersion' => '<string>',
                'runningCount' => <integer>,
                'scale' => [
                    'unit' => 'PERCENT',
                    'value' => <float>,
                ],
                'serviceArn' => '<string>',
                'serviceRegistries' => [
                    [
                        'containerName' => '<string>',
                        'containerPort' => <integer>,
                        'port' => <integer>,
                        'registryArn' => '<string>',
                    ],
                    // ...
                ],
                'stabilityStatus' => 'STEADY_STATE|STABILIZING',
                'stabilityStatusAt' => <DateTime>,
                'startedBy' => '<string>',
                'status' => '<string>',
                'taskDefinition' => '<string>',
                'taskSetArn' => '<string>',
                'updatedAt' => <DateTime>,
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• ServerException:

  These errors are usually caused by a server issue.

• ClientException:

  These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

• InvalidParameterException:

  The specified parameter is invalid. Review the available parameters for the API request.

• ClusterNotFoundException:

  The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

• ServiceNotFoundException:

  The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.

• ServiceNotActiveException:

  The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.

• PlatformUnknownException:

  The specified platform version does not exist.

• PlatformTaskDefinitionIncompatibilityException:

  The specified platform version does not satisfy the task definition's required capabilities.

• AccessDeniedException:

  You do not have authorization to perform the requested action.