ECS / Client / list_daemon_deployments

list_daemon_deployments

ECS.Client.list_daemon_deployments(**kwargs)

Returns a list of daemon deployments for a specified daemon. You can filter the results by status or creation time.

See also: AWS API Documentation

Request Syntax

response = client.list_daemon_deployments(
    daemonArn='string',
    status=[
        'PENDING'|'SUCCESSFUL'|'STOPPED'|'STOP_REQUESTED'|'IN_PROGRESS'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_SUCCESSFUL'|'ROLLBACK_FAILED',
    ],
    createdAt={
        'before': datetime(2015, 1, 1),
        'after': datetime(2015, 1, 1)
    },
    maxResults=123,
    nextToken='string'
)

Parameters:

• daemonArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the daemon to list deployments for.

• status (list) –

  An optional filter to narrow the ListDaemonDeployments results by deployment status. If you don’t specify a status, all deployments are returned.

  • (string) –

• createdAt (dict) –

  An optional filter to narrow the ListDaemonDeployments results by creation time. If you don’t specify a time range, all deployments are returned.

  • before (datetime) –

    Include service deployments in the result that were created before this time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

  • after (datetime) –

    Include service deployments in the result that were created after this time. The format is yyyy-MM-dd HH:mm:ss.SSSSSS.

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

• nextToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'daemonDeployments': [
        {
            'daemonDeploymentArn': 'string',
            'daemonArn': 'string',
            'clusterArn': 'string',
            'status': 'PENDING'|'SUCCESSFUL'|'STOPPED'|'STOP_REQUESTED'|'IN_PROGRESS'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_SUCCESSFUL'|'ROLLBACK_FAILED',
            'statusReason': 'string',
            'targetDaemonRevisionArn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'stoppedAt': datetime(2015, 1, 1),
            'finishedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

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

  • daemonDeployments (list) –

    The list of daemon deployment summaries.

    • (dict) –

      A summary of a daemon deployment.

      • daemonDeploymentArn (string) –

        The Amazon Resource Name (ARN) of the daemon deployment.

      • daemonArn (string) –

        The Amazon Resource Name (ARN) of the daemon.

      • clusterArn (string) –

        The Amazon Resource Name (ARN) of the cluster that hosts the daemon.

      • status (string) –

        The status of the daemon deployment.

      • statusReason (string) –

        Information about why the daemon deployment is in the current status.

      • targetDaemonRevisionArn (string) –

        The ARN of the daemon revision being deployed.

      • createdAt (datetime) –

        The time the daemon deployment was created.

      • startedAt (datetime) –

        The time the daemon deployment started.

      • stoppedAt (datetime) –

        The time the daemon deployment stopped.

      • finishedAt (datetime) –

        The time the daemon deployment finished.

Exceptions

• ECS.Client.exceptions.AccessDeniedException

• ECS.Client.exceptions.ServerException

• ECS.Client.exceptions.InvalidParameterException

• ECS.Client.exceptions.ClientException

• ECS.Client.exceptions.ClusterNotFoundException

• ECS.Client.exceptions.UnsupportedFeatureException