LaunchWizard / Paginator / ListDeploymentPatternVersions

ListDeploymentPatternVersions

class LaunchWizard.Paginator.ListDeploymentPatternVersions

paginator = client.get_paginator('list_deployment_pattern_versions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from LaunchWizard.Client.list_deployment_pattern_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    workloadName='string',
    deploymentPatternName='string',
    filters=[
        {
            'name': 'updateFromVersion',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• workloadName (string) –

  [REQUIRED]

  The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.

• deploymentPatternName (string) –

  [REQUIRED]

  The name of the deployment pattern. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.

• filters (list) –

  Filters to apply when listing deployment pattern versions.

  • (dict) –

    A filter for deployment pattern versions. Use this filter to specify criteria for querying deployment pattern versions in Launch Wizard.

    • name (string) – [REQUIRED]

      The name of the filter attribute. Specifies which attribute to filter on when querying deployment pattern versions.

    • values (list) – [REQUIRED]

      The values to filter by. Contains the specific values to match against when filtering deployment pattern versions.

      • (string) –

• 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

{
    'deploymentPatternVersions': [
        {
            'deploymentPatternVersionName': 'string',
            'description': 'string',
            'documentationUrl': 'string',
            'workloadName': 'string',
            'deploymentPatternName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • deploymentPatternVersions (list) –

    The deployment pattern versions.

    • (dict) –

      Describes a deployment pattern version summary.

      • deploymentPatternVersionName (string) –

        The name of the deployment pattern version.

      • description (string) –

        The description of the deployment pattern version.

      • documentationUrl (string) –

        The URL of the documentation for the deployment pattern version.

      • workloadName (string) –

        The name of the workload.

      • deploymentPatternName (string) –

        The name of the deployment pattern.

  • NextToken (string) –

    A token to resume pagination.