NAME

Paws::ECS - Perl Interface to AWS Amazon EC2 Container Service

SYNOPSIS

  use Paws;

  my $obj = Paws->service('ECS');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

METHODS

CreateCluster([ClusterName => Str])

Each argument is described in detail in: Paws::ECS::CreateCluster

Returns: a Paws::ECS::CreateClusterResponse instance

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

CreateService(DesiredCount => Int, ServiceName => Str, TaskDefinition => Str, [ClientToken => Str, Cluster => Str, DeploymentConfiguration => Paws::ECS::DeploymentConfiguration, LoadBalancers => ArrayRef[Paws::ECS::LoadBalancer], PlacementConstraints => ArrayRef[Paws::ECS::PlacementConstraint], PlacementStrategy => ArrayRef[Paws::ECS::PlacementStrategy], Role => Str])

Each argument is described in detail in: Paws::ECS::CreateService

Returns: a Paws::ECS::CreateServiceResponse instance

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

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon EC2 Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition or the desired count of a service with an UpdateService operation), the service scheduler uses the minimumHealthyPercent and maximumPercent parameters to determine the deployment strategy.

The minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if desiredCount is four tasks and the minimum is 50%, the scheduler can 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 are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The default value is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.

The maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if desiredCount is four tasks and the maximum is 200%, the scheduler can start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value is 200%.

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

DeleteAttributes(Attributes => ArrayRef[Paws::ECS::Attribute], [Cluster => Str])

Each argument is described in detail in: Paws::ECS::DeleteAttributes

Returns: a Paws::ECS::DeleteAttributesResponse instance

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

DeleteCluster(Cluster => Str)

Each argument is described in detail in: Paws::ECS::DeleteCluster

Returns: a Paws::ECS::DeleteClusterResponse instance

  Deletes the specified cluster. 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.

DeleteService(Service => Str, [Cluster => Str])

Each argument is described in detail in: Paws::ECS::DeleteService

Returns: a Paws::ECS::DeleteServiceResponse instance

  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.

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 ListServices API operations. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with DescribeServices API operations; however, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices API operations on those services will return a ServiceNotFoundException error.

DeregisterContainerInstance(ContainerInstance => Str, [Cluster => Str, Force => Bool])

Each argument is described in detail in: Paws::ECS::DeregisterContainerInstance

Returns: a Paws::ECS::DeregisterContainerInstanceResponse instance

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

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

DeregisterTaskDefinition(TaskDefinition => Str)

Each argument is described in detail in: Paws::ECS::DeregisterTaskDefinition

Returns: a Paws::ECS::DeregisterTaskDefinitionResponse instance

  Deregisters the specified task definition by family and revision. Upon
deregistration, the task definition is marked as C<INACTIVE>. Existing
tasks and services that reference an C<INACTIVE> task definition
continue to run without disruption. Existing services that reference an
C<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 (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).

DescribeClusters([Clusters => ArrayRef[Str|Undef]])

Each argument is described in detail in: Paws::ECS::DescribeClusters

Returns: a Paws::ECS::DescribeClustersResponse instance

  Describes one or more of your clusters.

DescribeContainerInstances(ContainerInstances => ArrayRef[Str|Undef], [Cluster => Str])

Each argument is described in detail in: Paws::ECS::DescribeContainerInstances

Returns: a Paws::ECS::DescribeContainerInstancesResponse instance

  Describes Amazon EC2 Container Service container instances. Returns
metadata about registered and remaining resources on each container
instance requested.

DescribeServices(Services => ArrayRef[Str|Undef], [Cluster => Str])

Each argument is described in detail in: Paws::ECS::DescribeServices

Returns: a Paws::ECS::DescribeServicesResponse instance

  Describes the specified services running in your cluster.

DescribeTaskDefinition(TaskDefinition => Str)

Each argument is described in detail in: Paws::ECS::DescribeTaskDefinition

Returns: a Paws::ECS::DescribeTaskDefinitionResponse instance

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

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

DescribeTasks(Tasks => ArrayRef[Str|Undef], [Cluster => Str])

Each argument is described in detail in: Paws::ECS::DescribeTasks

Returns: a Paws::ECS::DescribeTasksResponse instance

  Describes a specified task or tasks.

DiscoverPollEndpoint([Cluster => Str, ContainerInstance => Str])

Each argument is described in detail in: Paws::ECS::DiscoverPollEndpoint

Returns: a Paws::ECS::DiscoverPollEndpointResponse instance

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

Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.

