@aws-sdk/client-ecs 3.693.0 → 3.696.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 +11 -12
- package/dist-cjs/index.js +10 -2
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +2 -0
- package/dist-types/ECS.d.ts +11 -12
- package/dist-types/ECSClient.d.ts +11 -12
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +17 -22
- package/dist-types/commands/CreateClusterCommand.d.ts +17 -19
- package/dist-types/commands/CreateServiceCommand.d.ts +89 -80
- package/dist-types/commands/CreateTaskSetCommand.d.ts +15 -19
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +9 -12
- package/dist-types/commands/DeleteAttributesCommand.d.ts +2 -4
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +17 -21
- package/dist-types/commands/DeleteClusterCommand.d.ts +23 -27
- package/dist-types/commands/DeleteServiceCommand.d.ts +30 -29
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +24 -28
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +14 -17
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +19 -22
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +24 -26
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +8 -10
- package/dist-types/commands/DescribeClustersCommand.d.ts +8 -10
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +10 -12
- package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +9 -12
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +16 -12
- package/dist-types/commands/DescribeServicesCommand.d.ts +15 -10
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +14 -16
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +13 -17
- package/dist-types/commands/DescribeTasksCommand.d.ts +11 -13
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +7 -8
- package/dist-types/commands/ExecuteCommandCommand.d.ts +19 -23
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +8 -10
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +8 -10
- package/dist-types/commands/ListAttributesCommand.d.ts +6 -8
- package/dist-types/commands/ListClustersCommand.d.ts +8 -10
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +12 -13
- package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +9 -12
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +12 -15
- package/dist-types/commands/ListServicesCommand.d.ts +10 -12
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -10
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +13 -17
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +11 -13
- package/dist-types/commands/ListTasksCommand.d.ts +12 -15
- package/dist-types/commands/PutAccountSettingCommand.d.ts +11 -14
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +10 -12
- package/dist-types/commands/PutAttributesCommand.d.ts +7 -11
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +24 -29
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +10 -12
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +23 -23
- package/dist-types/commands/RunTaskCommand.d.ts +33 -37
- package/dist-types/commands/StartTaskCommand.d.ts +16 -16
- package/dist-types/commands/StopTaskCommand.d.ts +18 -22
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +8 -10
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +7 -8
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +8 -10
- package/dist-types/commands/TagResourceCommand.d.ts +11 -14
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -10
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +9 -11
- package/dist-types/commands/UpdateClusterCommand.d.ts +8 -10
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +8 -10
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +33 -37
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +42 -48
- package/dist-types/commands/UpdateServiceCommand.d.ts +105 -101
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +15 -20
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +20 -25
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +15 -19
- package/dist-types/index.d.ts +11 -12
- package/dist-types/models/models_0.d.ts +2882 -3340
- package/dist-types/models/models_1.d.ts +166 -152
- package/dist-types/ts3.4/commands/UpdateCapacityProviderCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +15 -7
- package/dist-types/ts3.4/models/models_1.d.ts +11 -0
- package/package.json +36 -36
package/README.md
CHANGED
|
@@ -8,18 +8,17 @@ AWS SDK for JavaScript ECS Client for Node.js, Browser and React Native.
|
|
|
8
8
|
|
|
9
9
|
<fullname>Amazon Elastic Container Service</fullname>
|
|
10
10
|
|
|
11
|
-
<p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
You also don't need to worry about scaling your management infrastructure. </p>
|
|
11
|
+
<p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,
|
|
12
|
+
stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's
|
|
13
|
+
managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your
|
|
14
|
+
tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p>
|
|
15
|
+
<p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes
|
|
16
|
+
it easy to get the state of your cluster from a centralized service, and gives you access to many
|
|
17
|
+
familiar Amazon EC2 features.</p>
|
|
18
|
+
<p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource
|
|
19
|
+
needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your
|
|
20
|
+
own cluster management and configuration management systems. You also don't need to worry about scaling
|
|
21
|
+
your management infrastructure. </p>
|
|
23
22
|
|
|
24
23
|
## Installing
|
|
25
24
|
|
package/dist-cjs/index.js
CHANGED
|
@@ -175,6 +175,7 @@ __export(src_exports, {
|
|
|
175
175
|
UpdateServicePrimaryTaskSetCommand: () => UpdateServicePrimaryTaskSetCommand,
|
|
176
176
|
UpdateTaskProtectionCommand: () => UpdateTaskProtectionCommand,
|
|
177
177
|
UpdateTaskSetCommand: () => UpdateTaskSetCommand,
|
|
178
|
+
VersionConsistency: () => VersionConsistency,
|
|
178
179
|
__Client: () => import_smithy_client.Client,
|
|
179
180
|
paginateListAccountSettings: () => paginateListAccountSettings,
|
|
180
181
|
paginateListAttributes: () => paginateListAttributes,
|
|
@@ -826,6 +827,10 @@ var UlimitName = {
|
|
|
826
827
|
SIGPENDING: "sigpending",
|
|
827
828
|
STACK: "stack"
|
|
828
829
|
};
|
|
830
|
+
var VersionConsistency = {
|
|
831
|
+
DISABLED: "disabled",
|
|
832
|
+
ENABLED: "enabled"
|
|
833
|
+
};
|
|
829
834
|
var IpcMode = {
|
|
830
835
|
HOST: "host",
|
|
831
836
|
NONE: "none",
|
|
@@ -2808,7 +2813,8 @@ var de_Deployment = /* @__PURE__ */ __name((output, context) => {
|
|
|
2808
2813
|
status: import_smithy_client.expectString,
|
|
2809
2814
|
taskDefinition: import_smithy_client.expectString,
|
|
2810
2815
|
updatedAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
|
|
2811
|
-
volumeConfigurations: import_smithy_client._json
|
|
2816
|
+
volumeConfigurations: import_smithy_client._json,
|
|
2817
|
+
vpcLatticeConfigurations: import_smithy_client._json
|
|
2812
2818
|
});
|
|
2813
2819
|
}, "de_Deployment");
|
|
2814
2820
|
var de_Deployments = /* @__PURE__ */ __name((output, context) => {
|
|
@@ -3079,7 +3085,8 @@ var de_ServiceRevision = /* @__PURE__ */ __name((output, context) => {
|
|
|
3079
3085
|
serviceRegistries: import_smithy_client._json,
|
|
3080
3086
|
serviceRevisionArn: import_smithy_client.expectString,
|
|
3081
3087
|
taskDefinition: import_smithy_client.expectString,
|
|
3082
|
-
volumeConfigurations: import_smithy_client._json
|
|
3088
|
+
volumeConfigurations: import_smithy_client._json,
|
|
3089
|
+
vpcLatticeConfigurations: import_smithy_client._json
|
|
3083
3090
|
});
|
|
3084
3091
|
}, "de_ServiceRevision");
|
|
3085
3092
|
var de_ServiceRevisions = /* @__PURE__ */ __name((output, context) => {
|
|
@@ -4585,6 +4592,7 @@ var waitUntilTasksStopped = /* @__PURE__ */ __name(async (params, input) => {
|
|
|
4585
4592
|
TransportProtocol,
|
|
4586
4593
|
ResourceType,
|
|
4587
4594
|
UlimitName,
|
|
4595
|
+
VersionConsistency,
|
|
4588
4596
|
IpcMode,
|
|
4589
4597
|
NetworkMode,
|
|
4590
4598
|
PidMode,
|
|
@@ -1681,6 +1681,7 @@ const de_Deployment = (output, context) => {
|
|
|
1681
1681
|
taskDefinition: __expectString,
|
|
1682
1682
|
updatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1683
1683
|
volumeConfigurations: _json,
|
|
1684
|
+
vpcLatticeConfigurations: _json,
|
|
1684
1685
|
});
|
|
1685
1686
|
};
|
|
1686
1687
|
const de_Deployments = (output, context) => {
|
|
@@ -1968,6 +1969,7 @@ const de_ServiceRevision = (output, context) => {
|
|
|
1968
1969
|
serviceRevisionArn: __expectString,
|
|
1969
1970
|
taskDefinition: __expectString,
|
|
1970
1971
|
volumeConfigurations: _json,
|
|
1972
|
+
vpcLatticeConfigurations: _json,
|
|
1971
1973
|
});
|
|
1972
1974
|
};
|
|
1973
1975
|
const de_ServiceRevisions = (output, context) => {
|
package/dist-types/ECS.d.ts
CHANGED
|
@@ -431,18 +431,17 @@ export interface ECS {
|
|
|
431
431
|
}
|
|
432
432
|
/**
|
|
433
433
|
* <fullname>Amazon Elastic Container Service</fullname>
|
|
434
|
-
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
|
-
*
|
|
438
|
-
*
|
|
439
|
-
*
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
* You also don't need to worry about scaling your management infrastructure. </p>
|
|
434
|
+
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,
|
|
435
|
+
* stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's
|
|
436
|
+
* managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your
|
|
437
|
+
* tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p>
|
|
438
|
+
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes
|
|
439
|
+
* it easy to get the state of your cluster from a centralized service, and gives you access to many
|
|
440
|
+
* familiar Amazon EC2 features.</p>
|
|
441
|
+
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource
|
|
442
|
+
* needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your
|
|
443
|
+
* own cluster management and configuration management systems. You also don't need to worry about scaling
|
|
444
|
+
* your management infrastructure. </p>
|
|
446
445
|
* @public
|
|
447
446
|
*/
|
|
448
447
|
export declare class ECS extends ECSClient implements ECS {
|
|
@@ -211,18 +211,17 @@ export interface ECSClientResolvedConfig extends ECSClientResolvedConfigType {
|
|
|
211
211
|
}
|
|
212
212
|
/**
|
|
213
213
|
* <fullname>Amazon Elastic Container Service</fullname>
|
|
214
|
-
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
|
|
215
|
-
*
|
|
216
|
-
*
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
*
|
|
220
|
-
*
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
* You also don't need to worry about scaling your management infrastructure. </p>
|
|
214
|
+
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run,
|
|
215
|
+
* stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's
|
|
216
|
+
* managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your
|
|
217
|
+
* tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p>
|
|
218
|
+
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes
|
|
219
|
+
* it easy to get the state of your cluster from a centralized service, and gives you access to many
|
|
220
|
+
* familiar Amazon EC2 features.</p>
|
|
221
|
+
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource
|
|
222
|
+
* needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your
|
|
223
|
+
* own cluster management and configuration management systems. You also don't need to worry about scaling
|
|
224
|
+
* your management infrastructure. </p>
|
|
226
225
|
* @public
|
|
227
226
|
*/
|
|
228
227
|
export declare class ECSClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ECSClientResolvedConfig> {
|
|
@@ -27,13 +27,11 @@ declare const CreateCapacityProviderCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* These providers are available to all accounts in the Amazon Web Services Regions that Fargate
|
|
36
|
-
* supports.</p>
|
|
30
|
+
* <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used
|
|
31
|
+
* in capacity provider strategies to facilitate cluster auto scaling.</p>
|
|
32
|
+
* <p>Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use
|
|
33
|
+
* the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers. These providers are
|
|
34
|
+
* available to all accounts in the Amazon Web Services Regions that Fargate supports.</p>
|
|
37
35
|
* @example
|
|
38
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
37
|
* ```javascript
|
|
@@ -100,23 +98,21 @@ declare const CreateCapacityProviderCommand_base: {
|
|
|
100
98
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
101
99
|
*
|
|
102
100
|
* @throws {@link ClientException} (client fault)
|
|
103
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
104
|
-
*
|
|
105
|
-
*
|
|
101
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or
|
|
102
|
+
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
|
|
103
|
+
* be specifying an identifier that isn't valid.</p>
|
|
106
104
|
* <p>The following list includes additional causes for the error:</p>
|
|
107
105
|
* <ul>
|
|
108
106
|
* <li>
|
|
109
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
* service quotas</a>.</p>
|
|
107
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
|
|
108
|
+
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
|
|
109
|
+
* 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
|
|
110
|
+
* quotas</a>.</p>
|
|
114
111
|
* </li>
|
|
115
112
|
* </ul>
|
|
116
113
|
*
|
|
117
114
|
* @throws {@link InvalidParameterException} (client fault)
|
|
118
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
119
|
-
* request.</p>
|
|
115
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
|
|
120
116
|
*
|
|
121
117
|
* @throws {@link LimitExceededException} (client fault)
|
|
122
118
|
* <p>The limit for the resource was exceeded.</p>
|
|
@@ -125,11 +121,10 @@ declare const CreateCapacityProviderCommand_base: {
|
|
|
125
121
|
* <p>These errors are usually caused by a server issue.</p>
|
|
126
122
|
*
|
|
127
123
|
* @throws {@link UpdateInProgressException} (client fault)
|
|
128
|
-
* <p>There's already a current Amazon ECS container agent update in progress on the container
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
* where it stopped previously.</p>
|
|
124
|
+
* <p>There's already a current Amazon ECS container agent update in progress on the container instance that's
|
|
125
|
+
* specified. If the container agent becomes disconnected while it's in a transitional stage, such as
|
|
126
|
+
* <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state.
|
|
127
|
+
* However, when the agent reconnects, it resumes where it stopped previously.</p>
|
|
133
128
|
*
|
|
134
129
|
* @throws {@link ECSServiceException}
|
|
135
130
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
@@ -27,16 +27,16 @@ declare const CreateClusterCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code>
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when
|
|
31
|
+
* you launch your first container instance. However, you can create your own cluster with a unique
|
|
32
|
+
* name.</p>
|
|
33
33
|
* <note>
|
|
34
|
-
* <p>When you call the <a>CreateCluster</a> API operation,
|
|
35
|
-
* create the Amazon ECS service-linked role for your account. This is so that it can
|
|
36
|
-
* required resources in other Amazon Web Services services on your behalf. However, if the user that
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
34
|
+
* <p>When you call the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCluster.html">CreateCluster</a> API operation,
|
|
35
|
+
* Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can
|
|
36
|
+
* manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes
|
|
37
|
+
* the call doesn't have permissions to create the service-linked role, it isn't created. For more
|
|
38
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using service-linked
|
|
39
|
+
* roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
40
40
|
* </note>
|
|
41
41
|
* @example
|
|
42
42
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -174,23 +174,21 @@ declare const CreateClusterCommand_base: {
|
|
|
174
174
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
175
175
|
*
|
|
176
176
|
* @throws {@link ClientException} (client fault)
|
|
177
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
178
|
-
*
|
|
179
|
-
*
|
|
177
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or
|
|
178
|
+
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
|
|
179
|
+
* be specifying an identifier that isn't valid.</p>
|
|
180
180
|
* <p>The following list includes additional causes for the error:</p>
|
|
181
181
|
* <ul>
|
|
182
182
|
* <li>
|
|
183
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
* service quotas</a>.</p>
|
|
183
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
|
|
184
|
+
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
|
|
185
|
+
* 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
|
|
186
|
+
* quotas</a>.</p>
|
|
188
187
|
* </li>
|
|
189
188
|
* </ul>
|
|
190
189
|
*
|
|
191
190
|
* @throws {@link InvalidParameterException} (client fault)
|
|
192
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
193
|
-
* request.</p>
|
|
191
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
|
|
194
192
|
*
|
|
195
193
|
* @throws {@link NamespaceNotFoundException} (client fault)
|
|
196
194
|
* <p>The specified namespace wasn't found.</p>
|
|
@@ -27,92 +27,89 @@ declare const CreateServiceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Runs and maintains your desired number of tasks from a specified task definition. If
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* service, see the <a>UpdateService</a> action.</p>
|
|
30
|
+
* <p>Runs and maintains your desired number of tasks from a specified task definition. If the number of
|
|
31
|
+
* tasks running in a service drops below the <code>desiredCount</code>, Amazon ECS runs another copy of the
|
|
32
|
+
* task in the specified cluster. To update an existing service, use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
|
|
34
33
|
* <note>
|
|
35
34
|
* <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>
|
|
36
35
|
* </note>
|
|
37
36
|
* <note>
|
|
38
37
|
* <p>Amazon Elastic Inference (EI) is no longer available to customers.</p>
|
|
39
38
|
* </note>
|
|
40
|
-
* <p>In addition to maintaining the desired count of tasks in your service, you can
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
* <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
|
|
45
|
-
*
|
|
46
|
-
* service
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
* healthy by the load balancer.</p>
|
|
39
|
+
* <p>In addition to maintaining the desired count of tasks in your service, you can optionally run your
|
|
40
|
+
* service behind one or more load balancers. The load balancers distribute traffic across the tasks that
|
|
41
|
+
* are associated with the service. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load
|
|
42
|
+
* balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
43
|
+
* <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a
|
|
44
|
+
* service. <code>volumeConfigurations</code> is only supported for REPLICA service and not DAEMON
|
|
45
|
+
* service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS
|
|
46
|
+
* volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
47
|
+
* <p>Tasks for services that don't use a load balancer are considered healthy if they're in the
|
|
48
|
+
* <code>RUNNING</code> state. Tasks for services that use a load balancer are considered healthy if
|
|
49
|
+
* they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer.</p>
|
|
51
50
|
* <p>There are two service scheduler strategies available:</p>
|
|
52
51
|
* <ul>
|
|
53
52
|
* <li>
|
|
54
53
|
* <p>
|
|
55
|
-
* <code>REPLICA</code> - The replica scheduling strategy places and
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* placement
|
|
59
|
-
*
|
|
54
|
+
* <code>REPLICA</code> - The replica scheduling strategy places and maintains your
|
|
55
|
+
* desired number of tasks across your cluster. By default, the service scheduler spreads tasks
|
|
56
|
+
* across Availability Zones. You can use task placement strategies and constraints to customize
|
|
57
|
+
* task placement decisions. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service
|
|
58
|
+
* scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
60
59
|
* </li>
|
|
61
60
|
* <li>
|
|
62
61
|
* <p>
|
|
63
|
-
* <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
*
|
|
62
|
+
* <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one task on each
|
|
63
|
+
* active container instance that meets all of the task placement constraints that you specify in
|
|
64
|
+
* your cluster. The service scheduler also evaluates the task placement constraints for running
|
|
65
|
+
* tasks. It also stops tasks that don't meet the placement constraints. When using this strategy,
|
|
66
|
+
* you don't need to specify a desired number of tasks, a task placement strategy, or use Service
|
|
67
|
+
* Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service
|
|
68
|
+
* scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
70
69
|
* </li>
|
|
71
70
|
* </ul>
|
|
72
|
-
* <p>You can optionally specify a deployment configuration for your service. The deployment
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
* <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service
|
|
76
|
-
*
|
|
77
|
-
* <p>If a service uses the <code>ECS</code> deployment controller, the minimum healthy
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
* that
|
|
88
|
-
* <code>RUNNING</code> state and reported as healthy by the load balancer, tasks for
|
|
89
|
-
* services that <i>do</i> use a load balancer are considered healthy . The
|
|
71
|
+
* <p>You can optionally specify a deployment configuration for your service. The deployment is initiated
|
|
72
|
+
* by changing properties. For example, the deployment might be initiated by the task definition or by
|
|
73
|
+
* your desired count of a service. You can use <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>. The default value for a replica service for
|
|
74
|
+
* <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service for
|
|
75
|
+
* <code>minimumHealthyPercent</code> is 0%.</p>
|
|
76
|
+
* <p>If a service uses the <code>ECS</code> deployment controller, the minimum healthy percent represents
|
|
77
|
+
* a lower limit on the number of tasks in a service that must remain in the <code>RUNNING</code> state
|
|
78
|
+
* during a deployment. Specifically, it represents it as a percentage of your desired number of tasks
|
|
79
|
+
* (rounded up to the nearest integer). This happens when any of your container instances are in the
|
|
80
|
+
* <code>DRAINING</code> state if the service contains tasks using the EC2 launch type.
|
|
81
|
+
* Using this parameter, you can deploy without using additional cluster capacity. For example, if you set
|
|
82
|
+
* your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler
|
|
83
|
+
* might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in
|
|
84
|
+
* the <code>RUNNING</code> state, tasks for services that don't use a load balancer are considered
|
|
85
|
+
* healthy . If they're in the <code>RUNNING</code> state and reported as healthy by the load balancer,
|
|
86
|
+
* tasks for services that <i>do</i> use a load balancer are considered healthy . The
|
|
90
87
|
* default value for minimum healthy percent is 100%.</p>
|
|
91
|
-
* <p>If a service uses the <code>ECS</code> deployment controller, the <b>maximum
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
* percentage of the desired number of tasks (rounded down to the nearest integer).
|
|
95
|
-
* happens when any of your container instances are in the <code>DRAINING</code> state if
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
* <p>When the service scheduler launches new tasks, it determines task placement. For
|
|
114
|
-
*
|
|
115
|
-
*
|
|
88
|
+
* <p>If a service uses the <code>ECS</code> deployment controller, the <b>maximum
|
|
89
|
+
* percent</b> parameter represents an upper limit on the number of tasks in a service that are
|
|
90
|
+
* allowed in the <code>RUNNING</code> or <code>PENDING</code> state during a deployment. Specifically, it
|
|
91
|
+
* represents it as a percentage of the desired number of tasks (rounded down to the nearest integer).
|
|
92
|
+
* This happens when any of your container instances are in the <code>DRAINING</code> state if the service
|
|
93
|
+
* contains tasks using the EC2 launch type. Using this parameter, you can define the
|
|
94
|
+
* deployment batch size. For example, if your service has a desired number of four tasks and a maximum
|
|
95
|
+
* percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks
|
|
96
|
+
* (provided that the cluster resources required to do this are available). The default value for maximum
|
|
97
|
+
* percent is 200%.</p>
|
|
98
|
+
* <p>If a service uses either the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code> deployment controller
|
|
99
|
+
* types and tasks that use the EC2 launch type, the <b>minimum healthy
|
|
100
|
+
* percent</b> and <b>maximum percent</b> values are used only to
|
|
101
|
+
* define the lower and upper limit on the number of the tasks in the service that remain in the
|
|
102
|
+
* <code>RUNNING</code> state. This is while the container instances are in the <code>DRAINING</code>
|
|
103
|
+
* state. If the tasks in the service use the Fargate launch type, the minimum healthy
|
|
104
|
+
* percent and maximum percent values aren't used. This is the case even if they're currently visible when
|
|
105
|
+
* describing your service.</p>
|
|
106
|
+
* <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you can specify
|
|
107
|
+
* only parameters that aren't controlled at the task set level. The only required parameter is the
|
|
108
|
+
* service name. You control your services using the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateTaskSet.html">CreateTaskSet</a>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment
|
|
109
|
+
* types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
110
|
+
* <p>When the service scheduler launches new tasks, it determines task placement. For information about
|
|
111
|
+
* task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS task
|
|
112
|
+
* placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>
|
|
116
113
|
* </p>
|
|
117
114
|
* @example
|
|
118
115
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -272,6 +269,13 @@ declare const CreateServiceCommand_base: {
|
|
|
272
269
|
* },
|
|
273
270
|
* },
|
|
274
271
|
* ],
|
|
272
|
+
* vpcLatticeConfigurations: [ // VpcLatticeConfigurations
|
|
273
|
+
* { // VpcLatticeConfiguration
|
|
274
|
+
* roleArn: "STRING_VALUE", // required
|
|
275
|
+
* targetGroupArn: "STRING_VALUE", // required
|
|
276
|
+
* portName: "STRING_VALUE", // required
|
|
277
|
+
* },
|
|
278
|
+
* ],
|
|
275
279
|
* };
|
|
276
280
|
* const command = new CreateServiceCommand(input);
|
|
277
281
|
* const response = await client.send(command);
|
|
@@ -506,6 +510,13 @@ declare const CreateServiceCommand_base: {
|
|
|
506
510
|
* // fargateEphemeralStorage: {
|
|
507
511
|
* // kmsKeyId: "STRING_VALUE",
|
|
508
512
|
* // },
|
|
513
|
+
* // vpcLatticeConfigurations: [ // VpcLatticeConfigurations
|
|
514
|
+
* // { // VpcLatticeConfiguration
|
|
515
|
+
* // roleArn: "STRING_VALUE", // required
|
|
516
|
+
* // targetGroupArn: "STRING_VALUE", // required
|
|
517
|
+
* // portName: "STRING_VALUE", // required
|
|
518
|
+
* // },
|
|
519
|
+
* // ],
|
|
509
520
|
* // },
|
|
510
521
|
* // ],
|
|
511
522
|
* // roleArn: "STRING_VALUE",
|
|
@@ -561,17 +572,16 @@ declare const CreateServiceCommand_base: {
|
|
|
561
572
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
562
573
|
*
|
|
563
574
|
* @throws {@link ClientException} (client fault)
|
|
564
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
565
|
-
*
|
|
566
|
-
*
|
|
575
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or
|
|
576
|
+
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
|
|
577
|
+
* be specifying an identifier that isn't valid.</p>
|
|
567
578
|
* <p>The following list includes additional causes for the error:</p>
|
|
568
579
|
* <ul>
|
|
569
580
|
* <li>
|
|
570
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
571
|
-
*
|
|
572
|
-
*
|
|
573
|
-
*
|
|
574
|
-
* service quotas</a>.</p>
|
|
581
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
|
|
582
|
+
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
|
|
583
|
+
* 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
|
|
584
|
+
* quotas</a>.</p>
|
|
575
585
|
* </li>
|
|
576
586
|
* </ul>
|
|
577
587
|
*
|
|
@@ -579,8 +589,7 @@ declare const CreateServiceCommand_base: {
|
|
|
579
589
|
* <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>
|
|
580
590
|
*
|
|
581
591
|
* @throws {@link InvalidParameterException} (client fault)
|
|
582
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
583
|
-
* request.</p>
|
|
592
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
|
|
584
593
|
*
|
|
585
594
|
* @throws {@link NamespaceNotFoundException} (client fault)
|
|
586
595
|
* <p>The specified namespace wasn't found.</p>
|