Skip to content

Commit 408d925

Browse files
author
awstools
committedJan 24, 2024
docs(client-ecs): Documentation updates for Amazon ECS.
1 parent 65a1927 commit 408d925

File tree

3 files changed

+27
-55
lines changed

3 files changed

+27
-55
lines changed
 

‎clients/client-ecs/src/commands/CreateTaskSetCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met
3232
* uses the <code>EXTERNAL</code> deployment controller type. For more information, see
3333
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment
3434
* types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
35-
* <p>You can create a maximum of 5 tasks sets for a deployment.</p>
35+
* <p>For information about the maximum number of task sets and otther quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service quotas</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.
3838
* ```javascript

‎clients/client-ecs/src/models/models_0.ts

+14-45
Original file line numberDiff line numberDiff line change
@@ -1432,8 +1432,8 @@ export interface DeploymentConfiguration {
14321432
* the container health check settings. </p>
14331433
* </li>
14341434
* </ul>
1435-
* <p>For services are that <i>do</i> use a load balancer, the following
1436-
* should be noted:</p>
1435+
* <p>For services that <i>do</i> use a load balancer, the following should be
1436+
* noted:</p>
14371437
* <ul>
14381438
* <li>
14391439
* <p>If a task has no essential containers with a health check defined, the service
@@ -1610,7 +1610,9 @@ export type AssignPublicIp = (typeof AssignPublicIp)[keyof typeof AssignPublicIp
16101610

16111611
/**
16121612
* @public
1613-
* <p>An object representing the networking details for a task or service.</p>
1613+
* <p>An object representing the networking details for a task or service. For example
1614+
* <code>awsvpcConfiguration=\{subnets=["subnet-12344321"],securityGroups=["sg-12344321"]\}</code>
1615+
* </p>
16141616
*/
16151617
export interface AwsVpcConfiguration {
16161618
/**
@@ -2087,7 +2089,7 @@ export interface ServiceConnectService {
20872089

20882090
/**
20892091
* @public
2090-
* <p>An object that represents the configuration for Service Connect TLS.</p>
2092+
* <p>A reference to an object that represents a Transport Layer Security (TLS) configuration.</p>
20912093
*/
20922094
tls?: ServiceConnectTlsConfiguration;
20932095
}
@@ -4401,6 +4403,7 @@ export type ContainerCondition = (typeof ContainerCondition)[keyof typeof Contai
44014403
* </li>
44024404
* </ul>
44034405
* </note>
4406+
* <p>For more information about how to create a container dependency, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/example_task_definitions.html#example_task_definition-containerdependency">Container dependency</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
44044407
*/
44054408
export interface ContainerDependency {
44064409
/**
@@ -5388,7 +5391,7 @@ export type UlimitName = (typeof UlimitName)[keyof typeof UlimitName];
53885391
* overrides. The <code>nofile</code> resource limit sets a restriction on
53895392
* the number of open files that a container can use. The default
53905393
* <code>nofile</code> soft limit is <code>1024</code> and the default hard limit
5391-
* is <code>4096</code>.</p>
5394+
* is <code>65535</code>.</p>
53925395
* <p>You can specify the <code>ulimit</code> settings for a container in a task
53935396
* definition.</p>
53945397
*/
@@ -6074,7 +6077,7 @@ export interface ContainerDefinition {
60746077
* overrides. The <code>nofile</code> resource limit sets a restriction on
60756078
* the number of open files that a container can use. The default
60766079
* <code>nofile</code> soft limit is <code>1024</code> and the default hard limit
6077-
* is <code>4096</code>.</p>
6080+
* is <code>65535</code>.</p>
60786081
* <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version --format '\{\{.Server.APIVersion\}\}'</code>
60796082
* </p>
60806083
* <note>
@@ -8846,41 +8849,7 @@ export interface Task {
88468849
* @public
88478850
* <p>The stop code indicating why a task was stopped. The <code>stoppedReason</code> might
88488851
* contain additional details. </p>
8849-
* <p>For more information about stop code, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/stopped-task-error-codes.html">Stopped tasks error
8850-
* codes</a> in the <i>Amazon ECS User Guide</i>.</p>
8851-
* <p>The following are valid values:</p>
8852-
* <ul>
8853-
* <li>
8854-
* <p>
8855-
* <code>TaskFailedToStart</code>
8856-
* </p>
8857-
* </li>
8858-
* <li>
8859-
* <p>
8860-
* <code>EssentialContainerExited</code>
8861-
* </p>
8862-
* </li>
8863-
* <li>
8864-
* <p>
8865-
* <code>UserInitiated</code>
8866-
* </p>
8867-
* </li>
8868-
* <li>
8869-
* <p>
8870-
* <code>TerminationNotice</code>
8871-
* </p>
8872-
* </li>
8873-
* <li>
8874-
* <p>
8875-
* <code>ServiceSchedulerInitiated</code>
8876-
* </p>
8877-
* </li>
8878-
* <li>
8879-
* <p>
8880-
* <code>SpotInterruption</code>
8881-
* </p>
8882-
* </li>
8883-
* </ul>
8852+
* <p>For more information about stop code, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/stopped-task-error-codes.html">Stopped tasks error codes</a> in the <i>Amazon ECS User Guide</i>.</p>
88848853
*/
88858854
stopCode?: TaskStopCode;
88868855

@@ -11652,10 +11621,10 @@ export interface StopTaskRequest {
1165211621

1165311622
/**
1165411623
* @public
11655-
* <p>An optional message specified when a task is stopped. For example, if you're using a
11656-
* custom scheduler, you can use this parameter to specify the reason for stopping the task
11657-
* here, and the message appears in subsequent <a>DescribeTasks</a> API
11658-
* operations on this task. Up to 255 characters are allowed in this message.</p>
11624+
* <p>An optional message specified when a task is stopped. For example, if you're using a custom
11625+
* scheduler, you can use this parameter to specify the reason for stopping the task here,
11626+
* and the message appears in subsequent <a>DescribeTasks</a> API operations on
11627+
* this task.</p>
1165911628
*/
1166011629
reason?: string;
1166111630
}

0 commit comments

Comments
 (0)
Please sign in to comment.