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], 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 instantiation of the task in
the specified cluster. To update an existing service, see
UpdateService.

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

If the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent 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 do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for minimumHealthyPercent 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 running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks, a maximumPercent value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximumPercent is 200%.

When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones 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).
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.

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.

When you terminate a container instance, it is automatically deregistered from your cluster.

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]])

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], [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], [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], [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.

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, MaxResults => Int, NextToken => 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.

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])

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 definitions). You can filter the results with the
C<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.

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

RunTask(TaskDefinition => Str, [Cluster => Str, Count => Int, Overrides => Paws::ECS::TaskOverride, StartedBy => Str])

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

Returns: a Paws::ECS::RunTaskResponse instance

Start a task using random placement and the default Amazon ECS
scheduler. To use your own scheduler or place a task on a specific
container instance, use C<StartTask> instead.

The count parameter is limited to 10 tasks per call.

StartTask(ContainerInstances => ArrayRef[Str], TaskDefinition => Str, [Cluster => 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. To use the default Amazon ECS
scheduler to place your task, use C<RunTask> instead.

The list of container instances to start tasks on is limited to 10.

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.

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.

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.