@aws-sdk/client-ecs 3.288.0 → 3.290.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/dist-types/commands/CreateCapacityProviderCommand.d.ts +23 -0
  2. package/dist-types/commands/CreateClusterCommand.d.ts +37 -0
  3. package/dist-types/commands/CreateServiceCommand.d.ts +149 -0
  4. package/dist-types/commands/CreateTaskSetCommand.d.ts +40 -0
  5. package/dist-types/commands/DeleteAccountSettingCommand.d.ts +54 -0
  6. package/dist-types/commands/DeleteAttributesCommand.d.ts +13 -0
  7. package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +13 -0
  8. package/dist-types/commands/DeleteClusterCommand.d.ts +60 -0
  9. package/dist-types/commands/DeleteServiceCommand.d.ts +31 -0
  10. package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteTaskSetCommand.d.ts +34 -0
  12. package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +29 -0
  13. package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +13 -0
  14. package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +13 -0
  15. package/dist-types/commands/DescribeClustersCommand.d.ts +38 -0
  16. package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +104 -0
  17. package/dist-types/commands/DescribeServicesCommand.d.ts +71 -0
  18. package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +71 -0
  19. package/dist-types/commands/DescribeTaskSetsCommand.d.ts +30 -0
  20. package/dist-types/commands/DescribeTasksCommand.d.ts +67 -0
  21. package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +9 -0
  22. package/dist-types/commands/ExecuteCommandCommand.d.ts +37 -0
  23. package/dist-types/commands/GetTaskProtectionCommand.d.ts +51 -0
  24. package/dist-types/commands/ListAccountSettingsCommand.d.ts +78 -0
  25. package/dist-types/commands/ListAttributesCommand.d.ts +8 -0
  26. package/dist-types/commands/ListClustersCommand.d.ts +30 -0
  27. package/dist-types/commands/ListContainerInstancesCommand.d.ts +35 -0
  28. package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +16 -0
  29. package/dist-types/commands/ListServicesCommand.d.ts +32 -0
  30. package/dist-types/commands/ListTagsForResourceCommand.d.ts +37 -0
  31. package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +51 -0
  32. package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +55 -0
  33. package/dist-types/commands/ListTasksCommand.d.ts +58 -0
  34. package/dist-types/commands/PutAccountSettingCommand.d.ts +56 -0
  35. package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +34 -0
  36. package/dist-types/commands/PutAttributesCommand.d.ts +18 -0
  37. package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +26 -0
  38. package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +13 -0
  39. package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +66 -0
  40. package/dist-types/commands/RunTaskCommand.d.ts +73 -0
  41. package/dist-types/commands/StartTaskCommand.d.ts +16 -0
  42. package/dist-types/commands/StopTaskCommand.d.ts +16 -0
  43. package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +16 -0
  44. package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +12 -0
  45. package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +16 -0
  46. package/dist-types/commands/TagResourceCommand.d.ts +36 -0
  47. package/dist-types/commands/UntagResourceCommand.d.ts +33 -0
  48. package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +13 -0
  49. package/dist-types/commands/UpdateClusterCommand.d.ts +16 -0
  50. package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +16 -0
  51. package/dist-types/commands/UpdateContainerAgentCommand.d.ts +34 -0
  52. package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +16 -0
  53. package/dist-types/commands/UpdateServiceCommand.d.ts +61 -0
  54. package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +34 -0
  55. package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +106 -0
  56. package/dist-types/commands/UpdateTaskSetCommand.d.ts +34 -0
  57. package/package.json +30 -30
@@ -29,6 +29,36 @@ export interface ListClustersCommandOutput extends ListClustersResponse, __Metad
29
29
  * @see {@link ListClustersCommandOutput} for command's `response` shape.
30
30
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
31
31
  *
32
+ * @throws {@link ClientException} (client fault)
33
+ * <p>These errors are usually caused by a client action. This client action might be using
34
+ * an action or resource on behalf of a user that doesn't have permissions to use the
35
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
36
+ *
37
+ * @throws {@link InvalidParameterException} (client fault)
38
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
39
+ * request.</p>
40
+ *
41
+ * @throws {@link ServerException} (server fault)
42
+ * <p>These errors are usually caused by a server issue.</p>
43
+ *
44
+ *
45
+ * @example To list your available clusters
46
+ * ```javascript
47
+ * // This example lists all of your available clusters in your default region.
48
+ * const input = {};
49
+ * const command = new ListClustersCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "clusterArns": [
54
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:cluster/test",
55
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:cluster/default"
56
+ * ]
57
+ * }
58
+ * *\/
59
+ * // example id: e337d059-134f-4125-ba8e-4f499139facf
60
+ * ```
61
+ *
32
62
  */
