AppConfig / Paginator / ListDeployments

ListDeployments

class AppConfig.Paginator.ListDeployments

paginator = client.get_paginator('list_deployments')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ApplicationId='string',
    EnvironmentId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ApplicationId (string) –

  [REQUIRED]

  The application ID.

• EnvironmentId (string) –

  [REQUIRED]

  The environment ID.

• 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

{
    'Items': [
        {
            'DeploymentNumber': 123,
            'ConfigurationName': 'string',
            'ConfigurationVersion': 'string',
            'DeploymentDurationInMinutes': 123,
            'GrowthType': 'LINEAR'|'EXPONENTIAL',
            'GrowthFactor': ...,
            'FinalBakeTimeInMinutes': 123,
            'State': 'BAKING'|'VALIDATING'|'DEPLOYING'|'COMPLETE'|'ROLLING_BACK'|'ROLLED_BACK',
            'PercentageComplete': ...,
            'StartedAt': datetime(2015, 1, 1),
            'CompletedAt': datetime(2015, 1, 1),
            'VersionLabel': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Items (list) –

    The elements from this collection.

    • (dict) –

      Information about the deployment.

      • DeploymentNumber (integer) –

        The sequence number of the deployment.

      • ConfigurationName (string) –

        The name of the configuration.

      • ConfigurationVersion (string) –

        The version of the configuration.

      • DeploymentDurationInMinutes (integer) –

        Total amount of time the deployment lasted.

      • GrowthType (string) –

        The algorithm used to define how percentage grows over time.

      • GrowthFactor (float) –

        The percentage of targets to receive a deployed configuration during each interval.

      • FinalBakeTimeInMinutes (integer) –

        The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

      • State (string) –

        The state of the deployment.

      • PercentageComplete (float) –

        The percentage of targets for which the deployment is available.

      • StartedAt (datetime) –

        Time the deployment started.

      • CompletedAt (datetime) –

        Time the deployment completed.

      • VersionLabel (string) –

        A user-defined label for an AppConfig hosted configuration version.