@aws-sdk/client-ecs 3.325.0 → 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.
Files changed (57) hide show
  1. package/dist-types/commands/CreateCapacityProviderCommand.d.ts +29 -0
  2. package/dist-types/commands/CreateClusterCommand.d.ts +72 -0
  3. package/dist-types/commands/CreateServiceCommand.d.ts +236 -0
  4. package/dist-types/commands/CreateTaskSetCommand.d.ts +69 -0
  5. package/dist-types/commands/DeleteAccountSettingCommand.d.ts +10 -0
  6. package/dist-types/commands/DeleteAttributesCommand.d.ts +13 -0
  7. package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +29 -0
  8. package/dist-types/commands/DeleteClusterCommand.d.ts +72 -0
  9. package/dist-types/commands/DeleteServiceCommand.d.ts +236 -0
  10. package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +275 -0
  11. package/dist-types/commands/DeleteTaskSetCommand.d.ts +69 -0
  12. package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +85 -0
  13. package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +266 -0
  14. package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +39 -0
  15. package/dist-types/commands/DescribeClustersCommand.d.ts +81 -0
  16. package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +94 -0
  17. package/dist-types/commands/DescribeServicesCommand.d.ts +245 -0
  18. package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +272 -0
  19. package/dist-types/commands/DescribeTaskSetsCommand.d.ts +78 -0
  20. package/dist-types/commands/DescribeTasksCommand.d.ts +170 -0
  21. package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +8 -0
  22. package/dist-types/commands/ExecuteCommandCommand.d.ts +15 -0
  23. package/dist-types/commands/GetTaskProtectionCommand.d.ts +19 -0
  24. package/dist-types/commands/ListAccountSettingsCommand.d.ts +13 -0
  25. package/dist-types/commands/ListAttributesCommand.d.ts +14 -0
  26. package/dist-types/commands/ListClustersCommand.d.ts +9 -0
  27. package/dist-types/commands/ListContainerInstancesCommand.d.ts +9 -0
  28. package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +9 -0
  29. package/dist-types/commands/ListServicesCommand.d.ts +9 -0
  30. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  31. package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +9 -0
  32. package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +9 -0
  33. package/dist-types/commands/ListTasksCommand.d.ts +9 -0
  34. package/dist-types/commands/PutAccountSettingCommand.d.ts +10 -0
  35. package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +10 -0
  36. package/dist-types/commands/PutAttributesCommand.d.ts +13 -0
  37. package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +72 -0
  38. package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +85 -0
  39. package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +272 -0
  40. package/dist-types/commands/RunTaskCommand.d.ts +170 -0
  41. package/dist-types/commands/StartTaskCommand.d.ts +170 -0
  42. package/dist-types/commands/StopTaskCommand.d.ts +161 -0
  43. package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +6 -0
  44. package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +6 -0
  45. package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +6 -0
  46. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  47. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  48. package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +29 -0
  49. package/dist-types/commands/UpdateClusterCommand.d.ts +72 -0
  50. package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +72 -0
  51. package/dist-types/commands/UpdateContainerAgentCommand.d.ts +85 -0
  52. package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +94 -0
  53. package/dist-types/commands/UpdateServiceCommand.d.ts +236 -0
  54. package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +69 -0
  55. package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +19 -0
  56. package/dist-types/commands/UpdateTaskSetCommand.d.ts +69 -0
  57. package/package.json +3 -3
package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts CHANGED
@@ -46,6 +46,89 @@ export interface DeregisterContainerInstanceCommandOutput extends DeregisterCont
46
46
  * };
47
47
  * const command = new DeregisterContainerInstanceCommand(input);
48
48
  * const response = await client.send(command);
