@aws-sdk/client-ecs 3.993.0 → 3.995.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/README.md +1 -15
- package/dist-cjs/index.js +164 -164
- package/dist-cjs/models/errors.js +86 -86
- package/dist-cjs/schemas/schemas_0.js +5 -5
- package/dist-es/models/enums.js +156 -156
- package/dist-es/models/errors.js +68 -68
- package/dist-es/schemas/schemas_0.js +5 -5
- package/dist-es/waiters/waitForServicesInactive.js +2 -2
- package/dist-es/waiters/waitForServicesStable.js +2 -2
- package/dist-es/waiters/waitForTasksRunning.js +2 -2
- package/dist-es/waiters/waitForTasksStopped.js +2 -2
- package/dist-types/ECS.d.ts +1 -15
- package/dist-types/ECSClient.d.ts +1 -15
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +4 -16
- package/dist-types/commands/CreateClusterCommand.d.ts +3 -20
- package/dist-types/commands/CreateExpressGatewayServiceCommand.d.ts +4 -18
- package/dist-types/commands/CreateServiceCommand.d.ts +4 -236
- package/dist-types/commands/CreateTaskSetCommand.d.ts +6 -25
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +12 -18
- package/dist-types/commands/DeleteAttributesCommand.d.ts +2 -7
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +3 -21
- package/dist-types/commands/DeleteClusterCommand.d.ts +7 -30
- package/dist-types/commands/DeleteExpressGatewayServiceCommand.d.ts +5 -19
- package/dist-types/commands/DeleteServiceCommand.d.ts +4 -30
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +3 -27
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +6 -16
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +3 -21
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +3 -25
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +34 -39
- package/dist-types/commands/DescribeClustersCommand.d.ts +3 -10
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +3 -9
- package/dist-types/commands/DescribeExpressGatewayServiceCommand.d.ts +3 -14
- package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +44 -13
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +44 -14
- package/dist-types/commands/DescribeServicesCommand.d.ts +2 -7
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +3 -15
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +5 -16
- package/dist-types/commands/DescribeTasksCommand.d.ts +3 -12
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +2 -8
- package/dist-types/commands/ExecuteCommandCommand.d.ts +4 -32
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +2 -7
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +9 -14
- package/dist-types/commands/ListAttributesCommand.d.ts +2 -11
- package/dist-types/commands/ListClustersCommand.d.ts +2 -7
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +3 -11
- package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +4 -15
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +3 -13
- package/dist-types/commands/ListServicesCommand.d.ts +3 -9
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -7
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +13 -24
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +13 -20
- package/dist-types/commands/ListTasksCommand.d.ts +14 -23
- package/dist-types/commands/PutAccountSettingCommand.d.ts +12 -22
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +3 -9
- package/dist-types/commands/PutAttributesCommand.d.ts +4 -14
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +4 -29
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +3 -13
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +3 -26
- package/dist-types/commands/RunTaskCommand.d.ts +6 -75
- package/dist-types/commands/StartTaskCommand.d.ts +3 -23
- package/dist-types/commands/StopServiceDeploymentCommand.d.ts +5 -25
- package/dist-types/commands/StopTaskCommand.d.ts +3 -25
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +3 -12
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +2 -8
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +3 -12
- package/dist-types/commands/TagResourceCommand.d.ts +3 -11
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -7
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +3 -10
- package/dist-types/commands/UpdateClusterCommand.d.ts +2 -7
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +2 -7
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +6 -41
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +3 -56
- package/dist-types/commands/UpdateExpressGatewayServiceCommand.d.ts +5 -19
- package/dist-types/commands/UpdateServiceCommand.d.ts +14 -146
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +6 -19
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +15 -47
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +6 -17
- package/dist-types/index.d.ts +1 -15
- package/dist-types/models/enums.d.ts +338 -338
- package/dist-types/models/errors.d.ts +74 -128
- package/dist-types/models/models_0.d.ts +3435 -9819
- package/dist-types/ts3.4/models/enums.d.ts +222 -222
- package/dist-types/ts3.4/models/errors.d.ts +61 -61
- package/dist-types/ts3.4/models/models_0.d.ts +1055 -1055
- package/package.json +3 -3
|
@@ -73,18 +73,13 @@ declare const GetTaskProtectionCommand_base: {
|
|
|
73
73
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
74
74
|
*
|
|
75
75
|
* @throws {@link ClientException} (client fault)
|
|
76
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
77
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
78
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
76
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
79
77
|
*
|
|
80
78
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
81
79
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
82
80
|
*
|
|
83
81
|
* @throws {@link InvalidParameterException} (client fault)
|
|
84
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
85
|
-
* request.</p>
|
|
86
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
87
|
-
* service event messages</a>. </p>
|
|
82
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
88
83
|
*
|
|
89
84
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
90
85
|
* <p>The specified resource wasn't found.</p>
|
|
@@ -67,15 +67,10 @@ declare const ListAccountSettingsCommand_base: {
|
|
|
67
67
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ClientException} (client fault)
|
|
70
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
71
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
72
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
70
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
73
71
|
*
|
|
74
72
|
* @throws {@link InvalidParameterException} (client fault)
|
|
75
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
76
|
-
* request.</p>
|
|
77
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
78
|
-
* service event messages</a>. </p>
|
|
73
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
79
74
|
*
|
|
80
75
|
* @throws {@link ServerException} (server fault)
|
|
81
76
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -84,12 +79,11 @@ declare const ListAccountSettingsCommand_base: {
|
|
|
84
79
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
85
80
|
*
|
|
86
81
|
*
|
|
87
|
-
* @example To view
|
|
82
|
+
* @example To view your effective account settings
|
|
88
83
|
* ```javascript
|
|
89
|
-
* // This example displays the effective account settings for
|
|
84
|
+
* // This example displays the effective account settings for your account.
|
|
90
85
|
* const input = {
|
|
91
|
-
* effectiveSettings: true
|
|
92
|
-
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
86
|
+
* effectiveSettings: true
|
|
93
87
|
* };
|
|
94
88
|
* const command = new ListAccountSettingsCommand(input);
|
|
95
89
|
* const response = await client.send(command);
|
|
@@ -116,11 +110,12 @@ declare const ListAccountSettingsCommand_base: {
|
|
|
116
110
|
* *\/
|
|
117
111
|
* ```
|
|
118
112
|
*
|
|
119
|
-
* @example To view
|
|
113
|
+
* @example To view the effective account settings for a specific IAM user or IAM role
|
|
120
114
|
* ```javascript
|
|
121
|
-
* // This example displays the effective account settings for
|
|
115
|
+
* // This example displays the effective account settings for the specified user or role.
|
|
122
116
|
* const input = {
|
|
123
|
-
* effectiveSettings: true
|
|
117
|
+
* effectiveSettings: true,
|
|
118
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName"
|
|
124
119
|
* };
|
|
125
120
|
* const command = new ListAccountSettingsCommand(input);
|
|
126
121
|
* const response = await client.send(command);
|
|
@@ -27,13 +27,7 @@ declare const ListAttributesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Lists the attributes for Amazon ECS resources within a specified target type and
|
|
31
|
-
* cluster. When you specify a target type and cluster, <code>ListAttributes</code> returns
|
|
32
|
-
* a list of attribute objects, one for each attribute on each resource. You can filter the
|
|
33
|
-
* list of results to a single attribute name to only return results that have that name.
|
|
34
|
-
* You can also filter the results by attribute name and value. You can do this, for
|
|
35
|
-
* example, to see which container instances in a cluster are running a Linux AMI
|
|
36
|
-
* (<code>ecs.os-type=linux</code>). </p>
|
|
30
|
+
* <p>Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, <code>ListAttributes</code> returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value. You can do this, for example, to see which container instances in a cluster are running a Linux AMI (<code>ecs.os-type=linux</code>). </p>
|
|
37
31
|
* @example
|
|
38
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
33
|
* ```javascript
|
|
@@ -76,10 +70,7 @@ declare const ListAttributesCommand_base: {
|
|
|
76
70
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
77
71
|
*
|
|
78
72
|
* @throws {@link InvalidParameterException} (client fault)
|
|
79
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
80
|
-
* request.</p>
|
|
81
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
82
|
-
* service event messages</a>. </p>
|
|
73
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
83
74
|
*
|
|
84
75
|
* @throws {@link ECSServiceException}
|
|
85
76
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
@@ -58,15 +58,10 @@ declare const ListClustersCommand_base: {
|
|
|
58
58
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ClientException} (client fault)
|
|
61
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
62
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
63
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
61
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
64
62
|
*
|
|
65
63
|
* @throws {@link InvalidParameterException} (client fault)
|
|
66
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
67
|
-
* request.</p>
|
|
68
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
69
|
-
* service event messages</a>. </p>
|
|
64
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
70
65
|
*
|
|
71
66
|
* @throws {@link ServerException} (server fault)
|
|
72
67
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,10 +27,7 @@ declare const ListContainerInstancesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a list of container instances in a specified cluster. You can filter the
|
|
31
|
-
* results of a <code>ListContainerInstances</code> operation with cluster query language
|
|
32
|
-
* statements inside the <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the <i>Amazon Elastic
|
|
33
|
-
* Container Service Developer Guide</i>.</p>
|
|
30
|
+
* <p>Returns a list of container instances in a specified cluster. You can filter the results of a <code>ListContainerInstances</code> operation with cluster query language statements inside the <code>filter</code> parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -64,18 +61,13 @@ declare const ListContainerInstancesCommand_base: {
|
|
|
64
61
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
65
62
|
*
|
|
66
63
|
* @throws {@link ClientException} (client fault)
|
|
67
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
68
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
69
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
64
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
70
65
|
*
|
|
71
66
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
72
67
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
73
68
|
*
|
|
74
69
|
* @throws {@link InvalidParameterException} (client fault)
|
|
75
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
76
|
-
* request.</p>
|
|
77
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
78
|
-
* service event messages</a>. </p>
|
|
70
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
79
71
|
*
|
|
80
72
|
* @throws {@link ServerException} (server fault)
|
|
81
73
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,12 +27,7 @@ declare const ListServiceDeploymentsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>This operation lists all the service deployments that meet the specified filter
|
|
31
|
-
* criteria.</p>
|
|
32
|
-
* <p>A service deployment happens when you release a software update for the service. You
|
|
33
|
-
* route traffic from the running service revisions to the new service revison and control
|
|
34
|
-
* the number of running tasks. </p>
|
|
35
|
-
* <p>This API returns the values that you use for the request parameters in <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServiceRevisions.html">DescribeServiceRevisions</a>.</p>
|
|
30
|
+
* <p>This operation lists all the service deployments that meet the specified filter criteria.</p> <p>A service deployment happens when you release a software update for the service. You route traffic from the running service revisions to the new service revison and control the number of running tasks. </p> <p>This API returns the values that you use for the request parameters in <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServiceRevisions.html">DescribeServiceRevisions</a>.</p>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -85,22 +80,16 @@ declare const ListServiceDeploymentsCommand_base: {
|
|
|
85
80
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
86
81
|
*
|
|
87
82
|
* @throws {@link ClientException} (client fault)
|
|
88
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
89
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
90
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
83
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
91
84
|
*
|
|
92
85
|
* @throws {@link InvalidParameterException} (client fault)
|
|
93
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
94
|
-
* request.</p>
|
|
95
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
96
|
-
* service event messages</a>. </p>
|
|
86
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
97
87
|
*
|
|
98
88
|
* @throws {@link ServerException} (server fault)
|
|
99
89
|
* <p>These errors are usually caused by a server issue.</p>
|
|
100
90
|
*
|
|
101
91
|
* @throws {@link ServiceNotFoundException} (client fault)
|
|
102
|
-
* <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region
|
|
103
|
-
* specific.</p>
|
|
92
|
+
* <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p>
|
|
104
93
|
*
|
|
105
94
|
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
106
95
|
* <p>The specified task isn't supported in this Region.</p>
|
|
@@ -27,12 +27,7 @@ declare const ListServicesByNamespaceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>This operation lists all of the services that are associated with a Cloud Map namespace.
|
|
31
|
-
* This list might include services in different clusters. In contrast,
|
|
32
|
-
* <code>ListServices</code> can only list services in one cluster at a time. If you
|
|
33
|
-
* need to filter the list of services in a single cluster by various parameters, use
|
|
34
|
-
* <code>ListServices</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a>
|
|
35
|
-
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
30
|
+
* <p>This operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast, <code>ListServices</code> can only list services in one cluster at a time. If you need to filter the list of services in a single cluster by various parameters, use <code>ListServices</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html">Service Connect</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -64,15 +59,10 @@ declare const ListServicesByNamespaceCommand_base: {
|
|
|
64
59
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
65
60
|
*
|
|
66
61
|
* @throws {@link ClientException} (client fault)
|
|
67
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
68
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
69
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
62
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
70
63
|
*
|
|
71
64
|
* @throws {@link InvalidParameterException} (client fault)
|
|
72
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
73
|
-
* request.</p>
|
|
74
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
75
|
-
* service event messages</a>. </p>
|
|
65
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
76
66
|
*
|
|
77
67
|
* @throws {@link NamespaceNotFoundException} (client fault)
|
|
78
68
|
* <p>The specified namespace wasn't found.</p>
|
|
@@ -27,8 +27,7 @@ declare const ListServicesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a list of services. You can filter the results by cluster, launch type, and
|
|
31
|
-
* scheduling strategy.</p>
|
|
30
|
+
* <p>Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -63,18 +62,13 @@ declare const ListServicesCommand_base: {
|
|
|
63
62
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
64
63
|
*
|
|
65
64
|
* @throws {@link ClientException} (client fault)
|
|
66
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
67
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
68
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
65
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
69
66
|
*
|
|
70
67
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
71
68
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
72
69
|
*
|
|
73
70
|
* @throws {@link InvalidParameterException} (client fault)
|
|
74
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
75
|
-
* request.</p>
|
|
76
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
77
|
-
* service event messages</a>. </p>
|
|
71
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
78
72
|
*
|
|
79
73
|
* @throws {@link ServerException} (server fault)
|
|
80
74
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -59,18 +59,13 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
59
59
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link ClientException} (client fault)
|
|
62
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
63
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
64
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
62
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
65
63
|
*
|
|
66
64
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
67
65
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
68
66
|
*
|
|
69
67
|
* @throws {@link InvalidParameterException} (client fault)
|
|
70
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
71
|
-
* request.</p>
|
|
72
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
73
|
-
* service event messages</a>. </p>
|
|
68
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
74
69
|
*
|
|
75
70
|
* @throws {@link ServerException} (server fault)
|
|
76
71
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,13 +27,7 @@ declare const ListTaskDefinitionFamiliesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a list of task definition families that are registered to your account. This
|
|
31
|
-
* list includes task definition families that no longer have any <code>ACTIVE</code> task
|
|
32
|
-
* definition revisions.</p>
|
|
33
|
-
* <p>You can filter out task definition families that don't contain any <code>ACTIVE</code>
|
|
34
|
-
* task definition revisions by setting the <code>status</code> parameter to
|
|
35
|
-
* <code>ACTIVE</code>. You can also filter the results with the
|
|
36
|
-
* <code>familyPrefix</code> parameter.</p>
|
|
30
|
+
* <p>Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any <code>ACTIVE</code> task definition revisions.</p> <p>You can filter out task definition families that don't contain any <code>ACTIVE</code> task definition revisions by setting the <code>status</code> parameter to <code>ACTIVE</code>. You can also filter the results with the <code>familyPrefix</code> parameter.</p>
|
|
37
31
|
* @example
|
|
38
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
33
|
* ```javascript
|
|
@@ -66,15 +60,10 @@ declare const ListTaskDefinitionFamiliesCommand_base: {
|
|
|
66
60
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
67
61
|
*
|
|
68
62
|
* @throws {@link ClientException} (client fault)
|
|
69
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
70
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
71
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
63
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
72
64
|
*
|
|
73
65
|
* @throws {@link InvalidParameterException} (client fault)
|
|
74
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
75
|
-
* request.</p>
|
|
76
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
77
|
-
* service event messages</a>. </p>
|
|
66
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
78
67
|
*
|
|
79
68
|
* @throws {@link ServerException} (server fault)
|
|
80
69
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -83,17 +72,17 @@ declare const ListTaskDefinitionFamiliesCommand_base: {
|
|
|
83
72
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
84
73
|
*
|
|
85
74
|
*
|
|
86
|
-
* @example To
|
|
75
|
+
* @example To list your registered task definition families
|
|
87
76
|
* ```javascript
|
|
88
|
-
* // This example lists
|
|
89
|
-
* const input = {
|
|
90
|
-
* familyPrefix: "hpcc"
|
|
91
|
-
* };
|
|
77
|
+
* // This example lists all of your registered task definition families.
|
|
78
|
+
* const input = { /* empty *\/ };
|
|
92
79
|
* const command = new ListTaskDefinitionFamiliesCommand(input);
|
|
93
80
|
* const response = await client.send(command);
|
|
94
81
|
* /* response is
|
|
95
82
|
* {
|
|
96
83
|
* families: [
|
|
84
|
+
* "node-js-app",
|
|
85
|
+
* "web-timer",
|
|
97
86
|
* "hpcc",
|
|
98
87
|
* "hpcc-c4-8xlarge"
|
|
99
88
|
* ]
|
|
@@ -101,17 +90,17 @@ declare const ListTaskDefinitionFamiliesCommand_base: {
|
|
|
101
90
|
* *\/
|
|
102
91
|
* ```
|
|
103
92
|
*
|
|
104
|
-
* @example To
|
|
93
|
+
* @example To filter your registered task definition families
|
|
105
94
|
* ```javascript
|
|
106
|
-
* // This example lists
|
|
107
|
-
* const input = {
|
|
95
|
+
* // This example lists the task definition revisions that start with "hpcc".
|
|
96
|
+
* const input = {
|
|
97
|
+
* familyPrefix: "hpcc"
|
|
98
|
+
* };
|
|
108
99
|
* const command = new ListTaskDefinitionFamiliesCommand(input);
|
|
109
100
|
* const response = await client.send(command);
|
|
110
101
|
* /* response is
|
|
111
102
|
* {
|
|
112
103
|
* families: [
|
|
113
|
-
* "node-js-app",
|
|
114
|
-
* "web-timer",
|
|
115
104
|
* "hpcc",
|
|
116
105
|
* "hpcc-c4-8xlarge"
|
|
117
106
|
* ]
|
|
@@ -27,9 +27,7 @@ declare const ListTaskDefinitionsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a list of task definitions that are registered to your account. You can filter
|
|
31
|
-
* the results by family name with the <code>familyPrefix</code> parameter or by status
|
|
32
|
-
* with the <code>status</code> parameter.</p>
|
|
30
|
+
* <p>Returns a list of task definitions that are registered to your account. You can filter the results by family name with the <code>familyPrefix</code> parameter or by status with the <code>status</code> parameter.</p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -63,15 +61,10 @@ declare const ListTaskDefinitionsCommand_base: {
|
|
|
63
61
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
64
62
|
*
|
|
65
63
|
* @throws {@link ClientException} (client fault)
|
|
66
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
67
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
68
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
64
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
69
65
|
*
|
|
70
66
|
* @throws {@link InvalidParameterException} (client fault)
|
|
71
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
72
|
-
* request.</p>
|
|
73
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
74
|
-
* service event messages</a>. </p>
|
|
67
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
75
68
|
*
|
|
76
69
|
* @throws {@link ServerException} (server fault)
|
|
77
70
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -80,17 +73,17 @@ declare const ListTaskDefinitionsCommand_base: {
|
|
|
80
73
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
81
74
|
*
|
|
82
75
|
*
|
|
83
|
-
* @example To list
|
|
76
|
+
* @example To list your registered task definitions
|
|
84
77
|
* ```javascript
|
|
85
|
-
* // This example lists
|
|
86
|
-
* const input = {
|
|
87
|
-
* familyPrefix: "wordpress"
|
|
88
|
-
* };
|
|
78
|
+
* // This example lists all of your registered task definitions.
|
|
79
|
+
* const input = { /* empty *\/ };
|
|
89
80
|
* const command = new ListTaskDefinitionsCommand(input);
|
|
90
81
|
* const response = await client.send(command);
|
|
91
82
|
* /* response is
|
|
92
83
|
* {
|
|
93
84
|
* taskDefinitionArns: [
|
|
85
|
+
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep300:2",
|
|
86
|
+
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1",
|
|
94
87
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:3",
|
|
95
88
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:4",
|
|
96
89
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:5",
|
|
@@ -100,17 +93,17 @@ declare const ListTaskDefinitionsCommand_base: {
|
|
|
100
93
|
* *\/
|
|
101
94
|
* ```
|
|
102
95
|
*
|
|
103
|
-
* @example To list
|
|
96
|
+
* @example To list the registered task definitions in a family
|
|
104
97
|
* ```javascript
|
|
105
|
-
* // This example lists
|
|
106
|
-
* const input = {
|
|
98
|
+
* // This example lists the task definition revisions of a specified family.
|
|
99
|
+
* const input = {
|
|
100
|
+
* familyPrefix: "wordpress"
|
|
101
|
+
* };
|
|
107
102
|
* const command = new ListTaskDefinitionsCommand(input);
|
|
108
103
|
* const response = await client.send(command);
|
|
109
104
|
* /* response is
|
|
110
105
|
* {
|
|
111
106
|
* taskDefinitionArns: [
|
|
112
|
-
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep300:2",
|
|
113
|
-
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1",
|
|
114
107
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:3",
|
|
115
108
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:4",
|
|
116
109
|
* "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:5",
|
|
@@ -27,10 +27,7 @@ declare const ListTasksCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a list of tasks. You can filter the results by cluster, task definition
|
|
31
|
-
* family, container instance, launch type, what IAM principal started the task, or by the
|
|
32
|
-
* desired status of the task.</p>
|
|
33
|
-
* <p>Recently stopped tasks might appear in the returned results. </p>
|
|
30
|
+
* <p>Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.</p> <p>Recently stopped tasks might appear in the returned results. </p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -68,61 +65,55 @@ declare const ListTasksCommand_base: {
|
|
|
68
65
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
69
66
|
*
|
|
70
67
|
* @throws {@link ClientException} (client fault)
|
|
71
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
72
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
73
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
68
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
74
69
|
*
|
|
75
70
|
* @throws {@link ClusterNotFoundException} (client fault)
|
|
76
71
|
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
77
72
|
*
|
|
78
73
|
* @throws {@link InvalidParameterException} (client fault)
|
|
79
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
80
|
-
* request.</p>
|
|
81
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
82
|
-
* service event messages</a>. </p>
|
|
74
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
83
75
|
*
|
|
84
76
|
* @throws {@link ServerException} (server fault)
|
|
85
77
|
* <p>These errors are usually caused by a server issue.</p>
|
|
86
78
|
*
|
|
87
79
|
* @throws {@link ServiceNotFoundException} (client fault)
|
|
88
|
-
* <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region
|
|
89
|
-
* specific.</p>
|
|
80
|
+
* <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region specific.</p>
|
|
90
81
|
*
|
|
91
82
|
* @throws {@link ECSServiceException}
|
|
92
83
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
93
84
|
*
|
|
94
85
|
*
|
|
95
|
-
* @example To list the tasks
|
|
86
|
+
* @example To list the tasks in a cluster
|
|
96
87
|
* ```javascript
|
|
97
|
-
* // This example lists
|
|
88
|
+
* // This example lists all of the tasks in a cluster.
|
|
98
89
|
* const input = {
|
|
99
|
-
* cluster: "default"
|
|
100
|
-
* containerInstance: "f6bbb147-5370-4ace-8c73-c7181ded911f"
|
|
90
|
+
* cluster: "default"
|
|
101
91
|
* };
|
|
102
92
|
* const command = new ListTasksCommand(input);
|
|
103
93
|
* const response = await client.send(command);
|
|
104
94
|
* /* response is
|
|
105
95
|
* {
|
|
106
96
|
* taskArns: [
|
|
107
|
-
* "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84"
|
|
97
|
+
* "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84",
|
|
98
|
+
* "arn:aws:ecs:us-east-1:012345678910:task/default/6b809ef6-c67e-4467-921f-ee261c15a0a1"
|
|
108
99
|
* ]
|
|
109
100
|
* }
|
|
110
101
|
* *\/
|
|
111
102
|
* ```
|
|
112
103
|
*
|
|
113
|
-
* @example To list the tasks
|
|
104
|
+
* @example To list the tasks on a particular container instance
|
|
114
105
|
* ```javascript
|
|
115
|
-
* // This example lists
|
|
106
|
+
* // This example lists the tasks of a specified container instance. Specifying a ``containerInstance`` value limits the results to tasks that belong to that container instance.
|
|
116
107
|
* const input = {
|
|
117
|
-
* cluster: "default"
|
|
108
|
+
* cluster: "default",
|
|
109
|
+
* containerInstance: "f6bbb147-5370-4ace-8c73-c7181ded911f"
|
|
118
110
|
* };
|
|
119
111
|
* const command = new ListTasksCommand(input);
|
|
120
112
|
* const response = await client.send(command);
|
|
121
113
|
* /* response is
|
|
122
114
|
* {
|
|
123
115
|
* taskArns: [
|
|
124
|
-
* "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84"
|
|
125
|
-
* "arn:aws:ecs:us-east-1:012345678910:task/default/6b809ef6-c67e-4467-921f-ee261c15a0a1"
|
|
116
|
+
* "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84"
|
|
126
117
|
* ]
|
|
127
118
|
* }
|
|
128
119
|
* *\/
|
|
@@ -27,12 +27,7 @@ declare const PutAccountSettingCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Modifies an account setting. Account settings are set on a per-Region basis.</p>
|
|
31
|
-
* <p>If you change the root user account setting, the default settings are reset for users
|
|
32
|
-
* and roles that do not have specified individual account settings. For more information,
|
|
33
|
-
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html">Account
|
|
34
|
-
* Settings</a> in the <i>Amazon Elastic Container Service Developer
|
|
35
|
-
* Guide</i>.</p>
|
|
30
|
+
* <p>Modifies an account setting. Account settings are set on a per-Region basis.</p> <p>If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html">Account Settings</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -66,15 +61,10 @@ declare const PutAccountSettingCommand_base: {
|
|
|
66
61
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
67
62
|
*
|
|
68
63
|
* @throws {@link ClientException} (client fault)
|
|
69
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
70
|
-
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
71
|
-
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
64
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
72
65
|
*
|
|
73
66
|
* @throws {@link InvalidParameterException} (client fault)
|
|
74
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
75
|
-
* request.</p>
|
|
76
|
-
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
77
|
-
* service event messages</a>. </p>
|
|
67
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
|
|
78
68
|
*
|
|
79
69
|
* @throws {@link ServerException} (server fault)
|
|
80
70
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -83,12 +73,11 @@ declare const PutAccountSettingCommand_base: {
|
|
|
83
73
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
84
74
|
*
|
|
85
75
|
*
|
|
86
|
-
* @example To modify
|
|
76
|
+
* @example To modify your account settings
|
|
87
77
|
* ```javascript
|
|
88
|
-
* // This example modifies
|
|
78
|
+
* // This example modifies your account settings to opt in to the new ARN and resource ID format for Amazon ECS services. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.
|
|
89
79
|
* const input = {
|
|
90
|
-
* name: "
|
|
91
|
-
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
80
|
+
* name: "serviceLongArnFormat",
|
|
92
81
|
* value: "enabled"
|
|
93
82
|
* };
|
|
94
83
|
* const command = new PutAccountSettingCommand(input);
|
|
@@ -96,7 +85,7 @@ declare const PutAccountSettingCommand_base: {
|
|
|
96
85
|
* /* response is
|
|
97
86
|
* {
|
|
98
87
|
* setting: {
|
|
99
|
-
* name: "
|
|
88
|
+
* name: "serviceLongArnFormat",
|
|
100
89
|
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
101
90
|
* value: "enabled"
|
|
102
91
|
* }
|
|
@@ -104,11 +93,12 @@ declare const PutAccountSettingCommand_base: {
|
|
|
104
93
|
* *\/
|
|
105
94
|
* ```
|
|
106
95
|
*
|
|
107
|
-
* @example To modify
|
|
96
|
+
* @example To modify the account settings for a specific IAM user or IAM role
|
|
108
97
|
* ```javascript
|
|
109
|
-
* // This example modifies
|
|
98
|
+
* // This example modifies the account setting for a specific IAM user or IAM role to opt in to the new ARN and resource ID format for Amazon ECS container instances. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.
|
|
110
99
|
* const input = {
|
|
111
|
-
* name: "
|
|
100
|
+
* name: "containerInstanceLongArnFormat",
|
|
101
|
+
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
112
102
|
* value: "enabled"
|
|
113
103
|
* };
|
|
114
104
|
* const command = new PutAccountSettingCommand(input);
|
|
@@ -116,7 +106,7 @@ declare const PutAccountSettingCommand_base: {
|
|
|
116
106
|
* /* response is
|
|
117
107
|
* {
|
|
118
108
|
* setting: {
|
|
119
|
-
* name: "
|
|
109
|
+
* name: "containerInstanceLongArnFormat",
|
|
120
110
|
* principalArn: "arn:aws:iam::<aws_account_id>:user/principalName",
|
|
121
111
|
* value: "enabled"
|
|
122
112
|
* }
|