Skip to content

List Daemon Task Definitions

ecs_list_daemon_task_definitions R Documentation

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

Description

Returns a list of daemon task definitions that are registered to your account. You can filter the results by family name, status, or both to find daemon task definitions that match your criteria.

Usage

ecs_list_daemon_task_definitions(familyPrefix, family, revision, status,
  sort, nextToken, maxResults)

Arguments

familyPrefix

The full family name to filter the list_daemon_task_definitions results with. Specifying a familyPrefix limits the listed daemon task definitions to daemon task definition families that start with the familyPrefix string.

family

The exact name of the daemon task definition family to filter results with.

revision

The revision filter to apply. Specify LAST_REGISTERED to return only the last registered revision for each daemon task definition family.

status

The daemon task definition status to filter the list_daemon_task_definitions results with. By default, only ACTIVE daemon task definitions are listed. If you set this parameter to DELETE_IN_PROGRESS, only daemon task definitions that are in the process of being deleted are listed. If you set this parameter to ALL, all daemon task definitions are listed regardless of status.

sort

The order to sort the results. Valid values are ASC and DESC. By default (ASC), daemon task definitions are listed in ascending order by family name and revision number.

nextToken

The nextToken value returned from a list_daemon_task_definitions request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible for 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 daemon task definition results that list_daemon_task_definitions returned in paginated output. When this parameter is used, list_daemon_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_daemon_task_definitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then list_daemon_task_definitions returns up to 100 results and a nextToken value if applicable.

Value

A list with the following syntax:

list(
  daemonTaskDefinitions = list(
    list(
      arn = "string",
      registeredAt = as.POSIXct(
        "2015-01-01"
      ),
      registeredBy = "string",
      deleteRequestedAt = as.POSIXct(
        "2015-01-01"
      ),
      status = "ACTIVE"|"DELETE_IN_PROGRESS"|"DELETED"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_daemon_task_definitions(
  familyPrefix = "string",
  family = "string",
  revision = "LAST_REGISTERED",
  status = "ACTIVE"|"DELETE_IN_PROGRESS"|"ALL",
  sort = "ASC"|"DESC",
  nextToken = "string",
  maxResults = 123
)