From 2aecb8b8ecbccdd42d39da293e2e4007f178ecf5 Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 4 Aug 2023 18:24:43 +0000 Subject: [PATCH] docs(client-ecs): This is a documentation update to address various tickets. --- .../src/commands/DescribeTasksCommand.ts | 3 + .../src/commands/ListTasksCommand.ts | 3 +- .../src/commands/UpdateServiceCommand.ts | 11 +- clients/client-ecs/src/endpoint/ruleset.ts | 2 +- clients/client-ecs/src/models/models_0.ts | 116 +- codegen/sdk-codegen/aws-models/ecs.json | 1102 +++++++++++++---- 6 files changed, 964 insertions(+), 273 deletions(-) diff --git a/clients/client-ecs/src/commands/DescribeTasksCommand.ts b/clients/client-ecs/src/commands/DescribeTasksCommand.ts index 282c955d04ca..0875bb4bb9f6 100644 --- a/clients/client-ecs/src/commands/DescribeTasksCommand.ts +++ b/clients/client-ecs/src/commands/DescribeTasksCommand.ts @@ -38,6 +38,9 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met * @public *

Describes a specified task or tasks.

*

Currently, stopped tasks appear in the returned results for at least one hour.

+ *

If you have tasks with tags, and then delete the cluster, the tagged tasks are + * returned in the response. If you create a new cluster with the same name as the deleted + * cluster, the tagged tasks are not included in the response.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ecs/src/commands/ListTasksCommand.ts b/clients/client-ecs/src/commands/ListTasksCommand.ts index 0b1bad435115..cc4490df90b6 100644 --- a/clients/client-ecs/src/commands/ListTasksCommand.ts +++ b/clients/client-ecs/src/commands/ListTasksCommand.ts @@ -39,8 +39,7 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea *

Returns a list of tasks. You can filter the results by cluster, task definition * family, container instance, launch type, what IAM principal started the task, or by the * desired status of the task.

- *

Recently stopped tasks might appear in the returned results. Currently, stopped tasks - * appear in the returned results for at least one hour.

+ *

Recently stopped tasks might appear in the returned results.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-ecs/src/commands/UpdateServiceCommand.ts b/clients/client-ecs/src/commands/UpdateServiceCommand.ts index 2d0f11b3135d..8923ee8d4ce0 100644 --- a/clients/client-ecs/src/commands/UpdateServiceCommand.ts +++ b/clients/client-ecs/src/commands/UpdateServiceCommand.ts @@ -143,14 +143,11 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met * * *

You must have a service-linked role when you update any of the following service - * properties. If you specified a custom role when you created the service, Amazon ECS - * automatically replaces the roleARN associated with the service with the ARN of your - * service-linked role. For more information, see Service-linked roles in the Amazon Elastic Container Service Developer Guide.

+ * properties:

* + *

For more information about the role see the CreateService request parameter + * + * role + * .

* * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ecs/src/endpoint/ruleset.ts b/clients/client-ecs/src/endpoint/ruleset.ts index 1604c5adbc4b..886a6837cdd1 100644 --- a/clients/client-ecs/src/endpoint/ruleset.ts +++ b/clients/client-ecs/src/endpoint/ruleset.ts @@ -26,5 +26,5 @@ m={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsDualStack" n=[i], o=[j], p=[{[t]:"Region"}]; -const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[r]:a,[s]:[h]}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]}]},{type:b,rules:[{conditions:[{[r]:a,[s]:p}],type:b,rules:[{conditions:[{[r]:"aws.partition",[s]:p,assign:e}],type:b,rules:[{conditions:[i,j],type:b,rules:[{conditions:[l,m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://ecs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[l],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://ecs-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://ecs.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://ecs.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]}; +const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[r]:a,[s]:[h]}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]},{conditions:[{[r]:a,[s]:p}],type:b,rules:[{conditions:[{[r]:"aws.partition",[s]:p,assign:e}],type:b,rules:[{conditions:[i,j],type:b,rules:[{conditions:[l,m],type:b,rules:[{endpoint:{url:"https://ecs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[l],type:b,rules:[{endpoint:{url:"https://ecs-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[m],type:b,rules:[{endpoint:{url:"https://ecs.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://ecs.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}; export const ruleSet: RuleSetObject = _data; diff --git a/clients/client-ecs/src/models/models_0.ts b/clients/client-ecs/src/models/models_0.ts index 84537e950541..8ea50dde51f6 100644 --- a/clients/client-ecs/src/models/models_0.ts +++ b/clients/client-ecs/src/models/models_0.ts @@ -122,9 +122,9 @@ export interface ManagedScaling { /** * @public - *

The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale - * in process is not affected by this parameter. If this parameter is omitted, the default - * value of 1 is used.

+ *

The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale in + * process is not affected by this parameter. If this parameter is omitted, the default + * value of 10000 is used.

*/ maximumScalingStepSize?: number; @@ -159,13 +159,13 @@ export type ManagedTerminationProtection = export interface AutoScalingGroupProvider { /** * @public - *

The Amazon Resource Name (ARN) that identifies the Auto Scaling group.

+ *

The Amazon Resource Name (ARN) that identifies the Auto Scaling group, or the Auto Scaling group name.

*/ autoScalingGroupArn: string | undefined; /** * @public - *

The managed scaling settings for the Auto Scaling group capacity provider.

+ *

he managed scaling settings for the Auto Scaling group capacity provider.

*/ managedScaling?: ManagedScaling; @@ -1303,6 +1303,7 @@ export interface DeploymentAlarms { * can also configure Amazon ECS to roll back your service to the last completed deployment * after a failure. For more information, see Rolling * update in the Amazon Elastic Container Service Developer Guide.

+ *

For more information about API failure reasons, see API failure reasons in the Amazon Elastic Container Service Developer Guide.

*/ export interface DeploymentCircuitBreaker { /** @@ -1517,8 +1518,7 @@ export interface LoadBalancer { * @public *

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or * task set.

- *

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a - * Classic Load Balancer, omit the target group ARN.

+ *

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer.

*

For services using the ECS deployment controller, you can specify one or * multiple target groups. For more information, see Registering multiple target groups with a service in * the Amazon Elastic Container Service Developer Guide.

@@ -1539,8 +1539,8 @@ export interface LoadBalancer { /** * @public *

The name of the load balancer to associate with the Amazon ECS service or task set.

- *

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer - * or a Network Load Balancer the load balancer name parameter should be omitted.

+ *

If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be + * omitted.

*/ loadBalancerName?: string; @@ -1822,9 +1822,16 @@ export interface Secret { * containers.

*