Proton / Paginator / ListComponents

ListComponents#

class Proton.Paginator.ListComponents#
paginator = client.get_paginator('list_components')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • environmentName (string) – The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.

  • serviceInstanceName (string) – The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

  • serviceName (string) – The name of a service for result list filtering. Proton returns components attached to 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

{
    'components': [
        {
            'arn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
            'deploymentStatusMessage': 'string',
            'environmentName': 'string',
            'lastAttemptedDeploymentId': 'string',
            'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
            'lastDeploymentSucceededAt': datetime(2015, 1, 1),
            'lastModifiedAt': datetime(2015, 1, 1),
            'lastSucceededDeploymentId': 'string',
            'name': 'string',
            'serviceInstanceName': 'string',
            'serviceName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • components (list) –

      An array of components with summary data.

      • (dict) –

        Summary data of an Proton component resource.

        For more information about components, see Proton components in the Proton User Guide.

        • arn (string) –

          The Amazon Resource Name (ARN) of the component.

        • createdAt (datetime) –

          The time when the component was created.

        • deploymentStatus (string) –

          The component deployment status.

        • deploymentStatusMessage (string) –

          The message associated with the component deployment status.

        • environmentName (string) –

          The name of the Proton environment that this component is associated with.

        • lastAttemptedDeploymentId (string) –

          The ID of the last attempted deployment of this component.

        • lastDeploymentAttemptedAt (datetime) –

          The time when a deployment of the component was last attempted.

        • lastDeploymentSucceededAt (datetime) –

          The time when the component was last deployed successfully.

        • lastModifiedAt (datetime) –

          The time when the component was last modified.

        • lastSucceededDeploymentId (string) –

          The ID of the last successful deployment of this component.

        • name (string) –

          The name of the component.

        • serviceInstanceName (string) –

          The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

        • serviceName (string) –

          The name of the service that serviceInstanceName is associated with. Provided when a component is attached to a service instance.

    • NextToken (string) –

      A token to resume pagination.