ListAttributes(TargetType => Str, [AttributeName => Str, AttributeValue => Str, Cluster => Str, MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::ECS::ListAttributes

Returns: a Paws::ECS::ListAttributesResponse instance

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

ListClusters([MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::ECS::ListClusters

Returns: a Paws::ECS::ListClustersResponse instance

  Returns a list of existing clusters.

ListContainerInstances([Cluster => Str, Filter => Str, MaxResults => Int, NextToken => Str, Status => Str])

Each argument is described in detail in: Paws::ECS::ListContainerInstances

Returns: a Paws::ECS::ListContainerInstancesResponse instance

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

ListServices([Cluster => Str, MaxResults => Int, NextToken => Str])

Each argument is described in detail in: Paws::ECS::ListServices

Returns: a Paws::ECS::ListServicesResponse instance

  Lists the services that are running in a specified cluster.

ListTaskDefinitionFamilies([FamilyPrefix => Str, MaxResults => Int, NextToken => Str, Status => Str])

Each argument is described in detail in: Paws::ECS::ListTaskDefinitionFamilies

Returns: a Paws::ECS::ListTaskDefinitionFamiliesResponse instance

  Returns a list of task definition families that are registered to your
account (which may include task definition families that no longer have
any C<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.

ListTaskDefinitions([FamilyPrefix => Str, MaxResults => Int, NextToken => Str, Sort => Str, Status => Str])

Each argument is described in detail in: Paws::ECS::ListTaskDefinitions

Returns: a Paws::ECS::ListTaskDefinitionsResponse instance

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

ListTasks([Cluster => Str, ContainerInstance => Str, DesiredStatus => Str, Family => Str, MaxResults => Int, NextToken => Str, ServiceName => Str, StartedBy => Str])

Each argument is described in detail in: Paws::ECS::ListTasks

Returns: a Paws::ECS::ListTasksResponse instance

  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 C<family>, C<containerInstance>,
and C<desiredStatus> parameters.

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

PutAttributes(Attributes => ArrayRef[Paws::ECS::Attribute], [Cluster => Str])

Each argument is described in detail in: Paws::ECS::PutAttributes

Returns: a Paws::ECS::PutAttributesResponse instance

  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 I<Amazon
EC2 Container Service Developer Guide>.

RegisterContainerInstance([Attributes => ArrayRef[Paws::ECS::Attribute], Cluster => Str, ContainerInstanceArn => Str, InstanceIdentityDocument => Str, InstanceIdentityDocumentSignature => Str, TotalResources => ArrayRef[Paws::ECS::Resource], VersionInfo => Paws::ECS::VersionInfo])

Each argument is described in detail in: Paws::ECS::RegisterContainerInstance

Returns: a Paws::ECS::RegisterContainerInstanceResponse instance

  This action is only used by the Amazon EC2 Container Service 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.

RegisterTaskDefinition(ContainerDefinitions => ArrayRef[Paws::ECS::ContainerDefinition], Family => Str, [NetworkMode => Str, PlacementConstraints => ArrayRef[Paws::ECS::TaskDefinitionPlacementConstraint], TaskRoleArn => Str, Volumes => ArrayRef[Paws::ECS::Volume]])

Each argument is described in detail in: Paws::ECS::RegisterTaskDefinition

Returns: a Paws::ECS::RegisterTaskDefinitionResponse instance

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

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

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference.

RunTask(TaskDefinition => Str, [Cluster => Str, Count => Int, Group => Str, Overrides => Paws::ECS::TaskOverride, PlacementConstraints => ArrayRef[Paws::ECS::PlacementConstraint], PlacementStrategy => ArrayRef[Paws::ECS::PlacementStrategy], StartedBy => Str])

Each argument is described in detail in: Paws::ECS::RunTask

Returns: a Paws::ECS::RunTaskResponse instance

  Starts a new task using the specified task definition.

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 EC2 Container Service Developer Guide.

Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.

StartTask(ContainerInstances => ArrayRef[Str|Undef], TaskDefinition => Str, [Cluster => Str, Group => Str, Overrides => Paws::ECS::TaskOverride, StartedBy => Str])

Each argument is described in detail in: Paws::ECS::StartTask

Returns: a Paws::ECS::StartTaskResponse instance

  Starts a new task from the specified task definition on the specified
container instance or instances.

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon EC2 Container Service Developer Guide.

StopTask(Task => Str, [Cluster => Str, Reason => Str])

Each argument is described in detail in: Paws::ECS::StopTask

Returns: a Paws::ECS::StopTaskResponse instance

  Stops a running task.

When StopTask is called on a task, 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 which 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.

SubmitContainerStateChange([Cluster => Str, ContainerName => Str, ExitCode => Int, NetworkBindings => ArrayRef[Paws::ECS::NetworkBinding], Reason => Str, Status => Str, Task => Str])

Each argument is described in detail in: Paws::ECS::SubmitContainerStateChange

Returns: a Paws::ECS::SubmitContainerStateChangeResponse instance

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

Sent to acknowledge that a container changed states.

SubmitTaskStateChange([Cluster => Str, Reason => Str, Status => Str, Task => Str])

Each argument is described in detail in: Paws::ECS::SubmitTaskStateChange

Returns: a Paws::ECS::SubmitTaskStateChangeResponse instance

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

Sent to acknowledge that a task changed states.

UpdateContainerAgent(ContainerInstance => Str, [Cluster => Str])

Each argument is described in detail in: Paws::ECS::UpdateContainerAgent

Returns: a Paws::ECS::UpdateContainerAgentResponse instance

  Updates the Amazon ECS container agent on a specified container
instance. Updating the Amazon ECS container agent does not 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.

UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux 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 EC2 Container Service Developer Guide.

UpdateContainerInstancesState(ContainerInstances => ArrayRef[Str|Undef], Status => Str, [Cluster => Str])

Each argument is described in detail in: Paws::ECS::UpdateContainerInstancesState

Returns: a Paws::ECS::UpdateContainerInstancesStateResponse instance

  Modifies the status of an Amazon ECS container instance.

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.

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 the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. Note that 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 are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount of 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 are not 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 you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on the instance again.

UpdateService(Service => Str, [Cluster => Str, DeploymentConfiguration => Paws::ECS::DeploymentConfiguration, DesiredCount => Int, TaskDefinition => Str])

Each argument is described in detail in: Paws::ECS::UpdateService

Returns: a Paws::ECS::UpdateServiceResponse instance

  Modifies the desired count, deployment configuration, or task
definition used in a service.

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 use UpdateService to modify your task definition and deploy a new version of your service.

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 do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you 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 which 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 (although 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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results