CodeDeploy / Client / list_deployments

list_deployments#

CodeDeploy.Client.list_deployments(**kwargs)#

Lists the deployments in a deployment group for an application registered with the IAM user or Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_deployments(
    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)
    },
    nextToken='string'
)
Parameters:

  • applicationName (string) –

    The name of an CodeDeploy application associated with the IAM 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.

  • nextToken (string) – An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.

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) –

      If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.

Exceptions

  • CodeDeploy.Client.exceptions.ApplicationNameRequiredException

  • CodeDeploy.Client.exceptions.InvalidApplicationNameException

  • CodeDeploy.Client.exceptions.ApplicationDoesNotExistException

  • CodeDeploy.Client.exceptions.InvalidDeploymentGroupNameException

  • CodeDeploy.Client.exceptions.DeploymentGroupDoesNotExistException

  • CodeDeploy.Client.exceptions.DeploymentGroupNameRequiredException

  • CodeDeploy.Client.exceptions.InvalidTimeRangeException

  • CodeDeploy.Client.exceptions.InvalidDeploymentStatusException

  • CodeDeploy.Client.exceptions.InvalidNextTokenException

  • CodeDeploy.Client.exceptions.InvalidExternalIdException

  • CodeDeploy.Client.exceptions.InvalidInputException