ECS / Client / list_daemon_task_definitions

list_daemon_task_definitions

ECS.Client.list_daemon_task_definitions(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_daemon_task_definitions(
    familyPrefix='string',
    family='string',
    revision='LAST_REGISTERED',
    status='ACTIVE'|'DELETE_IN_PROGRESS'|'ALL',
    sort='ASC'|'DESC',
    nextToken='string',
    maxResults=123
)
Parameters:

  • familyPrefix (string) – The full family name to filter the ListDaemonTaskDefinitions results with. Specifying a familyPrefix limits the listed daemon task definitions to daemon task definition families that start with the familyPrefix string.

  • family (string) – The exact name of the daemon task definition family to filter results with.

  • revision (string) – The revision filter to apply. Specify LAST_REGISTERED to return only the last registered revision for each daemon task definition family.

  • status (string) – The daemon task definition status to filter the ListDaemonTaskDefinitions 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 (string) – 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 (string) –

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

    Note

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

Return type:

dict

Returns:

Response Syntax

{
    'daemonTaskDefinitions': [
        {
            'arn': 'string',
            'registeredAt': datetime(2015, 1, 1),
            'registeredBy': 'string',
            'deleteRequestedAt': datetime(2015, 1, 1),
            'status': 'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • daemonTaskDefinitions (list) –

      The list of daemon task definition summaries.

      • (dict) –

        A summary of a daemon task definition.

        • arn (string) –

          The Amazon Resource Name (ARN) of the daemon task definition.

        • registeredAt (datetime) –

          The Unix timestamp for the time when the daemon task definition was registered.

        • registeredBy (string) –

          The principal that registered the daemon task definition.

        • deleteRequestedAt (datetime) –

          The Unix timestamp for the time when the daemon task definition delete was requested.

        • status (string) –

          The status of the daemon task definition.

    • nextToken (string) –

      The nextToken value to include in a future ListDaemonTaskDefinitions request. When the results of a ListDaemonTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results.

Exceptions

  • ECS.Client.exceptions.AccessDeniedException

  • ECS.Client.exceptions.ServerException

  • ECS.Client.exceptions.InvalidParameterException

  • ECS.Client.exceptions.ClientException