List Task Definitions

ecs_list_task_definitions

R Documentation

Returns a list of task definitions that are registered to your account

Description

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.

Usage

ecs_list_task_definitions(familyPrefix, status, sort, nextToken,
  maxResults)

Arguments

familyPrefix

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

status

The task definition status to filter the list_task_definitions 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

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.

nextToken

The nextToken value returned from a list_task_definitions 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.

maxResults

The maximum number of task definition results that list_task_definitions returned in paginated output. When this parameter is used, list_task_definitions 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 list_task_definitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then list_task_definitions returns up to 100 results and a nextToken value if applicable.

Value

A list with the following syntax:

list(
  taskDefinitionArns = list(
    "string"
  ),
  nextToken = "string"
)

Request syntax

svc$list_task_definitions(
  familyPrefix = "string",
  status = "ACTIVE"|"INACTIVE"|"DELETE_IN_PROGRESS",
  sort = "ASC"|"DESC",
  nextToken = "string",
  maxResults = 123
)

Examples

## Not run: 
# This example lists all of your registered task definitions.
svc$list_task_definitions()

# This example lists the task definition revisions of a specified family.
svc$list_task_definitions(
  familyPrefix = "wordpress"
)

## End(Not run)