@aws-sdk/client-ecs 3.993.0 → 3.995.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/README.md +1 -15
- package/dist-cjs/index.js +164 -164
- package/dist-cjs/models/errors.js +86 -86
- package/dist-cjs/schemas/schemas_0.js +5 -5
- package/dist-es/models/enums.js +156 -156
- package/dist-es/models/errors.js +68 -68
- package/dist-es/schemas/schemas_0.js +5 -5
- package/dist-es/waiters/waitForServicesInactive.js +2 -2
- package/dist-es/waiters/waitForServicesStable.js +2 -2
- package/dist-es/waiters/waitForTasksRunning.js +2 -2
- package/dist-es/waiters/waitForTasksStopped.js +2 -2
- package/dist-types/ECS.d.ts +1 -15
- package/dist-types/ECSClient.d.ts +1 -15
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +4 -16
- package/dist-types/commands/CreateClusterCommand.d.ts +3 -20
- package/dist-types/commands/CreateExpressGatewayServiceCommand.d.ts +4 -18
- package/dist-types/commands/CreateServiceCommand.d.ts +4 -236
- package/dist-types/commands/CreateTaskSetCommand.d.ts +6 -25
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +12 -18
- package/dist-types/commands/DeleteAttributesCommand.d.ts +2 -7
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +3 -21
- package/dist-types/commands/DeleteClusterCommand.d.ts +7 -30
- package/dist-types/commands/DeleteExpressGatewayServiceCommand.d.ts +5 -19
- package/dist-types/commands/DeleteServiceCommand.d.ts +4 -30
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +3 -27
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +6 -16
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +3 -21
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +3 -25
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +34 -39
- package/dist-types/commands/DescribeClustersCommand.d.ts +3 -10
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +3 -9
- package/dist-types/commands/DescribeExpressGatewayServiceCommand.d.ts +3 -14
- package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +44 -13
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +44 -14
- package/dist-types/commands/DescribeServicesCommand.d.ts +2 -7
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +3 -15
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +5 -16
- package/dist-types/commands/DescribeTasksCommand.d.ts +3 -12
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +2 -8
- package/dist-types/commands/ExecuteCommandCommand.d.ts +4 -32
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +2 -7
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +9 -14
- package/dist-types/commands/ListAttributesCommand.d.ts +2 -11
- package/dist-types/commands/ListClustersCommand.d.ts +2 -7
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +3 -11
- package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +4 -15
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +3 -13
- package/dist-types/commands/ListServicesCommand.d.ts +3 -9
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -7
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +13 -24
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +13 -20
- package/dist-types/commands/ListTasksCommand.d.ts +14 -23
- package/dist-types/commands/PutAccountSettingCommand.d.ts +12 -22
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +3 -9
- package/dist-types/commands/PutAttributesCommand.d.ts +4 -14
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +4 -29
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +3 -13
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +3 -26
- package/dist-types/commands/RunTaskCommand.d.ts +6 -75
- package/dist-types/commands/StartTaskCommand.d.ts +3 -23
- package/dist-types/commands/StopServiceDeploymentCommand.d.ts +5 -25
- package/dist-types/commands/StopTaskCommand.d.ts +3 -25
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +3 -12
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +2 -8
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +3 -12
- package/dist-types/commands/TagResourceCommand.d.ts +3 -11
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -7
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +3 -10
- package/dist-types/commands/UpdateClusterCommand.d.ts +2 -7
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +2 -7
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +6 -41
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +3 -56
- package/dist-types/commands/UpdateExpressGatewayServiceCommand.d.ts +5 -19
- package/dist-types/commands/UpdateServiceCommand.d.ts +14 -146
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +6 -19
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +15 -47
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +6 -17
- package/dist-types/index.d.ts +1 -15
- package/dist-types/models/enums.d.ts +338 -338
- package/dist-types/models/errors.d.ts +74 -128
- package/dist-types/models/models_0.d.ts +3435 -9819
- package/dist-types/ts3.4/models/enums.d.ts +222 -222
- package/dist-types/ts3.4/models/errors.d.ts +61 -61
- package/dist-types/ts3.4/models/models_0.d.ts +1055 -1055
- package/package.json +3 -3
|
@@ -27,8 +27,7 @@ declare const PutAccountSettingDefaultCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Modifies an account setting for all users on an account for whom no individual account
|
|
31
|
-
* setting has been specified. Account settings are set on a per-Region basis.</p>
|
|
30
|
+
* <p>Modifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -61,15 +60,10 @@ declare const PutAccountSettingDefaultCommand_base: {
|
|
|
61
60
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
62
61
|
*
|
|
63
62
|
* @throws {@link ClientException} (client fault)
|
|
64
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
65
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
66
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
63
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
67
64
|
*
|
|
68
65
|
* @throws {@link InvalidParameterException} (client fault)
|
|
69
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
70
|
-
* request.</p>
|
|
71
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
72
|
-
* service event messages</a>. </p>
|
|
66
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
73
67
|
*
|
|
74
68
|
* @throws {@link ServerException} (server fault)
|
|
75
69
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,10 +27,7 @@ declare const PutAttributesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Create or update an attribute on an Amazon ECS resource. If the attribute doesn't
|
|
31
|
-
* exist, it's created. If the attribute exists, its value is replaced with the specified
|
|
32
|
-
* value. To delete an attribute, use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html">DeleteAttributes</a>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the <i>Amazon Elastic Container
|
|
33
|
-
* Service Developer Guide</i>.</p>
|
|
30
|
+
* <p>Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html">DeleteAttributes</a>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -72,23 +69,16 @@ declare const PutAttributesCommand_base: {
|
|
|
72
69
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
73
70
|
*
|
|
74
71
|
* @throws {@link AttributeLimitExceededException} (client fault)
|
|
75
|
-
* <p>You can apply up to 10 custom attributes for each resource. You can view the
|
|
76
|
-
* attributes of a resource with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListAttributes.html">ListAttributes</a>.
|
|
77
|
-
* You can remove existing attributes on a resource with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html">DeleteAttributes</a>.</p>
|
|
72
|
+
* <p>You can apply up to 10 custom attributes for each resource. You can view the attributes of a resource with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListAttributes.html">ListAttributes</a>. You can remove existing attributes on a resource with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeleteAttributes.html">DeleteAttributes</a>.</p>
|
|
78
73
|
*
|
|
79
74
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
80
75
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
81
76
|
*
|
|
82
77
|
* @throws {@link InvalidParameterException} (client fault)
|
|
83
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
84
|
-
* request.</p>
|
|
85
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
86
|
-
* service event messages</a>. </p>
|
|
78
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
87
79
|
*
|
|
88
80
|
* @throws {@link TargetNotFoundException} (client fault)
|
|
89
|
-
* <p>The specified target wasn't found. You can view your available container instances
|
|
90
|
-
* with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a>. Amazon ECS container instances are cluster-specific
|
|
91
|
-
* and Region-specific.</p>
|
|
81
|
+
* <p>The specified target wasn't found. You can view your available container instances with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListContainerInstances.html">ListContainerInstances</a>. Amazon ECS container instances are cluster-specific and Region-specific.</p>
|
|
92
82
|
*
|
|
93
83
|
* @throws {@link ECSServiceException}
|
|
94
84
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
@@ -27,23 +27,7 @@ declare const PutClusterCapacityProvidersCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Modifies the available capacity providers and the default capacity provider strategy
|
|
31
|
-
* for a cluster.</p>
|
|
32
|
-
* <p>You must specify both the available capacity providers and a default capacity provider
|
|
33
|
-
* strategy for the cluster. If the specified cluster has existing capacity providers
|
|
34
|
-
* associated with it, you must specify all existing capacity providers in addition to any
|
|
35
|
-
* new ones you want to add. Any existing capacity providers that are associated with a
|
|
36
|
-
* cluster that are omitted from a <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> API call will be disassociated with the
|
|
37
|
-
* cluster. You can only disassociate an existing capacity provider from a cluster if it's
|
|
38
|
-
* not being used by any existing tasks.</p>
|
|
39
|
-
* <p>When creating a service or running a task on a cluster, if no capacity provider or
|
|
40
|
-
* launch type is specified, then the cluster's default capacity provider strategy is used.
|
|
41
|
-
* We recommend that you define a default capacity provider strategy for your cluster.
|
|
42
|
-
* However, you must specify an empty array (<code>[]</code>) to bypass defining a default
|
|
43
|
-
* strategy.</p>
|
|
44
|
-
* <p>Amazon ECS Managed Instances doesn't support this, because when you create a capacity
|
|
45
|
-
* provider with Amazon ECS Managed Instances, it becomes available only within the
|
|
46
|
-
* specified cluster.</p>
|
|
30
|
+
* <p>Modifies the available capacity providers and the default capacity provider strategy for a cluster.</p> <p>You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.</p> <p>When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. We recommend that you define a default capacity provider strategy for your cluster. However, you must specify an empty array (<code>[]</code>) to bypass defining a default strategy.</p> <p>Amazon ECS Managed Instances doesn't support this, because when you create a capacity provider with Amazon ECS Managed Instances, it becomes available only within the specified cluster.</p>
|
|
47
31
|
* @example
|
|
48
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
49
33
|
* ```javascript
|
|
@@ -150,18 +134,13 @@ declare const PutClusterCapacityProvidersCommand_base: {
|
|
|
150
134
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
151
135
|
*
|
|
152
136
|
* @throws {@link ClientException} (client fault)
|
|
153
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
154
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
155
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
137
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
156
138
|
*
|
|
157
139
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
158
140
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
159
141
|
*
|
|
160
142
|
* @throws {@link InvalidParameterException} (client fault)
|
|
161
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
162
|
-
* request.</p>
|
|
163
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
164
|
-
* service event messages</a>. </p>
|
|
143
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
165
144
|
*
|
|
166
145
|
* @throws {@link ResourceInUseException} (client fault)
|
|
167
146
|
* <p>The specified resource is in-use and can't be removed.</p>
|
|
@@ -170,11 +149,7 @@ declare const PutClusterCapacityProvidersCommand_base: {
|
|
|
170
149
|
* <p>These errors are usually caused by a server issue.</p>
|
|
171
150
|
*
|
|
172
151
|
* @throws {@link UpdateInProgressException} (client fault)
|
|
173
|
-
* <p>There's already a current Amazon ECS container agent update in progress on the
|
|
174
|
-
* container instance that's specified. If the container agent becomes disconnected while
|
|
175
|
-
* it's in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the
|
|
176
|
-
* update process can get stuck in that state. However, when the agent reconnects, it
|
|
177
|
-
* resumes where it stopped previously.</p>
|
|
152
|
+
* <p>There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's in a transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.</p>
|
|
178
153
|
*
|
|
179
154
|
* @throws {@link ECSServiceException}
|
|
180
155
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
@@ -27,12 +27,7 @@ declare const RegisterContainerInstanceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <note>
|
|
31
|
-
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use
|
|
32
|
-
* outside of the agent.</p>
|
|
33
|
-
* </note>
|
|
34
|
-
* <p>Registers an EC2 instance into the specified cluster. This instance becomes available
|
|
35
|
-
* to place containers on.</p>
|
|
30
|
+
* <note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.</p>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -178,15 +173,10 @@ declare const RegisterContainerInstanceCommand_base: {
|
|
|
178
173
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
179
174
|
*
|
|
180
175
|
* @throws {@link ClientException} (client fault)
|
|
181
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
182
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
183
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
176
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
184
177
|
*
|
|
185
178
|
* @throws {@link InvalidParameterException} (client fault)
|
|
186
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
187
|
-
* request.</p>
|
|
188
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
189
|
-
* service event messages</a>. </p>
|
|
179
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
190
180
|
*
|
|
191
181
|
* @throws {@link ServerException} (server fault)
|
|
192
182
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,25 +27,7 @@ declare const RegisterTaskDefinitionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Registers a new task definition from the supplied <code>family</code> and
|
|
31
|
-
* <code>containerDefinitions</code>. Optionally, you can add data volumes to your
|
|
32
|
-
* containers with the <code>volumes</code> parameter. For more information about task
|
|
33
|
-
* definition parameters and defaults, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task
|
|
34
|
-
* Definitions</a> in the <i>Amazon Elastic Container Service Developer
|
|
35
|
-
* Guide</i>.</p>
|
|
36
|
-
* <p>You can specify a role for your task with the <code>taskRoleArn</code> parameter. When
|
|
37
|
-
* you specify a role for a task, its containers can then use the latest versions of the
|
|
38
|
-
* CLI or SDKs
|
|
39
|
-
* to make API requests to the Amazon Web Services services that are specified in the policy
|
|
40
|
-
* that's associated with the role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM Roles for
|
|
41
|
-
* Tasks</a> in the <i>Amazon Elastic Container Service Developer
|
|
42
|
-
* Guide</i>.</p>
|
|
43
|
-
* <p>You can specify a Docker networking mode for the containers in your task definition
|
|
44
|
-
* with the <code>networkMode</code> parameter. If you specify the <code>awsvpc</code>
|
|
45
|
-
* network mode, the task is allocated an elastic network interface, and you must specify a
|
|
46
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html">NetworkConfiguration</a> when you create a service or run a task with the task
|
|
47
|
-
* definition. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html">Task Networking</a>
|
|
48
|
-
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
30
|
+
* <p>Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information about task definition parameters and defaults, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task Definitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can specify a role for your task with the <code>taskRoleArn</code> parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the policy that's associated with the role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can specify a Docker networking mode for the containers in your task definition with the <code>networkMode</code> parameter. If you specify the <code>awsvpc</code> network mode, the task is allocated an elastic network interface, and you must specify a <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html">NetworkConfiguration</a> when you create a service or run a task with the task definition. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
49
31
|
* @example
|
|
50
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
51
33
|
* ```javascript
|
|
@@ -607,15 +589,10 @@ declare const RegisterTaskDefinitionCommand_base: {
|
|
|
607
589
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
608
590
|
*
|
|
609
591
|
* @throws {@link ClientException} (client fault)
|
|
610
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
611
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
612
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
592
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
613
593
|
*
|
|
614
594
|
* @throws {@link InvalidParameterException} (client fault)
|
|
615
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
616
|
-
* request.</p>
|
|
617
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
618
|
-
* service event messages</a>. </p>
|
|
595
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
619
596
|
*
|
|
620
597
|
* @throws {@link ServerException} (server fault)
|
|
621
598
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,66 +27,7 @@ declare const RunTaskCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Starts a new task using the specified task definition.</p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>On March 21, 2024, a change was made to resolve the task definition revision
|
|
33
|
-
* before authorization. When a task definition revision is not specified,
|
|
34
|
-
* authorization will occur using the latest revision of a task definition.</p>
|
|
35
|
-
* </note>
|
|
36
|
-
* <note>
|
|
37
|
-
* <p>Amazon Elastic Inference (EI) is no longer available to customers.</p>
|
|
38
|
-
* </note>
|
|
39
|
-
* <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS
|
|
40
|
-
* places tasks using placement constraints and placement strategies. For more information,
|
|
41
|
-
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic
|
|
42
|
-
* Container Service Developer Guide</i>.</p>
|
|
43
|
-
* <p>Alternatively, you can use <code>StartTask</code> to use your own scheduler or place
|
|
44
|
-
* tasks manually on specific container instances.</p>
|
|
45
|
-
* <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when
|
|
46
|
-
* creating or updating a service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic
|
|
47
|
-
* Container Service Developer Guide</i>.</p>
|
|
48
|
-
* <p>The Amazon ECS API follows an eventual consistency model. This is because of the
|
|
49
|
-
* distributed nature of the system supporting the API. This means that the result of an
|
|
50
|
-
* API command you run that affects your Amazon ECS resources might not be immediately
|
|
51
|
-
* visible to all subsequent commands you run. Keep this in mind when you carry out an API
|
|
52
|
-
* command that immediately follows a previous API command.</p>
|
|
53
|
-
* <p>To manage eventual consistency, you can do the following:</p>
|
|
54
|
-
* <ul>
|
|
55
|
-
* <li>
|
|
56
|
-
* <p>Confirm the state of the resource before you run a command to modify it. Run
|
|
57
|
-
* the DescribeTasks command using an exponential backoff algorithm to ensure that
|
|
58
|
-
* you allow enough time for the previous command to propagate through the system.
|
|
59
|
-
* To do this, run the DescribeTasks command repeatedly, starting with a couple of
|
|
60
|
-
* seconds of wait time and increasing gradually up to five minutes of wait
|
|
61
|
-
* time.</p>
|
|
62
|
-
* </li>
|
|
63
|
-
* <li>
|
|
64
|
-
* <p>Add wait time between subsequent commands, even if the DescribeTasks command
|
|
65
|
-
* returns an accurate response. Apply an exponential backoff algorithm starting
|
|
66
|
-
* with a couple of seconds of wait time, and increase gradually up to about five
|
|
67
|
-
* minutes of wait time.</p>
|
|
68
|
-
* </li>
|
|
69
|
-
* </ul>
|
|
70
|
-
* <p>If you get a <code>ConflictException</code> error, the <code>RunTask</code> request
|
|
71
|
-
* could not be processed due to conflicts. The provided <code>clientToken</code> is
|
|
72
|
-
* already in use with a different <code>RunTask</code> request. The
|
|
73
|
-
* <code>resourceIds</code> are the existing task ARNs which are already associated
|
|
74
|
-
* with the <code>clientToken</code>. </p>
|
|
75
|
-
* <p>To fix this issue:</p>
|
|
76
|
-
* <ul>
|
|
77
|
-
* <li>
|
|
78
|
-
* <p>Run <code>RunTask</code> with a unique <code>clientToken</code>.</p>
|
|
79
|
-
* </li>
|
|
80
|
-
* <li>
|
|
81
|
-
* <p>Run <code>RunTask</code> with the <code>clientToken</code> and the original
|
|
82
|
-
* set of parameters</p>
|
|
83
|
-
* </li>
|
|
84
|
-
* </ul>
|
|
85
|
-
* <p>If you get a <code>ClientException</code>error, the <code>RunTask</code> could not be
|
|
86
|
-
* processed because you use managed scaling and there is a capacity error because the
|
|
87
|
-
* quota of tasks in the <code>PROVISIONING</code> per cluster has been reached. For
|
|
88
|
-
* information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
|
|
89
|
-
* quotas</a>.</p>
|
|
30
|
+
* <p>Starts a new task using the specified task definition.</p> <note> <p>On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.</p> </note> <note> <p>Amazon Elastic Inference (EI) is no longer available to customers.</p> </note> <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Alternatively, you can use <code>StartTask</code> to use your own scheduler or place tasks manually on specific container instances.</p> <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.</p> <p>To manage eventual consistency, you can do the following:</p> <ul> <li> <p>Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.</p> </li> <li> <p>Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.</p> </li> </ul> <p>If you get a <code>ConflictException</code> error, the <code>RunTask</code> request could not be processed due to conflicts. The provided <code>clientToken</code> is already in use with a different <code>RunTask</code> request. The <code>resourceIds</code> are the existing task ARNs which are already associated with the <code>clientToken</code>. </p> <p>To fix this issue:</p> <ul> <li> <p>Run <code>RunTask</code> with a unique <code>clientToken</code>.</p> </li> <li> <p>Run <code>RunTask</code> with the <code>clientToken</code> and the original set of parameters</p> </li> </ul> <p>If you get a <code>ClientException</code>error, the <code>RunTask</code> could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service quotas</a>.</p>
|
|
90
31
|
* @example
|
|
91
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
92
33
|
* ```javascript
|
|
@@ -407,32 +348,22 @@ declare const RunTaskCommand_base: {
|
|
|
407
348
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
408
349
|
*
|
|
409
350
|
* @throws {@link BlockedException} (client fault)
|
|
410
|
-
* <p>Your Amazon Web
|
|
411
|
-
* Services account was blocked. For more information, contact <a href="http://aws.amazon.com/contact-us/">
|
|
412
|
-
* Amazon Web
|
|
413
|
-
* Services Support</a>.</p>
|
|
351
|
+
* <p>Your Amazon Web Services account was blocked. For more information, contact <a href="http://aws.amazon.com/contact-us/"> Amazon Web Services Support</a>.</p>
|
|
414
352
|
*
|
|
415
353
|
* @throws {@link ClientException} (client fault)
|
|
416
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
417
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
418
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
354
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
419
355
|
*
|
|
420
356
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
421
357
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
422
358
|
*
|
|
423
359
|
* @throws {@link ConflictException} (client fault)
|
|
424
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
425
|
-
* resource. </p>
|
|
360
|
+
* <p>The request could not be processed because of conflict in the current state of the resource. </p>
|
|
426
361
|
*
|
|
427
362
|
* @throws {@link InvalidParameterException} (client fault)
|
|
428
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
429
|
-
* request.</p>
|
|
430
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
431
|
-
* service event messages</a>. </p>
|
|
363
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
432
364
|
*
|
|
433
365
|
* @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault)
|
|
434
|
-
* <p>The specified platform version doesn't satisfy the required capabilities of the task
|
|
435
|
-
* definition.</p>
|
|
366
|
+
* <p>The specified platform version doesn't satisfy the required capabilities of the task definition.</p>
|
|
436
367
|
*
|
|
437
368
|
* @throws {@link PlatformUnknownException} (client fault)
|
|
438
369
|
* <p>The specified platform version doesn't exist.</p>
|
|
@@ -27,22 +27,7 @@ declare const StartTaskCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Starts a new task from the specified task definition on the specified container
|
|
31
|
-
* instance or instances.</p>
|
|
32
|
-
* <note>
|
|
33
|
-
* <p>On March 21, 2024, a change was made to resolve the task definition revision
|
|
34
|
-
* before authorization. When a task definition revision is not specified,
|
|
35
|
-
* authorization will occur using the latest revision of a task definition.</p>
|
|
36
|
-
* </note>
|
|
37
|
-
* <note>
|
|
38
|
-
* <p>Amazon Elastic Inference (EI) is no longer available to customers.</p>
|
|
39
|
-
* </note>
|
|
40
|
-
* <p>Alternatively, you can use<code>RunTask</code> to place tasks for you. For more
|
|
41
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic
|
|
42
|
-
* Container Service Developer Guide</i>.</p>
|
|
43
|
-
* <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when
|
|
44
|
-
* creating or updating a service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic
|
|
45
|
-
* Container Service Developer Guide</i>.</p>
|
|
30
|
+
* <p>Starts a new task from the specified task definition on the specified container instance or instances.</p> <note> <p>On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.</p> </note> <note> <p>Amazon Elastic Inference (EI) is no longer available to customers.</p> </note> <p>Alternatively, you can use<code>RunTask</code> to place tasks for you. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
46
31
|
* @example
|
|
47
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
48
33
|
* ```javascript
|
|
@@ -338,18 +323,13 @@ declare const StartTaskCommand_base: {
|
|
|
338
323
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
339
324
|
*
|
|
340
325
|
* @throws {@link ClientException} (client fault)
|
|
341
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
342
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
343
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
326
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
344
327
|
*
|
|
345
328
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
346
329
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
347
330
|
*
|
|
348
331
|
* @throws {@link InvalidParameterException} (client fault)
|
|
349
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
350
|
-
* request.</p>
|
|
351
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
352
|
-
* service event messages</a>. </p>
|
|
332
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
353
333
|
*
|
|
354
334
|
* @throws {@link ServerException} (server fault)
|
|
355
335
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,19 +27,7 @@ declare const StopServiceDeploymentCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Stops an ongoing service deployment.</p>
|
|
31
|
-
* <p>The following stop types are avaiable:</p>
|
|
32
|
-
* <ul>
|
|
33
|
-
* <li>
|
|
34
|
-
* <p>ROLLBACK - This option rolls back the service deployment to the previous
|
|
35
|
-
* service revision. </p>
|
|
36
|
-
* <p>You can use this option even if you didn't configure the service deployment
|
|
37
|
-
* for the rollback option. </p>
|
|
38
|
-
* </li>
|
|
39
|
-
* </ul>
|
|
40
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/stop-service-deployment.html">Stopping Amazon
|
|
41
|
-
* ECS service deployments</a> in the <i>Amazon Elastic Container Service
|
|
42
|
-
* Developer Guide</i>.</p>
|
|
30
|
+
* <p>Stops an ongoing service deployment.</p> <p>The following stop types are avaiable:</p> <ul> <li> <p>ROLLBACK - This option rolls back the service deployment to the previous service revision. </p> <p>You can use this option even if you didn't configure the service deployment for the rollback option. </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/stop-service-deployment.html">Stopping Amazon ECS service deployments</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
43
31
|
* @example
|
|
44
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
45
33
|
* ```javascript
|
|
@@ -70,27 +58,19 @@ declare const StopServiceDeploymentCommand_base: {
|
|
|
70
58
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
71
59
|
*
|
|
72
60
|
* @throws {@link ClientException} (client fault)
|
|
73
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
74
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
75
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
61
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
76
62
|
*
|
|
77
63
|
* @throws {@link ConflictException} (client fault)
|
|
78
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
79
|
-
* resource. </p>
|
|
64
|
+
* <p>The request could not be processed because of conflict in the current state of the resource. </p>
|
|
80
65
|
*
|
|
81
66
|
* @throws {@link InvalidParameterException} (client fault)
|
|
82
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
83
|
-
* request.</p>
|
|
84
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
85
|
-
* service event messages</a>. </p>
|
|
67
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
86
68
|
*
|
|
87
69
|
* @throws {@link ServerException} (server fault)
|
|
88
70
|
* <p>These errors are usually caused by a server issue.</p>
|
|
89
71
|
*
|
|
90
72
|
* @throws {@link ServiceDeploymentNotFoundException} (client fault)
|
|
91
|
-
* <p>The service deploy ARN that you specified in the <code>StopServiceDeployment</code>
|
|
92
|
-
* doesn't exist. You can use <code>ListServiceDeployments</code> to retrieve the service
|
|
93
|
-
* deployment ARNs.</p>
|
|
73
|
+
* <p>The service deploy ARN that you specified in the <code>StopServiceDeployment</code> doesn't exist. You can use <code>ListServiceDeployments</code> to retrieve the service deployment ARNs.</p>
|
|
94
74
|
*
|
|
95
75
|
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
96
76
|
* <p>The specified task isn't supported in this Region.</p>
|
|
@@ -27,24 +27,7 @@ declare const StopTaskCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Stops a running task. Any tags associated with the task will be deleted.</p>
|
|
31
|
-
* <p>When you call <code>StopTask</code> on a task, the equivalent of <code>docker
|
|
32
|
-
* stop</code> is issued to the containers running in the task. This results in a
|
|
33
|
-
* stop signal value and a default 30-second timeout, after which the
|
|
34
|
-
* <code>SIGKILL</code> value is sent and the containers are forcibly stopped. This
|
|
35
|
-
* signal can be defined in your container image with the <code>STOPSIGNAL</code> instruction
|
|
36
|
-
* and will default to <code>SIGTERM</code>. If the container handles the <code>SIGTERM</code>
|
|
37
|
-
* value gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> value
|
|
38
|
-
* is sent.</p>
|
|
39
|
-
* <p>For Windows containers, POSIX signals do not work and runtime stops the container by
|
|
40
|
-
* sending a <code>CTRL_SHUTDOWN_EVENT</code>. For more information, see <a href="https://github.com/moby/moby/issues/25982">Unable to react to graceful shutdown
|
|
41
|
-
* of (Windows) container #25982</a> on GitHub.</p>
|
|
42
|
-
* <note>
|
|
43
|
-
* <p>The default 30-second timeout can be configured on the Amazon ECS container agent
|
|
44
|
-
* with the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see
|
|
45
|
-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS Container Agent Configuration</a> in the
|
|
46
|
-
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
47
|
-
* </note>
|
|
30
|
+
* <p>Stops a running task. Any tags associated with the task will be deleted.</p> <p>When you call <code>StopTask</code> on a task, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a stop signal value and a default 30-second timeout, after which the <code>SIGKILL</code> value is sent and the containers are forcibly stopped. This signal can be defined in your container image with the <code>STOPSIGNAL</code> instruction and will default to <code>SIGTERM</code>. If the container handles the <code>SIGTERM</code> value gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> value is sent.</p> <p>For Windows containers, POSIX signals do not work and runtime stops the container by sending a <code>CTRL_SHUTDOWN_EVENT</code>. For more information, see <a href="https://github.com/moby/moby/issues/25982">Unable to react to graceful shutdown of (Windows) container #25982</a> on GitHub.</p> <note> <p>The default 30-second timeout can be configured on the Amazon ECS container agent with the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>
|
|
48
31
|
* @example
|
|
49
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
50
33
|
* ```javascript
|
|
@@ -232,18 +215,13 @@ declare const StopTaskCommand_base: {
|
|
|
232
215
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
233
216
|
*
|
|
234
217
|
* @throws {@link ClientException} (client fault)
|
|
235
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
236
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
237
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
218
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
238
219
|
*
|
|
239
220
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
240
221
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
241
222
|
*
|
|
242
223
|
* @throws {@link InvalidParameterException} (client fault)
|
|
243
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
244
|
-
* request.</p>
|
|
245
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
246
|
-
* service event messages</a>. </p>
|
|
224
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
247
225
|
*
|
|
248
226
|
* @throws {@link ServerException} (server fault)
|
|
249
227
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,11 +27,7 @@ declare const SubmitAttachmentStateChangesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <note>
|
|
31
|
-
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use
|
|
32
|
-
* outside of the agent.</p>
|
|
33
|
-
* </note>
|
|
34
|
-
* <p>Sent to acknowledge that an attachment changed states.</p>
|
|
30
|
+
* <note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that an attachment changed states.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -67,15 +63,10 @@ declare const SubmitAttachmentStateChangesCommand_base: {
|
|
|
67
63
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
68
64
|
*
|
|
69
65
|
* @throws {@link ClientException} (client fault)
|
|
70
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
71
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
72
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
66
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
73
67
|
*
|
|
74
68
|
* @throws {@link InvalidParameterException} (client fault)
|
|
75
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
76
|
-
* request.</p>
|
|
77
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
78
|
-
* service event messages</a>. </p>
|
|
69
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
79
70
|
*
|
|
80
71
|
* @throws {@link ServerException} (server fault)
|
|
81
72
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,11 +27,7 @@ declare const SubmitContainerStateChangeCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <note>
|
|
31
|
-
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use
|
|
32
|
-
* outside of the agent.</p>
|
|
33
|
-
* </note>
|
|
34
|
-
* <p>Sent to acknowledge that a container changed states.</p>
|
|
30
|
+
* <note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that a container changed states.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -77,9 +73,7 @@ declare const SubmitContainerStateChangeCommand_base: {
|
|
|
77
73
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
78
74
|
*
|
|
79
75
|
* @throws {@link ClientException} (client fault)
|
|
80
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
81
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
82
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
76
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
83
77
|
*
|
|
84
78
|
* @throws {@link ServerException} (server fault)
|
|
85
79
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,11 +27,7 @@ declare const SubmitTaskStateChangeCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <note>
|
|
31
|
-
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use
|
|
32
|
-
* outside of the agent.</p>
|
|
33
|
-
* </note>
|
|
34
|
-
* <p>Sent to acknowledge that a task changed states.</p>
|
|
30
|
+
* <note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that a task changed states.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -101,15 +97,10 @@ declare const SubmitTaskStateChangeCommand_base: {
|
|
|
101
97
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
102
98
|
*
|
|
103
99
|
* @throws {@link ClientException} (client fault)
|
|
104
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
105
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
106
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
100
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
107
101
|
*
|
|
108
102
|
* @throws {@link InvalidParameterException} (client fault)
|
|
109
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
110
|
-
* request.</p>
|
|
111
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
112
|
-
* service event messages</a>. </p>
|
|
103
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
113
104
|
*
|
|
114
105
|
* @throws {@link ServerException} (server fault)
|
|
115
106
|
* <p>These errors are usually caused by a server issue.</p>
|