33
63
  export declare class ListClustersCommand extends $Command<ListClustersCommandInput, ListClustersCommandOutput, ECSClientResolvedConfig> {
34
64
  readonly input: ListClustersCommandInput;
@@ -31,6 +31,41 @@ export interface ListContainerInstancesCommandOutput extends ListContainerInstan
31
31
  * @see {@link ListContainerInstancesCommandOutput} for command's `response` shape.
32
32
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
33
33
  *
34
+ * @throws {@link ClientException} (client fault)
35
+ * <p>These errors are usually caused by a client action. This client action might be using
36
+ * an action or resource on behalf of a user that doesn't have permissions to use the
37
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
38
+ *
39
+ * @throws {@link ClusterNotFoundException} (client fault)
40
+ * <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
41
+ *
42
+ * @throws {@link InvalidParameterException} (client fault)
43
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
44
+ * request.</p>
45
+ *
46
+ * @throws {@link ServerException} (server fault)
47
+ * <p>These errors are usually caused by a server issue.</p>
48
+ *
49
+ *
50
+ * @example To list your available container instances in a cluster
51
+ * ```javascript
52
+ * // This example lists all of your available container instances in the specified cluster in your default region.
53
+ * const input = {
54
+ * "cluster": "default"
55
+ * };
56
+ * const command = new ListContainerInstancesCommand(input);
57
+ * const response = await client.send(command);
58
+ * /* response ==
59
+ * {
60
+ * "containerInstanceArns": [
61
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/f6bbb147-5370-4ace-8c73-c7181ded911f",
62
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb"
63
+ * ]
64
+ * }
65
+ * *\/
66
+ * // example id: 62a82a94-713c-4e18-8420-1d2b2ba9d484
67
+ * ```
68
+ *
34
69
  */
35
70
  export declare class ListContainerInstancesCommand extends $Command<ListContainerInstancesCommandInput, ListContainerInstancesCommandOutput, ECSClientResolvedConfig> {
36
71
  readonly input: ListContainerInstancesCommandInput;
@@ -33,6 +33,22 @@ export interface ListServicesByNamespaceCommandOutput extends ListServicesByName
33
33
  * @see {@link ListServicesByNamespaceCommandOutput} for command's `response` shape.
34
34
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
35
35
  *
36
+ * @throws {@link ClientException} (client fault)
37
+ * <p>These errors are usually caused by a client action. This client action might be using
38
+ * an action or resource on behalf of a user that doesn't have permissions to use the
39
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
40
+ *
41
+ * @throws {@link InvalidParameterException} (client fault)
42
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
43
+ * request.</p>
44
+ *
45
+ * @throws {@link NamespaceNotFoundException} (client fault)
46
+ * <p>The specified namespace wasn't found.</p>
47
+ *
48
+ * @throws {@link ServerException} (server fault)
49
+ * <p>These errors are usually caused by a server issue.</p>
50
+ *
51
+ *
36
52
  */
37
53
  export declare class ListServicesByNamespaceCommand extends $Command<ListServicesByNamespaceCommandInput, ListServicesByNamespaceCommandOutput, ECSClientResolvedConfig> {
38
54
  readonly input: ListServicesByNamespaceCommandInput;
@@ -30,6 +30,38 @@ export interface ListServicesCommandOutput extends ListServicesResponse, __Metad
30
30
  * @see {@link ListServicesCommandOutput} for command's `response` shape.
31
31
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
32
32
  *
33
+ * @throws {@link ClientException} (client fault)
34
+ * <p>These errors are usually caused by a client action. This client action might be using
35
+ * an action or resource on behalf of a user that doesn't have permissions to use the
36
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
37
+ *
38
+ * @throws {@link ClusterNotFoundException} (client fault)
39
+ * <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
40
+ *
41
+ * @throws {@link InvalidParameterException} (client fault)
42
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
43
+ * request.</p>
44
+ *
45
+ * @throws {@link ServerException} (server fault)
46
+ * <p>These errors are usually caused by a server issue.</p>
47
+ *
48
+ *
49
+ * @example To list the services in a cluster
50
+ * ```javascript
51
+ * // This example lists the services running in the default cluster for an account.
52
+ * const input = {};
53
+ * const command = new ListServicesCommand(input);
54
+ * const response = await client.send(command);
55
+ * /* response ==
56
+ * {
57
+ * "serviceArns": [
58
+ * "arn:aws:ecs:us-east-1:012345678910:service/my-http-service"
59
+ * ]
60
+ * }
61
+ * *\/
62
+ * // example id: 1d9a8037-4e0e-4234-a528-609656809a3a
63
+ * ```
64
+ *
33
65
  */
34
66
  export declare class ListServicesCommand extends $Command<ListServicesCommandInput, ListServicesCommandOutput, ECSClientResolvedConfig> {
35
67
  readonly input: ListServicesCommandInput;
@@ -29,6 +29,43 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
29
29
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
30
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
31
31
  *
32
+ * @throws {@link ClientException} (client fault)
33
+ * <p>These errors are usually caused by a client action. This client action might be using
34
+ * an action or resource on behalf of a user that doesn't have permissions to use the
35
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
36
+ *
37
+ * @throws {@link ClusterNotFoundException} (client fault)
38
+ * <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
39
+ *
40
+ * @throws {@link InvalidParameterException} (client fault)
41
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
42
+ * request.</p>
43
+ *
44
+ * @throws {@link ServerException} (server fault)
45
+ * <p>These errors are usually caused by a server issue.</p>
46
+ *
47
+ *
48
+ * @example To list the tags for a cluster.
49
+ * ```javascript
50
+ * // This example lists the tags for the 'dev' cluster.
51
+ * const input = {
52
+ * "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev"
53
+ * };
54
+ * const command = new ListTagsForResourceCommand(input);
55
+ * const response = await client.send(command);
56
+ * /* response ==
57
+ * {
58
+ * "tags": [
59
+ * {
60
+ * "key": "team",
61
+ * "value": "dev"
62
+ * }
63
+ * ]
64
+ * }
65
+ * *\/
66
+ * // example id: to-list-the-tags-for-a-cluster-1540582700259
67
+ * ```
68
+ *
32
69
  */
33
70
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ECSClientResolvedConfig> {
34
71
  readonly input: ListTagsForResourceCommandInput;
@@ -35,6 +35,57 @@ export interface ListTaskDefinitionFamiliesCommandOutput extends ListTaskDefinit
35
35
  * @see {@link ListTaskDefinitionFamiliesCommandOutput} for command's `response` shape.
36
36
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
37
37
  *
38
+ * @throws {@link ClientException} (client fault)
39
+ * <p>These errors are usually caused by a client action. This client action might be using
40
+ * an action or resource on behalf of a user that doesn't have permissions to use the
41
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
42
+ *
43
+ * @throws {@link InvalidParameterException} (client fault)
44
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
45
+ * request.</p>
46
+ *
47
+ * @throws {@link ServerException} (server fault)
48
+ * <p>These errors are usually caused by a server issue.</p>
49
+ *
50
+ *
51
+ * @example To list your registered task definition families
52
+ * ```javascript
53
+ * // This example lists all of your registered task definition families.
54
+ * const input = {};
55
+ * const command = new ListTaskDefinitionFamiliesCommand(input);
56
+ * const response = await client.send(command);
57
+ * /* response ==
58
+ * {
59
+ * "families": [
60
+ * "node-js-app",
61
+ * "web-timer",
62
+ * "hpcc",
63
+ * "hpcc-c4-8xlarge"
64
+ * ]
65
+ * }
66
+ * *\/
67
+ * // example id: b5c89769-1d94-4ca2-a79e-8069103c7f75
68
+ * ```
69
+ *
70
+ * @example To filter your registered task definition families
71
+ * ```javascript
72
+ * // This example lists the task definition revisions that start with "hpcc".
73
+ * const input = {
74
+ * "familyPrefix": "hpcc"
75
+ * };
76
+ * const command = new ListTaskDefinitionFamiliesCommand(input);
77
+ * const response = await client.send(command);
78
+ * /* response ==
79
+ * {
80
+ * "families": [
81
+ * "hpcc",
82
+ * "hpcc-c4-8xlarge"
83
+ * ]
84
+ * }
85
+ * *\/
86
+ * // example id: 8a4cf9a6-42c1-4fe3-852d-99ac8968e11b
87
+ * ```
88
+ *
38
89
  */
39
90
  export declare class ListTaskDefinitionFamiliesCommand extends $Command<ListTaskDefinitionFamiliesCommandInput, ListTaskDefinitionFamiliesCommandOutput, ECSClientResolvedConfig> {
40
91
  readonly input: ListTaskDefinitionFamiliesCommandInput;
@@ -31,6 +31,61 @@ export interface ListTaskDefinitionsCommandOutput extends ListTaskDefinitionsRes
31
31
  * @see {@link ListTaskDefinitionsCommandOutput} for command's `response` shape.
32
32
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
33
33
  *
34
+ * @throws {@link ClientException} (client fault)
35
+ * <p>These errors are usually caused by a client action. This client action might be using
36
+ * an action or resource on behalf of a user that doesn't have permissions to use the
37
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
38
+ *
39
+ * @throws {@link InvalidParameterException} (client fault)
40
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
41
+ * request.</p>
42
+ *
43
+ * @throws {@link ServerException} (server fault)
44
+ * <p>These errors are usually caused by a server issue.</p>
45
+ *
46
+ *
47
+ * @example To list your registered task definitions
48
+ * ```javascript
49
+ * // This example lists all of your registered task definitions.
50
+ * const input = {};
51
+ * const command = new ListTaskDefinitionsCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "taskDefinitionArns": [
56
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep300:2",
57
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1",
58
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:3",
59
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:4",
60
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:5",
61
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:6"
62
+ * ]
63
+ * }
64
+ * *\/
65
+ * // example id: b381ebaf-7eba-4d60-b99b-7f6ae49d3d60
66
+ * ```
67
+ *
68
+ * @example To list the registered task definitions in a family
69
+ * ```javascript
70
+ * // This example lists the task definition revisions of a specified family.
71
+ * const input = {
72
+ * "familyPrefix": "wordpress"
73
+ * };
74
+ * const command = new ListTaskDefinitionsCommand(input);
75
+ * const response = await client.send(command);
76
+ * /* response ==
77
+ * {
78
+ * "taskDefinitionArns": [
79
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:3",
80
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:4",
81
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:5",
82
+ * "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:6"
83
+ * ]
84
+ * }
85
+ * *\/
86
+ * // example id: 734e7afd-753a-4bc2-85d0-badddce10910
87
+ * ```
88
+ *
34
89
  */
35
90
  export declare class ListTaskDefinitionsCommand extends $Command<ListTaskDefinitionsCommandInput, ListTaskDefinitionsCommandOutput, ECSClientResolvedConfig> {
36
91
  readonly input: ListTaskDefinitionsCommandInput;
@@ -33,6 +33,64 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea
33
33
  * @see {@link ListTasksCommandOutput} for command's `response` shape.
34
34
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
35
35
  *
36
+ * @throws {@link ClientException} (client fault)
37
+ * <p>These errors are usually caused by a client action. This client action might be using
38
+ * an action or resource on behalf of a user that doesn't have permissions to use the
39
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
40
+ *
41
+ * @throws {@link ClusterNotFoundException} (client fault)
42
+ * <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
43
+ *
44
+ * @throws {@link InvalidParameterException} (client fault)
45
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
46
+ * request.</p>
47
+ *
48
+ * @throws {@link ServerException} (server fault)
49
+ * <p>These errors are usually caused by a server issue.</p>
50
+ *
51
+ * @throws {@link ServiceNotFoundException} (client fault)
52
+ * <p>The specified service wasn't found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster specific and Region
53
+ * specific.</p>
54
+ *
55
+ *
56
+ * @example To list the tasks in a cluster
57
+ * ```javascript
58
+ * // This example lists all of the tasks in a cluster.
59
+ * const input = {
60
+ * "cluster": "default"
61
+ * };
62
+ * const command = new ListTasksCommand(input);
63
+ * const response = await client.send(command);
64
+ * /* response ==
65
+ * {
66
+ * "taskArns": [
67
+ * "arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84",
68
+ * "arn:aws:ecs:us-east-1:012345678910:task/6b809ef6-c67e-4467-921f-ee261c15a0a1"
69
+ * ]
70
+ * }
71
+ * *\/
72
+ * // example id: 9a6ec707-1a77-45d0-b2eb-516b5dd9e924
73
+ * ```
74
+ *
75
+ * @example To list the tasks on a particular container instance
76
+ * ```javascript
77
+ * // 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.
78
+ * const input = {
79
+ * "cluster": "default",
80
+ * "containerInstance": "f6bbb147-5370-4ace-8c73-c7181ded911f"
81
+ * };
82
+ * const command = new ListTasksCommand(input);
83
+ * const response = await client.send(command);
84
+ * /* response ==
85
+ * {
86
+ * "taskArns": [
87
+ * "arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84"
88
+ * ]
89
+ * }
90
+ * *\/
91
+ * // example id: 024bf3b7-9cbb-44e3-848f-9d074e1fecce
92
+ * ```
93
+ *
36
94
  */
37
95
  export declare class ListTasksCommand extends $Command<ListTasksCommandInput, ListTasksCommandOutput, ECSClientResolvedConfig> {
38
96
  readonly input: ListTasksCommandInput;
@@ -52,6 +52,62 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons
52
52
  * @see {@link PutAccountSettingCommandOutput} for command's `response` shape.
53
53
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
54
54
  *
55
+ * @throws {@link ClientException} (client fault)
56
+ * <p>These errors are usually caused by a client action. This client action might be using
57
+ * an action or resource on behalf of a user that doesn't have permissions to use the
58
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
59
+ *
60
+ * @throws {@link InvalidParameterException} (client fault)
61
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
62
+ * request.</p>
63
+ *
64
+ * @throws {@link ServerException} (server fault)
65
+ * <p>These errors are usually caused by a server issue.</p>
66
+ *
67
+ *
68
+ * @example To modify your account settings
69
+ * ```javascript
70
+ * // 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.
71
+ * const input = {
72
+ * "name": "serviceLongArnFormat",
73
+ * "value": "enabled"
74
+ * };
75
+ * const command = new PutAccountSettingCommand(input);
76
+ * const response = await client.send(command);
77
+ * /* response ==
78
+ * {
79
+ * "setting": {
80
+ * "name": "serviceLongArnFormat",
81
+ * "value": "enabled",
82
+ * "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
83
+ * }
84
+ * }
85
+ * *\/
86
+ * // example id: to-modify-the-account-settings-for-your-iam-user-account-1549523130939
87
+ * ```
88
+ *
89
+ * @example To modify the account settings for a specific IAM user or IAM role
90
+ * ```javascript
91
+ * // 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.
92
+ * const input = {
93
+ * "name": "containerInstanceLongArnFormat",
94
+ * "value": "enabled",
95
+ * "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
96
+ * };
97
+ * const command = new PutAccountSettingCommand(input);
98
+ * const response = await client.send(command);
99
+ * /* response ==
100
+ * {
101
+ * "setting": {
102
+ * "name": "containerInstanceLongArnFormat",
103
+ * "value": "enabled",
104
+ * "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
105
+ * }
106
+ * }
107
+ * *\/
108
+ * // example id: to-modify-the-account-settings-for-a-specific-iam-user-or-iam-role-1549523518390
109
+ * ```
110
+ *
55
111
  */
56
112
  export declare class PutAccountSettingCommand extends $Command<PutAccountSettingCommandInput, PutAccountSettingCommandOutput, ECSClientResolvedConfig> {
57
113
  readonly input: PutAccountSettingCommandInput;
@@ -31,6 +31,40 @@ export interface PutAccountSettingDefaultCommandOutput extends PutAccountSetting
31
31
  * @see {@link PutAccountSettingDefaultCommandOutput} for command's `response` shape.
32
32
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
33
33
  *
34
+ * @throws {@link ClientException} (client fault)
35
+ * <p>These errors are usually caused by a client action. This client action might be using
36
+ * an action or resource on behalf of a user that doesn't have permissions to use the
37
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
38
+ *
39
+ * @throws {@link InvalidParameterException} (client fault)
40
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
41
+ * request.</p>
42
+ *
43
+ * @throws {@link ServerException} (server fault)
44
+ * <p>These errors are usually caused by a server issue.</p>
45
+ *
46
+ *
47
+ * @example To modify the default account settings for all IAM users or roles on an account
48
+ * ```javascript
49
+ * // This example modifies the default account setting for the specified resource for all IAM users or roles on an account. These changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.
50
+ * const input = {
51
+ * "name": "serviceLongArnFormat",
52
+ * "value": "enabled"
53
+ * };
54
+ * const command = new PutAccountSettingDefaultCommand(input);
55
+ * const response = await client.send(command);
56
+ * /* response ==
57
+ * {
58
+ * "setting": {
59
+ * "name": "serviceLongArnFormat",
60
+ * "value": "enabled",
61
+ * "principalArn": "arn:aws:iam::<aws_account_id>:root"
62
+ * }
63
+ * }
64
+ * *\/
65
+ * // example id: to-modify-the-default-account-settings-for-all-iam-users-or-roles-on-your-account-1549523794603
66
+ * ```
67
+ *
34
68
  */
35
69
  export declare class PutAccountSettingDefaultCommand extends $Command<PutAccountSettingDefaultCommandInput, PutAccountSettingDefaultCommandOutput, ECSClientResolvedConfig> {
36
70
  readonly input: PutAccountSettingDefaultCommandInput;
@@ -32,6 +32,24 @@ export interface PutAttributesCommandOutput extends PutAttributesResponse, __Met
32
32
  * @see {@link PutAttributesCommandOutput} for command's `response` shape.
33
33
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
34
34
  *
35
+ * @throws {@link AttributeLimitExceededException} (client fault)
36
+ * <p>You can apply up to 10 custom attributes for each resource. You can view the
37
+ * attributes of a resource with <a>ListAttributes</a>. You can remove existing
38
+ * attributes on a resource with <a>DeleteAttributes</a>.</p>
39
+ *
40
+ * @throws {@link ClusterNotFoundException} (client fault)
41
+ * <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
42
+ *
43
+ * @throws {@link InvalidParameterException} (client fault)
44
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
45
+ * request.</p>
46
+ *
47
+ * @throws {@link TargetNotFoundException} (client fault)
48
+ * <p>The specified target wasn't found. You can view your available container instances
49
+ * with <a>ListContainerInstances</a>. Amazon ECS container instances are
50
+ * cluster-specific and Region-specific.</p>
51
+ *
52
+ *
35
53
  */
36
54
  export declare class PutAttributesCommand extends $Command<PutAttributesCommandInput, PutAttributesCommandOutput, ECSClientResolvedConfig> {
37
55
  readonly input: PutAttributesCommandInput;
@@ -42,6 +42,32 @@ export interface PutClusterCapacityProvidersCommandOutput extends PutClusterCapa
42
42
  * @see {@link PutClusterCapacityProvidersCommandOutput} for command's `response` shape.
43
43
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
44
44
  *
45
+ * @throws {@link ClientException} (client fault)
46
+ * <p>These errors are usually caused by a client action. This client action might be using
47
+ * an action or resource on behalf of a user that doesn't have permissions to use the
48
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
49
+ *
50
+ * @throws {@link ClusterNotFoundException} (client fault)
51
+ * <p>The specified cluster wasn't found. You can view your available clusters with <a>ListClusters</a>. Amazon ECS clusters are Region specific.</p>
52
+ *
53
+ * @throws {@link InvalidParameterException} (client fault)
54
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
55
+ * request.</p>
56
+ *
57
+ * @throws {@link ResourceInUseException} (client fault)
58
+ * <p>The specified resource is in-use and can't be removed.</p>
59
+ *
60
+ * @throws {@link ServerException} (server fault)
61
+ * <p>These errors are usually caused by a server issue.</p>
62
+ *
63
+ * @throws {@link UpdateInProgressException} (client fault)
64
+ * <p>There's already a current Amazon ECS container agent update in progress on the container
65
+ * instance that's specified. If the container agent becomes disconnected while it's in a
66
+ * transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update
67
+ * process can get stuck in that state. However, when the agent reconnects, it resumes
68
+ * where it stopped previously.</p>
69
+ *
70
+ *
45
71
  */
46
72
  export declare class PutClusterCapacityProvidersCommand extends $Command<PutClusterCapacityProvidersCommandInput, PutClusterCapacityProvidersCommandOutput, ECSClientResolvedConfig> {
47
73
  readonly input: PutClusterCapacityProvidersCommandInput;
@@ -33,6 +33,19 @@ export interface RegisterContainerInstanceCommandOutput extends RegisterContaine
33
33
  * @see {@link RegisterContainerInstanceCommandOutput} for command's `response` shape.
34
34
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
35
35
  *
36
+ * @throws {@link ClientException} (client fault)
37
+ * <p>These errors are usually caused by a client action. This client action might be using
38
+ * an action or resource on behalf of a user that doesn't have permissions to use the
39
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
40
+ *
41
+ * @throws {@link InvalidParameterException} (client fault)
42
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
43
+ * request.</p>
44
+ *
45
+ * @throws {@link ServerException} (server fault)
46
+ * <p>These errors are usually caused by a server issue.</p>
47
+ *
48
+ *
36
49
  */
37
50
  export declare class RegisterContainerInstanceCommand extends $Command<RegisterContainerInstanceCommandInput, RegisterContainerInstanceCommandOutput, ECSClientResolvedConfig> {
38
51
  readonly input: RegisterContainerInstanceCommandInput;
@@ -46,6 +46,72 @@ export interface RegisterTaskDefinitionCommandOutput extends RegisterTaskDefinit
46
46
  * @see {@link RegisterTaskDefinitionCommandOutput} for command's `response` shape.
47
47
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
48
48
  *
49
+ * @throws {@link ClientException} (client fault)
50
+ * <p>These errors are usually caused by a client action. This client action might be using
51
+ * an action or resource on behalf of a user that doesn't have permissions to use the
52
+ * action or resource,. Or, it might be specifying an identifier that isn't valid.</p>
53
+ *
54
+ * @throws {@link InvalidParameterException} (client fault)
55
+ * <p>The specified parameter isn't valid. Review the available parameters for the API
56
+ * request.</p>
57
+ *
58
+ * @throws {@link ServerException} (server fault)
59
+ * <p>These errors are usually caused by a server issue.</p>
60
+ *
61
+ *
62
+ * @example To register a task definition
63
+ * ```javascript
64
+ * // This example registers a task definition to the specified family.
65
+ * const input = {
66
+ * "containerDefinitions": [
67
+ * {
68
+ * "name": "sleep",
69
+ * "command": [
70
+ * "sleep",
71
+ * "360"
72
+ * ],
73
+ * "cpu": 10,
74
+ * "essential": true,
75
+ * "image": "busybox",
76
+ * "memory": 10
77
+ * }
78
+ * ],
79
+ * "family": "sleep360",
80
+ * "taskRoleArn": "",
81
+ * "volumes": []
82
+ * };
83
+ * const command = new RegisterTaskDefinitionCommand(input);
84
+ * const response = await client.send(command);
85
+ * /* response ==
86
+ * {
87
+ * "taskDefinition": {
88
+ * "containerDefinitions": [
89
+ * {
90
+ * "name": "sleep",
91
+ * "command": [
92
+ * "sleep",
93
+ * "360"
94
+ * ],
95
+ * "cpu": 10,
96
+ * "environment": [],
97
+ * "essential": true,
98
+ * "image": "busybox",
99
+ * "memory": 10,
100
+ * "mountPoints": [],
101
+ * "portMappings": [],
102
+ * "volumesFrom": []
103
+ * }
104
+ * ],
105
+ * "family": "sleep360",
106
+ * "revision": 1,
107
+ * "taskDefinitionArn": "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:19",
108
+ * "volumes": []
109
+ * }
110
+ * }
111
+ * *\/
112
+ * // example id: to-register-a-task-definition-1470764550877
113
+ * ```
114
+ *
49
115
  */
50
116
  export declare class RegisterTaskDefinitionCommand extends $Command<RegisterTaskDefinitionCommandInput, RegisterTaskDefinitionCommandOutput, ECSClientResolvedConfig> {
51
117
  readonly input: RegisterTaskDefinitionCommandInput;