@aws-sdk/client-ecs 3.299.0 → 3.301.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 +20 -0
- package/dist-types/commands/CreateClusterCommand.d.ts +41 -0
- package/dist-types/commands/CreateServiceCommand.d.ts +114 -0
- package/dist-types/commands/CreateTaskSetCommand.d.ts +53 -0
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +4 -0
- package/dist-types/commands/DeleteAttributesCommand.d.ts +11 -0
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +3 -0
- package/dist-types/commands/DeleteClusterCommand.d.ts +3 -0
- package/dist-types/commands/DeleteServiceCommand.d.ts +5 -0
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +5 -0
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +6 -0
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +5 -0
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +3 -0
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +10 -0
- package/dist-types/commands/DescribeClustersCommand.d.ts +8 -0
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +9 -0
- package/dist-types/commands/DescribeServicesCommand.d.ts +9 -0
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +6 -0
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +10 -0
- package/dist-types/commands/DescribeTasksCommand.d.ts +9 -0
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +4 -0
- package/dist-types/commands/ExecuteCommandCommand.d.ts +7 -0
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +6 -0
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +8 -0
- package/dist-types/commands/ListAttributesCommand.d.ts +8 -0
- package/dist-types/commands/ListClustersCommand.d.ts +4 -0
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +7 -0
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +5 -0
- package/dist-types/commands/ListServicesCommand.d.ts +7 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +6 -0
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +7 -0
- package/dist-types/commands/ListTasksCommand.d.ts +11 -0
- package/dist-types/commands/PutAccountSettingCommand.d.ts +5 -0
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +4 -0
- package/dist-types/commands/PutAttributesCommand.d.ts +11 -0
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +13 -0
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +43 -0
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +250 -0
- package/dist-types/commands/RunTaskCommand.d.ts +93 -0
- package/dist-types/commands/StartTaskCommand.d.ts +72 -0
- package/dist-types/commands/StopTaskCommand.d.ts +5 -0
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +9 -0
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +19 -0
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +43 -0
- package/dist-types/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +13 -0
- package/dist-types/commands/UpdateClusterCommand.d.ts +25 -0
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +9 -0
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +4 -0
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +7 -0
- package/dist-types/commands/UpdateServiceCommand.d.ts +102 -0
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +5 -0
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +8 -0
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +9 -0
- package/package.json +8 -8
|
@@ -28,6 +28,13 @@ export interface ListTaskDefinitionsCommandOutput extends ListTaskDefinitionsRes
|
|
|
28
28
|
* import { ECSClient, ListTaskDefinitionsCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
29
29
|
* // const { ECSClient, ListTaskDefinitionsCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
30
30
|
* const client = new ECSClient(config);
|
|
31
|
+
* const input = { // ListTaskDefinitionsRequest
|
|
32
|
+
* familyPrefix: "STRING_VALUE",
|
|
33
|
+
* status: "ACTIVE" || "INACTIVE" || "DELETE_IN_PROGRESS",
|
|
34
|
+
* sort: "ASC" || "DESC",
|
|
35
|
+
* nextToken: "STRING_VALUE",
|
|
36
|
+
* maxResults: Number("int"),
|
|
37
|
+
* };
|
|
31
38
|
* const command = new ListTaskDefinitionsCommand(input);
|
|
32
39
|
* const response = await client.send(command);
|
|
33
40
|
* ```
|
|
@@ -30,6 +30,17 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea
|
|
|
30
30
|
* import { ECSClient, ListTasksCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
31
31
|
* // const { ECSClient, ListTasksCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
32
32
|
* const client = new ECSClient(config);
|
|
33
|
+
* const input = { // ListTasksRequest
|
|
34
|
+
* cluster: "STRING_VALUE",
|
|
35
|
+
* containerInstance: "STRING_VALUE",
|
|
36
|
+
* family: "STRING_VALUE",
|
|
37
|
+
* nextToken: "STRING_VALUE",
|
|
38
|
+
* maxResults: Number("int"),
|
|
39
|
+
* startedBy: "STRING_VALUE",
|
|
40
|
+
* serviceName: "STRING_VALUE",
|
|
41
|
+
* desiredStatus: "RUNNING" || "PENDING" || "STOPPED",
|
|
42
|
+
* launchType: "EC2" || "FARGATE" || "EXTERNAL",
|
|
43
|
+
* };
|
|
33
44
|
* const command = new ListTasksCommand(input);
|
|
34
45
|
* const response = await client.send(command);
|
|
35
46
|
* ```
|
|
@@ -49,6 +49,11 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons
|
|
|
49
49
|
* import { ECSClient, PutAccountSettingCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
50
50
|
* // const { ECSClient, PutAccountSettingCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
51
51
|
* const client = new ECSClient(config);
|
|
52
|
+
* const input = { // PutAccountSettingRequest
|
|
53
|
+
* name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights", // required
|
|
54
|
+
* value: "STRING_VALUE", // required
|
|
55
|
+
* principalArn: "STRING_VALUE",
|
|
56
|
+
* };
|
|
52
57
|
* const command = new PutAccountSettingCommand(input);
|
|
53
58
|
* const response = await client.send(command);
|
|
54
59
|
* ```
|
|
@@ -28,6 +28,10 @@ export interface PutAccountSettingDefaultCommandOutput extends PutAccountSetting
|
|
|
28
28
|
* import { ECSClient, PutAccountSettingDefaultCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
29
29
|
* // const { ECSClient, PutAccountSettingDefaultCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
30
30
|
* const client = new ECSClient(config);
|
|
31
|
+
* const input = { // PutAccountSettingDefaultRequest
|
|
32
|
+
* name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights", // required
|
|
33
|
+
* value: "STRING_VALUE", // required
|
|
34
|
+
* };
|
|
31
35
|
* const command = new PutAccountSettingDefaultCommand(input);
|
|
32
36
|
* const response = await client.send(command);
|
|
33
37
|
* ```
|
|
@@ -29,6 +29,17 @@ export interface PutAttributesCommandOutput extends PutAttributesResponse, __Met
|
|
|
29
29
|
* import { ECSClient, PutAttributesCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
30
30
|
* // const { ECSClient, PutAttributesCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
31
31
|
* const client = new ECSClient(config);
|
|
32
|
+
* const input = { // PutAttributesRequest
|
|
33
|
+
* cluster: "STRING_VALUE",
|
|
34
|
+
* attributes: [ // Attributes // required
|
|
35
|
+
* { // Attribute
|
|
36
|
+
* name: "STRING_VALUE", // required
|
|
37
|
+
* value: "STRING_VALUE",
|
|
38
|
+
* targetType: "container-instance",
|
|
39
|
+
* targetId: "STRING_VALUE",
|
|
40
|
+
* },
|
|
41
|
+
* ],
|
|
42
|
+
* };
|
|
32
43
|
* const command = new PutAttributesCommand(input);
|
|
33
44
|
* const response = await client.send(command);
|
|
34
45
|
* ```
|
|
@@ -39,6 +39,19 @@ export interface PutClusterCapacityProvidersCommandOutput extends PutClusterCapa
|
|
|
39
39
|
* import { ECSClient, PutClusterCapacityProvidersCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
40
40
|
* // const { ECSClient, PutClusterCapacityProvidersCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
41
41
|
* const client = new ECSClient(config);
|
|
42
|
+
* const input = { // PutClusterCapacityProvidersRequest
|
|
43
|
+
* cluster: "STRING_VALUE", // required
|
|
44
|
+
* capacityProviders: [ // StringList // required
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* defaultCapacityProviderStrategy: [ // CapacityProviderStrategy // required
|
|
48
|
+
* { // CapacityProviderStrategyItem
|
|
49
|
+
* capacityProvider: "STRING_VALUE", // required
|
|
50
|
+
* weight: Number("int"),
|
|
51
|
+
* base: Number("int"),
|
|
52
|
+
* },
|
|
53
|
+
* ],
|
|
54
|
+
* };
|
|
42
55
|
* const command = new PutClusterCapacityProvidersCommand(input);
|
|
43
56
|
* const response = await client.send(command);
|
|
44
57
|
* ```
|
|
@@ -30,6 +30,49 @@ export interface RegisterContainerInstanceCommandOutput extends RegisterContaine
|
|
|
30
30
|
* import { ECSClient, RegisterContainerInstanceCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
31
31
|
* // const { ECSClient, RegisterContainerInstanceCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
32
32
|
* const client = new ECSClient(config);
|
|
33
|
+
* const input = { // RegisterContainerInstanceRequest
|
|
34
|
+
* cluster: "STRING_VALUE",
|
|
35
|
+
* instanceIdentityDocument: "STRING_VALUE",
|
|
36
|
+
* instanceIdentityDocumentSignature: "STRING_VALUE",
|
|
37
|
+
* totalResources: [ // Resources
|
|
38
|
+
* { // Resource
|
|
39
|
+
* name: "STRING_VALUE",
|
|
40
|
+
* type: "STRING_VALUE",
|
|
41
|
+
* doubleValue: Number("double"),
|
|
42
|
+
* longValue: Number("long"),
|
|
43
|
+
* integerValue: Number("int"),
|
|
44
|
+
* stringSetValue: [ // StringList
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* },
|
|
48
|
+
* ],
|
|
49
|
+
* versionInfo: { // VersionInfo
|
|
50
|
+
* agentVersion: "STRING_VALUE",
|
|
51
|
+
* agentHash: "STRING_VALUE",
|
|
52
|
+
* dockerVersion: "STRING_VALUE",
|
|
53
|
+
* },
|
|
54
|
+
* containerInstanceArn: "STRING_VALUE",
|
|
55
|
+
* attributes: [ // Attributes
|
|
56
|
+
* { // Attribute
|
|
57
|
+
* name: "STRING_VALUE", // required
|
|
58
|
+
* value: "STRING_VALUE",
|
|
59
|
+
* targetType: "container-instance",
|
|
60
|
+
* targetId: "STRING_VALUE",
|
|
61
|
+
* },
|
|
62
|
+
* ],
|
|
63
|
+
* platformDevices: [ // PlatformDevices
|
|
64
|
+
* { // PlatformDevice
|
|
65
|
+
* id: "STRING_VALUE", // required
|
|
66
|
+
* type: "GPU", // required
|
|
67
|
+
* },
|
|
68
|
+
* ],
|
|
69
|
+
* tags: [ // Tags
|
|
70
|
+
* { // Tag
|
|
71
|
+
* key: "STRING_VALUE",
|
|
72
|
+
* value: "STRING_VALUE",
|
|
73
|
+
* },
|
|
74
|
+
* ],
|
|
75
|
+
* };
|
|
33
76
|
* const command = new RegisterContainerInstanceCommand(input);
|
|
34
77
|
* const response = await client.send(command);
|
|
35
78
|
* ```
|
|
@@ -43,6 +43,256 @@ export interface RegisterTaskDefinitionCommandOutput extends RegisterTaskDefinit
|
|
|
43
43
|
* import { ECSClient, RegisterTaskDefinitionCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
44
44
|
* // const { ECSClient, RegisterTaskDefinitionCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
45
45
|
* const client = new ECSClient(config);
|
|
46
|
+
* const input = { // RegisterTaskDefinitionRequest
|
|
47
|
+
* family: "STRING_VALUE", // required
|
|
48
|
+
* taskRoleArn: "STRING_VALUE",
|
|
49
|
+
* executionRoleArn: "STRING_VALUE",
|
|
50
|
+
* networkMode: "bridge" || "host" || "awsvpc" || "none",
|
|
51
|
+
* containerDefinitions: [ // ContainerDefinitions // required
|
|
52
|
+
* { // ContainerDefinition
|
|
53
|
+
* name: "STRING_VALUE",
|
|
54
|
+
* image: "STRING_VALUE",
|
|
55
|
+
* repositoryCredentials: { // RepositoryCredentials
|
|
56
|
+
* credentialsParameter: "STRING_VALUE", // required
|
|
57
|
+
* },
|
|
58
|
+
* cpu: Number("int"),
|
|
59
|
+
* memory: Number("int"),
|
|
60
|
+
* memoryReservation: Number("int"),
|
|
61
|
+
* links: [ // StringList
|
|
62
|
+
* "STRING_VALUE",
|
|
63
|
+
* ],
|
|
64
|
+
* portMappings: [ // PortMappingList
|
|
65
|
+
* { // PortMapping
|
|
66
|
+
* containerPort: Number("int"),
|
|
67
|
+
* hostPort: Number("int"),
|
|
68
|
+
* protocol: "tcp" || "udp",
|
|
69
|
+
* name: "STRING_VALUE",
|
|
70
|
+
* appProtocol: "http" || "http2" || "grpc",
|
|
71
|
+
* containerPortRange: "STRING_VALUE",
|
|
72
|
+
* },
|
|
73
|
+
* ],
|
|
74
|
+
* essential: true || false,
|
|
75
|
+
* entryPoint: [
|
|
76
|
+
* "STRING_VALUE",
|
|
77
|
+
* ],
|
|
78
|
+
* command: [
|
|
79
|
+
* "STRING_VALUE",
|
|
80
|
+
* ],
|
|
81
|
+
* environment: [ // EnvironmentVariables
|
|
82
|
+
* { // KeyValuePair
|
|
83
|
+
* name: "STRING_VALUE",
|
|
84
|
+
* value: "STRING_VALUE",
|
|
85
|
+
* },
|
|
86
|
+
* ],
|
|
87
|
+
* environmentFiles: [ // EnvironmentFiles
|
|
88
|
+
* { // EnvironmentFile
|
|
89
|
+
* value: "STRING_VALUE", // required
|
|
90
|
+
* type: "s3", // required
|
|
91
|
+
* },
|
|
92
|
+
* ],
|
|
93
|
+
* mountPoints: [ // MountPointList
|
|
94
|
+
* { // MountPoint
|
|
95
|
+
* sourceVolume: "STRING_VALUE",
|
|
96
|
+
* containerPath: "STRING_VALUE",
|
|
97
|
+
* readOnly: true || false,
|
|
98
|
+
* },
|
|
99
|
+
* ],
|
|
100
|
+
* volumesFrom: [ // VolumeFromList
|
|
101
|
+
* { // VolumeFrom
|
|
102
|
+
* sourceContainer: "STRING_VALUE",
|
|
103
|
+
* readOnly: true || false,
|
|
104
|
+
* },
|
|
105
|
+
* ],
|
|
106
|
+
* linuxParameters: { // LinuxParameters
|
|
107
|
+
* capabilities: { // KernelCapabilities
|
|
108
|
+
* add: [
|
|
109
|
+
* "STRING_VALUE",
|
|
110
|
+
* ],
|
|
111
|
+
* drop: [
|
|
112
|
+
* "STRING_VALUE",
|
|
113
|
+
* ],
|
|
114
|
+
* },
|
|
115
|
+
* devices: [ // DevicesList
|
|
116
|
+
* { // Device
|
|
117
|
+
* hostPath: "STRING_VALUE", // required
|
|
118
|
+
* containerPath: "STRING_VALUE",
|
|
119
|
+
* permissions: [ // DeviceCgroupPermissions
|
|
120
|
+
* "read" || "write" || "mknod",
|
|
121
|
+
* ],
|
|
122
|
+
* },
|
|
123
|
+
* ],
|
|
124
|
+
* initProcessEnabled: true || false,
|
|
125
|
+
* sharedMemorySize: Number("int"),
|
|
126
|
+
* tmpfs: [ // TmpfsList
|
|
127
|
+
* { // Tmpfs
|
|
128
|
+
* containerPath: "STRING_VALUE", // required
|
|
129
|
+
* size: Number("int"), // required
|
|
130
|
+
* mountOptions: "<StringList>",
|
|
131
|
+
* },
|
|
132
|
+
* ],
|
|
133
|
+
* maxSwap: Number("int"),
|
|
134
|
+
* swappiness: Number("int"),
|
|
135
|
+
* },
|
|
136
|
+
* secrets: [ // SecretList
|
|
137
|
+
* { // Secret
|
|
138
|
+
* name: "STRING_VALUE", // required
|
|
139
|
+
* valueFrom: "STRING_VALUE", // required
|
|
140
|
+
* },
|
|
141
|
+
* ],
|
|
142
|
+
* dependsOn: [ // ContainerDependencies
|
|
143
|
+
* { // ContainerDependency
|
|
144
|
+
* containerName: "STRING_VALUE", // required
|
|
145
|
+
* condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
|
|
146
|
+
* },
|
|
147
|
+
* ],
|
|
148
|
+
* startTimeout: Number("int"),
|
|
149
|
+
* stopTimeout: Number("int"),
|
|
150
|
+
* hostname: "STRING_VALUE",
|
|
151
|
+
* user: "STRING_VALUE",
|
|
152
|
+
* workingDirectory: "STRING_VALUE",
|
|
153
|
+
* disableNetworking: true || false,
|
|
154
|
+
* privileged: true || false,
|
|
155
|
+
* readonlyRootFilesystem: true || false,
|
|
156
|
+
* dnsServers: "<StringList>",
|
|
157
|
+
* dnsSearchDomains: "<StringList>",
|
|
158
|
+
* extraHosts: [ // HostEntryList
|
|
159
|
+
* { // HostEntry
|
|
160
|
+
* hostname: "STRING_VALUE", // required
|
|
161
|
+
* ipAddress: "STRING_VALUE", // required
|
|
162
|
+
* },
|
|
163
|
+
* ],
|
|
164
|
+
* dockerSecurityOptions: "<StringList>",
|
|
165
|
+
* interactive: true || false,
|
|
166
|
+
* pseudoTerminal: true || false,
|
|
167
|
+
* dockerLabels: { // DockerLabelsMap
|
|
168
|
+
* "<keys>": "STRING_VALUE",
|
|
169
|
+
* },
|
|
170
|
+
* ulimits: [ // UlimitList
|
|
171
|
+
* { // Ulimit
|
|
172
|
+
* name: "core" || "cpu" || "data" || "fsize" || "locks" || "memlock" || "msgqueue" || "nice" || "nofile" || "nproc" || "rss" || "rtprio" || "rttime" || "sigpending" || "stack", // required
|
|
173
|
+
* softLimit: Number("int"), // required
|
|
174
|
+
* hardLimit: Number("int"), // required
|
|
175
|
+
* },
|
|
176
|
+
* ],
|
|
177
|
+
* logConfiguration: { // LogConfiguration
|
|
178
|
+
* logDriver: "json-file" || "syslog" || "journald" || "gelf" || "fluentd" || "awslogs" || "splunk" || "awsfirelens", // required
|
|
179
|
+
* options: { // LogConfigurationOptionsMap
|
|
180
|
+
* "<keys>": "STRING_VALUE",
|
|
181
|
+
* },
|
|
182
|
+
* secretOptions: [
|
|
183
|
+
* {
|
|
184
|
+
* name: "STRING_VALUE", // required
|
|
185
|
+
* valueFrom: "STRING_VALUE", // required
|
|
186
|
+
* },
|
|
187
|
+
* ],
|
|
188
|
+
* },
|
|
189
|
+
* healthCheck: { // HealthCheck
|
|
190
|
+
* command: "<StringList>", // required
|
|
191
|
+
* interval: Number("int"),
|
|
192
|
+
* timeout: Number("int"),
|
|
193
|
+
* retries: Number("int"),
|
|
194
|
+
* startPeriod: Number("int"),
|
|
195
|
+
* },
|
|
196
|
+
* systemControls: [ // SystemControls
|
|
197
|
+
* { // SystemControl
|
|
198
|
+
* namespace: "STRING_VALUE",
|
|
199
|
+
* value: "STRING_VALUE",
|
|
200
|
+
* },
|
|
201
|
+
* ],
|
|
202
|
+
* resourceRequirements: [ // ResourceRequirements
|
|
203
|
+
* { // ResourceRequirement
|
|
204
|
+
* value: "STRING_VALUE", // required
|
|
205
|
+
* type: "GPU" || "InferenceAccelerator", // required
|
|
206
|
+
* },
|
|
207
|
+
* ],
|
|
208
|
+
* firelensConfiguration: { // FirelensConfiguration
|
|
209
|
+
* type: "fluentd" || "fluentbit", // required
|
|
210
|
+
* options: { // FirelensConfigurationOptionsMap
|
|
211
|
+
* "<keys>": "STRING_VALUE",
|
|
212
|
+
* },
|
|
213
|
+
* },
|
|
214
|
+
* },
|
|
215
|
+
* ],
|
|
216
|
+
* volumes: [ // VolumeList
|
|
217
|
+
* { // Volume
|
|
218
|
+
* name: "STRING_VALUE",
|
|
219
|
+
* host: { // HostVolumeProperties
|
|
220
|
+
* sourcePath: "STRING_VALUE",
|
|
221
|
+
* },
|
|
222
|
+
* dockerVolumeConfiguration: { // DockerVolumeConfiguration
|
|
223
|
+
* scope: "task" || "shared",
|
|
224
|
+
* autoprovision: true || false,
|
|
225
|
+
* driver: "STRING_VALUE",
|
|
226
|
+
* driverOpts: { // StringMap
|
|
227
|
+
* "<keys>": "STRING_VALUE",
|
|
228
|
+
* },
|
|
229
|
+
* labels: {
|
|
230
|
+
* "<keys>": "STRING_VALUE",
|
|
231
|
+
* },
|
|
232
|
+
* },
|
|
233
|
+
* efsVolumeConfiguration: { // EFSVolumeConfiguration
|
|
234
|
+
* fileSystemId: "STRING_VALUE", // required
|
|
235
|
+
* rootDirectory: "STRING_VALUE",
|
|
236
|
+
* transitEncryption: "ENABLED" || "DISABLED",
|
|
237
|
+
* transitEncryptionPort: Number("int"),
|
|
238
|
+
* authorizationConfig: { // EFSAuthorizationConfig
|
|
239
|
+
* accessPointId: "STRING_VALUE",
|
|
240
|
+
* iam: "ENABLED" || "DISABLED",
|
|
241
|
+
* },
|
|
242
|
+
* },
|
|
243
|
+
* fsxWindowsFileServerVolumeConfiguration: { // FSxWindowsFileServerVolumeConfiguration
|
|
244
|
+
* fileSystemId: "STRING_VALUE", // required
|
|
245
|
+
* rootDirectory: "STRING_VALUE", // required
|
|
246
|
+
* authorizationConfig: { // FSxWindowsFileServerAuthorizationConfig
|
|
247
|
+
* credentialsParameter: "STRING_VALUE", // required
|
|
248
|
+
* domain: "STRING_VALUE", // required
|
|
249
|
+
* },
|
|
250
|
+
* },
|
|
251
|
+
* },
|
|
252
|
+
* ],
|
|
253
|
+
* placementConstraints: [ // TaskDefinitionPlacementConstraints
|
|
254
|
+
* { // TaskDefinitionPlacementConstraint
|
|
255
|
+
* type: "memberOf",
|
|
256
|
+
* expression: "STRING_VALUE",
|
|
257
|
+
* },
|
|
258
|
+
* ],
|
|
259
|
+
* requiresCompatibilities: [ // CompatibilityList
|
|
260
|
+
* "EC2" || "FARGATE" || "EXTERNAL",
|
|
261
|
+
* ],
|
|
262
|
+
* cpu: "STRING_VALUE",
|
|
263
|
+
* memory: "STRING_VALUE",
|
|
264
|
+
* tags: [ // Tags
|
|
265
|
+
* { // Tag
|
|
266
|
+
* key: "STRING_VALUE",
|
|
267
|
+
* value: "STRING_VALUE",
|
|
268
|
+
* },
|
|
269
|
+
* ],
|
|
270
|
+
* pidMode: "host" || "task",
|
|
271
|
+
* ipcMode: "host" || "task" || "none",
|
|
272
|
+
* proxyConfiguration: { // ProxyConfiguration
|
|
273
|
+
* type: "APPMESH",
|
|
274
|
+
* containerName: "STRING_VALUE", // required
|
|
275
|
+
* properties: [ // ProxyConfigurationProperties
|
|
276
|
+
* {
|
|
277
|
+
* name: "STRING_VALUE",
|
|
278
|
+
* value: "STRING_VALUE",
|
|
279
|
+
* },
|
|
280
|
+
* ],
|
|
281
|
+
* },
|
|
282
|
+
* inferenceAccelerators: [ // InferenceAccelerators
|
|
283
|
+
* { // InferenceAccelerator
|
|
284
|
+
* deviceName: "STRING_VALUE", // required
|
|
285
|
+
* deviceType: "STRING_VALUE", // required
|
|
286
|
+
* },
|
|
287
|
+
* ],
|
|
288
|
+
* ephemeralStorage: { // EphemeralStorage
|
|
289
|
+
* sizeInGiB: Number("int"), // required
|
|
290
|
+
* },
|
|
291
|
+
* runtimePlatform: { // RuntimePlatform
|
|
292
|
+
* cpuArchitecture: "X86_64" || "ARM64",
|
|
293
|
+
* 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",
|
|
294
|
+
* },
|
|
295
|
+
* };
|
|
46
296
|
* const command = new RegisterTaskDefinitionCommand(input);
|
|
47
297
|
* const response = await client.send(command);
|
|
48
298
|
* ```
|
|
@@ -53,6 +53,99 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer
|
|
|
53
53
|
* import { ECSClient, RunTaskCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
54
54
|
* // const { ECSClient, RunTaskCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
55
55
|
* const client = new ECSClient(config);
|
|
56
|
+
* const input = { // RunTaskRequest
|
|
57
|
+
* capacityProviderStrategy: [ // CapacityProviderStrategy
|
|
58
|
+
* { // CapacityProviderStrategyItem
|
|
59
|
+
* capacityProvider: "STRING_VALUE", // required
|
|
60
|
+
* weight: Number("int"),
|
|
61
|
+
* base: Number("int"),
|
|
62
|
+
* },
|
|
63
|
+
* ],
|
|
64
|
+
* cluster: "STRING_VALUE",
|
|
65
|
+
* count: Number("int"),
|
|
66
|
+
* enableECSManagedTags: true || false,
|
|
67
|
+
* enableExecuteCommand: true || false,
|
|
68
|
+
* group: "STRING_VALUE",
|
|
69
|
+
* launchType: "EC2" || "FARGATE" || "EXTERNAL",
|
|
70
|
+
* networkConfiguration: { // NetworkConfiguration
|
|
71
|
+
* awsvpcConfiguration: { // AwsVpcConfiguration
|
|
72
|
+
* subnets: [ // StringList // required
|
|
73
|
+
* "STRING_VALUE",
|
|
74
|
+
* ],
|
|
75
|
+
* securityGroups: [
|
|
76
|
+
* "STRING_VALUE",
|
|
77
|
+
* ],
|
|
78
|
+
* assignPublicIp: "ENABLED" || "DISABLED",
|
|
79
|
+
* },
|
|
80
|
+
* },
|
|
81
|
+
* overrides: { // TaskOverride
|
|
82
|
+
* containerOverrides: [ // ContainerOverrides
|
|
83
|
+
* { // ContainerOverride
|
|
84
|
+
* name: "STRING_VALUE",
|
|
85
|
+
* command: [
|
|
86
|
+
* "STRING_VALUE",
|
|
87
|
+
* ],
|
|
88
|
+
* environment: [ // EnvironmentVariables
|
|
89
|
+
* { // KeyValuePair
|
|
90
|
+
* name: "STRING_VALUE",
|
|
91
|
+
* value: "STRING_VALUE",
|
|
92
|
+
* },
|
|
93
|
+
* ],
|
|
94
|
+
* environmentFiles: [ // EnvironmentFiles
|
|
95
|
+
* { // EnvironmentFile
|
|
96
|
+
* value: "STRING_VALUE", // required
|
|
97
|
+
* type: "s3", // required
|
|
98
|
+
* },
|
|
99
|
+
* ],
|
|
100
|
+
* cpu: Number("int"),
|
|
101
|
+
* memory: Number("int"),
|
|
102
|
+
* memoryReservation: Number("int"),
|
|
103
|
+
* resourceRequirements: [ // ResourceRequirements
|
|
104
|
+
* { // ResourceRequirement
|
|
105
|
+
* value: "STRING_VALUE", // required
|
|
106
|
+
* type: "GPU" || "InferenceAccelerator", // required
|
|
107
|
+
* },
|
|
108
|
+
* ],
|
|
109
|
+
* },
|
|
110
|
+
* ],
|
|
111
|
+
* cpu: "STRING_VALUE",
|
|
112
|
+
* inferenceAcceleratorOverrides: [ // InferenceAcceleratorOverrides
|
|
113
|
+
* { // InferenceAcceleratorOverride
|
|
114
|
+
* deviceName: "STRING_VALUE",
|
|
115
|
+
* deviceType: "STRING_VALUE",
|
|
116
|
+
* },
|
|
117
|
+
* ],
|
|
118
|
+
* executionRoleArn: "STRING_VALUE",
|
|
119
|
+
* memory: "STRING_VALUE",
|
|
120
|
+
* taskRoleArn: "STRING_VALUE",
|
|
121
|
+
* ephemeralStorage: { // EphemeralStorage
|
|
122
|
+
* sizeInGiB: Number("int"), // required
|
|
123
|
+
* },
|
|
124
|
+
* },
|
|
125
|
+
* placementConstraints: [ // PlacementConstraints
|
|
126
|
+
* { // PlacementConstraint
|
|
127
|
+
* type: "distinctInstance" || "memberOf",
|
|
128
|
+
* expression: "STRING_VALUE",
|
|
129
|
+
* },
|
|
130
|
+
* ],
|
|
131
|
+
* placementStrategy: [ // PlacementStrategies
|
|
132
|
+
* { // PlacementStrategy
|
|
133
|
+
* type: "random" || "spread" || "binpack",
|
|
134
|
+
* field: "STRING_VALUE",
|
|
135
|
+
* },
|
|
136
|
+
* ],
|
|
137
|
+
* platformVersion: "STRING_VALUE",
|
|
138
|
+
* propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
|
|
139
|
+
* referenceId: "STRING_VALUE",
|
|
140
|
+
* startedBy: "STRING_VALUE",
|
|
141
|
+
* tags: [ // Tags
|
|
142
|
+
* { // Tag
|
|
143
|
+
* key: "STRING_VALUE",
|
|
144
|
+
* value: "STRING_VALUE",
|
|
145
|
+
* },
|
|
146
|
+
* ],
|
|
147
|
+
* taskDefinition: "STRING_VALUE", // required
|
|
148
|
+
* };
|
|
56
149
|
* const command = new RunTaskCommand(input);
|
|
57
150
|
* const response = await client.send(command);
|
|
58
151
|
* ```
|
|
@@ -29,6 +29,78 @@ export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBea
|
|
|
29
29
|
* import { ECSClient, StartTaskCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
30
30
|
* // const { ECSClient, StartTaskCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
31
31
|
* const client = new ECSClient(config);
|
|
32
|
+
* const input = { // StartTaskRequest
|
|
33
|
+
* cluster: "STRING_VALUE",
|
|
34
|
+
* containerInstances: [ // StringList // required
|
|
35
|
+
* "STRING_VALUE",
|
|
36
|
+
* ],
|
|
37
|
+
* enableECSManagedTags: true || false,
|
|
38
|
+
* enableExecuteCommand: true || false,
|
|
39
|
+
* group: "STRING_VALUE",
|
|
40
|
+
* networkConfiguration: { // NetworkConfiguration
|
|
41
|
+
* awsvpcConfiguration: { // AwsVpcConfiguration
|
|
42
|
+
* subnets: [ // required
|
|
43
|
+
* "STRING_VALUE",
|
|
44
|
+
* ],
|
|
45
|
+
* securityGroups: [
|
|
46
|
+
* "STRING_VALUE",
|
|
47
|
+
* ],
|
|
48
|
+
* assignPublicIp: "ENABLED" || "DISABLED",
|
|
49
|
+
* },
|
|
50
|
+
* },
|
|
51
|
+
* overrides: { // TaskOverride
|
|
52
|
+
* containerOverrides: [ // ContainerOverrides
|
|
53
|
+
* { // ContainerOverride
|
|
54
|
+
* name: "STRING_VALUE",
|
|
55
|
+
* command: "<StringList>",
|
|
56
|
+
* environment: [ // EnvironmentVariables
|
|
57
|
+
* { // KeyValuePair
|
|
58
|
+
* name: "STRING_VALUE",
|
|
59
|
+
* value: "STRING_VALUE",
|
|
60
|
+
* },
|
|
61
|
+
* ],
|
|
62
|
+
* environmentFiles: [ // EnvironmentFiles
|
|
63
|
+
* { // EnvironmentFile
|
|
64
|
+
* value: "STRING_VALUE", // required
|
|
65
|
+
* type: "s3", // required
|
|
66
|
+
* },
|
|
67
|
+
* ],
|
|
68
|
+
* cpu: Number("int"),
|
|
69
|
+
* memory: Number("int"),
|
|
70
|
+
* memoryReservation: Number("int"),
|
|
71
|
+
* resourceRequirements: [ // ResourceRequirements
|
|
72
|
+
* { // ResourceRequirement
|
|
73
|
+
* value: "STRING_VALUE", // required
|
|
74
|
+
* type: "GPU" || "InferenceAccelerator", // required
|
|
75
|
+
* },
|
|
76
|
+
* ],
|
|
77
|
+
* },
|
|
78
|
+
* ],
|
|
79
|
+
* cpu: "STRING_VALUE",
|
|
80
|
+
* inferenceAcceleratorOverrides: [ // InferenceAcceleratorOverrides
|
|
81
|
+
* { // InferenceAcceleratorOverride
|
|
82
|
+
* deviceName: "STRING_VALUE",
|
|
83
|
+
* deviceType: "STRING_VALUE",
|
|
84
|
+
* },
|
|
85
|
+
* ],
|
|
86
|
+
* executionRoleArn: "STRING_VALUE",
|
|
87
|
+
* memory: "STRING_VALUE",
|
|
88
|
+
* taskRoleArn: "STRING_VALUE",
|
|
89
|
+
* ephemeralStorage: { // EphemeralStorage
|
|
90
|
+
* sizeInGiB: Number("int"), // required
|
|
91
|
+
* },
|
|
92
|
+
* },
|
|
93
|
+
* propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
|
|
94
|
+
* referenceId: "STRING_VALUE",
|
|
95
|
+
* startedBy: "STRING_VALUE",
|
|
96
|
+
* tags: [ // Tags
|
|
97
|
+
* { // Tag
|
|
98
|
+
* key: "STRING_VALUE",
|
|
99
|
+
* value: "STRING_VALUE",
|
|
100
|
+
* },
|
|
101
|
+
* ],
|
|
102
|
+
* taskDefinition: "STRING_VALUE", // required
|
|
103
|
+
* };
|
|
32
104
|
* const command = new StartTaskCommand(input);
|
|
33
105
|
* const response = await client.send(command);
|
|
34
106
|
* ```
|
|
@@ -38,6 +38,11 @@ export interface StopTaskCommandOutput extends StopTaskResponse, __MetadataBeare
|
|
|
38
38
|
* import { ECSClient, StopTaskCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
39
39
|
* // const { ECSClient, StopTaskCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
40
40
|
* const client = new ECSClient(config);
|
|
41
|
+
* const input = { // StopTaskRequest
|
|
42
|
+
* cluster: "STRING_VALUE",
|
|
43
|
+
* task: "STRING_VALUE", // required
|
|
44
|
+
* reason: "STRING_VALUE",
|
|
45
|
+
* };
|
|
41
46
|
* const command = new StopTaskCommand(input);
|
|
42
47
|
* const response = await client.send(command);
|
|
43
48
|
* ```
|
|
@@ -29,6 +29,15 @@ export interface SubmitAttachmentStateChangesCommandOutput extends SubmitAttachm
|
|
|
29
29
|
* import { ECSClient, SubmitAttachmentStateChangesCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
30
30
|
* // const { ECSClient, SubmitAttachmentStateChangesCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
31
31
|
* const client = new ECSClient(config);
|
|
32
|
+
* const input = { // SubmitAttachmentStateChangesRequest
|
|
33
|
+
* cluster: "STRING_VALUE",
|
|
34
|
+
* attachments: [ // AttachmentStateChanges // required
|
|
35
|
+
* { // AttachmentStateChange
|
|
36
|
+
* attachmentArn: "STRING_VALUE", // required
|
|
37
|
+
* status: "STRING_VALUE", // required
|
|
38
|
+
* },
|
|
39
|
+
* ],
|
|
40
|
+
* };
|
|
32
41
|
* const command = new SubmitAttachmentStateChangesCommand(input);
|
|
33
42
|
* const response = await client.send(command);
|
|
34
43
|
* ```
|
|
@@ -29,6 +29,25 @@ export interface SubmitContainerStateChangeCommandOutput extends SubmitContainer
|
|
|
29
29
|
* import { ECSClient, SubmitContainerStateChangeCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
30
30
|
* // const { ECSClient, SubmitContainerStateChangeCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
31
31
|
* const client = new ECSClient(config);
|
|
32
|
+
* const input = { // SubmitContainerStateChangeRequest
|
|
33
|
+
* cluster: "STRING_VALUE",
|
|
34
|
+
* task: "STRING_VALUE",
|
|
35
|
+
* containerName: "STRING_VALUE",
|
|
36
|
+
* runtimeId: "STRING_VALUE",
|
|
37
|
+
* status: "STRING_VALUE",
|
|
38
|
+
* exitCode: Number("int"),
|
|
39
|
+
* reason: "STRING_VALUE",
|
|
40
|
+
* networkBindings: [ // NetworkBindings
|
|
41
|
+
* { // NetworkBinding
|
|
42
|
+
* bindIP: "STRING_VALUE",
|
|
43
|
+
* containerPort: Number("int"),
|
|
44
|
+
* hostPort: Number("int"),
|
|
45
|
+
* protocol: "tcp" || "udp",
|
|
46
|
+
* containerPortRange: "STRING_VALUE",
|
|
47
|
+
* hostPortRange: "STRING_VALUE",
|
|
48
|
+
* },
|
|
49
|
+
* ],
|
|
50
|
+
* };
|
|
32
51
|
* const command = new SubmitContainerStateChangeCommand(input);
|
|
33
52
|
* const response = await client.send(command);
|
|
34
53
|
* ```
|