@aws-sdk/client-ecs 3.325.0 → 3.327.0

package/dist-types/commands/PutAttributesCommand.d.ts

@@ -42,6 +42,17 @@ export interface PutAttributesCommandOutput extends PutAttributesResponse, __Met
  * };
  * const command = new PutAttributesCommand(input);
  * const response = await client.send(command);
+ * // { // PutAttributesResponse
+ * //   attributes: [ // Attributes
+ * //     { // Attribute
+ * //       name: "STRING_VALUE", // required
+ * //       value: "STRING_VALUE",
+ * //       targetType: "container-instance",
+ * //       targetId: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param PutAttributesCommandInput - {@link PutAttributesCommandInput}
@@ -67,6 +78,8 @@ export interface PutAttributesCommandOutput extends PutAttributesResponse, __Met
  * 			with <a>ListContainerInstances</a>. Amazon ECS container instances are
  * 			cluster-specific and Region-specific.</p>
  *
+ * @throws {@link ECSServiceException}
+ * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  */
 export declare class PutAttributesCommand extends $Command<PutAttributesCommandInput, PutAttributesCommandOutput, ECSClientResolvedConfig> {

package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts

@@ -54,6 +54,76 @@ export interface PutClusterCapacityProvidersCommandOutput extends PutClusterCapa
  * };
  * const command = new PutClusterCapacityProvidersCommand(input);
  * const response = await client.send(command);
