@aws-sdk/client-ecs 3.40.0 → 3.45.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/CHANGELOG.md +41 -0
- package/README.md +7 -7
- package/dist-cjs/endpoints.js +9 -0
- package/dist-cjs/models/models_0.js +29 -5
- package/dist-cjs/protocols/Aws_json1_1.js +33 -0
- package/dist-es/endpoints.js +9 -0
- package/dist-es/models/models_0.js +20 -0
- package/dist-es/protocols/Aws_json1_1.js +33 -0
- package/dist-types/ECS.d.ts +147 -152
- package/dist-types/ECSClient.d.ts +7 -7
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +5 -5
- package/dist-types/commands/CreateClusterCommand.d.ts +5 -5
- package/dist-types/commands/CreateServiceCommand.d.ts +52 -51
- package/dist-types/commands/CreateTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAttributesCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +4 -4
- package/dist-types/commands/DeleteClusterCommand.d.ts +5 -6
- package/dist-types/commands/DeleteServiceCommand.d.ts +2 -2
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +8 -7
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +8 -9
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeClustersCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeServicesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTasksCommand.d.ts +1 -1
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +2 -3
- package/dist-types/commands/ExecuteCommandCommand.d.ts +1 -1
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +1 -1
- package/dist-types/commands/ListAttributesCommand.d.ts +4 -4
- package/dist-types/commands/ListClustersCommand.d.ts +1 -1
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +1 -1
- package/dist-types/commands/ListServicesCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +7 -7
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTasksCommand.d.ts +1 -1
- package/dist-types/commands/PutAccountSettingCommand.d.ts +6 -6
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +1 -1
- package/dist-types/commands/PutAttributesCommand.d.ts +3 -3
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +7 -7
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +3 -4
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +2 -2
- package/dist-types/commands/RunTaskCommand.d.ts +6 -6
- package/dist-types/commands/StartTaskCommand.d.ts +1 -1
- package/dist-types/commands/StopTaskCommand.d.ts +1 -1
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +2 -3
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +2 -3
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +2 -3
- package/dist-types/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +1 -1
- package/dist-types/commands/UpdateClusterCommand.d.ts +1 -1
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +4 -4
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +6 -6
- package/dist-types/commands/UpdateServiceCommand.d.ts +16 -16
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +1041 -948
- package/dist-types/ts3.4/models/models_0.d.ts +38 -0
- package/package.json +6 -6
|
@@ -20,7 +20,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -7,12 +7,12 @@ export interface ListTaskDefinitionFamiliesCommandInput extends ListTaskDefiniti
|
|
|
7
7
|
export interface ListTaskDefinitionFamiliesCommandOutput extends ListTaskDefinitionFamiliesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns a list of task definition families that are registered to your account
|
|
11
|
-
*
|
|
12
|
-
* definition revisions
|
|
13
|
-
* <p>You can filter out task definition families that
|
|
14
|
-
*
|
|
15
|
-
*
|
|
10
|
+
* <p>Returns a list of task definition families that are registered to your account. This
|
|
11
|
+
* list includes task definition families that no longer have any <code>ACTIVE</code> task
|
|
12
|
+
* definition revisions.</p>
|
|
13
|
+
* <p>You can filter out task definition families that don't contain any <code>ACTIVE</code>
|
|
14
|
+
* task definition revisions by setting the <code>status</code> parameter to
|
|
15
|
+
* <code>ACTIVE</code>. You can also filter the results with the
|
|
16
16
|
* <code>familyPrefix</code> parameter.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -26,7 +26,7 @@ export interface ListTaskDefinitionFamiliesCommandOutput extends ListTaskDefinit
|
|
|
26
26
|
*
|
|
27
27
|
* @see {@link ListTaskDefinitionFamiliesCommandInput} for command's `input` shape.
|
|
28
28
|
* @see {@link ListTaskDefinitionFamiliesCommandOutput} for command's `response` shape.
|
|
29
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
29
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
30
30
|
*
|
|
31
31
|
*/
|
|
32
32
|
export declare class ListTaskDefinitionFamiliesCommand extends $Command<ListTaskDefinitionFamiliesCommandInput, ListTaskDefinitionFamiliesCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -22,7 +22,7 @@ export interface ListTaskDefinitionsCommandOutput extends ListTaskDefinitionsRes
|
|
|
22
22
|
*
|
|
23
23
|
* @see {@link ListTaskDefinitionsCommandInput} for command's `input` shape.
|
|
24
24
|
* @see {@link ListTaskDefinitionsCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
25
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
28
|
export declare class ListTaskDefinitionsCommand extends $Command<ListTaskDefinitionsCommandInput, ListTaskDefinitionsCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -24,7 +24,7 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea
|
|
|
24
24
|
*
|
|
25
25
|
* @see {@link ListTasksCommandInput} for command's `input` shape.
|
|
26
26
|
* @see {@link ListTasksCommandOutput} for command's `response` shape.
|
|
27
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
27
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
28
28
|
*
|
|
29
29
|
*/
|
|
30
30
|
export declare class ListTasksCommand extends $Command<ListTasksCommandInput, ListTasksCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -9,16 +9,16 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Modifies an account setting. Account settings are set on a per-Region basis.</p>
|
|
11
11
|
* <p>If you change the account setting for the root user, the default settings for all of
|
|
12
|
-
* the IAM users and roles
|
|
13
|
-
*
|
|
12
|
+
* the IAM users and roles that no individual account setting was specified are reset for.
|
|
13
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html">Account
|
|
14
14
|
* Settings</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
15
15
|
* <p>When <code>serviceLongArnFormat</code>, <code>taskLongArnFormat</code>, or
|
|
16
16
|
* <code>containerInstanceLongArnFormat</code> are specified, the Amazon Resource Name
|
|
17
17
|
* (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or
|
|
18
18
|
* the root user for an account is affected. The opt-in and opt-out account setting must be
|
|
19
|
-
* set for each Amazon ECS resource separately. The ARN and resource ID format of a resource
|
|
20
|
-
*
|
|
21
|
-
*
|
|
19
|
+
* set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is
|
|
20
|
+
* defined by the opt-in status of the IAM user or role that created the resource. You must
|
|
21
|
+
* enable this setting to use Amazon ECS features such as resource tagging.</p>
|
|
22
22
|
* <p>When <code>awsvpcTrunking</code> is specified, the elastic network interface (ENI)
|
|
23
23
|
* limit for any new container instances that support the feature is changed. If
|
|
24
24
|
* <code>awsvpcTrunking</code> is enabled, any new container instances that support the
|
|
@@ -43,7 +43,7 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons
|
|
|
43
43
|
*
|
|
44
44
|
* @see {@link PutAccountSettingCommandInput} for command's `input` shape.
|
|
45
45
|
* @see {@link PutAccountSettingCommandOutput} for command's `response` shape.
|
|
46
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
46
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
47
47
|
*
|
|
48
48
|
*/
|
|
49
49
|
export declare class PutAccountSettingCommand extends $Command<PutAccountSettingCommandInput, PutAccountSettingCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -22,7 +22,7 @@ export interface PutAccountSettingDefaultCommandOutput extends PutAccountSetting
|
|
|
22
22
|
*
|
|
23
23
|
* @see {@link PutAccountSettingDefaultCommandInput} for command's `input` shape.
|
|
24
24
|
* @see {@link PutAccountSettingDefaultCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
25
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
28
|
export declare class PutAccountSettingDefaultCommand extends $Command<PutAccountSettingDefaultCommandInput, PutAccountSettingDefaultCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -7,8 +7,8 @@ export interface PutAttributesCommandInput extends PutAttributesRequest {
|
|
|
7
7
|
export interface PutAttributesCommandOutput extends PutAttributesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Create or update an attribute on an Amazon ECS resource. If the attribute
|
|
11
|
-
* it
|
|
10
|
+
* <p>Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist,
|
|
11
|
+
* it's created. If the attribute exists, its value is replaced with the specified value.
|
|
12
12
|
* To delete an attribute, use <a>DeleteAttributes</a>. For more information,
|
|
13
13
|
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes">Attributes</a> in the
|
|
14
14
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
@@ -24,7 +24,7 @@ export interface PutAttributesCommandOutput extends PutAttributesResponse, __Met
|
|
|
24
24
|
*
|
|
25
25
|
* @see {@link PutAttributesCommandInput} for command's `input` shape.
|
|
26
26
|
* @see {@link PutAttributesCommandOutput} for command's `response` shape.
|
|
27
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
27
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
28
28
|
*
|
|
29
29
|
*/
|
|
30
30
|
export declare class PutAttributesCommand extends $Command<PutAttributesCommandInput, PutAttributesCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -12,14 +12,14 @@ export interface PutClusterCapacityProvidersCommandOutput extends PutClusterCapa
|
|
|
12
12
|
* <p>You must specify both the available capacity providers and a default capacity provider
|
|
13
13
|
* strategy for the cluster. If the specified cluster has existing capacity providers
|
|
14
14
|
* associated with it, you must specify all existing capacity providers in addition to any
|
|
15
|
-
* new ones you want to add. Any existing capacity providers associated with a
|
|
16
|
-
* are omitted from a <a>PutClusterCapacityProviders</a> API call
|
|
17
|
-
* disassociated with the cluster. You can only disassociate an existing capacity
|
|
18
|
-
* from a cluster if it's not being used by any existing tasks.</p>
|
|
15
|
+
* new ones you want to add. Any existing capacity providers that are associated with a
|
|
16
|
+
* cluster that are omitted from a <a>PutClusterCapacityProviders</a> API call
|
|
17
|
+
* will be disassociated with the cluster. You can only disassociate an existing capacity
|
|
18
|
+
* provider from a cluster if it's not being used by any existing tasks.</p>
|
|
19
19
|
* <p>When creating a service or running a task on a cluster, if no capacity provider or
|
|
20
20
|
* launch type is specified, then the cluster's default capacity provider strategy is used.
|
|
21
|
-
*
|
|
22
|
-
*
|
|
21
|
+
* We recommend that you define a default capacity provider strategy for your cluster.
|
|
22
|
+
* However, you must specify an empty array (<code>[]</code>) to bypass defining a default
|
|
23
23
|
* strategy.</p>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -33,7 +33,7 @@ export interface PutClusterCapacityProvidersCommandOutput extends PutClusterCapa
|
|
|
33
33
|
*
|
|
34
34
|
* @see {@link PutClusterCapacityProvidersCommandInput} for command's `input` shape.
|
|
35
35
|
* @see {@link PutClusterCapacityProvidersCommandOutput} for command's `response` shape.
|
|
36
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
36
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
37
37
|
*
|
|
38
38
|
*/
|
|
39
39
|
export declare class PutClusterCapacityProvidersCommand extends $Command<PutClusterCapacityProvidersCommandInput, PutClusterCapacityProvidersCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -10,9 +10,8 @@ export interface RegisterContainerInstanceCommandOutput extends RegisterContaine
|
|
|
10
10
|
* <note>
|
|
11
11
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
12
12
|
* </note>
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* on.</p>
|
|
13
|
+
* <p>Registers an EC2 instance into the specified cluster. This instance becomes available
|
|
14
|
+
* to place containers on.</p>
|
|
16
15
|
* @example
|
|
17
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
17
|
* ```javascript
|
|
@@ -25,7 +24,7 @@ export interface RegisterContainerInstanceCommandOutput extends RegisterContaine
|
|
|
25
24
|
*
|
|
26
25
|
* @see {@link RegisterContainerInstanceCommandInput} for command's `input` shape.
|
|
27
26
|
* @see {@link RegisterContainerInstanceCommandOutput} for command's `response` shape.
|
|
28
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
27
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
29
28
|
*
|
|
30
29
|
*/
|
|
31
30
|
export declare class RegisterContainerInstanceCommand extends $Command<RegisterContainerInstanceCommandInput, RegisterContainerInstanceCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -15,7 +15,7 @@ export interface RegisterTaskDefinitionCommandOutput extends RegisterTaskDefinit
|
|
|
15
15
|
* <p>You can specify an IAM role for your task with the <code>taskRoleArn</code> parameter.
|
|
16
16
|
* When you specify an IAM role for a task, its containers can then use the latest versions
|
|
17
17
|
* of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in
|
|
18
|
-
* the IAM policy associated with the role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM
|
|
18
|
+
* the IAM 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
|
|
19
19
|
* Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
20
20
|
* <p>You can specify a Docker networking mode for the containers in your task definition
|
|
21
21
|
* with the <code>networkMode</code> parameter. The available network modes correspond to
|
|
@@ -37,7 +37,7 @@ export interface RegisterTaskDefinitionCommandOutput extends RegisterTaskDefinit
|
|
|
37
37
|
*
|
|
38
38
|
* @see {@link RegisterTaskDefinitionCommandInput} for command's `input` shape.
|
|
39
39
|
* @see {@link RegisterTaskDefinitionCommandOutput} for command's `response` shape.
|
|
40
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
40
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
41
41
|
*
|
|
42
42
|
*/
|
|
43
43
|
export declare class RegisterTaskDefinitionCommand extends $Command<RegisterTaskDefinitionCommandInput, RegisterTaskDefinitionCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -14,11 +14,11 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer
|
|
|
14
14
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
15
15
|
* <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or
|
|
16
16
|
* place tasks manually on specific container instances.</p>
|
|
17
|
-
* <p>The Amazon ECS API follows an eventual consistency model
|
|
18
|
-
* the system supporting the API. This means that the result of an API command
|
|
19
|
-
* affects your Amazon ECS resources might not be immediately visible to all
|
|
20
|
-
* you run. Keep this in mind when you carry out an API command that
|
|
21
|
-
* previous API command.</p>
|
|
17
|
+
* <p>The Amazon ECS API follows an eventual consistency model. This is because the distributed
|
|
18
|
+
* nature of the system supporting the API. This means that the result of an API command
|
|
19
|
+
* you run that affects your Amazon ECS resources might not be immediately visible to all
|
|
20
|
+
* subsequent commands you run. Keep this in mind when you carry out an API command that
|
|
21
|
+
* immediately follows a previous API command.</p>
|
|
22
22
|
* <p>To manage eventual consistency, you can do the following:</p>
|
|
23
23
|
* <ul>
|
|
24
24
|
* <li>
|
|
@@ -48,7 +48,7 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer
|
|
|
48
48
|
*
|
|
49
49
|
* @see {@link RunTaskCommandInput} for command's `input` shape.
|
|
50
50
|
* @see {@link RunTaskCommandOutput} for command's `response` shape.
|
|
51
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
51
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
52
52
|
*
|
|
53
53
|
*/
|
|
54
54
|
export declare class RunTaskCommand extends $Command<RunTaskCommandInput, RunTaskCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -24,7 +24,7 @@ export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBea
|
|
|
24
24
|
*
|
|
25
25
|
* @see {@link StartTaskCommandInput} for command's `input` shape.
|
|
26
26
|
* @see {@link StartTaskCommandOutput} for command's `response` shape.
|
|
27
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
27
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
28
28
|
*
|
|
29
29
|
*/
|
|
30
30
|
export declare class StartTaskCommand extends $Command<StartTaskCommandInput, StartTaskCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -32,7 +32,7 @@ export interface StopTaskCommandOutput extends StopTaskResponse, __MetadataBeare
|
|
|
32
32
|
*
|
|
33
33
|
* @see {@link StopTaskCommandInput} for command's `input` shape.
|
|
34
34
|
* @see {@link StopTaskCommandOutput} for command's `response` shape.
|
|
35
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
35
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
36
36
|
*
|
|
37
37
|
*/
|
|
38
38
|
export declare class StopTaskCommand extends $Command<StopTaskCommandInput, StopTaskCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -10,8 +10,7 @@ export interface SubmitAttachmentStateChangesCommandOutput extends SubmitAttachm
|
|
|
10
10
|
* <note>
|
|
11
11
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
12
12
|
* </note>
|
|
13
|
-
*
|
|
14
|
-
* acknowledge that an attachment changed states.</p>
|
|
13
|
+
* <p>Sent to acknowledge that an attachment changed states.</p>
|
|
15
14
|
* @example
|
|
16
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
16
|
* ```javascript
|
|
@@ -24,7 +23,7 @@ export interface SubmitAttachmentStateChangesCommandOutput extends SubmitAttachm
|
|
|
24
23
|
*
|
|
25
24
|
* @see {@link SubmitAttachmentStateChangesCommandInput} for command's `input` shape.
|
|
26
25
|
* @see {@link SubmitAttachmentStateChangesCommandOutput} for command's `response` shape.
|
|
27
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
26
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
28
27
|
*
|
|
29
28
|
*/
|
|
30
29
|
export declare class SubmitAttachmentStateChangesCommand extends $Command<SubmitAttachmentStateChangesCommandInput, SubmitAttachmentStateChangesCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -10,8 +10,7 @@ export interface SubmitContainerStateChangeCommandOutput extends SubmitContainer
|
|
|
10
10
|
* <note>
|
|
11
11
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
12
12
|
* </note>
|
|
13
|
-
*
|
|
14
|
-
* acknowledge that a container changed states.</p>
|
|
13
|
+
* <p>Sent to acknowledge that a container changed states.</p>
|
|
15
14
|
* @example
|
|
16
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
16
|
* ```javascript
|
|
@@ -24,7 +23,7 @@ export interface SubmitContainerStateChangeCommandOutput extends SubmitContainer
|
|
|
24
23
|
*
|
|
25
24
|
* @see {@link SubmitContainerStateChangeCommandInput} for command's `input` shape.
|
|
26
25
|
* @see {@link SubmitContainerStateChangeCommandOutput} for command's `response` shape.
|
|
27
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
26
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
28
27
|
*
|
|
29
28
|
*/
|
|
30
29
|
export declare class SubmitContainerStateChangeCommand extends $Command<SubmitContainerStateChangeCommandInput, SubmitContainerStateChangeCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -10,8 +10,7 @@ export interface SubmitTaskStateChangeCommandOutput extends SubmitTaskStateChang
|
|
|
10
10
|
* <note>
|
|
11
11
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
12
12
|
* </note>
|
|
13
|
-
*
|
|
14
|
-
* that a task changed states.</p>
|
|
13
|
+
* <p>Sent to acknowledge that a task changed states.</p>
|
|
15
14
|
* @example
|
|
16
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
16
|
* ```javascript
|
|
@@ -24,7 +23,7 @@ export interface SubmitTaskStateChangeCommandOutput extends SubmitTaskStateChang
|
|
|
24
23
|
*
|
|
25
24
|
* @see {@link SubmitTaskStateChangeCommandInput} for command's `input` shape.
|
|
26
25
|
* @see {@link SubmitTaskStateChangeCommandOutput} for command's `response` shape.
|
|
27
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
26
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
28
27
|
*
|
|
29
28
|
*/
|
|
30
29
|
export declare class SubmitTaskStateChangeCommand extends $Command<SubmitTaskStateChangeCommandInput, SubmitTaskStateChangeCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -8,8 +8,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Associates the specified tags to a resource with the specified
|
|
11
|
-
* <code>resourceArn</code>. If existing tags on a resource
|
|
12
|
-
* request parameters, they
|
|
11
|
+
* <code>resourceArn</code>. If existing tags on a resource aren't specified in the
|
|
12
|
+
* request parameters, they aren't changed. When a resource is deleted, the tags that are
|
|
13
13
|
* associated with that resource are deleted as well.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,7 +23,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
23
23
|
*
|
|
24
24
|
* @see {@link TagResourceCommandInput} for command's `input` shape.
|
|
25
25
|
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
26
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
26
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
27
27
|
*
|
|
28
28
|
*/
|
|
29
29
|
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link UntagResourceCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface UpdateCapacityProviderCommandOutput extends UpdateCapacityProvi
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link UpdateCapacityProviderCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link UpdateCapacityProviderCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class UpdateCapacityProviderCommand extends $Command<UpdateCapacityProviderCommandInput, UpdateCapacityProviderCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface UpdateClusterCommandOutput extends UpdateClusterResponse, __Met
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link UpdateClusterCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link UpdateClusterCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class UpdateClusterCommand extends $Command<UpdateClusterCommandInput, UpdateClusterCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface UpdateClusterSettingsCommandOutput extends UpdateClusterSetting
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link UpdateClusterSettingsCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link UpdateClusterSettingsCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class UpdateClusterSettingsCommand extends $Command<UpdateClusterSettingsCommandInput, UpdateClusterSettingsCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -8,14 +8,14 @@ export interface UpdateContainerAgentCommandOutput extends UpdateContainerAgentR
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Updates the Amazon ECS container agent on a specified container instance. Updating the
|
|
11
|
-
* Amazon ECS container agent
|
|
11
|
+
* Amazon ECS container agent doesn't interrupt running tasks or services on the container
|
|
12
12
|
* instance. The process for updating the agent differs depending on whether your container
|
|
13
13
|
* instance was launched with the Amazon ECS-optimized AMI or another operating system.</p>
|
|
14
14
|
* <note>
|
|
15
15
|
* <p>The <code>UpdateContainerAgent</code> API isn't supported for container instances
|
|
16
16
|
* using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,
|
|
17
|
-
* you can update the <code>ecs-init</code> package
|
|
18
|
-
*
|
|
17
|
+
* you can update the <code>ecs-init</code> package. This updates the agent. For more
|
|
18
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html">Updating the
|
|
19
19
|
* Amazon ECS container agent</a> in the
|
|
20
20
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
21
21
|
* </note>
|
|
@@ -35,7 +35,7 @@ export interface UpdateContainerAgentCommandOutput extends UpdateContainerAgentR
|
|
|
35
35
|
*
|
|
36
36
|
* @see {@link UpdateContainerAgentCommandInput} for command's `input` shape.
|
|
37
37
|
* @see {@link UpdateContainerAgentCommandOutput} for command's `response` shape.
|
|
38
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
38
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
39
39
|
*
|
|
40
40
|
*/
|
|
41
41
|
export declare class UpdateContainerAgentCommand extends $Command<UpdateContainerAgentCommandInput, UpdateContainerAgentCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -13,7 +13,7 @@ export interface UpdateContainerInstancesStateCommandOutput extends UpdateContai
|
|
|
13
13
|
* from a cluster, for example to perform system updates, update the Docker daemon, or
|
|
14
14
|
* scale down the cluster size.</p>
|
|
15
15
|
* <important>
|
|
16
|
-
* <p>A container instance
|
|
16
|
+
* <p>A container instance can't be changed to <code>DRAINING</code> until it has
|
|
17
17
|
* reached an <code>ACTIVE</code> status. If the instance is in any other status, an
|
|
18
18
|
* error will be received.</p>
|
|
19
19
|
* </important>
|
|
@@ -34,14 +34,14 @@ export interface UpdateContainerInstancesStateCommandOutput extends UpdateContai
|
|
|
34
34
|
* scheduler to stop two existing tasks before starting two new tasks. If the
|
|
35
35
|
* minimum is 100%, the service scheduler can't remove existing tasks until the
|
|
36
36
|
* replacement tasks are considered healthy. Tasks for services that do not use a
|
|
37
|
-
* load balancer are considered healthy if they
|
|
37
|
+
* load balancer are considered healthy if they're in the <code>RUNNING</code>
|
|
38
38
|
* state. Tasks for services that use a load balancer are considered healthy if
|
|
39
|
-
* they
|
|
39
|
+
* they're in the <code>RUNNING</code> state and the container instance they're
|
|
40
40
|
* hosted on is reported as healthy by the load balancer.</p>
|
|
41
41
|
* </li>
|
|
42
42
|
* <li>
|
|
43
43
|
* <p>The <code>maximumPercent</code> parameter represents an upper limit on the
|
|
44
|
-
* number of running tasks during task replacement
|
|
44
|
+
* number of running tasks during task replacement. You can use this to define the
|
|
45
45
|
* replacement batch size. For example, if <code>desiredCount</code> is four tasks,
|
|
46
46
|
* a maximum of 200% starts four new tasks before stopping the four tasks to be
|
|
47
47
|
* drained, provided that the cluster resources required to do this are available.
|
|
@@ -50,7 +50,7 @@ export interface UpdateContainerInstancesStateCommandOutput extends UpdateContai
|
|
|
50
50
|
* </li>
|
|
51
51
|
* </ul>
|
|
52
52
|
* <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service
|
|
53
|
-
*
|
|
53
|
+
* aren't affected. You must wait for them to finish or stop them manually.</p>
|
|
54
54
|
* <p>A container instance has completed draining when it has no more <code>RUNNING</code>
|
|
55
55
|
* tasks. You can verify this using <a>ListTasks</a>.</p>
|
|
56
56
|
* <p>When a container instance has been drained, you can set a container instance to
|
|
@@ -68,7 +68,7 @@ export interface UpdateContainerInstancesStateCommandOutput extends UpdateContai
|
|
|
68
68
|
*
|
|
69
69
|
* @see {@link UpdateContainerInstancesStateCommandInput} for command's `input` shape.
|
|
70
70
|
* @see {@link UpdateContainerInstancesStateCommandOutput} for command's `response` shape.
|
|
71
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
71
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
72
72
|
*
|
|
73
73
|
*/
|
|
74
74
|
export declare class UpdateContainerInstancesStateCommand extends $Command<UpdateContainerInstancesStateCommandInput, UpdateContainerInstancesStateCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -21,12 +21,12 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
21
21
|
* only the desired count, deployment configuration, task placement constraints and
|
|
22
22
|
* strategies, and health check grace period can be updated using this API. If the network
|
|
23
23
|
* configuration, platform version, or task definition need to be updated, a new CodeDeploy
|
|
24
|
-
* deployment
|
|
24
|
+
* deployment is created. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a> in the <i>CodeDeploy API Reference</i>.</p>
|
|
25
25
|
* <p>For services using an external deployment controller, you can update only the desired
|
|
26
26
|
* count, task placement constraints and strategies, and health check grace period using
|
|
27
27
|
* this API. If the launch type, load balancer, network configuration, platform version, or
|
|
28
|
-
* task definition need to be updated,
|
|
29
|
-
*
|
|
28
|
+
* task definition need to be updated, create a new task set. For more information, see
|
|
29
|
+
* <a>CreateTaskSet</a>.</p>
|
|
30
30
|
* <p>You can add to or subtract from the number of instantiations of a task definition in a
|
|
31
31
|
* service by specifying the cluster that the service is running in and a new
|
|
32
32
|
* <code>desiredCount</code> parameter.</p>
|
|
@@ -36,7 +36,7 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
36
36
|
* configuration) to determine the deployment strategy.</p>
|
|
37
37
|
* <note>
|
|
38
38
|
* <p>If your updated Docker image uses the same tag as what is in the existing task
|
|
39
|
-
* definition for your service (for example, <code>my_image:latest</code>), you
|
|
39
|
+
* definition for your service (for example, <code>my_image:latest</code>), you don't
|
|
40
40
|
* need to create a new revision of your task definition. You can update the service
|
|
41
41
|
* using the <code>forceNewDeployment</code> option. The new tasks launched by the
|
|
42
42
|
* deployment pull the current image/tag combination from your repository when they
|
|
@@ -52,15 +52,15 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
52
52
|
* <code>desiredCount</code> temporarily during a deployment. For example, if
|
|
53
53
|
* <code>desiredCount</code> is four tasks, a minimum of 50% allows the
|
|
54
54
|
* scheduler to stop two existing tasks before starting two new tasks. Tasks for
|
|
55
|
-
* services that
|
|
56
|
-
*
|
|
57
|
-
* considered healthy if they
|
|
58
|
-
* container instance they
|
|
55
|
+
* services that don't use a load balancer are considered healthy if they're in the
|
|
56
|
+
* <code>RUNNING</code> state. Tasks for services that use a load balancer are
|
|
57
|
+
* considered healthy if they're in the <code>RUNNING</code> state and the
|
|
58
|
+
* container instance they're hosted on is reported as healthy by the load
|
|
59
59
|
* balancer.</p>
|
|
60
60
|
* </li>
|
|
61
61
|
* <li>
|
|
62
62
|
* <p>The <code>maximumPercent</code> parameter represents an upper limit on the
|
|
63
|
-
* number of running tasks during a deployment
|
|
63
|
+
* number of running tasks during a deployment. You can use it to define the
|
|
64
64
|
* deployment batch size. For example, if <code>desiredCount</code> is four tasks,
|
|
65
65
|
* a maximum of 200% starts four new tasks before stopping the four older tasks
|
|
66
66
|
* (provided that the cluster resources required to do this are available).</p>
|
|
@@ -68,22 +68,22 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
68
68
|
* </ul>
|
|
69
69
|
* <p>When <a>UpdateService</a> stops a task during a deployment, the equivalent
|
|
70
70
|
* of <code>docker stop</code> is issued to the containers running in the task. This
|
|
71
|
-
* results in a <code>SIGTERM</code> and a 30-second timeout
|
|
71
|
+
* results in a <code>SIGTERM</code> and a 30-second timeout. After this,
|
|
72
72
|
* <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the
|
|
73
73
|
* container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from
|
|
74
74
|
* receiving it, no <code>SIGKILL</code> is sent.</p>
|
|
75
75
|
* <p>When the service scheduler launches new tasks, it determines task placement in your
|
|
76
|
-
* cluster with the following logic
|
|
76
|
+
* cluster with the following logic.</p>
|
|
77
77
|
* <ul>
|
|
78
78
|
* <li>
|
|
79
79
|
* <p>Determine which of the container instances in your cluster can support your
|
|
80
|
-
* service's task definition
|
|
81
|
-
* ports, and container instance attributes
|
|
80
|
+
* service's task definition. For example, they have the required CPU, memory,
|
|
81
|
+
* ports, and container instance attributes.</p>
|
|
82
82
|
* </li>
|
|
83
83
|
* <li>
|
|
84
84
|
* <p>By default, the service scheduler attempts to balance tasks across
|
|
85
|
-
* Availability Zones in this manner
|
|
86
|
-
* strategy
|
|
85
|
+
* Availability Zones in this manner even though you can choose a different
|
|
86
|
+
* placement strategy.</p>
|
|
87
87
|
* <ul>
|
|
88
88
|
* <li>
|
|
89
89
|
* <p>Sort the valid container instances by the fewest number of running
|
|
@@ -128,7 +128,7 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
128
128
|
*
|
|
129
129
|
* @see {@link UpdateServiceCommandInput} for command's `input` shape.
|
|
130
130
|
* @see {@link UpdateServiceCommandOutput} for command's `response` shape.
|
|
131
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
131
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
132
132
|
*
|
|
133
133
|
*/
|
|
134
134
|
export declare class UpdateServiceCommand extends $Command<UpdateServiceCommandInput, UpdateServiceCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -24,7 +24,7 @@ export interface UpdateServicePrimaryTaskSetCommandOutput extends UpdateServiceP
|
|
|
24
24
|
*
|
|
25
25
|
* @see {@link UpdateServicePrimaryTaskSetCommandInput} for command's `input` shape.
|
|
26
26
|
* @see {@link UpdateServicePrimaryTaskSetCommandOutput} for command's `response` shape.
|
|
27
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
27
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
28
28
|
*
|
|
29
29
|
*/
|
|
30
30
|
export declare class UpdateServicePrimaryTaskSetCommand extends $Command<UpdateServicePrimaryTaskSetCommandInput, UpdateServicePrimaryTaskSetCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -22,7 +22,7 @@ export interface UpdateTaskSetCommandOutput extends UpdateTaskSetResponse, __Met
|
|
|
22
22
|
*
|
|
23
23
|
* @see {@link UpdateTaskSetCommandInput} for command's `input` shape.
|
|
24
24
|
* @see {@link UpdateTaskSetCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link ECSClientResolvedConfig | config} for
|
|
25
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
28
|
export declare class UpdateTaskSetCommand extends $Command<UpdateTaskSetCommandInput, UpdateTaskSetCommandOutput, ECSClientResolvedConfig> {
|