@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
|
@@ -56,6 +56,79 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer
|
|
|
56
56
|
* @see {@link RunTaskCommandOutput} for command's `response` shape.
|
|
57
57
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
58
58
|
*
|
|
59
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
60
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link BlockedException} (client fault)
|
|
63
|
+
* <p>Your Amazon Web Services account was blocked. For more information, contact <a href="http://aws.amazon.com/contact-us/">
|
|
64
|
+
* Amazon Web Services Support</a>.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ClientException} (client fault)
|
|
67
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
68
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
69
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
72
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
75
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
76
|
+
* request.</p>
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault)
|
|
79
|
+
* <p>The specified platform version doesn't satisfy the required capabilities of the task
|
|
80
|
+
* definition.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link PlatformUnknownException} (client fault)
|
|
83
|
+
* <p>The specified platform version doesn't exist.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ServerException} (server fault)
|
|
86
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
89
|
+
* <p>The specified task isn't supported in this Region.</p>
|
|
90
|
+
*
|
|
91
|
+
*
|
|
92
|
+
* @example To run a task on your default cluster
|
|
93
|
+
* ```javascript
|
|
94
|
+
* // This example runs the specified task definition on your default cluster.
|
|
95
|
+
* const input = {
|
|
96
|
+
* "cluster": "default",
|
|
97
|
+
* "taskDefinition": "sleep360:1"
|
|
98
|
+
* };
|
|
99
|
+
* const command = new RunTaskCommand(input);
|
|
100
|
+
* const response = await client.send(command);
|
|
101
|
+
* /* response ==
|
|
102
|
+
* {
|
|
103
|
+
* "tasks": [
|
|
104
|
+
* {
|
|
105
|
+
* "containerInstanceArn": "arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb",
|
|
106
|
+
* "containers": [
|
|
107
|
+
* {
|
|
108
|
+
* "name": "sleep",
|
|
109
|
+
* "containerArn": "arn:aws:ecs:us-east-1:<aws_account_id>:container/58591c8e-be29-4ddf-95aa-ee459d4c59fd",
|
|
110
|
+
* "lastStatus": "PENDING",
|
|
111
|
+
* "taskArn": "arn:aws:ecs:us-east-1:<aws_account_id>:task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0"
|
|
112
|
+
* }
|
|
113
|
+
* ],
|
|
114
|
+
* "desiredStatus": "RUNNING",
|
|
115
|
+
* "lastStatus": "PENDING",
|
|
116
|
+
* "overrides": {
|
|
117
|
+
* "containerOverrides": [
|
|
118
|
+
* {
|
|
119
|
+
* "name": "sleep"
|
|
120
|
+
* }
|
|
121
|
+
* ]
|
|
122
|
+
* },
|
|
123
|
+
* "taskArn": "arn:aws:ecs:us-east-1:<aws_account_id>:task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0",
|
|
124
|
+
* "taskDefinitionArn": "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1"
|
|
125
|
+
* }
|
|
126
|
+
* ]
|
|
127
|
+
* }
|
|
128
|
+
* *\/
|
|
129
|
+
* // example id: 6f238c83-a133-42cd-ab3d-abeca0560445
|
|
130
|
+
* ```
|
|
131
|
+
*
|
|
59
132
|
*/
|
|
60
133
|
export declare class RunTaskCommand extends $Command<RunTaskCommandInput, RunTaskCommandOutput, ECSClientResolvedConfig> {
|
|
61
134
|
readonly input: RunTaskCommandInput;
|
|
@@ -32,6 +32,22 @@ export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBea
|
|
|
32
32
|
* @see {@link StartTaskCommandOutput} 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 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 ServerException} (server fault)
|
|
48
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
49
|
+
*
|
|
50
|
+
*
|
|
35
51
|
*/
|
|
36
52
|
export declare class StartTaskCommand extends $Command<StartTaskCommandInput, StartTaskCommandOutput, ECSClientResolvedConfig> {
|
|
37
53
|
readonly input: StartTaskCommandInput;
|
|
@@ -41,6 +41,22 @@ export interface StopTaskCommandOutput extends StopTaskResponse, __MetadataBeare
|
|
|
41
41
|
* @see {@link StopTaskCommandOutput} for command's `response` shape.
|
|
42
42
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
43
43
|
*
|
|
44
|
+
* @throws {@link ClientException} (client fault)
|
|
45
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
46
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
47
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
48
|
+
*
|
|
49
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
50
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
53
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
54
|
+
* request.</p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ServerException} (server fault)
|
|
57
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
58
|
+
*
|
|
59
|
+
*
|
|
44
60
|
*/
|
|
45
61
|
export declare class StopTaskCommand extends $Command<StopTaskCommandInput, StopTaskCommandOutput, ECSClientResolvedConfig> {
|
|
46
62
|
readonly input: StopTaskCommandInput;
|
|
@@ -32,6 +32,22 @@ export interface SubmitAttachmentStateChangesCommandOutput extends SubmitAttachm
|
|
|
32
32
|
* @see {@link SubmitAttachmentStateChangesCommandOutput} 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 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 ServerException} (server fault)
|
|
48
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
49
|
+
*
|
|
50
|
+
*
|
|
35
51
|
*/
|
|
36
52
|
export declare class SubmitAttachmentStateChangesCommand extends $Command<SubmitAttachmentStateChangesCommandInput, SubmitAttachmentStateChangesCommandOutput, ECSClientResolvedConfig> {
|
|
37
53
|
readonly input: SubmitAttachmentStateChangesCommandInput;
|
|
@@ -32,6 +32,18 @@ export interface SubmitContainerStateChangeCommandOutput extends SubmitContainer
|
|
|
32
32
|
* @see {@link SubmitContainerStateChangeCommandOutput} 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 ServerException} (server fault)
|
|
44
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
45
|
+
*
|
|
46
|
+
*
|
|
35
47
|
*/
|
|
36
48
|
export declare class SubmitContainerStateChangeCommand extends $Command<SubmitContainerStateChangeCommandInput, SubmitContainerStateChangeCommandOutput, ECSClientResolvedConfig> {
|
|
37
49
|
readonly input: SubmitContainerStateChangeCommandInput;
|
|
@@ -32,6 +32,22 @@ export interface SubmitTaskStateChangeCommandOutput extends SubmitTaskStateChang
|
|
|
32
32
|
* @see {@link SubmitTaskStateChangeCommandOutput} 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 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 ServerException} (server fault)
|
|
48
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
49
|
+
*
|
|
50
|
+
*
|
|
35
51
|
*/
|
|
36
52
|
export declare class SubmitTaskStateChangeCommand extends $Command<SubmitTaskStateChangeCommandInput, SubmitTaskStateChangeCommandOutput, ECSClientResolvedConfig> {
|
|
37
53
|
readonly input: SubmitTaskStateChangeCommandInput;
|
|
@@ -32,6 +32,42 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
32
32
|
* @see {@link TagResourceCommandOutput} 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 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
|
+
*
|
|
54
|
+
* @example To tag a cluster.
|
|
55
|
+
* ```javascript
|
|
56
|
+
* // This example tags the 'dev' cluster with key 'team' and value 'dev'.
|
|
57
|
+
* const input = {
|
|
58
|
+
* "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev",
|
|
59
|
+
* "tags": [
|
|
60
|
+
* {
|
|
61
|
+
* "key": "team",
|
|
62
|
+
* "value": "dev"
|
|
63
|
+
* }
|
|
64
|
+
* ]
|
|
65
|
+
* };
|
|
66
|
+
* const command = new TagResourceCommand(input);
|
|
67
|
+
* await client.send(command);
|
|
68
|
+
* // example id: to-tag-a-cluster-1540581863751
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
35
71
|
*/
|
|
36
72
|
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ECSClientResolvedConfig> {
|
|
37
73
|
readonly input: TagResourceCommandInput;
|
|
@@ -29,6 +29,39 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
|
|
|
29
29
|
* @see {@link UntagResourceCommandOutput} 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 ResourceNotFoundException} (client fault)
|
|
45
|
+
* <p>The specified resource wasn't found.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link ServerException} (server fault)
|
|
48
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
49
|
+
*
|
|
50
|
+
*
|
|
51
|
+
* @example To untag a cluster.
|
|
52
|
+
* ```javascript
|
|
53
|
+
* // This example deletes the 'team' tag from the 'dev' cluster.
|
|
54
|
+
* const input = {
|
|
55
|
+
* "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev",
|
|
56
|
+
* "tagKeys": [
|
|
57
|
+
* "team"
|
|
58
|
+
* ]
|
|
59
|
+
* };
|
|
60
|
+
* const command = new UntagResourceCommand(input);
|
|
61
|
+
* await client.send(command);
|
|
62
|
+
* // example id: to-untag-a-cluster-1540582546056
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
32
65
|
*/
|
|
33
66
|
export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ECSClientResolvedConfig> {
|
|
34
67
|
readonly input: UntagResourceCommandInput;
|
|
@@ -29,6 +29,19 @@ export interface UpdateCapacityProviderCommandOutput extends UpdateCapacityProvi
|
|
|
29
29
|
* @see {@link UpdateCapacityProviderCommandOutput} 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
|
+
*
|
|
32
45
|
*/
|
|
33
46
|
export declare class UpdateCapacityProviderCommand extends $Command<UpdateCapacityProviderCommandInput, UpdateCapacityProviderCommandOutput, ECSClientResolvedConfig> {
|
|
34
47
|
readonly input: UpdateCapacityProviderCommandInput;
|
|
@@ -29,6 +29,22 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met
|
|
|
29
29
|
* @see {@link UpdateClusterCommandOutput} 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
|
+
*
|
|
32
48
|
*/
|
|
33
49
|
export declare class UpdateClusterCommand extends $Command<UpdateClusterCommandInput, UpdateClusterCommandOutput, ECSClientResolvedConfig> {
|
|
34
50
|
readonly input: UpdateClusterCommandInput;
|
|
@@ -29,6 +29,22 @@ export interface UpdateClusterSettingsCommandOutput extends UpdateClusterSetting
|
|
|
29
29
|
* @see {@link UpdateClusterSettingsCommandOutput} 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
|
+
*
|
|
32
48
|
*/
|
|
33
49
|
export declare class UpdateClusterSettingsCommand extends $Command<UpdateClusterSettingsCommandInput, UpdateClusterSettingsCommandOutput, ECSClientResolvedConfig> {
|
|
34
50
|
readonly input: UpdateClusterSettingsCommandInput;
|
|
@@ -47,6 +47,40 @@ export interface UpdateContainerAgentCommandOutput extends UpdateContainerAgentR
|
|
|
47
47
|
* @see {@link UpdateContainerAgentCommandOutput} for command's `response` shape.
|
|
48
48
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
49
49
|
*
|
|
50
|
+
* @throws {@link ClientException} (client fault)
|
|
51
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
52
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
53
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
56
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
59
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
60
|
+
* request.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link MissingVersionException} (client fault)
|
|
63
|
+
* <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the
|
|
64
|
+
* container instance and doesn't have enough information to proceed with an update. This
|
|
65
|
+
* could be because the agent running on the container instance is a previous or custom
|
|
66
|
+
* version that doesn't use our version information.</p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link NoUpdateAvailableException} (client fault)
|
|
69
|
+
* <p>There's no update available for this Amazon ECS container agent. This might be because the
|
|
70
|
+
* agent is already running the latest version or because it's so old that there's no
|
|
71
|
+
* update path to the current version.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ServerException} (server fault)
|
|
74
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link UpdateInProgressException} (client fault)
|
|
77
|
+
* <p>There's already a current Amazon ECS container agent update in progress on the container
|
|
78
|
+
* instance that's specified. If the container agent becomes disconnected while it's in a
|
|
79
|
+
* transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update
|
|
80
|
+
* process can get stuck in that state. However, when the agent reconnects, it resumes
|
|
81
|
+
* where it stopped previously.</p>
|
|
82
|
+
*
|
|
83
|
+
*
|
|
50
84
|
*/
|
|
51
85
|
export declare class UpdateContainerAgentCommand extends $Command<UpdateContainerAgentCommandInput, UpdateContainerAgentCommandOutput, ECSClientResolvedConfig> {
|
|
52
86
|
readonly input: UpdateContainerAgentCommandInput;
|
|
@@ -77,6 +77,22 @@ export interface UpdateContainerInstancesStateCommandOutput extends UpdateContai
|
|
|
77
77
|
* @see {@link UpdateContainerInstancesStateCommandOutput} for command's `response` shape.
|
|
78
78
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
79
79
|
*
|
|
80
|
+
* @throws {@link ClientException} (client fault)
|
|
81
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
82
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
83
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
86
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
89
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
90
|
+
* request.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ServerException} (server fault)
|
|
93
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
94
|
+
*
|
|
95
|
+
*
|
|
80
96
|
*/
|
|
81
97
|
export declare class UpdateContainerInstancesStateCommand extends $Command<UpdateContainerInstancesStateCommandInput, UpdateContainerInstancesStateCommandOutput, ECSClientResolvedConfig> {
|
|
82
98
|
readonly input: UpdateContainerInstancesStateCommandInput;
|
|
@@ -151,6 +151,67 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
151
151
|
* @see {@link UpdateServiceCommandOutput} for command's `response` shape.
|
|
152
152
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
153
153
|
*
|
|
154
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
155
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
156
|
+
*
|
|
157
|
+
* @throws {@link ClientException} (client fault)
|
|
158
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
159
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
160
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
161
|
+
*
|
|
162
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
163
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
164
|
+
*
|
|
165
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
166
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
167
|
+
* request.</p>
|
|
168
|
+
*
|
|
169
|
+
* @throws {@link NamespaceNotFoundException} (client fault)
|
|
170
|
+
* <p>The specified namespace wasn't found.</p>
|
|
171
|
+
*
|
|
172
|
+
* @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault)
|
|
173
|
+
* <p>The specified platform version doesn't satisfy the required capabilities of the task
|
|
174
|
+
* definition.</p>
|
|
175
|
+
*
|
|
176
|
+
* @throws {@link PlatformUnknownException} (client fault)
|
|
177
|
+
* <p>The specified platform version doesn't exist.</p>
|
|
178
|
+
*
|
|
179
|
+
* @throws {@link ServerException} (server fault)
|
|
180
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
181
|
+
*
|
|
182
|
+
* @throws {@link ServiceNotActiveException} (client fault)
|
|
183
|
+
* <p>The specified service isn't active. You can't update a service that's inactive. If you
|
|
184
|
+
* have previously deleted a service, you can re-create it with <a>CreateService</a>.</p>
|
|
185
|
+
*
|
|
186
|
+
* @throws {@link ServiceNotFoundException} (client fault)
|
|
187
|
+
* <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
|
|
188
|
+
* specific.</p>
|
|
189
|
+
*
|
|
190
|
+
*
|
|
191
|
+
* @example To change the task definition used in a service
|
|
192
|
+
* ```javascript
|
|
193
|
+
* // This example updates the my-http-service service to use the amazon-ecs-sample task definition.
|
|
194
|
+
* const input = {
|
|
195
|
+
* "service": "my-http-service",
|
|
196
|
+
* "taskDefinition": "amazon-ecs-sample"
|
|
197
|
+
* };
|
|
198
|
+
* const command = new UpdateServiceCommand(input);
|
|
199
|
+
* await client.send(command);
|
|
200
|
+
* // example id: cc9e8900-0cc2-44d2-8491-64d1d3d37887
|
|
201
|
+
* ```
|
|
202
|
+
*
|
|
203
|
+
* @example To change the number of tasks in a service
|
|
204
|
+
* ```javascript
|
|
205
|
+
* // This example updates the desired count of the my-http-service service to 10.
|
|
206
|
+
* const input = {
|
|
207
|
+
* "desiredCount": 10,
|
|
208
|
+
* "service": "my-http-service"
|
|
209
|
+
* };
|
|
210
|
+
* const command = new UpdateServiceCommand(input);
|
|
211
|
+
* await client.send(command);
|
|
212
|
+
* // example id: 9581d6c5-02e3-4140-8cc1-5a4301586633
|
|
213
|
+
* ```
|
|
214
|
+
*
|
|
154
215
|
*/
|
|
155
216
|
export declare class UpdateServiceCommand extends $Command<UpdateServiceCommandInput, UpdateServiceCommandOutput, ECSClientResolvedConfig> {
|
|
156
217
|
readonly input: UpdateServiceCommandInput;
|
|
@@ -33,6 +33,40 @@ export interface UpdateServicePrimaryTaskSetCommandOutput extends UpdateServiceP
|
|
|
33
33
|
* @see {@link UpdateServicePrimaryTaskSetCommandOutput} for command's `response` shape.
|
|
34
34
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
35
35
|
*
|
|
36
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
37
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
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 ClusterNotFoundException} (client fault)
|
|
45
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
48
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
49
|
+
* request.</p>
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link ServerException} (server fault)
|
|
52
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ServiceNotActiveException} (client fault)
|
|
55
|
+
* <p>The specified service isn't active. You can't update a service that's inactive. If you
|
|
56
|
+
* have previously deleted a service, you can re-create it with <a>CreateService</a>.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ServiceNotFoundException} (client fault)
|
|
59
|
+
* <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
|
|
60
|
+
* specific.</p>
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link TaskSetNotFoundException} (client fault)
|
|
63
|
+
* <p>The specified task set wasn't found. You can view your available task sets with <a>DescribeTaskSets</a>. Task sets are specific to each cluster, service and
|
|
64
|
+
* Region.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
67
|
+
* <p>The specified task isn't supported in this Region.</p>
|
|
68
|
+
*
|
|
69
|
+
*
|
|
36
70
|
*/
|
|
37
71
|
export declare class UpdateServicePrimaryTaskSetCommand extends $Command<UpdateServicePrimaryTaskSetCommandInput, UpdateServicePrimaryTaskSetCommandOutput, ECSClientResolvedConfig> {
|
|
38
72
|
readonly input: UpdateServicePrimaryTaskSetCommandInput;
|
|
@@ -55,6 +55,112 @@ export interface UpdateTaskProtectionCommandOutput extends UpdateTaskProtectionR
|
|
|
55
55
|
* @see {@link UpdateTaskProtectionCommandOutput} for command's `response` shape.
|
|
56
56
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
57
57
|
*
|
|
58
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
59
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ClientException} (client fault)
|
|
62
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
63
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
64
|
+
* action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
67
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
70
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
71
|
+
* request.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>The specified resource wasn't found.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ServerException} (server fault)
|
|
77
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
80
|
+
* <p>The specified task isn't supported in this Region.</p>
|
|
81
|
+
*
|
|
82
|
+
*
|
|
83
|
+
* @example To set task scale-in protection for a task for 60 minutes
|
|
84
|
+
* ```javascript
|
|
85
|
+
* // This example enables scale-in protection for a task for 60 minutes.
|
|
86
|
+
* const input = {
|
|
87
|
+
* "cluster": "test-task-protection",
|
|
88
|
+
* "expiresInMinutes": 60,
|
|
89
|
+
* "protectionEnabled": true,
|
|
90
|
+
* "tasks": [
|
|
91
|
+
* "b8b1cf532d0e46ba8d44a40d1de16772"
|
|
92
|
+
* ]
|
|
93
|
+
* };
|
|
94
|
+
* const command = new UpdateTaskProtectionCommand(input);
|
|
95
|
+
* const response = await client.send(command);
|
|
96
|
+
* /* response ==
|
|
97
|
+
* {
|
|
98
|
+
* "failures": [],
|
|
99
|
+
* "protectedTasks": [
|
|
100
|
+
* {
|
|
101
|
+
* "expirationDate": "2022-11-02T06:56:32.553Z",
|
|
102
|
+
* "protectionEnabled": true,
|
|
103
|
+
* "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/b8b1cf532d0e46ba8d44a40d1de16772"
|
|
104
|
+
* }
|
|
105
|
+
* ]
|
|
106
|
+
* }
|
|
107
|
+
* *\/
|
|
108
|
+
* // example id: enable-the-protection-status-for-a-single-task-for-60-minutes-2022-11-02T06:56:32.553Z
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
111
|
+
* @example To set task scale-in protection for the default time period in minutes
|
|
112
|
+
* ```javascript
|
|
113
|
+
* // This example enables task scale-in protection for a task, without specifying the expiresInMinutes parameter, for the default protection period of 120 minutes.
|
|
114
|
+
* const input = {
|
|
115
|
+
* "cluster": "test-task-protection",
|
|
116
|
+
* "protectionEnabled": true,
|
|
117
|
+
* "tasks": [
|
|
118
|
+
* "b8b1cf532d0e46ba8d44a40d1de16772"
|
|
119
|
+
* ]
|
|
120
|
+
* };
|
|
121
|
+
* const command = new UpdateTaskProtectionCommand(input);
|
|
122
|
+
* const response = await client.send(command);
|
|
123
|
+
* /* response ==
|
|
124
|
+
* {
|
|
125
|
+
* "failures": [],
|
|
126
|
+
* "protectedTasks": [
|
|
127
|
+
* {
|
|
128
|
+
* "expirationDate": "2022-11-02T06:56:32.553Z",
|
|
129
|
+
* "protectionEnabled": true,
|
|
130
|
+
* "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/b8b1cf532d0e46ba8d44a40d1de16772"
|
|
131
|
+
* }
|
|
132
|
+
* ]
|
|
133
|
+
* }
|
|
134
|
+
* *\/
|
|
135
|
+
* // example id: enable-the-protection-status-for-a-single-task-with-default-expiresinminutes-2022-11-02T06:56:32.553Z
|
|
136
|
+
* ```
|
|
137
|
+
*
|
|
138
|
+
* @example To remove task scale-in protection
|
|
139
|
+
* ```javascript
|
|
140
|
+
* // This example removes scale-in protection for a task.
|
|
141
|
+
* const input = {
|
|
142
|
+
* "cluster": "test-task-protection",
|
|
143
|
+
* "protectionEnabled": false,
|
|
144
|
+
* "tasks": [
|
|
145
|
+
* "b8b1cf532d0e46ba8d44a40d1de16772"
|
|
146
|
+
* ]
|
|
147
|
+
* };
|
|
148
|
+
* const command = new UpdateTaskProtectionCommand(input);
|
|
149
|
+
* const response = await client.send(command);
|
|
150
|
+
* /* response ==
|
|
151
|
+
* {
|
|
152
|
+
* "failures": [],
|
|
153
|
+
* "protectedTasks": [
|
|
154
|
+
* {
|
|
155
|
+
* "protectionEnabled": false,
|
|
156
|
+
* "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/b8b1cf532d0e46ba8d44a40d1de16772"
|
|
157
|
+
* }
|
|
158
|
+
* ]
|
|
159
|
+
* }
|
|
160
|
+
* *\/
|
|
161
|
+
* // example id: disable-scale-in-protection-on-a-single-task
|
|
162
|
+
* ```
|
|
163
|
+
*
|
|
58
164
|
*/
|
|
59
165
|
export declare class UpdateTaskProtectionCommand extends $Command<UpdateTaskProtectionCommandInput, UpdateTaskProtectionCommandOutput, ECSClientResolvedConfig> {
|
|
60
166
|
readonly input: UpdateTaskProtectionCommandInput;
|