+ * // { // PutClusterCapacityProvidersResponse
+ * //   cluster: { // Cluster
+ * //     clusterArn: "STRING_VALUE",
+ * //     clusterName: "STRING_VALUE",
+ * //     configuration: { // ClusterConfiguration
+ * //       executeCommandConfiguration: { // ExecuteCommandConfiguration
+ * //         kmsKeyId: "STRING_VALUE",
+ * //         logging: "NONE" || "DEFAULT" || "OVERRIDE",
+ * //         logConfiguration: { // ExecuteCommandLogConfiguration
+ * //           cloudWatchLogGroupName: "STRING_VALUE",
+ * //           cloudWatchEncryptionEnabled: true || false,
+ * //           s3BucketName: "STRING_VALUE",
+ * //           s3EncryptionEnabled: true || false,
+ * //           s3KeyPrefix: "STRING_VALUE",
+ * //         },
+ * //       },
+ * //     },
+ * //     status: "STRING_VALUE",
+ * //     registeredContainerInstancesCount: Number("int"),
+ * //     runningTasksCount: Number("int"),
+ * //     pendingTasksCount: Number("int"),
+ * //     activeServicesCount: Number("int"),
+ * //     statistics: [ // Statistics
+ * //       { // KeyValuePair
+ * //         name: "STRING_VALUE",
+ * //         value: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     tags: [ // Tags
+ * //       { // Tag
+ * //         key: "STRING_VALUE",
+ * //         value: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     settings: [ // ClusterSettings
+ * //       { // ClusterSetting
+ * //         name: "containerInsights",
+ * //         value: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     capacityProviders: [ // StringList
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     defaultCapacityProviderStrategy: [ // CapacityProviderStrategy
+ * //       { // CapacityProviderStrategyItem
+ * //         capacityProvider: "STRING_VALUE", // required
+ * //         weight: Number("int"),
+ * //         base: Number("int"),
+ * //       },
+ * //     ],
+ * //     attachments: [ // Attachments
+ * //       { // Attachment
+ * //         id: "STRING_VALUE",
+ * //         type: "STRING_VALUE",
+ * //         status: "STRING_VALUE",
+ * //         details: [ // AttachmentDetails
+ * //           {
+ * //             name: "STRING_VALUE",
+ * //             value: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //     attachmentsStatus: "STRING_VALUE",
+ * //     serviceConnectDefaults: { // ClusterServiceConnectDefaults
+ * //       namespace: "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param PutClusterCapacityProvidersCommandInput - {@link PutClusterCapacityProvidersCommandInput}
@@ -87,6 +157,8 @@ export interface PutClusterCapacityProvidersCommandOutput extends PutClusterCapa
  * 			process can get stuck in that state. However, when the agent reconnects, it resumes
  * 			where it stopped previously.</p>
  *
+ * @throws {@link ECSServiceException}
+ * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  */
 export declare class PutClusterCapacityProvidersCommand extends $Command<PutClusterCapacityProvidersCommandInput, PutClusterCapacityProvidersCommandOutput, ECSClientResolvedConfig> {

package/dist-types/commands/RegisterContainerInstanceCommand.d.ts

@@ -75,6 +75,89 @@ export interface RegisterContainerInstanceCommandOutput extends RegisterContaine
  * };
  * const command = new RegisterContainerInstanceCommand(input);
  * const response = await client.send(command);
+ * // { // RegisterContainerInstanceResponse
+ * //   containerInstance: { // ContainerInstance
+ * //     containerInstanceArn: "STRING_VALUE",
+ * //     ec2InstanceId: "STRING_VALUE",
+ * //     capacityProviderName: "STRING_VALUE",
+ * //     version: Number("long"),
+ * //     versionInfo: { // VersionInfo
+ * //       agentVersion: "STRING_VALUE",
+ * //       agentHash: "STRING_VALUE",
+ * //       dockerVersion: "STRING_VALUE",
+ * //     },
+ * //     remainingResources: [ // Resources
+ * //       { // Resource
+ * //         name: "STRING_VALUE",
+ * //         type: "STRING_VALUE",
+ * //         doubleValue: Number("double"),
+ * //         longValue: Number("long"),
+ * //         integerValue: Number("int"),
+ * //         stringSetValue: [ // StringList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //     ],
+ * //     registeredResources: [
+ * //       {
+ * //         name: "STRING_VALUE",
+ * //         type: "STRING_VALUE",
+ * //         doubleValue: Number("double"),
+ * //         longValue: Number("long"),
+ * //         integerValue: Number("int"),
+ * //         stringSetValue: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //     ],
+ * //     status: "STRING_VALUE",
+ * //     statusReason: "STRING_VALUE",
+ * //     agentConnected: true || false,
+ * //     runningTasksCount: Number("int"),
+ * //     pendingTasksCount: Number("int"),
+ * //     agentUpdateStatus: "PENDING" || "STAGING" || "STAGED" || "UPDATING" || "UPDATED" || "FAILED",
+ * //     attributes: [ // Attributes
+ * //       { // Attribute
+ * //         name: "STRING_VALUE", // required
+ * //         value: "STRING_VALUE",
+ * //         targetType: "container-instance",
+ * //         targetId: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     registeredAt: new Date("TIMESTAMP"),
+ * //     attachments: [ // Attachments
+ * //       { // Attachment
+ * //         id: "STRING_VALUE",
+ * //         type: "STRING_VALUE",
+ * //         status: "STRING_VALUE",
+ * //         details: [ // AttachmentDetails
+ * //           { // KeyValuePair
+ * //             name: "STRING_VALUE",
+ * //             value: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //       },
+ * //     ],
+ * //     tags: [ // Tags
+ * //       { // Tag
+ * //         key: "STRING_VALUE",
+ * //         value: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     healthStatus: { // ContainerInstanceHealthStatus
+ * //       overallStatus: "OK" || "IMPAIRED" || "INSUFFICIENT_DATA" || "INITIALIZING",
+ * //       details: [ // InstanceHealthCheckResultList
+ * //         { // InstanceHealthCheckResult
+ * //           type: "CONTAINER_RUNTIME",
+ * //           status: "OK" || "IMPAIRED" || "INSUFFICIENT_DATA" || "INITIALIZING",
+ * //           lastUpdated: new Date("TIMESTAMP"),
+ * //           lastStatusChange: new Date("TIMESTAMP"),
+ * //         },
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param RegisterContainerInstanceCommandInput - {@link RegisterContainerInstanceCommandInput}
@@ -95,6 +178,8 @@ export interface RegisterContainerInstanceCommandOutput extends RegisterContaine
  * @throws {@link ServerException} (server fault)
  *  <p>These errors are usually caused by a server issue.</p>
  *
+ * @throws {@link ECSServiceException}
+ * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  */
 export declare class RegisterContainerInstanceCommand extends $Command<RegisterContainerInstanceCommandInput, RegisterContainerInstanceCommandOutput, ECSClientResolvedConfig> {

package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts

@@ -295,6 +295,276 @@ export interface RegisterTaskDefinitionCommandOutput extends RegisterTaskDefinit
  * };
  * const command = new RegisterTaskDefinitionCommand(input);
  * const response = await client.send(command);
+ * // { // RegisterTaskDefinitionResponse
+ * //   taskDefinition: { // TaskDefinition
+ * //     taskDefinitionArn: "STRING_VALUE",
+ * //     containerDefinitions: [ // ContainerDefinitions
+ * //       { // ContainerDefinition
+ * //         name: "STRING_VALUE",
+ * //         image: "STRING_VALUE",
+ * //         repositoryCredentials: { // RepositoryCredentials
+ * //           credentialsParameter: "STRING_VALUE", // required
+ * //         },
+ * //         cpu: Number("int"),
+ * //         memory: Number("int"),
+ * //         memoryReservation: Number("int"),
+ * //         links: [ // StringList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         portMappings: [ // PortMappingList
+ * //           { // PortMapping
+ * //             containerPort: Number("int"),
+ * //             hostPort: Number("int"),
+ * //             protocol: "tcp" || "udp",
+ * //             name: "STRING_VALUE",
+ * //             appProtocol: "http" || "http2" || "grpc",
+ * //             containerPortRange: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //         essential: true || false,
+ * //         entryPoint: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         command: [
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         environment: [ // EnvironmentVariables
+ * //           { // KeyValuePair
+ * //             name: "STRING_VALUE",
+ * //             value: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //         environmentFiles: [ // EnvironmentFiles
+ * //           { // EnvironmentFile
+ * //             value: "STRING_VALUE", // required
+ * //             type: "s3", // required
+ * //           },
+ * //         ],
+ * //         mountPoints: [ // MountPointList
+ * //           { // MountPoint
+ * //             sourceVolume: "STRING_VALUE",
+ * //             containerPath: "STRING_VALUE",
+ * //             readOnly: true || false,
+ * //           },
+ * //         ],
+ * //         volumesFrom: [ // VolumeFromList
+ * //           { // VolumeFrom
+ * //             sourceContainer: "STRING_VALUE",
+ * //             readOnly: true || false,
+ * //           },
+ * //         ],
+ * //         linuxParameters: { // LinuxParameters
+ * //           capabilities: { // KernelCapabilities
+ * //             add: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //             drop: [
+ * //               "STRING_VALUE",
+ * //             ],
+ * //           },
+ * //           devices: [ // DevicesList
+ * //             { // Device
+ * //               hostPath: "STRING_VALUE", // required
+ * //               containerPath: "STRING_VALUE",
+ * //               permissions: [ // DeviceCgroupPermissions
+ * //                 "read" || "write" || "mknod",
+ * //               ],
+ * //             },
+ * //           ],
+ * //           initProcessEnabled: true || false,
+ * //           sharedMemorySize: Number("int"),
+ * //           tmpfs: [ // TmpfsList
+ * //             { // Tmpfs
+ * //               containerPath: "STRING_VALUE", // required
+ * //               size: Number("int"), // required
+ * //               mountOptions: "<StringList>",
+ * //             },
+ * //           ],
+ * //           maxSwap: Number("int"),
+ * //           swappiness: Number("int"),
+ * //         },
+ * //         secrets: [ // SecretList
+ * //           { // Secret
+ * //             name: "STRING_VALUE", // required
+ * //             valueFrom: "STRING_VALUE", // required
+ * //           },
+ * //         ],
+ * //         dependsOn: [ // ContainerDependencies
+ * //           { // ContainerDependency
+ * //             containerName: "STRING_VALUE", // required
+ * //             condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
+ * //           },
+ * //         ],
+ * //         startTimeout: Number("int"),
+ * //         stopTimeout: Number("int"),
+ * //         hostname: "STRING_VALUE",
+ * //         user: "STRING_VALUE",
+ * //         workingDirectory: "STRING_VALUE",
+ * //         disableNetworking: true || false,
+ * //         privileged: true || false,
+ * //         readonlyRootFilesystem: true || false,
+ * //         dnsServers: "<StringList>",
+ * //         dnsSearchDomains: "<StringList>",
+ * //         extraHosts: [ // HostEntryList
+ * //           { // HostEntry
+ * //             hostname: "STRING_VALUE", // required
+ * //             ipAddress: "STRING_VALUE", // required
+ * //           },
+ * //         ],
+ * //         dockerSecurityOptions: "<StringList>",
+ * //         interactive: true || false,
+ * //         pseudoTerminal: true || false,
+ * //         dockerLabels: { // DockerLabelsMap
+ * //           "<keys>": "STRING_VALUE",
+ * //         },
+ * //         ulimits: [ // UlimitList
+ * //           { // Ulimit
+ * //             name: "core" || "cpu" || "data" || "fsize" || "locks" || "memlock" || "msgqueue" || "nice" || "nofile" || "nproc" || "rss" || "rtprio" || "rttime" || "sigpending" || "stack", // required
+ * //             softLimit: Number("int"), // required
+ * //             hardLimit: Number("int"), // required
+ * //           },
+ * //         ],
+ * //         logConfiguration: { // LogConfiguration
+ * //           logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk" || "awsfirelens", // required
+ * //           options: { // LogConfigurationOptionsMap
+ * //             "<keys>": "STRING_VALUE",
+ * //           },
+ * //           secretOptions: [
+ * //             {
+ * //               name: "STRING_VALUE", // required
+ * //               valueFrom: "STRING_VALUE", // required
+ * //             },
+ * //           ],
+ * //         },
+ * //         healthCheck: { // HealthCheck
+ * //           command: "<StringList>", // required
+ * //           interval: Number("int"),
+ * //           timeout: Number("int"),
+ * //           retries: Number("int"),
+ * //           startPeriod: Number("int"),
+ * //         },
+ * //         systemControls: [ // SystemControls
+ * //           { // SystemControl
+ * //             namespace: "STRING_VALUE",
+ * //             value: "STRING_VALUE",
+ * //           },
+ * //         ],
+ * //         resourceRequirements: [ // ResourceRequirements
+ * //           { // ResourceRequirement
+ * //             value: "STRING_VALUE", // required
+ * //             type: "GPU" || "InferenceAccelerator", // required
+ * //           },
+ * //         ],
+ * //         firelensConfiguration: { // FirelensConfiguration
+ * //           type: "fluentd" || "fluentbit", // required
+ * //           options: { // FirelensConfigurationOptionsMap
+ * //             "<keys>": "STRING_VALUE",
+ * //           },
+ * //         },
+ * //       },
+ * //     ],
+ * //     family: "STRING_VALUE",
+ * //     taskRoleArn: "STRING_VALUE",
+ * //     executionRoleArn: "STRING_VALUE",
+ * //     networkMode: "bridge" || "host" || "awsvpc" || "none",
+ * //     revision: Number("int"),
+ * //     volumes: [ // VolumeList
+ * //       { // Volume
+ * //         name: "STRING_VALUE",
+ * //         host: { // HostVolumeProperties
+ * //           sourcePath: "STRING_VALUE",
+ * //         },
+ * //         dockerVolumeConfiguration: { // DockerVolumeConfiguration
+ * //           scope: "task" || "shared",
+ * //           autoprovision: true || false,
+ * //           driver: "STRING_VALUE",
+ * //           driverOpts: { // StringMap
+ * //             "<keys>": "STRING_VALUE",
+ * //           },
+ * //           labels: {
+ * //             "<keys>": "STRING_VALUE",
+ * //           },
+ * //         },
+ * //         efsVolumeConfiguration: { // EFSVolumeConfiguration
+ * //           fileSystemId: "STRING_VALUE", // required
+ * //           rootDirectory: "STRING_VALUE",
+ * //           transitEncryption: "ENABLED" || "DISABLED",
+ * //           transitEncryptionPort: Number("int"),
+ * //           authorizationConfig: { // EFSAuthorizationConfig
+ * //             accessPointId: "STRING_VALUE",
+ * //             iam: "ENABLED" || "DISABLED",
+ * //           },
+ * //         },
+ * //         fsxWindowsFileServerVolumeConfiguration: { // FSxWindowsFileServerVolumeConfiguration
+ * //           fileSystemId: "STRING_VALUE", // required
+ * //           rootDirectory: "STRING_VALUE", // required
+ * //           authorizationConfig: { // FSxWindowsFileServerAuthorizationConfig
+ * //             credentialsParameter: "STRING_VALUE", // required
+ * //             domain: "STRING_VALUE", // required
+ * //           },
+ * //         },
+ * //       },
+ * //     ],
+ * //     status: "ACTIVE" || "INACTIVE" || "DELETE_IN_PROGRESS",
+ * //     requiresAttributes: [ // RequiresAttributes
+ * //       { // Attribute
+ * //         name: "STRING_VALUE", // required
+ * //         value: "STRING_VALUE",
+ * //         targetType: "container-instance",
+ * //         targetId: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     placementConstraints: [ // TaskDefinitionPlacementConstraints
+ * //       { // TaskDefinitionPlacementConstraint
+ * //         type: "memberOf",
+ * //         expression: "STRING_VALUE",
+ * //       },
+ * //     ],
+ * //     compatibilities: [ // CompatibilityList
+ * //       "EC2" || "FARGATE" || "EXTERNAL",
+ * //     ],
+ * //     runtimePlatform: { // RuntimePlatform
+ * //       cpuArchitecture: "X86_64" || "ARM64",
+ * //       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",
+ * //     },
+ * //     requiresCompatibilities: [
+ * //       "EC2" || "FARGATE" || "EXTERNAL",
+ * //     ],
+ * //     cpu: "STRING_VALUE",
+ * //     memory: "STRING_VALUE",
+ * //     inferenceAccelerators: [ // InferenceAccelerators
+ * //       { // InferenceAccelerator
+ * //         deviceName: "STRING_VALUE", // required
+ * //         deviceType: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     pidMode: "host" || "task",
+ * //     ipcMode: "host" || "task" || "none",
+ * //     proxyConfiguration: { // ProxyConfiguration
+ * //       type: "APPMESH",
+ * //       containerName: "STRING_VALUE", // required
+ * //       properties: [ // ProxyConfigurationProperties
+ * //         {
+ * //           name: "STRING_VALUE",
+ * //           value: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //     },
+ * //     registeredAt: new Date("TIMESTAMP"),
+ * //     deregisteredAt: new Date("TIMESTAMP"),
+ * //     registeredBy: "STRING_VALUE",
+ * //     ephemeralStorage: { // EphemeralStorage
+ * //       sizeInGiB: Number("int"), // required
+ * //     },
+ * //   },
+ * //   tags: [ // Tags
+ * //     { // Tag
+ * //       key: "STRING_VALUE",
+ * //       value: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param RegisterTaskDefinitionCommandInput - {@link RegisterTaskDefinitionCommandInput}
@@ -315,6 +585,8 @@ export interface RegisterTaskDefinitionCommandOutput extends RegisterTaskDefinit
  * @throws {@link ServerException} (server fault)
  *  <p>These errors are usually caused by a server issue.</p>
  *
+ * @throws {@link ECSServiceException}
+ * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @example To register a task definition
  * ```javascript