CodeDeploy / Paginator / ListDeployments

ListDeployments

class CodeDeploy.Paginator.ListDeployments

paginator = client.get_paginator('list_deployments')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeDeploy.Client.list_deployments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    applicationName='string',
    deploymentGroupName='string',
    externalId='string',
    includeOnlyStatuses=[
        'Created'|'Queued'|'InProgress'|'Baking'|'Succeeded'|'Failed'|'Stopped'|'Ready',
    ],
    createTimeRange={
        'start': datetime(2015, 1, 1),
        'end': datetime(2015, 1, 1)
    },
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• applicationName (string) –

  The name of an CodeDeploy application associated with the user or Amazon Web Services account.

  Note

  If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.

• deploymentGroupName (string) –

  The name of a deployment group for the specified application.

  Note

  If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.

• externalId (string) – The unique ID of an external resource for returning deployments linked to the external resource.

• includeOnlyStatuses (list) –

  A subset of deployments to list by status:

  • Created: Include created deployments in the resulting list.

  • Queued: Include queued deployments in the resulting list.

  • In Progress: Include in-progress deployments in the resulting list.

  • Succeeded: Include successful deployments in the resulting list.

  • Failed: Include failed deployments in the resulting list.

  • Stopped: Include stopped deployments in the resulting list.

  • (string) –

• createTimeRange (dict) –

  A time range (start and end) for returning a subset of the list of deployments.

  • start (datetime) –

    The start time of the time range.

    Note

    Specify null to leave the start time open-ended.

  • end (datetime) –

    The end time of the time range.

    Note

    Specify null to leave the end time open-ended.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'deployments': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents the output of a ListDeployments operation.

  • deployments (list) –

    A list of deployment IDs.

    • (string) –

  • NextToken (string) –

    A token to resume pagination.