49
+ * // { // DeregisterContainerInstanceResponse
50
+ * // containerInstance: { // ContainerInstance
51
+ * // containerInstanceArn: "STRING_VALUE",
52
+ * // ec2InstanceId: "STRING_VALUE",
53
+ * // capacityProviderName: "STRING_VALUE",
54
+ * // version: Number("long"),
55
+ * // versionInfo: { // VersionInfo
56
+ * // agentVersion: "STRING_VALUE",
57
+ * // agentHash: "STRING_VALUE",
58
+ * // dockerVersion: "STRING_VALUE",
59
+ * // },
60
+ * // remainingResources: [ // Resources
61
+ * // { // Resource
62
+ * // name: "STRING_VALUE",
63
+ * // type: "STRING_VALUE",
64
+ * // doubleValue: Number("double"),
65
+ * // longValue: Number("long"),
66
+ * // integerValue: Number("int"),
67
+ * // stringSetValue: [ // StringList
68
+ * // "STRING_VALUE",
69
+ * // ],
70
+ * // },
71
+ * // ],
72
+ * // registeredResources: [
73
+ * // {
74
+ * // name: "STRING_VALUE",
75
+ * // type: "STRING_VALUE",
76
+ * // doubleValue: Number("double"),
77
+ * // longValue: Number("long"),
78
+ * // integerValue: Number("int"),
79
+ * // stringSetValue: [
80
+ * // "STRING_VALUE",
81
+ * // ],
82
+ * // },
83
+ * // ],
84
+ * // status: "STRING_VALUE",
85
+ * // statusReason: "STRING_VALUE",
86
+ * // agentConnected: true || false,
87
+ * // runningTasksCount: Number("int"),
88
+ * // pendingTasksCount: Number("int"),
89
+ * // agentUpdateStatus: "PENDING" || "STAGING" || "STAGED" || "UPDATING" || "UPDATED" || "FAILED",
90
+ * // attributes: [ // Attributes
91
+ * // { // Attribute
92
+ * // name: "STRING_VALUE", // required
93
+ * // value: "STRING_VALUE",
94
+ * // targetType: "container-instance",
95
+ * // targetId: "STRING_VALUE",
96
+ * // },
97
+ * // ],
98
+ * // registeredAt: new Date("TIMESTAMP"),
99
+ * // attachments: [ // Attachments
100
+ * // { // Attachment
101
+ * // id: "STRING_VALUE",
102
+ * // type: "STRING_VALUE",
103
+ * // status: "STRING_VALUE",
104
+ * // details: [ // AttachmentDetails
105
+ * // { // KeyValuePair
106
+ * // name: "STRING_VALUE",
107
+ * // value: "STRING_VALUE",
108
+ * // },
109
+ * // ],
110
+ * // },
111
+ * // ],
112
+ * // tags: [ // Tags
113
+ * // { // Tag
114
+ * // key: "STRING_VALUE",
115
+ * // value: "STRING_VALUE",
116
+ * // },
117
+ * // ],
118
+ * // healthStatus: { // ContainerInstanceHealthStatus
119
+ * // overallStatus: "OK" || "IMPAIRED" || "INSUFFICIENT_DATA" || "INITIALIZING",
120
+ * // details: [ // InstanceHealthCheckResultList
121
+ * // { // InstanceHealthCheckResult
122
+ * // type: "CONTAINER_RUNTIME",
123
+ * // status: "OK" || "IMPAIRED" || "INSUFFICIENT_DATA" || "INITIALIZING",
124
+ * // lastUpdated: new Date("TIMESTAMP"),
125
+ * // lastStatusChange: new Date("TIMESTAMP"),
126
+ * // },
127
+ * // ],
128
+ * // },
129
+ * // },
130
+ * // };
131
+ *
49
132
  * ```
50
133
  *
51
134
  * @param DeregisterContainerInstanceCommandInput - {@link DeregisterContainerInstanceCommandInput}
@@ -69,6 +152,8 @@ export interface DeregisterContainerInstanceCommandOutput extends DeregisterCont
69
152
  * @throws {@link ServerException} (server fault)
70
153
  * <p>These errors are usually caused by a server issue.</p>
71
154
  *
155
+ * @throws {@link ECSServiceException}
156
+ * <p>Base exception class for all service exceptions from ECS service.</p>
72
157
  *
73
158
  * @example To deregister a container instance from a cluster
74
159
  * ```javascript
package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts CHANGED
@@ -48,6 +48,270 @@ export interface DeregisterTaskDefinitionCommandOutput extends DeregisterTaskDef
48
48
  * };
49
49
  * const command = new DeregisterTaskDefinitionCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // DeregisterTaskDefinitionResponse
