lib/aws-sdk-ecs/client.rb in aws-sdk-ecs-1.29.0 vs lib/aws-sdk-ecs/client.rb in aws-sdk-ecs-1.30.0

- old
+ new

@@ -397,11 +397,11 @@ # container instances with the fewest number of running tasks for # this service. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html # # @option params [String] :cluster # The short name or full Amazon Resource Name (ARN) of the cluster on # which to run your service. If you do not specify a cluster, the # default cluster is assumed. @@ -491,11 +491,11 @@ # see [Amazon ECS Launch Types][1] in the *Amazon Elastic Container # Service Developer Guide*. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html # # @option params [String] :platform_version # The platform version on which your tasks in the service are running. A # platform version is only specified for tasks using the Fargate launch # type. If one is not specified, the `LATEST` platform version is used @@ -503,11 +503,11 @@ # Versions][1] in the *Amazon Elastic Container Service Developer # Guide*. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html # # @option params [String] :role # The name or full Amazon Resource Name (ARN) of the IAM role that # allows Amazon ECS to make calls to your load balancer on your behalf. # This parameter is only permitted if you are using a load balancer with @@ -531,11 +531,11 @@ # User Guide*. # # # # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html - # [2]: http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names + # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names # # @option params [Types::DeploymentConfiguration] :deployment_configuration # Optional deployment parameters that control how many tasks run during # the deployment and the ordering of stopping and starting tasks. # @@ -943,10 +943,47 @@ # # @return [Types::DeleteAccountSettingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteAccountSettingResponse#setting #setting} => Types::Setting # + # + # @example Example: To delete your account setting + # + # # This example deletes the account setting for your user for the specified resource type. + # + # resp = client.delete_account_setting({ + # name: "serviceLongArnFormat", + # }) + # + # resp.to_h outputs the following: + # { + # setting: { + # name: "serviceLongArnFormat", + # value: "enabled", + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }, + # } + # + # @example Example: To delete the account settings for a specific IAM user or IAM role + # + # # This example deletes the account setting for a specific IAM user or IAM role for the specified resource type. Only the + # # root user can view or modify the account settings for another user. + # + # resp = client.delete_account_setting({ + # name: "containerInstanceLongArnFormat", + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }) + # + # resp.to_h outputs the following: + # { + # setting: { + # name: "containerInstanceLongArnFormat", + # value: "enabled", + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }, + # } + # # @example Request syntax with placeholder values # # resp = client.delete_account_setting({ # name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat # principal_arn: "String", @@ -2496,10 +2533,70 @@ # @return [Types::ListAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListAccountSettingsResponse#settings #settings} => Array&lt;Types::Setting&gt; # * {Types::ListAccountSettingsResponse#next_token #next_token} => String # + # + # @example Example: To view your effective account settings + # + # # This example displays the effective account settings for your account. + # + # resp = client.list_account_settings({ + # effective_settings: true, + # }) + # + # resp.to_h outputs the following: + # { + # settings: [ + # { + # name: "containerInstanceLongArnFormat", + # value: "disabled", + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }, + # { + # name: "serviceLongArnFormat", + # value: "enabled", + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }, + # { + # name: "taskLongArnFormat", + # value: "disabled", + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }, + # ], + # } + # + # @example Example: To view the effective account settings for a specific IAM user or IAM role + # + # # This example displays the effective account settings for the specified user or role. + # + # resp = client.list_account_settings({ + # effective_settings: true, + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }) + # + # resp.to_h outputs the following: + # { + # settings: [ + # { + # name: "containerInstanceLongArnFormat", + # value: "disabled", + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }, + # { + # name: "serviceLongArnFormat", + # value: "enabled", + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }, + # { + # name: "taskLongArnFormat", + # value: "disabled", + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }, + # ], + # } + # # @example Request syntax with placeholder values # # resp = client.list_account_settings({ # name: "serviceLongArnFormat", # accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat # value: "String", @@ -2679,11 +2776,11 @@ # more information, see [Cluster Query Language][1] in the *Amazon # Elastic Container Service Developer Guide*. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html # # @option params [String] :cluster # The short name or full Amazon Resource Name (ARN) of the cluster that # hosts the container instances to list. If you do not specify a # cluster, the default cluster is assumed. @@ -2694,11 +2791,11 @@ # [Cluster Query Language][1] in the *Amazon Elastic Container Service # Developer Guide*. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html # # @option params [String] :next_token # The `nextToken` value returned from a previous paginated # `ListContainerInstances` request where `maxResults` was used and the # results exceeded the value of that parameter. Pagination continues @@ -3280,16 +3377,26 @@ def list_tasks(params = {}, options = {}) req = build_request(:list_tasks, params) req.send_request(options) end - # Modifies the ARN and resource ID format of a resource for a specified - # IAM user, IAM role, or the root user for an account. You can specify - # whether the new ARN and resource ID format are enabled for new - # resources that are created. Enabling this setting is required to use - # new Amazon ECS features such as resource tagging. + # Modifies the ARN and resource ID format of a resource type for a + # specified IAM user, IAM role, or the root user for an account. If the + # account setting for the root user is changed, it sets the default + # setting for all of the IAM users and roles for which no individual + # account setting has been set. The opt-in and opt-out account setting + # can be set for each Amazon ECS resource separately. The ARN and + # resource ID format of a resource will be defined by the opt-in status + # of the IAM user or role that created the resource. Enabling this + # setting is required to use new Amazon ECS features such as resource + # tagging. For more information, see [Amazon Resource Names (ARNs) and + # IDs][1] in the *Amazon Elastic Container Service Developer Guide*. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-resource-ids.html + # # @option params [required, String] :name # The resource name for which to enable the new format. If # `serviceLongArnFormat` is specified, the ARN for your Amazon ECS # services is affected. If `taskLongArnFormat` is specified, the ARN and # resource ID for your Amazon ECS tasks is affected. If @@ -3303,17 +3410,59 @@ # @option params [String] :principal_arn # The ARN of the principal, which can be an IAM user, IAM role, or the # root user. If you specify the root user, it modifies the ARN and # resource ID format for all IAM users, IAM roles, and the root user of # the account unless an IAM user or role explicitly overrides these - # settings for themselves. If this field is omitted, the setting are + # settings for themselves. If this field is omitted, the settings are # changed only for the authenticated user. # # @return [Types::PutAccountSettingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::PutAccountSettingResponse#setting #setting} => Types::Setting # + # + # @example Example: To modify your account settings + # + # # 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. + # + # resp = client.put_account_setting({ + # name: "serviceLongArnFormat", + # value: "enabled", + # }) + # + # resp.to_h outputs the following: + # { + # setting: { + # name: "serviceLongArnFormat", + # value: "enabled", + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }, + # } + # + # @example Example: To modify the account settings for a specific IAM user or IAM role + # + # # 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. + # + # resp = client.put_account_setting({ + # name: "containerInstanceLongArnFormat", + # value: "enabled", + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }) + # + # resp.to_h outputs the following: + # { + # setting: { + # name: "containerInstanceLongArnFormat", + # value: "enabled", + # principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", + # }, + # } + # # @example Request syntax with placeholder values # # resp = client.put_account_setting({ # name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat # value: "String", # required @@ -3333,19 +3482,83 @@ def put_account_setting(params = {}, options = {}) req = build_request(:put_account_setting, params) req.send_request(options) end + # Modifies the ARN and resource ID format of a resource type for all IAM + # users on an account for which no individual account setting has been + # set. Enabling this setting is required to use new Amazon ECS features + # such as resource tagging. + # + # @option params [required, String] :name + # The resource type to enable the new format for. If + # `serviceLongArnFormat` is specified, the ARN for your Amazon ECS + # services is affected. If `taskLongArnFormat` is specified, the ARN and + # resource ID for your Amazon ECS tasks are affected. If + # `containerInstanceLongArnFormat` is specified, the ARN and resource ID + # for your Amazon ECS container instances are affected. + # + # @option params [required, String] :value + # The account setting value for the specified principal ARN. Accepted + # values are `enabled` and `disabled`. + # + # @return [Types::PutAccountSettingDefaultResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::PutAccountSettingDefaultResponse#setting #setting} => Types::Setting + # + # + # @example Example: To modify the default account settings for all IAM users or roles on an account + # + # # 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. + # + # resp = client.put_account_setting_default({ + # name: "serviceLongArnFormat", + # value: "enabled", + # }) + # + # resp.to_h outputs the following: + # { + # setting: { + # name: "serviceLongArnFormat", + # value: "enabled", + # principal_arn: "arn:aws:iam::<aws_account_id>:root", + # }, + # } + # + # @example Request syntax with placeholder values + # + # resp = client.put_account_setting_default({ + # name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat + # value: "String", # required + # }) + # + # @example Response structure + # + # resp.setting.name #=> String, one of "serviceLongArnFormat", "taskLongArnFormat", "containerInstanceLongArnFormat" + # resp.setting.value #=> String + # resp.setting.principal_arn #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAccountSettingDefault AWS API Documentation + # + # @overload put_account_setting_default(params = {}) + # @param [Hash] params ({}) + def put_account_setting_default(params = {}, options = {}) + req = build_request(:put_account_setting_default, params) + req.send_request(options) + end + # Create or update an attribute on an Amazon ECS resource. If the # attribute does not exist, it is created. If the attribute exists, its # value is replaced with the specified value. To delete an attribute, # use DeleteAttributes. For more information, see [Attributes][1] in the # *Amazon Elastic Container Service Developer Guide*. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes # # @option params [String] :cluster # The short name or full Amazon Resource Name (ARN) of the cluster that # contains the resource to apply attributes. If you do not specify a # cluster, the default cluster is assumed. @@ -3567,12 +3780,12 @@ # Networking][4] in the *Amazon Elastic Container Service Developer # Guide*. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html - # [2]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html + # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html # [3]: https://docs.docker.com/engine/reference/run/#/network-settings # [4]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html # # @option params [required, String] :family # You must specify a `family` for a task definition, which allows you to @@ -3587,11 +3800,11 @@ # information, see [IAM Roles for Tasks][1] in the *Amazon Elastic # Container Service Developer Guide*. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html # # @option params [String] :execution_role_arn # The Amazon Resource Name (ARN) of the task execution role that the # Amazon ECS container agent and the Docker daemon can assume. # @@ -4196,11 +4409,11 @@ # algorithm starting with a couple of seconds of wait time, and # increase gradually up to about five minutes of wait time. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html # # @option params [String] :cluster # The short name or full Amazon Resource Name (ARN) of the cluster on # which to run your task. If you do not specify a cluster, the default # cluster is assumed. @@ -4260,22 +4473,22 @@ # [Amazon ECS Launch Types][1] in the *Amazon Elastic Container Service # Developer Guide*. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html # # @option params [String] :platform_version # The platform version the task should run. A platform version is only # specified for tasks using the Fargate launch type. If one is not # specified, the `LATEST` platform version is used by default. For more # information, see [AWS Fargate Platform Versions][1] in the *Amazon # Elastic Container Service Developer Guide*. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html # # @option params [Types::NetworkConfiguration] :network_configuration # The network configuration for the task. This parameter is required for # task definitions that use the `awsvpc` network mode to receive their # own elastic network interface, and it is not supported for other @@ -4515,11 +4728,11 @@ # information, see [Scheduling Tasks][1] in the *Amazon Elastic # Container Service Developer Guide*. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html # # @option params [String] :cluster # The short name or full Amazon Resource Name (ARN) of the cluster on # which to start your task. If you do not specify a cluster, the default # cluster is assumed. @@ -4752,11 +4965,11 @@ # # </note> # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html # # @option params [String] :cluster # The short name or full Amazon Resource Name (ARN) of the cluster that # hosts the task to stop. If you do not specify a cluster, the default # cluster is assumed. @@ -5132,11 +5345,11 @@ # see [Manually Updating the Amazon ECS Container Agent][1] in the # *Amazon Elastic Container Service Developer Guide*. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent # # @option params [String] :cluster # The short name or full Amazon Resource Name (ARN) of the cluster that # your container instance is running on. If you do not specify a # cluster, the default cluster is assumed. @@ -5501,11 +5714,11 @@ # Versions][1] in the *Amazon Elastic Container Service Developer # Guide*. # # # - # [1]: http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html # # @option params [Boolean] :force_new_deployment # Whether to force a new deployment of the service. Deployments are not # forced by default. You can use this option to trigger a new deployment # with no service definition changes. For example, you can update a @@ -5694,10 +5907,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-ecs' - context[:gem_version] = '1.29.0' + context[:gem_version] = '1.30.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #