Class: Aws::ECS::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb

Overview

An API client for ECS. To construct a client, you need to configure a :region and :credentials.

client = Aws::ECS::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::ECS::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::ECS::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



451
452
453
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 451

def initialize(*args)
  super
end

Instance Method Details

#create_capacity_provider(params = {}) ⇒ Types::CreateCapacityProviderResponse

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.

Examples:

Request syntax with placeholder values


resp = client.create_capacity_provider({
  name: "String", # required
  auto_scaling_group_provider: { # required
    auto_scaling_group_arn: "String", # required
    managed_scaling: {
      status: "ENABLED", # accepts ENABLED, DISABLED
      target_capacity: 1,
      minimum_scaling_step_size: 1,
      maximum_scaling_step_size: 1,
      instance_warmup_period: 1,
    },
    managed_termination_protection: "ENABLED", # accepts ENABLED, DISABLED
    managed_draining: "ENABLED", # accepts ENABLED, DISABLED
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.capacity_provider.capacity_provider_arn #=> String
resp.capacity_provider.name #=> String
resp.capacity_provider.status #=> String, one of "ACTIVE", "INACTIVE"
resp.capacity_provider.auto_scaling_group_provider.auto_scaling_group_arn #=> String
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.status #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.target_capacity #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.minimum_scaling_step_size #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.maximum_scaling_step_size #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.instance_warmup_period #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_termination_protection #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.auto_scaling_group_provider.managed_draining #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.update_status #=> String, one of "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED"
resp.capacity_provider.update_status_reason #=> String
resp.capacity_provider.tags #=> Array
resp.capacity_provider.tags[0].key #=> String
resp.capacity_provider.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with "aws", "ecs", or "fargate".

  • :auto_scaling_group_provider (required, Types::AutoScalingGroupProvider) —

    The details of the Auto Scaling group for the capacity provider.

  • :tags (Array<Types::Tag>) —

    The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.

    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 Amazon Web Services 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.

Returns:

See Also:



556
557
558
559
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 556

def create_capacity_provider(params = {}, options = {})
  req = build_request(:create_capacity_provider, params)
  req.send_request(options)
end

#create_cluster(params = {}) ⇒ Types::CreateClusterResponse

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name.

When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Examples:

Example: To create a new cluster


# This example creates a cluster in your default region.

resp = client.create_cluster({
  cluster_name: "my_cluster", 
})

resp.to_h outputs the following:
{
  cluster: {
    active_services_count: 0, 
    cluster_arn: "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", 
    cluster_name: "my_cluster", 
    pending_tasks_count: 0, 
    registered_container_instances_count: 0, 
    running_tasks_count: 0, 
    status: "ACTIVE", 
  }, 
}

Request syntax with placeholder values


resp = client.create_cluster({
  cluster_name: "String",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  settings: [
    {
      name: "containerInsights", # accepts containerInsights
      value: "String",
    },
  ],
  configuration: {
    execute_command_configuration: {
      kms_key_id: "String",
      logging: "NONE", # accepts NONE, DEFAULT, OVERRIDE
      log_configuration: {
        cloud_watch_log_group_name: "String",
        cloud_watch_encryption_enabled: false,
        s3_bucket_name: "String",
        s3_encryption_enabled: false,
        s3_key_prefix: "String",
      },
    },
    managed_storage_configuration: {
      kms_key_id: "String",
      fargate_ephemeral_storage_kms_key_id: "String",
    },
  },
  capacity_providers: ["String"],
  default_capacity_provider_strategy: [
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
  service_connect_defaults: {
    namespace: "String", # required
  },
})

Response structure


resp.cluster.cluster_arn #=> String
resp.cluster.cluster_name #=> String
resp.cluster.configuration.execute_command_configuration.kms_key_id #=> String
resp.cluster.configuration.execute_command_configuration.logging #=> String, one of "NONE", "DEFAULT", "OVERRIDE"
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
resp.cluster.configuration.managed_storage_configuration.kms_key_id #=> String
resp.cluster.configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
resp.cluster.status #=> String
resp.cluster.registered_container_instances_count #=> Integer
resp.cluster.running_tasks_count #=> Integer
resp.cluster.pending_tasks_count #=> Integer
resp.cluster.active_services_count #=> Integer
resp.cluster.statistics #=> Array
resp.cluster.statistics[0].name #=> String
resp.cluster.statistics[0].value #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.settings #=> Array
resp.cluster.settings[0].name #=> String, one of "containerInsights"
resp.cluster.settings[0].value #=> String
resp.cluster.capacity_providers #=> Array
resp.cluster.capacity_providers[0] #=> String
resp.cluster.default_capacity_provider_strategy #=> Array
resp.cluster.default_capacity_provider_strategy[0].capacity_provider #=> String
resp.cluster.default_capacity_provider_strategy[0].weight #=> Integer
resp.cluster.default_capacity_provider_strategy[0].base #=> Integer
resp.cluster.attachments #=> Array
resp.cluster.attachments[0].id #=> String
resp.cluster.attachments[0].type #=> String
resp.cluster.attachments[0].status #=> String
resp.cluster.attachments[0].details #=> Array
resp.cluster.attachments[0].details[0].name #=> String
resp.cluster.attachments[0].details[0].value #=> String
resp.cluster.attachments_status #=> String
resp.cluster.service_connect_defaults.namespace #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_name (String) —

    The name of your cluster. If you don't specify a name for your cluster, you create a cluster that's named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

  • :tags (Array<Types::Tag>) —

    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. You define both.

    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 Amazon Web Services 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.

  • :settings (Array<Types::ClusterSetting>) —

    The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

  • :configuration (Types::ClusterConfiguration) —

    The execute command configuration for the cluster.

  • :capacity_providers (Array<String>) —

    The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.

    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

    To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

    The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

  • :default_capacity_provider_strategy (Array<Types::CapacityProviderStrategyItem>) —

    The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the CreateService or RunTask APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.

    If a default capacity provider strategy isn't defined for a cluster when it was created, it can be defined later with the PutClusterCapacityProviders API operation.

  • :service_connect_defaults (Types::ClusterServiceConnectDefaultsRequest) —

    Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

    Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Returns:

See Also:



817
818
819
820
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 817

def create_cluster(params = {}, options = {})
  req = build_request(:create_cluster, params)
  req.send_request(options)
end

#create_service(params = {}) ⇒ Types::CreateServiceResponse

Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, use UpdateService.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

Amazon Elastic Inference (EI) is no longer available to customers.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

There are two service scheduler strategies available:

  • REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

  • DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

If a service uses the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used. This is the case even if they're currently visible when describing your service.

When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide

Examples:

Example: To create a new service


# This example creates a service in your default region called ``ecs-simple-service``. The service uses the
# ``hello_world`` task definition and it maintains 10 copies of that task.

resp = client.create_service({
  desired_count: 10, 
  service_name: "ecs-simple-service", 
  task_definition: "hello_world", 
})

resp.to_h outputs the following:
{
  service: {
    cluster_arn: "arn:aws:ecs:us-east-1:012345678910:cluster/default", 
    created_at: Time.parse("2016-08-29T16:13:47.298Z"), 
    deployment_configuration: {
      maximum_percent: 200, 
      minimum_healthy_percent: 100, 
    }, 
    deployments: [
      {
        created_at: Time.parse("2016-08-29T16:13:47.298Z"), 
        desired_count: 10, 
        id: "ecs-svc/9223370564342348388", 
        pending_count: 0, 
        running_count: 0, 
        status: "PRIMARY", 
        task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", 
        updated_at: Time.parse("2016-08-29T16:13:47.298Z"), 
      }, 
      {
        created_at: Time.parse("2016-08-29T15:52:44.481Z"), 
        desired_count: 0, 
        id: "ecs-svc/9223370564343611322", 
        pending_count: 0, 
        running_count: 0, 
        status: "ACTIVE", 
        task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", 
        updated_at: Time.parse("2016-08-29T16:11:38.941Z"), 
      }, 
    ], 
    desired_count: 10, 
    events: [
    ], 
    load_balancers: [
    ], 
    pending_count: 0, 
    running_count: 0, 
    service_arn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service", 
    service_name: "ecs-simple-service", 
    status: "ACTIVE", 
    task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6", 
  }, 
}

Example: To create a new service behind a load balancer


# This example creates a service in your default region called ``ecs-simple-service-elb``. The service uses the
# ``ecs-demo`` task definition and it maintains 10 copies of that task. You must reference an existing load balancer in
# the same region by its name.

resp = client.create_service({
  desired_count: 10, 
  load_balancers: [
    {
      container_name: "simple-app", 
      container_port: 80, 
      load_balancer_name: "EC2Contai-EcsElast-15DCDAURT3ZO2", 
    }, 
  ], 
  role: "ecsServiceRole", 
  service_name: "ecs-simple-service-elb", 
  task_definition: "console-sample-app-static", 
})

resp.to_h outputs the following:
{
  service: {
    cluster_arn: "arn:aws:ecs:us-east-1:012345678910:cluster/default", 
    created_at: Time.parse("2016-08-29T16:02:54.884Z"), 
    deployment_configuration: {
      maximum_percent: 200, 
      minimum_healthy_percent: 100, 
    }, 
    deployments: [
      {
        created_at: Time.parse("2016-08-29T16:02:54.884Z"), 
        desired_count: 10, 
        id: "ecs-svc/9223370564343000923", 
        pending_count: 0, 
        running_count: 0, 
        status: "PRIMARY", 
        task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6", 
        updated_at: Time.parse("2016-08-29T16:02:54.884Z"), 
      }, 
    ], 
    desired_count: 10, 
    events: [
    ], 
    load_balancers: [
      {
        container_name: "simple-app", 
        container_port: 80, 
        load_balancer_name: "EC2Contai-EcsElast-15DCDAURT3ZO2", 
      }, 
    ], 
    pending_count: 0, 
    role_arn: "arn:aws:iam::012345678910:role/ecsServiceRole", 
    running_count: 0, 
    service_arn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service-elb", 
    service_name: "ecs-simple-service-elb", 
    status: "ACTIVE", 
    task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/console-sample-app-static:6", 
  }, 
}

Request syntax with placeholder values


resp = client.create_service({
  cluster: "String",
  service_name: "String", # required
  task_definition: "String",
  availability_zone_rebalancing: "ENABLED", # accepts ENABLED, DISABLED
  load_balancers: [
    {
      target_group_arn: "String",
      load_balancer_name: "String",
      container_name: "String",
      container_port: 1,
    },
  ],
  service_registries: [
    {
      registry_arn: "String",
      port: 1,
      container_name: "String",
      container_port: 1,
    },
  ],
  desired_count: 1,
  client_token: "String",
  launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
  capacity_provider_strategy: [
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
  platform_version: "String",
  role: "String",
  deployment_configuration: {
    deployment_circuit_breaker: {
      enable: false, # required
      rollback: false, # required
    },
    maximum_percent: 1,
    minimum_healthy_percent: 1,
    alarms: {
      alarm_names: ["String"], # required
      rollback: false, # required
      enable: false, # required
    },
  },
  placement_constraints: [
    {
      type: "distinctInstance", # accepts distinctInstance, memberOf
      expression: "String",
    },
  ],
  placement_strategy: [
    {
      type: "random", # accepts random, spread, binpack
      field: "String",
    },
  ],
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  health_check_grace_period_seconds: 1,
  scheduling_strategy: "REPLICA", # accepts REPLICA, DAEMON
  deployment_controller: {
    type: "ECS", # required, accepts ECS, CODE_DEPLOY, EXTERNAL
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  enable_ecs_managed_tags: false,
  propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
  enable_execute_command: false,
  service_connect_configuration: {
    enabled: false, # required
    namespace: "String",
    services: [
      {
        port_name: "String", # required
        discovery_name: "String",
        client_aliases: [
          {
            port: 1, # required
            dns_name: "String",
          },
        ],
        ingress_port_override: 1,
        timeout: {
          idle_timeout_seconds: 1,
          per_request_timeout_seconds: 1,
        },
        tls: {
          issuer_certificate_authority: { # required
            aws_pca_authority_arn: "String",
          },
          kms_key: "String",
          role_arn: "String",
        },
      },
    ],
    log_configuration: {
      log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk, awsfirelens
      options: {
        "String" => "String",
      },
      secret_options: [
        {
          name: "String", # required
          value_from: "String", # required
        },
      ],
    },
  },
  volume_configurations: [
    {
      name: "ECSVolumeName", # required
      managed_ebs_volume: {
        encrypted: false,
        kms_key_id: "EBSKMSKeyId",
        volume_type: "EBSVolumeType",
        size_in_gi_b: 1,
        snapshot_id: "EBSSnapshotId",
        iops: 1,
        throughput: 1,
        tag_specifications: [
          {
            resource_type: "volume", # required, accepts volume
            tags: [
              {
                key: "TagKey",
                value: "TagValue",
              },
            ],
            propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
          },
        ],
        role_arn: "IAMRoleArn", # required
        filesystem_type: "ext3", # accepts ext3, ext4, xfs, ntfs
      },
    },
  ],
  vpc_lattice_configurations: [
    {
      role_arn: "IAMRoleArn", # required
      target_group_arn: "String", # required
      port_name: "String", # required
    },
  ],
})

Response structure


resp.service.service_arn #=> String
resp.service.service_name #=> String
resp.service.cluster_arn #=> String
resp.service.load_balancers #=> Array
resp.service.load_balancers[0].target_group_arn #=> String
resp.service.load_balancers[0].load_balancer_name #=> String
resp.service.load_balancers[0].container_name #=> String
resp.service.load_balancers[0].container_port #=> Integer
resp.service.service_registries #=> Array
resp.service.service_registries[0].registry_arn #=> String
resp.service.service_registries[0].port #=> Integer
resp.service.service_registries[0].container_name #=> String
resp.service.service_registries[0].container_port #=> Integer
resp.service.status #=> String
resp.service.desired_count #=> Integer
resp.service.running_count #=> Integer
resp.service.pending_count #=> Integer
resp.service.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.capacity_provider_strategy #=> Array
resp.service.capacity_provider_strategy[0].capacity_provider #=> String
resp.service.capacity_provider_strategy[0].weight #=> Integer
resp.service.capacity_provider_strategy[0].base #=> Integer
resp.service.platform_version #=> String
resp.service.platform_family #=> String
resp.service.task_definition #=> String
resp.service.deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
resp.service.deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
resp.service.deployment_configuration.maximum_percent #=> Integer
resp.service.deployment_configuration.minimum_healthy_percent #=> Integer
resp.service.deployment_configuration.alarms.alarm_names #=> Array
resp.service.deployment_configuration.alarms.alarm_names[0] #=> String
resp.service.deployment_configuration.alarms.rollback #=> Boolean
resp.service.deployment_configuration.alarms.enable #=> Boolean
resp.service.task_sets #=> Array
resp.service.task_sets[0].id #=> String
resp.service.task_sets[0].task_set_arn #=> String
resp.service.task_sets[0].service_arn #=> String
resp.service.task_sets[0].cluster_arn #=> String
resp.service.task_sets[0].started_by #=> String
resp.service.task_sets[0].external_id #=> String
resp.service.task_sets[0].status #=> String
resp.service.task_sets[0].task_definition #=> String
resp.service.task_sets[0].computed_desired_count #=> Integer
resp.service.task_sets[0].pending_count #=> Integer
resp.service.task_sets[0].running_count #=> Integer
resp.service.task_sets[0].created_at #=> Time
resp.service.task_sets[0].updated_at #=> Time
resp.service.task_sets[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.task_sets[0].capacity_provider_strategy #=> Array
resp.service.task_sets[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.service.task_sets[0].capacity_provider_strategy[0].weight #=> Integer
resp.service.task_sets[0].capacity_provider_strategy[0].base #=> Integer
resp.service.task_sets[0].platform_version #=> String
resp.service.task_sets[0].platform_family #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.task_sets[0].load_balancers #=> Array
resp.service.task_sets[0].load_balancers[0].target_group_arn #=> String
resp.service.task_sets[0].load_balancers[0].load_balancer_name #=> String
resp.service.task_sets[0].load_balancers[0].container_name #=> String
resp.service.task_sets[0].load_balancers[0].container_port #=> Integer
resp.service.task_sets[0].service_registries #=> Array
resp.service.task_sets[0].service_registries[0].registry_arn #=> String
resp.service.task_sets[0].service_registries[0].port #=> Integer
resp.service.task_sets[0].service_registries[0].container_name #=> String
resp.service.task_sets[0].service_registries[0].container_port #=> Integer
resp.service.task_sets[0].scale.value #=> Float
resp.service.task_sets[0].scale.unit #=> String, one of "PERCENT"
resp.service.task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.service.task_sets[0].stability_status_at #=> Time
resp.service.task_sets[0].tags #=> Array
resp.service.task_sets[0].tags[0].key #=> String
resp.service.task_sets[0].tags[0].value #=> String
resp.service.task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.service.deployments #=> Array
resp.service.deployments[0].id #=> String
resp.service.deployments[0].status #=> String
resp.service.deployments[0].task_definition #=> String
resp.service.deployments[0].desired_count #=> Integer
resp.service.deployments[0].pending_count #=> Integer
resp.service.deployments[0].running_count #=> Integer
resp.service.deployments[0].failed_tasks #=> Integer
resp.service.deployments[0].created_at #=> Time
resp.service.deployments[0].updated_at #=> Time
resp.service.deployments[0].capacity_provider_strategy #=> Array
resp.service.deployments[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.service.deployments[0].capacity_provider_strategy[0].weight #=> Integer
resp.service.deployments[0].capacity_provider_strategy[0].base #=> Integer
resp.service.deployments[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.deployments[0].platform_version #=> String
resp.service.deployments[0].platform_family #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.deployments[0].rollout_state #=> String, one of "COMPLETED", "FAILED", "IN_PROGRESS"
resp.service.deployments[0].rollout_state_reason #=> String
resp.service.deployments[0].service_connect_configuration.enabled #=> Boolean
resp.service.deployments[0].service_connect_configuration.namespace #=> String
resp.service.deployments[0].service_connect_configuration.services #=> Array
resp.service.deployments[0].service_connect_configuration.services[0].port_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].discovery_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases #=> Array
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases[0].port #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases[0].dns_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].ingress_port_override #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].timeout.idle_timeout_seconds #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].timeout.per_request_timeout_seconds #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].tls.issuer_certificate_authority.aws_pca_authority_arn #=> String
resp.service.deployments[0].service_connect_configuration.services[0].tls.kms_key #=> String
resp.service.deployments[0].service_connect_configuration.services[0].tls.role_arn #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.service.deployments[0].service_connect_configuration.log_configuration.options #=> Hash
resp.service.deployments[0].service_connect_configuration.log_configuration.options["String"] #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options #=> Array
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options[0].name #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options[0].value_from #=> String
resp.service.deployments[0].service_connect_resources #=> Array
resp.service.deployments[0].service_connect_resources[0].discovery_name #=> String
resp.service.deployments[0].service_connect_resources[0].discovery_arn #=> String
resp.service.deployments[0].volume_configurations #=> Array
resp.service.deployments[0].volume_configurations[0].name #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.encrypted #=> Boolean
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.kms_key_id #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.volume_type #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.size_in_gi_b #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.snapshot_id #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.iops #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.throughput #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications #=> Array
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].resource_type #=> String, one of "volume"
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags #=> Array
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs", "ntfs"
resp.service.deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.service.deployments[0].vpc_lattice_configurations #=> Array
resp.service.deployments[0].vpc_lattice_configurations[0].role_arn #=> String
resp.service.deployments[0].vpc_lattice_configurations[0].target_group_arn #=> String
resp.service.deployments[0].vpc_lattice_configurations[0].port_name #=> String
resp.service.role_arn #=> String
resp.service.events #=> Array
resp.service.events[0].id #=> String
resp.service.events[0].created_at #=> Time
resp.service.events[0].message #=> String
resp.service.created_at #=> Time
resp.service.placement_constraints #=> Array
resp.service.placement_constraints[0].type #=> String, one of "distinctInstance", "memberOf"
resp.service.placement_constraints[0].expression #=> String
resp.service.placement_strategy #=> Array
resp.service.placement_strategy[0].type #=> String, one of "random", "spread", "binpack"
resp.service.placement_strategy[0].field #=> String
resp.service.network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.health_check_grace_period_seconds #=> Integer
resp.service.scheduling_strategy #=> String, one of "REPLICA", "DAEMON"
resp.service.deployment_controller.type #=> String, one of "ECS", "CODE_DEPLOY", "EXTERNAL"
resp.service.tags #=> Array
resp.service.tags[0].key #=> String
resp.service.tags[0].value #=> String
resp.service.created_by #=> String
resp.service.enable_ecs_managed_tags #=> Boolean
resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.service.enable_execute_command #=> Boolean
resp.service.availability_zone_rebalancing #=> String, one of "ENABLED", "DISABLED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.

  • :service_name (required, String) —

    The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

  • :task_definition (String) —

    The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn't specified, the latest ACTIVE revision is used.

    A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.

    For more information about deployment types, see Amazon ECS deployment types.

  • :availability_zone_rebalancing (String) —

    Indicates whether to use Availability Zone rebalancing for the service.

    For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide.

  • :load_balancers (Array<Types::LoadBalancer>) —

    A load balancer object representing the load balancers to use with your service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

    If the service uses the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

    If the service uses the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, CodeDeploy determines which task set in your service has the status PRIMARY, and it associates one target group with it. Then, it also associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that you can use to perform validation tests with Lambda functions before routing production traffic to it.

    If you use the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

    For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name, and the container port to access from the load balancer. The container name must be as it appears in a container definition. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group that's specified here.

    For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer that's specified here.

    Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren't supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. This is because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

  • :service_registries (Array<Types::ServiceRegistry>) —

    The details of the service discovery registry to associate with this service. For more information, see Service discovery.

    Each service may be associated with one service registry. Multiple service registries for each service isn't supported.

  • :desired_count (Integer) —

    The number of instantiations of the specified task definition to place and keep running in your service.

    This is required if schedulingStrategy is REPLICA or isn't specified. If schedulingStrategy is DAEMON then this isn't required.

  • :client_token (String) —

    An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

  • :launch_type (String) —

    The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

    The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

    Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.

    The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

    The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

    A service can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

  • :capacity_provider_strategy (Array<Types::CapacityProviderStrategyItem>) —

    The capacity provider strategy to use for the service.

    If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

    A capacity provider strategy may contain a maximum of 6 capacity providers.

  • :platform_version (String) —

    The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

  • :role (String) —

    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 your service and your task definition doesn't use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

    If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

    If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

  • :deployment_configuration (Types::DeploymentConfiguration) —

    Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

  • :placement_constraints (Array<Types::PlacementConstraint>) —

    An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

  • :placement_strategy (Array<Types::PlacementStrategy>) —

    The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.

  • :network_configuration (Types::NetworkConfiguration) —

    The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

  • :health_check_grace_period_seconds (Integer) —

    The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of 0 is used. If you don't use any of the health checks, then healthCheckGracePeriodSeconds is unused.

    If your service's tasks take a while to start and respond to health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

  • :scheduling_strategy (String) —

    The scheduling strategy to use for the service. For more information, see Services.

    There are two service scheduler strategies available:

    • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.

    • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

      Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.

  • :deployment_controller (Types::DeploymentController) —

    The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

  • :tags (Array<Types::Tag>) —

    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.

    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 Amazon Web Services 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.

  • :enable_ecs_managed_tags (Boolean) —

    Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide.

    When you use Amazon ECS managed tags, you need to set the propagateTags request parameter.

  • :propagate_tags (String) —

    Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

    You must set this to a value other than NONE when you use Cost Explorer. For more information, see Amazon ECS usage reports in the Amazon Elastic Container Service Developer Guide.

    The default is NONE.

  • :enable_execute_command (Boolean) —

    Determines whether the execute command functionality is turned on for the service. If true, this enables execute command functionality on all containers in the service tasks.

  • :service_connect_configuration (Types::ServiceConnectConfiguration) —

    The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

    Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

  • :volume_configurations (Array<Types::ServiceVolumeConfiguration>) —

    The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.

  • :vpc_lattice_configurations (Array<Types::VpcLatticeConfiguration>) —

    The VPC Lattice configuration for the service being created.

Returns:

See Also:



1780
1781
1782
1783
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 1780

def create_service(params = {}, options = {})
  req = build_request(:create_service, params)
  req.send_request(options)
end

#create_task_set(params = {}) ⇒ Types::CreateTaskSetResponse

Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

For information about the maximum number of task sets and other quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_task_set({
  service: "String", # required
  cluster: "String", # required
  external_id: "String",
  task_definition: "String", # required
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  load_balancers: [
    {
      target_group_arn: "String",
      load_balancer_name: "String",
      container_name: "String",
      container_port: 1,
    },
  ],
  service_registries: [
    {
      registry_arn: "String",
      port: 1,
      container_name: "String",
      container_port: 1,
    },
  ],
  launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
  capacity_provider_strategy: [
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
  platform_version: "String",
  scale: {
    value: 1.0,
    unit: "PERCENT", # accepts PERCENT
  },
  client_token: "String",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.task_set.id #=> String
resp.task_set.task_set_arn #=> String
resp.task_set.service_arn #=> String
resp.task_set.cluster_arn #=> String
resp.task_set.started_by #=> String
resp.task_set.external_id #=> String
resp.task_set.status #=> String
resp.task_set.task_definition #=> String
resp.task_set.computed_desired_count #=> Integer
resp.task_set.pending_count #=> Integer
resp.task_set.running_count #=> Integer
resp.task_set.created_at #=> Time
resp.task_set.updated_at #=> Time
resp.task_set.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_set.capacity_provider_strategy #=> Array
resp.task_set.capacity_provider_strategy[0].capacity_provider #=> String
resp.task_set.capacity_provider_strategy[0].weight #=> Integer
resp.task_set.capacity_provider_strategy[0].base #=> Integer
resp.task_set.platform_version #=> String
resp.task_set.platform_family #=> String
resp.task_set.network_configuration.awsvpc_configuration.subnets #=> Array
resp.task_set.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.task_set.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.task_set.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.task_set.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.task_set.load_balancers #=> Array
resp.task_set.load_balancers[0].target_group_arn #=> String
resp.task_set.load_balancers[0].load_balancer_name #=> String
resp.task_set.load_balancers[0].container_name #=> String
resp.task_set.load_balancers[0].container_port #=> Integer
resp.task_set.service_registries #=> Array
resp.task_set.service_registries[0].registry_arn #=> String
resp.task_set.service_registries[0].port #=> Integer
resp.task_set.service_registries[0].container_name #=> String
resp.task_set.service_registries[0].container_port #=> Integer
resp.task_set.scale.value #=> Float
resp.task_set.scale.unit #=> String, one of "PERCENT"
resp.task_set.stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.task_set.stability_status_at #=> Time
resp.task_set.tags #=> Array
resp.task_set.tags[0].key #=> String
resp.task_set.tags[0].value #=> String
resp.task_set.fargate_ephemeral_storage.kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service (required, String) —

    The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

  • :cluster (required, String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

  • :external_id (String) —

    An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided value.

  • :task_definition (required, String) —

    The task definition for the tasks in the task set to use. If a revision isn't specified, the latest ACTIVE revision is used.

  • :network_configuration (Types::NetworkConfiguration) —

    An object representing the network configuration for a task set.

  • :load_balancers (Array<Types::LoadBalancer>) —

    A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

  • :service_registries (Array<Types::ServiceRegistry>) —

    The details of the service discovery registries to assign to this task set. For more information, see Service discovery.

  • :launch_type (String) —

    The launch type that new tasks in the task set uses. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

    If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

  • :capacity_provider_strategy (Array<Types::CapacityProviderStrategyItem>) —

    The capacity provider strategy to use for the task set.

    A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

    If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProviderProviderAPI operation.

    To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

    The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

  • :platform_version (String) —

    The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used.

  • :scale (Types::Scale) —

    A floating-point percentage of the desired number of tasks to place and keep running in the task set.

  • :client_token (String) —

    An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

  • :tags (Array<Types::Tag>) —

    The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. When a service is deleted, the tags are deleted.

    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 Amazon Web Services 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.

Returns:

See Also:



2036
2037
2038
2039
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2036

def create_task_set(params = {}, options = {})
  req = build_request(:create_task_set, params)
  req.send_request(options)
end

#delete_account_setting(params = {}) ⇒ Types::DeleteAccountSettingResponse

Disables an account setting for a specified user, role, or the root user for an account.

Examples:

Example: To delete your account setting


# This example deletes the account setting for your user for the specified resource type.

resp = client.({
  name: "serviceLongArnFormat", 
})

resp.to_h outputs the following:
{
  setting: {
    name: "serviceLongArnFormat", 
    value: "enabled", 
    principal_arn: "arn:aws:iam::<aws_account_id>:user/principalName", 
  }, 
}

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.({
  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", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat, awsvpcTrunking, containerInsights, fargateFIPSMode, tagResourceAuthorization, fargateTaskRetirementWaitPeriod, guardDutyActivate
  principal_arn: "String",
})

Response structure


resp.setting.name #=> String, one of "serviceLongArnFormat", "taskLongArnFormat", "containerInstanceLongArnFormat", "awsvpcTrunking", "containerInsights", "fargateFIPSMode", "tagResourceAuthorization", "fargateTaskRetirementWaitPeriod", "guardDutyActivate"
resp.setting.value #=> String
resp.setting.principal_arn #=> String
resp.setting.type #=> String, one of "user", "aws_managed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The resource name to disable the account setting 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 is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.

  • :principal_arn (String) —

    The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

Returns:

See Also:



2121
2122
2123
2124
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2121

def (params = {}, options = {})
  req = build_request(:delete_account_setting, params)
  req.send_request(options)
end

#delete_attributes(params = {}) ⇒ Types::DeleteAttributesResponse

Deletes one or more custom attributes from an Amazon ECS resource.

Examples:

Request syntax with placeholder values


resp = client.delete_attributes({
  cluster: "String",
  attributes: [ # required
    {
      name: "String", # required
      value: "String",
      target_type: "container-instance", # accepts container-instance
      target_id: "String",
    },
  ],
})

Response structure


resp.attributes #=> Array
resp.attributes[0].name #=> String
resp.attributes[0].value #=> String
resp.attributes[0].target_type #=> String, one of "container-instance"
resp.attributes[0].target_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.

  • :attributes (required, Array<Types::Attribute>) —

    The attributes to delete from your resource. You can specify up to 10 attributes for each request. For custom attributes, specify the attribute name and target ID, but don't specify the value. If you specify the target ID using the short form, you must also specify the target type.

Returns:

See Also:



2170
2171
2172
2173
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2170

def delete_attributes(params = {}, options = {})
  req = build_request(:delete_attributes, params)
  req.send_request(options)
end

#delete_capacity_provider(params = {}) ⇒ Types::DeleteCapacityProviderResponse

Deletes the specified capacity provider.

The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either PutCapacityProviderProviders or by deleting the cluster.

Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

Examples:

Request syntax with placeholder values


resp = client.delete_capacity_provider({
  capacity_provider: "String", # required
})

Response structure


resp.capacity_provider.capacity_provider_arn #=> String
resp.capacity_provider.name #=> String
resp.capacity_provider.status #=> String, one of "ACTIVE", "INACTIVE"
resp.capacity_provider.auto_scaling_group_provider.auto_scaling_group_arn #=> String
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.status #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.target_capacity #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.minimum_scaling_step_size #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.maximum_scaling_step_size #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.instance_warmup_period #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_termination_protection #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.auto_scaling_group_provider.managed_draining #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.update_status #=> String, one of "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED"
resp.capacity_provider.update_status_reason #=> String
resp.capacity_provider.tags #=> Array
resp.capacity_provider.tags[0].key #=> String
resp.capacity_provider.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity_provider (required, String) —

    The short name or full Amazon Resource Name (ARN) of the capacity provider to delete.

Returns:

See Also:



2238
2239
2240
2241
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2238

def delete_capacity_provider(params = {}, options = {})
  req = build_request(:delete_capacity_provider, params)
  req.send_request(options)
end

#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse

Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

Examples:

Example: To delete an empty cluster


# This example deletes an empty cluster in your default region.

resp = client.delete_cluster({
  cluster: "my_cluster", 
})

resp.to_h outputs the following:
{
  cluster: {
    active_services_count: 0, 
    cluster_arn: "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", 
    cluster_name: "my_cluster", 
    pending_tasks_count: 0, 
    registered_container_instances_count: 0, 
    running_tasks_count: 0, 
    status: "INACTIVE", 
  }, 
}

Request syntax with placeholder values


resp = client.delete_cluster({
  cluster: "String", # required
})

Response structure


resp.cluster.cluster_arn #=> String
resp.cluster.cluster_name #=> String
resp.cluster.configuration.execute_command_configuration.kms_key_id #=> String
resp.cluster.configuration.execute_command_configuration.logging #=> String, one of "NONE", "DEFAULT", "OVERRIDE"
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
resp.cluster.configuration.managed_storage_configuration.kms_key_id #=> String
resp.cluster.configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
resp.cluster.status #=> String
resp.cluster.registered_container_instances_count #=> Integer
resp.cluster.running_tasks_count #=> Integer
resp.cluster.pending_tasks_count #=> Integer
resp.cluster.active_services_count #=> Integer
resp.cluster.statistics #=> Array
resp.cluster.statistics[0].name #=> String
resp.cluster.statistics[0].value #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.settings #=> Array
resp.cluster.settings[0].name #=> String, one of "containerInsights"
resp.cluster.settings[0].value #=> String
resp.cluster.capacity_providers #=> Array
resp.cluster.capacity_providers[0] #=> String
resp.cluster.default_capacity_provider_strategy #=> Array
resp.cluster.default_capacity_provider_strategy[0].capacity_provider #=> String
resp.cluster.default_capacity_provider_strategy[0].weight #=> Integer
resp.cluster.default_capacity_provider_strategy[0].base #=> Integer
resp.cluster.attachments #=> Array
resp.cluster.attachments[0].id #=> String
resp.cluster.attachments[0].type #=> String
resp.cluster.attachments[0].status #=> String
resp.cluster.attachments[0].details #=> Array
resp.cluster.attachments[0].details[0].name #=> String
resp.cluster.attachments[0].details[0].value #=> String
resp.cluster.attachments_status #=> String
resp.cluster.service_connect_defaults.namespace #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (required, String) —

    The short name or full Amazon Resource Name (ARN) of the cluster to delete.

Returns:

See Also:



2342
2343
2344
2345
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2342

def delete_cluster(params = {}, options = {})
  req = build_request(:delete_cluster, params)
  req.send_request(options)
end

#delete_service(params = {}) ⇒ Types::DeleteServiceResponse

Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you can't delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.

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 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.

If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.

Examples:

Example: To delete a service


# This example deletes the my-http-service service. The service must have a desired count and running count of 0 before
# you can delete it.

resp = client.delete_service({
  service: "my-http-service", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_service({
  cluster: "String",
  service: "String", # required
  force: false,
})

Response structure


resp.service.service_arn #=> String
resp.service.service_name #=> String
resp.service.cluster_arn #=> String
resp.service.load_balancers #=> Array
resp.service.load_balancers[0].target_group_arn #=> String
resp.service.load_balancers[0].load_balancer_name #=> String
resp.service.load_balancers[0].container_name #=> String
resp.service.load_balancers[0].container_port #=> Integer
resp.service.service_registries #=> Array
resp.service.service_registries[0].registry_arn #=> String
resp.service.service_registries[0].port #=> Integer
resp.service.service_registries[0].container_name #=> String
resp.service.service_registries[0].container_port #=> Integer
resp.service.status #=> String
resp.service.desired_count #=> Integer
resp.service.running_count #=> Integer
resp.service.pending_count #=> Integer
resp.service.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.capacity_provider_strategy #=> Array
resp.service.capacity_provider_strategy[0].capacity_provider #=> String
resp.service.capacity_provider_strategy[0].weight #=> Integer
resp.service.capacity_provider_strategy[0].base #=> Integer
resp.service.platform_version #=> String
resp.service.platform_family #=> String
resp.service.task_definition #=> String
resp.service.deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
resp.service.deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
resp.service.deployment_configuration.maximum_percent #=> Integer
resp.service.deployment_configuration.minimum_healthy_percent #=> Integer
resp.service.deployment_configuration.alarms.alarm_names #=> Array
resp.service.deployment_configuration.alarms.alarm_names[0] #=> String
resp.service.deployment_configuration.alarms.rollback #=> Boolean
resp.service.deployment_configuration.alarms.enable #=> Boolean
resp.service.task_sets #=> Array
resp.service.task_sets[0].id #=> String
resp.service.task_sets[0].task_set_arn #=> String
resp.service.task_sets[0].service_arn #=> String
resp.service.task_sets[0].cluster_arn #=> String
resp.service.task_sets[0].started_by #=> String
resp.service.task_sets[0].external_id #=> String
resp.service.task_sets[0].status #=> String
resp.service.task_sets[0].task_definition #=> String
resp.service.task_sets[0].computed_desired_count #=> Integer
resp.service.task_sets[0].pending_count #=> Integer
resp.service.task_sets[0].running_count #=> Integer
resp.service.task_sets[0].created_at #=> Time
resp.service.task_sets[0].updated_at #=> Time
resp.service.task_sets[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.task_sets[0].capacity_provider_strategy #=> Array
resp.service.task_sets[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.service.task_sets[0].capacity_provider_strategy[0].weight #=> Integer
resp.service.task_sets[0].capacity_provider_strategy[0].base #=> Integer
resp.service.task_sets[0].platform_version #=> String
resp.service.task_sets[0].platform_family #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.task_sets[0].load_balancers #=> Array
resp.service.task_sets[0].load_balancers[0].target_group_arn #=> String
resp.service.task_sets[0].load_balancers[0].load_balancer_name #=> String
resp.service.task_sets[0].load_balancers[0].container_name #=> String
resp.service.task_sets[0].load_balancers[0].container_port #=> Integer
resp.service.task_sets[0].service_registries #=> Array
resp.service.task_sets[0].service_registries[0].registry_arn #=> String
resp.service.task_sets[0].service_registries[0].port #=> Integer
resp.service.task_sets[0].service_registries[0].container_name #=> String
resp.service.task_sets[0].service_registries[0].container_port #=> Integer
resp.service.task_sets[0].scale.value #=> Float
resp.service.task_sets[0].scale.unit #=> String, one of "PERCENT"
resp.service.task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.service.task_sets[0].stability_status_at #=> Time
resp.service.task_sets[0].tags #=> Array
resp.service.task_sets[0].tags[0].key #=> String
resp.service.task_sets[0].tags[0].value #=> String
resp.service.task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.service.deployments #=> Array
resp.service.deployments[0].id #=> String
resp.service.deployments[0].status #=> String
resp.service.deployments[0].task_definition #=> String
resp.service.deployments[0].desired_count #=> Integer
resp.service.deployments[0].pending_count #=> Integer
resp.service.deployments[0].running_count #=> Integer
resp.service.deployments[0].failed_tasks #=> Integer
resp.service.deployments[0].created_at #=> Time
resp.service.deployments[0].updated_at #=> Time
resp.service.deployments[0].capacity_provider_strategy #=> Array
resp.service.deployments[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.service.deployments[0].capacity_provider_strategy[0].weight #=> Integer
resp.service.deployments[0].capacity_provider_strategy[0].base #=> Integer
resp.service.deployments[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.deployments[0].platform_version #=> String
resp.service.deployments[0].platform_family #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.deployments[0].rollout_state #=> String, one of "COMPLETED", "FAILED", "IN_PROGRESS"
resp.service.deployments[0].rollout_state_reason #=> String
resp.service.deployments[0].service_connect_configuration.enabled #=> Boolean
resp.service.deployments[0].service_connect_configuration.namespace #=> String
resp.service.deployments[0].service_connect_configuration.services #=> Array
resp.service.deployments[0].service_connect_configuration.services[0].port_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].discovery_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases #=> Array
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases[0].port #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases[0].dns_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].ingress_port_override #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].timeout.idle_timeout_seconds #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].timeout.per_request_timeout_seconds #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].tls.issuer_certificate_authority.aws_pca_authority_arn #=> String
resp.service.deployments[0].service_connect_configuration.services[0].tls.kms_key #=> String
resp.service.deployments[0].service_connect_configuration.services[0].tls.role_arn #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.service.deployments[0].service_connect_configuration.log_configuration.options #=> Hash
resp.service.deployments[0].service_connect_configuration.log_configuration.options["String"] #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options #=> Array
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options[0].name #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options[0].value_from #=> String
resp.service.deployments[0].service_connect_resources #=> Array
resp.service.deployments[0].service_connect_resources[0].discovery_name #=> String
resp.service.deployments[0].service_connect_resources[0].discovery_arn #=> String
resp.service.deployments[0].volume_configurations #=> Array
resp.service.deployments[0].volume_configurations[0].name #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.encrypted #=> Boolean
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.kms_key_id #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.volume_type #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.size_in_gi_b #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.snapshot_id #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.iops #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.throughput #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications #=> Array
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].resource_type #=> String, one of "volume"
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags #=> Array
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs", "ntfs"
resp.service.deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.service.deployments[0].vpc_lattice_configurations #=> Array
resp.service.deployments[0].vpc_lattice_configurations[0].role_arn #=> String
resp.service.deployments[0].vpc_lattice_configurations[0].target_group_arn #=> String
resp.service.deployments[0].vpc_lattice_configurations[0].port_name #=> String
resp.service.role_arn #=> String
resp.service.events #=> Array
resp.service.events[0].id #=> String
resp.service.events[0].created_at #=> Time
resp.service.events[0].message #=> String
resp.service.created_at #=> Time
resp.service.placement_constraints #=> Array
resp.service.placement_constraints[0].type #=> String, one of "distinctInstance", "memberOf"
resp.service.placement_constraints[0].expression #=> String
resp.service.placement_strategy #=> Array
resp.service.placement_strategy[0].type #=> String, one of "random", "spread", "binpack"
resp.service.placement_strategy[0].field #=> String
resp.service.network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.health_check_grace_period_seconds #=> Integer
resp.service.scheduling_strategy #=> String, one of "REPLICA", "DAEMON"
resp.service.deployment_controller.type #=> String, one of "ECS", "CODE_DEPLOY", "EXTERNAL"
resp.service.tags #=> Array
resp.service.tags[0].key #=> String
resp.service.tags[0].value #=> String
resp.service.created_by #=> String
resp.service.enable_ecs_managed_tags #=> Boolean
resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.service.enable_execute_command #=> Boolean
resp.service.availability_zone_rebalancing #=> String, one of "ENABLED", "DISABLED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

  • :service (required, String) —

    The name of the service to delete.

  • :force (Boolean) —

    If true, allows you to delete a service even if it wasn't scaled down to zero tasks. It's only necessary to use this if the service uses the REPLICA scheduling strategy.

Returns:

See Also:



2597
2598
2599
2600
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2597

def delete_service(params = {}, options = {})
  req = build_request(:delete_service, params)
  req.send_request(options)
end

#delete_task_definitions(params = {}) ⇒ Types::DeleteTaskDefinitionsResponse

Deletes one or more task definitions.

You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.

When you delete a task definition revision, it is immediately transitions from the INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that reference a DELETE_IN_PROGRESS task definition revision continue to run without disruption. Existing services that reference a DELETE_IN_PROGRESS task definition revision can still scale up or down by modifying the service's desired count.

You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks or create new services. You also can't update an existing service to reference a DELETE_IN_PROGRESS task definition revision.

A task definition revision will stay in DELETE_IN_PROGRESS status until all the associated tasks and services have been terminated.

When you delete all INACTIVE task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the DELETE_IN_PROGRESS state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.

Examples:

Request syntax with placeholder values


resp = client.delete_task_definitions({
  task_definitions: ["String"], # required
})

Response structure


resp.task_definitions #=> Array
resp.task_definitions[0].task_definition_arn #=> String
resp.task_definitions[0].container_definitions #=> Array
resp.task_definitions[0].container_definitions[0].name #=> String
resp.task_definitions[0].container_definitions[0].image #=> String
resp.task_definitions[0].container_definitions[0].repository_credentials.credentials_parameter #=> String
resp.task_definitions[0].container_definitions[0].cpu #=> Integer
resp.task_definitions[0].container_definitions[0].memory #=> Integer
resp.task_definitions[0].container_definitions[0].memory_reservation #=> Integer
resp.task_definitions[0].container_definitions[0].links #=> Array
resp.task_definitions[0].container_definitions[0].links[0] #=> String
resp.task_definitions[0].container_definitions[0].port_mappings #=> Array
resp.task_definitions[0].container_definitions[0].port_mappings[0].container_port #=> Integer
resp.task_definitions[0].container_definitions[0].port_mappings[0].host_port #=> Integer
resp.task_definitions[0].container_definitions[0].port_mappings[0].protocol #=> String, one of "tcp", "udp"
resp.task_definitions[0].container_definitions[0].port_mappings[0].name #=> String
resp.task_definitions[0].container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
resp.task_definitions[0].container_definitions[0].port_mappings[0].container_port_range #=> String
resp.task_definitions[0].container_definitions[0].essential #=> Boolean
resp.task_definitions[0].container_definitions[0].restart_policy.enabled #=> Boolean
resp.task_definitions[0].container_definitions[0].restart_policy.ignored_exit_codes #=> Array
resp.task_definitions[0].container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
resp.task_definitions[0].container_definitions[0].restart_policy.restart_attempt_period #=> Integer
resp.task_definitions[0].container_definitions[0].entry_point #=> Array
resp.task_definitions[0].container_definitions[0].entry_point[0] #=> String
resp.task_definitions[0].container_definitions[0].command #=> Array
resp.task_definitions[0].container_definitions[0].command[0] #=> String
resp.task_definitions[0].container_definitions[0].environment #=> Array
resp.task_definitions[0].container_definitions[0].environment[0].name #=> String
resp.task_definitions[0].container_definitions[0].environment[0].value #=> String
resp.task_definitions[0].container_definitions[0].environment_files #=> Array
resp.task_definitions[0].container_definitions[0].environment_files[0].value #=> String
resp.task_definitions[0].container_definitions[0].environment_files[0].type #=> String, one of "s3"
resp.task_definitions[0].container_definitions[0].mount_points #=> Array
resp.task_definitions[0].container_definitions[0].mount_points[0].source_volume #=> String
resp.task_definitions[0].container_definitions[0].mount_points[0].container_path #=> String
resp.task_definitions[0].container_definitions[0].mount_points[0].read_only #=> Boolean
resp.task_definitions[0].container_definitions[0].volumes_from #=> Array
resp.task_definitions[0].container_definitions[0].volumes_from[0].source_container #=> String
resp.task_definitions[0].container_definitions[0].volumes_from[0].read_only #=> Boolean
resp.task_definitions[0].container_definitions[0].linux_parameters.capabilities.add #=> Array
resp.task_definitions[0].container_definitions[0].linux_parameters.capabilities.add[0] #=> String
resp.task_definitions[0].container_definitions[0].linux_parameters.capabilities.drop #=> Array
resp.task_definitions[0].container_definitions[0].linux_parameters.capabilities.drop[0] #=> String
resp.task_definitions[0].container_definitions[0].linux_parameters.devices #=> Array
resp.task_definitions[0].container_definitions[0].linux_parameters.devices[0].host_path #=> String
resp.task_definitions[0].container_definitions[0].linux_parameters.devices[0].container_path #=> String
resp.task_definitions[0].container_definitions[0].linux_parameters.devices[0].permissions #=> Array
resp.task_definitions[0].container_definitions[0].linux_parameters.devices[0].permissions[0] #=> String, one of "read", "write", "mknod"
resp.task_definitions[0].container_definitions[0].linux_parameters.init_process_enabled #=> Boolean
resp.task_definitions[0].container_definitions[0].linux_parameters.shared_memory_size #=> Integer
resp.task_definitions[0].container_definitions[0].linux_parameters.tmpfs #=> Array
resp.task_definitions[0].container_definitions[0].linux_parameters.tmpfs[0].container_path #=> String
resp.task_definitions[0].container_definitions[0].linux_parameters.tmpfs[0].size #=> Integer
resp.task_definitions[0].container_definitions[0].linux_parameters.tmpfs[0].mount_options #=> Array
resp.task_definitions[0].container_definitions[0].linux_parameters.tmpfs[0].mount_options[0] #=> String
resp.task_definitions[0].container_definitions[0].linux_parameters.max_swap #=> Integer
resp.task_definitions[0].container_definitions[0].linux_parameters.swappiness #=> Integer
resp.task_definitions[0].container_definitions[0].secrets #=> Array
resp.task_definitions[0].container_definitions[0].secrets[0].name #=> String
resp.task_definitions[0].container_definitions[0].secrets[0].value_from #=> String
resp.task_definitions[0].container_definitions[0].depends_on #=> Array
resp.task_definitions[0].container_definitions[0].depends_on[0].container_name #=> String
resp.task_definitions[0].container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
resp.task_definitions[0].container_definitions[0].start_timeout #=> Integer
resp.task_definitions[0].container_definitions[0].stop_timeout #=> Integer
resp.task_definitions[0].container_definitions[0].version_consistency #=> String, one of "enabled", "disabled"
resp.task_definitions[0].container_definitions[0].hostname #=> String
resp.task_definitions[0].container_definitions[0].user #=> String
resp.task_definitions[0].container_definitions[0].working_directory #=> String
resp.task_definitions[0].container_definitions[0].disable_networking #=> Boolean
resp.task_definitions[0].container_definitions[0].privileged #=> Boolean
resp.task_definitions[0].container_definitions[0].readonly_root_filesystem #=> Boolean
resp.task_definitions[0].container_definitions[0].dns_servers #=> Array
resp.task_definitions[0].container_definitions[0].dns_servers[0] #=> String
resp.task_definitions[0].container_definitions[0].dns_search_domains #=> Array
resp.task_definitions[0].container_definitions[0].dns_search_domains[0] #=> String
resp.task_definitions[0].container_definitions[0].extra_hosts #=> Array
resp.task_definitions[0].container_definitions[0].extra_hosts[0].hostname #=> String
resp.task_definitions[0].container_definitions[0].extra_hosts[0].ip_address #=> String
resp.task_definitions[0].container_definitions[0].docker_security_options #=> Array
resp.task_definitions[0].container_definitions[0].docker_security_options[0] #=> String
resp.task_definitions[0].container_definitions[0].interactive #=> Boolean
resp.task_definitions[0].container_definitions[0].pseudo_terminal #=> Boolean
resp.task_definitions[0].container_definitions[0].docker_labels #=> Hash
resp.task_definitions[0].container_definitions[0].docker_labels["String"] #=> String
resp.task_definitions[0].container_definitions[0].ulimits #=> Array
resp.task_definitions[0].container_definitions[0].ulimits[0].name #=> String, one of "core", "cpu", "data", "fsize", "locks", "memlock", "msgqueue", "nice", "nofile", "nproc", "rss", "rtprio", "rttime", "sigpending", "stack"
resp.task_definitions[0].container_definitions[0].ulimits[0].soft_limit #=> Integer
resp.task_definitions[0].container_definitions[0].ulimits[0].hard_limit #=> Integer
resp.task_definitions[0].container_definitions[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.task_definitions[0].container_definitions[0].log_configuration.options #=> Hash
resp.task_definitions[0].container_definitions[0].log_configuration.options["String"] #=> String
resp.task_definitions[0].container_definitions[0].log_configuration.secret_options #=> Array
resp.task_definitions[0].container_definitions[0].log_configuration.secret_options[0].name #=> String
resp.task_definitions[0].container_definitions[0].log_configuration.secret_options[0].value_from #=> String
resp.task_definitions[0].container_definitions[0].health_check.command #=> Array
resp.task_definitions[0].container_definitions[0].health_check.command[0] #=> String
resp.task_definitions[0].container_definitions[0].health_check.interval #=> Integer
resp.task_definitions[0].container_definitions[0].health_check.timeout #=> Integer
resp.task_definitions[0].container_definitions[0].health_check.retries #=> Integer
resp.task_definitions[0].container_definitions[0].health_check.start_period #=> Integer
resp.task_definitions[0].container_definitions[0].system_controls #=> Array
resp.task_definitions[0].container_definitions[0].system_controls[0].namespace #=> String
resp.task_definitions[0].container_definitions[0].system_controls[0].value #=> String
resp.task_definitions[0].container_definitions[0].resource_requirements #=> Array
resp.task_definitions[0].container_definitions[0].resource_requirements[0].value #=> String
resp.task_definitions[0].container_definitions[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
resp.task_definitions[0].container_definitions[0].firelens_configuration.type #=> String, one of "fluentd", "fluentbit"
resp.task_definitions[0].container_definitions[0].firelens_configuration.options #=> Hash
resp.task_definitions[0].container_definitions[0].firelens_configuration.options["String"] #=> String
resp.task_definitions[0].container_definitions[0].credential_specs #=> Array
resp.task_definitions[0].container_definitions[0].credential_specs[0] #=> String
resp.task_definitions[0].family #=> String
resp.task_definitions[0].task_role_arn #=> String
resp.task_definitions[0].execution_role_arn #=> String
resp.task_definitions[0].network_mode #=> String, one of "bridge", "host", "awsvpc", "none"
resp.task_definitions[0].revision #=> Integer
resp.task_definitions[0].volumes #=> Array
resp.task_definitions[0].volumes[0].name #=> String
resp.task_definitions[0].volumes[0].host.source_path #=> String
resp.task_definitions[0].volumes[0].docker_volume_configuration.scope #=> String, one of "task", "shared"
resp.task_definitions[0].volumes[0].docker_volume_configuration.autoprovision #=> Boolean
resp.task_definitions[0].volumes[0].docker_volume_configuration.driver #=> String
resp.task_definitions[0].volumes[0].docker_volume_configuration.driver_opts #=> Hash
resp.task_definitions[0].volumes[0].docker_volume_configuration.driver_opts["String"] #=> String
resp.task_definitions[0].volumes[0].docker_volume_configuration.labels #=> Hash
resp.task_definitions[0].volumes[0].docker_volume_configuration.labels["String"] #=> String
resp.task_definitions[0].volumes[0].efs_volume_configuration.file_system_id #=> String
resp.task_definitions[0].volumes[0].efs_volume_configuration.root_directory #=> String
resp.task_definitions[0].volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
resp.task_definitions[0].volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
resp.task_definitions[0].volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
resp.task_definitions[0].volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
resp.task_definitions[0].volumes[0].fsx_windows_file_server_volume_configuration.file_system_id #=> String
resp.task_definitions[0].volumes[0].fsx_windows_file_server_volume_configuration.root_directory #=> String
resp.task_definitions[0].volumes[0].fsx_windows_file_server_volume_configuration.authorization_config.credentials_parameter #=> String
resp.task_definitions[0].volumes[0].fsx_windows_file_server_volume_configuration.authorization_config.domain #=> String
resp.task_definitions[0].volumes[0].configured_at_launch #=> Boolean
resp.task_definitions[0].status #=> String, one of "ACTIVE", "INACTIVE", "DELETE_IN_PROGRESS"
resp.task_definitions[0].requires_attributes #=> Array
resp.task_definitions[0].requires_attributes[0].name #=> String
resp.task_definitions[0].requires_attributes[0].value #=> String
resp.task_definitions[0].requires_attributes[0].target_type #=> String, one of "container-instance"
resp.task_definitions[0].requires_attributes[0].target_id #=> String
resp.task_definitions[0].placement_constraints #=> Array
resp.task_definitions[0].placement_constraints[0].type #=> String, one of "memberOf"
resp.task_definitions[0].placement_constraints[0].expression #=> String
resp.task_definitions[0].compatibilities #=> Array
resp.task_definitions[0].compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_definitions[0].runtime_platform.cpu_architecture #=> String, one of "X86_64", "ARM64"
resp.task_definitions[0].runtime_platform.operating_system_family #=> String, one of "WINDOWS_SERVER_2019_FULL", "WINDOWS_SERVER_2019_CORE", "WINDOWS_SERVER_2016_FULL", "WINDOWS_SERVER_2004_CORE", "WINDOWS_SERVER_2022_CORE", "WINDOWS_SERVER_2022_FULL", "WINDOWS_SERVER_20H2_CORE", "LINUX"
resp.task_definitions[0].requires_compatibilities #=> Array
resp.task_definitions[0].requires_compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_definitions[0].cpu #=> String
resp.task_definitions[0].memory #=> String
resp.task_definitions[0].inference_accelerators #=> Array
resp.task_definitions[0].inference_accelerators[0].device_name #=> String
resp.task_definitions[0].inference_accelerators[0].device_type #=> String
resp.task_definitions[0].pid_mode #=> String, one of "host", "task"
resp.task_definitions[0].ipc_mode #=> String, one of "host", "task", "none"
resp.task_definitions[0].proxy_configuration.type #=> String, one of "APPMESH"
resp.task_definitions[0].proxy_configuration.container_name #=> String
resp.task_definitions[0].proxy_configuration.properties #=> Array
resp.task_definitions[0].proxy_configuration.properties[0].name #=> String
resp.task_definitions[0].proxy_configuration.properties[0].value #=> String
resp.task_definitions[0].registered_at #=> Time
resp.task_definitions[0].deregistered_at #=> Time
resp.task_definitions[0].registered_by #=> String
resp.task_definitions[0].ephemeral_storage.size_in_gi_b #=> Integer
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_definitions (required, Array<String>) —

    The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to delete. You must specify a revision.

    You can specify up to 10 task definitions as a comma separated list.

Returns:

See Also:



2833
2834
2835
2836
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2833

def delete_task_definitions(params = {}, options = {})
  req = build_request(:delete_task_definitions, params)
  req.send_request(options)
end

#delete_task_set(params = {}) ⇒ Types::DeleteTaskSetResponse

Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_task_set({
  cluster: "String", # required
  service: "String", # required
  task_set: "String", # required
  force: false,
})

Response structure


resp.task_set.id #=> String
resp.task_set.task_set_arn #=> String
resp.task_set.service_arn #=> String
resp.task_set.cluster_arn #=> String
resp.task_set.started_by #=> String
resp.task_set.external_id #=> String
resp.task_set.status #=> String
resp.task_set.task_definition #=> String
resp.task_set.computed_desired_count #=> Integer
resp.task_set.pending_count #=> Integer
resp.task_set.running_count #=> Integer
resp.task_set.created_at #=> Time
resp.task_set.updated_at #=> Time
resp.task_set.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_set.capacity_provider_strategy #=> Array
resp.task_set.capacity_provider_strategy[0].capacity_provider #=> String
resp.task_set.capacity_provider_strategy[0].weight #=> Integer
resp.task_set.capacity_provider_strategy[0].base #=> Integer
resp.task_set.platform_version #=> String
resp.task_set.platform_family #=> String
resp.task_set.network_configuration.awsvpc_configuration.subnets #=> Array
resp.task_set.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.task_set.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.task_set.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.task_set.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.task_set.load_balancers #=> Array
resp.task_set.load_balancers[0].target_group_arn #=> String
resp.task_set.load_balancers[0].load_balancer_name #=> String
resp.task_set.load_balancers[0].container_name #=> String
resp.task_set.load_balancers[0].container_port #=> Integer
resp.task_set.service_registries #=> Array
resp.task_set.service_registries[0].registry_arn #=> String
resp.task_set.service_registries[0].port #=> Integer
resp.task_set.service_registries[0].container_name #=> String
resp.task_set.service_registries[0].container_port #=> Integer
resp.task_set.scale.value #=> Float
resp.task_set.scale.unit #=> String, one of "PERCENT"
resp.task_set.stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.task_set.stability_status_at #=> Time
resp.task_set.tags #=> Array
resp.task_set.tags[0].key #=> String
resp.task_set.tags[0].value #=> String
resp.task_set.fargate_ephemeral_storage.kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (required, String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set found in to delete.

  • :service (required, String) —

    The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.

  • :task_set (required, String) —

    The task set ID or full Amazon Resource Name (ARN) of the task set to delete.

  • :force (Boolean) —

    If true, you can delete a task set even if it hasn't been scaled down to zero.

Returns:

See Also:



2926
2927
2928
2929
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2926

def delete_task_set(params = {}, options = {})
  req = build_request(:delete_task_set, params)
  req.send_request(options)
end

#deregister_container_instance(params = {}) ⇒ Types::DeregisterContainerInstanceResponse

Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.

If you intend to use the container instance for some other purpose after deregistration, we recommend that you stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents aren't automatically deregistered when terminated).

Examples:

Example: To deregister a container instance from a cluster


# This example deregisters a container instance from the specified cluster in your default region. If there are still
# tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option.

resp = client.deregister_container_instance({
  cluster: "default", 
  container_instance: "container_instance_UUID", 
  force: true, 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.deregister_container_instance({
  cluster: "String",
  container_instance: "String", # required
  force: false,
})

Response structure


resp.container_instance.container_instance_arn #=> String
resp.container_instance.ec2_instance_id #=> String
resp.container_instance.capacity_provider_name #=> String
resp.container_instance.version #=> Integer
resp.container_instance.version_info.agent_version #=> String
resp.container_instance.version_info.agent_hash #=> String
resp.container_instance.version_info.docker_version #=> String
resp.container_instance.remaining_resources #=> Array
resp.container_instance.remaining_resources[0].name #=> String
resp.container_instance.remaining_resources[0].type #=> String
resp.container_instance.remaining_resources[0].double_value #=> Float
resp.container_instance.remaining_resources[0].long_value #=> Integer
resp.container_instance.remaining_resources[0].integer_value #=> Integer
resp.container_instance.remaining_resources[0].string_set_value #=> Array
resp.container_instance.remaining_resources[0].string_set_value[0] #=> String
resp.container_instance.registered_resources #=> Array
resp.container_instance.registered_resources[0].name #=> String
resp.container_instance.registered_resources[0].type #=> String
resp.container_instance.registered_resources[0].double_value #=> Float
resp.container_instance.registered_resources[0].long_value #=> Integer
resp.container_instance.registered_resources[0].integer_value #=> Integer
resp.container_instance.registered_resources[0].string_set_value #=> Array
resp.container_instance.registered_resources[0].string_set_value[0] #=> String
resp.container_instance.status #=> String
resp.container_instance.status_reason #=> String
resp.container_instance.agent_connected #=> Boolean
resp.container_instance.running_tasks_count #=> Integer
resp.container_instance.pending_tasks_count #=> Integer
resp.container_instance.agent_update_status #=> String, one of "PENDING", "STAGING", "STAGED", "UPDATING", "UPDATED", "FAILED"
resp.container_instance.attributes #=> Array
resp.container_instance.attributes[0].name #=> String
resp.container_instance.attributes[0].value #=> String
resp.container_instance.attributes[0].target_type #=> String, one of "container-instance"
resp.container_instance.attributes[0].target_id #=> String
resp.container_instance.registered_at #=> Time
resp.container_instance.attachments #=> Array
resp.container_instance.attachments[0].id #=> String
resp.container_instance.attachments[0].type #=> String
resp.container_instance.attachments[0].status #=> String
resp.container_instance.attachments[0].details #=> Array
resp.container_instance.attachments[0].details[0].name #=> String
resp.container_instance.attachments[0].details[0].value #=> String
resp.container_instance.tags #=> Array
resp.container_instance.tags[0].key #=> String
resp.container_instance.tags[0].value #=> String
resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instance.health_status.details #=> Array
resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instance.health_status.details[0].last_updated #=> Time
resp.container_instance.health_status.details[0].last_status_change #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

  • :container_instance (required, String) —

    The container instance ID or full ARN of the container instance to deregister. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

  • :force (Boolean) —

    Forces the container instance to be deregistered. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they're orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

    Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

Returns:

See Also:



3066
3067
3068
3069
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3066

def deregister_container_instance(params = {}, options = {})
  req = build_request(:deregister_container_instance, params)
  req.send_request(options)
end

#deregister_task_definition(params = {}) ⇒ Types::DeregisterTaskDefinitionResponse

Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count. If you want to delete a task definition revision, you must first deregister the task definition revision.

You can't use an INACTIVE task definition to run new tasks or create new services, and you can't update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.

At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.

Examples:

Request syntax with placeholder values


resp = client.deregister_task_definition({
  task_definition: "String", # required
})

Response structure


resp.task_definition.task_definition_arn #=> String
resp.task_definition.container_definitions #=> Array
resp.task_definition.container_definitions[0].name #=> String
resp.task_definition.container_definitions[0].image #=> String
resp.task_definition.container_definitions[0].repository_credentials.credentials_parameter #=> String
resp.task_definition.container_definitions[0].cpu #=> Integer
resp.task_definition.container_definitions[0].memory #=> Integer
resp.task_definition.container_definitions[0].memory_reservation #=> Integer
resp.task_definition.container_definitions[0].links #=> Array
resp.task_definition.container_definitions[0].links[0] #=> String
resp.task_definition.container_definitions[0].port_mappings #=> Array
resp.task_definition.container_definitions[0].port_mappings[0].container_port #=> Integer
resp.task_definition.container_definitions[0].port_mappings[0].host_port #=> Integer
resp.task_definition.container_definitions[0].port_mappings[0].protocol #=> String, one of "tcp", "udp"
resp.task_definition.container_definitions[0].port_mappings[0].name #=> String
resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
resp.task_definition.container_definitions[0].essential #=> Boolean
resp.task_definition.container_definitions[0].restart_policy.enabled #=> Boolean
resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes #=> Array
resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
resp.task_definition.container_definitions[0].restart_policy.restart_attempt_period #=> Integer
resp.task_definition.container_definitions[0].entry_point #=> Array
resp.task_definition.container_definitions[0].entry_point[0] #=> String
resp.task_definition.container_definitions[0].command #=> Array
resp.task_definition.container_definitions[0].command[0] #=> String
resp.task_definition.container_definitions[0].environment #=> Array
resp.task_definition.container_definitions[0].environment[0].name #=> String
resp.task_definition.container_definitions[0].environment[0].value #=> String
resp.task_definition.container_definitions[0].environment_files #=> Array
resp.task_definition.container_definitions[0].environment_files[0].value #=> String
resp.task_definition.container_definitions[0].environment_files[0].type #=> String, one of "s3"
resp.task_definition.container_definitions[0].mount_points #=> Array
resp.task_definition.container_definitions[0].mount_points[0].source_volume #=> String
resp.task_definition.container_definitions[0].mount_points[0].container_path #=> String
resp.task_definition.container_definitions[0].mount_points[0].read_only #=> Boolean
resp.task_definition.container_definitions[0].volumes_from #=> Array
resp.task_definition.container_definitions[0].volumes_from[0].source_container #=> String
resp.task_definition.container_definitions[0].volumes_from[0].read_only #=> Boolean
resp.task_definition.container_definitions[0].linux_parameters.capabilities.add #=> Array
resp.task_definition.container_definitions[0].linux_parameters.capabilities.add[0] #=> String
resp.task_definition.container_definitions[0].linux_parameters.capabilities.drop #=> Array
resp.task_definition.container_definitions[0].linux_parameters.capabilities.drop[0] #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices #=> Array
resp.task_definition.container_definitions[0].linux_parameters.devices[0].host_path #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices[0].container_path #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices[0].permissions #=> Array
resp.task_definition.container_definitions[0].linux_parameters.devices[0].permissions[0] #=> String, one of "read", "write", "mknod"
resp.task_definition.container_definitions[0].linux_parameters.init_process_enabled #=> Boolean
resp.task_definition.container_definitions[0].linux_parameters.shared_memory_size #=> Integer
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
resp.task_definition.container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
resp.task_definition.container_definitions[0].start_timeout #=> Integer
resp.task_definition.container_definitions[0].stop_timeout #=> Integer
resp.task_definition.container_definitions[0].version_consistency #=> String, one of "enabled", "disabled"
resp.task_definition.container_definitions[0].hostname #=> String
resp.task_definition.container_definitions[0].user #=> String
resp.task_definition.container_definitions[0].working_directory #=> String
resp.task_definition.container_definitions[0].disable_networking #=> Boolean
resp.task_definition.container_definitions[0].privileged #=> Boolean
resp.task_definition.container_definitions[0].readonly_root_filesystem #=> Boolean
resp.task_definition.container_definitions[0].dns_servers #=> Array
resp.task_definition.container_definitions[0].dns_servers[0] #=> String
resp.task_definition.container_definitions[0].dns_search_domains #=> Array
resp.task_definition.container_definitions[0].dns_search_domains[0] #=> String
resp.task_definition.container_definitions[0].extra_hosts #=> Array
resp.task_definition.container_definitions[0].extra_hosts[0].hostname #=> String
resp.task_definition.container_definitions[0].extra_hosts[0].ip_address #=> String
resp.task_definition.container_definitions[0].docker_security_options #=> Array
resp.task_definition.container_definitions[0].docker_security_options[0] #=> String
resp.task_definition.container_definitions[0].interactive #=> Boolean
resp.task_definition.container_definitions[0].pseudo_terminal #=> Boolean
resp.task_definition.container_definitions[0].docker_labels #=> Hash
resp.task_definition.container_definitions[0].docker_labels["String"] #=> String
resp.task_definition.container_definitions[0].ulimits #=> Array
resp.task_definition.container_definitions[0].ulimits[0].name #=> String, one of "core", "cpu", "data", "fsize", "locks", "memlock", "msgqueue", "nice", "nofile", "nproc", "rss", "rtprio", "rttime", "sigpending", "stack"
resp.task_definition.container_definitions[0].ulimits[0].soft_limit #=> Integer
resp.task_definition.container_definitions[0].ulimits[0].hard_limit #=> Integer
resp.task_definition.container_definitions[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.task_definition.container_definitions[0].log_configuration.options #=> Hash
resp.task_definition.container_definitions[0].log_configuration.options["String"] #=> String
resp.task_definition.container_definitions[0].log_configuration.secret_options #=> Array
resp.task_definition.container_definitions[0].log_configuration.secret_options[0].name #=> String
resp.task_definition.container_definitions[0].log_configuration.secret_options[0].value_from #=> String
resp.task_definition.container_definitions[0].health_check.command #=> Array
resp.task_definition.container_definitions[0].health_check.command[0] #=> String
resp.task_definition.container_definitions[0].health_check.interval #=> Integer
resp.task_definition.container_definitions[0].health_check.timeout #=> Integer
resp.task_definition.container_definitions[0].health_check.retries #=> Integer
resp.task_definition.container_definitions[0].health_check.start_period #=> Integer
resp.task_definition.container_definitions[0].system_controls #=> Array
resp.task_definition.container_definitions[0].system_controls[0].namespace #=> String
resp.task_definition.container_definitions[0].system_controls[0].value #=> String
resp.task_definition.container_definitions[0].resource_requirements #=> Array
resp.task_definition.container_definitions[0].resource_requirements[0].value #=> String
resp.task_definition.container_definitions[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
resp.task_definition.container_definitions[0].firelens_configuration.type #=> String, one of "fluentd", "fluentbit"
resp.task_definition.container_definitions[0].firelens_configuration.options #=> Hash
resp.task_definition.container_definitions[0].firelens_configuration.options["String"] #=> String
resp.task_definition.container_definitions[0].credential_specs #=> Array
resp.task_definition.container_definitions[0].credential_specs[0] #=> String
resp.task_definition.family #=> String
resp.task_definition.task_role_arn #=> String
resp.task_definition.execution_role_arn #=> String
resp.task_definition.network_mode #=> String, one of "bridge", "host", "awsvpc", "none"
resp.task_definition.revision #=> Integer
resp.task_definition.volumes #=> Array
resp.task_definition.volumes[0].name #=> String
resp.task_definition.volumes[0].host.source_path #=> String
resp.task_definition.volumes[0].docker_volume_configuration.scope #=> String, one of "task", "shared"
resp.task_definition.volumes[0].docker_volume_configuration.autoprovision #=> Boolean
resp.task_definition.volumes[0].docker_volume_configuration.driver #=> String
resp.task_definition.volumes[0].docker_volume_configuration.driver_opts #=> Hash
resp.task_definition.volumes[0].docker_volume_configuration.driver_opts["String"] #=> String
resp.task_definition.volumes[0].docker_volume_configuration.labels #=> Hash
resp.task_definition.volumes[0].docker_volume_configuration.labels["String"] #=> String
resp.task_definition.volumes[0].efs_volume_configuration.file_system_id #=> String
resp.task_definition.volumes[0].efs_volume_configuration.root_directory #=> String
resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.file_system_id #=> String
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.root_directory #=> String
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.authorization_config.credentials_parameter #=> String
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.authorization_config.domain #=> String
resp.task_definition.volumes[0].configured_at_launch #=> Boolean
resp.task_definition.status #=> String, one of "ACTIVE", "INACTIVE", "DELETE_IN_PROGRESS"
resp.task_definition.requires_attributes #=> Array
resp.task_definition.requires_attributes[0].name #=> String
resp.task_definition.requires_attributes[0].value #=> String
resp.task_definition.requires_attributes[0].target_type #=> String, one of "container-instance"
resp.task_definition.requires_attributes[0].target_id #=> String
resp.task_definition.placement_constraints #=> Array
resp.task_definition.placement_constraints[0].type #=> String, one of "memberOf"
resp.task_definition.placement_constraints[0].expression #=> String
resp.task_definition.compatibilities #=> Array
resp.task_definition.compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_definition.runtime_platform.cpu_architecture #=> String, one of "X86_64", "ARM64"
resp.task_definition.runtime_platform.operating_system_family #=> String, one of "WINDOWS_SERVER_2019_FULL", "WINDOWS_SERVER_2019_CORE", "WINDOWS_SERVER_2016_FULL", "WINDOWS_SERVER_2004_CORE", "WINDOWS_SERVER_2022_CORE", "WINDOWS_SERVER_2022_FULL", "WINDOWS_SERVER_20H2_CORE", "LINUX"
resp.task_definition.requires_compatibilities #=> Array
resp.task_definition.requires_compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_definition.cpu #=> String
resp.task_definition.memory #=> String
resp.task_definition.inference_accelerators #=> Array
resp.task_definition.inference_accelerators[0].device_name #=> String
resp.task_definition.inference_accelerators[0].device_type #=> String
resp.task_definition.pid_mode #=> String, one of "host", "task"
resp.task_definition.ipc_mode #=> String, one of "host", "task", "none"
resp.task_definition.proxy_configuration.type #=> String, one of "APPMESH"
resp.task_definition.proxy_configuration.container_name #=> String
resp.task_definition.proxy_configuration.properties #=> Array
resp.task_definition.proxy_configuration.properties[0].name #=> String
resp.task_definition.proxy_configuration.properties[0].value #=> String
resp.task_definition.registered_at #=> Time
resp.task_definition.deregistered_at #=> Time
resp.task_definition.registered_by #=> String
resp.task_definition.ephemeral_storage.size_in_gi_b #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_definition (required, String) —

    The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

Returns:

See Also:



3291
3292
3293
3294
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3291

def deregister_task_definition(params = {}, options = {})
  req = build_request(:deregister_task_definition, params)
  req.send_request(options)
end

#describe_capacity_providers(params = {}) ⇒ Types::DescribeCapacityProvidersResponse

Describes one or more of your capacity providers.

Examples:

Request syntax with placeholder values


resp = client.describe_capacity_providers({
  capacity_providers: ["String"],
  include: ["TAGS"], # accepts TAGS
  max_results: 1,
  next_token: "String",
})

Response structure


resp.capacity_providers #=> Array
resp.capacity_providers[0].capacity_provider_arn #=> String
resp.capacity_providers[0].name #=> String
resp.capacity_providers[0].status #=> String, one of "ACTIVE", "INACTIVE"
resp.capacity_providers[0].auto_scaling_group_provider.auto_scaling_group_arn #=> String
resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.status #=> String, one of "ENABLED", "DISABLED"
resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.target_capacity #=> Integer
resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.minimum_scaling_step_size #=> Integer
resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.maximum_scaling_step_size #=> Integer
resp.capacity_providers[0].auto_scaling_group_provider.managed_scaling.instance_warmup_period #=> Integer
resp.capacity_providers[0].auto_scaling_group_provider.managed_termination_protection #=> String, one of "ENABLED", "DISABLED"
resp.capacity_providers[0].auto_scaling_group_provider.managed_draining #=> String, one of "ENABLED", "DISABLED"
resp.capacity_providers[0].update_status #=> String, one of "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED"
resp.capacity_providers[0].update_status_reason #=> String
resp.capacity_providers[0].tags #=> Array
resp.capacity_providers[0].tags[0].key #=> String
resp.capacity_providers[0].tags[0].value #=> String
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity_providers (Array<String>) —

    The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

  • :include (Array<String>) —

    Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

  • :max_results (Integer) —

    The maximum number of account setting results returned by DescribeCapacityProviders in paginated output. When this parameter is used, DescribeCapacityProviders only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders returns up to 10 results and a nextToken value if applicable.

  • :next_token (String) —

    The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Returns:

See Also:



3377
3378
3379
3380
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3377

def describe_capacity_providers(params = {}, options = {})
  req = build_request(:describe_capacity_providers, params)
  req.send_request(options)
end

#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse

Describes one or more of your clusters.

Examples:

Example: To describe a cluster


# This example provides a description of the specified cluster in your default region.

resp = client.describe_clusters({
  clusters: [
    "default", 
  ], 
})

resp.to_h outputs the following:
{
  clusters: [
    {
      cluster_arn: "arn:aws:ecs:us-east-1:aws_account_id:cluster/default", 
      cluster_name: "default", 
      status: "ACTIVE", 
    }, 
  ], 
  failures: [
  ], 
}

Request syntax with placeholder values


resp = client.describe_clusters({
  clusters: ["String"],
  include: ["ATTACHMENTS"], # accepts ATTACHMENTS, CONFIGURATIONS, SETTINGS, STATISTICS, TAGS
})

Response structure


resp.clusters #=> Array
resp.clusters[0].cluster_arn #=> String
resp.clusters[0].cluster_name #=> String
resp.clusters[0].configuration.execute_command_configuration.kms_key_id #=> String
resp.clusters[0].configuration.execute_command_configuration.logging #=> String, one of "NONE", "DEFAULT", "OVERRIDE"
resp.clusters[0].configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
resp.clusters[0].configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
resp.clusters[0].configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
resp.clusters[0].configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
resp.clusters[0].configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
resp.clusters[0].configuration.managed_storage_configuration.kms_key_id #=> String
resp.clusters[0].configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
resp.clusters[0].status #=> String
resp.clusters[0].registered_container_instances_count #=> Integer
resp.clusters[0].running_tasks_count #=> Integer
resp.clusters[0].pending_tasks_count #=> Integer
resp.clusters[0].active_services_count #=> Integer
resp.clusters[0].statistics #=> Array
resp.clusters[0].statistics[0].name #=> String
resp.clusters[0].statistics[0].value #=> String
resp.clusters[0].tags #=> Array
resp.clusters[0].tags[0].key #=> String
resp.clusters[0].tags[0].value #=> String
resp.clusters[0].settings #=> Array
resp.clusters[0].settings[0].name #=> String, one of "containerInsights"
resp.clusters[0].settings[0].value #=> String
resp.clusters[0].capacity_providers #=> Array
resp.clusters[0].capacity_providers[0] #=> String
resp.clusters[0].default_capacity_provider_strategy #=> Array
resp.clusters[0].default_capacity_provider_strategy[0].capacity_provider #=> String
resp.clusters[0].default_capacity_provider_strategy[0].weight #=> Integer
resp.clusters[0].default_capacity_provider_strategy[0].base #=> Integer
resp.clusters[0].attachments #=> Array
resp.clusters[0].attachments[0].id #=> String
resp.clusters[0].attachments[0].type #=> String
resp.clusters[0].attachments[0].status #=> String
resp.clusters[0].attachments[0].details #=> Array
resp.clusters[0].attachments[0].details[0].name #=> String
resp.clusters[0].attachments[0].details[0].value #=> String
resp.clusters[0].attachments_status #=> String
resp.clusters[0].service_connect_defaults.namespace #=> String
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :clusters (Array<String>) —

    A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

  • :include (Array<String>) —

    Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

    If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

    If SETTINGS is specified, the settings for the cluster are included.

    If CONFIGURATIONS is specified, the configuration for the cluster is included.

    If STATISTICS is specified, the task and service count is included, separated by launch type.

    If TAGS is specified, the metadata tags associated with the cluster are included.

Returns:

See Also:



3497
3498
3499
3500
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3497

def describe_clusters(params = {}, options = {})
  req = build_request(:describe_clusters, params)
  req.send_request(options)
end

#describe_container_instances(params = {}) ⇒ Types::DescribeContainerInstancesResponse

Describes one or more container instances. Returns metadata about each container instance requested.

Examples:

Example: To describe container instance


# This example provides a description of the specified container instance in your default region, using the container
# instance UUID as an identifier.

resp = client.describe_container_instances({
  cluster: "default", 
  container_instances: [
    "f2756532-8f13-4d53-87c9-aed50dc94cd7", 
  ], 
})

resp.to_h outputs the following:
{
  container_instances: [
    {
      agent_connected: true, 
      container_instance_arn: "arn:aws:ecs:us-east-1:012345678910:container-instance/default/f2756532-8f13-4d53-87c9-aed50dc94cd7", 
      ec2_instance_id: "i-807f3249", 
      pending_tasks_count: 0, 
      registered_resources: [
        {
          name: "CPU", 
          type: "INTEGER", 
          double_value: 0.0, 
          integer_value: 2048, 
          long_value: 0, 
        }, 
        {
          name: "MEMORY", 
          type: "INTEGER", 
          double_value: 0.0, 
          integer_value: 3768, 
          long_value: 0, 
        }, 
        {
          name: "PORTS", 
          type: "STRINGSET", 
          double_value: 0.0, 
          integer_value: 0, 
          long_value: 0, 
          string_set_value: [
            "2376", 
            "22", 
            "51678", 
            "2375", 
          ], 
        }, 
      ], 
      remaining_resources: [
        {
          name: "CPU", 
          type: "INTEGER", 
          double_value: 0.0, 
          integer_value: 1948, 
          long_value: 0, 
        }, 
        {
          name: "MEMORY", 
          type: "INTEGER", 
          double_value: 0.0, 
          integer_value: 3668, 
          long_value: 0, 
        }, 
        {
          name: "PORTS", 
          type: "STRINGSET", 
          double_value: 0.0, 
          integer_value: 0, 
          long_value: 0, 
          string_set_value: [
            "2376", 
            "22", 
            "80", 
            "51678", 
            "2375", 
          ], 
        }, 
      ], 
      running_tasks_count: 1, 
      status: "ACTIVE", 
    }, 
  ], 
  failures: [
  ], 
}

Request syntax with placeholder values


resp = client.describe_container_instances({
  cluster: "String",
  container_instances: ["String"], # required
  include: ["TAGS"], # accepts TAGS, CONTAINER_INSTANCE_HEALTH
})

Response structure


resp.container_instances #=> Array
resp.container_instances[0].container_instance_arn #=> String
resp.container_instances[0].ec2_instance_id #=> String
resp.container_instances[0].capacity_provider_name #=> String
resp.container_instances[0].version #=> Integer
resp.container_instances[0].version_info.agent_version #=> String
resp.container_instances[0].version_info.agent_hash #=> String
resp.container_instances[0].version_info.docker_version #=> String
resp.container_instances[0].remaining_resources #=> Array
resp.container_instances[0].remaining_resources[0].name #=> String
resp.container_instances[0].remaining_resources[0].type #=> String
resp.container_instances[0].remaining_resources[0].double_value #=> Float
resp.container_instances[0].remaining_resources[0].long_value #=> Integer
resp.container_instances[0].remaining_resources[0].integer_value #=> Integer
resp.container_instances[0].remaining_resources[0].string_set_value #=> Array
resp.container_instances[0].remaining_resources[0].string_set_value[0] #=> String
resp.container_instances[0].registered_resources #=> Array
resp.container_instances[0].registered_resources[0].name #=> String
resp.container_instances[0].registered_resources[0].type #=> String
resp.container_instances[0].registered_resources[0].double_value #=> Float
resp.container_instances[0].registered_resources[0].long_value #=> Integer
resp.container_instances[0].registered_resources[0].integer_value #=> Integer
resp.container_instances[0].registered_resources[0].string_set_value #=> Array
resp.container_instances[0].registered_resources[0].string_set_value[0] #=> String
resp.container_instances[0].status #=> String
resp.container_instances[0].status_reason #=> String
resp.container_instances[0].agent_connected #=> Boolean
resp.container_instances[0].running_tasks_count #=> Integer
resp.container_instances[0].pending_tasks_count #=> Integer
resp.container_instances[0].agent_update_status #=> String, one of "PENDING", "STAGING", "STAGED", "UPDATING", "UPDATED", "FAILED"
resp.container_instances[0].attributes #=> Array
resp.container_instances[0].attributes[0].name #=> String
resp.container_instances[0].attributes[0].value #=> String
resp.container_instances[0].attributes[0].target_type #=> String, one of "container-instance"
resp.container_instances[0].attributes[0].target_id #=> String
resp.container_instances[0].registered_at #=> Time
resp.container_instances[0].attachments #=> Array
resp.container_instances[0].attachments[0].id #=> String
resp.container_instances[0].attachments[0].type #=> String
resp.container_instances[0].attachments[0].status #=> String
resp.container_instances[0].attachments[0].details #=> Array
resp.container_instances[0].attachments[0].details[0].name #=> String
resp.container_instances[0].attachments[0].details[0].value #=> String
resp.container_instances[0].tags #=> Array
resp.container_instances[0].tags[0].key #=> String
resp.container_instances[0].tags[0].value #=> String
resp.container_instances[0].health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instances[0].health_status.details #=> Array
resp.container_instances[0].health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
resp.container_instances[0].health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instances[0].health_status.details[0].last_updated #=> Time
resp.container_instances[0].health_status.details[0].last_status_change #=> Time
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

  • :container_instances (required, Array<String>) —

    A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

  • :include (Array<String>) —

    Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.

Returns:

See Also:



3688
3689
3690
3691
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3688

def describe_container_instances(params = {}, options = {})
  req = build_request(:describe_container_instances, params)
  req.send_request(options)
end

#describe_service_deployments(params = {}) ⇒ Types::DescribeServiceDeploymentsResponse

Describes one or more of your service deployments.

A service deployment happens when you release a software update for the service. For more information, see Amazon ECS service deployments.

Examples:

Request syntax with placeholder values


resp = client.describe_service_deployments({
  service_deployment_arns: ["String"], # required
})

Response structure


resp.service_deployments #=> Array
resp.service_deployments[0].service_deployment_arn #=> String
resp.service_deployments[0].service_arn #=> String
resp.service_deployments[0].cluster_arn #=> String
resp.service_deployments[0].created_at #=> Time
resp.service_deployments[0].started_at #=> Time
resp.service_deployments[0].finished_at #=> Time
resp.service_deployments[0].stopped_at #=> Time
resp.service_deployments[0].updated_at #=> Time
resp.service_deployments[0].source_service_revisions #=> Array
resp.service_deployments[0].source_service_revisions[0].arn #=> String
resp.service_deployments[0].source_service_revisions[0].requested_task_count #=> Integer
resp.service_deployments[0].source_service_revisions[0].running_task_count #=> Integer
resp.service_deployments[0].source_service_revisions[0].pending_task_count #=> Integer
resp.service_deployments[0].target_service_revision.arn #=> String
resp.service_deployments[0].target_service_revision.requested_task_count #=> Integer
resp.service_deployments[0].target_service_revision.running_task_count #=> Integer
resp.service_deployments[0].target_service_revision.pending_task_count #=> Integer
resp.service_deployments[0].status #=> String, one of "PENDING", "SUCCESSFUL", "STOPPED", "STOP_REQUESTED", "IN_PROGRESS", "ROLLBACK_IN_PROGRESS", "ROLLBACK_SUCCESSFUL", "ROLLBACK_FAILED"
resp.service_deployments[0].status_reason #=> String
resp.service_deployments[0].deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
resp.service_deployments[0].deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
resp.service_deployments[0].deployment_configuration.maximum_percent #=> Integer
resp.service_deployments[0].deployment_configuration.minimum_healthy_percent #=> Integer
resp.service_deployments[0].deployment_configuration.alarms.alarm_names #=> Array
resp.service_deployments[0].deployment_configuration.alarms.alarm_names[0] #=> String
resp.service_deployments[0].deployment_configuration.alarms.rollback #=> Boolean
resp.service_deployments[0].deployment_configuration.alarms.enable #=> Boolean
resp.service_deployments[0].rollback.reason #=> String
resp.service_deployments[0].rollback.started_at #=> Time
resp.service_deployments[0].rollback.service_revision_arn #=> String
resp.service_deployments[0].deployment_circuit_breaker.status #=> String, one of "TRIGGERED", "MONITORING", "MONITORING_COMPLETE", "DISABLED"
resp.service_deployments[0].deployment_circuit_breaker.failure_count #=> Integer
resp.service_deployments[0].deployment_circuit_breaker.threshold #=> Integer
resp.service_deployments[0].alarms.status #=> String, one of "TRIGGERED", "MONITORING", "MONITORING_COMPLETE", "DISABLED"
resp.service_deployments[0].alarms.alarm_names #=> Array
resp.service_deployments[0].alarms.alarm_names[0] #=> String
resp.service_deployments[0].alarms.triggered_alarm_names #=> Array
resp.service_deployments[0].alarms.triggered_alarm_names[0] #=> String
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_deployment_arns (required, Array<String>) —

    The ARN of the service deployment.

    You can specify a maximum of 20 ARNs.

Returns:

See Also:



3769
3770
3771
3772
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3769

def describe_service_deployments(params = {}, options = {})
  req = build_request(:describe_service_deployments, params)
  req.send_request(options)
end

#describe_service_revisions(params = {}) ⇒ Types::DescribeServiceRevisionsResponse

Describes one or more service revisions.

A service revision is a version of the service that includes the values for the Amazon ECS resources (for example, task definition) and the environment resources (for example, load balancers, subnets, and security groups). For more information, see Amazon ECS service revisions.

You can't describe a service revision that was created before October 25, 2024.

Examples:

Request syntax with placeholder values


resp = client.describe_service_revisions({
  service_revision_arns: ["String"], # required
})

Response structure


resp.service_revisions #=> Array
resp.service_revisions[0].service_revision_arn #=> String
resp.service_revisions[0].service_arn #=> String
resp.service_revisions[0].cluster_arn #=> String
resp.service_revisions[0].task_definition #=> String
resp.service_revisions[0].capacity_provider_strategy #=> Array
resp.service_revisions[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.service_revisions[0].capacity_provider_strategy[0].weight #=> Integer
resp.service_revisions[0].capacity_provider_strategy[0].base #=> Integer
resp.service_revisions[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service_revisions[0].platform_version #=> String
resp.service_revisions[0].platform_family #=> String
resp.service_revisions[0].load_balancers #=> Array
resp.service_revisions[0].load_balancers[0].target_group_arn #=> String
resp.service_revisions[0].load_balancers[0].load_balancer_name #=> String
resp.service_revisions[0].load_balancers[0].container_name #=> String
resp.service_revisions[0].load_balancers[0].container_port #=> Integer
resp.service_revisions[0].service_registries #=> Array
resp.service_revisions[0].service_registries[0].registry_arn #=> String
resp.service_revisions[0].service_registries[0].port #=> Integer
resp.service_revisions[0].service_registries[0].container_name #=> String
resp.service_revisions[0].service_registries[0].container_port #=> Integer
resp.service_revisions[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.service_revisions[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service_revisions[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service_revisions[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service_revisions[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service_revisions[0].container_images #=> Array
resp.service_revisions[0].container_images[0].container_name #=> String
resp.service_revisions[0].container_images[0].image_digest #=> String
resp.service_revisions[0].container_images[0].image #=> String
resp.service_revisions[0].guard_duty_enabled #=> Boolean
resp.service_revisions[0].service_connect_configuration.enabled #=> Boolean
resp.service_revisions[0].service_connect_configuration.namespace #=> String
resp.service_revisions[0].service_connect_configuration.services #=> Array
resp.service_revisions[0].service_connect_configuration.services[0].port_name #=> String
resp.service_revisions[0].service_connect_configuration.services[0].discovery_name #=> String
resp.service_revisions[0].service_connect_configuration.services[0].client_aliases #=> Array
resp.service_revisions[0].service_connect_configuration.services[0].client_aliases[0].port #=> Integer
resp.service_revisions[0].service_connect_configuration.services[0].client_aliases[0].dns_name #=> String
resp.service_revisions[0].service_connect_configuration.services[0].ingress_port_override #=> Integer
resp.service_revisions[0].service_connect_configuration.services[0].timeout.idle_timeout_seconds #=> Integer
resp.service_revisions[0].service_connect_configuration.services[0].timeout.per_request_timeout_seconds #=> Integer
resp.service_revisions[0].service_connect_configuration.services[0].tls.issuer_certificate_authority.aws_pca_authority_arn #=> String
resp.service_revisions[0].service_connect_configuration.services[0].tls.kms_key #=> String
resp.service_revisions[0].service_connect_configuration.services[0].tls.role_arn #=> String
resp.service_revisions[0].service_connect_configuration.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.service_revisions[0].service_connect_configuration.log_configuration.options #=> Hash
resp.service_revisions[0].service_connect_configuration.log_configuration.options["String"] #=> String
resp.service_revisions[0].service_connect_configuration.log_configuration.secret_options #=> Array
resp.service_revisions[0].service_connect_configuration.log_configuration.secret_options[0].name #=> String
resp.service_revisions[0].service_connect_configuration.log_configuration.secret_options[0].value_from #=> String
resp.service_revisions[0].volume_configurations #=> Array
resp.service_revisions[0].volume_configurations[0].name #=> String
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.encrypted #=> Boolean
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.kms_key_id #=> String
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.volume_type #=> String
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.size_in_gi_b #=> Integer
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.snapshot_id #=> String
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.iops #=> Integer
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.throughput #=> Integer
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.tag_specifications #=> Array
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].resource_type #=> String, one of "volume"
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags #=> Array
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
resp.service_revisions[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs", "ntfs"
resp.service_revisions[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.service_revisions[0].created_at #=> Time
resp.service_revisions[0].vpc_lattice_configurations #=> Array
resp.service_revisions[0].vpc_lattice_configurations[0].role_arn #=> String
resp.service_revisions[0].vpc_lattice_configurations[0].target_group_arn #=> String
resp.service_revisions[0].vpc_lattice_configurations[0].port_name #=> String
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service_revision_arns (required, Array<String>) —

    The ARN of the service revision.

    You can specify a maximum of 20 ARNs.

    You can call ListServiceDeployments to get the ARNs.

Returns:

See Also:



3897
3898
3899
3900
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3897

def describe_service_revisions(params = {}, options = {})
  req = build_request(:describe_service_revisions, params)
  req.send_request(options)
end

#describe_services(params = {}) ⇒ Types::DescribeServicesResponse

Describes the specified services running in your cluster.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • services_inactive
  • services_stable

Examples:

Example: To describe a service


# This example provides descriptive information about the service named ``ecs-simple-service``.

resp = client.describe_services({
  services: [
    "ecs-simple-service", 
  ], 
})

resp.to_h outputs the following:
{
  failures: [
  ], 
  services: [
    {
      cluster_arn: "arn:aws:ecs:us-east-1:012345678910:cluster/default", 
      created_at: Time.parse("2016-08-29T16:25:52.130Z"), 
      deployment_configuration: {
        maximum_percent: 200, 
        minimum_healthy_percent: 100, 
      }, 
      deployments: [
        {
          created_at: Time.parse("2016-08-29T16:25:52.130Z"), 
          desired_count: 1, 
          id: "ecs-svc/9223370564341623665", 
          pending_count: 0, 
          running_count: 0, 
          status: "PRIMARY", 
          task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", 
          updated_at: Time.parse("2016-08-29T16:25:52.130Z"), 
        }, 
      ], 
      desired_count: 1, 
      events: [
        {
          created_at: Time.parse("2016-08-29T16:25:58.520Z"), 
          id: "38c285e5-d335-4b68-8b15-e46dedc8e88d", 
          message: "(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide.", # In this example, there is a service event that shows unavailable cluster resources.
        }, 
      ], 
      load_balancers: [
      ], 
      pending_count: 0, 
      running_count: 0, 
      service_arn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service", 
      service_name: "ecs-simple-service", 
      status: "ACTIVE", 
      task_definition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_services({
  cluster: "String",
  services: ["String"], # required
  include: ["TAGS"], # accepts TAGS
})

Response structure


resp.services #=> Array
resp.services[0].service_arn #=> String
resp.services[0].service_name #=> String
resp.services[0].cluster_arn #=> String
resp.services[0].load_balancers #=> Array
resp.services[0].load_balancers[0].target_group_arn #=> String
resp.services[0].load_balancers[0].load_balancer_name #=> String
resp.services[0].load_balancers[0].container_name #=> String
resp.services[0].load_balancers[0].container_port #=> Integer
resp.services[0].service_registries #=> Array
resp.services[0].service_registries[0].registry_arn #=> String
resp.services[0].service_registries[0].port #=> Integer
resp.services[0].service_registries[0].container_name #=> String
resp.services[0].service_registries[0].container_port #=> Integer
resp.services[0].status #=> String
resp.services[0].desired_count #=> Integer
resp.services[0].running_count #=> Integer
resp.services[0].pending_count #=> Integer
resp.services[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.services[0].capacity_provider_strategy #=> Array
resp.services[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.services[0].capacity_provider_strategy[0].weight #=> Integer
resp.services[0].capacity_provider_strategy[0].base #=> Integer
resp.services[0].platform_version #=> String
resp.services[0].platform_family #=> String
resp.services[0].task_definition #=> String
resp.services[0].deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
resp.services[0].deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
resp.services[0].deployment_configuration.maximum_percent #=> Integer
resp.services[0].deployment_configuration.minimum_healthy_percent #=> Integer
resp.services[0].deployment_configuration.alarms.alarm_names #=> Array
resp.services[0].deployment_configuration.alarms.alarm_names[0] #=> String
resp.services[0].deployment_configuration.alarms.rollback #=> Boolean
resp.services[0].deployment_configuration.alarms.enable #=> Boolean
resp.services[0].task_sets #=> Array
resp.services[0].task_sets[0].id #=> String
resp.services[0].task_sets[0].task_set_arn #=> String
resp.services[0].task_sets[0].service_arn #=> String
resp.services[0].task_sets[0].cluster_arn #=> String
resp.services[0].task_sets[0].started_by #=> String
resp.services[0].task_sets[0].external_id #=> String
resp.services[0].task_sets[0].status #=> String
resp.services[0].task_sets[0].task_definition #=> String
resp.services[0].task_sets[0].computed_desired_count #=> Integer
resp.services[0].task_sets[0].pending_count #=> Integer
resp.services[0].task_sets[0].running_count #=> Integer
resp.services[0].task_sets[0].created_at #=> Time
resp.services[0].task_sets[0].updated_at #=> Time
resp.services[0].task_sets[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.services[0].task_sets[0].capacity_provider_strategy #=> Array
resp.services[0].task_sets[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.services[0].task_sets[0].capacity_provider_strategy[0].weight #=> Integer
resp.services[0].task_sets[0].capacity_provider_strategy[0].base #=> Integer
resp.services[0].task_sets[0].platform_version #=> String
resp.services[0].task_sets[0].platform_family #=> String
resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.services[0].task_sets[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.services[0].task_sets[0].load_balancers #=> Array
resp.services[0].task_sets[0].load_balancers[0].target_group_arn #=> String
resp.services[0].task_sets[0].load_balancers[0].load_balancer_name #=> String
resp.services[0].task_sets[0].load_balancers[0].container_name #=> String
resp.services[0].task_sets[0].load_balancers[0].container_port #=> Integer
resp.services[0].task_sets[0].service_registries #=> Array
resp.services[0].task_sets[0].service_registries[0].registry_arn #=> String
resp.services[0].task_sets[0].service_registries[0].port #=> Integer
resp.services[0].task_sets[0].service_registries[0].container_name #=> String
resp.services[0].task_sets[0].service_registries[0].container_port #=> Integer
resp.services[0].task_sets[0].scale.value #=> Float
resp.services[0].task_sets[0].scale.unit #=> String, one of "PERCENT"
resp.services[0].task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.services[0].task_sets[0].stability_status_at #=> Time
resp.services[0].task_sets[0].tags #=> Array
resp.services[0].task_sets[0].tags[0].key #=> String
resp.services[0].task_sets[0].tags[0].value #=> String
resp.services[0].task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.services[0].deployments #=> Array
resp.services[0].deployments[0].id #=> String
resp.services[0].deployments[0].status #=> String
resp.services[0].deployments[0].task_definition #=> String
resp.services[0].deployments[0].desired_count #=> Integer
resp.services[0].deployments[0].pending_count #=> Integer
resp.services[0].deployments[0].running_count #=> Integer
resp.services[0].deployments[0].failed_tasks #=> Integer
resp.services[0].deployments[0].created_at #=> Time
resp.services[0].deployments[0].updated_at #=> Time
resp.services[0].deployments[0].capacity_provider_strategy #=> Array
resp.services[0].deployments[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.services[0].deployments[0].capacity_provider_strategy[0].weight #=> Integer
resp.services[0].deployments[0].capacity_provider_strategy[0].base #=> Integer
resp.services[0].deployments[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.services[0].deployments[0].platform_version #=> String
resp.services[0].deployments[0].platform_family #=> String
resp.services[0].deployments[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.services[0].deployments[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.services[0].deployments[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.services[0].deployments[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.services[0].deployments[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.services[0].deployments[0].rollout_state #=> String, one of "COMPLETED", "FAILED", "IN_PROGRESS"
resp.services[0].deployments[0].rollout_state_reason #=> String
resp.services[0].deployments[0].service_connect_configuration.enabled #=> Boolean
resp.services[0].deployments[0].service_connect_configuration.namespace #=> String
resp.services[0].deployments[0].service_connect_configuration.services #=> Array
resp.services[0].deployments[0].service_connect_configuration.services[0].port_name #=> String
resp.services[0].deployments[0].service_connect_configuration.services[0].discovery_name #=> String
resp.services[0].deployments[0].service_connect_configuration.services[0].client_aliases #=> Array
resp.services[0].deployments[0].service_connect_configuration.services[0].client_aliases[0].port #=> Integer
resp.services[0].deployments[0].service_connect_configuration.services[0].client_aliases[0].dns_name #=> String
resp.services[0].deployments[0].service_connect_configuration.services[0].ingress_port_override #=> Integer
resp.services[0].deployments[0].service_connect_configuration.services[0].timeout.idle_timeout_seconds #=> Integer
resp.services[0].deployments[0].service_connect_configuration.services[0].timeout.per_request_timeout_seconds #=> Integer
resp.services[0].deployments[0].service_connect_configuration.services[0].tls.issuer_certificate_authority.aws_pca_authority_arn #=> String
resp.services[0].deployments[0].service_connect_configuration.services[0].tls.kms_key #=> String
resp.services[0].deployments[0].service_connect_configuration.services[0].tls.role_arn #=> String
resp.services[0].deployments[0].service_connect_configuration.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.services[0].deployments[0].service_connect_configuration.log_configuration.options #=> Hash
resp.services[0].deployments[0].service_connect_configuration.log_configuration.options["String"] #=> String
resp.services[0].deployments[0].service_connect_configuration.log_configuration.secret_options #=> Array
resp.services[0].deployments[0].service_connect_configuration.log_configuration.secret_options[0].name #=> String
resp.services[0].deployments[0].service_connect_configuration.log_configuration.secret_options[0].value_from #=> String
resp.services[0].deployments[0].service_connect_resources #=> Array
resp.services[0].deployments[0].service_connect_resources[0].discovery_name #=> String
resp.services[0].deployments[0].service_connect_resources[0].discovery_arn #=> String
resp.services[0].deployments[0].volume_configurations #=> Array
resp.services[0].deployments[0].volume_configurations[0].name #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.encrypted #=> Boolean
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.kms_key_id #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.volume_type #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.size_in_gi_b #=> Integer
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.snapshot_id #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.iops #=> Integer
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.throughput #=> Integer
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications #=> Array
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].resource_type #=> String, one of "volume"
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags #=> Array
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
resp.services[0].deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs", "ntfs"
resp.services[0].deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.services[0].deployments[0].vpc_lattice_configurations #=> Array
resp.services[0].deployments[0].vpc_lattice_configurations[0].role_arn #=> String
resp.services[0].deployments[0].vpc_lattice_configurations[0].target_group_arn #=> String
resp.services[0].deployments[0].vpc_lattice_configurations[0].port_name #=> String
resp.services[0].role_arn #=> String
resp.services[0].events #=> Array
resp.services[0].events[0].id #=> String
resp.services[0].events[0].created_at #=> Time
resp.services[0].events[0].message #=> String
resp.services[0].created_at #=> Time
resp.services[0].placement_constraints #=> Array
resp.services[0].placement_constraints[0].type #=> String, one of "distinctInstance", "memberOf"
resp.services[0].placement_constraints[0].expression #=> String
resp.services[0].placement_strategy #=> Array
resp.services[0].placement_strategy[0].type #=> String, one of "random", "spread", "binpack"
resp.services[0].placement_strategy[0].field #=> String
resp.services[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.services[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.services[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.services[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.services[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.services[0].health_check_grace_period_seconds #=> Integer
resp.services[0].scheduling_strategy #=> String, one of "REPLICA", "DAEMON"
resp.services[0].deployment_controller.type #=> String, one of "ECS", "CODE_DEPLOY", "EXTERNAL"
resp.services[0].tags #=> Array
resp.services[0].tags[0].key #=> String
resp.services[0].tags[0].value #=> String
resp.services[0].created_by #=> String
resp.services[0].enable_ecs_managed_tags #=> Boolean
resp.services[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.services[0].enable_execute_command #=> Boolean
resp.services[0].availability_zone_rebalancing #=> String, one of "ENABLED", "DISABLED"
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.

  • :services (required, Array<String>) —

    A list of services to describe. You may specify up to 10 services to describe in a single operation.

  • :include (Array<String>) —

    Determines whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

Returns:

See Also:



4180
4181
4182
4183
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4180

def describe_services(params = {}, options = {})
  req = build_request(:describe_services, params)
  req.send_request(options)
end

#describe_task_definition(params = {}) ⇒ Types::DescribeTaskDefinitionResponse

Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

You can only describe INACTIVE task definitions while an active task or service references them.

Examples:

Example: To describe a task definition


# This example provides a description of the specified task definition.

resp = client.describe_task_definition({
  task_definition: "hello_world:8", 
})

resp.to_h outputs the following:
{
  task_definition: {
    container_definitions: [
      {
        name: "wordpress", 
        cpu: 10, 
        environment: [
        ], 
        essential: true, 
        image: "wordpress", 
        links: [
          "mysql", 
        ], 
        memory: 500, 
        mount_points: [
        ], 
        port_mappings: [
          {
            container_port: 80, 
            host_port: 80, 
          }, 
        ], 
        volumes_from: [
        ], 
      }, 
      {
        name: "mysql", 
        cpu: 10, 
        environment: [
          {
            name: "MYSQL_ROOT_PASSWORD", 
            value: "password", 
          }, 
        ], 
        essential: true, 
        image: "mysql", 
        memory: 500, 
        mount_points: [
        ], 
        port_mappings: [
        ], 
        volumes_from: [
        ], 
      }, 
    ], 
    family: "hello_world", 
    revision: 8, 
    task_definition_arn: "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/hello_world:8", 
    volumes: [
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.describe_task_definition({
  task_definition: "String", # required
  include: ["TAGS"], # accepts TAGS
})

Response structure


resp.task_definition.task_definition_arn #=> String
resp.task_definition.container_definitions #=> Array
resp.task_definition.container_definitions[0].name #=> String
resp.task_definition.container_definitions[0].image #=> String
resp.task_definition.container_definitions[0].repository_credentials.credentials_parameter #=> String
resp.task_definition.container_definitions[0].cpu #=> Integer
resp.task_definition.container_definitions[0].memory #=> Integer
resp.task_definition.container_definitions[0].memory_reservation #=> Integer
resp.task_definition.container_definitions[0].links #=> Array
resp.task_definition.container_definitions[0].links[0] #=> String
resp.task_definition.container_definitions[0].port_mappings #=> Array
resp.task_definition.container_definitions[0].port_mappings[0].container_port #=> Integer
resp.task_definition.container_definitions[0].port_mappings[0].host_port #=> Integer
resp.task_definition.container_definitions[0].port_mappings[0].protocol #=> String, one of "tcp", "udp"
resp.task_definition.container_definitions[0].port_mappings[0].name #=> String
resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
resp.task_definition.container_definitions[0].essential #=> Boolean
resp.task_definition.container_definitions[0].restart_policy.enabled #=> Boolean
resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes #=> Array
resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
resp.task_definition.container_definitions[0].restart_policy.restart_attempt_period #=> Integer
resp.task_definition.container_definitions[0].entry_point #=> Array
resp.task_definition.container_definitions[0].entry_point[0] #=> String
resp.task_definition.container_definitions[0].command #=> Array
resp.task_definition.container_definitions[0].command[0] #=> String
resp.task_definition.container_definitions[0].environment #=> Array
resp.task_definition.container_definitions[0].environment[0].name #=> String
resp.task_definition.container_definitions[0].environment[0].value #=> String
resp.task_definition.container_definitions[0].environment_files #=> Array
resp.task_definition.container_definitions[0].environment_files[0].value #=> String
resp.task_definition.container_definitions[0].environment_files[0].type #=> String, one of "s3"
resp.task_definition.container_definitions[0].mount_points #=> Array
resp.task_definition.container_definitions[0].mount_points[0].source_volume #=> String
resp.task_definition.container_definitions[0].mount_points[0].container_path #=> String
resp.task_definition.container_definitions[0].mount_points[0].read_only #=> Boolean
resp.task_definition.container_definitions[0].volumes_from #=> Array
resp.task_definition.container_definitions[0].volumes_from[0].source_container #=> String
resp.task_definition.container_definitions[0].volumes_from[0].read_only #=> Boolean
resp.task_definition.container_definitions[0].linux_parameters.capabilities.add #=> Array
resp.task_definition.container_definitions[0].linux_parameters.capabilities.add[0] #=> String
resp.task_definition.container_definitions[0].linux_parameters.capabilities.drop #=> Array
resp.task_definition.container_definitions[0].linux_parameters.capabilities.drop[0] #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices #=> Array
resp.task_definition.container_definitions[0].linux_parameters.devices[0].host_path #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices[0].container_path #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices[0].permissions #=> Array
resp.task_definition.container_definitions[0].linux_parameters.devices[0].permissions[0] #=> String, one of "read", "write", "mknod"
resp.task_definition.container_definitions[0].linux_parameters.init_process_enabled #=> Boolean
resp.task_definition.container_definitions[0].linux_parameters.shared_memory_size #=> Integer
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
resp.task_definition.container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
resp.task_definition.container_definitions[0].start_timeout #=> Integer
resp.task_definition.container_definitions[0].stop_timeout #=> Integer
resp.task_definition.container_definitions[0].version_consistency #=> String, one of "enabled", "disabled"
resp.task_definition.container_definitions[0].hostname #=> String
resp.task_definition.container_definitions[0].user #=> String
resp.task_definition.container_definitions[0].working_directory #=> String
resp.task_definition.container_definitions[0].disable_networking #=> Boolean
resp.task_definition.container_definitions[0].privileged #=> Boolean
resp.task_definition.container_definitions[0].readonly_root_filesystem #=> Boolean
resp.task_definition.container_definitions[0].dns_servers #=> Array
resp.task_definition.container_definitions[0].dns_servers[0] #=> String
resp.task_definition.container_definitions[0].dns_search_domains #=> Array
resp.task_definition.container_definitions[0].dns_search_domains[0] #=> String
resp.task_definition.container_definitions[0].extra_hosts #=> Array
resp.task_definition.container_definitions[0].extra_hosts[0].hostname #=> String
resp.task_definition.container_definitions[0].extra_hosts[0].ip_address #=> String
resp.task_definition.container_definitions[0].docker_security_options #=> Array
resp.task_definition.container_definitions[0].docker_security_options[0] #=> String
resp.task_definition.container_definitions[0].interactive #=> Boolean
resp.task_definition.container_definitions[0].pseudo_terminal #=> Boolean
resp.task_definition.container_definitions[0].docker_labels #=> Hash
resp.task_definition.container_definitions[0].docker_labels["String"] #=> String
resp.task_definition.container_definitions[0].ulimits #=> Array
resp.task_definition.container_definitions[0].ulimits[0].name #=> String, one of "core", "cpu", "data", "fsize", "locks", "memlock", "msgqueue", "nice", "nofile", "nproc", "rss", "rtprio", "rttime", "sigpending", "stack"
resp.task_definition.container_definitions[0].ulimits[0].soft_limit #=> Integer
resp.task_definition.container_definitions[0].ulimits[0].hard_limit #=> Integer
resp.task_definition.container_definitions[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.task_definition.container_definitions[0].log_configuration.options #=> Hash
resp.task_definition.container_definitions[0].log_configuration.options["String"] #=> String
resp.task_definition.container_definitions[0].log_configuration.secret_options #=> Array
resp.task_definition.container_definitions[0].log_configuration.secret_options[0].name #=> String
resp.task_definition.container_definitions[0].log_configuration.secret_options[0].value_from #=> String
resp.task_definition.container_definitions[0].health_check.command #=> Array
resp.task_definition.container_definitions[0].health_check.command[0] #=> String
resp.task_definition.container_definitions[0].health_check.interval #=> Integer
resp.task_definition.container_definitions[0].health_check.timeout #=> Integer
resp.task_definition.container_definitions[0].health_check.retries #=> Integer
resp.task_definition.container_definitions[0].health_check.start_period #=> Integer
resp.task_definition.container_definitions[0].system_controls #=> Array
resp.task_definition.container_definitions[0].system_controls[0].namespace #=> String
resp.task_definition.container_definitions[0].system_controls[0].value #=> String
resp.task_definition.container_definitions[0].resource_requirements #=> Array
resp.task_definition.container_definitions[0].resource_requirements[0].value #=> String
resp.task_definition.container_definitions[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
resp.task_definition.container_definitions[0].firelens_configuration.type #=> String, one of "fluentd", "fluentbit"
resp.task_definition.container_definitions[0].firelens_configuration.options #=> Hash
resp.task_definition.container_definitions[0].firelens_configuration.options["String"] #=> String
resp.task_definition.container_definitions[0].credential_specs #=> Array
resp.task_definition.container_definitions[0].credential_specs[0] #=> String
resp.task_definition.family #=> String
resp.task_definition.task_role_arn #=> String
resp.task_definition.execution_role_arn #=> String
resp.task_definition.network_mode #=> String, one of "bridge", "host", "awsvpc", "none"
resp.task_definition.revision #=> Integer
resp.task_definition.volumes #=> Array
resp.task_definition.volumes[0].name #=> String
resp.task_definition.volumes[0].host.source_path #=> String
resp.task_definition.volumes[0].docker_volume_configuration.scope #=> String, one of "task", "shared"
resp.task_definition.volumes[0].docker_volume_configuration.autoprovision #=> Boolean
resp.task_definition.volumes[0].docker_volume_configuration.driver #=> String
resp.task_definition.volumes[0].docker_volume_configuration.driver_opts #=> Hash
resp.task_definition.volumes[0].docker_volume_configuration.driver_opts["String"] #=> String
resp.task_definition.volumes[0].docker_volume_configuration.labels #=> Hash
resp.task_definition.volumes[0].docker_volume_configuration.labels["String"] #=> String
resp.task_definition.volumes[0].efs_volume_configuration.file_system_id #=> String
resp.task_definition.volumes[0].efs_volume_configuration.root_directory #=> String
resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.file_system_id #=> String
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.root_directory #=> String
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.authorization_config.credentials_parameter #=> String
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.authorization_config.domain #=> String
resp.task_definition.volumes[0].configured_at_launch #=> Boolean
resp.task_definition.status #=> String, one of "ACTIVE", "INACTIVE", "DELETE_IN_PROGRESS"
resp.task_definition.requires_attributes #=> Array
resp.task_definition.requires_attributes[0].name #=> String
resp.task_definition.requires_attributes[0].value #=> String
resp.task_definition.requires_attributes[0].target_type #=> String, one of "container-instance"
resp.task_definition.requires_attributes[0].target_id #=> String
resp.task_definition.placement_constraints #=> Array
resp.task_definition.placement_constraints[0].type #=> String, one of "memberOf"
resp.task_definition.placement_constraints[0].expression #=> String
resp.task_definition.compatibilities #=> Array
resp.task_definition.compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_definition.runtime_platform.cpu_architecture #=> String, one of "X86_64", "ARM64"
resp.task_definition.runtime_platform.operating_system_family #=> String, one of "WINDOWS_SERVER_2019_FULL", "WINDOWS_SERVER_2019_CORE", "WINDOWS_SERVER_2016_FULL", "WINDOWS_SERVER_2004_CORE", "WINDOWS_SERVER_2022_CORE", "WINDOWS_SERVER_2022_FULL", "WINDOWS_SERVER_20H2_CORE", "LINUX"
resp.task_definition.requires_compatibilities #=> Array
resp.task_definition.requires_compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_definition.cpu #=> String
resp.task_definition.memory #=> String
resp.task_definition.inference_accelerators #=> Array
resp.task_definition.inference_accelerators[0].device_name #=> String
resp.task_definition.inference_accelerators[0].device_type #=> String
resp.task_definition.pid_mode #=> String, one of "host", "task"
resp.task_definition.ipc_mode #=> String, one of "host", "task", "none"
resp.task_definition.proxy_configuration.type #=> String, one of "APPMESH"
resp.task_definition.proxy_configuration.container_name #=> String
resp.task_definition.proxy_configuration.properties #=> Array
resp.task_definition.proxy_configuration.properties[0].name #=> String
resp.task_definition.proxy_configuration.properties[0].value #=> String
resp.task_definition.registered_at #=> Time
resp.task_definition.deregistered_at #=> Time
resp.task_definition.registered_by #=> String
resp.task_definition.ephemeral_storage.size_in_gi_b #=> Integer
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_definition (required, String) —

    The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.

  • :include (Array<String>) —

    Determines whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

Returns:

See Also:



4459
4460
4461
4462
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4459

def describe_task_definition(params = {}, options = {})
  req = build_request(:describe_task_definition, params)
  req.send_request(options)
end

#describe_task_sets(params = {}) ⇒ Types::DescribeTaskSetsResponse

Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_task_sets({
  cluster: "String", # required
  service: "String", # required
  task_sets: ["String"],
  include: ["TAGS"], # accepts TAGS
})

Response structure


resp.task_sets #=> Array
resp.task_sets[0].id #=> String
resp.task_sets[0].task_set_arn #=> String
resp.task_sets[0].service_arn #=> String
resp.task_sets[0].cluster_arn #=> String
resp.task_sets[0].started_by #=> String
resp.task_sets[0].external_id #=> String
resp.task_sets[0].status #=> String
resp.task_sets[0].task_definition #=> String
resp.task_sets[0].computed_desired_count #=> Integer
resp.task_sets[0].pending_count #=> Integer
resp.task_sets[0].running_count #=> Integer
resp.task_sets[0].created_at #=> Time
resp.task_sets[0].updated_at #=> Time
resp.task_sets[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_sets[0].capacity_provider_strategy #=> Array
resp.task_sets[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.task_sets[0].capacity_provider_strategy[0].weight #=> Integer
resp.task_sets[0].capacity_provider_strategy[0].base #=> Integer
resp.task_sets[0].platform_version #=> String
resp.task_sets[0].platform_family #=> String
resp.task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.task_sets[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.task_sets[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.task_sets[0].load_balancers #=> Array
resp.task_sets[0].load_balancers[0].target_group_arn #=> String
resp.task_sets[0].load_balancers[0].load_balancer_name #=> String
resp.task_sets[0].load_balancers[0].container_name #=> String
resp.task_sets[0].load_balancers[0].container_port #=> Integer
resp.task_sets[0].service_registries #=> Array
resp.task_sets[0].service_registries[0].registry_arn #=> String
resp.task_sets[0].service_registries[0].port #=> Integer
resp.task_sets[0].service_registries[0].container_name #=> String
resp.task_sets[0].service_registries[0].container_port #=> Integer
resp.task_sets[0].scale.value #=> Float
resp.task_sets[0].scale.unit #=> String, one of "PERCENT"
resp.task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.task_sets[0].stability_status_at #=> Time
resp.task_sets[0].tags #=> Array
resp.task_sets[0].tags[0].key #=> String
resp.task_sets[0].tags[0].value #=> String
resp.task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (required, String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

  • :service (required, String) —

    The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.

  • :task_sets (Array<String>) —

    The ID or full Amazon Resource Name (ARN) of task sets to describe.

  • :include (Array<String>) —

    Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

Returns:

See Also:



4558
4559
4560
4561
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4558

def describe_task_sets(params = {}, options = {})
  req = build_request(:describe_task_sets, params)
  req.send_request(options)
end

#describe_tasks(params = {}) ⇒ Types::DescribeTasksResponse

Describes a specified task or tasks.

Currently, stopped tasks appear in the returned results for at least one hour.

If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • tasks_running
  • tasks_stopped

Examples:

Example: To describe a task


# This example provides a description of the specified task, using the task UUID as an identifier.

resp = client.describe_tasks({
  tasks: [
    "c5cba4eb-5dad-405e-96db-71ef8eefe6a8", 
  ], 
})

resp.to_h outputs the following:
{
  failures: [
  ], 
  tasks: [
    {
      cluster_arn: "arn:aws:ecs:<region>:<aws_account_id>:cluster/default", 
      container_instance_arn: "arn:aws:ecs:<region>:<aws_account_id>:container-instance/default/18f9eda5-27d7-4c19-b133-45adc516e8fb", 
      containers: [
        {
          name: "ecs-demo", 
          container_arn: "arn:aws:ecs:<region>:<aws_account_id>:container/7c01765b-c588-45b3-8290-4ba38bd6c5a6", 
          last_status: "RUNNING", 
          network_bindings: [
            {
              bind_ip: "0.0.0.0", 
              container_port: 80, 
              host_port: 80, 
            }, 
          ], 
          task_arn: "arn:aws:ecs:<region>:<aws_account_id>:task/default/c5cba4eb-5dad-405e-96db-71ef8eefe6a8", 
        }, 
      ], 
      desired_status: "RUNNING", 
      last_status: "RUNNING", 
      overrides: {
        container_overrides: [
          {
            name: "ecs-demo", 
          }, 
        ], 
      }, 
      started_by: "ecs-svc/9223370608528463088", 
      task_arn: "arn:aws:ecs:<region>:<aws_account_id>:task/default/c5cba4eb-5dad-405e-96db-71ef8eefe6a8", 
      task_definition_arn: "arn:aws:ecs:<region>:<aws_account_id>:task-definition/amazon-ecs-sample:1", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_tasks({
  cluster: "String",
  tasks: ["String"], # required
  include: ["TAGS"], # accepts TAGS
})

Response structure


resp.tasks #=> Array
resp.tasks[0].attachments #=> Array
resp.tasks[0].attachments[0].id #=> String
resp.tasks[0].attachments[0].type #=> String
resp.tasks[0].attachments[0].status #=> String
resp.tasks[0].attachments[0].details #=> Array
resp.tasks[0].attachments[0].details[0].name #=> String
resp.tasks[0].attachments[0].details[0].value #=> String
resp.tasks[0].attributes #=> Array
resp.tasks[0].attributes[0].name #=> String
resp.tasks[0].attributes[0].value #=> String
resp.tasks[0].attributes[0].target_type #=> String, one of "container-instance"
resp.tasks[0].attributes[0].target_id #=> String
resp.tasks[0].availability_zone #=> String
resp.tasks[0].capacity_provider_name #=> String
resp.tasks[0].cluster_arn #=> String
resp.tasks[0].connectivity #=> String, one of "CONNECTED", "DISCONNECTED"
resp.tasks[0].connectivity_at #=> Time
resp.tasks[0].container_instance_arn #=> String
resp.tasks[0].containers #=> Array
resp.tasks[0].containers[0].container_arn #=> String
resp.tasks[0].containers[0].task_arn #=> String
resp.tasks[0].containers[0].name #=> String
resp.tasks[0].containers[0].image #=> String
resp.tasks[0].containers[0].image_digest #=> String
resp.tasks[0].containers[0].runtime_id #=> String
resp.tasks[0].containers[0].last_status #=> String
resp.tasks[0].containers[0].exit_code #=> Integer
resp.tasks[0].containers[0].reason #=> String
resp.tasks[0].containers[0].network_bindings #=> Array
resp.tasks[0].containers[0].network_bindings[0].bind_ip #=> String
resp.tasks[0].containers[0].network_bindings[0].container_port #=> Integer
resp.tasks[0].containers[0].network_bindings[0].host_port #=> Integer
resp.tasks[0].containers[0].network_bindings[0].protocol #=> String, one of "tcp", "udp"
resp.tasks[0].containers[0].network_bindings[0].container_port_range #=> String
resp.tasks[0].containers[0].network_bindings[0].host_port_range #=> String
resp.tasks[0].containers[0].network_interfaces #=> Array
resp.tasks[0].containers[0].network_interfaces[0].attachment_id #=> String
resp.tasks[0].containers[0].network_interfaces[0].private_ipv_4_address #=> String
resp.tasks[0].containers[0].network_interfaces[0].ipv6_address #=> String
resp.tasks[0].containers[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
resp.tasks[0].containers[0].managed_agents #=> Array
resp.tasks[0].containers[0].managed_agents[0].last_started_at #=> Time
resp.tasks[0].containers[0].managed_agents[0].name #=> String, one of "ExecuteCommandAgent"
resp.tasks[0].containers[0].managed_agents[0].reason #=> String
resp.tasks[0].containers[0].managed_agents[0].last_status #=> String
resp.tasks[0].containers[0].cpu #=> String
resp.tasks[0].containers[0].memory #=> String
resp.tasks[0].containers[0].memory_reservation #=> String
resp.tasks[0].containers[0].gpu_ids #=> Array
resp.tasks[0].containers[0].gpu_ids[0] #=> String
resp.tasks[0].cpu #=> String
resp.tasks[0].created_at #=> Time
resp.tasks[0].desired_status #=> String
resp.tasks[0].enable_execute_command #=> Boolean
resp.tasks[0].execution_stopped_at #=> Time
resp.tasks[0].group #=> String
resp.tasks[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
resp.tasks[0].inference_accelerators #=> Array
resp.tasks[0].inference_accelerators[0].device_name #=> String
resp.tasks[0].inference_accelerators[0].device_type #=> String
resp.tasks[0].last_status #=> String
resp.tasks[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.tasks[0].memory #=> String
resp.tasks[0].overrides.container_overrides #=> Array
resp.tasks[0].overrides.container_overrides[0].name #=> String
resp.tasks[0].overrides.container_overrides[0].command #=> Array
resp.tasks[0].overrides.container_overrides[0].command[0] #=> String
resp.tasks[0].overrides.container_overrides[0].environment #=> Array
resp.tasks[0].overrides.container_overrides[0].environment[0].name #=> String
resp.tasks[0].overrides.container_overrides[0].environment[0].value #=> String
resp.tasks[0].overrides.container_overrides[0].environment_files #=> Array
resp.tasks[0].overrides.container_overrides[0].environment_files[0].value #=> String
resp.tasks[0].overrides.container_overrides[0].environment_files[0].type #=> String, one of "s3"
resp.tasks[0].overrides.container_overrides[0].cpu #=> Integer
resp.tasks[0].overrides.container_overrides[0].memory #=> Integer
resp.tasks[0].overrides.container_overrides[0].memory_reservation #=> Integer
resp.tasks[0].overrides.container_overrides[0].resource_requirements #=> Array
resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].value #=> String
resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
resp.tasks[0].overrides.cpu #=> String
resp.tasks[0].overrides.inference_accelerator_overrides #=> Array
resp.tasks[0].overrides.inference_accelerator_overrides[0].device_name #=> String
resp.tasks[0].overrides.inference_accelerator_overrides[0].device_type #=> String
resp.tasks[0].overrides.execution_role_arn #=> String
resp.tasks[0].overrides.memory #=> String
resp.tasks[0].overrides.task_role_arn #=> String
resp.tasks[0].overrides.ephemeral_storage.size_in_gi_b #=> Integer
resp.tasks[0].platform_version #=> String
resp.tasks[0].platform_family #=> String
resp.tasks[0].pull_started_at #=> Time
resp.tasks[0].pull_stopped_at #=> Time
resp.tasks[0].started_at #=> Time
resp.tasks[0].started_by #=> String
resp.tasks[0].stop_code #=> String, one of "TaskFailedToStart", "EssentialContainerExited", "UserInitiated", "ServiceSchedulerInitiated", "SpotInterruption", "TerminationNotice"
resp.tasks[0].stopped_at #=> Time
resp.tasks[0].stopped_reason #=> String
resp.tasks[0].stopping_at #=> Time
resp.tasks[0].tags #=> Array
resp.tasks[0].tags[0].key #=> String
resp.tasks[0].tags[0].value #=> String
resp.tasks[0].task_arn #=> String
resp.tasks[0].task_definition_arn #=> String
resp.tasks[0].version #=> Integer
resp.tasks[0].ephemeral_storage.size_in_gi_b #=> Integer
resp.tasks[0].fargate_ephemeral_storage.size_in_gi_b #=> Integer
resp.tasks[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

  • :tasks (required, Array<String>) —

    A list of up to 100 task IDs or full ARN entries.

  • :include (Array<String>) —

    Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

Returns:

See Also:



4775
4776
4777
4778
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4775

def describe_tasks(params = {}, options = {})
  req = build_request(:describe_tasks, params)
  req.send_request(options)
end

#discover_poll_endpoint(params = {}) ⇒ Types::DiscoverPollEndpointResponse

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon ECS agent to poll for updates.

Examples:

Request syntax with placeholder values


resp = client.discover_poll_endpoint({
  container_instance: "String",
  cluster: "String",
})

Response structure


resp.endpoint #=> String
resp.telemetry_endpoint #=> String
resp.service_connect_endpoint #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :container_instance (String) —

    The container instance ID or full ARN of the container instance. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs to.

Returns:

See Also:



4823
4824
4825
4826
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4823

def discover_poll_endpoint(params = {}, options = {})
  req = build_request(:discover_poll_endpoint, params)
  req.send_request(options)
end

#execute_command(params = {}) ⇒ Types::ExecuteCommandResponse

Runs a command remotely on a container within a task.

If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you receive an AccessDeniedException when there is a mismatch between the condition key value and the corresponding parameter value.

For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.execute_command({
  cluster: "String",
  container: "String",
  command: "String", # required
  interactive: false, # required
  task: "String", # required
})

Response structure


resp.cluster_arn #=> String
resp.container_arn #=> String
resp.container_name #=> String
resp.interactive #=> Boolean
resp.session.session_id #=> String
resp.session.stream_url #=> String
resp.session.token_value #=> String
resp.task_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.

  • :container (String) —

    The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.

  • :command (required, String) —

    The command to run on the container.

  • :interactive (required, Boolean) —

    Use this flag to run your command in interactive mode.

  • :task (required, String) —

    The Amazon Resource Name (ARN) or ID of the task the container is part of.

Returns:

See Also:



4897
4898
4899
4900
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4897

def execute_command(params = {}, options = {})
  req = build_request(:execute_command, params)
  req.send_request(options)
end

#get_task_protection(params = {}) ⇒ Types::GetTaskProtectionResponse

Retrieves the protection status of tasks in an Amazon ECS service.

Examples:

Example: To get the protection status of a task


# In this example, we get the protection status for a single task.

resp = client.get_task_protection({
  cluster: "test-task-protection", 
  tasks: [
    "b8b1cf532d0e46ba8d44a40d1de16772", 
  ], 
})

resp.to_h outputs the following:
{
  failures: [
  ], 
  protected_tasks: [
    {
      expiration_date: Time.parse("2022-11-02T06:56:32.553Z"), 
      protection_enabled: true, 
      task_arn: "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.get_task_protection({
  cluster: "String", # required
  tasks: ["String"],
})

Response structure


resp.protected_tasks #=> Array
resp.protected_tasks[0].task_arn #=> String
resp.protected_tasks[0].protection_enabled #=> Boolean
resp.protected_tasks[0].expiration_date #=> Time
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (required, String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

  • :tasks (Array<String>) —

    A list of up to 100 task IDs or full ARN entries.

Returns:

See Also:



4963
4964
4965
4966
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4963

def get_task_protection(params = {}, options = {})
  req = build_request(:get_task_protection, params)
  req.send_request(options)
end

#list_account_settings(params = {}) ⇒ Types::ListAccountSettingsResponse

Lists the account settings for a specified principal.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To view your effective account settings


# This example displays the effective account settings for your account.

resp = client.({
  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: 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.({
  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", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.({
  name: "serviceLongArnFormat", # accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat, awsvpcTrunking, containerInsights, fargateFIPSMode, tagResourceAuthorization, fargateTaskRetirementWaitPeriod, guardDutyActivate
  value: "String",
  principal_arn: "String",
  effective_settings: false,
  next_token: "String",
  max_results: 1,
})

Response structure


resp.settings #=> Array
resp.settings[0].name #=> String, one of "serviceLongArnFormat", "taskLongArnFormat", "containerInstanceLongArnFormat", "awsvpcTrunking", "containerInsights", "fargateFIPSMode", "tagResourceAuthorization", "fargateTaskRetirementWaitPeriod", "guardDutyActivate"
resp.settings[0].value #=> String
resp.settings[0].principal_arn #=> String
resp.settings[0].type #=> String, one of "user", "aws_managed"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (String) —

    The name of the account setting you want to list the settings for.

  • :value (String) —

    The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.

  • :principal_arn (String) —

    The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

    Federated users assume the account setting of the root user and can't have explicit account settings set for them.

  • :effective_settings (Boolean) —

    Determines whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they're set. Otherwise, no account settings are returned.

  • :next_token (String) —

    The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

  • :max_results (Integer) —

    The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter isn't used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

Returns:

See Also:



5108
5109
5110
5111
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 5108

def (params = {}, options = {})
  req = build_request(:list_account_settings, params)
  req.send_request(options)
end

#list_attributes(params = {}) ⇒ Types::ListAttributesResponse

Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes 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 (ecs.os-type=linux).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_attributes({
  cluster: "String",
  target_type: "container-instance", # required, accepts container-instance
  attribute_name: "String",
  attribute_value: "String",
  next_token: "String",
  max_results: 1,
})

Response structure


resp.attributes #=> Array
resp.attributes[0].name #=> String
resp.attributes[0].value #=> String
resp.attributes[0].target_type #=> String, one of "container-instance"
resp.attributes[0].target_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

  • :target_type (required, String) —

    The type of the target to list attributes with.

  • :attribute_name (String) —

    The name of the attribute to filter the results with.

  • :attribute_value (String) —

    The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.

  • :next_token (String) —

    The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

  • :max_results (Integer) —

    The maximum number of cluster results that ListAttributes returned in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

Returns:

See Also:



5190
5191
5192
5193
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 5190

def list_attributes(params = {}, options = {})
  req = build_request(:list_attributes, params)
  req.send_request(options)
end

#list_clusters(params = {}) ⇒ Types::ListClustersResponse

Returns a list of existing clusters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list your available clusters


# This example lists all of your available clusters in your default region.

resp = client.list_clusters({
})

resp.to_h outputs the following:
{
  cluster_arns: [
    "arn:aws:ecs:us-east-1:<aws_account_id>:cluster/test", 
    "arn:aws:ecs:us-east-1:<aws_account_id>:cluster/default", 
  ], 
}

Request syntax with placeholder values


resp = client.list_clusters({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.cluster_arns #=> Array
resp.cluster_arns[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The nextToken value returned from a ListClusters request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

  • :max_results (Integer) —

    The maximum number of cluster results that ListClusters returned in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListClusters returns up to 100 results and a nextToken value if applicable.

Returns:

See Also:



5259
5260
5261
5262
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 5259

def list_clusters(params = {}, options = {})
  req = build_request(:list_clusters, params)
  req.send_request(options)
end

#list_container_instances(params = {}) ⇒ Types::ListContainerInstancesResponse

Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list your available container instances in a cluster


# This example lists all of your available container instances in the specified cluster in your default region.

resp = client.list_container_instances({
  cluster: "default", 
})

resp.to_h outputs the following:
{
  container_instance_arns: [
    "arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/default/f6bbb147-5370-4ace-8c73-c7181ded911f", 
    "arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/default/ffe3d344-77e2-476c-a4d0-bf560ad50acb", 
  ], 
}

Request syntax with placeholder values


resp = client.list_container_instances({
  cluster: "String",
  filter: "String",
  next_token: "String",
  max_results: 1,
  status: "ACTIVE", # accepts ACTIVE, DRAINING, REGISTERING, DEREGISTERING, REGISTRATION_FAILED
})

Response structure


resp.container_instance_arns #=> Array
resp.container_instance_arns[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    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.

  • :filter (String) —

    You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

  • :next_token (String) —

    The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

  • :max_results (Integer) —

    The maximum number of container instance results that ListContainerInstances returned in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

  • :status (String) —

    Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you don't specify this parameter, the default is to include container instances set to all states other than INACTIVE.

Returns:

See Also:



5368
5369
5370
5371
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 5368

def list_container_instances(params = {}, options = {})
  req = build_request(:list_container_instances, params)
  req.send_request(options)
end

#list_service_deployments(params = {}) ⇒ Types::ListServiceDeploymentsResponse

This operation lists all the service deployments that meet the specified filter criteria.

A service deployment happens when you release a softwre update for the service. You route traffic from the running service revisions to the new service revison and control the number of running tasks.

This API returns the values that you use for the request parameters in DescribeServiceRevisions.

Examples:

Request syntax with placeholder values


resp = client.list_service_deployments({
  service: "String", # required
  cluster: "String",
  status: ["PENDING"], # accepts PENDING, SUCCESSFUL, STOPPED, STOP_REQUESTED, IN_PROGRESS, ROLLBACK_IN_PROGRESS, ROLLBACK_SUCCESSFUL, ROLLBACK_FAILED
  created_at: {
    before: Time.now,
    after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.service_deployments #=> Array
resp.service_deployments[0].service_deployment_arn #=> String
resp.service_deployments[0].service_arn #=> String
resp.service_deployments[0].cluster_arn #=> String
resp.service_deployments[0].started_at #=> Time
resp.service_deployments[0].created_at #=> Time
resp.service_deployments[0].finished_at #=> Time
resp.service_deployments[0].target_service_revision_arn #=> String
resp.service_deployments[0].status #=> String, one of "PENDING", "SUCCESSFUL", "STOPPED", "STOP_REQUESTED", "IN_PROGRESS", "ROLLBACK_IN_PROGRESS", "ROLLBACK_SUCCESSFUL", "ROLLBACK_FAILED"
resp.service_deployments[0].status_reason #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :service (required, String) —

    The ARN or name of the service

  • :cluster (String) —

    The cluster that hosts the service. This can either be the cluster name or ARN. Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performanceIf you don't specify a cluster, deault is used.

  • :status (Array<String>) —

    An optional filter you can use to narrow the results. If you do not specify a status, then all status values are included in the result.

  • :created_at (Types::CreatedAt) —

    An optional filter you can use to narrow the results by the service creation date. If you do not specify a value, the result includes all services created before the current time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

  • :next_token (String) —

    The nextToken value returned from a ListServiceDeployments request indicating that more results are available to fulfill the request and further calls are needed. If you provided maxResults, it's possible the number of results is fewer than maxResults.

  • :max_results (Integer) —

    The maximum number of service deployment results that ListServiceDeployments returned in paginated output. When this parameter is used, ListServiceDeployments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServiceDeployments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServiceDeployments returns up to 20 results and a nextToken value if applicable.

Returns:

See Also:



5462
5463
5464
5465
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 5462

def list_service_deployments(params = {}, options = {})
  req = build_request(:list_service_deployments, params)
  req.send_request(options)
end

#list_services(params = {}) ⇒ Types::ListServicesResponse

Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list the services in a cluster


# This example lists the services running in the default cluster for an account.

resp = client.list_services({
})

resp.to_h outputs the following:
{
  service_arns: [
    "arn:aws:ecs:us-east-1:012345678910:service/default/my-http-service", 
  ], 
}

Request syntax with placeholder values


resp = client.list_services({
  cluster: "String",
  next_token: "String",
  max_results: 1,
  launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
  scheduling_strategy: "REPLICA", # accepts REPLICA, DAEMON
})

Response structure


resp.service_arns #=> Array
resp.service_arns[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.

  • :next_token (String) —

    The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

  • :max_results (Integer) —

    The maximum number of service results that ListServices returned in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a nextToken value if applicable.

  • :launch_type (String) —

    The launch type to use when filtering the ListServices results.

  • :scheduling_strategy (String) —

    The scheduling strategy to use when filtering the ListServices results.

Returns:

See Also:



5546
5547
5548
5549
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 5546

def list_services(params = {}, options = {})
  req = build_request(:list_services, params)
  req.send_request(options)
end

#list_services_by_namespace(params = {}) ⇒ Types::ListServicesByNamespaceResponse

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, ListServices 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 ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_services_by_namespace({
  namespace: "String", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.service_arns #=> Array
resp.service_arns[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :namespace (required, String) —

    The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.

    Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

  • :next_token (String) —

    The nextToken value that's returned from a ListServicesByNamespace request. It indicates that more results are available to fulfill the request and further calls are needed. If maxResults is returned, it is possible the number of results is less than maxResults.

  • :max_results (Integer) —

    The maximum number of service results that ListServicesByNamespace returns in paginated output. When this parameter is used, ListServicesByNamespace only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServicesByNamespace request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServicesByNamespace returns up to 10 results and a nextToken value if applicable.

Returns:

See Also:



5622
5623
5624
5625
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 5622

def list_services_by_namespace(params = {}, options = {})
  req = build_request(:list_services_by_namespace, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

List the tags for an Amazon ECS resource.

Examples:

Example: To list the tags for a cluster.


# This example lists the tags for the 'dev' cluster.

resp = client.list_tags_for_resource({
  resource_arn: "arn:aws:ecs:region:aws_account_id:cluster/dev", 
})

resp.to_h outputs the following:
{
  tags: [
    {
      key: "team", 
      value: "dev", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

Returns:

See Also:



5673
5674
5675
5676
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 5673

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_task_definition_families(params = {}) ⇒ Types::ListTaskDefinitionFamiliesResponse

Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE task definition revisions.

You can filter out task definition families that don't contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list your registered task definition families


# This example lists all of your registered task definition families.

resp = client.list_task_definition_families({
})

resp.to_h outputs the following:
{
  families: [
    "node-js-app", 
    "web-timer", 
    "hpcc", 
    "hpcc-c4-8xlarge", 
  ], 
}

Example: To filter your registered task definition families


# This example lists the task definition revisions that start with "hpcc".

resp = client.list_task_definition_families({
  family_prefix: "hpcc", 
})

resp.to_h outputs the following:
{
  families: [
    "hpcc", 
    "hpcc-c4-8xlarge", 
  ], 
}

Request syntax with placeholder values


resp = client.list_task_definition_families({
  family_prefix: "String",
  status: "ACTIVE", # accepts ACTIVE, INACTIVE, ALL
  next_token: "String",
  max_results: 1,
})

Response structure


resp.families #=> Array
resp.families[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :family_prefix (String) —

    The familyPrefix is a string that's used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

  • :status (String) —

    The task definition family status to filter the ListTaskDefinitionFamilies results with. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

  • :next_token (String) —

    The nextToken value returned from a ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

  • :max_results (Integer) —

    The maximum number of task definition family results that ListTaskDefinitionFamilies returned in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

Returns:

See Also:



5788
5789
5790
5791
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 5788

def list_task_definition_families(params = {}, options = {})
  req = build_request(:list_task_definition_families, params)
  req.send_request(options)
end

#list_task_definitions(params = {}) ⇒ Types::ListTaskDefinitionsResponse

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list your registered task definitions


# This example lists all of your registered task definitions.

resp = client.list_task_definitions({
})

resp.to_h outputs the following:
{
  task_definition_arns: [
    "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep300:2", 
    "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1", 
    "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:3", 
    "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:4", 
    "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:5", 
    "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:6", 
  ], 
}

Example: To list the registered task definitions in a family


# This example lists the task definition revisions of a specified family.

resp = client.list_task_definitions({
  family_prefix: "wordpress", 
})

resp.to_h outputs the following:
{
  task_definition_arns: [
    "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:3", 
    "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:4", 
    "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:5", 
    "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:6", 
  ], 
}

Request syntax with placeholder values


resp = client.list_task_definitions({
  family_prefix: "String",
  status: "ACTIVE", # accepts ACTIVE, INACTIVE, DELETE_IN_PROGRESS
  sort: "ASC", # accepts ASC, DESC
  next_token: "String",
  max_results: 1,
})

Response structure


resp.task_definition_arns #=> Array
resp.task_definition_arns[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :family_prefix (String) —

    The full family name to filter the ListTaskDefinitions results with. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

  • :status (String) —

    The task definition status to filter the ListTaskDefinitions results with. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

  • :sort (String) —

    The order to sort the results in. Valid values are ASC and DESC. By default, (ASC) task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision. This is so that the newest task definitions in a family are listed first.

  • :next_token (String) —

    The nextToken value returned from a ListTaskDefinitions request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

  • :max_results (Integer) —

    The maximum number of task definition results that ListTaskDefinitions returned in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

Returns:

See Also:



5907
5908
5909
5910
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 5907

def list_task_definitions(params = {}, options = {})
  req = build_request(:list_task_definitions, params)
  req.send_request(options)
end

#list_tasks(params = {}) ⇒ Types::ListTasksResponse

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.

Recently stopped tasks might appear in the returned results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To list the tasks in a cluster


# This example lists all of the tasks in a cluster.

resp = client.list_tasks({
  cluster: "default", 
})

resp.to_h outputs the following:
{
  task_arns: [
    "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84", 
    "arn:aws:ecs:us-east-1:012345678910:task/default/6b809ef6-c67e-4467-921f-ee261c15a0a1", 
  ], 
}

Example: To list the tasks on a particular container instance


# 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.

resp = client.list_tasks({
  cluster: "default", 
  container_instance: "f6bbb147-5370-4ace-8c73-c7181ded911f", 
})

resp.to_h outputs the following:
{
  task_arns: [
    "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84", 
  ], 
}

Request syntax with placeholder values


resp = client.list_tasks({
  cluster: "String",
  container_instance: "String",
  family: "String",
  next_token: "String",
  max_results: 1,
  started_by: "String",
  service_name: "String",
  desired_status: "RUNNING", # accepts RUNNING, PENDING, STOPPED
  launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
})

Response structure


resp.task_arns #=> Array
resp.task_arns[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

  • :container_instance (String) —

    The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

  • :family (String) —

    The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

  • :next_token (String) —

    The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

  • :max_results (Integer) —

    The maximum number of task results that ListTasks returned in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTasks returns up to 100 results and a nextToken value if applicable.

  • :started_by (String) —

    The startedBy value to filter the task results with. Specifying a startedBy value limits the results to tasks that were started with that value.

    When you specify startedBy as the filter, it must be the only filter that you use.

  • :service_name (String) —

    The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

  • :desired_status (String) —

    The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that aren't starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

    Although you can filter results based on a desired status of PENDING, this doesn't return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

  • :launch_type (String) —

    The launch type to use when filtering the ListTasks results.

Returns:

See Also:



6052
6053
6054
6055
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 6052

def list_tasks(params = {}, options = {})
  req = build_request(:list_tasks, params)
  req.send_request(options)
end

#put_account_setting(params = {}) ⇒ Types::PutAccountSettingResponse

Modifies an account setting. Account settings are set on a per-Region basis.

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 Account Settings in the Amazon Elastic Container Service Developer Guide.

Examples:

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.({
  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: 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.({
  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", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat, awsvpcTrunking, containerInsights, fargateFIPSMode, tagResourceAuthorization, fargateTaskRetirementWaitPeriod, guardDutyActivate
  value: "String", # required
  principal_arn: "String",
})

Response structure


resp.setting.name #=> String, one of "serviceLongArnFormat", "taskLongArnFormat", "containerInstanceLongArnFormat", "awsvpcTrunking", "containerInsights", "fargateFIPSMode", "tagResourceAuthorization", "fargateTaskRetirementWaitPeriod", "guardDutyActivate"
resp.setting.value #=> String
resp.setting.principal_arn #=> String
resp.setting.type #=> String, one of "user", "aws_managed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The Amazon ECS account setting name to modify.

    The following are the valid values for the account setting name.

    • serviceLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, 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 resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.

    • taskLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, 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 resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.

    • containerInstanceLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, 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 resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.

    • awsvpcTrunking - When modified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.

    • containerInsights - When modified, the default setting indicating whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If containerInsights is turned on, any new clusters that are created will have Container Insights turned on unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.

    • dualStackIPv6 - When turned on, when using a VPC in dual stack mode, your tasks using the awsvpc network mode can have an IPv6 address assigned. For more information on using IPv6 with tasks launched on Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6 with tasks launched on Fargate, see Using a VPC in dual-stack mode.

    • fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.

    • tagResourceAuthorization - Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide.

    • guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

  • :value (required, String) —

    The account setting value for the specified principal ARN. Accepted values are enabled, disabled, on, and off.

    When you specify fargateTaskRetirementWaitPeriod for the name, the following are the valid values:

    • 0 - Amazon Web Services sends the notification, and immediately retires the affected tasks.

    • 7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the tasks.

    • 14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the tasks.

  • :principal_arn (String) —

    The ARN of the principal, which can be a user, role, or the root user. If you specify the root user, it modifies the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

    You must use the root user when you set the Fargate wait time (fargateTaskRetirementWaitPeriod).

    Federated users assume the account setting of the root user and can't have explicit account settings set for them.

Returns:

See Also:



6256
6257
6258
6259
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 6256

def (params = {}, options = {})
  req = build_request(:put_account_setting, params)
  req.send_request(options)
end

#put_account_setting_default(params = {}) ⇒ Types::PutAccountSettingDefaultResponse

Modifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.

Examples:

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.({
  name: "serviceLongArnFormat", 
  value: "enabled", 
})

resp.to_h outputs the following:
{
  setting: {
    name: "serviceLongArnFormat", 
    value: "enabled", 
    principal_arn: "arn:aws:iam::<aws_account_id>:root", 
  }, 
}

Request syntax with placeholder values


resp = client.({
  name: "serviceLongArnFormat", # required, accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat, awsvpcTrunking, containerInsights, fargateFIPSMode, tagResourceAuthorization, fargateTaskRetirementWaitPeriod, guardDutyActivate
  value: "String", # required
})

Response structure


resp.setting.name #=> String, one of "serviceLongArnFormat", "taskLongArnFormat", "containerInstanceLongArnFormat", "awsvpcTrunking", "containerInsights", "fargateFIPSMode", "tagResourceAuthorization", "fargateTaskRetirementWaitPeriod", "guardDutyActivate"
resp.setting.value #=> String
resp.setting.principal_arn #=> String
resp.setting.type #=> String, one of "user", "aws_managed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The resource name for which to modify the account setting.

    The following are the valid values for the account setting name.

    • serviceLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, 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 resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.

    • taskLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, 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 resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.

    • containerInstanceLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, 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 resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.

    • awsvpcTrunking - When modified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.

    • containerInsights - When modified, the default setting indicating whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If containerInsights is turned on, any new clusters that are created will have Container Insights turned on unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.

    • dualStackIPv6 - When turned on, when using a VPC in dual stack mode, your tasks using the awsvpc network mode can have an IPv6 address assigned. For more information on using IPv6 with tasks launched on Amazon EC2 instances, see Using a VPC in dual-stack mode. For more information on using IPv6 with tasks launched on Fargate, see Using a VPC in dual-stack mode.

    • fargateFIPSMode - If you specify fargateFIPSMode, Fargate FIPS 140 compliance is affected.

    • fargateTaskRetirementWaitPeriod - When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.

    • tagResourceAuthorization - Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide.

    • guardDutyActivate - The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

  • :value (required, String) —

    The account setting value for the specified principal ARN. Accepted values are enabled, disabled, on, and off.

    When you specify fargateTaskRetirementWaitPeriod for the name, the following are the valid values:

    • 0 - Amazon Web Services sends the notification, and immediately retires the affected tasks.

    • 7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the tasks.

    • 14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the tasks.

Returns:

See Also:



6418
6419
6420
6421
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 6418

def (params = {}, options = {})
  req = build_request(:put_account_setting_default, params)
  req.send_request(options)
end

#put_attributes(params = {}) ⇒ Types::PutAttributesResponse

Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.put_attributes({
  cluster: "String",
  attributes: [ # required
    {
      name: "String", # required
      value: "String",
      target_type: "container-instance", # accepts container-instance
      target_id: "String",
    },
  ],
})

Response structure


resp.attributes #=> Array
resp.attributes[0].name #=> String
resp.attributes[0].value #=> String
resp.attributes[0].target_type #=> String, one of "container-instance"
resp.attributes[0].target_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    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.

  • :attributes (required, Array<Types::Attribute>) —

    The attributes to apply to your resource. You can specify up to 10 custom attributes for each resource. You can specify up to 10 attributes in a single call.

Returns:

See Also:



6474
6475
6476
6477
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 6474

def put_attributes(params = {}, options = {})
  req = build_request(:put_attributes, params)
  req.send_request(options)
end

#put_cluster_capacity_providers(params = {}) ⇒ Types::PutClusterCapacityProvidersResponse

Modifies the available capacity providers and the default capacity provider strategy for a cluster.

You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. We recommend that you define a default capacity provider strategy for your cluster. However, you must specify an empty array ([]) to bypass defining a default strategy.

Examples:

Request syntax with placeholder values


resp = client.put_cluster_capacity_providers({
  cluster: "String", # required
  capacity_providers: ["String"], # required
  default_capacity_provider_strategy: [ # required
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
})

Response structure


resp.cluster.cluster_arn #=> String
resp.cluster.cluster_name #=> String
resp.cluster.configuration.execute_command_configuration.kms_key_id #=> String
resp.cluster.configuration.execute_command_configuration.logging #=> String, one of "NONE", "DEFAULT", "OVERRIDE"
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
resp.cluster.configuration.managed_storage_configuration.kms_key_id #=> String
resp.cluster.configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
resp.cluster.status #=> String
resp.cluster.registered_container_instances_count #=> Integer
resp.cluster.running_tasks_count #=> Integer
resp.cluster.pending_tasks_count #=> Integer
resp.cluster.active_services_count #=> Integer
resp.cluster.statistics #=> Array
resp.cluster.statistics[0].name #=> String
resp.cluster.statistics[0].value #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.settings #=> Array
resp.cluster.settings[0].name #=> String, one of "containerInsights"
resp.cluster.settings[0].value #=> String
resp.cluster.capacity_providers #=> Array
resp.cluster.capacity_providers[0] #=> String
resp.cluster.default_capacity_provider_strategy #=> Array
resp.cluster.default_capacity_provider_strategy[0].capacity_provider #=> String
resp.cluster.default_capacity_provider_strategy[0].weight #=> Integer
resp.cluster.default_capacity_provider_strategy[0].base #=> Integer
resp.cluster.attachments #=> Array
resp.cluster.attachments[0].id #=> String
resp.cluster.attachments[0].type #=> String
resp.cluster.attachments[0].status #=> String
resp.cluster.attachments[0].details #=> Array
resp.cluster.attachments[0].details[0].name #=> String
resp.cluster.attachments[0].details[0].value #=> String
resp.cluster.attachments_status #=> String
resp.cluster.service_connect_defaults.namespace #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (required, String) —

    The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don't specify a cluster, the default cluster is assumed.

  • :capacity_providers (required, Array<String>) —

    The name of one or more capacity providers to associate with the cluster.

    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

    To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

  • :default_capacity_provider_strategy (required, Array<Types::CapacityProviderStrategyItem>) —

    The capacity provider strategy to use by default for the cluster.

    When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

    A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

    To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

Returns:

See Also:



6617
6618
6619
6620
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 6617

def put_cluster_capacity_providers(params = {}, options = {})
  req = build_request(:put_cluster_capacity_providers, params)
  req.send_request(options)
end

#register_container_instance(params = {}) ⇒ Types::RegisterContainerInstanceResponse

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.

Examples:

Request syntax with placeholder values


resp = client.register_container_instance({
  cluster: "String",
  instance_identity_document: "String",
  instance_identity_document_signature: "String",
  total_resources: [
    {
      name: "String",
      type: "String",
      double_value: 1.0,
      long_value: 1,
      integer_value: 1,
      string_set_value: ["String"],
    },
  ],
  version_info: {
    agent_version: "String",
    agent_hash: "String",
    docker_version: "String",
  },
  container_instance_arn: "String",
  attributes: [
    {
      name: "String", # required
      value: "String",
      target_type: "container-instance", # accepts container-instance
      target_id: "String",
    },
  ],
  platform_devices: [
    {
      id: "String", # required
      type: "GPU", # required, accepts GPU
    },
  ],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.container_instance.container_instance_arn #=> String
resp.container_instance.ec2_instance_id #=> String
resp.container_instance.capacity_provider_name #=> String
resp.container_instance.version #=> Integer
resp.container_instance.version_info.agent_version #=> String
resp.container_instance.version_info.agent_hash #=> String
resp.container_instance.version_info.docker_version #=> String
resp.container_instance.remaining_resources #=> Array
resp.container_instance.remaining_resources[0].name #=> String
resp.container_instance.remaining_resources[0].type #=> String
resp.container_instance.remaining_resources[0].double_value #=> Float
resp.container_instance.remaining_resources[0].long_value #=> Integer
resp.container_instance.remaining_resources[0].integer_value #=> Integer
resp.container_instance.remaining_resources[0].string_set_value #=> Array
resp.container_instance.remaining_resources[0].string_set_value[0] #=> String
resp.container_instance.registered_resources #=> Array
resp.container_instance.registered_resources[0].name #=> String
resp.container_instance.registered_resources[0].type #=> String
resp.container_instance.registered_resources[0].double_value #=> Float
resp.container_instance.registered_resources[0].long_value #=> Integer
resp.container_instance.registered_resources[0].integer_value #=> Integer
resp.container_instance.registered_resources[0].string_set_value #=> Array
resp.container_instance.registered_resources[0].string_set_value[0] #=> String
resp.container_instance.status #=> String
resp.container_instance.status_reason #=> String
resp.container_instance.agent_connected #=> Boolean
resp.container_instance.running_tasks_count #=> Integer
resp.container_instance.pending_tasks_count #=> Integer
resp.container_instance.agent_update_status #=> String, one of "PENDING", "STAGING", "STAGED", "UPDATING", "UPDATED", "FAILED"
resp.container_instance.attributes #=> Array
resp.container_instance.attributes[0].name #=> String
resp.container_instance.attributes[0].value #=> String
resp.container_instance.attributes[0].target_type #=> String, one of "container-instance"
resp.container_instance.attributes[0].target_id #=> String
resp.container_instance.registered_at #=> Time
resp.container_instance.attachments #=> Array
resp.container_instance.attachments[0].id #=> String
resp.container_instance.attachments[0].type #=> String
resp.container_instance.attachments[0].status #=> String
resp.container_instance.attachments[0].details #=> Array
resp.container_instance.attachments[0].details[0].name #=> String
resp.container_instance.attachments[0].details[0].value #=> String
resp.container_instance.tags #=> Array
resp.container_instance.tags[0].key #=> String
resp.container_instance.tags[0].value #=> String
resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instance.health_status.details #=> Array
resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instance.health_status.details[0].last_updated #=> Time
resp.container_instance.health_status.details[0].last_status_change #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance with. If you do not specify a cluster, the default cluster is assumed.

  • :instance_identity_document (String) —

    The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

  • :instance_identity_document_signature (String) —

    The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

  • :total_resources (Array<Types::Resource>) —

    The resources available on the instance.

  • :version_info (Types::VersionInfo) —

    The version information for the Amazon ECS container agent and Docker daemon that runs on the container instance.

  • :container_instance_arn (String) —

    The ARN of the container instance (if it was previously registered).

  • :attributes (Array<Types::Attribute>) —

    The container instance attributes that this container instance supports.

  • :platform_devices (Array<Types::PlatformDevice>) —

    The devices that are available on the container instance. The only supported device type is a GPU.

  • :tags (Array<Types::Tag>) —

    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. You define both.

    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 Amazon Web Services 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.

Returns:

See Also:



6801
6802
6803
6804
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 6801

def register_container_instance(params = {}, options = {})
  req = build_request(:register_container_instance, params)
  req.send_request(options)
end

#register_task_definition(params = {}) ⇒ Types::RegisterTaskDefinitionResponse

Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the policy that's associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Examples:

Example: To register a task definition


# This example registers a task definition to the specified family.

resp = client.register_task_definition({
  container_definitions: [
    {
      name: "sleep", 
      command: [
        "sleep", 
        "360", 
      ], 
      cpu: 10, 
      essential: true, 
      image: "busybox", 
      memory: 10, 
    }, 
  ], 
  family: "sleep360", 
  task_role_arn: "", 
  volumes: [
  ], 
})

resp.to_h outputs the following:
{
  task_definition: {
    container_definitions: [
      {
        name: "sleep", 
        command: [
          "sleep", 
          "360", 
        ], 
        cpu: 10, 
        environment: [
        ], 
        essential: true, 
        image: "busybox", 
        memory: 10, 
        mount_points: [
        ], 
        port_mappings: [
        ], 
        volumes_from: [
        ], 
      }, 
    ], 
    family: "sleep360", 
    revision: 1, 
    task_definition_arn: "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:19", 
    volumes: [
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.register_task_definition({
  family: "String", # required
  task_role_arn: "String",
  execution_role_arn: "String",
  network_mode: "bridge", # accepts bridge, host, awsvpc, none
  container_definitions: [ # required
    {
      name: "String",
      image: "String",
      repository_credentials: {
        credentials_parameter: "String", # required
      },
      cpu: 1,
      memory: 1,
      memory_reservation: 1,
      links: ["String"],
      port_mappings: [
        {
          container_port: 1,
          host_port: 1,
          protocol: "tcp", # accepts tcp, udp
          name: "String",
          app_protocol: "http", # accepts http, http2, grpc
          container_port_range: "String",
        },
      ],
      essential: false,
      restart_policy: {
        enabled: false, # required
        ignored_exit_codes: [1],
        restart_attempt_period: 1,
      },
      entry_point: ["String"],
      command: ["String"],
      environment: [
        {
          name: "String",
          value: "String",
        },
      ],
      environment_files: [
        {
          value: "String", # required
          type: "s3", # required, accepts s3
        },
      ],
      mount_points: [
        {
          source_volume: "String",
          container_path: "String",
          read_only: false,
        },
      ],
      volumes_from: [
        {
          source_container: "String",
          read_only: false,
        },
      ],
      linux_parameters: {
        capabilities: {
          add: ["String"],
          drop: ["String"],
        },
        devices: [
          {
            host_path: "String", # required
            container_path: "String",
            permissions: ["read"], # accepts read, write, mknod
          },
        ],
        init_process_enabled: false,
        shared_memory_size: 1,
        tmpfs: [
          {
            container_path: "String", # required
            size: 1, # required
            mount_options: ["String"],
          },
        ],
        max_swap: 1,
        swappiness: 1,
      },
      secrets: [
        {
          name: "String", # required
          value_from: "String", # required
        },
      ],
      depends_on: [
        {
          container_name: "String", # required
          condition: "START", # required, accepts START, COMPLETE, SUCCESS, HEALTHY
        },
      ],
      start_timeout: 1,
      stop_timeout: 1,
      version_consistency: "enabled", # accepts enabled, disabled
      hostname: "String",
      user: "String",
      working_directory: "String",
      disable_networking: false,
      privileged: false,
      readonly_root_filesystem: false,
      dns_servers: ["String"],
      dns_search_domains: ["String"],
      extra_hosts: [
        {
          hostname: "String", # required
          ip_address: "String", # required
        },
      ],
      docker_security_options: ["String"],
      interactive: false,
      pseudo_terminal: false,
      docker_labels: {
        "String" => "String",
      },
      ulimits: [
        {
          name: "core", # required, accepts core, cpu, data, fsize, locks, memlock, msgqueue, nice, nofile, nproc, rss, rtprio, rttime, sigpending, stack
          soft_limit: 1, # required
          hard_limit: 1, # required
        },
      ],
      log_configuration: {
        log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk, awsfirelens
        options: {
          "String" => "String",
        },
        secret_options: [
          {
            name: "String", # required
            value_from: "String", # required
          },
        ],
      },
      health_check: {
        command: ["String"], # required
        interval: 1,
        timeout: 1,
        retries: 1,
        start_period: 1,
      },
      system_controls: [
        {
          namespace: "String",
          value: "String",
        },
      ],
      resource_requirements: [
        {
          value: "String", # required
          type: "GPU", # required, accepts GPU, InferenceAccelerator
        },
      ],
      firelens_configuration: {
        type: "fluentd", # required, accepts fluentd, fluentbit
        options: {
          "String" => "String",
        },
      },
      credential_specs: ["String"],
    },
  ],
  volumes: [
    {
      name: "String",
      host: {
        source_path: "String",
      },
      docker_volume_configuration: {
        scope: "task", # accepts task, shared
        autoprovision: false,
        driver: "String",
        driver_opts: {
          "String" => "String",
        },
        labels: {
          "String" => "String",
        },
      },
      efs_volume_configuration: {
        file_system_id: "String", # required
        root_directory: "String",
        transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
        transit_encryption_port: 1,
        authorization_config: {
          access_point_id: "String",
          iam: "ENABLED", # accepts ENABLED, DISABLED
        },
      },
      fsx_windows_file_server_volume_configuration: {
        file_system_id: "String", # required
        root_directory: "String", # required
        authorization_config: { # required
          credentials_parameter: "String", # required
          domain: "String", # required
        },
      },
      configured_at_launch: false,
    },
  ],
  placement_constraints: [
    {
      type: "memberOf", # accepts memberOf
      expression: "String",
    },
  ],
  requires_compatibilities: ["EC2"], # accepts EC2, FARGATE, EXTERNAL
  cpu: "String",
  memory: "String",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  pid_mode: "host", # accepts host, task
  ipc_mode: "host", # accepts host, task, none
  proxy_configuration: {
    type: "APPMESH", # accepts APPMESH
    container_name: "String", # required
    properties: [
      {
        name: "String",
        value: "String",
      },
    ],
  },
  inference_accelerators: [
    {
      device_name: "String", # required
      device_type: "String", # required
    },
  ],
  ephemeral_storage: {
    size_in_gi_b: 1, # required
  },
  runtime_platform: {
    cpu_architecture: "X86_64", # accepts X86_64, ARM64
    operating_system_family: "WINDOWS_SERVER_2019_FULL", # accepts WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2016_FULL, WINDOWS_SERVER_2004_CORE, WINDOWS_SERVER_2022_CORE, WINDOWS_SERVER_2022_FULL, WINDOWS_SERVER_20H2_CORE, LINUX
  },
})

Response structure


resp.task_definition.task_definition_arn #=> String
resp.task_definition.container_definitions #=> Array
resp.task_definition.container_definitions[0].name #=> String
resp.task_definition.container_definitions[0].image #=> String
resp.task_definition.container_definitions[0].repository_credentials.credentials_parameter #=> String
resp.task_definition.container_definitions[0].cpu #=> Integer
resp.task_definition.container_definitions[0].memory #=> Integer
resp.task_definition.container_definitions[0].memory_reservation #=> Integer
resp.task_definition.container_definitions[0].links #=> Array
resp.task_definition.container_definitions[0].links[0] #=> String
resp.task_definition.container_definitions[0].port_mappings #=> Array
resp.task_definition.container_definitions[0].port_mappings[0].container_port #=> Integer
resp.task_definition.container_definitions[0].port_mappings[0].host_port #=> Integer
resp.task_definition.container_definitions[0].port_mappings[0].protocol #=> String, one of "tcp", "udp"
resp.task_definition.container_definitions[0].port_mappings[0].name #=> String
resp.task_definition.container_definitions[0].port_mappings[0].app_protocol #=> String, one of "http", "http2", "grpc"
resp.task_definition.container_definitions[0].port_mappings[0].container_port_range #=> String
resp.task_definition.container_definitions[0].essential #=> Boolean
resp.task_definition.container_definitions[0].restart_policy.enabled #=> Boolean
resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes #=> Array
resp.task_definition.container_definitions[0].restart_policy.ignored_exit_codes[0] #=> Integer
resp.task_definition.container_definitions[0].restart_policy.restart_attempt_period #=> Integer
resp.task_definition.container_definitions[0].entry_point #=> Array
resp.task_definition.container_definitions[0].entry_point[0] #=> String
resp.task_definition.container_definitions[0].command #=> Array
resp.task_definition.container_definitions[0].command[0] #=> String
resp.task_definition.container_definitions[0].environment #=> Array
resp.task_definition.container_definitions[0].environment[0].name #=> String
resp.task_definition.container_definitions[0].environment[0].value #=> String
resp.task_definition.container_definitions[0].environment_files #=> Array
resp.task_definition.container_definitions[0].environment_files[0].value #=> String
resp.task_definition.container_definitions[0].environment_files[0].type #=> String, one of "s3"
resp.task_definition.container_definitions[0].mount_points #=> Array
resp.task_definition.container_definitions[0].mount_points[0].source_volume #=> String
resp.task_definition.container_definitions[0].mount_points[0].container_path #=> String
resp.task_definition.container_definitions[0].mount_points[0].read_only #=> Boolean
resp.task_definition.container_definitions[0].volumes_from #=> Array
resp.task_definition.container_definitions[0].volumes_from[0].source_container #=> String
resp.task_definition.container_definitions[0].volumes_from[0].read_only #=> Boolean
resp.task_definition.container_definitions[0].linux_parameters.capabilities.add #=> Array
resp.task_definition.container_definitions[0].linux_parameters.capabilities.add[0] #=> String
resp.task_definition.container_definitions[0].linux_parameters.capabilities.drop #=> Array
resp.task_definition.container_definitions[0].linux_parameters.capabilities.drop[0] #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices #=> Array
resp.task_definition.container_definitions[0].linux_parameters.devices[0].host_path #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices[0].container_path #=> String
resp.task_definition.container_definitions[0].linux_parameters.devices[0].permissions #=> Array
resp.task_definition.container_definitions[0].linux_parameters.devices[0].permissions[0] #=> String, one of "read", "write", "mknod"
resp.task_definition.container_definitions[0].linux_parameters.init_process_enabled #=> Boolean
resp.task_definition.container_definitions[0].linux_parameters.shared_memory_size #=> Integer
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
resp.task_definition.container_definitions[0].depends_on[0].condition #=> String, one of "START", "COMPLETE", "SUCCESS", "HEALTHY"
resp.task_definition.container_definitions[0].start_timeout #=> Integer
resp.task_definition.container_definitions[0].stop_timeout #=> Integer
resp.task_definition.container_definitions[0].version_consistency #=> String, one of "enabled", "disabled"
resp.task_definition.container_definitions[0].hostname #=> String
resp.task_definition.container_definitions[0].user #=> String
resp.task_definition.container_definitions[0].working_directory #=> String
resp.task_definition.container_definitions[0].disable_networking #=> Boolean
resp.task_definition.container_definitions[0].privileged #=> Boolean
resp.task_definition.container_definitions[0].readonly_root_filesystem #=> Boolean
resp.task_definition.container_definitions[0].dns_servers #=> Array
resp.task_definition.container_definitions[0].dns_servers[0] #=> String
resp.task_definition.container_definitions[0].dns_search_domains #=> Array
resp.task_definition.container_definitions[0].dns_search_domains[0] #=> String
resp.task_definition.container_definitions[0].extra_hosts #=> Array
resp.task_definition.container_definitions[0].extra_hosts[0].hostname #=> String
resp.task_definition.container_definitions[0].extra_hosts[0].ip_address #=> String
resp.task_definition.container_definitions[0].docker_security_options #=> Array
resp.task_definition.container_definitions[0].docker_security_options[0] #=> String
resp.task_definition.container_definitions[0].interactive #=> Boolean
resp.task_definition.container_definitions[0].pseudo_terminal #=> Boolean
resp.task_definition.container_definitions[0].docker_labels #=> Hash
resp.task_definition.container_definitions[0].docker_labels["String"] #=> String
resp.task_definition.container_definitions[0].ulimits #=> Array
resp.task_definition.container_definitions[0].ulimits[0].name #=> String, one of "core", "cpu", "data", "fsize", "locks", "memlock", "msgqueue", "nice", "nofile", "nproc", "rss", "rtprio", "rttime", "sigpending", "stack"
resp.task_definition.container_definitions[0].ulimits[0].soft_limit #=> Integer
resp.task_definition.container_definitions[0].ulimits[0].hard_limit #=> Integer
resp.task_definition.container_definitions[0].log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.task_definition.container_definitions[0].log_configuration.options #=> Hash
resp.task_definition.container_definitions[0].log_configuration.options["String"] #=> String
resp.task_definition.container_definitions[0].log_configuration.secret_options #=> Array
resp.task_definition.container_definitions[0].log_configuration.secret_options[0].name #=> String
resp.task_definition.container_definitions[0].log_configuration.secret_options[0].value_from #=> String
resp.task_definition.container_definitions[0].health_check.command #=> Array
resp.task_definition.container_definitions[0].health_check.command[0] #=> String
resp.task_definition.container_definitions[0].health_check.interval #=> Integer
resp.task_definition.container_definitions[0].health_check.timeout #=> Integer
resp.task_definition.container_definitions[0].health_check.retries #=> Integer
resp.task_definition.container_definitions[0].health_check.start_period #=> Integer
resp.task_definition.container_definitions[0].system_controls #=> Array
resp.task_definition.container_definitions[0].system_controls[0].namespace #=> String
resp.task_definition.container_definitions[0].system_controls[0].value #=> String
resp.task_definition.container_definitions[0].resource_requirements #=> Array
resp.task_definition.container_definitions[0].resource_requirements[0].value #=> String
resp.task_definition.container_definitions[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
resp.task_definition.container_definitions[0].firelens_configuration.type #=> String, one of "fluentd", "fluentbit"
resp.task_definition.container_definitions[0].firelens_configuration.options #=> Hash
resp.task_definition.container_definitions[0].firelens_configuration.options["String"] #=> String
resp.task_definition.container_definitions[0].credential_specs #=> Array
resp.task_definition.container_definitions[0].credential_specs[0] #=> String
resp.task_definition.family #=> String
resp.task_definition.task_role_arn #=> String
resp.task_definition.execution_role_arn #=> String
resp.task_definition.network_mode #=> String, one of "bridge", "host", "awsvpc", "none"
resp.task_definition.revision #=> Integer
resp.task_definition.volumes #=> Array
resp.task_definition.volumes[0].name #=> String
resp.task_definition.volumes[0].host.source_path #=> String
resp.task_definition.volumes[0].docker_volume_configuration.scope #=> String, one of "task", "shared"
resp.task_definition.volumes[0].docker_volume_configuration.autoprovision #=> Boolean
resp.task_definition.volumes[0].docker_volume_configuration.driver #=> String
resp.task_definition.volumes[0].docker_volume_configuration.driver_opts #=> Hash
resp.task_definition.volumes[0].docker_volume_configuration.driver_opts["String"] #=> String
resp.task_definition.volumes[0].docker_volume_configuration.labels #=> Hash
resp.task_definition.volumes[0].docker_volume_configuration.labels["String"] #=> String
resp.task_definition.volumes[0].efs_volume_configuration.file_system_id #=> String
resp.task_definition.volumes[0].efs_volume_configuration.root_directory #=> String
resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption #=> String, one of "ENABLED", "DISABLED"
resp.task_definition.volumes[0].efs_volume_configuration.transit_encryption_port #=> Integer
resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.access_point_id #=> String
resp.task_definition.volumes[0].efs_volume_configuration.authorization_config.iam #=> String, one of "ENABLED", "DISABLED"
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.file_system_id #=> String
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.root_directory #=> String
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.authorization_config.credentials_parameter #=> String
resp.task_definition.volumes[0].fsx_windows_file_server_volume_configuration.authorization_config.domain #=> String
resp.task_definition.volumes[0].configured_at_launch #=> Boolean
resp.task_definition.status #=> String, one of "ACTIVE", "INACTIVE", "DELETE_IN_PROGRESS"
resp.task_definition.requires_attributes #=> Array
resp.task_definition.requires_attributes[0].name #=> String
resp.task_definition.requires_attributes[0].value #=> String
resp.task_definition.requires_attributes[0].target_type #=> String, one of "container-instance"
resp.task_definition.requires_attributes[0].target_id #=> String
resp.task_definition.placement_constraints #=> Array
resp.task_definition.placement_constraints[0].type #=> String, one of "memberOf"
resp.task_definition.placement_constraints[0].expression #=> String
resp.task_definition.compatibilities #=> Array
resp.task_definition.compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_definition.runtime_platform.cpu_architecture #=> String, one of "X86_64", "ARM64"
resp.task_definition.runtime_platform.operating_system_family #=> String, one of "WINDOWS_SERVER_2019_FULL", "WINDOWS_SERVER_2019_CORE", "WINDOWS_SERVER_2016_FULL", "WINDOWS_SERVER_2004_CORE", "WINDOWS_SERVER_2022_CORE", "WINDOWS_SERVER_2022_FULL", "WINDOWS_SERVER_20H2_CORE", "LINUX"
resp.task_definition.requires_compatibilities #=> Array
resp.task_definition.requires_compatibilities[0] #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_definition.cpu #=> String
resp.task_definition.memory #=> String
resp.task_definition.inference_accelerators #=> Array
resp.task_definition.inference_accelerators[0].device_name #=> String
resp.task_definition.inference_accelerators[0].device_type #=> String
resp.task_definition.pid_mode #=> String, one of "host", "task"
resp.task_definition.ipc_mode #=> String, one of "host", "task", "none"
resp.task_definition.proxy_configuration.type #=> String, one of "APPMESH"
resp.task_definition.proxy_configuration.container_name #=> String
resp.task_definition.proxy_configuration.properties #=> Array
resp.task_definition.proxy_configuration.properties[0].name #=> String
resp.task_definition.proxy_configuration.properties[0].value #=> String
resp.task_definition.registered_at #=> Time
resp.task_definition.deregistered_at #=> Time
resp.task_definition.registered_by #=> String
resp.task_definition.ephemeral_storage.size_in_gi_b #=> Integer
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :family (required, String) —

    You must specify a family for a task definition. You can use it track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

  • :task_role_arn (String) —

    The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

  • :execution_role_arn (String) —

    The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. For informationabout the required IAM roles for Amazon ECS, see IAM roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

  • :network_mode (String) —

    The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. If no network mode is specified, the default is bridge.

    For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

    With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

    When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

    If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

    If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

  • :container_definitions (required, Array<Types::ContainerDefinition>) —

    A list of container definitions in JSON format that describe the different containers that make up your task.

  • :volumes (Array<Types::Volume>) —

    A list of volume definitions in JSON format that containers in your task might use.

  • :placement_constraints (Array<Types::TaskDefinitionPlacementConstraint>) —

    An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

  • :requires_compatibilities (Array<String>) —

    The task launch type that Amazon ECS validates the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.

  • :cpu (String) —

    The number of CPU units used by the task. It can be expressed as an integer using CPU units (for example, 1024) or as a string using vCPUs (for example, 1 vCPU or 1 vcpu) in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.

    Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

    If you're using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If you do not specify a value, the parameter is ignored.

    If you're using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

    The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

    • 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

    • 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

    • 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

    • 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

    • 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

    • 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

      This option requires Linux platform 1.4.0 or later.

    • 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

      This option requires Linux platform 1.4.0 or later.

  • :memory (String) —

    The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB (for example ,1024) or as a string using GB (for example, 1GB or 1 GB) in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.

    Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

    If using the EC2 launch type, this field is optional.

    If using the Fargate launch type, this field is required and you must use one of the following values. This determines your range of supported values for the cpu parameter.

    The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

    • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

    • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

    • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

    • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

    • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

    • Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

      This option requires Linux platform 1.4.0 or later.

    • Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

      This option requires Linux platform 1.4.0 or later.

  • :tags (Array<Types::Tag>) —

    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. You define both of them.

    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 Amazon Web Services 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.

  • :pid_mode (String) —

    The process namespace to use for the containers in the task. The valid values are host or task. On Fargate for Linux containers, the only valid value is task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

    If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance.

    If task is specified, all containers within the specified task share the same process namespace.

    If no value is specified, the default is a private namespace for each container.

    If the host PID mode is used, there's a heightened risk of undesired process namespace exposure.

    This parameter is not supported for Windows containers.

    This parameter is only supported for tasks that are hosted on Fargate if the tasks are using platform version 1.4.0 or later (Linux). This isn't supported for Windows containers on Fargate.

  • :ipc_mode (String) —

    The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance.

    If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose.

    If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

    • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.

    • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

    This parameter is not supported for Windows containers or tasks run on Fargate.

  • :proxy_configuration (Types::ProxyConfiguration) —

    The configuration details for the App Mesh proxy.

    For tasks hosted on Amazon EC2 instances, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized AMI versions in the Amazon Elastic Container Service Developer Guide.

  • :inference_accelerators (Array<Types::InferenceAccelerator>) —

    The Elastic Inference accelerators to use for the containers in the task.

  • :ephemeral_storage (Types::EphemeralStorage) —

    The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Using data volumes in tasks in the Amazon ECS Developer Guide.

    For tasks using the Fargate launch type, the task requires the following platforms:

    • Linux platform version 1.4.0 or later.

    • Windows platform version 1.0.0 or later.

  • :runtime_platform (Types::RuntimePlatform) —

    The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.

Returns:

See Also:



7648
7649
7650
7651
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 7648

def register_task_definition(params = {}, options = {})
  req = build_request(:register_task_definition, params)
  req.send_request(options)
end

#run_task(params = {}) ⇒ Types::RunTaskResponse

Starts a new task using the specified task definition.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

Amazon Elastic Inference (EI) is no longer available to customers.

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.

To manage eventual consistency, you can do the following:

  • Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.

  • Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.

Examples:

Example: To run a task on your default cluster


# This example runs the specified task definition on your default cluster.

resp = client.run_task({
  cluster: "default", 
  task_definition: "sleep360:1", 
})

resp.to_h outputs the following:
{
  tasks: [
    {
      container_instance_arn: "arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/default/ffe3d344-77e2-476c-a4d0-bf560ad50acb", 
      containers: [
        {
          name: "sleep", 
          container_arn: "arn:aws:ecs:us-east-1:<aws_account_id>:container/default/58591c8e-be29-4ddf-95aa-ee459d4c59fd", 
          last_status: "PENDING", 
          task_arn: "arn:aws:ecs:us-east-1:<aws_account_id>:task/default/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0", 
        }, 
      ], 
      desired_status: "RUNNING", 
      last_status: "PENDING", 
      overrides: {
        container_overrides: [
          {
            name: "sleep", 
          }, 
        ], 
      }, 
      task_arn: "arn:aws:ecs:us-east-1:<aws_account_id>:task/default/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0", 
      task_definition_arn: "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.run_task({
  capacity_provider_strategy: [
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
  cluster: "String",
  count: 1,
  enable_ecs_managed_tags: false,
  enable_execute_command: false,
  group: "String",
  launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  overrides: {
    container_overrides: [
      {
        name: "String",
        command: ["String"],
        environment: [
          {
            name: "String",
            value: "String",
          },
        ],
        environment_files: [
          {
            value: "String", # required
            type: "s3", # required, accepts s3
          },
        ],
        cpu: 1,
        memory: 1,
        memory_reservation: 1,
        resource_requirements: [
          {
            value: "String", # required
            type: "GPU", # required, accepts GPU, InferenceAccelerator
          },
        ],
      },
    ],
    cpu: "String",
    inference_accelerator_overrides: [
      {
        device_name: "String",
        device_type: "String",
      },
    ],
    execution_role_arn: "String",
    memory: "String",
    task_role_arn: "String",
    ephemeral_storage: {
      size_in_gi_b: 1, # required
    },
  },
  placement_constraints: [
    {
      type: "distinctInstance", # accepts distinctInstance, memberOf
      expression: "String",
    },
  ],
  placement_strategy: [
    {
      type: "random", # accepts random, spread, binpack
      field: "String",
    },
  ],
  platform_version: "String",
  propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
  reference_id: "String",
  started_by: "String",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  task_definition: "String", # required
  client_token: "String",
  volume_configurations: [
    {
      name: "ECSVolumeName", # required
      managed_ebs_volume: {
        encrypted: false,
        kms_key_id: "EBSKMSKeyId",
        volume_type: "EBSVolumeType",
        size_in_gi_b: 1,
        snapshot_id: "EBSSnapshotId",
        iops: 1,
        throughput: 1,
        tag_specifications: [
          {
            resource_type: "volume", # required, accepts volume
            tags: [
              {
                key: "TagKey",
                value: "TagValue",
              },
            ],
            propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
          },
        ],
        role_arn: "IAMRoleArn", # required
        termination_policy: {
          delete_on_termination: false, # required
        },
        filesystem_type: "ext3", # accepts ext3, ext4, xfs, ntfs
      },
    },
  ],
})

Response structure


resp.tasks #=> Array
resp.tasks[0].attachments #=> Array
resp.tasks[0].attachments[0].id #=> String
resp.tasks[0].attachments[0].type #=> String
resp.tasks[0].attachments[0].status #=> String
resp.tasks[0].attachments[0].details #=> Array
resp.tasks[0].attachments[0].details[0].name #=> String
resp.tasks[0].attachments[0].details[0].value #=> String
resp.tasks[0].attributes #=> Array
resp.tasks[0].attributes[0].name #=> String
resp.tasks[0].attributes[0].value #=> String
resp.tasks[0].attributes[0].target_type #=> String, one of "container-instance"
resp.tasks[0].attributes[0].target_id #=> String
resp.tasks[0].availability_zone #=> String
resp.tasks[0].capacity_provider_name #=> String
resp.tasks[0].cluster_arn #=> String
resp.tasks[0].connectivity #=> String, one of "CONNECTED", "DISCONNECTED"
resp.tasks[0].connectivity_at #=> Time
resp.tasks[0].container_instance_arn #=> String
resp.tasks[0].containers #=> Array
resp.tasks[0].containers[0].container_arn #=> String
resp.tasks[0].containers[0].task_arn #=> String
resp.tasks[0].containers[0].name #=> String
resp.tasks[0].containers[0].image #=> String
resp.tasks[0].containers[0].image_digest #=> String
resp.tasks[0].containers[0].runtime_id #=> String
resp.tasks[0].containers[0].last_status #=> String
resp.tasks[0].containers[0].exit_code #=> Integer
resp.tasks[0].containers[0].reason #=> String
resp.tasks[0].containers[0].network_bindings #=> Array
resp.tasks[0].containers[0].network_bindings[0].bind_ip #=> String
resp.tasks[0].containers[0].network_bindings[0].container_port #=> Integer
resp.tasks[0].containers[0].network_bindings[0].host_port #=> Integer
resp.tasks[0].containers[0].network_bindings[0].protocol #=> String, one of "tcp", "udp"
resp.tasks[0].containers[0].network_bindings[0].container_port_range #=> String
resp.tasks[0].containers[0].network_bindings[0].host_port_range #=> String
resp.tasks[0].containers[0].network_interfaces #=> Array
resp.tasks[0].containers[0].network_interfaces[0].attachment_id #=> String
resp.tasks[0].containers[0].network_interfaces[0].private_ipv_4_address #=> String
resp.tasks[0].containers[0].network_interfaces[0].ipv6_address #=> String
resp.tasks[0].containers[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
resp.tasks[0].containers[0].managed_agents #=> Array
resp.tasks[0].containers[0].managed_agents[0].last_started_at #=> Time
resp.tasks[0].containers[0].managed_agents[0].name #=> String, one of "ExecuteCommandAgent"
resp.tasks[0].containers[0].managed_agents[0].reason #=> String
resp.tasks[0].containers[0].managed_agents[0].last_status #=> String
resp.tasks[0].containers[0].cpu #=> String
resp.tasks[0].containers[0].memory #=> String
resp.tasks[0].containers[0].memory_reservation #=> String
resp.tasks[0].containers[0].gpu_ids #=> Array
resp.tasks[0].containers[0].gpu_ids[0] #=> String
resp.tasks[0].cpu #=> String
resp.tasks[0].created_at #=> Time
resp.tasks[0].desired_status #=> String
resp.tasks[0].enable_execute_command #=> Boolean
resp.tasks[0].execution_stopped_at #=> Time
resp.tasks[0].group #=> String
resp.tasks[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
resp.tasks[0].inference_accelerators #=> Array
resp.tasks[0].inference_accelerators[0].device_name #=> String
resp.tasks[0].inference_accelerators[0].device_type #=> String
resp.tasks[0].last_status #=> String
resp.tasks[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.tasks[0].memory #=> String
resp.tasks[0].overrides.container_overrides #=> Array
resp.tasks[0].overrides.container_overrides[0].name #=> String
resp.tasks[0].overrides.container_overrides[0].command #=> Array
resp.tasks[0].overrides.container_overrides[0].command[0] #=> String
resp.tasks[0].overrides.container_overrides[0].environment #=> Array
resp.tasks[0].overrides.container_overrides[0].environment[0].name #=> String
resp.tasks[0].overrides.container_overrides[0].environment[0].value #=> String
resp.tasks[0].overrides.container_overrides[0].environment_files #=> Array
resp.tasks[0].overrides.container_overrides[0].environment_files[0].value #=> String
resp.tasks[0].overrides.container_overrides[0].environment_files[0].type #=> String, one of "s3"
resp.tasks[0].overrides.container_overrides[0].cpu #=> Integer
resp.tasks[0].overrides.container_overrides[0].memory #=> Integer
resp.tasks[0].overrides.container_overrides[0].memory_reservation #=> Integer
resp.tasks[0].overrides.container_overrides[0].resource_requirements #=> Array
resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].value #=> String
resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
resp.tasks[0].overrides.cpu #=> String
resp.tasks[0].overrides.inference_accelerator_overrides #=> Array
resp.tasks[0].overrides.inference_accelerator_overrides[0].device_name #=> String
resp.tasks[0].overrides.inference_accelerator_overrides[0].device_type #=> String
resp.tasks[0].overrides.execution_role_arn #=> String
resp.tasks[0].overrides.memory #=> String
resp.tasks[0].overrides.task_role_arn #=> String
resp.tasks[0].overrides.ephemeral_storage.size_in_gi_b #=> Integer
resp.tasks[0].platform_version #=> String
resp.tasks[0].platform_family #=> String
resp.tasks[0].pull_started_at #=> Time
resp.tasks[0].pull_stopped_at #=> Time
resp.tasks[0].started_at #=> Time
resp.tasks[0].started_by #=> String
resp.tasks[0].stop_code #=> String, one of "TaskFailedToStart", "EssentialContainerExited", "UserInitiated", "ServiceSchedulerInitiated", "SpotInterruption", "TerminationNotice"
resp.tasks[0].stopped_at #=> Time
resp.tasks[0].stopped_reason #=> String
resp.tasks[0].stopping_at #=> Time
resp.tasks[0].tags #=> Array
resp.tasks[0].tags[0].key #=> String
resp.tasks[0].tags[0].value #=> String
resp.tasks[0].task_arn #=> String
resp.tasks[0].task_definition_arn #=> String
resp.tasks[0].version #=> Integer
resp.tasks[0].ephemeral_storage.size_in_gi_b #=> Integer
resp.tasks[0].fargate_ephemeral_storage.size_in_gi_b #=> Integer
resp.tasks[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :capacity_provider_strategy (Array<Types::CapacityProviderStrategyItem>) —

    The capacity provider strategy to use for the task.

    If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

    When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

    A capacity provider strategy may contain a maximum of 6 capacity providers.

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. If you do not specify a cluster, the default cluster is assumed.

  • :count (Integer) —

    The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.

  • :enable_ecs_managed_tags (Boolean) —

    Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

  • :enable_execute_command (Boolean) —

    Determines whether to use the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

    If true, then the task definition must have a task role, or you must provide one as an override.

  • :group (String) —

    The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

  • :launch_type (String) —

    The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

    The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

    Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.

    The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

    The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

    A task can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

    When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

  • :network_configuration (Types::NetworkConfiguration) —

    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 isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

  • :overrides (Types::TaskOverride) —

    A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that's specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

    A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

  • :placement_constraints (Array<Types::PlacementConstraint>) —

    An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).

  • :placement_strategy (Array<Types::PlacementStrategy>) —

    The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.

  • :platform_version (String) —

    The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

  • :propagate_tags (String) —

    Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use theTagResource API action.

    An error will be received if you specify the SERVICE option when running a task.

  • :reference_id (String) —

    This parameter is only used by Amazon ECS. It is not intended for use by customers.

  • :started_by (String) —

    An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 128 letters (uppercase and lowercase), numbers, hyphens (-), forward slash (/), and underscores (_) are allowed.

    If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

  • :tags (Array<Types::Tag>) —

    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.

    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 Amazon Web Services 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.

  • :task_definition (required, String) —

    The family and revision (family:revision) or full ARN of the task definition to run. If a revision isn't specified, the latest ACTIVE revision is used.

    The full ARN value must match the value that you specified as the Resource of the principal's permissions policy.

    When you specify a task definition, you must either specify a specific revision, or all revisions in the ARN.

    To specify a specific revision, include the revision number in the ARN. For example, to specify revision 2, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2.

    To specify all revisions, use the wildcard (*) in the ARN. For example, to specify all revisions, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*.

    For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

  • :client_token (String) —

    An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :volume_configurations (Array<Types::TaskVolumeConfiguration>) —

    The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in in TaskManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

Returns:

See Also:



8226
8227
8228
8229
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 8226

def run_task(params = {}, options = {})
  req = build_request(:run_task, params)
  req.send_request(options)
end

#start_task(params = {}) ⇒ Types::StartTaskResponse

Starts a new task from the specified task definition on the specified container instance or instances.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

Amazon Elastic Inference (EI) is no longer available to customers.

Alternatively, you can useRunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.start_task({
  cluster: "String",
  container_instances: ["String"], # required
  enable_ecs_managed_tags: false,
  enable_execute_command: false,
  group: "String",
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  overrides: {
    container_overrides: [
      {
        name: "String",
        command: ["String"],
        environment: [
          {
            name: "String",
            value: "String",
          },
        ],
        environment_files: [
          {
            value: "String", # required
            type: "s3", # required, accepts s3
          },
        ],
        cpu: 1,
        memory: 1,
        memory_reservation: 1,
        resource_requirements: [
          {
            value: "String", # required
            type: "GPU", # required, accepts GPU, InferenceAccelerator
          },
        ],
      },
    ],
    cpu: "String",
    inference_accelerator_overrides: [
      {
        device_name: "String",
        device_type: "String",
      },
    ],
    execution_role_arn: "String",
    memory: "String",
    task_role_arn: "String",
    ephemeral_storage: {
      size_in_gi_b: 1, # required
    },
  },
  propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
  reference_id: "String",
  started_by: "String",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  task_definition: "String", # required
  volume_configurations: [
    {
      name: "ECSVolumeName", # required
      managed_ebs_volume: {
        encrypted: false,
        kms_key_id: "EBSKMSKeyId",
        volume_type: "EBSVolumeType",
        size_in_gi_b: 1,
        snapshot_id: "EBSSnapshotId",
        iops: 1,
        throughput: 1,
        tag_specifications: [
          {
            resource_type: "volume", # required, accepts volume
            tags: [
              {
                key: "TagKey",
                value: "TagValue",
              },
            ],
            propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
          },
        ],
        role_arn: "IAMRoleArn", # required
        termination_policy: {
          delete_on_termination: false, # required
        },
        filesystem_type: "ext3", # accepts ext3, ext4, xfs, ntfs
      },
    },
  ],
})

Response structure


resp.tasks #=> Array
resp.tasks[0].attachments #=> Array
resp.tasks[0].attachments[0].id #=> String
resp.tasks[0].attachments[0].type #=> String
resp.tasks[0].attachments[0].status #=> String
resp.tasks[0].attachments[0].details #=> Array
resp.tasks[0].attachments[0].details[0].name #=> String
resp.tasks[0].attachments[0].details[0].value #=> String
resp.tasks[0].attributes #=> Array
resp.tasks[0].attributes[0].name #=> String
resp.tasks[0].attributes[0].value #=> String
resp.tasks[0].attributes[0].target_type #=> String, one of "container-instance"
resp.tasks[0].attributes[0].target_id #=> String
resp.tasks[0].availability_zone #=> String
resp.tasks[0].capacity_provider_name #=> String
resp.tasks[0].cluster_arn #=> String
resp.tasks[0].connectivity #=> String, one of "CONNECTED", "DISCONNECTED"
resp.tasks[0].connectivity_at #=> Time
resp.tasks[0].container_instance_arn #=> String
resp.tasks[0].containers #=> Array
resp.tasks[0].containers[0].container_arn #=> String
resp.tasks[0].containers[0].task_arn #=> String
resp.tasks[0].containers[0].name #=> String
resp.tasks[0].containers[0].image #=> String
resp.tasks[0].containers[0].image_digest #=> String
resp.tasks[0].containers[0].runtime_id #=> String
resp.tasks[0].containers[0].last_status #=> String
resp.tasks[0].containers[0].exit_code #=> Integer
resp.tasks[0].containers[0].reason #=> String
resp.tasks[0].containers[0].network_bindings #=> Array
resp.tasks[0].containers[0].network_bindings[0].bind_ip #=> String
resp.tasks[0].containers[0].network_bindings[0].container_port #=> Integer
resp.tasks[0].containers[0].network_bindings[0].host_port #=> Integer
resp.tasks[0].containers[0].network_bindings[0].protocol #=> String, one of "tcp", "udp"
resp.tasks[0].containers[0].network_bindings[0].container_port_range #=> String
resp.tasks[0].containers[0].network_bindings[0].host_port_range #=> String
resp.tasks[0].containers[0].network_interfaces #=> Array
resp.tasks[0].containers[0].network_interfaces[0].attachment_id #=> String
resp.tasks[0].containers[0].network_interfaces[0].private_ipv_4_address #=> String
resp.tasks[0].containers[0].network_interfaces[0].ipv6_address #=> String
resp.tasks[0].containers[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
resp.tasks[0].containers[0].managed_agents #=> Array
resp.tasks[0].containers[0].managed_agents[0].last_started_at #=> Time
resp.tasks[0].containers[0].managed_agents[0].name #=> String, one of "ExecuteCommandAgent"
resp.tasks[0].containers[0].managed_agents[0].reason #=> String
resp.tasks[0].containers[0].managed_agents[0].last_status #=> String
resp.tasks[0].containers[0].cpu #=> String
resp.tasks[0].containers[0].memory #=> String
resp.tasks[0].containers[0].memory_reservation #=> String
resp.tasks[0].containers[0].gpu_ids #=> Array
resp.tasks[0].containers[0].gpu_ids[0] #=> String
resp.tasks[0].cpu #=> String
resp.tasks[0].created_at #=> Time
resp.tasks[0].desired_status #=> String
resp.tasks[0].enable_execute_command #=> Boolean
resp.tasks[0].execution_stopped_at #=> Time
resp.tasks[0].group #=> String
resp.tasks[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
resp.tasks[0].inference_accelerators #=> Array
resp.tasks[0].inference_accelerators[0].device_name #=> String
resp.tasks[0].inference_accelerators[0].device_type #=> String
resp.tasks[0].last_status #=> String
resp.tasks[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.tasks[0].memory #=> String
resp.tasks[0].overrides.container_overrides #=> Array
resp.tasks[0].overrides.container_overrides[0].name #=> String
resp.tasks[0].overrides.container_overrides[0].command #=> Array
resp.tasks[0].overrides.container_overrides[0].command[0] #=> String
resp.tasks[0].overrides.container_overrides[0].environment #=> Array
resp.tasks[0].overrides.container_overrides[0].environment[0].name #=> String
resp.tasks[0].overrides.container_overrides[0].environment[0].value #=> String
resp.tasks[0].overrides.container_overrides[0].environment_files #=> Array
resp.tasks[0].overrides.container_overrides[0].environment_files[0].value #=> String
resp.tasks[0].overrides.container_overrides[0].environment_files[0].type #=> String, one of "s3"
resp.tasks[0].overrides.container_overrides[0].cpu #=> Integer
resp.tasks[0].overrides.container_overrides[0].memory #=> Integer
resp.tasks[0].overrides.container_overrides[0].memory_reservation #=> Integer
resp.tasks[0].overrides.container_overrides[0].resource_requirements #=> Array
resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].value #=> String
resp.tasks[0].overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
resp.tasks[0].overrides.cpu #=> String
resp.tasks[0].overrides.inference_accelerator_overrides #=> Array
resp.tasks[0].overrides.inference_accelerator_overrides[0].device_name #=> String
resp.tasks[0].overrides.inference_accelerator_overrides[0].device_type #=> String
resp.tasks[0].overrides.execution_role_arn #=> String
resp.tasks[0].overrides.memory #=> String
resp.tasks[0].overrides.task_role_arn #=> String
resp.tasks[0].overrides.ephemeral_storage.size_in_gi_b #=> Integer
resp.tasks[0].platform_version #=> String
resp.tasks[0].platform_family #=> String
resp.tasks[0].pull_started_at #=> Time
resp.tasks[0].pull_stopped_at #=> Time
resp.tasks[0].started_at #=> Time
resp.tasks[0].started_by #=> String
resp.tasks[0].stop_code #=> String, one of "TaskFailedToStart", "EssentialContainerExited", "UserInitiated", "ServiceSchedulerInitiated", "SpotInterruption", "TerminationNotice"
resp.tasks[0].stopped_at #=> Time
resp.tasks[0].stopped_reason #=> String
resp.tasks[0].stopping_at #=> Time
resp.tasks[0].tags #=> Array
resp.tasks[0].tags[0].key #=> String
resp.tasks[0].tags[0].value #=> String
resp.tasks[0].task_arn #=> String
resp.tasks[0].task_definition_arn #=> String
resp.tasks[0].version #=> Integer
resp.tasks[0].ephemeral_storage.size_in_gi_b #=> Integer
resp.tasks[0].fargate_ephemeral_storage.size_in_gi_b #=> Integer
resp.tasks[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster where to start your task. If you do not specify a cluster, the default cluster is assumed.

  • :container_instances (required, Array<String>) —

    The container instance IDs or full ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.

  • :enable_ecs_managed_tags (Boolean) —

    Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

  • :enable_execute_command (Boolean) —

    Whether or not the execute command functionality is turned on for the task. If true, this turns on the execute command functionality on all containers in the task.

  • :group (String) —

    The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

  • :network_configuration (Types::NetworkConfiguration) —

    The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

  • :overrides (Types::TaskOverride) —

    A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it receives. You can override the default command for a container (that's specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

    A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

  • :propagate_tags (String) —

    Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

  • :reference_id (String) —

    This parameter is only used by Amazon ECS. It is not intended for use by customers.

  • :started_by (String) —

    An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens (-), forward slash (/), and underscores (_) are allowed.

    If a task is started by an Amazon ECS service, the startedBy parameter contains the deployment ID of the service that starts it.

  • :tags (Array<Types::Tag>) —

    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.

    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 Amazon Web Services 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.

  • :task_definition (required, String) —

    The family and revision (family:revision) or full ARN of the task definition to start. If a revision isn't specified, the latest ACTIVE revision is used.

  • :volume_configurations (Array<Types::TaskVolumeConfiguration>) —

    The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

Returns:

See Also:



8602
8603
8604
8605
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 8602

def start_task(params = {}, options = {})
  req = build_request(:start_task, params)
  req.send_request(options)
end

#stop_task(params = {}) ⇒ Types::StopTaskResponse

Stops a running task. Any tags associated with the task will be deleted.

When you call StopTask on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.

For Windows containers, POSIX signals do not work and runtime stops the container by sending a CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown of (Windows) container #25982 on GitHub.

The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.stop_task({
  cluster: "String",
  task: "String", # required
  reason: "String",
})

Response structure


resp.task.attachments #=> Array
resp.task.attachments[0].id #=> String
resp.task.attachments[0].type #=> String
resp.task.attachments[0].status #=> String
resp.task.attachments[0].details #=> Array
resp.task.attachments[0].details[0].name #=> String
resp.task.attachments[0].details[0].value #=> String
resp.task.attributes #=> Array
resp.task.attributes[0].name #=> String
resp.task.attributes[0].value #=> String
resp.task.attributes[0].target_type #=> String, one of "container-instance"
resp.task.attributes[0].target_id #=> String
resp.task.availability_zone #=> String
resp.task.capacity_provider_name #=> String
resp.task.cluster_arn #=> String
resp.task.connectivity #=> String, one of "CONNECTED", "DISCONNECTED"
resp.task.connectivity_at #=> Time
resp.task.container_instance_arn #=> String
resp.task.containers #=> Array
resp.task.containers[0].container_arn #=> String
resp.task.containers[0].task_arn #=> String
resp.task.containers[0].name #=> String
resp.task.containers[0].image #=> String
resp.task.containers[0].image_digest #=> String
resp.task.containers[0].runtime_id #=> String
resp.task.containers[0].last_status #=> String
resp.task.containers[0].exit_code #=> Integer
resp.task.containers[0].reason #=> String
resp.task.containers[0].network_bindings #=> Array
resp.task.containers[0].network_bindings[0].bind_ip #=> String
resp.task.containers[0].network_bindings[0].container_port #=> Integer
resp.task.containers[0].network_bindings[0].host_port #=> Integer
resp.task.containers[0].network_bindings[0].protocol #=> String, one of "tcp", "udp"
resp.task.containers[0].network_bindings[0].container_port_range #=> String
resp.task.containers[0].network_bindings[0].host_port_range #=> String
resp.task.containers[0].network_interfaces #=> Array
resp.task.containers[0].network_interfaces[0].attachment_id #=> String
resp.task.containers[0].network_interfaces[0].private_ipv_4_address #=> String
resp.task.containers[0].network_interfaces[0].ipv6_address #=> String
resp.task.containers[0].health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
resp.task.containers[0].managed_agents #=> Array
resp.task.containers[0].managed_agents[0].last_started_at #=> Time
resp.task.containers[0].managed_agents[0].name #=> String, one of "ExecuteCommandAgent"
resp.task.containers[0].managed_agents[0].reason #=> String
resp.task.containers[0].managed_agents[0].last_status #=> String
resp.task.containers[0].cpu #=> String
resp.task.containers[0].memory #=> String
resp.task.containers[0].memory_reservation #=> String
resp.task.containers[0].gpu_ids #=> Array
resp.task.containers[0].gpu_ids[0] #=> String
resp.task.cpu #=> String
resp.task.created_at #=> Time
resp.task.desired_status #=> String
resp.task.enable_execute_command #=> Boolean
resp.task.execution_stopped_at #=> Time
resp.task.group #=> String
resp.task.health_status #=> String, one of "HEALTHY", "UNHEALTHY", "UNKNOWN"
resp.task.inference_accelerators #=> Array
resp.task.inference_accelerators[0].device_name #=> String
resp.task.inference_accelerators[0].device_type #=> String
resp.task.last_status #=> String
resp.task.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task.memory #=> String
resp.task.overrides.container_overrides #=> Array
resp.task.overrides.container_overrides[0].name #=> String
resp.task.overrides.container_overrides[0].command #=> Array
resp.task.overrides.container_overrides[0].command[0] #=> String
resp.task.overrides.container_overrides[0].environment #=> Array
resp.task.overrides.container_overrides[0].environment[0].name #=> String
resp.task.overrides.container_overrides[0].environment[0].value #=> String
resp.task.overrides.container_overrides[0].environment_files #=> Array
resp.task.overrides.container_overrides[0].environment_files[0].value #=> String
resp.task.overrides.container_overrides[0].environment_files[0].type #=> String, one of "s3"
resp.task.overrides.container_overrides[0].cpu #=> Integer
resp.task.overrides.container_overrides[0].memory #=> Integer
resp.task.overrides.container_overrides[0].memory_reservation #=> Integer
resp.task.overrides.container_overrides[0].resource_requirements #=> Array
resp.task.overrides.container_overrides[0].resource_requirements[0].value #=> String
resp.task.overrides.container_overrides[0].resource_requirements[0].type #=> String, one of "GPU", "InferenceAccelerator"
resp.task.overrides.cpu #=> String
resp.task.overrides.inference_accelerator_overrides #=> Array
resp.task.overrides.inference_accelerator_overrides[0].device_name #=> String
resp.task.overrides.inference_accelerator_overrides[0].device_type #=> String
resp.task.overrides.execution_role_arn #=> String
resp.task.overrides.memory #=> String
resp.task.overrides.task_role_arn #=> String
resp.task.overrides.ephemeral_storage.size_in_gi_b #=> Integer
resp.task.platform_version #=> String
resp.task.platform_family #=> String
resp.task.pull_started_at #=> Time
resp.task.pull_stopped_at #=> Time
resp.task.started_at #=> Time
resp.task.started_by #=> String
resp.task.stop_code #=> String, one of "TaskFailedToStart", "EssentialContainerExited", "UserInitiated", "ServiceSchedulerInitiated", "SpotInterruption", "TerminationNotice"
resp.task.stopped_at #=> Time
resp.task.stopped_reason #=> String
resp.task.stopping_at #=> Time
resp.task.tags #=> Array
resp.task.tags[0].key #=> String
resp.task.tags[0].value #=> String
resp.task.task_arn #=> String
resp.task.task_definition_arn #=> String
resp.task.version #=> Integer
resp.task.ephemeral_storage.size_in_gi_b #=> Integer
resp.task.fargate_ephemeral_storage.size_in_gi_b #=> Integer
resp.task.fargate_ephemeral_storage.kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    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.

  • :task (required, String) —

    The task ID of the task to stop.

  • :reason (String) —

    An optional message specified when a task is stopped. For example, if you're using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks> API operations on this task.

Returns:

See Also:



8777
8778
8779
8780
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 8777

def stop_task(params = {}, options = {})
  req = build_request(:stop_task, params)
  req.send_request(options)
end

#submit_attachment_state_changes(params = {}) ⇒ Types::SubmitAttachmentStateChangesResponse

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that an attachment changed states.

Examples:

Request syntax with placeholder values


resp = client.submit_attachment_state_changes({
  cluster: "String",
  attachments: [ # required
    {
      attachment_arn: "String", # required
      status: "String", # required
    },
  ],
})

Response structure


resp.acknowledgment #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full ARN of the cluster that hosts the container instance the attachment belongs to.

  • :attachments (required, Array<Types::AttachmentStateChange>) —

    Any attachments associated with the state change request.

Returns:

See Also:



8820
8821
8822
8823
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 8820

def submit_attachment_state_changes(params = {}, options = {})
  req = build_request(:submit_attachment_state_changes, params)
  req.send_request(options)
end

#submit_container_state_change(params = {}) ⇒ Types::SubmitContainerStateChangeResponse

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a container changed states.

Examples:

Request syntax with placeholder values


resp = client.submit_container_state_change({
  cluster: "String",
  task: "String",
  container_name: "String",
  runtime_id: "String",
  status: "String",
  exit_code: 1,
  reason: "String",
  network_bindings: [
    {
      bind_ip: "String",
      container_port: 1,
      host_port: 1,
      protocol: "tcp", # accepts tcp, udp
      container_port_range: "String",
      host_port_range: "String",
    },
  ],
})

Response structure


resp.acknowledgment #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full ARN of the cluster that hosts the container.

  • :task (String) —

    The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

  • :container_name (String) —

    The name of the container.

  • :runtime_id (String) —

    The ID of the Docker container.

  • :status (String) —

    The status of the state change request.

  • :exit_code (Integer) —

    The exit code that's returned for the state change request.

  • :reason (String) —

    The reason for the state change request.

  • :network_bindings (Array<Types::NetworkBinding>) —

    The network bindings of the container.

Returns:

See Also:



8891
8892
8893
8894
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 8891

def submit_container_state_change(params = {}, options = {})
  req = build_request(:submit_container_state_change, params)
  req.send_request(options)
end

#submit_task_state_change(params = {}) ⇒ Types::SubmitTaskStateChangeResponse

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

Examples:

Request syntax with placeholder values


resp = client.submit_task_state_change({
  cluster: "String",
  task: "String",
  status: "String",
  reason: "String",
  containers: [
    {
      container_name: "String",
      image_digest: "String",
      runtime_id: "String",
      exit_code: 1,
      network_bindings: [
        {
          bind_ip: "String",
          container_port: 1,
          host_port: 1,
          protocol: "tcp", # accepts tcp, udp
          container_port_range: "String",
          host_port_range: "String",
        },
      ],
      reason: "String",
      status: "String",
    },
  ],
  attachments: [
    {
      attachment_arn: "String", # required
      status: "String", # required
    },
  ],
  managed_agents: [
    {
      container_name: "String", # required
      managed_agent_name: "ExecuteCommandAgent", # required, accepts ExecuteCommandAgent
      status: "String", # required
      reason: "String",
    },
  ],
  pull_started_at: Time.now,
  pull_stopped_at: Time.now,
  execution_stopped_at: Time.now,
})

Response structure


resp.acknowledgment #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

  • :task (String) —

    The task ID or full ARN of the task in the state change request.

  • :status (String) —

    The status of the state change request.

  • :reason (String) —

    The reason for the state change request.

  • :containers (Array<Types::ContainerStateChange>) —

    Any containers that's associated with the state change request.

  • :attachments (Array<Types::AttachmentStateChange>) —

    Any attachments associated with the state change request.

  • :managed_agents (Array<Types::ManagedAgentStateChange>) —

    The details for the managed agent that's associated with the task.

  • :pull_started_at (Time, DateTime, Date, Integer, String) —

    The Unix timestamp for the time when the container image pull started.

  • :pull_stopped_at (Time, DateTime, Date, Integer, String) —

    The Unix timestamp for the time when the container image pull completed.

  • :execution_stopped_at (Time, DateTime, Date, Integer, String) —

    The Unix timestamp for the time when the task execution stopped.

Returns:

See Also:



8993
8994
8995
8996
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 8993

def submit_task_state_change(params = {}, options = {})
  req = build_request(:submit_task_state_change, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well.

Examples:

Example: To tag a cluster.


# This example tags the 'dev' cluster with key 'team' and value 'dev'.

resp = client.tag_resource({
  resource_arn: "arn:aws:ecs:region:aws_account_id:cluster/dev", 
  tags: [
    {
      key: "team", 
      value: "dev", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: [ # required
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.

  • :tags (required, Array<Types::Tag>) —

    The tags to add to the resource. A tag is an array of key-value pairs.

    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 Amazon Web Services 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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



9073
9074
9075
9076
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 9073

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Deletes specified tags from a resource.

Examples:

Example: To untag a cluster.


# This example deletes the 'team' tag from the 'dev' cluster.

resp = client.untag_resource({
  resource_arn: "arn:aws:ecs:region:aws_account_id:cluster/dev", 
  tag_keys: [
    "team", 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.

  • :tag_keys (required, Array<String>) —

    The keys of the tags to be removed.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



9117
9118
9119
9120
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 9117

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_capacity_provider(params = {}) ⇒ Types::UpdateCapacityProviderResponse

Modifies the parameters for a capacity provider.

Examples:

Request syntax with placeholder values


resp = client.update_capacity_provider({
  name: "String", # required
  auto_scaling_group_provider: { # required
    managed_scaling: {
      status: "ENABLED", # accepts ENABLED, DISABLED
      target_capacity: 1,
      minimum_scaling_step_size: 1,
      maximum_scaling_step_size: 1,
      instance_warmup_period: 1,
    },
    managed_termination_protection: "ENABLED", # accepts ENABLED, DISABLED
    managed_draining: "ENABLED", # accepts ENABLED, DISABLED
  },
})

Response structure


resp.capacity_provider.capacity_provider_arn #=> String
resp.capacity_provider.name #=> String
resp.capacity_provider.status #=> String, one of "ACTIVE", "INACTIVE"
resp.capacity_provider.auto_scaling_group_provider.auto_scaling_group_arn #=> String
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.status #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.target_capacity #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.minimum_scaling_step_size #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.maximum_scaling_step_size #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_scaling.instance_warmup_period #=> Integer
resp.capacity_provider.auto_scaling_group_provider.managed_termination_protection #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.auto_scaling_group_provider.managed_draining #=> String, one of "ENABLED", "DISABLED"
resp.capacity_provider.update_status #=> String, one of "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED"
resp.capacity_provider.update_status_reason #=> String
resp.capacity_provider.tags #=> Array
resp.capacity_provider.tags[0].key #=> String
resp.capacity_provider.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the capacity provider to update.

  • :auto_scaling_group_provider (required, Types::AutoScalingGroupProviderUpdate) —

    An object that represent the parameters to update for the Auto Scaling group capacity provider.

Returns:

See Also:



9175
9176
9177
9178
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 9175

def update_capacity_provider(params = {}, options = {})
  req = build_request(:update_capacity_provider, params)
  req.send_request(options)
end

#update_cluster(params = {}) ⇒ Types::UpdateClusterResponse

Updates the cluster.

Examples:

Request syntax with placeholder values


resp = client.update_cluster({
  cluster: "String", # required
  settings: [
    {
      name: "containerInsights", # accepts containerInsights
      value: "String",
    },
  ],
  configuration: {
    execute_command_configuration: {
      kms_key_id: "String",
      logging: "NONE", # accepts NONE, DEFAULT, OVERRIDE
      log_configuration: {
        cloud_watch_log_group_name: "String",
        cloud_watch_encryption_enabled: false,
        s3_bucket_name: "String",
        s3_encryption_enabled: false,
        s3_key_prefix: "String",
      },
    },
    managed_storage_configuration: {
      kms_key_id: "String",
      fargate_ephemeral_storage_kms_key_id: "String",
    },
  },
  service_connect_defaults: {
    namespace: "String", # required
  },
})

Response structure


resp.cluster.cluster_arn #=> String
resp.cluster.cluster_name #=> String
resp.cluster.configuration.execute_command_configuration.kms_key_id #=> String
resp.cluster.configuration.execute_command_configuration.logging #=> String, one of "NONE", "DEFAULT", "OVERRIDE"
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
resp.cluster.configuration.managed_storage_configuration.kms_key_id #=> String
resp.cluster.configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
resp.cluster.status #=> String
resp.cluster.registered_container_instances_count #=> Integer
resp.cluster.running_tasks_count #=> Integer
resp.cluster.pending_tasks_count #=> Integer
resp.cluster.active_services_count #=> Integer
resp.cluster.statistics #=> Array
resp.cluster.statistics[0].name #=> String
resp.cluster.statistics[0].value #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.settings #=> Array
resp.cluster.settings[0].name #=> String, one of "containerInsights"
resp.cluster.settings[0].value #=> String
resp.cluster.capacity_providers #=> Array
resp.cluster.capacity_providers[0] #=> String
resp.cluster.default_capacity_provider_strategy #=> Array
resp.cluster.default_capacity_provider_strategy[0].capacity_provider #=> String
resp.cluster.default_capacity_provider_strategy[0].weight #=> Integer
resp.cluster.default_capacity_provider_strategy[0].base #=> Integer
resp.cluster.attachments #=> Array
resp.cluster.attachments[0].id #=> String
resp.cluster.attachments[0].type #=> String
resp.cluster.attachments[0].status #=> String
resp.cluster.attachments[0].details #=> Array
resp.cluster.attachments[0].details[0].name #=> String
resp.cluster.attachments[0].details[0].value #=> String
resp.cluster.attachments_status #=> String
resp.cluster.service_connect_defaults.namespace #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (required, String) —

    The name of the cluster to modify the settings for.

  • :settings (Array<Types::ClusterSetting>) —

    The cluster settings for your cluster.

  • :configuration (Types::ClusterConfiguration) —

    The execute command configuration for the cluster.

  • :service_connect_defaults (Types::ClusterServiceConnectDefaultsRequest) —

    Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration. You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

    Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Returns:

See Also:



9296
9297
9298
9299
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 9296

def update_cluster(params = {}, options = {})
  req = build_request(:update_cluster, params)
  req.send_request(options)
end

#update_cluster_settings(params = {}) ⇒ Types::UpdateClusterSettingsResponse

Modifies the settings to use for a cluster.

Examples:

Request syntax with placeholder values


resp = client.update_cluster_settings({
  cluster: "String", # required
  settings: [ # required
    {
      name: "containerInsights", # accepts containerInsights
      value: "String",
    },
  ],
})

Response structure


resp.cluster.cluster_arn #=> String
resp.cluster.cluster_name #=> String
resp.cluster.configuration.execute_command_configuration.kms_key_id #=> String
resp.cluster.configuration.execute_command_configuration.logging #=> String, one of "NONE", "DEFAULT", "OVERRIDE"
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_log_group_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.cloud_watch_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_bucket_name #=> String
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_encryption_enabled #=> Boolean
resp.cluster.configuration.execute_command_configuration.log_configuration.s3_key_prefix #=> String
resp.cluster.configuration.managed_storage_configuration.kms_key_id #=> String
resp.cluster.configuration.managed_storage_configuration.fargate_ephemeral_storage_kms_key_id #=> String
resp.cluster.status #=> String
resp.cluster.registered_container_instances_count #=> Integer
resp.cluster.running_tasks_count #=> Integer
resp.cluster.pending_tasks_count #=> Integer
resp.cluster.active_services_count #=> Integer
resp.cluster.statistics #=> Array
resp.cluster.statistics[0].name #=> String
resp.cluster.statistics[0].value #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.settings #=> Array
resp.cluster.settings[0].name #=> String, one of "containerInsights"
resp.cluster.settings[0].value #=> String
resp.cluster.capacity_providers #=> Array
resp.cluster.capacity_providers[0] #=> String
resp.cluster.default_capacity_provider_strategy #=> Array
resp.cluster.default_capacity_provider_strategy[0].capacity_provider #=> String
resp.cluster.default_capacity_provider_strategy[0].weight #=> Integer
resp.cluster.default_capacity_provider_strategy[0].base #=> Integer
resp.cluster.attachments #=> Array
resp.cluster.attachments[0].id #=> String
resp.cluster.attachments[0].type #=> String
resp.cluster.attachments[0].status #=> String
resp.cluster.attachments[0].details #=> Array
resp.cluster.attachments[0].details[0].name #=> String
resp.cluster.attachments[0].details[0].value #=> String
resp.cluster.attachments_status #=> String
resp.cluster.service_connect_defaults.namespace #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (required, String) —

    The name of the cluster to modify the settings for.

  • :settings (required, Array<Types::ClusterSetting>) —

    The setting to use by default for a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. If this value is specified, it overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

    Currently, if you delete an existing cluster that does not have Container Insights turned on, and then create a new cluster with the same name with Container Insights tuned on, Container Insights will not actually be turned on. If you want to preserve the same name for your existing cluster and turn on Container Insights, you must wait 7 days before you can re-create it.

Returns:

See Also:



9387
9388
9389
9390
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 9387

def update_cluster_settings(params = {}, options = {})
  req = build_request(:update_cluster_settings, params)
  req.send_request(options)
end

#update_container_agent(params = {}) ⇒ Types::UpdateContainerAgentResponse

Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.

The UpdateContainerAgent API isn't supported for container instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init package. This updates the agent. For more information, see Updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

Agent updates with the UpdateContainerAgent API operation do not apply to Windows container instances. We recommend that you launch new container instances to update the agent version in your Windows clusters.

The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_container_agent({
  cluster: "String",
  container_instance: "String", # required
})

Response structure


resp.container_instance.container_instance_arn #=> String
resp.container_instance.ec2_instance_id #=> String
resp.container_instance.capacity_provider_name #=> String
resp.container_instance.version #=> Integer
resp.container_instance.version_info.agent_version #=> String
resp.container_instance.version_info.agent_hash #=> String
resp.container_instance.version_info.docker_version #=> String
resp.container_instance.remaining_resources #=> Array
resp.container_instance.remaining_resources[0].name #=> String
resp.container_instance.remaining_resources[0].type #=> String
resp.container_instance.remaining_resources[0].double_value #=> Float
resp.container_instance.remaining_resources[0].long_value #=> Integer
resp.container_instance.remaining_resources[0].integer_value #=> Integer
resp.container_instance.remaining_resources[0].string_set_value #=> Array
resp.container_instance.remaining_resources[0].string_set_value[0] #=> String
resp.container_instance.registered_resources #=> Array
resp.container_instance.registered_resources[0].name #=> String
resp.container_instance.registered_resources[0].type #=> String
resp.container_instance.registered_resources[0].double_value #=> Float
resp.container_instance.registered_resources[0].long_value #=> Integer
resp.container_instance.registered_resources[0].integer_value #=> Integer
resp.container_instance.registered_resources[0].string_set_value #=> Array
resp.container_instance.registered_resources[0].string_set_value[0] #=> String
resp.container_instance.status #=> String
resp.container_instance.status_reason #=> String
resp.container_instance.agent_connected #=> Boolean
resp.container_instance.running_tasks_count #=> Integer
resp.container_instance.pending_tasks_count #=> Integer
resp.container_instance.agent_update_status #=> String, one of "PENDING", "STAGING", "STAGED", "UPDATING", "UPDATED", "FAILED"
resp.container_instance.attributes #=> Array
resp.container_instance.attributes[0].name #=> String
resp.container_instance.attributes[0].value #=> String
resp.container_instance.attributes[0].target_type #=> String, one of "container-instance"
resp.container_instance.attributes[0].target_id #=> String
resp.container_instance.registered_at #=> Time
resp.container_instance.attachments #=> Array
resp.container_instance.attachments[0].id #=> String
resp.container_instance.attachments[0].type #=> String
resp.container_instance.attachments[0].status #=> String
resp.container_instance.attachments[0].details #=> Array
resp.container_instance.attachments[0].details[0].name #=> String
resp.container_instance.attachments[0].details[0].value #=> String
resp.container_instance.tags #=> Array
resp.container_instance.tags[0].key #=> String
resp.container_instance.tags[0].value #=> String
resp.container_instance.health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instance.health_status.details #=> Array
resp.container_instance.health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
resp.container_instance.health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instance.health_status.details[0].last_updated #=> Time
resp.container_instance.health_status.details[0].last_status_change #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    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.

  • :container_instance (required, String) —

    The container instance ID or full ARN entries for the container instance where you would like to update the Amazon ECS container agent.

Returns:

See Also:



9505
9506
9507
9508
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 9505

def update_container_agent(params = {}, options = {})
  req = build_request(:update_container_agent, params)
  req.send_request(options)
end

#update_container_instances_state(params = {}) ⇒ Types::UpdateContainerInstancesStateResponse

Modifies the status of an Amazon ECS container instance.

Once a container instance has reached an ACTIVE state, you can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.

A container instance can't be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received.

When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.

Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement. You can use this to define the replacement batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.

Any PENDING or RUNNING tasks that do not belong to a service aren't affected. You must wait for them to finish or stop them manually.

A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.

When a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.

Examples:

Request syntax with placeholder values


resp = client.update_container_instances_state({
  cluster: "String",
  container_instances: ["String"], # required
  status: "ACTIVE", # required, accepts ACTIVE, DRAINING, REGISTERING, DEREGISTERING, REGISTRATION_FAILED
})

Response structure


resp.container_instances #=> Array
resp.container_instances[0].container_instance_arn #=> String
resp.container_instances[0].ec2_instance_id #=> String
resp.container_instances[0].capacity_provider_name #=> String
resp.container_instances[0].version #=> Integer
resp.container_instances[0].version_info.agent_version #=> String
resp.container_instances[0].version_info.agent_hash #=> String
resp.container_instances[0].version_info.docker_version #=> String
resp.container_instances[0].remaining_resources #=> Array
resp.container_instances[0].remaining_resources[0].name #=> String
resp.container_instances[0].remaining_resources[0].type #=> String
resp.container_instances[0].remaining_resources[0].double_value #=> Float
resp.container_instances[0].remaining_resources[0].long_value #=> Integer
resp.container_instances[0].remaining_resources[0].integer_value #=> Integer
resp.container_instances[0].remaining_resources[0].string_set_value #=> Array
resp.container_instances[0].remaining_resources[0].string_set_value[0] #=> String
resp.container_instances[0].registered_resources #=> Array
resp.container_instances[0].registered_resources[0].name #=> String
resp.container_instances[0].registered_resources[0].type #=> String
resp.container_instances[0].registered_resources[0].double_value #=> Float
resp.container_instances[0].registered_resources[0].long_value #=> Integer
resp.container_instances[0].registered_resources[0].integer_value #=> Integer
resp.container_instances[0].registered_resources[0].string_set_value #=> Array
resp.container_instances[0].registered_resources[0].string_set_value[0] #=> String
resp.container_instances[0].status #=> String
resp.container_instances[0].status_reason #=> String
resp.container_instances[0].agent_connected #=> Boolean
resp.container_instances[0].running_tasks_count #=> Integer
resp.container_instances[0].pending_tasks_count #=> Integer
resp.container_instances[0].agent_update_status #=> String, one of "PENDING", "STAGING", "STAGED", "UPDATING", "UPDATED", "FAILED"
resp.container_instances[0].attributes #=> Array
resp.container_instances[0].attributes[0].name #=> String
resp.container_instances[0].attributes[0].value #=> String
resp.container_instances[0].attributes[0].target_type #=> String, one of "container-instance"
resp.container_instances[0].attributes[0].target_id #=> String
resp.container_instances[0].registered_at #=> Time
resp.container_instances[0].attachments #=> Array
resp.container_instances[0].attachments[0].id #=> String
resp.container_instances[0].attachments[0].type #=> String
resp.container_instances[0].attachments[0].status #=> String
resp.container_instances[0].attachments[0].details #=> Array
resp.container_instances[0].attachments[0].details[0].name #=> String
resp.container_instances[0].attachments[0].details[0].value #=> String
resp.container_instances[0].tags #=> Array
resp.container_instances[0].tags[0].key #=> String
resp.container_instances[0].tags[0].value #=> String
resp.container_instances[0].health_status.overall_status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instances[0].health_status.details #=> Array
resp.container_instances[0].health_status.details[0].type #=> String, one of "CONTAINER_RUNTIME"
resp.container_instances[0].health_status.details[0].status #=> String, one of "OK", "IMPAIRED", "INSUFFICIENT_DATA", "INITIALIZING"
resp.container_instances[0].health_status.details[0].last_updated #=> Time
resp.container_instances[0].health_status.details[0].last_status_change #=> Time
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.

  • :container_instances (required, Array<String>) —

    A list of up to 10 container instance IDs or full ARN entries.

  • :status (required, String) —

    The container instance state to update the container instance with. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but can't update the container instance state.

Returns:

See Also:



9663
9664
9665
9666
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 9663

def update_container_instances_state(params = {}, options = {})
  req = build_request(:update_container_instances_state, params)
  req.send_request(options)
end

#update_service(params = {}) ⇒ Types::UpdateServiceResponse

Modifies the parameters of a service.

On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

For services using the rolling update (ECS) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new deployment. volumeConfigurations is only supported for REPLICA service and not DAEMON service. If you leave volumeConfigurations null, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more information, see CreateDeployment in the CodeDeploy API Reference.

For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

If you have updated the container image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.

If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you don't need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment. You can use it to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).

When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout. After this, SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic.

  • Determine which of the container instances in your cluster can support your service's task definition. For example, they have the required CPU, memory, ports, and container instance attributes.

  • By default, the service scheduler attempts to balance tasks across Availability Zones in this manner even though you can choose a different placement strategy.

    • Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.

    • Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.

When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:

  • Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.

  • Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.

You must have a service-linked role when you update any of the following service properties:

  • loadBalancers,

  • serviceRegistries

For more information about the role see the CreateService request parameter role .

Examples:

Example: To change the task definition used in a service


# This example updates the my-http-service service to use the amazon-ecs-sample task definition.

resp = client.update_service({
  service: "my-http-service", 
  task_definition: "amazon-ecs-sample", 
})

resp.to_h outputs the following:
{
}

Example: To change the number of tasks in a service


# This example updates the desired count of the my-http-service service to 10.

resp = client.update_service({
  desired_count: 10, 
  service: "my-http-service", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.update_service({
  cluster: "String",
  service: "String", # required
  desired_count: 1,
  task_definition: "String",
  capacity_provider_strategy: [
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
  deployment_configuration: {
    deployment_circuit_breaker: {
      enable: false, # required
      rollback: false, # required
    },
    maximum_percent: 1,
    minimum_healthy_percent: 1,
    alarms: {
      alarm_names: ["String"], # required
      rollback: false, # required
      enable: false, # required
    },
  },
  availability_zone_rebalancing: "ENABLED", # accepts ENABLED, DISABLED
  network_configuration: {
    awsvpc_configuration: {
      subnets: ["String"], # required
      security_groups: ["String"],
      assign_public_ip: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
  placement_constraints: [
    {
      type: "distinctInstance", # accepts distinctInstance, memberOf
      expression: "String",
    },
  ],
  placement_strategy: [
    {
      type: "random", # accepts random, spread, binpack
      field: "String",
    },
  ],
  platform_version: "String",
  force_new_deployment: false,
  health_check_grace_period_seconds: 1,
  enable_execute_command: false,
  enable_ecs_managed_tags: false,
  load_balancers: [
    {
      target_group_arn: "String",
      load_balancer_name: "String",
      container_name: "String",
      container_port: 1,
    },
  ],
  propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
  service_registries: [
    {
      registry_arn: "String",
      port: 1,
      container_name: "String",
      container_port: 1,
    },
  ],
  service_connect_configuration: {
    enabled: false, # required
    namespace: "String",
    services: [
      {
        port_name: "String", # required
        discovery_name: "String",
        client_aliases: [
          {
            port: 1, # required
            dns_name: "String",
          },
        ],
        ingress_port_override: 1,
        timeout: {
          idle_timeout_seconds: 1,
          per_request_timeout_seconds: 1,
        },
        tls: {
          issuer_certificate_authority: { # required
            aws_pca_authority_arn: "String",
          },
          kms_key: "String",
          role_arn: "String",
        },
      },
    ],
    log_configuration: {
      log_driver: "json-file", # required, accepts json-file, syslog, journald, gelf, fluentd, awslogs, splunk, awsfirelens
      options: {
        "String" => "String",
      },
      secret_options: [
        {
          name: "String", # required
          value_from: "String", # required
        },
      ],
    },
  },
  volume_configurations: [
    {
      name: "ECSVolumeName", # required
      managed_ebs_volume: {
        encrypted: false,
        kms_key_id: "EBSKMSKeyId",
        volume_type: "EBSVolumeType",
        size_in_gi_b: 1,
        snapshot_id: "EBSSnapshotId",
        iops: 1,
        throughput: 1,
        tag_specifications: [
          {
            resource_type: "volume", # required, accepts volume
            tags: [
              {
                key: "TagKey",
                value: "TagValue",
              },
            ],
            propagate_tags: "TASK_DEFINITION", # accepts TASK_DEFINITION, SERVICE, NONE
          },
        ],
        role_arn: "IAMRoleArn", # required
        filesystem_type: "ext3", # accepts ext3, ext4, xfs, ntfs
      },
    },
  ],
  vpc_lattice_configurations: [
    {
      role_arn: "IAMRoleArn", # required
      target_group_arn: "String", # required
      port_name: "String", # required
    },
  ],
})

Response structure


resp.service.service_arn #=> String
resp.service.service_name #=> String
resp.service.cluster_arn #=> String
resp.service.load_balancers #=> Array
resp.service.load_balancers[0].target_group_arn #=> String
resp.service.load_balancers[0].load_balancer_name #=> String
resp.service.load_balancers[0].container_name #=> String
resp.service.load_balancers[0].container_port #=> Integer
resp.service.service_registries #=> Array
resp.service.service_registries[0].registry_arn #=> String
resp.service.service_registries[0].port #=> Integer
resp.service.service_registries[0].container_name #=> String
resp.service.service_registries[0].container_port #=> Integer
resp.service.status #=> String
resp.service.desired_count #=> Integer
resp.service.running_count #=> Integer
resp.service.pending_count #=> Integer
resp.service.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.capacity_provider_strategy #=> Array
resp.service.capacity_provider_strategy[0].capacity_provider #=> String
resp.service.capacity_provider_strategy[0].weight #=> Integer
resp.service.capacity_provider_strategy[0].base #=> Integer
resp.service.platform_version #=> String
resp.service.platform_family #=> String
resp.service.task_definition #=> String
resp.service.deployment_configuration.deployment_circuit_breaker.enable #=> Boolean
resp.service.deployment_configuration.deployment_circuit_breaker.rollback #=> Boolean
resp.service.deployment_configuration.maximum_percent #=> Integer
resp.service.deployment_configuration.minimum_healthy_percent #=> Integer
resp.service.deployment_configuration.alarms.alarm_names #=> Array
resp.service.deployment_configuration.alarms.alarm_names[0] #=> String
resp.service.deployment_configuration.alarms.rollback #=> Boolean
resp.service.deployment_configuration.alarms.enable #=> Boolean
resp.service.task_sets #=> Array
resp.service.task_sets[0].id #=> String
resp.service.task_sets[0].task_set_arn #=> String
resp.service.task_sets[0].service_arn #=> String
resp.service.task_sets[0].cluster_arn #=> String
resp.service.task_sets[0].started_by #=> String
resp.service.task_sets[0].external_id #=> String
resp.service.task_sets[0].status #=> String
resp.service.task_sets[0].task_definition #=> String
resp.service.task_sets[0].computed_desired_count #=> Integer
resp.service.task_sets[0].pending_count #=> Integer
resp.service.task_sets[0].running_count #=> Integer
resp.service.task_sets[0].created_at #=> Time
resp.service.task_sets[0].updated_at #=> Time
resp.service.task_sets[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.task_sets[0].capacity_provider_strategy #=> Array
resp.service.task_sets[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.service.task_sets[0].capacity_provider_strategy[0].weight #=> Integer
resp.service.task_sets[0].capacity_provider_strategy[0].base #=> Integer
resp.service.task_sets[0].platform_version #=> String
resp.service.task_sets[0].platform_family #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.task_sets[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.task_sets[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.task_sets[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.task_sets[0].load_balancers #=> Array
resp.service.task_sets[0].load_balancers[0].target_group_arn #=> String
resp.service.task_sets[0].load_balancers[0].load_balancer_name #=> String
resp.service.task_sets[0].load_balancers[0].container_name #=> String
resp.service.task_sets[0].load_balancers[0].container_port #=> Integer
resp.service.task_sets[0].service_registries #=> Array
resp.service.task_sets[0].service_registries[0].registry_arn #=> String
resp.service.task_sets[0].service_registries[0].port #=> Integer
resp.service.task_sets[0].service_registries[0].container_name #=> String
resp.service.task_sets[0].service_registries[0].container_port #=> Integer
resp.service.task_sets[0].scale.value #=> Float
resp.service.task_sets[0].scale.unit #=> String, one of "PERCENT"
resp.service.task_sets[0].stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.service.task_sets[0].stability_status_at #=> Time
resp.service.task_sets[0].tags #=> Array
resp.service.task_sets[0].tags[0].key #=> String
resp.service.task_sets[0].tags[0].value #=> String
resp.service.task_sets[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.service.deployments #=> Array
resp.service.deployments[0].id #=> String
resp.service.deployments[0].status #=> String
resp.service.deployments[0].task_definition #=> String
resp.service.deployments[0].desired_count #=> Integer
resp.service.deployments[0].pending_count #=> Integer
resp.service.deployments[0].running_count #=> Integer
resp.service.deployments[0].failed_tasks #=> Integer
resp.service.deployments[0].created_at #=> Time
resp.service.deployments[0].updated_at #=> Time
resp.service.deployments[0].capacity_provider_strategy #=> Array
resp.service.deployments[0].capacity_provider_strategy[0].capacity_provider #=> String
resp.service.deployments[0].capacity_provider_strategy[0].weight #=> Integer
resp.service.deployments[0].capacity_provider_strategy[0].base #=> Integer
resp.service.deployments[0].launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.service.deployments[0].platform_version #=> String
resp.service.deployments[0].platform_family #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.deployments[0].network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.deployments[0].network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.deployments[0].network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.deployments[0].rollout_state #=> String, one of "COMPLETED", "FAILED", "IN_PROGRESS"
resp.service.deployments[0].rollout_state_reason #=> String
resp.service.deployments[0].service_connect_configuration.enabled #=> Boolean
resp.service.deployments[0].service_connect_configuration.namespace #=> String
resp.service.deployments[0].service_connect_configuration.services #=> Array
resp.service.deployments[0].service_connect_configuration.services[0].port_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].discovery_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases #=> Array
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases[0].port #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].client_aliases[0].dns_name #=> String
resp.service.deployments[0].service_connect_configuration.services[0].ingress_port_override #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].timeout.idle_timeout_seconds #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].timeout.per_request_timeout_seconds #=> Integer
resp.service.deployments[0].service_connect_configuration.services[0].tls.issuer_certificate_authority.aws_pca_authority_arn #=> String
resp.service.deployments[0].service_connect_configuration.services[0].tls.kms_key #=> String
resp.service.deployments[0].service_connect_configuration.services[0].tls.role_arn #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.log_driver #=> String, one of "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk", "awsfirelens"
resp.service.deployments[0].service_connect_configuration.log_configuration.options #=> Hash
resp.service.deployments[0].service_connect_configuration.log_configuration.options["String"] #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options #=> Array
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options[0].name #=> String
resp.service.deployments[0].service_connect_configuration.log_configuration.secret_options[0].value_from #=> String
resp.service.deployments[0].service_connect_resources #=> Array
resp.service.deployments[0].service_connect_resources[0].discovery_name #=> String
resp.service.deployments[0].service_connect_resources[0].discovery_arn #=> String
resp.service.deployments[0].volume_configurations #=> Array
resp.service.deployments[0].volume_configurations[0].name #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.encrypted #=> Boolean
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.kms_key_id #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.volume_type #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.size_in_gi_b #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.snapshot_id #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.iops #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.throughput #=> Integer
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications #=> Array
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].resource_type #=> String, one of "volume"
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags #=> Array
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].key #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].tags[0].value #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.tag_specifications[0].propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.role_arn #=> String
resp.service.deployments[0].volume_configurations[0].managed_ebs_volume.filesystem_type #=> String, one of "ext3", "ext4", "xfs", "ntfs"
resp.service.deployments[0].fargate_ephemeral_storage.kms_key_id #=> String
resp.service.deployments[0].vpc_lattice_configurations #=> Array
resp.service.deployments[0].vpc_lattice_configurations[0].role_arn #=> String
resp.service.deployments[0].vpc_lattice_configurations[0].target_group_arn #=> String
resp.service.deployments[0].vpc_lattice_configurations[0].port_name #=> String
resp.service.role_arn #=> String
resp.service.events #=> Array
resp.service.events[0].id #=> String
resp.service.events[0].created_at #=> Time
resp.service.events[0].message #=> String
resp.service.created_at #=> Time
resp.service.placement_constraints #=> Array
resp.service.placement_constraints[0].type #=> String, one of "distinctInstance", "memberOf"
resp.service.placement_constraints[0].expression #=> String
resp.service.placement_strategy #=> Array
resp.service.placement_strategy[0].type #=> String, one of "random", "spread", "binpack"
resp.service.placement_strategy[0].field #=> String
resp.service.network_configuration.awsvpc_configuration.subnets #=> Array
resp.service.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.service.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.service.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.service.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.service.health_check_grace_period_seconds #=> Integer
resp.service.scheduling_strategy #=> String, one of "REPLICA", "DAEMON"
resp.service.deployment_controller.type #=> String, one of "ECS", "CODE_DEPLOY", "EXTERNAL"
resp.service.tags #=> Array
resp.service.tags[0].key #=> String
resp.service.tags[0].value #=> String
resp.service.created_by #=> String
resp.service.enable_ecs_managed_tags #=> Boolean
resp.service.propagate_tags #=> String, one of "TASK_DEFINITION", "SERVICE", "NONE"
resp.service.enable_execute_command #=> Boolean
resp.service.availability_zone_rebalancing #=> String, one of "ENABLED", "DISABLED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on. If you do not specify a cluster, the default cluster is assumed.

  • :service (required, String) —

    The name of the service to update.

  • :desired_count (Integer) —

    The number of instantiations of the task to place and keep running in your service.

  • :task_definition (String) —

    The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

  • :capacity_provider_strategy (Array<Types::CapacityProviderStrategyItem>) —

    The capacity provider strategy to update the service to use.

    if the service uses the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that's not the default capacity provider strategy, the service can't be updated to use the cluster's default capacity provider strategy.

    A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateClusterCapacityProvider API operation.

    To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

    The PutClusterCapacityProvidersAPI operation is used to update the list of available capacity providers for a cluster after the cluster is created.

  • :deployment_configuration (Types::DeploymentConfiguration) —

    Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

  • :availability_zone_rebalancing (String) —

    Indicates whether to use Availability Zone rebalancing for the service.

    For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide.

  • :network_configuration (Types::NetworkConfiguration) —

    An object representing the network configuration for the service.

  • :placement_constraints (Array<Types::PlacementConstraint>) —

    An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.

    You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

  • :placement_strategy (Array<Types::PlacementStrategy>) —

    The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.

    You can specify a maximum of five strategy rules for each service.

  • :platform_version (String) —

    The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

  • :force_new_deployment (Boolean) —

    Determines whether to force a new deployment of the service. By default, deployments aren't forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.

  • :health_check_grace_period_seconds (Integer) —

    The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of 0 is used. If you don't use any of the health checks, then healthCheckGracePeriodSeconds is unused.

    If your service's tasks take a while to start and respond to health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

  • :enable_execute_command (Boolean) —

    If true, this enables execute command functionality on all task containers.

    If you do not want to override the value that was set when the service was created, you can set this to null when performing this action.

  • :enable_ecs_managed_tags (Boolean) —

    Determines whether to turn on Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

    Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

  • :load_balancers (Array<Types::LoadBalancer>) —

    A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.

    When you add, update, or remove a load balancer configuration, Amazon ECS starts new tasks with the updated Elastic Load Balancing configuration, and then stops the old tasks when the new tasks are running.

    For services that use rolling updates, you can add, update, or remove Elastic Load Balancing target groups. You can update from a single target group to multiple target groups and from multiple target groups to a single target group.

    For services that use blue/green deployments, you can update Elastic Load Balancing target groups by using CreateDeployment through CodeDeploy. Note that multiple target groups are not supported for blue/green deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

    For services that use the external deployment controller, you can add, update, or remove load balancers by using CreateTaskSet. Note that multiple target groups are not supported for external deployments. For more information see Register multiple target groups with a service in the Amazon Elastic Container Service Developer Guide.

    You can remove existing loadBalancers by passing an empty list.

  • :propagate_tags (String) —

    Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

    Only tasks launched after the update will reflect the update. To update the tags on all tasks, set forceNewDeployment to true, so that Amazon ECS starts new tasks with the updated tags.

  • :service_registries (Array<Types::ServiceRegistry>) —

    The details for the service discovery registries to assign to this service. For more information, see Service Discovery.

    When you add, update, or remove the service registries configuration, Amazon ECS starts new tasks with the updated service registries configuration, and then stops the old tasks when the new tasks are running.

    You can remove existing serviceRegistries by passing an empty list.

  • :service_connect_configuration (Types::ServiceConnectConfiguration) —

    The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

    Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

  • :volume_configurations (Array<Types::ServiceVolumeConfiguration>) —

    The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition. If set to null, no new deployment is triggered. Otherwise, if this configuration differs from the existing one, it triggers a new deployment.

  • :vpc_lattice_configurations (Array<Types::VpcLatticeConfiguration>) —

    An object representing the VPC Lattice configuration for the service being updated.

Returns:

See Also:



10425
10426
10427
10428
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 10425

def update_service(params = {}, options = {})
  req = build_request(:update_service, params)
  req.send_request(options)
end

#update_service_primary_task_set(params = {}) ⇒ Types::UpdateServicePrimaryTaskSetResponse

Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_service_primary_task_set({
  cluster: "String", # required
  service: "String", # required
  primary_task_set: "String", # required
})

Response structure


resp.task_set.id #=> String
resp.task_set.task_set_arn #=> String
resp.task_set.service_arn #=> String
resp.task_set.cluster_arn #=> String
resp.task_set.started_by #=> String
resp.task_set.external_id #=> String
resp.task_set.status #=> String
resp.task_set.task_definition #=> String
resp.task_set.computed_desired_count #=> Integer
resp.task_set.pending_count #=> Integer
resp.task_set.running_count #=> Integer
resp.task_set.created_at #=> Time
resp.task_set.updated_at #=> Time
resp.task_set.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_set.capacity_provider_strategy #=> Array
resp.task_set.capacity_provider_strategy[0].capacity_provider #=> String
resp.task_set.capacity_provider_strategy[0].weight #=> Integer
resp.task_set.capacity_provider_strategy[0].base #=> Integer
resp.task_set.platform_version #=> String
resp.task_set.platform_family #=> String
resp.task_set.network_configuration.awsvpc_configuration.subnets #=> Array
resp.task_set.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.task_set.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.task_set.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.task_set.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.task_set.load_balancers #=> Array
resp.task_set.load_balancers[0].target_group_arn #=> String
resp.task_set.load_balancers[0].load_balancer_name #=> String
resp.task_set.load_balancers[0].container_name #=> String
resp.task_set.load_balancers[0].container_port #=> Integer
resp.task_set.service_registries #=> Array
resp.task_set.service_registries[0].registry_arn #=> String
resp.task_set.service_registries[0].port #=> Integer
resp.task_set.service_registries[0].container_name #=> String
resp.task_set.service_registries[0].container_port #=> Integer
resp.task_set.scale.value #=> Float
resp.task_set.scale.unit #=> String, one of "PERCENT"
resp.task_set.stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.task_set.stability_status_at #=> Time
resp.task_set.tags #=> Array
resp.task_set.tags[0].key #=> String
resp.task_set.tags[0].value #=> String
resp.task_set.fargate_ephemeral_storage.kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (required, String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.

  • :service (required, String) —

    The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

  • :primary_task_set (required, String) —

    The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.

Returns:

See Also:



10515
10516
10517
10518
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 10515

def update_service_primary_task_set(params = {}, options = {})
  req = build_request(:update_service_primary_task_set, params)
  req.send_request(options)
end

#update_task_protection(params = {}) ⇒ Types::UpdateTaskProtectionResponse

Updates the protection status of a task. You can set protectionEnabled to true to protect your task from termination during scale-in events from Service Autoscaling or deployments.

Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the protectionEnabled property making the task eligible for termination by a subsequent scale-in event.

You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes (48 hours). To specify the custom expiration period, set the expiresInMinutes property. The expiresInMinutes property is always reset when you invoke this operation for a task that already has protectionEnabled set to true. You can keep extending the protection expiration period of a task by invoking this operation repeatedly.

To learn more about Amazon ECS task protection, see Task scale-in protection in the Amazon Elastic Container Service Developer Guide .

This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation for a standalone task will result in an TASK_NOT_VALID failure. For more information, see API failure reasons.

If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint.

Examples:

Example: To set task scale-in protection for a task for 60 minutes


# This example enables scale-in protection for a task for 60 minutes.

resp = client.update_task_protection({
  cluster: "test-task-protection", 
  expires_in_minutes: 60, 
  protection_enabled: true, 
  tasks: [
    "b8b1cf532d0e46ba8d44a40d1de16772", 
  ], 
})

resp.to_h outputs the following:
{
  failures: [
  ], 
  protected_tasks: [
    {
      expiration_date: Time.parse("2022-11-02T06:56:32.553Z"), 
      protection_enabled: true, 
      task_arn: "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772", 
    }, 
  ], 
}

Example: To set task scale-in protection for the default time period in minutes


# This example enables task scale-in protection for a task, without specifying the expiresInMinutes parameter, for the
# default protection period of 120 minutes.

resp = client.update_task_protection({
  cluster: "test-task-protection", 
  protection_enabled: true, 
  tasks: [
    "b8b1cf532d0e46ba8d44a40d1de16772", 
  ], 
})

resp.to_h outputs the following:
{
  failures: [
  ], 
  protected_tasks: [
    {
      expiration_date: Time.parse("2022-11-02T06:56:32.553Z"), 
      protection_enabled: true, 
      task_arn: "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772", 
    }, 
  ], 
}

Example: To remove task scale-in protection


# This example removes scale-in protection for a task.

resp = client.update_task_protection({
  cluster: "test-task-protection", 
  protection_enabled: false, 
  tasks: [
    "b8b1cf532d0e46ba8d44a40d1de16772", 
  ], 
})

resp.to_h outputs the following:
{
  failures: [
  ], 
  protected_tasks: [
    {
      protection_enabled: false, 
      task_arn: "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.update_task_protection({
  cluster: "String", # required
  tasks: ["String"], # required
  protection_enabled: false, # required
  expires_in_minutes: 1,
})

Response structure


resp.protected_tasks #=> Array
resp.protected_tasks[0].task_arn #=> String
resp.protected_tasks[0].protection_enabled #=> Boolean
resp.protected_tasks[0].expiration_date #=> Time
resp.failures #=> Array
resp.failures[0].arn #=> String
resp.failures[0].reason #=> String
resp.failures[0].detail #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (required, String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

  • :tasks (required, Array<String>) —

    A list of up to 10 task IDs or full ARN entries.

  • :protection_enabled (required, Boolean) —

    Specify true to mark a task for protection and false to unset protection, making it eligible for termination.

  • :expires_in_minutes (Integer) —

    If you set protectionEnabled to true, you can specify the duration for task protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in events from Service Auto Scaling or deployments. After this time period lapses, protectionEnabled will be reset to false.

    If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).

Returns:

See Also:



10687
10688
10689
10690
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 10687

def update_task_protection(params = {}, options = {})
  req = build_request(:update_task_protection, params)
  req.send_request(options)
end

#update_task_set(params = {}) ⇒ Types::UpdateTaskSetResponse

Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_task_set({
  cluster: "String", # required
  service: "String", # required
  task_set: "String", # required
  scale: { # required
    value: 1.0,
    unit: "PERCENT", # accepts PERCENT
  },
})

Response structure


resp.task_set.id #=> String
resp.task_set.task_set_arn #=> String
resp.task_set.service_arn #=> String
resp.task_set.cluster_arn #=> String
resp.task_set.started_by #=> String
resp.task_set.external_id #=> String
resp.task_set.status #=> String
resp.task_set.task_definition #=> String
resp.task_set.computed_desired_count #=> Integer
resp.task_set.pending_count #=> Integer
resp.task_set.running_count #=> Integer
resp.task_set.created_at #=> Time
resp.task_set.updated_at #=> Time
resp.task_set.launch_type #=> String, one of "EC2", "FARGATE", "EXTERNAL"
resp.task_set.capacity_provider_strategy #=> Array
resp.task_set.capacity_provider_strategy[0].capacity_provider #=> String
resp.task_set.capacity_provider_strategy[0].weight #=> Integer
resp.task_set.capacity_provider_strategy[0].base #=> Integer
resp.task_set.platform_version #=> String
resp.task_set.platform_family #=> String
resp.task_set.network_configuration.awsvpc_configuration.subnets #=> Array
resp.task_set.network_configuration.awsvpc_configuration.subnets[0] #=> String
resp.task_set.network_configuration.awsvpc_configuration.security_groups #=> Array
resp.task_set.network_configuration.awsvpc_configuration.security_groups[0] #=> String
resp.task_set.network_configuration.awsvpc_configuration.assign_public_ip #=> String, one of "ENABLED", "DISABLED"
resp.task_set.load_balancers #=> Array
resp.task_set.load_balancers[0].target_group_arn #=> String
resp.task_set.load_balancers[0].load_balancer_name #=> String
resp.task_set.load_balancers[0].container_name #=> String
resp.task_set.load_balancers[0].container_port #=> Integer
resp.task_set.service_registries #=> Array
resp.task_set.service_registries[0].registry_arn #=> String
resp.task_set.service_registries[0].port #=> Integer
resp.task_set.service_registries[0].container_name #=> String
resp.task_set.service_registries[0].container_port #=> Integer
resp.task_set.scale.value #=> Float
resp.task_set.scale.unit #=> String, one of "PERCENT"
resp.task_set.stability_status #=> String, one of "STEADY_STATE", "STABILIZING"
resp.task_set.stability_status_at #=> Time
resp.task_set.tags #=> Array
resp.task_set.tags[0].key #=> String
resp.task_set.tags[0].value #=> String
resp.task_set.fargate_ephemeral_storage.kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster (required, String) —

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set is found in.

  • :service (required, String) —

    The short name or full Amazon Resource Name (ARN) of the service that the task set is found in.

  • :task_set (required, String) —

    The short name or full Amazon Resource Name (ARN) of the task set to update.

  • :scale (required, Types::Scale) —

    A floating-point percentage of the desired number of tasks to place and keep running in the task set.

Returns:

See Also:



10783
10784
10785
10786
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 10783

def update_task_set(params = {}, options = {})
  req = build_request(:update_task_set, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
services_inactive #describe_services 15 40
services_stable #describe_services 15 40
tasks_running #describe_tasks 6 100
tasks_stopped #describe_tasks 6 100

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



10901
10902
10903
10904
10905
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 10901

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end