NAME
Paws::ECS::ListTasks - Arguments for method ListTasks on Paws::ECS
DESCRIPTION
This class represents the parameters used for calling the method ListTasks on the Amazon EC2 Container Service service. Use the attributes of this class as arguments to method ListTasks.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTasks.
SYNOPSIS
my $ecs = Paws->service('ECS');
# To list the tasks in a cluster
# This example lists all of the tasks in a cluster.
my $ListTasksResponse = $ecs->ListTasks( 'Cluster' => 'default' );
# Results:
my $taskArns = $ListTasksResponse->taskArns;
# Returns a L<Paws::ECS::ListTasksResponse> object.
# 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.
my $ListTasksResponse = $ecs->ListTasks(
'Cluster' => 'default',
'ContainerInstance' => 'f6bbb147-5370-4ace-8c73-c7181ded911f'
);
# Results:
my $taskArns = $ListTasksResponse->taskArns;
# Returns a L<Paws::ECS::ListTasksResponse> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ecs/ListTasks
ATTRIBUTES
Cluster => Str
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.
ContainerInstance => Str
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.
DesiredStatus => Str
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 are not 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 does not 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).
Valid values are: "RUNNING", "PENDING", "STOPPED"
Family => Str
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.
LaunchType => Str
The launch type to use when filtering the ListTasks results.
Valid values are: "EC2", "FARGATE", "EXTERNAL"
MaxResults => Int
The maximum number of task results returned by ListTasks 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 is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.
NextToken => Str
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 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.
ServiceName => Str
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.
StartedBy => Str
The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.
SEE ALSO
This class forms part of Paws, documenting arguments for method ListTasks in Paws::ECS
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues