Skip to content

Commit

Permalink
docs(client-ecs): This is an Amazon ECS documentation only update to …
Browse files Browse the repository at this point in the history
…address tickets.
  • Loading branch information
awstools committed Oct 17, 2024
1 parent 1f02a26 commit 5933d69
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 10 deletions.
13 changes: 6 additions & 7 deletions clients/client-ecs/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11742,8 +11742,7 @@ export interface RunTaskRequest {
propagateTags?: PropagateTags;

/**
* <p>The reference ID to use for the task. The reference ID can have a maximum length of
* 1024 characters.</p>
* <p>This parameter is only used by Amazon ECS. It is not intended for use by customers.</p>
* @public
*/
referenceId?: string;
Expand Down Expand Up @@ -11926,16 +11925,16 @@ export interface StartTaskRequest {
propagateTags?: PropagateTags;

/**
* <p>The reference ID to use for the task.</p>
* <p>This parameter is only used by Amazon ECS. It is not intended for use by customers.</p>
* @public
*/
referenceId?: string;

/**
* <p>An optional tag specified when a task is started. For example, if you automatically
* trigger a task to run a batch process job, you could apply a unique identifier for that
* job to your task with the <code>startedBy</code> parameter. You can then identify which
* tasks belong to that job by filtering the results of a <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html">ListTasks</a> call with
* <p>An optional tag specified when a task is started. For example, if you automatically trigger
* a task to run a batch process job, you could apply a unique identifier for that job to
* your task with the <code>startedBy</code> parameter. You can then identify which tasks
* belong to that job by filtering the results of a <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html">ListTasks</a> call with
* the <code>startedBy</code> value. Up to 36 letters (uppercase and lowercase), numbers,
* hyphens (-), forward slash (/), and underscores (_) are allowed.</p>
* <p>If a task is started by an Amazon ECS service, the <code>startedBy</code> parameter
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 @@ -9602,7 +9602,7 @@
"referenceId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The reference ID to use for the task. The reference ID can have a maximum length of\n\t\t\t1024 characters.</p>"
"smithy.api#documentation": "<p>This parameter is only used by Amazon ECS. It is not intended for use by customers.</p>"
}
},
"startedBy": {
Expand Down Expand Up @@ -10651,13 +10651,13 @@
"referenceId": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>The reference ID to use for the task.</p>"
"smithy.api#documentation": "<p>This parameter is only used by Amazon ECS. It is not intended for use by customers.</p>"
}
},
"startedBy": {
"target": "com.amazonaws.ecs#String",
"traits": {
"smithy.api#documentation": "<p>An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the <code>startedBy</code> parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html\">ListTasks</a> call with\n\t\t\tthe <code>startedBy</code> value. Up to 36 letters (uppercase and lowercase), numbers,\n\t\t\thyphens (-), forward slash (/), and underscores (_) are allowed.</p>\n <p>If a task is started by an Amazon ECS service, the <code>startedBy</code> parameter\n\t\t\tcontains the deployment ID of the service that starts it.</p>"
"smithy.api#documentation": "<p>An optional tag specified when a task is started. For example, if you automatically trigger\n\t\t\ta task to run a batch process job, you could apply a unique identifier for that job to\n\t\t\tyour task with the <code>startedBy</code> parameter. You can then identify which tasks\n\t\t\tbelong to that job by filtering the results of a <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html\">ListTasks</a> call with\n\t\t\tthe <code>startedBy</code> value. Up to 36 letters (uppercase and lowercase), numbers,\n\t\t\thyphens (-), forward slash (/), and underscores (_) are allowed.</p>\n <p>If a task is started by an Amazon ECS service, the <code>startedBy</code> parameter\n\t\t\tcontains the deployment ID of the service that starts it.</p>"
}
},
"tags": {
Expand Down

0 comments on commit 5933d69

Please sign in to comment.