lib/aws-sdk-ecs/client.rb in aws-sdk-ecs-1.45.0 vs lib/aws-sdk-ecs/client.rb in aws-sdk-ecs-1.46.0
- old
+ new
@@ -289,14 +289,37 @@
# (uppercase and lowercase), numbers, and hyphens are allowed.
#
# @option params [Array<Types::Tag>] :tags
# The metadata that you apply to the cluster to help you categorize and
# organize them. Each tag consists of a key and an optional value, both
- # of which you define. Tag keys can have a maximum character length of
- # 128 characters, and tag values can have a maximum length of 256
- # characters.
+ # of which you define.
#
+ # The following basic restrictions apply to tags:
+ #
+ # * Maximum number of tags per resource - 50
+ #
+ # * For each resource, each tag key must be unique, and each tag key can
+ # have only one value.
+ #
+ # * Maximum key length - 128 Unicode characters in UTF-8
+ #
+ # * Maximum value length - 256 Unicode characters in UTF-8
+ #
+ # * If your tagging schema is used across multiple services and
+ # resources, remember that other services may have restrictions on
+ # allowed characters. Generally allowed characters are: letters,
+ # numbers, and spaces representable in UTF-8, and the following
+ # characters: + - = . \_ : / @.
+ #
+ # * Tag keys and values are case-sensitive.
+ #
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
+ # such as a prefix for either keys or values as it is reserved for AWS
+ # use. You cannot edit or delete tag keys or values with this prefix.
+ # Tags with this prefix do not count against your tags per resource
+ # limit.
+ #
# @option params [Array<Types::ClusterSetting>] :settings
# The setting to use when creating a cluster. This parameter is used to
# enable CloudWatch Container Insights for a cluster. If this value is
# specified, it will override the `containerInsights` value set with
# PutAccountSetting or PutAccountSettingDefault.
@@ -699,14 +722,37 @@
#
# @option params [Array<Types::Tag>] :tags
# The metadata that you apply to the service to help you categorize and
# organize them. Each tag consists of a key and an optional value, both
# of which you define. When a service is deleted, the tags are deleted
- # as well. Tag keys can have a maximum character length of 128
- # characters, and tag values can have a maximum length of 256
- # characters.
+ # as well.
#
+ # The following basic restrictions apply to tags:
+ #
+ # * Maximum number of tags per resource - 50
+ #
+ # * For each resource, each tag key must be unique, and each tag key can
+ # have only one value.
+ #
+ # * Maximum key length - 128 Unicode characters in UTF-8
+ #
+ # * Maximum value length - 256 Unicode characters in UTF-8
+ #
+ # * If your tagging schema is used across multiple services and
+ # resources, remember that other services may have restrictions on
+ # allowed characters. Generally allowed characters are: letters,
+ # numbers, and spaces representable in UTF-8, and the following
+ # characters: + - = . \_ : / @.
+ #
+ # * Tag keys and values are case-sensitive.
+ #
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
+ # such as a prefix for either keys or values as it is reserved for AWS
+ # use. You cannot edit or delete tag keys or values with this prefix.
+ # Tags with this prefix do not count against your tags per resource
+ # limit.
+ #
# @option params [Boolean] :enable_ecs_managed_tags
# Specifies whether to enable Amazon ECS managed tags for the tasks
# within the service. For more information, see [Tagging Your Amazon ECS
# Resources][1] in the *Amazon Elastic Container Service Developer
# Guide*.
@@ -1384,17 +1430,17 @@
# more information, see UpdateService.
#
# <note markdown="1"> When you delete a service, if there are still running tasks that
# require cleanup, the service status moves from `ACTIVE` to `DRAINING`,
# and the service is no longer visible in the console or in the
- # ListServices API operation. After the tasks have stopped, then the
- # service status moves from `DRAINING` to `INACTIVE`. Services in the
- # `DRAINING` or `INACTIVE` status can still be viewed with the
- # DescribeServices API operation. However, in the future, `INACTIVE`
- # services may be cleaned up and purged from Amazon ECS record keeping,
- # and DescribeServices calls on those services return a
- # `ServiceNotFoundException` error.
+ # ListServices API operation. After all tasks have transitioned to
+ # either `STOPPING` or `STOPPED` status, the service status moves from
+ # `DRAINING` to `INACTIVE`. Services in the `DRAINING` or `INACTIVE`
+ # status can still be viewed with the DescribeServices API operation.
+ # However, in the future, `INACTIVE` services may be cleaned up and
+ # purged from Amazon ECS record keeping, and DescribeServices calls on
+ # those services return a `ServiceNotFoundException` error.
#
# </note>
#
# If you attempt to create a new service with the same name as an
# existing service in either `ACTIVE` or `DRAINING` status, you receive
@@ -1846,10 +1892,12 @@
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs #=> Array
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].container_path #=> String
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].size #=> Integer
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].mount_options #=> Array
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].mount_options[0] #=> String
+ # resp.task_definition.container_definitions[0].linux_parameters.max_swap #=> Integer
+ # resp.task_definition.container_definitions[0].linux_parameters.swappiness #=> Integer
# resp.task_definition.container_definitions[0].secrets #=> Array
# resp.task_definition.container_definitions[0].secrets[0].name #=> String
# resp.task_definition.container_definitions[0].secrets[0].value_from #=> String
# resp.task_definition.container_definitions[0].depends_on #=> Array
# resp.task_definition.container_definitions[0].depends_on[0].container_name #=> String
@@ -2562,10 +2610,12 @@
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs #=> Array
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].container_path #=> String
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].size #=> Integer
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].mount_options #=> Array
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].mount_options[0] #=> String
+ # resp.task_definition.container_definitions[0].linux_parameters.max_swap #=> Integer
+ # resp.task_definition.container_definitions[0].linux_parameters.swappiness #=> Integer
# resp.task_definition.container_definitions[0].secrets #=> Array
# resp.task_definition.container_definitions[0].secrets[0].name #=> String
# resp.task_definition.container_definitions[0].secrets[0].value_from #=> String
# resp.task_definition.container_definitions[0].depends_on #=> Array
# resp.task_definition.container_definitions[0].depends_on[0].container_name #=> String
@@ -3851,16 +3901,19 @@
def list_tasks(params = {}, options = {})
req = build_request(:list_tasks, params)
req.send_request(options)
end
- # Modifies an account setting. If you change the account setting for the
- # root user, the default settings for all of the IAM users and roles for
- # which no individual account setting has been specified are reset. For
- # more information, see [Account Settings][1] in the *Amazon Elastic
- # Container Service Developer Guide*.
+ # Modifies an account setting. Account settings are set on a per-Region
+ # basis.
#
+ # If you change the account setting for the root user, the default
+ # settings for all of the IAM users and roles for which no individual
+ # account setting has been specified are reset. For more information,
+ # see [Account Settings][1] in the *Amazon Elastic Container Service
+ # Developer Guide*.
+ #
# When `serviceLongArnFormat`, `taskLongArnFormat`, or
# `containerInstanceLongArnFormat` are specified, the Amazon Resource
# Name (ARN) and resource ID format of the resource type for a specified
# IAM user, IAM role, or the root user for an account is affected. The
# opt-in and opt-out account setting must be set for each Amazon ECS
@@ -3983,11 +4036,12 @@
req = build_request(:put_account_setting, params)
req.send_request(options)
end
# Modifies an account setting for all IAM users on an account for whom
- # no individual account setting has been specified.
+ # no individual account setting has been specified. Account settings are
+ # set on a per-Region basis.
#
# @option params [required, String] :name
# The resource name for which to modify the account setting. If
# `serviceLongArnFormat` is specified, the ARN for your Amazon ECS
# services is affected. If `taskLongArnFormat` is specified, the ARN and
@@ -4149,14 +4203,37 @@
# supported device type is a GPU.
#
# @option params [Array<Types::Tag>] :tags
# The metadata that you apply to the container instance to help you
# categorize and organize them. Each tag consists of a key and an
- # optional value, both of which you define. Tag keys can have a maximum
- # character length of 128 characters, and tag values can have a maximum
- # length of 256 characters.
+ # optional value, both of which you define.
#
+ # The following basic restrictions apply to tags:
+ #
+ # * Maximum number of tags per resource - 50
+ #
+ # * For each resource, each tag key must be unique, and each tag key can
+ # have only one value.
+ #
+ # * Maximum key length - 128 Unicode characters in UTF-8
+ #
+ # * Maximum value length - 256 Unicode characters in UTF-8
+ #
+ # * If your tagging schema is used across multiple services and
+ # resources, remember that other services may have restrictions on
+ # allowed characters. Generally allowed characters are: letters,
+ # numbers, and spaces representable in UTF-8, and the following
+ # characters: + - = . \_ : / @.
+ #
+ # * Tag keys and values are case-sensitive.
+ #
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
+ # such as a prefix for either keys or values as it is reserved for AWS
+ # use. You cannot edit or delete tag keys or values with this prefix.
+ # Tags with this prefix do not count against your tags per resource
+ # limit.
+ #
# @return [Types::RegisterContainerInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::RegisterContainerInstanceResponse#container_instance #container_instance} => Types::ContainerInstance
#
# @example Request syntax with placeholder values
@@ -4448,14 +4525,37 @@
# Available `cpu` values: 4096 (4 vCPU)
#
# @option params [Array<Types::Tag>] :tags
# The metadata that you apply to the task definition to help you
# categorize and organize them. Each tag consists of a key and an
- # optional value, both of which you define. Tag keys can have a maximum
- # character length of 128 characters, and tag values can have a maximum
- # length of 256 characters.
+ # optional value, both of which you define.
#
+ # The following basic restrictions apply to tags:
+ #
+ # * Maximum number of tags per resource - 50
+ #
+ # * For each resource, each tag key must be unique, and each tag key can
+ # have only one value.
+ #
+ # * Maximum key length - 128 Unicode characters in UTF-8
+ #
+ # * Maximum value length - 256 Unicode characters in UTF-8
+ #
+ # * If your tagging schema is used across multiple services and
+ # resources, remember that other services may have restrictions on
+ # allowed characters. Generally allowed characters are: letters,
+ # numbers, and spaces representable in UTF-8, and the following
+ # characters: + - = . \_ : / @.
+ #
+ # * Tag keys and values are case-sensitive.
+ #
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
+ # such as a prefix for either keys or values as it is reserved for AWS
+ # use. You cannot edit or delete tag keys or values with this prefix.
+ # Tags with this prefix do not count against your tags per resource
+ # limit.
+ #
# @option params [String] :pid_mode
# The process namespace to use for the containers in the task. The valid
# values are `host` or `task`. If `host` is specified, then all
# containers within the tasks that specified the `host` PID mode on the
# same container instance share the same IPC resources with the host
@@ -4665,10 +4765,12 @@
# container_path: "String", # required
# size: 1, # required
# mount_options: ["String"],
# },
# ],
+ # max_swap: 1,
+ # swappiness: 1,
# },
# secrets: [
# {
# name: "String", # required
# value_from: "String", # required
@@ -4835,10 +4937,12 @@
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs #=> Array
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].container_path #=> String
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].size #=> Integer
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].mount_options #=> Array
# resp.task_definition.container_definitions[0].linux_parameters.tmpfs[0].mount_options[0] #=> String
+ # resp.task_definition.container_definitions[0].linux_parameters.max_swap #=> Integer
+ # resp.task_definition.container_definitions[0].linux_parameters.swappiness #=> Integer
# resp.task_definition.container_definitions[0].secrets #=> Array
# resp.task_definition.container_definitions[0].secrets[0].name #=> String
# resp.task_definition.container_definitions[0].secrets[0].value_from #=> String
# resp.task_definition.container_definitions[0].depends_on #=> Array
# resp.task_definition.container_definitions[0].depends_on[0].container_name #=> String
@@ -5059,14 +5163,37 @@
# [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html
#
# @option params [Array<Types::Tag>] :tags
# The metadata that you apply to the task to help you categorize and
# organize them. Each tag consists of a key and an optional value, both
- # of which you define. Tag keys can have a maximum character length of
- # 128 characters, and tag values can have a maximum length of 256
- # characters.
+ # of which you define.
#
+ # The following basic restrictions apply to tags:
+ #
+ # * Maximum number of tags per resource - 50
+ #
+ # * For each resource, each tag key must be unique, and each tag key can
+ # have only one value.
+ #
+ # * Maximum key length - 128 Unicode characters in UTF-8
+ #
+ # * Maximum value length - 256 Unicode characters in UTF-8
+ #
+ # * If your tagging schema is used across multiple services and
+ # resources, remember that other services may have restrictions on
+ # allowed characters. Generally allowed characters are: letters,
+ # numbers, and spaces representable in UTF-8, and the following
+ # characters: + - = . \_ : / @.
+ #
+ # * Tag keys and values are case-sensitive.
+ #
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
+ # such as a prefix for either keys or values as it is reserved for AWS
+ # use. You cannot edit or delete tag keys or values with this prefix.
+ # Tags with this prefix do not count against your tags per resource
+ # limit.
+ #
# @option params [Boolean] :enable_ecs_managed_tags
# Specifies whether to enable Amazon ECS managed tags for the task. For
# more information, see [Tagging Your Amazon ECS Resources][1] in the
# *Amazon Elastic Container Service Developer Guide*.
#
@@ -5344,14 +5471,37 @@
# mode.
#
# @option params [Array<Types::Tag>] :tags
# The metadata that you apply to the task to help you categorize and
# organize them. Each tag consists of a key and an optional value, both
- # of which you define. Tag keys can have a maximum character length of
- # 128 characters, and tag values can have a maximum length of 256
- # characters.
+ # of which you define.
#
+ # The following basic restrictions apply to tags:
+ #
+ # * Maximum number of tags per resource - 50
+ #
+ # * For each resource, each tag key must be unique, and each tag key can
+ # have only one value.
+ #
+ # * Maximum key length - 128 Unicode characters in UTF-8
+ #
+ # * Maximum value length - 256 Unicode characters in UTF-8
+ #
+ # * If your tagging schema is used across multiple services and
+ # resources, remember that other services may have restrictions on
+ # allowed characters. Generally allowed characters are: letters,
+ # numbers, and spaces representable in UTF-8, and the following
+ # characters: + - = . \_ : / @.
+ #
+ # * Tag keys and values are case-sensitive.
+ #
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
+ # such as a prefix for either keys or values as it is reserved for AWS
+ # use. You cannot edit or delete tag keys or values with this prefix.
+ # Tags with this prefix do not count against your tags per resource
+ # limit.
+ #
# @option params [Boolean] :enable_ecs_managed_tags
# Specifies whether to enable Amazon ECS managed tags for the task. For
# more information, see [Tagging Your Amazon ECS Resources][1] in the
# *Amazon Elastic Container Service Developer Guide*.
#
@@ -5843,13 +5993,36 @@
# Currently, the supported resources are Amazon ECS tasks, services,
# task definitions, clusters, and container instances.
#
# @option params [required, Array<Types::Tag>] :tags
# The tags to add to the resource. A tag is an array of key-value pairs.
- # Tag keys can have a maximum character length of 128 characters, and
- # tag values can have a maximum length of 256 characters.
#
+ # The following basic restrictions apply to tags:
+ #
+ # * Maximum number of tags per resource - 50
+ #
+ # * For each resource, each tag key must be unique, and each tag key can
+ # have only one value.
+ #
+ # * Maximum key length - 128 Unicode characters in UTF-8
+ #
+ # * Maximum value length - 256 Unicode characters in UTF-8
+ #
+ # * If your tagging schema is used across multiple services and
+ # resources, remember that other services may have restrictions on
+ # allowed characters. Generally allowed characters are: letters,
+ # numbers, and spaces representable in UTF-8, and the following
+ # characters: + - = . \_ : / @.
+ #
+ # * Tag keys and values are case-sensitive.
+ #
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
+ # such as a prefix for either keys or values as it is reserved for AWS
+ # use. You cannot edit or delete tag keys or values with this prefix.
+ # Tags with this prefix do not count against your tags per resource
+ # limit.
+ #
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
#
#
# @example Example: To tag a cluster.
#
@@ -6702,10 +6875,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-ecs'
- context[:gem_version] = '1.45.0'
+ context[:gem_version] = '1.46.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#