@aws-sdk/client-ecs 3.288.0 → 3.290.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +23 -0
- package/dist-types/commands/CreateClusterCommand.d.ts +37 -0
- package/dist-types/commands/CreateServiceCommand.d.ts +149 -0
- package/dist-types/commands/CreateTaskSetCommand.d.ts +40 -0
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +54 -0
- package/dist-types/commands/DeleteAttributesCommand.d.ts +13 -0
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +13 -0
- package/dist-types/commands/DeleteClusterCommand.d.ts +60 -0
- package/dist-types/commands/DeleteServiceCommand.d.ts +31 -0
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +16 -0
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +34 -0
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +29 -0
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +13 -0
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +13 -0
- package/dist-types/commands/DescribeClustersCommand.d.ts +38 -0
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +104 -0
- package/dist-types/commands/DescribeServicesCommand.d.ts +71 -0
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +71 -0
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +30 -0
- package/dist-types/commands/DescribeTasksCommand.d.ts +67 -0
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +9 -0
- package/dist-types/commands/ExecuteCommandCommand.d.ts +37 -0
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +51 -0
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +78 -0
- package/dist-types/commands/ListAttributesCommand.d.ts +8 -0
- package/dist-types/commands/ListClustersCommand.d.ts +30 -0
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +35 -0
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +16 -0
- package/dist-types/commands/ListServicesCommand.d.ts +32 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +37 -0
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +51 -0
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +55 -0
- package/dist-types/commands/ListTasksCommand.d.ts +58 -0
- package/dist-types/commands/PutAccountSettingCommand.d.ts +56 -0
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +34 -0
- package/dist-types/commands/PutAttributesCommand.d.ts +18 -0
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +26 -0
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +13 -0
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +66 -0
- package/dist-types/commands/RunTaskCommand.d.ts +73 -0
- package/dist-types/commands/StartTaskCommand.d.ts +16 -0
- package/dist-types/commands/StopTaskCommand.d.ts +16 -0
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +16 -0
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +12 -0
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +36 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +33 -0
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +13 -0
- package/dist-types/commands/UpdateClusterCommand.d.ts +16 -0
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +16 -0
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +34 -0
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +16 -0
- package/dist-types/commands/UpdateServiceCommand.d.ts +61 -0
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +34 -0
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +106 -0
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +34 -0
- package/package.json +30 -30
|
@@ -29,6 +29,44 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
|
|
|
29
29
|
* @see {@link DescribeClustersCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link ClientException} (client fault)
|
|
33
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
34
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
35
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
38
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
39
|
+
* request.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link ServerException} (server fault)
|
|
42
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
43
|
+
*
|
|
44
|
+
*
|
|
45
|
+
* @example To describe a cluster
|
|
46
|
+
* ```javascript
|
|
47
|
+
* // This example provides a description of the specified cluster in your default region.
|
|
48
|
+
* const input = {
|
|
49
|
+
* "clusters": [
|
|
50
|
+
* "default"
|
|
51
|
+
* ]
|
|
52
|
+
* };
|
|
53
|
+
* const command = new DescribeClustersCommand(input);
|
|
54
|
+
* const response = await client.send(command);
|
|
55
|
+
* /* response ==
|
|
56
|
+
* {
|
|
57
|
+
* "clusters": [
|
|
58
|
+
* {
|
|
59
|
+
* "clusterArn": "arn:aws:ecs:us-east-1:aws_account_id:cluster/default",
|
|
60
|
+
* "clusterName": "default",
|
|
61
|
+
* "status": "ACTIVE"
|
|
62
|
+
* }
|
|
63
|
+
* ],
|
|
64
|
+
* "failures": []
|
|
65
|
+
* }
|
|
66
|
+
* *\/
|
|
67
|
+
* // example id: ba88d100-9672-4231-80da-a4bd210bf728
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
32
70
|
*/
|
|
33
71
|
export declare class DescribeClustersCommand extends $Command<DescribeClustersCommandInput, DescribeClustersCommandOutput, ECSClientResolvedConfig> {
|
|
34
72
|
readonly input: DescribeClustersCommandInput;
|
|
@@ -30,6 +30,110 @@ export interface DescribeContainerInstancesCommandOutput extends DescribeContain
|
|
|
30
30
|
* @see {@link DescribeContainerInstancesCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link ClientException} (client fault)
|
|
34
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
35
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
36
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
39
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
42
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
43
|
+
* request.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link ServerException} (server fault)
|
|
46
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
47
|
+
*
|
|
48
|
+
*
|
|
49
|
+
* @example To describe container instance
|
|
50
|
+
* ```javascript
|
|
51
|
+
* // This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier.
|
|
52
|
+
* const input = {
|
|
53
|
+
* "cluster": "default",
|
|
54
|
+
* "containerInstances": [
|
|
55
|
+
* "f2756532-8f13-4d53-87c9-aed50dc94cd7"
|
|
56
|
+
* ]
|
|
57
|
+
* };
|
|
58
|
+
* const command = new DescribeContainerInstancesCommand(input);
|
|
59
|
+
* const response = await client.send(command);
|
|
60
|
+
* /* response ==
|
|
61
|
+
* {
|
|
62
|
+
* "containerInstances": [
|
|
63
|
+
* {
|
|
64
|
+
* "agentConnected": true,
|
|
65
|
+
* "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/f2756532-8f13-4d53-87c9-aed50dc94cd7",
|
|
66
|
+
* "ec2InstanceId": "i-807f3249",
|
|
67
|
+
* "pendingTasksCount": 0,
|
|
68
|
+
* "registeredResources": [
|
|
69
|
+
* {
|
|
70
|
+
* "name": "CPU",
|
|
71
|
+
* "type": "INTEGER",
|
|
72
|
+
* "doubleValue": 0,
|
|
73
|
+
* "integerValue": 2048,
|
|
74
|
+
* "longValue": 0
|
|
75
|
+
* },
|
|
76
|
+
* {
|
|
77
|
+
* "name": "MEMORY",
|
|
78
|
+
* "type": "INTEGER",
|
|
79
|
+
* "doubleValue": 0,
|
|
80
|
+
* "integerValue": 3768,
|
|
81
|
+
* "longValue": 0
|
|
82
|
+
* },
|
|
83
|
+
* {
|
|
84
|
+
* "name": "PORTS",
|
|
85
|
+
* "type": "STRINGSET",
|
|
86
|
+
* "doubleValue": 0,
|
|
87
|
+
* "integerValue": 0,
|
|
88
|
+
* "longValue": 0,
|
|
89
|
+
* "stringSetValue": [
|
|
90
|
+
* "2376",
|
|
91
|
+
* "22",
|
|
92
|
+
* "51678",
|
|
93
|
+
* "2375"
|
|
94
|
+
* ]
|
|
95
|
+
* }
|
|
96
|
+
* ],
|
|
97
|
+
* "remainingResources": [
|
|
98
|
+
* {
|
|
99
|
+
* "name": "CPU",
|
|
100
|
+
* "type": "INTEGER",
|
|
101
|
+
* "doubleValue": 0,
|
|
102
|
+
* "integerValue": 1948,
|
|
103
|
+
* "longValue": 0
|
|
104
|
+
* },
|
|
105
|
+
* {
|
|
106
|
+
* "name": "MEMORY",
|
|
107
|
+
* "type": "INTEGER",
|
|
108
|
+
* "doubleValue": 0,
|
|
109
|
+
* "integerValue": 3668,
|
|
110
|
+
* "longValue": 0
|
|
111
|
+
* },
|
|
112
|
+
* {
|
|
113
|
+
* "name": "PORTS",
|
|
114
|
+
* "type": "STRINGSET",
|
|
115
|
+
* "doubleValue": 0,
|
|
116
|
+
* "integerValue": 0,
|
|
117
|
+
* "longValue": 0,
|
|
118
|
+
* "stringSetValue": [
|
|
119
|
+
* "2376",
|
|
120
|
+
* "22",
|
|
121
|
+
* "80",
|
|
122
|
+
* "51678",
|
|
123
|
+
* "2375"
|
|
124
|
+
* ]
|
|
125
|
+
* }
|
|
126
|
+
* ],
|
|
127
|
+
* "runningTasksCount": 1,
|
|
128
|
+
* "status": "ACTIVE"
|
|
129
|
+
* }
|
|
130
|
+
* ],
|
|
131
|
+
* "failures": []
|
|
132
|
+
* }
|
|
133
|
+
* *\/
|
|
134
|
+
* // example id: c8f439de-eb27-4269-8ca7-2c0a7ba75ab0
|
|
135
|
+
* ```
|
|
136
|
+
*
|
|
33
137
|
*/
|
|
34
138
|
export declare class DescribeContainerInstancesCommand extends $Command<DescribeContainerInstancesCommandInput, DescribeContainerInstancesCommandOutput, ECSClientResolvedConfig> {
|
|
35
139
|
readonly input: DescribeContainerInstancesCommandInput;
|
|
@@ -29,6 +29,77 @@ export interface DescribeServicesCommandOutput extends DescribeServicesResponse,
|
|
|
29
29
|
* @see {@link DescribeServicesCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link ClientException} (client fault)
|
|
33
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
34
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
35
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
38
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
41
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
42
|
+
* request.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link ServerException} (server fault)
|
|
45
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
46
|
+
*
|
|
47
|
+
*
|
|
48
|
+
* @example To describe a service
|
|
49
|
+
* ```javascript
|
|
50
|
+
* // This example provides descriptive information about the service named ``ecs-simple-service``.
|
|
51
|
+
* const input = {
|
|
52
|
+
* "services": [
|
|
53
|
+
* "ecs-simple-service"
|
|
54
|
+
* ]
|
|
55
|
+
* };
|
|
56
|
+
* const command = new DescribeServicesCommand(input);
|
|
57
|
+
* const response = await client.send(command);
|
|
58
|
+
* /* response ==
|
|
59
|
+
* {
|
|
60
|
+
* "failures": [],
|
|
61
|
+
* "services": [
|
|
62
|
+
* {
|
|
63
|
+
* "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default",
|
|
64
|
+
* "createdAt": "2016-08-29T16:25:52.130Z",
|
|
65
|
+
* "deploymentConfiguration": {
|
|
66
|
+
* "maximumPercent": 200,
|
|
67
|
+
* "minimumHealthyPercent": 100
|
|
68
|
+
* },
|
|
69
|
+
* "deployments": [
|
|
70
|
+
* {
|
|
71
|
+
* "createdAt": "2016-08-29T16:25:52.130Z",
|
|
72
|
+
* "desiredCount": 1,
|
|
73
|
+
* "id": "ecs-svc/9223370564341623665",
|
|
74
|
+
* "pendingCount": 0,
|
|
75
|
+
* "runningCount": 0,
|
|
76
|
+
* "status": "PRIMARY",
|
|
77
|
+
* "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6",
|
|
78
|
+
* "updatedAt": "2016-08-29T16:25:52.130Z"
|
|
79
|
+
* }
|
|
80
|
+
* ],
|
|
81
|
+
* "desiredCount": 1,
|
|
82
|
+
* "events": [
|
|
83
|
+
* {
|
|
84
|
+
* "createdAt": "2016-08-29T16:25:58.520Z",
|
|
85
|
+
* "id": "38c285e5-d335-4b68-8b15-e46dedc8e88d",
|
|
86
|
+
* "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."
|
|
87
|
+
* }
|
|
88
|
+
* ],
|
|
89
|
+
* "loadBalancers": [],
|
|
90
|
+
* "pendingCount": 0,
|
|
91
|
+
* "runningCount": 0,
|
|
92
|
+
* "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service",
|
|
93
|
+
* "serviceName": "ecs-simple-service",
|
|
94
|
+
* "status": "ACTIVE",
|
|
95
|
+
* "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6"
|
|
96
|
+
* }
|
|
97
|
+
* ]
|
|
98
|
+
* }
|
|
99
|
+
* *\/
|
|
100
|
+
* // example id: to-describe-a-service-1472513256350
|
|
101
|
+
* ```
|
|
102
|
+
*
|
|
32
103
|
*/
|
|
33
104
|
export declare class DescribeServicesCommand extends $Command<DescribeServicesCommandInput, DescribeServicesCommandOutput, ECSClientResolvedConfig> {
|
|
34
105
|
readonly input: DescribeServicesCommandInput;
|
|
@@ -36,6 +36,77 @@ export interface DescribeTaskDefinitionCommandOutput extends DescribeTaskDefinit
|
|
|
36
36
|
* @see {@link DescribeTaskDefinitionCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @throws {@link ClientException} (client fault)
|
|
40
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
41
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
42
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
45
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
46
|
+
* request.</p>
|
|
47
|
+
*
|
|
48
|
+
* @throws {@link ServerException} (server fault)
|
|
49
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
50
|
+
*
|
|
51
|
+
*
|
|
52
|
+
* @example To describe a task definition
|
|
53
|
+
* ```javascript
|
|
54
|
+
* // This example provides a description of the specified task definition.
|
|
55
|
+
* const input = {
|
|
56
|
+
* "taskDefinition": "hello_world:8"
|
|
57
|
+
* };
|
|
58
|
+
* const command = new DescribeTaskDefinitionCommand(input);
|
|
59
|
+
* const response = await client.send(command);
|
|
60
|
+
* /* response ==
|
|
61
|
+
* {
|
|
62
|
+
* "taskDefinition": {
|
|
63
|
+
* "containerDefinitions": [
|
|
64
|
+
* {
|
|
65
|
+
* "name": "wordpress",
|
|
66
|
+
* "cpu": 10,
|
|
67
|
+
* "environment": [],
|
|
68
|
+
* "essential": true,
|
|
69
|
+
* "image": "wordpress",
|
|
70
|
+
* "links": [
|
|
71
|
+
* "mysql"
|
|
72
|
+
* ],
|
|
73
|
+
* "memory": 500,
|
|
74
|
+
* "mountPoints": [],
|
|
75
|
+
* "portMappings": [
|
|
76
|
+
* {
|
|
77
|
+
* "containerPort": 80,
|
|
78
|
+
* "hostPort": 80
|
|
79
|
+
* }
|
|
80
|
+
* ],
|
|
81
|
+
* "volumesFrom": []
|
|
82
|
+
* },
|
|
83
|
+
* {
|
|
84
|
+
* "name": "mysql",
|
|
85
|
+
* "cpu": 10,
|
|
86
|
+
* "environment": [
|
|
87
|
+
* {
|
|
88
|
+
* "name": "MYSQL_ROOT_PASSWORD",
|
|
89
|
+
* "value": "password"
|
|
90
|
+
* }
|
|
91
|
+
* ],
|
|
92
|
+
* "essential": true,
|
|
93
|
+
* "image": "mysql",
|
|
94
|
+
* "memory": 500,
|
|
95
|
+
* "mountPoints": [],
|
|
96
|
+
* "portMappings": [],
|
|
97
|
+
* "volumesFrom": []
|
|
98
|
+
* }
|
|
99
|
+
* ],
|
|
100
|
+
* "family": "hello_world",
|
|
101
|
+
* "revision": 8,
|
|
102
|
+
* "taskDefinitionArn": "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/hello_world:8",
|
|
103
|
+
* "volumes": []
|
|
104
|
+
* }
|
|
105
|
+
* }
|
|
106
|
+
* *\/
|
|
107
|
+
* // example id: 4c21eeb1-f1da-4a08-8c44-297fc8d0ea88
|
|
108
|
+
* ```
|
|
109
|
+
*
|
|
39
110
|
*/
|
|
40
111
|
export declare class DescribeTaskDefinitionCommand extends $Command<DescribeTaskDefinitionCommandInput, DescribeTaskDefinitionCommandOutput, ECSClientResolvedConfig> {
|
|
41
112
|
readonly input: DescribeTaskDefinitionCommandInput;
|
|
@@ -32,6 +32,36 @@ export interface DescribeTaskSetsCommandOutput extends DescribeTaskSetsResponse,
|
|
|
32
32
|
* @see {@link DescribeTaskSetsCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
36
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link ClientException} (client fault)
|
|
39
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
40
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
41
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
44
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
47
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
48
|
+
* request.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link ServerException} (server fault)
|
|
51
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link ServiceNotActiveException} (client fault)
|
|
54
|
+
* <p>The specified service isn't active. You can't update a service that's inactive. If you
|
|
55
|
+
* have previously deleted a service, you can re-create it with <a>CreateService</a>.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ServiceNotFoundException} (client fault)
|
|
58
|
+
* <p>The specified service wasn't found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster specific and Region
|
|
59
|
+
* specific.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
62
|
+
* <p>The specified task isn't supported in this Region.</p>
|
|
63
|
+
*
|
|
64
|
+
*
|
|
35
65
|
*/
|
|
36
66
|
export declare class DescribeTaskSetsCommand extends $Command<DescribeTaskSetsCommandInput, DescribeTaskSetsCommandOutput, ECSClientResolvedConfig> {
|
|
37
67
|
readonly input: DescribeTaskSetsCommandInput;
|
|
@@ -30,6 +30,73 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met
|
|
|
30
30
|
* @see {@link DescribeTasksCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
* @throws {@link ClientException} (client fault)
|
|
34
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
35
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
36
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
39
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
42
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
43
|
+
* request.</p>
|
|
44
|
+
*
|
|
45
|
+
* @throws {@link ServerException} (server fault)
|
|
46
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
47
|
+
*
|
|
48
|
+
*
|
|
49
|
+
* @example To describe a task
|
|
50
|
+
* ```javascript
|
|
51
|
+
* // This example provides a description of the specified task, using the task UUID as an identifier.
|
|
52
|
+
* const input = {
|
|
53
|
+
* "tasks": [
|
|
54
|
+
* "c5cba4eb-5dad-405e-96db-71ef8eefe6a8"
|
|
55
|
+
* ]
|
|
56
|
+
* };
|
|
57
|
+
* const command = new DescribeTasksCommand(input);
|
|
58
|
+
* const response = await client.send(command);
|
|
59
|
+
* /* response ==
|
|
60
|
+
* {
|
|
61
|
+
* "failures": [],
|
|
62
|
+
* "tasks": [
|
|
63
|
+
* {
|
|
64
|
+
* "clusterArn": "arn:aws:ecs:<region>:<aws_account_id>:cluster/default",
|
|
65
|
+
* "containerInstanceArn": "arn:aws:ecs:<region>:<aws_account_id>:container-instance/18f9eda5-27d7-4c19-b133-45adc516e8fb",
|
|
66
|
+
* "containers": [
|
|
67
|
+
* {
|
|
68
|
+
* "name": "ecs-demo",
|
|
69
|
+
* "containerArn": "arn:aws:ecs:<region>:<aws_account_id>:container/7c01765b-c588-45b3-8290-4ba38bd6c5a6",
|
|
70
|
+
* "lastStatus": "RUNNING",
|
|
71
|
+
* "networkBindings": [
|
|
72
|
+
* {
|
|
73
|
+
* "bindIP": "0.0.0.0",
|
|
74
|
+
* "containerPort": 80,
|
|
75
|
+
* "hostPort": 80
|
|
76
|
+
* }
|
|
77
|
+
* ],
|
|
78
|
+
* "taskArn": "arn:aws:ecs:<region>:<aws_account_id>:task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8"
|
|
79
|
+
* }
|
|
80
|
+
* ],
|
|
81
|
+
* "desiredStatus": "RUNNING",
|
|
82
|
+
* "lastStatus": "RUNNING",
|
|
83
|
+
* "overrides": {
|
|
84
|
+
* "containerOverrides": [
|
|
85
|
+
* {
|
|
86
|
+
* "name": "ecs-demo"
|
|
87
|
+
* }
|
|
88
|
+
* ]
|
|
89
|
+
* },
|
|
90
|
+
* "startedBy": "ecs-svc/9223370608528463088",
|
|
91
|
+
* "taskArn": "arn:aws:ecs:<region>:<aws_account_id>:task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8",
|
|
92
|
+
* "taskDefinitionArn": "arn:aws:ecs:<region>:<aws_account_id>:task-definition/amazon-ecs-sample:1"
|
|
93
|
+
* }
|
|
94
|
+
* ]
|
|
95
|
+
* }
|
|
96
|
+
* *\/
|
|
97
|
+
* // example id: a90b0cde-f965-4946-b55e-cfd8cc54e827
|
|
98
|
+
* ```
|
|
99
|
+
*
|
|
33
100
|
*/
|
|
34
101
|
export declare class DescribeTasksCommand extends $Command<DescribeTasksCommandInput, DescribeTasksCommandOutput, ECSClientResolvedConfig> {
|
|
35
102
|
readonly input: DescribeTasksCommandInput;
|
|
@@ -32,6 +32,15 @@ export interface DiscoverPollEndpointCommandOutput extends DiscoverPollEndpointR
|
|
|
32
32
|
* @see {@link DiscoverPollEndpointCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @throws {@link ClientException} (client fault)
|
|
36
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
37
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
38
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link ServerException} (server fault)
|
|
41
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
42
|
+
*
|
|
43
|
+
*
|
|
35
44
|
*/
|
|
36
45
|
export declare class DiscoverPollEndpointCommand extends $Command<DiscoverPollEndpointCommandInput, DiscoverPollEndpointCommandOutput, ECSClientResolvedConfig> {
|
|
37
46
|
readonly input: DiscoverPollEndpointCommandInput;
|
|
@@ -35,6 +35,43 @@ export interface ExecuteCommandCommandOutput extends ExecuteCommandResponse, __M
|
|
|
35
35
|
* @see {@link ExecuteCommandCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
39
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link ClientException} (client fault)
|
|
42
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
43
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
44
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
47
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
50
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
51
|
+
* request.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link ServerException} (server fault)
|
|
54
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link TargetNotConnectedException} (client fault)
|
|
57
|
+
* <p>The execute command cannot run. This error can be caused by any of the following
|
|
58
|
+
* configuration issues:</p>
|
|
59
|
+
* <ul>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p>Incorrect IAM permissions</p>
|
|
62
|
+
* </li>
|
|
63
|
+
* <li>
|
|
64
|
+
* <p>The SSM agent is not installed or is not running</p>
|
|
65
|
+
* </li>
|
|
66
|
+
* <li>
|
|
67
|
+
* <p> There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for
|
|
68
|
+
* for Systems Manager Session Manager</p>
|
|
69
|
+
* </li>
|
|
70
|
+
* </ul>
|
|
71
|
+
* <p>For information about how to troubleshoot the issues, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Troubleshooting issues with ECS
|
|
72
|
+
* Exec</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
73
|
+
*
|
|
74
|
+
*
|
|
38
75
|
*/
|
|
39
76
|
export declare class ExecuteCommandCommand extends $Command<ExecuteCommandCommandInput, ExecuteCommandCommandOutput, ECSClientResolvedConfig> {
|
|
40
77
|
readonly input: ExecuteCommandCommandInput;
|
|
@@ -29,6 +29,57 @@ export interface GetTaskProtectionCommandOutput extends GetTaskProtectionRespons
|
|
|
29
29
|
* @see {@link GetTaskProtectionCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
33
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link ClientException} (client fault)
|
|
36
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
37
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
38
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
41
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
44
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
45
|
+
* request.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
48
|
+
* <p>The specified resource wasn't found.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link ServerException} (server fault)
|
|
51
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
54
|
+
* <p>The specified task isn't supported in this Region.</p>
|
|
55
|
+
*
|
|
56
|
+
*
|
|
57
|
+
* @example To get the protection status of a task
|
|
58
|
+
* ```javascript
|
|
59
|
+
* // In this example, we get the protection status for a single task.
|
|
60
|
+
* const input = {
|
|
61
|
+
* "cluster": "test-task-protection",
|
|
62
|
+
* "tasks": [
|
|
63
|
+
* "b8b1cf532d0e46ba8d44a40d1de16772"
|
|
64
|
+
* ]
|
|
65
|
+
* };
|
|
66
|
+
* const command = new GetTaskProtectionCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* /* response ==
|
|
69
|
+
* {
|
|
70
|
+
* "failures": [],
|
|
71
|
+
* "protectedTasks": [
|
|
72
|
+
* {
|
|
73
|
+
* "expirationDate": "2022-11-02T06:56:32.553Z",
|
|
74
|
+
* "protectionEnabled": true,
|
|
75
|
+
* "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/b8b1cf532d0e46ba8d44a40d1de16772"
|
|
76
|
+
* }
|
|
77
|
+
* ]
|
|
78
|
+
* }
|
|
79
|
+
* *\/
|
|
80
|
+
* // example id: get-the-protection-status-for-a-single-task-2022-11-02T06:56:32.553Z
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
32
83
|
*/
|
|
33
84
|
export declare class GetTaskProtectionCommand extends $Command<GetTaskProtectionCommandInput, GetTaskProtectionCommandOutput, ECSClientResolvedConfig> {
|
|
34
85
|
readonly input: GetTaskProtectionCommandInput;
|
|
@@ -29,6 +29,84 @@ export interface ListAccountSettingsCommandOutput extends ListAccountSettingsRes
|
|
|
29
29
|
* @see {@link ListAccountSettingsCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link ClientException} (client fault)
|
|
33
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
34
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
35
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
38
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
39
|
+
* request.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link ServerException} (server fault)
|
|
42
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
43
|
+
*
|
|
44
|
+
*
|
|
45
|
+
* @example To view your effective account settings
|
|
46
|
+
* ```javascript
|
|
47
|
+
* // This example displays the effective account settings for your account.
|
|
48
|
+
* const input = {
|
|
49
|
+
* "effectiveSettings": true
|
|
50
|
+
* };
|
|
51
|
+
* const command = new ListAccountSettingsCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* /* response ==
|
|
54
|
+
* {
|
|
55
|
+
* "settings": [
|
|
56
|
+
* {
|
|
57
|
+
* "name": "containerInstanceLongArnFormat",
|
|
58
|
+
* "value": "disabled",
|
|
59
|
+
* "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
60
|
+
* },
|
|
61
|
+
* {
|
|
62
|
+
* "name": "serviceLongArnFormat",
|
|
63
|
+
* "value": "enabled",
|
|
64
|
+
* "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
65
|
+
* },
|
|
66
|
+
* {
|
|
67
|
+
* "name": "taskLongArnFormat",
|
|
68
|
+
* "value": "disabled",
|
|
69
|
+
* "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
70
|
+
* }
|
|
71
|
+
* ]
|
|
72
|
+
* }
|
|
73
|
+
* *\/
|
|
74
|
+
* // example id: to-view-your-account-settings-1549524118170
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
77
|
+
* @example To view the effective account settings for a specific IAM user or IAM role
|
|
78
|
+
* ```javascript
|
|
79
|
+
* // This example displays the effective account settings for the specified user or role.
|
|
80
|
+
* const input = {
|
|
81
|
+
* "effectiveSettings": true,
|
|
82
|
+
* "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
83
|
+
* };
|
|
84
|
+
* const command = new ListAccountSettingsCommand(input);
|
|
85
|
+
* const response = await client.send(command);
|
|
86
|
+
* /* response ==
|
|
87
|
+
* {
|
|
88
|
+
* "settings": [
|
|
89
|
+
* {
|
|
90
|
+
* "name": "containerInstanceLongArnFormat",
|
|
91
|
+
* "value": "disabled",
|
|
92
|
+
* "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
93
|
+
* },
|
|
94
|
+
* {
|
|
95
|
+
* "name": "serviceLongArnFormat",
|
|
96
|
+
* "value": "enabled",
|
|
97
|
+
* "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
98
|
+
* },
|
|
99
|
+
* {
|
|
100
|
+
* "name": "taskLongArnFormat",
|
|
101
|
+
* "value": "disabled",
|
|
102
|
+
* "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
103
|
+
* }
|
|
104
|
+
* ]
|
|
105
|
+
* }
|
|
106
|
+
* *\/
|
|
107
|
+
* // example id: to-view-the-account-settings-for-a-specific-iam-user-or-iam-role-1549524237932
|
|
108
|
+
* ```
|
|
109
|
+
*
|
|
32
110
|
*/
|
|
33
111
|
export declare class ListAccountSettingsCommand extends $Command<ListAccountSettingsCommandInput, ListAccountSettingsCommandOutput, ECSClientResolvedConfig> {
|
|
34
112
|
readonly input: ListAccountSettingsCommandInput;
|
|
@@ -35,6 +35,14 @@ export interface ListAttributesCommandOutput extends ListAttributesResponse, __M
|
|
|
35
35
|
* @see {@link ListAttributesCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
39
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
42
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
43
|
+
* request.</p>
|
|
44
|
+
*
|
|
45
|
+
*
|
|
38
46
|
*/
|
|
39
47
|
export declare class ListAttributesCommand extends $Command<ListAttributesCommandInput, ListAttributesCommandOutput, ECSClientResolvedConfig> {
|
|
40
48
|
readonly input: ListAttributesCommandInput;
|