52
+ * // taskDefinition: { // TaskDefinition
53
+ * // taskDefinitionArn: "STRING_VALUE",
54
+ * // containerDefinitions: [ // ContainerDefinitions
55
+ * // { // ContainerDefinition
56
+ * // name: "STRING_VALUE",
57
+ * // image: "STRING_VALUE",
58
+ * // repositoryCredentials: { // RepositoryCredentials
59
+ * // credentialsParameter: "STRING_VALUE", // required
60
+ * // },
61
+ * // cpu: Number("int"),
62
+ * // memory: Number("int"),
63
+ * // memoryReservation: Number("int"),
64
+ * // links: [ // StringList
65
+ * // "STRING_VALUE",
66
+ * // ],
67
+ * // portMappings: [ // PortMappingList
68
+ * // { // PortMapping
69
+ * // containerPort: Number("int"),
70
+ * // hostPort: Number("int"),
71
+ * // protocol: "tcp" || "udp",
72
+ * // name: "STRING_VALUE",
73
+ * // appProtocol: "http" || "http2" || "grpc",
74
+ * // containerPortRange: "STRING_VALUE",
75
+ * // },
76
+ * // ],
77
+ * // essential: true || false,
78
+ * // entryPoint: [
79
+ * // "STRING_VALUE",
80
+ * // ],
81
+ * // command: [
82
+ * // "STRING_VALUE",
83
+ * // ],
84
+ * // environment: [ // EnvironmentVariables
85
+ * // { // KeyValuePair
86
+ * // name: "STRING_VALUE",
87
+ * // value: "STRING_VALUE",
88
+ * // },
89
+ * // ],
90
+ * // environmentFiles: [ // EnvironmentFiles
91
+ * // { // EnvironmentFile
92
+ * // value: "STRING_VALUE", // required
93
+ * // type: "s3", // required
94
+ * // },
95
+ * // ],
96
+ * // mountPoints: [ // MountPointList
97
+ * // { // MountPoint
98
+ * // sourceVolume: "STRING_VALUE",
99
+ * // containerPath: "STRING_VALUE",
100
+ * // readOnly: true || false,
101
+ * // },
102
+ * // ],
103
+ * // volumesFrom: [ // VolumeFromList
104
+ * // { // VolumeFrom
105
+ * // sourceContainer: "STRING_VALUE",
106
+ * // readOnly: true || false,
107
+ * // },
108
+ * // ],
109
+ * // linuxParameters: { // LinuxParameters
110
+ * // capabilities: { // KernelCapabilities
111
+ * // add: [
112
+ * // "STRING_VALUE",
113
+ * // ],
114
+ * // drop: [
115
+ * // "STRING_VALUE",
116
+ * // ],
117
+ * // },
118
+ * // devices: [ // DevicesList
119
+ * // { // Device
120
+ * // hostPath: "STRING_VALUE", // required
121
+ * // containerPath: "STRING_VALUE",
122
+ * // permissions: [ // DeviceCgroupPermissions
123
+ * // "read" || "write" || "mknod",
124
+ * // ],
125
+ * // },
126
+ * // ],
127
+ * // initProcessEnabled: true || false,
128
+ * // sharedMemorySize: Number("int"),
129
+ * // tmpfs: [ // TmpfsList
130
+ * // { // Tmpfs
131
+ * // containerPath: "STRING_VALUE", // required
132
+ * // size: Number("int"), // required
133
+ * // mountOptions: "<StringList>",
134
+ * // },
135
+ * // ],
136
+ * // maxSwap: Number("int"),
137
+ * // swappiness: Number("int"),
138
+ * // },
139
+ * // secrets: [ // SecretList
140
+ * // { // Secret
141
+ * // name: "STRING_VALUE", // required
142
+ * // valueFrom: "STRING_VALUE", // required
143
+ * // },
144
+ * // ],
145
+ * // dependsOn: [ // ContainerDependencies
146
+ * // { // ContainerDependency
147
+ * // containerName: "STRING_VALUE", // required
148
+ * // condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
149
+ * // },
150
+ * // ],
151
+ * // startTimeout: Number("int"),
152
+ * // stopTimeout: Number("int"),
153
+ * // hostname: "STRING_VALUE",
154
+ * // user: "STRING_VALUE",
155
+ * // workingDirectory: "STRING_VALUE",
156
+ * // disableNetworking: true || false,
157
+ * // privileged: true || false,
158
+ * // readonlyRootFilesystem: true || false,
159
+ * // dnsServers: "<StringList>",
160
+ * // dnsSearchDomains: "<StringList>",
161
+ * // extraHosts: [ // HostEntryList
162
+ * // { // HostEntry
163
+ * // hostname: "STRING_VALUE", // required
164
+ * // ipAddress: "STRING_VALUE", // required
165
+ * // },
166
+ * // ],
167
+ * // dockerSecurityOptions: "<StringList>",
168
+ * // interactive: true || false,
169
+ * // pseudoTerminal: true || false,
170
+ * // dockerLabels: { // DockerLabelsMap
171
+ * // "<keys>": "STRING_VALUE",
172
+ * // },
173
+ * // ulimits: [ // UlimitList
174
+ * // { // Ulimit
175
+ * // name: "core" || "cpu" || "data" || "fsize" || "locks" || "memlock" || "msgqueue" || "nice" || "nofile" || "nproc" || "rss" || "rtprio" || "rttime" || "sigpending" || "stack", // required
176
+ * // softLimit: Number("int"), // required
177
+ * // hardLimit: Number("int"), // required
178
+ * // },
179
+ * // ],
180
+ * // logConfiguration: { // LogConfiguration
181
+ * // logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk" || "awsfirelens", // required
182
+ * // options: { // LogConfigurationOptionsMap
183
+ * // "<keys>": "STRING_VALUE",
184
+ * // },
185
+ * // secretOptions: [
186
+ * // {
187
+ * // name: "STRING_VALUE", // required
188
+ * // valueFrom: "STRING_VALUE", // required
189
+ * // },
190
+ * // ],
191
+ * // },
192
+ * // healthCheck: { // HealthCheck
193
+ * // command: "<StringList>", // required
194
+ * // interval: Number("int"),
195
+ * // timeout: Number("int"),
196
+ * // retries: Number("int"),
197
+ * // startPeriod: Number("int"),
198
+ * // },
199
+ * // systemControls: [ // SystemControls
200
+ * // { // SystemControl
201
+ * // namespace: "STRING_VALUE",
202
+ * // value: "STRING_VALUE",
203
+ * // },
204
+ * // ],
205
+ * // resourceRequirements: [ // ResourceRequirements
206
+ * // { // ResourceRequirement
207
+ * // value: "STRING_VALUE", // required
208
+ * // type: "GPU" || "InferenceAccelerator", // required
209
+ * // },
210
+ * // ],
211
+ * // firelensConfiguration: { // FirelensConfiguration
212
+ * // type: "fluentd" || "fluentbit", // required
213
+ * // options: { // FirelensConfigurationOptionsMap
214
+ * // "<keys>": "STRING_VALUE",
215
+ * // },
216
+ * // },
217
+ * // },
218
+ * // ],
219
+ * // family: "STRING_VALUE",
220
+ * // taskRoleArn: "STRING_VALUE",
221
+ * // executionRoleArn: "STRING_VALUE",
222
+ * // networkMode: "bridge" || "host" || "awsvpc" || "none",
223
+ * // revision: Number("int"),
224
+ * // volumes: [ // VolumeList
225
+ * // { // Volume
226
+ * // name: "STRING_VALUE",
227
+ * // host: { // HostVolumeProperties
228
+ * // sourcePath: "STRING_VALUE",
229
+ * // },
230
+ * // dockerVolumeConfiguration: { // DockerVolumeConfiguration
231
+ * // scope: "task" || "shared",
232
+ * // autoprovision: true || false,
233
+ * // driver: "STRING_VALUE",
234
+ * // driverOpts: { // StringMap
235
+ * // "<keys>": "STRING_VALUE",
236
+ * // },
237
+ * // labels: {
238
+ * // "<keys>": "STRING_VALUE",
239
+ * // },
240
+ * // },
241
+ * // efsVolumeConfiguration: { // EFSVolumeConfiguration
242
+ * // fileSystemId: "STRING_VALUE", // required
243
+ * // rootDirectory: "STRING_VALUE",
244
+ * // transitEncryption: "ENABLED" || "DISABLED",
245
+ * // transitEncryptionPort: Number("int"),
246
+ * // authorizationConfig: { // EFSAuthorizationConfig
247
+ * // accessPointId: "STRING_VALUE",
248
+ * // iam: "ENABLED" || "DISABLED",
249
+ * // },
250
+ * // },
251
+ * // fsxWindowsFileServerVolumeConfiguration: { // FSxWindowsFileServerVolumeConfiguration
252
+ * // fileSystemId: "STRING_VALUE", // required
253
+ * // rootDirectory: "STRING_VALUE", // required
254
+ * // authorizationConfig: { // FSxWindowsFileServerAuthorizationConfig
255
+ * // credentialsParameter: "STRING_VALUE", // required
256
+ * // domain: "STRING_VALUE", // required
257
+ * // },
258
+ * // },
259
+ * // },
260
+ * // ],
261
+ * // status: "ACTIVE" || "INACTIVE" || "DELETE_IN_PROGRESS",
262
+ * // requiresAttributes: [ // RequiresAttributes
263
+ * // { // Attribute
264
+ * // name: "STRING_VALUE", // required
265
+ * // value: "STRING_VALUE",
266
+ * // targetType: "container-instance",
267
+ * // targetId: "STRING_VALUE",
268
+ * // },
269
+ * // ],
270
+ * // placementConstraints: [ // TaskDefinitionPlacementConstraints
271
+ * // { // TaskDefinitionPlacementConstraint
272
+ * // type: "memberOf",
273
+ * // expression: "STRING_VALUE",
274
+ * // },
275
+ * // ],
276
+ * // compatibilities: [ // CompatibilityList
277
+ * // "EC2" || "FARGATE" || "EXTERNAL",
278
+ * // ],
279
+ * // runtimePlatform: { // RuntimePlatform
280
+ * // cpuArchitecture: "X86_64" || "ARM64",
281
+ * // operatingSystemFamily: "WINDOWS_SERVER_2019_FULL" || "WINDOWS_SERVER_2019_CORE" || "WINDOWS_SERVER_2016_FULL" || "WINDOWS_SERVER_2004_CORE" || "WINDOWS_SERVER_2022_CORE" || "WINDOWS_SERVER_2022_FULL" || "WINDOWS_SERVER_20H2_CORE" || "LINUX",
282
+ * // },
283
+ * // requiresCompatibilities: [
284
+ * // "EC2" || "FARGATE" || "EXTERNAL",
285
+ * // ],
286
+ * // cpu: "STRING_VALUE",
287
+ * // memory: "STRING_VALUE",
288
+ * // inferenceAccelerators: [ // InferenceAccelerators
289
+ * // { // InferenceAccelerator
290
+ * // deviceName: "STRING_VALUE", // required
291
+ * // deviceType: "STRING_VALUE", // required
292
+ * // },
293
+ * // ],
294
+ * // pidMode: "host" || "task",
295
+ * // ipcMode: "host" || "task" || "none",
296
+ * // proxyConfiguration: { // ProxyConfiguration
297
+ * // type: "APPMESH",
298
+ * // containerName: "STRING_VALUE", // required
299
+ * // properties: [ // ProxyConfigurationProperties
300
+ * // {
301
+ * // name: "STRING_VALUE",
302
+ * // value: "STRING_VALUE",
303
+ * // },
304
+ * // ],
305
+ * // },
306
+ * // registeredAt: new Date("TIMESTAMP"),
307
+ * // deregisteredAt: new Date("TIMESTAMP"),
308
+ * // registeredBy: "STRING_VALUE",
309
+ * // ephemeralStorage: { // EphemeralStorage
310
+ * // sizeInGiB: Number("int"), // required
311
+ * // },
312
+ * // },
313
+ * // };
314
+ *
51
315
  * ```
52
316
  *
53
317
  * @param DeregisterTaskDefinitionCommandInput - {@link DeregisterTaskDefinitionCommandInput}
@@ -68,6 +332,8 @@ export interface DeregisterTaskDefinitionCommandOutput extends DeregisterTaskDef
68
332
  * @throws {@link ServerException} (server fault)
69
333
  * <p>These errors are usually caused by a server issue.</p>
70
334
  *
335
+ * @throws {@link ECSServiceException}
336
+ * <p>Base exception class for all service exceptions from ECS service.</p>
71
337
  *
72
338
  */
73
339
  export declare class DeregisterTaskDefinitionCommand extends $Command<DeregisterTaskDefinitionCommandInput, DeregisterTaskDefinitionCommandOutput, ECSClientResolvedConfig> {
package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts CHANGED
@@ -38,6 +38,43 @@ export interface DescribeCapacityProvidersCommandOutput extends DescribeCapacity
38
38
  * };
39
39
  * const command = new DescribeCapacityProvidersCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // DescribeCapacityProvidersResponse
42
+ * // capacityProviders: [ // CapacityProviders
43
+ * // { // CapacityProvider
44
+ * // capacityProviderArn: "STRING_VALUE",
45
+ * // name: "STRING_VALUE",
46
+ * // status: "ACTIVE" || "INACTIVE",
47
+ * // autoScalingGroupProvider: { // AutoScalingGroupProvider
48
+ * // autoScalingGroupArn: "STRING_VALUE", // required
49
+ * // managedScaling: { // ManagedScaling
50
+ * // status: "ENABLED" || "DISABLED",
51
+ * // targetCapacity: Number("int"),
52
+ * // minimumScalingStepSize: Number("int"),
53
+ * // maximumScalingStepSize: Number("int"),
54
+ * // instanceWarmupPeriod: Number("int"),
55
+ * // },
56
+ * // managedTerminationProtection: "ENABLED" || "DISABLED",
57
+ * // },
58
+ * // updateStatus: "DELETE_IN_PROGRESS" || "DELETE_COMPLETE" || "DELETE_FAILED" || "UPDATE_IN_PROGRESS" || "UPDATE_COMPLETE" || "UPDATE_FAILED",
59
+ * // updateStatusReason: "STRING_VALUE",
60
+ * // tags: [ // Tags
61
+ * // { // Tag
62
+ * // key: "STRING_VALUE",
63
+ * // value: "STRING_VALUE",
64
+ * // },
65
+ * // ],
66
+ * // },
67
+ * // ],
68
+ * // failures: [ // Failures
69
+ * // { // Failure
70
+ * // arn: "STRING_VALUE",
71
+ * // reason: "STRING_VALUE",
72
+ * // detail: "STRING_VALUE",
73
+ * // },
74
+ * // ],
75
+ * // nextToken: "STRING_VALUE",
76
+ * // };
77
+ *
41
78
  * ```
