Proton / Paginator / ListDeployments

ListDeployments

class Proton.Paginator.ListDeployments

paginator = client.get_paginator('list_deployments')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    componentName='string',
    environmentName='string',
    serviceInstanceName='string',
    serviceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• componentName (string) – The name of a component for result list filtering. Proton returns deployments associated with that component.

• environmentName (string) – The name of an environment for result list filtering. Proton returns deployments associated with the environment.

• serviceInstanceName (string) – The name of a service instance for result list filtering. Proton returns the deployments associated with the service instance.

• serviceName (string) – The name of a service for result list filtering. Proton returns deployments associated with service instances of the service.

• 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.

  • PageSize (integer) –

    The size of each page.

  • 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': [
        {
            'arn': 'string',
            'completedAt': datetime(2015, 1, 1),
            'componentName': 'string',
            'createdAt': datetime(2015, 1, 1),
            'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
            'environmentName': 'string',
            'id': 'string',
            'lastAttemptedDeploymentId': 'string',
            'lastModifiedAt': datetime(2015, 1, 1),
            'lastSucceededDeploymentId': 'string',
            'serviceInstanceName': 'string',
            'serviceName': 'string',
            'targetArn': 'string',
            'targetResourceCreatedAt': datetime(2015, 1, 1),
            'targetResourceType': 'ENVIRONMENT'|'SERVICE_PIPELINE'|'SERVICE_INSTANCE'|'COMPONENT'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • deployments (list) –

    An array of deployment with summary data.

    • (dict) –

      Summary data of the deployment.

      • arn (string) –

        The Amazon Resource Name (ARN) of the deployment.

      • completedAt (datetime) –

        The date and time the deployment was completed.

      • componentName (string) –

        The name of the component associated with the deployment.

      • createdAt (datetime) –

        The date and time the deployment was created.

      • deploymentStatus (string) –

        The current status of the deployment.

      • environmentName (string) –

        The name of the environment associated with the deployment.

      • id (string) –

        The ID of the deployment.

      • lastAttemptedDeploymentId (string) –

        The ID of the last attempted deployment.

      • lastModifiedAt (datetime) –

        The date and time the deployment was last modified.

      • lastSucceededDeploymentId (string) –

        The ID of the last successful deployment.

      • serviceInstanceName (string) –

        The name of the service instance associated with the deployment.

      • serviceName (string) –

        The name of the service associated with the deployment.

      • targetArn (string) –

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

      • targetResourceCreatedAt (datetime) –

        The date and time the target resource was created.

      • targetResourceType (string) –

        The resource type of the deployment target. It can be an environment, service, service instance, or component.

  • NextToken (string) –

    A token to resume pagination.