Skip to content

Commit

Permalink
docs(client-ecs): Documentation only update to address various tickets.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Jun 19, 2023
1 parent 30be6be commit 1a741f7
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ export interface DeleteTaskDefinitionsCommandOutput extends DeleteTaskDefinition
* <code>DELETE_IN_PROGRESS</code> task definition revision.</p>
* <p> A task definition revision will stay in <code>DELETE_IN_PROGRESS</code> status until
* all the associated tasks and services have been terminated.</p>
* <p>When you delete all <code>INACTIVE</code> task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the <code>DELETE_IN_PROGRESS</code> state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
3 changes: 3 additions & 0 deletions clients/client-ecs/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2283,13 +2283,16 @@ export interface CreateServiceRequest {
* <p>Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html">Tagging your Amazon ECS
* resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
* <p>When you use Amazon ECS managed tags, you need to set the <code>propagateTags</code>
* request parameter.</p>
*/
enableECSManagedTags?: boolean;

/**
* <p>Specifies whether to propagate the tags from the task definition to the task. If no
* value is specified, the tags aren't propagated. Tags can only be propagated to the task
* during task creation. To add tags to a task after task creation, use the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html">TagResource</a> API action.</p>
* <p>The default is <code>NONE</code>.</p>
*/
propagateTags?: PropagateTags | string;

Expand Down
6 changes: 3 additions & 3 deletions codegen/sdk-codegen/aws-models/ecs.json
Original file line number Diff line number Diff line change
Expand Up @@ -3175,13 +3175,13 @@
"target": "com.amazonaws.ecs#Boolean",
"traits": {
"smithy.api#default": false,
"smithy.api#documentation": "<p>Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging your Amazon ECS\n\t\t\t\tresources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"smithy.api#documentation": "<p>Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging your Amazon ECS\n\t\t\t\tresources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>\n <p>When you use Amazon ECS managed tags, you need to set the <code>propagateTags</code>\n\t\t\trequest parameter.</p>"
}
},
"propagateTags": {
"target": "com.amazonaws.ecs#PropagateTags",
"traits": {
"smithy.api#documentation": "<p>Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use the <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html\">TagResource</a> API action.</p>"
"smithy.api#documentation": "<p>Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use the <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html\">TagResource</a> API action.</p>\n <p>The default is <code>NONE</code>.</p>"
}
},
"enableExecuteCommand": {
Expand Down Expand Up @@ -3694,7 +3694,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes one or more task definitions.</p>\n <p>You must deregister a task definition revision before you delete it. For more information,\n\t\t\tsee <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterTaskDefinition.html\">DeregisterTaskDefinition</a>.</p>\n <p>When you delete a task definition revision, it is immediately transitions from the\n\t\t<code>INACTIVE</code> to <code>DELETE_IN_PROGRESS</code>. Existing tasks and services\n\t\tthat reference a <code>DELETE_IN_PROGRESS</code> task definition revision continue to run\n\t\twithout disruption. Existing services that reference a <code>DELETE_IN_PROGRESS</code> task\n\t\tdefinition revision can still scale up or down by modifying the service's desired\n\t\tcount.</p>\n <p>You can't use a <code>DELETE_IN_PROGRESS</code> task definition revision to run new tasks\n\t\t\tor create new services. You also can't update an existing service to reference a\n\t\t\t<code>DELETE_IN_PROGRESS</code> task definition revision.</p>\n <p> A task definition revision will stay in <code>DELETE_IN_PROGRESS</code> status until\n\t\t\tall the associated tasks and services have been terminated.</p>"
"smithy.api#documentation": "<p>Deletes one or more task definitions.</p>\n <p>You must deregister a task definition revision before you delete it. For more information,\n\t\t\tsee <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DeregisterTaskDefinition.html\">DeregisterTaskDefinition</a>.</p>\n <p>When you delete a task definition revision, it is immediately transitions from the\n\t\t<code>INACTIVE</code> to <code>DELETE_IN_PROGRESS</code>. Existing tasks and services\n\t\tthat reference a <code>DELETE_IN_PROGRESS</code> task definition revision continue to run\n\t\twithout disruption. Existing services that reference a <code>DELETE_IN_PROGRESS</code> task\n\t\tdefinition revision can still scale up or down by modifying the service's desired\n\t\tcount.</p>\n <p>You can't use a <code>DELETE_IN_PROGRESS</code> task definition revision to run new tasks\n\t\t\tor create new services. You also can't update an existing service to reference a\n\t\t\t<code>DELETE_IN_PROGRESS</code> task definition revision.</p>\n <p> A task definition revision will stay in <code>DELETE_IN_PROGRESS</code> status until\n\t\t\tall the associated tasks and services have been terminated.</p>\n <p>When you delete all <code>INACTIVE</code> task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the <code>DELETE_IN_PROGRESS</code> state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.</p>"
}
},
"com.amazonaws.ecs#DeleteTaskDefinitionsRequest": {
Expand Down

0 comments on commit 1a741f7

Please sign in to comment.