42
79
  *
43
80
  * @param DescribeCapacityProvidersCommandInput - {@link DescribeCapacityProvidersCommandInput}
@@ -58,6 +95,8 @@ export interface DescribeCapacityProvidersCommandOutput extends DescribeCapacity
58
95
  * @throws {@link ServerException} (server fault)
59
96
  * <p>These errors are usually caused by a server issue.</p>
60
97
  *
98
+ * @throws {@link ECSServiceException}
99
+ * <p>Base exception class for all service exceptions from ECS service.</p>
61
100
  *
62
101
  */
63
102
  export declare class DescribeCapacityProvidersCommand extends $Command<DescribeCapacityProvidersCommandInput, DescribeCapacityProvidersCommandOutput, ECSClientResolvedConfig> {
package/dist-types/commands/DescribeClustersCommand.d.ts CHANGED
@@ -36,6 +36,85 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
36
36
  * };
37
37
  * const command = new DescribeClustersCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // DescribeClustersResponse
40
+ * // clusters: [ // Clusters
41
+ * // { // Cluster
42
+ * // clusterArn: "STRING_VALUE",
43
+ * // clusterName: "STRING_VALUE",
44
+ * // configuration: { // ClusterConfiguration
45
+ * // executeCommandConfiguration: { // ExecuteCommandConfiguration
46
+ * // kmsKeyId: "STRING_VALUE",
47
+ * // logging: "NONE" || "DEFAULT" || "OVERRIDE",
48
+ * // logConfiguration: { // ExecuteCommandLogConfiguration
49
+ * // cloudWatchLogGroupName: "STRING_VALUE",
50
+ * // cloudWatchEncryptionEnabled: true || false,
51
+ * // s3BucketName: "STRING_VALUE",
52
+ * // s3EncryptionEnabled: true || false,
53
+ * // s3KeyPrefix: "STRING_VALUE",
54
+ * // },
55
+ * // },
56
+ * // },
57
+ * // status: "STRING_VALUE",
58
+ * // registeredContainerInstancesCount: Number("int"),
59
+ * // runningTasksCount: Number("int"),
60
+ * // pendingTasksCount: Number("int"),
61
+ * // activeServicesCount: Number("int"),
62
+ * // statistics: [ // Statistics
63
+ * // { // KeyValuePair
64
+ * // name: "STRING_VALUE",
65
+ * // value: "STRING_VALUE",
66
+ * // },
67
+ * // ],
68
+ * // tags: [ // Tags
69
+ * // { // Tag
70
+ * // key: "STRING_VALUE",
71
+ * // value: "STRING_VALUE",
72
+ * // },
73
+ * // ],
74
+ * // settings: [ // ClusterSettings
75
+ * // { // ClusterSetting
76
+ * // name: "containerInsights",
77
+ * // value: "STRING_VALUE",
78
+ * // },
79
+ * // ],
80
+ * // capacityProviders: [ // StringList
81
+ * // "STRING_VALUE",
82
+ * // ],
83
+ * // defaultCapacityProviderStrategy: [ // CapacityProviderStrategy
84
+ * // { // CapacityProviderStrategyItem
85
+ * // capacityProvider: "STRING_VALUE", // required
86
+ * // weight: Number("int"),
87
+ * // base: Number("int"),
88
+ * // },
89
+ * // ],
90
+ * // attachments: [ // Attachments
91
+ * // { // Attachment
92
+ * // id: "STRING_VALUE",
93
+ * // type: "STRING_VALUE",
94
+ * // status: "STRING_VALUE",
95
+ * // details: [ // AttachmentDetails
96
+ * // {
97
+ * // name: "STRING_VALUE",
98
+ * // value: "STRING_VALUE",
99
+ * // },
100
+ * // ],
101
+ * // },
102
+ * // ],
103
+ * // attachmentsStatus: "STRING_VALUE",
104
+ * // serviceConnectDefaults: { // ClusterServiceConnectDefaults
105
+ * // namespace: "STRING_VALUE",
106
+ * // },
107
+ * // },
108
+ * // ],
109
+ * // failures: [ // Failures
110
+ * // { // Failure
111
+ * // arn: "STRING_VALUE",
112
+ * // reason: "STRING_VALUE",
113
+ * // detail: "STRING_VALUE",
114
+ * // },
115
+ * // ],
116
+ * // };
117
+ *
39
118
  * ```
40
119
  *
41
120
  * @param DescribeClustersCommandInput - {@link DescribeClustersCommandInput}
@@ -56,6 +135,8 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
56
135
  * @throws {@link ServerException} (server fault)
57
136
  * <p>These errors are usually caused by a server issue.</p>
58
137
  *
138
+ * @throws {@link ECSServiceException}
139
+ * <p>Base exception class for all service exceptions from ECS service.</p>
59
140
  *
60
141
  * @example To describe a cluster
61
142
  * ```javascript
