Class: Aws::ECS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ECS::Client
- 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
API Operations collapse
-
#create_capacity_provider(params = {}) ⇒ Types::CreateCapacityProviderResponse
Creates a new capacity provider.
-
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a new Amazon ECS cluster.
-
#create_service(params = {}) ⇒ Types::CreateServiceResponse
Runs and maintains a desired number of tasks from a specified task definition.
-
#create_task_set(params = {}) ⇒ Types::CreateTaskSetResponse
Create a task set in the specified cluster and service.
-
#delete_account_setting(params = {}) ⇒ Types::DeleteAccountSettingResponse
Disables an account setting for a specified IAM user, IAM role, or the root user for an account.
-
#delete_attributes(params = {}) ⇒ Types::DeleteAttributesResponse
Deletes one or more custom attributes from an Amazon ECS resource.
-
#delete_capacity_provider(params = {}) ⇒ Types::DeleteCapacityProviderResponse
Deletes the specified capacity provider.
-
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes the specified cluster.
-
#delete_service(params = {}) ⇒ Types::DeleteServiceResponse
Deletes a specified service within a cluster.
-
#delete_task_set(params = {}) ⇒ Types::DeleteTaskSetResponse
Deletes a specified task set within a service.
-
#deregister_container_instance(params = {}) ⇒ Types::DeregisterContainerInstanceResponse
Deregisters an Amazon ECS container instance from the specified cluster.
-
#deregister_task_definition(params = {}) ⇒ Types::DeregisterTaskDefinitionResponse
Deregisters the specified task definition by family and revision.
-
#describe_capacity_providers(params = {}) ⇒ Types::DescribeCapacityProvidersResponse
Describes one or more of your capacity providers.
-
#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse
Describes one or more of your clusters.
-
#describe_container_instances(params = {}) ⇒ Types::DescribeContainerInstancesResponse
Describes Amazon Elastic Container Service container instances.
-
#describe_services(params = {}) ⇒ Types::DescribeServicesResponse
Describes the specified services running in your cluster.
-
#describe_task_definition(params = {}) ⇒ Types::DescribeTaskDefinitionResponse
Describes a task definition.
-
#describe_task_sets(params = {}) ⇒ Types::DescribeTaskSetsResponse
Describes the task sets in the specified cluster and service.
-
#describe_tasks(params = {}) ⇒ Types::DescribeTasksResponse
Describes a specified task or tasks.
-
#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. -
#list_account_settings(params = {}) ⇒ Types::ListAccountSettingsResponse
Lists the account settings for a specified principal.
-
#list_attributes(params = {}) ⇒ Types::ListAttributesResponse
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
-
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Returns a list of existing clusters.
-
#list_container_instances(params = {}) ⇒ Types::ListContainerInstancesResponse
Returns a list of container instances in a specified cluster.
-
#list_services(params = {}) ⇒ Types::ListServicesResponse
Lists the services that are running in a specified cluster.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for an Amazon ECS resource.
-
#list_task_definition_families(params = {}) ⇒ Types::ListTaskDefinitionFamiliesResponse
Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any
ACTIVE
task definition revisions). -
#list_task_definitions(params = {}) ⇒ Types::ListTaskDefinitionsResponse
Returns a list of task definitions that are registered to your account.
-
#list_tasks(params = {}) ⇒ Types::ListTasksResponse
Returns a list of tasks for a specified cluster.
-
#put_account_setting(params = {}) ⇒ Types::PutAccountSettingResponse
Modifies an account setting.
-
#put_account_setting_default(params = {}) ⇒ Types::PutAccountSettingDefaultResponse
Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified.
-
#put_attributes(params = {}) ⇒ Types::PutAttributesResponse
Create or update an attribute on an Amazon ECS resource.
-
#put_cluster_capacity_providers(params = {}) ⇒ Types::PutClusterCapacityProvidersResponse
Modifies the available capacity providers and the default capacity provider strategy for a cluster.
-
#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. -
#register_task_definition(params = {}) ⇒ Types::RegisterTaskDefinitionResponse
Registers a new task definition from the supplied
family
andcontainerDefinitions
. -
#run_task(params = {}) ⇒ Types::RunTaskResponse
Starts a new task using the specified task definition.
-
#start_task(params = {}) ⇒ Types::StartTaskResponse
Starts a new task from the specified task definition on the specified container instance or instances.
-
#stop_task(params = {}) ⇒ Types::StopTaskResponse
Stops a running task.
-
#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. -
#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. -
#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. -
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified
resourceArn
. -
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
-
#update_capacity_provider(params = {}) ⇒ Types::UpdateCapacityProviderResponse
Modifies the parameters for a capacity provider.
-
#update_cluster_settings(params = {}) ⇒ Types::UpdateClusterSettingsResponse
Modifies the settings to use for a cluster.
-
#update_container_agent(params = {}) ⇒ Types::UpdateContainerAgentResponse
Updates the Amazon ECS container agent on a specified container instance.
-
#update_container_instances_state(params = {}) ⇒ Types::UpdateContainerInstancesStateResponse
Modifies the status of an Amazon ECS container instance.
-
#update_service(params = {}) ⇒ Types::UpdateServiceResponse
Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at [https://aws.amazon.com/service-terms][1] ("Beta Terms").
-
#update_service_primary_task_set(params = {}) ⇒ Types::UpdateServicePrimaryTaskSetResponse
Modifies which task set in a service is the primary task set.
-
#update_task_set(params = {}) ⇒ Types::UpdateTaskSetResponse
Modifies a task set.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
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.
334 335 336 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 334 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 using an Auto Scaling group can be created.
Amazon ECS tasks on AWS Fargate use the FARGATE
and FARGATE_SPOT
capacity providers which are already created and available to all
accounts in Regions supported by AWS Fargate.
437 438 439 440 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 437 def create_capacity_provider(params = {}, = {}) req = build_request(:create_capacity_provider, params) req.send_request() 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 with the
CreateCluster
action.
636 637 638 639 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 636 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_service(params = {}) ⇒ Types::CreateServiceResponse
Runs and maintains a 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, see the
UpdateService action.
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.
Tasks for services that do not use a load balancer are considered
healthy if they're in the RUNNING
state. Tasks for services that
do use a load balancer are considered healthy if they're in the
RUNNING
state and the container instance that they're hosted on is
reported as healthy by the load balancer.
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. 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 and will stop tasks that do not 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 triggered by changing properties, such as
the task definition or the desired count of a service, with an
UpdateService operation. 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 is using 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,
as a percentage of the desired number of tasks (rounded up to the
nearest integer), and while any container instances are in the
DRAINING
state if the service contains tasks using the EC2 launch
type. This parameter enables you to deploy without using additional
cluster capacity. For example, if your service has a 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. Tasks for services that do not use a load balancer
are considered healthy if they're in the RUNNING
state. Tasks for
services that do use a load balancer are considered healthy if
they're in the RUNNING
state and they're reported as healthy by
the load balancer. The default value for minimum healthy percent is
100%.
If a service is using 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, as a percentage of the desired number of tasks
(rounded down to the nearest integer), and while any container
instances are in the DRAINING
state if the service contains tasks
using the EC2 launch type. This parameter enables you to 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 is using 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 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, although 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 operation. 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 in your cluster using 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 (although you can choose a different placement strategy) with the
placementStrategy
parameter):Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. 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.
1398 1399 1400 1401 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 1398 def create_service(params = {}, = {}) req = build_request(:create_service, params) req.send_request() 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.
1636 1637 1638 1639 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 1636 def create_task_set(params = {}, = {}) req = build_request(:create_task_set, params) req.send_request() end |
#delete_account_setting(params = {}) ⇒ Types::DeleteAccountSettingResponse
Disables an account setting for a specified IAM user, IAM role, or the root user for an account.
1720 1721 1722 1723 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 1720 def delete_account_setting(params = {}, = {}) req = build_request(:delete_account_setting, params) req.send_request() end |
#delete_attributes(params = {}) ⇒ Types::DeleteAttributesResponse
Deletes one or more custom attributes from an Amazon ECS resource.
1768 1769 1770 1771 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 1768 def delete_attributes(params = {}, = {}) req = build_request(:delete_attributes, params) req.send_request() end |
#delete_capacity_provider(params = {}) ⇒ Types::DeleteCapacityProviderResponse
Deletes the specified capacity provider.
FARGATE
and FARGATE_SPOT
capacity providers are reserved and
cannot be deleted. You can disassociate them from a cluster using
either the PutClusterCapacityProviders API 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 are not associated with a
cluster can be deleted. To remove a capacity provider from a cluster,
you can either use PutClusterCapacityProviders or delete the cluster.
1828 1829 1830 1831 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 1828 def delete_capacity_provider(params = {}, = {}) req = build_request(:delete_capacity_provider, params) req.send_request() end |
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes the specified cluster. The cluster will transition to the
INACTIVE
state. Clusters with an INACTIVE
status may remain
discoverable in your account for a period of time. However, this
behavior is subject to change in the future, so you should not 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.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 1917 def delete_cluster(params = {}, = {}) req = build_request(:delete_cluster, params) req.send_request() 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 cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
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.
2110 2111 2112 2113 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2110 def delete_service(params = {}, = {}) req = build_request(:delete_service, params) req.send_request() 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.
2201 2202 2203 2204 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2201 def delete_task_set(params = {}, = {}) req = build_request(:delete_task_set, params) req.send_request() 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, you should 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 does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
2334 2335 2336 2337 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2334 def deregister_container_instance(params = {}, = {}) req = build_request(:deregister_container_instance, params) req.send_request() 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.
You cannot use an INACTIVE
task definition to run new tasks or
create new services, and you cannot 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.
INACTIVE
task definitions remain discoverable in your
account indefinitely. However, this behavior is subject to change in
the future, so you should not rely on INACTIVE
task definitions
persisting beyond the lifecycle of any associated tasks and services.
2536 2537 2538 2539 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2536 def deregister_task_definition(params = {}, = {}) req = build_request(:deregister_task_definition, params) req.send_request() end |
#describe_capacity_providers(params = {}) ⇒ Types::DescribeCapacityProvidersResponse
Describes one or more of your capacity providers.
2621 2622 2623 2624 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2621 def describe_capacity_providers(params = {}, = {}) req = build_request(:describe_capacity_providers, params) req.send_request() end |
#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse
Describes one or more of your clusters.
2743 2744 2745 2746 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2743 def describe_clusters(params = {}, = {}) req = build_request(:describe_clusters, params) req.send_request() end |
#describe_container_instances(params = {}) ⇒ Types::DescribeContainerInstancesResponse
Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
2927 2928 2929 2930 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 2927 def describe_container_instances(params = {}, = {}) req = build_request(:describe_container_instances, params) req.send_request() 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
3155 3156 3157 3158 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3155 def describe_services(params = {}, = {}) req = build_request(:describe_services, params) req.send_request() 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.
INACTIVE
task definitions while an active task
or service references them.
3420 3421 3422 3423 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3420 def describe_task_definition(params = {}, = {}) req = build_request(:describe_task_definition, params) req.send_request() 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.
3517 3518 3519 3520 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3517 def describe_task_sets(params = {}, = {}) req = build_request(:describe_task_sets, params) req.send_request() end |
#describe_tasks(params = {}) ⇒ Types::DescribeTasksResponse
Describes a specified task or tasks.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- tasks_running
- tasks_stopped
3713 3714 3715 3716 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3713 def describe_tasks(params = {}, = {}) req = build_request(:describe_tasks, params) req.send_request() end |
#discover_poll_endpoint(params = {}) ⇒ Types::DiscoverPollEndpointResponse
Returns an endpoint for the Amazon ECS agent to poll for updates.
3758 3759 3760 3761 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3758 def discover_poll_endpoint(params = {}, = {}) req = build_request(:discover_poll_endpoint, params) req.send_request() 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.
3897 3898 3899 3900 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3897 def list_account_settings(params = {}, = {}) req = build_request(:list_account_settings, params) req.send_request() 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, 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.
3979 3980 3981 3982 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 3979 def list_attributes(params = {}, = {}) req = build_request(:list_attributes, params) req.send_request() 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.
4048 4049 4050 4051 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4048 def list_clusters(params = {}, = {}) req = build_request(:list_clusters, params) req.send_request() 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.
4152 4153 4154 4155 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4152 def list_container_instances(params = {}, = {}) req = build_request(:list_container_instances, params) req.send_request() end |
#list_services(params = {}) ⇒ Types::ListServicesResponse
Lists the services that are running in a specified cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4234 4235 4236 4237 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4234 def list_services(params = {}, = {}) req = build_request(:list_services, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for an Amazon ECS resource.
4285 4286 4287 4288 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4285 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_task_definition_families(params = {}) ⇒ Types::ListTaskDefinitionFamiliesResponse
Returns a list of task definition families that are registered to your
account (which may include task definition families that no longer
have any ACTIVE
task definition revisions).
You can filter out task definition families that do not 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.
4400 4401 4402 4403 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4400 def list_task_definition_families(params = {}, = {}) req = build_request(:list_task_definition_families, params) req.send_request() 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.
4520 4521 4522 4523 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4520 def list_task_definitions(params = {}, = {}) req = build_request(:list_task_definitions, params) req.send_request() end |
#list_tasks(params = {}) ⇒ Types::ListTasksResponse
Returns a list of tasks for a specified cluster. You can filter the
results by family name, by a particular container instance, or by the
desired status of the task with the family
, containerInstance
, and
desiredStatus
parameters.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4665 4666 4667 4668 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4665 def list_tasks(params = {}, = {}) req = build_request(:list_tasks, params) req.send_request() end |
#put_account_setting(params = {}) ⇒ Types::PutAccountSettingResponse
Modifies an account setting. Account settings are set on a per-Region basis.
If you change the account setting for the root user, the default settings for all of the IAM users and roles for which no individual account setting has been specified are reset. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.
When serviceLongArnFormat
, taskLongArnFormat
, or
containerInstanceLongArnFormat
are specified, the Amazon Resource
Name (ARN) and resource ID format of the resource type for a specified
IAM user, IAM role, or the root user for an account is affected. The
opt-in and opt-out account setting must be set for each Amazon ECS
resource separately. The ARN and resource ID format of a resource will
be defined by the opt-in status of the IAM user or role that created
the resource. You must enable this setting to use Amazon ECS features
such as resource tagging.
When awsvpcTrunking
is specified, the elastic network interface
(ENI) limit for any new container instances that support the feature
is changed. If awsvpcTrunking
is enabled, 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.
When containerInsights
is specified, the default setting indicating
whether CloudWatch Container Insights is enabled for your clusters is
changed. If containerInsights
is enabled, any new clusters that are
created will have Container Insights enabled unless you disable it
during cluster creation. For more information, see CloudWatch
Container Insights in the Amazon Elastic Container Service
Developer Guide.
4799 4800 4801 4802 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4799 def put_account_setting(params = {}, = {}) req = build_request(:put_account_setting, params) req.send_request() end |
#put_account_setting_default(params = {}) ⇒ Types::PutAccountSettingDefaultResponse
Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.
4866 4867 4868 4869 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4866 def put_account_setting_default(params = {}, = {}) req = build_request(:put_account_setting_default, params) req.send_request() end |
#put_attributes(params = {}) ⇒ Types::PutAttributesResponse
Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
4921 4922 4923 4924 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb', line 4921 def put_attributes(params = {}, = {}) req = build_request(:put_attributes, params) req.send_request() 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 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. It is recommended to define a
default capacity provider strategy for your cluster, however you may
specify an empty array ([]
) to bypass defining a default strategy.