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¶
Arguments¶
familyPrefix
The full family name to filter the
list_task_definitions
results with. Specifying afamilyPrefix
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, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.sort
The order to sort the results in. Valid values are
ASC
andDESC
. 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 toDESC
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 alist_task_definitions
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it is possible the number of results to be fewer thanmaxResults
.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 returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherlist_task_definitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenlist_task_definitions
returns up to 100 results and anextToken
value if applicable.
Value¶
A list with the following syntax:
Request syntax¶
svc$list_task_definitions(
familyPrefix = "string",
status = "ACTIVE"|"INACTIVE"|"DELETE_IN_PROGRESS",
sort = "ASC"|"DESC",
nextToken = "string",
maxResults = 123
)