package/dist-types/commands/DescribeContainerInstancesCommand.d.ts CHANGED
@@ -38,6 +38,98 @@ export interface DescribeContainerInstancesCommandOutput extends DescribeContain
38
38
  * };
39
39
  * const command = new DescribeContainerInstancesCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // DescribeContainerInstancesResponse
42
+ * // containerInstances: [ // ContainerInstances
43
+ * // { // ContainerInstance
44
+ * // containerInstanceArn: "STRING_VALUE",
45
+ * // ec2InstanceId: "STRING_VALUE",
46
+ * // capacityProviderName: "STRING_VALUE",
47
+ * // version: Number("long"),
48
+ * // versionInfo: { // VersionInfo
49
+ * // agentVersion: "STRING_VALUE",
50
+ * // agentHash: "STRING_VALUE",
51
+ * // dockerVersion: "STRING_VALUE",
52
+ * // },
53
+ * // remainingResources: [ // Resources
54
+ * // { // Resource
55
+ * // name: "STRING_VALUE",
56
+ * // type: "STRING_VALUE",
57
+ * // doubleValue: Number("double"),
58
+ * // longValue: Number("long"),
59
+ * // integerValue: Number("int"),
60
+ * // stringSetValue: [ // StringList
61
+ * // "STRING_VALUE",
62
+ * // ],
63
+ * // },
64
+ * // ],
65
+ * // registeredResources: [
66
+ * // {
67
+ * // name: "STRING_VALUE",
68
+ * // type: "STRING_VALUE",
69
+ * // doubleValue: Number("double"),
70
+ * // longValue: Number("long"),
71
+ * // integerValue: Number("int"),
72
+ * // stringSetValue: [
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // },
76
+ * // ],
77
+ * // status: "STRING_VALUE",
78
+ * // statusReason: "STRING_VALUE",
79
+ * // agentConnected: true || false,
80
+ * // runningTasksCount: Number("int"),
81
+ * // pendingTasksCount: Number("int"),
82
+ * // agentUpdateStatus: "PENDING" || "STAGING" || "STAGED" || "UPDATING" || "UPDATED" || "FAILED",
83
+ * // attributes: [ // Attributes
84
+ * // { // Attribute
85
+ * // name: "STRING_VALUE", // required
86
+ * // value: "STRING_VALUE",
87
+ * // targetType: "container-instance",
88
+ * // targetId: "STRING_VALUE",
89
+ * // },
90
+ * // ],
91
+ * // registeredAt: new Date("TIMESTAMP"),
92
+ * // attachments: [ // Attachments
93
+ * // { // Attachment
94
+ * // id: "STRING_VALUE",
95
+ * // type: "STRING_VALUE",
96
+ * // status: "STRING_VALUE",
97
+ * // details: [ // AttachmentDetails
98
+ * // { // KeyValuePair
99
+ * // name: "STRING_VALUE",
100
+ * // value: "STRING_VALUE",
101
+ * // },
102
+ * // ],
103
+ * // },
104
+ * // ],
105
+ * // tags: [ // Tags
106
+ * // { // Tag
107
+ * // key: "STRING_VALUE",
108
+ * // value: "STRING_VALUE",
109
+ * // },
110
+ * // ],
111
+ * // healthStatus: { // ContainerInstanceHealthStatus
112
+ * // overallStatus: "OK" || "IMPAIRED" || "INSUFFICIENT_DATA" || "INITIALIZING",
113
+ * // details: [ // InstanceHealthCheckResultList
114
+ * // { // InstanceHealthCheckResult
115
+ * // type: "CONTAINER_RUNTIME",
116
+ * // status: "OK" || "IMPAIRED" || "INSUFFICIENT_DATA" || "INITIALIZING",
117
+ * // lastUpdated: new Date("TIMESTAMP"),
118
+ * // lastStatusChange: new Date("TIMESTAMP"),
119
+ * // },
120
+ * // ],
121
+ * // },
122
+ * // },
123
+ * // ],
124
+ * // failures: [ // Failures
125
+ * // { // Failure
126
+ * // arn: "STRING_VALUE",
127
+ * // reason: "STRING_VALUE",
128
+ * // detail: "STRING_VALUE",
129
+ * // },
130
+ * // ],
131
+ * // };
132
+ *
41
133
  * ```
42
134
  *
43
135
  * @param DescribeContainerInstancesCommandInput - {@link DescribeContainerInstancesCommandInput}
@@ -61,6 +153,8 @@ export interface DescribeContainerInstancesCommandOutput extends DescribeContain
61
153
  * @throws {@link ServerException} (server fault)
62
154
  * <p>These errors are usually caused by a server issue.</p>
63
155
  *
156
+ * @throws {@link ECSServiceException}
157
+ * <p>Base exception class for all service exceptions from ECS service.</p>
64
158
  *
65
159
  * @example To describe container instance
66
160
  * ```javascript