@aws-sdk/client-ecs 3.321.1 → 3.326.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 +29 -0
- package/dist-types/commands/CreateClusterCommand.d.ts +72 -0
- package/dist-types/commands/CreateServiceCommand.d.ts +236 -0
- package/dist-types/commands/CreateTaskSetCommand.d.ts +69 -0
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +10 -0
- package/dist-types/commands/DeleteAttributesCommand.d.ts +13 -0
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +29 -0
- package/dist-types/commands/DeleteClusterCommand.d.ts +72 -0
- package/dist-types/commands/DeleteServiceCommand.d.ts +236 -0
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +275 -0
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +69 -0
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +85 -0
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +266 -0
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +39 -0
- package/dist-types/commands/DescribeClustersCommand.d.ts +81 -0
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +94 -0
- package/dist-types/commands/DescribeServicesCommand.d.ts +245 -0
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +272 -0
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +78 -0
- package/dist-types/commands/DescribeTasksCommand.d.ts +170 -0
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +8 -0
- package/dist-types/commands/ExecuteCommandCommand.d.ts +15 -0
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +19 -0
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +13 -0
- package/dist-types/commands/ListAttributesCommand.d.ts +14 -0
- package/dist-types/commands/ListClustersCommand.d.ts +9 -0
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +9 -0
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +9 -0
- package/dist-types/commands/ListServicesCommand.d.ts +9 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +9 -0
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +9 -0
- package/dist-types/commands/ListTasksCommand.d.ts +9 -0
- package/dist-types/commands/PutAccountSettingCommand.d.ts +10 -0
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +10 -0
- package/dist-types/commands/PutAttributesCommand.d.ts +13 -0
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +72 -0
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +85 -0
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +272 -0
- package/dist-types/commands/RunTaskCommand.d.ts +170 -0
- package/dist-types/commands/StartTaskCommand.d.ts +170 -0
- package/dist-types/commands/StopTaskCommand.d.ts +161 -0
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +6 -0
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +6 -0
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +6 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +29 -0
- package/dist-types/commands/UpdateClusterCommand.d.ts +72 -0
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +72 -0
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +85 -0
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +94 -0
- package/dist-types/commands/UpdateServiceCommand.d.ts +236 -0
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +69 -0
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +19 -0
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +69 -0
- package/dist-types/models/models_0.d.ts +4 -2
- package/package.json +16 -16
|
@@ -38,6 +38,174 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new DescribeTasksCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // DescribeTasksResponse
|
|
42
|
+
* // tasks: [ // Tasks
|
|
43
|
+
* // { // Task
|
|
44
|
+
* // attachments: [ // Attachments
|
|
45
|
+
* // { // Attachment
|
|
46
|
+
* // id: "STRING_VALUE",
|
|
47
|
+
* // type: "STRING_VALUE",
|
|
48
|
+
* // status: "STRING_VALUE",
|
|
49
|
+
* // details: [ // AttachmentDetails
|
|
50
|
+
* // { // KeyValuePair
|
|
51
|
+
* // name: "STRING_VALUE",
|
|
52
|
+
* // value: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // attributes: [ // Attributes
|
|
58
|
+
* // { // Attribute
|
|
59
|
+
* // name: "STRING_VALUE", // required
|
|
60
|
+
* // value: "STRING_VALUE",
|
|
61
|
+
* // targetType: "container-instance",
|
|
62
|
+
* // targetId: "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // availabilityZone: "STRING_VALUE",
|
|
66
|
+
* // capacityProviderName: "STRING_VALUE",
|
|
67
|
+
* // clusterArn: "STRING_VALUE",
|
|
68
|
+
* // connectivity: "CONNECTED" || "DISCONNECTED",
|
|
69
|
+
* // connectivityAt: new Date("TIMESTAMP"),
|
|
70
|
+
* // containerInstanceArn: "STRING_VALUE",
|
|
71
|
+
* // containers: [ // Containers
|
|
72
|
+
* // { // Container
|
|
73
|
+
* // containerArn: "STRING_VALUE",
|
|
74
|
+
* // taskArn: "STRING_VALUE",
|
|
75
|
+
* // name: "STRING_VALUE",
|
|
76
|
+
* // image: "STRING_VALUE",
|
|
77
|
+
* // imageDigest: "STRING_VALUE",
|
|
78
|
+
* // runtimeId: "STRING_VALUE",
|
|
79
|
+
* // lastStatus: "STRING_VALUE",
|
|
80
|
+
* // exitCode: Number("int"),
|
|
81
|
+
* // reason: "STRING_VALUE",
|
|
82
|
+
* // networkBindings: [ // NetworkBindings
|
|
83
|
+
* // { // NetworkBinding
|
|
84
|
+
* // bindIP: "STRING_VALUE",
|
|
85
|
+
* // containerPort: Number("int"),
|
|
86
|
+
* // hostPort: Number("int"),
|
|
87
|
+
* // protocol: "tcp" || "udp",
|
|
88
|
+
* // containerPortRange: "STRING_VALUE",
|
|
89
|
+
* // hostPortRange: "STRING_VALUE",
|
|
90
|
+
* // },
|
|
91
|
+
* // ],
|
|
92
|
+
* // networkInterfaces: [ // NetworkInterfaces
|
|
93
|
+
* // { // NetworkInterface
|
|
94
|
+
* // attachmentId: "STRING_VALUE",
|
|
95
|
+
* // privateIpv4Address: "STRING_VALUE",
|
|
96
|
+
* // ipv6Address: "STRING_VALUE",
|
|
97
|
+
* // },
|
|
98
|
+
* // ],
|
|
99
|
+
* // healthStatus: "HEALTHY" || "UNHEALTHY" || "UNKNOWN",
|
|
100
|
+
* // managedAgents: [ // ManagedAgents
|
|
101
|
+
* // { // ManagedAgent
|
|
102
|
+
* // lastStartedAt: new Date("TIMESTAMP"),
|
|
103
|
+
* // name: "ExecuteCommandAgent",
|
|
104
|
+
* // reason: "STRING_VALUE",
|
|
105
|
+
* // lastStatus: "STRING_VALUE",
|
|
106
|
+
* // },
|
|
107
|
+
* // ],
|
|
108
|
+
* // cpu: "STRING_VALUE",
|
|
109
|
+
* // memory: "STRING_VALUE",
|
|
110
|
+
* // memoryReservation: "STRING_VALUE",
|
|
111
|
+
* // gpuIds: [ // GpuIds
|
|
112
|
+
* // "STRING_VALUE",
|
|
113
|
+
* // ],
|
|
114
|
+
* // },
|
|
115
|
+
* // ],
|
|
116
|
+
* // cpu: "STRING_VALUE",
|
|
117
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
118
|
+
* // desiredStatus: "STRING_VALUE",
|
|
119
|
+
* // enableExecuteCommand: true || false,
|
|
120
|
+
* // executionStoppedAt: new Date("TIMESTAMP"),
|
|
121
|
+
* // group: "STRING_VALUE",
|
|
122
|
+
* // healthStatus: "HEALTHY" || "UNHEALTHY" || "UNKNOWN",
|
|
123
|
+
* // inferenceAccelerators: [ // InferenceAccelerators
|
|
124
|
+
* // { // InferenceAccelerator
|
|
125
|
+
* // deviceName: "STRING_VALUE", // required
|
|
126
|
+
* // deviceType: "STRING_VALUE", // required
|
|
127
|
+
* // },
|
|
128
|
+
* // ],
|
|
129
|
+
* // lastStatus: "STRING_VALUE",
|
|
130
|
+
* // launchType: "EC2" || "FARGATE" || "EXTERNAL",
|
|
131
|
+
* // memory: "STRING_VALUE",
|
|
132
|
+
* // overrides: { // TaskOverride
|
|
133
|
+
* // containerOverrides: [ // ContainerOverrides
|
|
134
|
+
* // { // ContainerOverride
|
|
135
|
+
* // name: "STRING_VALUE",
|
|
136
|
+
* // command: [ // StringList
|
|
137
|
+
* // "STRING_VALUE",
|
|
138
|
+
* // ],
|
|
139
|
+
* // environment: [ // EnvironmentVariables
|
|
140
|
+
* // {
|
|
141
|
+
* // name: "STRING_VALUE",
|
|
142
|
+
* // value: "STRING_VALUE",
|
|
143
|
+
* // },
|
|
144
|
+
* // ],
|
|
145
|
+
* // environmentFiles: [ // EnvironmentFiles
|
|
146
|
+
* // { // EnvironmentFile
|
|
147
|
+
* // value: "STRING_VALUE", // required
|
|
148
|
+
* // type: "s3", // required
|
|
149
|
+
* // },
|
|
150
|
+
* // ],
|
|
151
|
+
* // cpu: Number("int"),
|
|
152
|
+
* // memory: Number("int"),
|
|
153
|
+
* // memoryReservation: Number("int"),
|
|
154
|
+
* // resourceRequirements: [ // ResourceRequirements
|
|
155
|
+
* // { // ResourceRequirement
|
|
156
|
+
* // value: "STRING_VALUE", // required
|
|
157
|
+
* // type: "GPU" || "InferenceAccelerator", // required
|
|
158
|
+
* // },
|
|
159
|
+
* // ],
|
|
160
|
+
* // },
|
|
161
|
+
* // ],
|
|
162
|
+
* // cpu: "STRING_VALUE",
|
|
163
|
+
* // inferenceAcceleratorOverrides: [ // InferenceAcceleratorOverrides
|
|
164
|
+
* // { // InferenceAcceleratorOverride
|
|
165
|
+
* // deviceName: "STRING_VALUE",
|
|
166
|
+
* // deviceType: "STRING_VALUE",
|
|
167
|
+
* // },
|
|
168
|
+
* // ],
|
|
169
|
+
* // executionRoleArn: "STRING_VALUE",
|
|
170
|
+
* // memory: "STRING_VALUE",
|
|
171
|
+
* // taskRoleArn: "STRING_VALUE",
|
|
172
|
+
* // ephemeralStorage: { // EphemeralStorage
|
|
173
|
+
* // sizeInGiB: Number("int"), // required
|
|
174
|
+
* // },
|
|
175
|
+
* // },
|
|
176
|
+
* // platformVersion: "STRING_VALUE",
|
|
177
|
+
* // platformFamily: "STRING_VALUE",
|
|
178
|
+
* // pullStartedAt: new Date("TIMESTAMP"),
|
|
179
|
+
* // pullStoppedAt: new Date("TIMESTAMP"),
|
|
180
|
+
* // startedAt: new Date("TIMESTAMP"),
|
|
181
|
+
* // startedBy: "STRING_VALUE",
|
|
182
|
+
* // stopCode: "TaskFailedToStart" || "EssentialContainerExited" || "UserInitiated" || "ServiceSchedulerInitiated" || "SpotInterruption" || "TerminationNotice",
|
|
183
|
+
* // stoppedAt: new Date("TIMESTAMP"),
|
|
184
|
+
* // stoppedReason: "STRING_VALUE",
|
|
185
|
+
* // stoppingAt: new Date("TIMESTAMP"),
|
|
186
|
+
* // tags: [ // Tags
|
|
187
|
+
* // { // Tag
|
|
188
|
+
* // key: "STRING_VALUE",
|
|
189
|
+
* // value: "STRING_VALUE",
|
|
190
|
+
* // },
|
|
191
|
+
* // ],
|
|
192
|
+
* // taskArn: "STRING_VALUE",
|
|
193
|
+
* // taskDefinitionArn: "STRING_VALUE",
|
|
194
|
+
* // version: Number("long"),
|
|
195
|
+
* // ephemeralStorage: {
|
|
196
|
+
* // sizeInGiB: Number("int"), // required
|
|
197
|
+
* // },
|
|
198
|
+
* // },
|
|
199
|
+
* // ],
|
|
200
|
+
* // failures: [ // Failures
|
|
201
|
+
* // { // Failure
|
|
202
|
+
* // arn: "STRING_VALUE",
|
|
203
|
+
* // reason: "STRING_VALUE",
|
|
204
|
+
* // detail: "STRING_VALUE",
|
|
205
|
+
* // },
|
|
206
|
+
* // ],
|
|
207
|
+
* // };
|
|
208
|
+
*
|
|
41
209
|
* ```
|
|
42
210
|
*
|
|
43
211
|
* @param DescribeTasksCommandInput - {@link DescribeTasksCommandInput}
|
|
@@ -61,6 +229,8 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met
|
|
|
61
229
|
* @throws {@link ServerException} (server fault)
|
|
62
230
|
* <p>These errors are usually caused by a server issue.</p>
|
|
63
231
|
*
|
|
232
|
+
* @throws {@link ECSServiceException}
|
|
233
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
64
234
|
*
|
|
65
235
|
* @example To describe a task
|
|
66
236
|
* ```javascript
|
|
@@ -35,6 +35,12 @@ export interface DiscoverPollEndpointCommandOutput extends DiscoverPollEndpointR
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new DiscoverPollEndpointCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // DiscoverPollEndpointResponse
|
|
39
|
+
* // endpoint: "STRING_VALUE",
|
|
40
|
+
* // telemetryEndpoint: "STRING_VALUE",
|
|
41
|
+
* // serviceConnectEndpoint: "STRING_VALUE",
|
|
42
|
+
* // };
|
|
43
|
+
*
|
|
38
44
|
* ```
|
|
39
45
|
*
|
|
40
46
|
* @param DiscoverPollEndpointCommandInput - {@link DiscoverPollEndpointCommandInput}
|
|
@@ -51,6 +57,8 @@ export interface DiscoverPollEndpointCommandOutput extends DiscoverPollEndpointR
|
|
|
51
57
|
* @throws {@link ServerException} (server fault)
|
|
52
58
|
* <p>These errors are usually caused by a server issue.</p>
|
|
53
59
|
*
|
|
60
|
+
* @throws {@link ECSServiceException}
|
|
61
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
54
62
|
*
|
|
55
63
|
*/
|
|
56
64
|
export declare class DiscoverPollEndpointCommand extends $Command<DiscoverPollEndpointCommandInput, DiscoverPollEndpointCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -41,6 +41,19 @@ export interface ExecuteCommandCommandOutput extends ExecuteCommandResponse, __M
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new ExecuteCommandCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // { // ExecuteCommandResponse
|
|
45
|
+
* // clusterArn: "STRING_VALUE",
|
|
46
|
+
* // containerArn: "STRING_VALUE",
|
|
47
|
+
* // containerName: "STRING_VALUE",
|
|
48
|
+
* // interactive: true || false,
|
|
49
|
+
* // session: { // Session
|
|
50
|
+
* // sessionId: "STRING_VALUE",
|
|
51
|
+
* // streamUrl: "STRING_VALUE",
|
|
52
|
+
* // tokenValue: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // taskArn: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
44
57
|
* ```
|
|
45
58
|
*
|
|
46
59
|
* @param ExecuteCommandCommandInput - {@link ExecuteCommandCommandInput}
|
|
@@ -85,6 +98,8 @@ export interface ExecuteCommandCommandOutput extends ExecuteCommandResponse, __M
|
|
|
85
98
|
* <p>For information about how to troubleshoot the issues, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Troubleshooting issues with ECS
|
|
86
99
|
* Exec</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
87
100
|
*
|
|
101
|
+
* @throws {@link ECSServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
88
103
|
*
|
|
89
104
|
*/
|
|
90
105
|
export declare class ExecuteCommandCommand extends $Command<ExecuteCommandCommandInput, ExecuteCommandCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -34,6 +34,23 @@ export interface GetTaskProtectionCommandOutput extends GetTaskProtectionRespons
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new GetTaskProtectionCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // GetTaskProtectionResponse
|
|
38
|
+
* // protectedTasks: [ // ProtectedTasks
|
|
39
|
+
* // { // ProtectedTask
|
|
40
|
+
* // taskArn: "STRING_VALUE",
|
|
41
|
+
* // protectionEnabled: true || false,
|
|
42
|
+
* // expirationDate: new Date("TIMESTAMP"),
|
|
43
|
+
* // },
|
|
44
|
+
* // ],
|
|
45
|
+
* // failures: [ // Failures
|
|
46
|
+
* // { // Failure
|
|
47
|
+
* // arn: "STRING_VALUE",
|
|
48
|
+
* // reason: "STRING_VALUE",
|
|
49
|
+
* // detail: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // ],
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
37
54
|
* ```
|
|
38
55
|
*
|
|
39
56
|
* @param GetTaskProtectionCommandInput - {@link GetTaskProtectionCommandInput}
|
|
@@ -66,6 +83,8 @@ export interface GetTaskProtectionCommandOutput extends GetTaskProtectionRespons
|
|
|
66
83
|
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
67
84
|
* <p>The specified task isn't supported in this Region.</p>
|
|
68
85
|
*
|
|
86
|
+
* @throws {@link ECSServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
69
88
|
*
|
|
70
89
|
* @example To get the protection status of a task
|
|
71
90
|
* ```javascript
|
|
@@ -36,6 +36,17 @@ export interface ListAccountSettingsCommandOutput extends ListAccountSettingsRes
|
|
|
36
36
|
* };
|
|
37
37
|
* const command = new ListAccountSettingsCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
39
|
+
* // { // ListAccountSettingsResponse
|
|
40
|
+
* // settings: [ // Settings
|
|
41
|
+
* // { // Setting
|
|
42
|
+
* // name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization",
|
|
43
|
+
* // value: "STRING_VALUE",
|
|
44
|
+
* // principalArn: "STRING_VALUE",
|
|
45
|
+
* // },
|
|
46
|
+
* // ],
|
|
47
|
+
* // nextToken: "STRING_VALUE",
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
39
50
|
* ```
|
|
40
51
|
*
|
|
41
52
|
* @param ListAccountSettingsCommandInput - {@link ListAccountSettingsCommandInput}
|
|
@@ -56,6 +67,8 @@ export interface ListAccountSettingsCommandOutput extends ListAccountSettingsRes
|
|
|
56
67
|
* @throws {@link ServerException} (server fault)
|
|
57
68
|
* <p>These errors are usually caused by a server issue.</p>
|
|
58
69
|
*
|
|
70
|
+
* @throws {@link ECSServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
59
72
|
*
|
|
60
73
|
* @example To view your effective account settings
|
|
61
74
|
* ```javascript
|
|
@@ -42,6 +42,18 @@ export interface ListAttributesCommandOutput extends ListAttributesResponse, __M
|
|
|
42
42
|
* };
|
|
43
43
|
* const command = new ListAttributesCommand(input);
|
|
44
44
|
* const response = await client.send(command);
|
|
45
|
+
* // { // ListAttributesResponse
|
|
46
|
+
* // attributes: [ // Attributes
|
|
47
|
+
* // { // Attribute
|
|
48
|
+
* // name: "STRING_VALUE", // required
|
|
49
|
+
* // value: "STRING_VALUE",
|
|
50
|
+
* // targetType: "container-instance",
|
|
51
|
+
* // targetId: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // nextToken: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
45
57
|
* ```
|
|
46
58
|
*
|
|
47
59
|
* @param ListAttributesCommandInput - {@link ListAttributesCommandInput}
|
|
@@ -57,6 +69,8 @@ export interface ListAttributesCommandOutput extends ListAttributesResponse, __M
|
|
|
57
69
|
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
58
70
|
* request.</p>
|
|
59
71
|
*
|
|
72
|
+
* @throws {@link ECSServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
60
74
|
*
|
|
61
75
|
*/
|
|
62
76
|
export declare class ListAttributesCommand extends $Command<ListAttributesCommandInput, ListAttributesCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -32,6 +32,13 @@ export interface ListClustersCommandOutput extends ListClustersResponse, __Metad
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new ListClustersCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // ListClustersResponse
|
|
36
|
+
* // clusterArns: [ // StringList
|
|
37
|
+
* // "STRING_VALUE",
|
|
38
|
+
* // ],
|
|
39
|
+
* // nextToken: "STRING_VALUE",
|
|
40
|
+
* // };
|
|
41
|
+
*
|
|
35
42
|
* ```
|
|
36
43
|
*
|
|
37
44
|
* @param ListClustersCommandInput - {@link ListClustersCommandInput}
|
|
@@ -52,6 +59,8 @@ export interface ListClustersCommandOutput extends ListClustersResponse, __Metad
|
|
|
52
59
|
* @throws {@link ServerException} (server fault)
|
|
53
60
|
* <p>These errors are usually caused by a server issue.</p>
|
|
54
61
|
*
|
|
62
|
+
* @throws {@link ECSServiceException}
|
|
63
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
55
64
|
*
|
|
56
65
|
* @example To list your available clusters
|
|
57
66
|
* ```javascript
|
|
@@ -37,6 +37,13 @@ export interface ListContainerInstancesCommandOutput extends ListContainerInstan
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new ListContainerInstancesCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // { // ListContainerInstancesResponse
|
|
41
|
+
* // containerInstanceArns: [ // StringList
|
|
42
|
+
* // "STRING_VALUE",
|
|
43
|
+
* // ],
|
|
44
|
+
* // nextToken: "STRING_VALUE",
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
40
47
|
* ```
|
|
41
48
|
*
|
|
42
49
|
* @param ListContainerInstancesCommandInput - {@link ListContainerInstancesCommandInput}
|
|
@@ -60,6 +67,8 @@ export interface ListContainerInstancesCommandOutput extends ListContainerInstan
|
|
|
60
67
|
* @throws {@link ServerException} (server fault)
|
|
61
68
|
* <p>These errors are usually caused by a server issue.</p>
|
|
62
69
|
*
|
|
70
|
+
* @throws {@link ECSServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
63
72
|
*
|
|
64
73
|
* @example To list your available container instances in a cluster
|
|
65
74
|
* ```javascript
|
|
@@ -37,6 +37,13 @@ export interface ListServicesByNamespaceCommandOutput extends ListServicesByName
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new ListServicesByNamespaceCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // { // ListServicesByNamespaceResponse
|
|
41
|
+
* // serviceArns: [ // StringList
|
|
42
|
+
* // "STRING_VALUE",
|
|
43
|
+
* // ],
|
|
44
|
+
* // nextToken: "STRING_VALUE",
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
40
47
|
* ```
|
|
41
48
|
*
|
|
42
49
|
* @param ListServicesByNamespaceCommandInput - {@link ListServicesByNamespaceCommandInput}
|
|
@@ -60,6 +67,8 @@ export interface ListServicesByNamespaceCommandOutput extends ListServicesByName
|
|
|
60
67
|
* @throws {@link ServerException} (server fault)
|
|
61
68
|
* <p>These errors are usually caused by a server issue.</p>
|
|
62
69
|
*
|
|
70
|
+
* @throws {@link ECSServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
63
72
|
*
|
|
64
73
|
*/
|
|
65
74
|
export declare class ListServicesByNamespaceCommand extends $Command<ListServicesByNamespaceCommandInput, ListServicesByNamespaceCommandOutput, ECSClientResolvedConfig> {
|
|
@@ -36,6 +36,13 @@ export interface ListServicesCommandOutput extends ListServicesResponse, __Metad
|
|
|
36
36
|
* };
|
|
37
37
|
* const command = new ListServicesCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
39
|
+
* // { // ListServicesResponse
|
|
40
|
+
* // serviceArns: [ // StringList
|
|
41
|
+
* // "STRING_VALUE",
|
|
42
|
+
* // ],
|
|
43
|
+
* // nextToken: "STRING_VALUE",
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
39
46
|
* ```
|
|
40
47
|
*
|
|
41
48
|
* @param ListServicesCommandInput - {@link ListServicesCommandInput}
|
|
@@ -59,6 +66,8 @@ export interface ListServicesCommandOutput extends ListServicesResponse, __Metad
|
|
|
59
66
|
* @throws {@link ServerException} (server fault)
|
|
60
67
|
* <p>These errors are usually caused by a server issue.</p>
|
|
61
68
|
*
|
|
69
|
+
* @throws {@link ECSServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
62
71
|
*
|
|
63
72
|
* @example To list the services in a cluster
|
|
64
73
|
* ```javascript
|
|
@@ -31,6 +31,15 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new ListTagsForResourceCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // ListTagsForResourceResponse
|
|
35
|
+
* // tags: [ // Tags
|
|
36
|
+
* // { // Tag
|
|
37
|
+
* // key: "STRING_VALUE",
|
|
38
|
+
* // value: "STRING_VALUE",
|
|
39
|
+
* // },
|
|
40
|
+
* // ],
|
|
41
|
+
* // };
|
|
42
|
+
*
|
|
34
43
|
* ```
|
|
35
44
|
*
|
|
36
45
|
* @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
|
|
@@ -54,6 +63,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
54
63
|
* @throws {@link ServerException} (server fault)
|
|
55
64
|
* <p>These errors are usually caused by a server issue.</p>
|
|
56
65
|
*
|
|
66
|
+
* @throws {@link ECSServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
57
68
|
*
|
|
58
69
|
* @example To list the tags for a cluster.
|
|
59
70
|
* ```javascript
|
|
@@ -40,6 +40,13 @@ export interface ListTaskDefinitionFamiliesCommandOutput extends ListTaskDefinit
|
|
|
40
40
|
* };
|
|
41
41
|
* const command = new ListTaskDefinitionFamiliesCommand(input);
|
|
42
42
|
* const response = await client.send(command);
|
|
43
|
+
* // { // ListTaskDefinitionFamiliesResponse
|
|
44
|
+
* // families: [ // StringList
|
|
45
|
+
* // "STRING_VALUE",
|
|
46
|
+
* // ],
|
|
47
|
+
* // nextToken: "STRING_VALUE",
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
43
50
|
* ```
|
|
44
51
|
*
|
|
45
52
|
* @param ListTaskDefinitionFamiliesCommandInput - {@link ListTaskDefinitionFamiliesCommandInput}
|
|
@@ -60,6 +67,8 @@ export interface ListTaskDefinitionFamiliesCommandOutput extends ListTaskDefinit
|
|
|
60
67
|
* @throws {@link ServerException} (server fault)
|
|
61
68
|
* <p>These errors are usually caused by a server issue.</p>
|
|
62
69
|
*
|
|
70
|
+
* @throws {@link ECSServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
63
72
|
*
|
|
64
73
|
* @example To list your registered task definition families
|
|
65
74
|
* ```javascript
|
|
@@ -37,6 +37,13 @@ export interface ListTaskDefinitionsCommandOutput extends ListTaskDefinitionsRes
|
|
|
37
37
|
* };
|
|
38
38
|
* const command = new ListTaskDefinitionsCommand(input);
|
|
39
39
|
* const response = await client.send(command);
|
|
40
|
+
* // { // ListTaskDefinitionsResponse
|
|
41
|
+
* // taskDefinitionArns: [ // StringList
|
|
42
|
+
* // "STRING_VALUE",
|
|
43
|
+
* // ],
|
|
44
|
+
* // nextToken: "STRING_VALUE",
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
40
47
|
* ```
|
|
41
48
|
*
|
|
42
49
|
* @param ListTaskDefinitionsCommandInput - {@link ListTaskDefinitionsCommandInput}
|
|
@@ -57,6 +64,8 @@ export interface ListTaskDefinitionsCommandOutput extends ListTaskDefinitionsRes
|
|
|
57
64
|
* @throws {@link ServerException} (server fault)
|
|
58
65
|
* <p>These errors are usually caused by a server issue.</p>
|
|
59
66
|
*
|
|
67
|
+
* @throws {@link ECSServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
60
69
|
*
|
|
61
70
|
* @example To list your registered task definitions
|
|
62
71
|
* ```javascript
|
|
@@ -43,6 +43,13 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea
|
|
|
43
43
|
* };
|
|
44
44
|
* const command = new ListTasksCommand(input);
|
|
45
45
|
* const response = await client.send(command);
|
|
46
|
+
* // { // ListTasksResponse
|
|
47
|
+
* // taskArns: [ // StringList
|
|
48
|
+
* // "STRING_VALUE",
|
|
49
|
+
* // ],
|
|
50
|
+
* // nextToken: "STRING_VALUE",
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
46
53
|
* ```
|
|
47
54
|
*
|
|
48
55
|
* @param ListTasksCommandInput - {@link ListTasksCommandInput}
|
|
@@ -70,6 +77,8 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea
|
|
|
70
77
|
* <p>The specified service wasn't found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster specific and Region
|
|
71
78
|
* specific.</p>
|
|
72
79
|
*
|
|
80
|
+
* @throws {@link ECSServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
73
82
|
*
|
|
74
83
|
* @example To list the tasks in a cluster
|
|
75
84
|
* ```javascript
|
|
@@ -64,6 +64,14 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons
|
|
|
64
64
|
* };
|
|
65
65
|
* const command = new PutAccountSettingCommand(input);
|
|
66
66
|
* const response = await client.send(command);
|
|
67
|
+
* // { // PutAccountSettingResponse
|
|
68
|
+
* // setting: { // Setting
|
|
69
|
+
* // name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization",
|
|
70
|
+
* // value: "STRING_VALUE",
|
|
71
|
+
* // principalArn: "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
67
75
|
* ```
|
|
68
76
|
*
|
|
69
77
|
* @param PutAccountSettingCommandInput - {@link PutAccountSettingCommandInput}
|
|
@@ -84,6 +92,8 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons
|
|
|
84
92
|
* @throws {@link ServerException} (server fault)
|
|
85
93
|
* <p>These errors are usually caused by a server issue.</p>
|
|
86
94
|
*
|
|
95
|
+
* @throws {@link ECSServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
87
97
|
*
|
|
88
98
|
* @example To modify your account settings
|
|
89
99
|
* ```javascript
|
|
@@ -34,6 +34,14 @@ export interface PutAccountSettingDefaultCommandOutput extends PutAccountSetting
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new PutAccountSettingDefaultCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // PutAccountSettingDefaultResponse
|
|
38
|
+
* // setting: { // Setting
|
|
39
|
+
* // name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization",
|
|
40
|
+
* // value: "STRING_VALUE",
|
|
41
|
+
* // principalArn: "STRING_VALUE",
|
|
42
|
+
* // },
|
|
43
|
+
* // };
|
|
44
|
+
*
|
|
37
45
|
* ```
|
|
38
46
|
*
|
|
39
47
|
* @param PutAccountSettingDefaultCommandInput - {@link PutAccountSettingDefaultCommandInput}
|
|
@@ -54,6 +62,8 @@ export interface PutAccountSettingDefaultCommandOutput extends PutAccountSetting
|
|
|
54
62
|
* @throws {@link ServerException} (server fault)
|
|
55
63
|
* <p>These errors are usually caused by a server issue.</p>
|
|
56
64
|
*
|
|
65
|
+
* @throws {@link ECSServiceException}
|
|
66
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
57
67
|
*
|
|
58
68
|
* @example To modify the default account settings for all IAM users or roles on an account
|
|
59
69
|
* ```javascript
|
|
@@ -42,6 +42,17 @@ export interface PutAttributesCommandOutput extends PutAttributesResponse, __Met
|
|
|
42
42
|
* };
|
|
43
43
|
* const command = new PutAttributesCommand(input);
|
|
44
44
|
* const response = await client.send(command);
|
|
45
|
+
* // { // PutAttributesResponse
|
|
46
|
+
* // attributes: [ // Attributes
|
|
47
|
+
* // { // Attribute
|
|
48
|
+
* // name: "STRING_VALUE", // required
|
|
49
|
+
* // value: "STRING_VALUE",
|
|
50
|
+
* // targetType: "container-instance",
|
|
51
|
+
* // targetId: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
45
56
|
* ```
|
|
46
57
|
*
|
|
47
58
|
* @param PutAttributesCommandInput - {@link PutAttributesCommandInput}
|
|
@@ -67,6 +78,8 @@ export interface PutAttributesCommandOutput extends PutAttributesResponse, __Met
|
|
|
67
78
|
* with <a>ListContainerInstances</a>. Amazon ECS container instances are
|
|
68
79
|
* cluster-specific and Region-specific.</p>
|
|
69
80
|
*
|
|
81
|
+
* @throws {@link ECSServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
70
83
|
*
|
|
71
84
|
*/
|
|
72
85
|
export declare class PutAttributesCommand extends $Command<PutAttributesCommandInput, PutAttributesCommandOutput, ECSClientResolvedConfig> {
|