@aws-sdk/client-ecs 3.775.0 → 3.777.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/dist-types/commands/CreateCapacityProviderCommand.d.ts +25 -25
- package/dist-types/commands/CreateClusterCommand.d.ts +12 -12
- package/dist-types/commands/CreateServiceCommand.d.ts +75 -76
- package/dist-types/commands/CreateTaskSetCommand.d.ts +33 -33
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +19 -20
- package/dist-types/commands/DeleteAttributesCommand.d.ts +10 -10
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +18 -18
- package/dist-types/commands/DeleteClusterCommand.d.ts +12 -12
- package/dist-types/commands/DeleteServiceCommand.d.ts +7 -4
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +23 -23
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +30 -30
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +9 -6
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +22 -22
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +60 -61
- package/dist-types/commands/DescribeClustersCommand.d.ts +9 -9
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +49 -49
- package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +1 -41
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +1 -41
- package/dist-types/commands/DescribeServicesCommand.d.ts +32 -32
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +33 -33
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +30 -30
- package/dist-types/commands/DescribeTasksCommand.d.ts +25 -25
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +1 -0
- package/dist-types/commands/ExecuteCommandCommand.d.ts +17 -17
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +10 -10
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +31 -32
- package/dist-types/commands/ListAttributesCommand.d.ts +11 -11
- package/dist-types/commands/ListClustersCommand.d.ts +5 -5
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +5 -5
- package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +12 -12
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +1 -0
- package/dist-types/commands/ListServicesCommand.d.ts +5 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +7 -7
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +16 -17
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +16 -17
- package/dist-types/commands/ListTasksCommand.d.ts +16 -17
- package/dist-types/commands/PutAccountSettingCommand.d.ts +21 -22
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +9 -9
- package/dist-types/commands/PutAttributesCommand.d.ts +12 -12
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +129 -131
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +1 -0
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +29 -29
- package/dist-types/commands/RunTaskCommand.d.ts +19 -19
- package/dist-types/commands/StartTaskCommand.d.ts +29 -29
- package/dist-types/commands/StopTaskCommand.d.ts +37 -37
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +1 -0
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +1 -0
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +1 -0
- package/dist-types/commands/TagResourceCommand.d.ts +10 -7
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -5
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +25 -25
- package/dist-types/commands/UpdateClusterCommand.d.ts +103 -104
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +20 -20
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +12 -12
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +90 -90
- package/dist-types/commands/UpdateServiceCommand.d.ts +18 -13
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +29 -29
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +35 -37
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +32 -32
- package/package.json +2 -2
|
@@ -90,72 +90,71 @@ declare const ListAccountSettingsCommand_base: {
|
|
|
90
90
|
* @throws {@link ECSServiceException}
|
|
91
91
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
92
92
|
*
|
|
93
|
-
*
|
|
94
|
-
* @example To view
|
|
93
|
+
*
|
|
94
|
+
* @example To view the effective account settings for a specific IAM user or IAM role
|
|
95
95
|
* ```javascript
|
|
96
|
-
* // This example displays the effective account settings for
|
|
96
|
+
* // This example displays the effective account settings for the specified user or role.
|
|
97
97
|
* const input = {
|
|
98
|
-
*
|
|
98
|
+
* effectiveSettings: true,
|
|
99
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
99
100
|
* };
|
|
100
101
|
* const command = new ListAccountSettingsCommand(input);
|
|
101
102
|
* const response = await client.send(command);
|
|
102
|
-
* /* response
|
|
103
|
+
* /* response is
|
|
103
104
|
* {
|
|
104
|
-
*
|
|
105
|
+
* settings: [
|
|
105
106
|
* {
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
107
|
+
* name: "containerInstanceLongArnFormat",
|
|
108
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
109
|
+
* value: "disabled"
|
|
109
110
|
* },
|
|
110
111
|
* {
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
112
|
+
* name: "serviceLongArnFormat",
|
|
113
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
114
|
+
* value: "enabled"
|
|
114
115
|
* },
|
|
115
116
|
* {
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
117
|
+
* name: "taskLongArnFormat",
|
|
118
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
119
|
+
* value: "disabled"
|
|
119
120
|
* }
|
|
120
121
|
* ]
|
|
121
122
|
* }
|
|
122
123
|
* *\/
|
|
123
|
-
* // example id: to-view-your-account-settings-1549524118170
|
|
124
124
|
* ```
|
|
125
125
|
*
|
|
126
|
-
* @example To view
|
|
126
|
+
* @example To view your effective account settings
|
|
127
127
|
* ```javascript
|
|
128
|
-
* // This example displays the effective account settings for
|
|
128
|
+
* // This example displays the effective account settings for your account.
|
|
129
129
|
* const input = {
|
|
130
|
-
*
|
|
131
|
-
* "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
130
|
+
* effectiveSettings: true
|
|
132
131
|
* };
|
|
133
132
|
* const command = new ListAccountSettingsCommand(input);
|
|
134
133
|
* const response = await client.send(command);
|
|
135
|
-
* /* response
|
|
134
|
+
* /* response is
|
|
136
135
|
* {
|
|
137
|
-
*
|
|
136
|
+
* settings: [
|
|
138
137
|
* {
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
138
|
+
* name: "containerInstanceLongArnFormat",
|
|
139
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
140
|
+
* value: "disabled"
|
|
142
141
|
* },
|
|
143
142
|
* {
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
143
|
+
* name: "serviceLongArnFormat",
|
|
144
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
145
|
+
* value: "enabled"
|
|
147
146
|
* },
|
|
148
147
|
* {
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
*
|
|
148
|
+
* name: "taskLongArnFormat",
|
|
149
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
150
|
+
* value: "disabled"
|
|
152
151
|
* }
|
|
153
152
|
* ]
|
|
154
153
|
* }
|
|
155
154
|
* *\/
|
|
156
|
-
* // example id: to-view-the-account-settings-for-a-specific-iam-user-or-iam-role-1549524237932
|
|
157
155
|
* ```
|
|
158
156
|
*
|
|
157
|
+
* @public
|
|
159
158
|
*/
|
|
160
159
|
export declare class ListAccountSettingsCommand extends ListAccountSettingsCommand_base {
|
|
161
160
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -81,32 +81,32 @@ declare const ListAttributesCommand_base: {
|
|
|
81
81
|
* @throws {@link ECSServiceException}
|
|
82
82
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
83
83
|
*
|
|
84
|
-
*
|
|
84
|
+
*
|
|
85
85
|
* @example To list container instances that have a specific attribute
|
|
86
86
|
* ```javascript
|
|
87
87
|
* // This example lists attributes for a container instance with the attribute "stack" equal to the value "production".
|
|
88
88
|
* const input = {
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
89
|
+
* attributeName: "stack",
|
|
90
|
+
* attributeValue: "production",
|
|
91
|
+
* cluster: "MyCluster",
|
|
92
|
+
* targetType: "container-instance"
|
|
93
93
|
* };
|
|
94
94
|
* const command = new ListAttributesCommand(input);
|
|
95
95
|
* const response = await client.send(command);
|
|
96
|
-
* /* response
|
|
96
|
+
* /* response is
|
|
97
97
|
* {
|
|
98
|
-
*
|
|
98
|
+
* attributes: [
|
|
99
99
|
* {
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
100
|
+
* name: "stack",
|
|
101
|
+
* targetId: "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34",
|
|
102
|
+
* value: "production"
|
|
103
103
|
* }
|
|
104
104
|
* ]
|
|
105
105
|
* }
|
|
106
106
|
* *\/
|
|
107
|
-
* // example id: to-list-container-instances-that-have-a-specific-attribute-1734368946577
|
|
108
107
|
* ```
|
|
109
108
|
*
|
|
109
|
+
* @public
|
|
110
110
|
*/
|
|
111
111
|
export declare class ListAttributesCommand extends ListAttributesCommand_base {
|
|
112
112
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -81,24 +81,24 @@ declare const ListClustersCommand_base: {
|
|
|
81
81
|
* @throws {@link ECSServiceException}
|
|
82
82
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
83
83
|
*
|
|
84
|
-
*
|
|
84
|
+
*
|
|
85
85
|
* @example To list your available clusters
|
|
86
86
|
* ```javascript
|
|
87
87
|
* // This example lists all of your available clusters in your default region.
|
|
88
|
-
* const input = {};
|
|
88
|
+
* const input = { /* empty *\/ };
|
|
89
89
|
* const command = new ListClustersCommand(input);
|
|
90
90
|
* const response = await client.send(command);
|
|
91
|
-
* /* response
|
|
91
|
+
* /* response is
|
|
92
92
|
* {
|
|
93
|
-
*
|
|
93
|
+
* clusterArns: [
|
|
94
94
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:cluster/test",
|
|
95
95
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:cluster/default"
|
|
96
96
|
* ]
|
|
97
97
|
* }
|
|
98
98
|
* *\/
|
|
99
|
-
* // example id: e337d059-134f-4125-ba8e-4f499139facf
|
|
100
99
|
* ```
|
|
101
100
|
*
|
|
101
|
+
* @public
|
|
102
102
|
*/
|
|
103
103
|
export declare class ListClustersCommand extends ListClustersCommand_base {
|
|
104
104
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -89,26 +89,26 @@ declare const ListContainerInstancesCommand_base: {
|
|
|
89
89
|
* @throws {@link ECSServiceException}
|
|
90
90
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
91
91
|
*
|
|
92
|
-
*
|
|
92
|
+
*
|
|
93
93
|
* @example To list your available container instances in a cluster
|
|
94
94
|
* ```javascript
|
|
95
95
|
* // This example lists all of your available container instances in the specified cluster in your default region.
|
|
96
96
|
* const input = {
|
|
97
|
-
*
|
|
97
|
+
* cluster: "default"
|
|
98
98
|
* };
|
|
99
99
|
* const command = new ListContainerInstancesCommand(input);
|
|
100
100
|
* const response = await client.send(command);
|
|
101
|
-
* /* response
|
|
101
|
+
* /* response is
|
|
102
102
|
* {
|
|
103
|
-
*
|
|
103
|
+
* containerInstanceArns: [
|
|
104
104
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/default/f6bbb147-5370-4ace-8c73-c7181ded911f",
|
|
105
105
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/default/ffe3d344-77e2-476c-a4d0-bf560ad50acb"
|
|
106
106
|
* ]
|
|
107
107
|
* }
|
|
108
108
|
* *\/
|
|
109
|
-
* // example id: 62a82a94-713c-4e18-8420-1d2b2ba9d484
|
|
110
109
|
* ```
|
|
111
110
|
*
|
|
111
|
+
* @public
|
|
112
112
|
*/
|
|
113
113
|
export declare class ListContainerInstancesCommand extends ListContainerInstancesCommand_base {
|
|
114
114
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -115,35 +115,35 @@ declare const ListServiceDeploymentsCommand_base: {
|
|
|
115
115
|
* @throws {@link ECSServiceException}
|
|
116
116
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
117
117
|
*
|
|
118
|
-
*
|
|
118
|
+
*
|
|
119
119
|
* @example To list service deployments that meet the specified criteria
|
|
120
120
|
* ```javascript
|
|
121
121
|
* // This example lists all successful service deployments for the service "sd-example" in the cluster "example".
|
|
122
122
|
* const input = {
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
123
|
+
* cluster: "example",
|
|
124
|
+
* service: "sd-example",
|
|
125
|
+
* status: [
|
|
126
126
|
* "SUCCESSFUL"
|
|
127
127
|
* ]
|
|
128
128
|
* };
|
|
129
129
|
* const command = new ListServiceDeploymentsCommand(input);
|
|
130
130
|
* const response = await client.send(command);
|
|
131
|
-
* /* response
|
|
131
|
+
* /* response is
|
|
132
132
|
* {
|
|
133
|
-
*
|
|
133
|
+
* serviceDeployments: [
|
|
134
134
|
* {
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
135
|
+
* clusterArn: "arn:aws:ecs:us-west-2:123456789012:cluster/example",
|
|
136
|
+
* serviceArn: "arn:aws:ecs:us-west-2:123456789012:service/example/sd-example",
|
|
137
|
+
* serviceDeploymentArn: "arn:aws:ecs:us-west-2:123456789012:service-deployment/example/sd-example/NCWGC2ZR-taawPAYrIaU5",
|
|
138
|
+
* status: "SUCCESSFUL",
|
|
139
|
+
* targetServiceRevisionArn: "arn:aws:ecs:us-west-2:123456789012:service-revision/example/sd-example/4980306466373577095"
|
|
140
140
|
* }
|
|
141
141
|
* ]
|
|
142
142
|
* }
|
|
143
143
|
* *\/
|
|
144
|
-
* // example id: to-list-service-deployments-that-meet-the-specified-criteria-1734370445427
|
|
145
144
|
* ```
|
|
146
145
|
*
|
|
146
|
+
* @public
|
|
147
147
|
*/
|
|
148
148
|
export declare class ListServiceDeploymentsCommand extends ListServiceDeploymentsCommand_base {
|
|
149
149
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -89,6 +89,7 @@ declare const ListServicesByNamespaceCommand_base: {
|
|
|
89
89
|
* @throws {@link ECSServiceException}
|
|
90
90
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
91
91
|
*
|
|
92
|
+
*
|
|
92
93
|
* @public
|
|
93
94
|
*/
|
|
94
95
|
export declare class ListServicesByNamespaceCommand extends ListServicesByNamespaceCommand_base {
|
|
@@ -88,23 +88,23 @@ declare const ListServicesCommand_base: {
|
|
|
88
88
|
* @throws {@link ECSServiceException}
|
|
89
89
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
90
90
|
*
|
|
91
|
-
*
|
|
91
|
+
*
|
|
92
92
|
* @example To list the services in a cluster
|
|
93
93
|
* ```javascript
|
|
94
94
|
* // This example lists the services running in the default cluster for an account.
|
|
95
|
-
* const input = {};
|
|
95
|
+
* const input = { /* empty *\/ };
|
|
96
96
|
* const command = new ListServicesCommand(input);
|
|
97
97
|
* const response = await client.send(command);
|
|
98
|
-
* /* response
|
|
98
|
+
* /* response is
|
|
99
99
|
* {
|
|
100
|
-
*
|
|
100
|
+
* serviceArns: [
|
|
101
101
|
* "arn:aws:ecs:us-east-1:012345678910:service/default/my-http-service"
|
|
102
102
|
* ]
|
|
103
103
|
* }
|
|
104
104
|
* *\/
|
|
105
|
-
* // example id: 1d9a8037-4e0e-4234-a528-609656809a3a
|
|
106
105
|
* ```
|
|
107
106
|
*
|
|
107
|
+
* @public
|
|
108
108
|
*/
|
|
109
109
|
export declare class ListServicesCommand extends ListServicesCommand_base {
|
|
110
110
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -85,28 +85,28 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
85
85
|
* @throws {@link ECSServiceException}
|
|
86
86
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
87
87
|
*
|
|
88
|
-
*
|
|
88
|
+
*
|
|
89
89
|
* @example To list the tags for a cluster.
|
|
90
90
|
* ```javascript
|
|
91
91
|
* // This example lists the tags for the 'dev' cluster.
|
|
92
92
|
* const input = {
|
|
93
|
-
*
|
|
93
|
+
* resourceArn: "arn:aws:ecs:region:aws_account_id:cluster/dev"
|
|
94
94
|
* };
|
|
95
95
|
* const command = new ListTagsForResourceCommand(input);
|
|
96
96
|
* const response = await client.send(command);
|
|
97
|
-
* /* response
|
|
97
|
+
* /* response is
|
|
98
98
|
* {
|
|
99
|
-
*
|
|
99
|
+
* tags: [
|
|
100
100
|
* {
|
|
101
|
-
*
|
|
102
|
-
*
|
|
101
|
+
* key: "team",
|
|
102
|
+
* value: "dev"
|
|
103
103
|
* }
|
|
104
104
|
* ]
|
|
105
105
|
* }
|
|
106
106
|
* *\/
|
|
107
|
-
* // example id: to-list-the-tags-for-a-cluster-1540582700259
|
|
108
107
|
* ```
|
|
109
108
|
*
|
|
109
|
+
* @public
|
|
110
110
|
*/
|
|
111
111
|
export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
|
|
112
112
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -89,45 +89,44 @@ declare const ListTaskDefinitionFamiliesCommand_base: {
|
|
|
89
89
|
* @throws {@link ECSServiceException}
|
|
90
90
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
91
91
|
*
|
|
92
|
-
*
|
|
93
|
-
* @example To
|
|
92
|
+
*
|
|
93
|
+
* @example To filter your registered task definition families
|
|
94
94
|
* ```javascript
|
|
95
|
-
* // This example lists
|
|
96
|
-
* const input = {
|
|
95
|
+
* // This example lists the task definition revisions that start with "hpcc".
|
|
96
|
+
* const input = {
|
|
97
|
+
* familyPrefix: "hpcc"
|
|
98
|
+
* };
|
|
97
99
|
* const command = new ListTaskDefinitionFamiliesCommand(input);
|
|
98
100
|
* const response = await client.send(command);
|
|
99
|
-
* /* response
|
|
101
|
+
* /* response is
|
|
100
102
|
* {
|
|
101
|
-
*
|
|
102
|
-
* "node-js-app",
|
|
103
|
-
* "web-timer",
|
|
103
|
+
* families: [
|
|
104
104
|
* "hpcc",
|
|
105
105
|
* "hpcc-c4-8xlarge"
|
|
106
106
|
* ]
|
|
107
107
|
* }
|
|
108
108
|
* *\/
|
|
109
|
-
* // example id: b5c89769-1d94-4ca2-a79e-8069103c7f75
|
|
110
109
|
* ```
|
|
111
110
|
*
|
|
112
|
-
* @example To
|
|
111
|
+
* @example To list your registered task definition families
|
|
113
112
|
* ```javascript
|
|
114
|
-
* // This example lists
|
|
115
|
-
* const input = {
|
|
116
|
-
* "familyPrefix": "hpcc"
|
|
117
|
-
* };
|
|
113
|
+
* // This example lists all of your registered task definition families.
|
|
114
|
+
* const input = { /* empty *\/ };
|
|
118
115
|
* const command = new ListTaskDefinitionFamiliesCommand(input);
|
|
119
116
|
* const response = await client.send(command);
|
|
120
|
-
* /* response
|
|
117
|
+
* /* response is
|
|
121
118
|
* {
|
|
122
|
-
*
|
|
119
|
+
* families: [
|
|
120
|
+
* "node-js-app",
|
|
121
|
+
* "web-timer",
|
|
123
122
|
* "hpcc",
|
|
124
123
|
* "hpcc-c4-8xlarge"
|
|
125
124
|
* ]
|
|
126
125
|
* }
|
|
127
126
|
* *\/
|
|
128
|
-
* // example id: 8a4cf9a6-42c1-4fe3-852d-99ac8968e11b
|
|
129
127
|
* ```
|
|
130
128
|
*
|
|
129
|
+
* @public
|
|
131
130
|
*/
|
|
132
131
|
export declare class ListTaskDefinitionFamiliesCommand extends ListTaskDefinitionFamiliesCommand_base {
|
|
133
132
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -86,18 +86,18 @@ declare const ListTaskDefinitionsCommand_base: {
|
|
|
86
86
|
* @throws {@link ECSServiceException}
|
|
87
87
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
88
88
|
*
|
|
89
|
-
*
|
|
90
|
-
* @example To list
|
|
89
|
+
*
|
|
90
|
+
* @example To list the registered task definitions in a family
|
|
91
91
|
* ```javascript
|
|
92
|
-
* // This example lists
|
|
93
|
-
* const input = {
|
|
92
|
+
* // This example lists the task definition revisions of a specified family.
|
|
93
|
+
* const input = {
|
|
94
|
+
* familyPrefix: "wordpress"
|
|
95
|
+
* };
|
|
94
96
|
* const command = new ListTaskDefinitionsCommand(input);
|
|
95
97
|
* const response = await client.send(command);
|
|
96
|
-
* /* response
|
|
98
|
+
* /* response is
|
|
97
99
|
* {
|
|
98
|
-
*
|
|
99
|
-
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep300:2",
|
|
100
|
-
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1",
|
|
100
|
+
* taskDefinitionArns: [
|
|
101
101
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:3",
|
|
102
102
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:4",
|
|
103
103
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:5",
|
|
@@ -105,20 +105,19 @@ declare const ListTaskDefinitionsCommand_base: {
|
|
|
105
105
|
* ]
|
|
106
106
|
* }
|
|
107
107
|
* *\/
|
|
108
|
-
* // example id: b381ebaf-7eba-4d60-b99b-7f6ae49d3d60
|
|
109
108
|
* ```
|
|
110
109
|
*
|
|
111
|
-
* @example To list
|
|
110
|
+
* @example To list your registered task definitions
|
|
112
111
|
* ```javascript
|
|
113
|
-
* // This example lists
|
|
114
|
-
* const input = {
|
|
115
|
-
* "familyPrefix": "wordpress"
|
|
116
|
-
* };
|
|
112
|
+
* // This example lists all of your registered task definitions.
|
|
113
|
+
* const input = { /* empty *\/ };
|
|
117
114
|
* const command = new ListTaskDefinitionsCommand(input);
|
|
118
115
|
* const response = await client.send(command);
|
|
119
|
-
* /* response
|
|
116
|
+
* /* response is
|
|
120
117
|
* {
|
|
121
|
-
*
|
|
118
|
+
* taskDefinitionArns: [
|
|
119
|
+
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep300:2",
|
|
120
|
+
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1",
|
|
122
121
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:3",
|
|
123
122
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:4",
|
|
124
123
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:5",
|
|
@@ -126,9 +125,9 @@ declare const ListTaskDefinitionsCommand_base: {
|
|
|
126
125
|
* ]
|
|
127
126
|
* }
|
|
128
127
|
* *\/
|
|
129
|
-
* // example id: 734e7afd-753a-4bc2-85d0-badddce10910
|
|
130
128
|
* ```
|
|
131
129
|
*
|
|
130
|
+
* @public
|
|
132
131
|
*/
|
|
133
132
|
export declare class ListTaskDefinitionsCommand extends ListTaskDefinitionsCommand_base {
|
|
134
133
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -98,45 +98,44 @@ declare const ListTasksCommand_base: {
|
|
|
98
98
|
* @throws {@link ECSServiceException}
|
|
99
99
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
100
100
|
*
|
|
101
|
-
*
|
|
102
|
-
* @example To list the tasks
|
|
101
|
+
*
|
|
102
|
+
* @example To list the tasks on a particular container instance
|
|
103
103
|
* ```javascript
|
|
104
|
-
* // This example lists
|
|
104
|
+
* // This example lists the tasks of a specified container instance. Specifying a ``containerInstance`` value limits the results to tasks that belong to that container instance.
|
|
105
105
|
* const input = {
|
|
106
|
-
*
|
|
106
|
+
* cluster: "default",
|
|
107
|
+
* containerInstance: "f6bbb147-5370-4ace-8c73-c7181ded911f"
|
|
107
108
|
* };
|
|
108
109
|
* const command = new ListTasksCommand(input);
|
|
109
110
|
* const response = await client.send(command);
|
|
110
|
-
* /* response
|
|
111
|
+
* /* response is
|
|
111
112
|
* {
|
|
112
|
-
*
|
|
113
|
-
* "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84"
|
|
114
|
-
* "arn:aws:ecs:us-east-1:012345678910:task/default/6b809ef6-c67e-4467-921f-ee261c15a0a1"
|
|
113
|
+
* taskArns: [
|
|
114
|
+
* "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84"
|
|
115
115
|
* ]
|
|
116
116
|
* }
|
|
117
117
|
* *\/
|
|
118
|
-
* // example id: 9a6ec707-1a77-45d0-b2eb-516b5dd9e924
|
|
119
118
|
* ```
|
|
120
119
|
*
|
|
121
|
-
* @example To list the tasks
|
|
120
|
+
* @example To list the tasks in a cluster
|
|
122
121
|
* ```javascript
|
|
123
|
-
* // This example lists
|
|
122
|
+
* // This example lists all of the tasks in a cluster.
|
|
124
123
|
* const input = {
|
|
125
|
-
*
|
|
126
|
-
* "containerInstance": "f6bbb147-5370-4ace-8c73-c7181ded911f"
|
|
124
|
+
* cluster: "default"
|
|
127
125
|
* };
|
|
128
126
|
* const command = new ListTasksCommand(input);
|
|
129
127
|
* const response = await client.send(command);
|
|
130
|
-
* /* response
|
|
128
|
+
* /* response is
|
|
131
129
|
* {
|
|
132
|
-
*
|
|
133
|
-
* "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84"
|
|
130
|
+
* taskArns: [
|
|
131
|
+
* "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84",
|
|
132
|
+
* "arn:aws:ecs:us-east-1:012345678910:task/default/6b809ef6-c67e-4467-921f-ee261c15a0a1"
|
|
134
133
|
* ]
|
|
135
134
|
* }
|
|
136
135
|
* *\/
|
|
137
|
-
* // example id: 024bf3b7-9cbb-44e3-848f-9d074e1fecce
|
|
138
136
|
* ```
|
|
139
137
|
*
|
|
138
|
+
* @public
|
|
140
139
|
*/
|
|
141
140
|
export declare class ListTasksCommand extends ListTasksCommand_base {
|
|
142
141
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -88,50 +88,49 @@ declare const PutAccountSettingCommand_base: {
|
|
|
88
88
|
* @throws {@link ECSServiceException}
|
|
89
89
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
90
90
|
*
|
|
91
|
-
*
|
|
92
|
-
* @example To modify
|
|
91
|
+
*
|
|
92
|
+
* @example To modify the account settings for a specific IAM user or IAM role
|
|
93
93
|
* ```javascript
|
|
94
|
-
* // This example modifies
|
|
94
|
+
* // This example modifies the account setting for a specific IAM user or IAM role to opt in to the new ARN and resource ID format for Amazon ECS container instances. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.
|
|
95
95
|
* const input = {
|
|
96
|
-
*
|
|
97
|
-
*
|
|
96
|
+
* name: "containerInstanceLongArnFormat",
|
|
97
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
98
|
+
* value: "enabled"
|
|
98
99
|
* };
|
|
99
100
|
* const command = new PutAccountSettingCommand(input);
|
|
100
101
|
* const response = await client.send(command);
|
|
101
|
-
* /* response
|
|
102
|
+
* /* response is
|
|
102
103
|
* {
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
104
|
+
* setting: {
|
|
105
|
+
* name: "containerInstanceLongArnFormat",
|
|
106
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
107
|
+
* value: "enabled"
|
|
107
108
|
* }
|
|
108
109
|
* }
|
|
109
110
|
* *\/
|
|
110
|
-
* // example id: to-modify-the-account-settings-for-your-iam-user-account-1549523130939
|
|
111
111
|
* ```
|
|
112
112
|
*
|
|
113
|
-
* @example To modify
|
|
113
|
+
* @example To modify your account settings
|
|
114
114
|
* ```javascript
|
|
115
|
-
* // This example modifies
|
|
115
|
+
* // This example modifies your account settings to opt in to the new ARN and resource ID format for Amazon ECS services. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.
|
|
116
116
|
* const input = {
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
* "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
117
|
+
* name: "serviceLongArnFormat",
|
|
118
|
+
* value: "enabled"
|
|
120
119
|
* };
|
|
121
120
|
* const command = new PutAccountSettingCommand(input);
|
|
122
121
|
* const response = await client.send(command);
|
|
123
|
-
* /* response
|
|
122
|
+
* /* response is
|
|
124
123
|
* {
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
124
|
+
* setting: {
|
|
125
|
+
* name: "serviceLongArnFormat",
|
|
126
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
127
|
+
* value: "enabled"
|
|
129
128
|
* }
|
|
130
129
|
* }
|
|
131
130
|
* *\/
|
|
132
|
-
* // example id: to-modify-the-account-settings-for-a-specific-iam-user-or-iam-role-1549523518390
|
|
133
131
|
* ```
|
|
134
132
|
*
|
|
133
|
+
* @public
|
|
135
134
|
*/
|
|
136
135
|
export declare class PutAccountSettingCommand extends PutAccountSettingCommand_base {
|
|
137
136
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -84,28 +84,28 @@ declare const PutAccountSettingDefaultCommand_base: {
|
|
|
84
84
|
* @throws {@link ECSServiceException}
|
|
85
85
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
86
86
|
*
|
|
87
|
-
*
|
|
87
|
+
*
|
|
88
88
|
* @example To modify the default account settings for all IAM users or roles on an account
|
|
89
89
|
* ```javascript
|
|
90
90
|
* // This example modifies the default account setting for the specified resource for all IAM users or roles on an account. These changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.
|
|
91
91
|
* const input = {
|
|
92
|
-
*
|
|
93
|
-
*
|
|
92
|
+
* name: "serviceLongArnFormat",
|
|
93
|
+
* value: "enabled"
|
|
94
94
|
* };
|
|
95
95
|
* const command = new PutAccountSettingDefaultCommand(input);
|
|
96
96
|
* const response = await client.send(command);
|
|
97
|
-
* /* response
|
|
97
|
+
* /* response is
|
|
98
98
|
* {
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
99
|
+
* setting: {
|
|
100
|
+
* name: "serviceLongArnFormat",
|
|
101
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:root",
|
|
102
|
+
* value: "enabled"
|
|
103
103
|
* }
|
|
104
104
|
* }
|
|
105
105
|
* *\/
|
|
106
|
-
* // example id: to-modify-the-default-account-settings-for-all-iam-users-or-roles-on-your-account-1549523794603
|
|
107
106
|
* ```
|
|
108
107
|
*
|
|
108
|
+
* @public
|
|
109
109
|
*/
|
|
110
110
|
export declare class PutAccountSettingDefaultCommand extends PutAccountSettingDefaultCommand_base {
|
|
111
111
|
/** @internal type navigation helper, not in runtime. */
|