LaunchWizard / Paginator / ListWorkloadDeploymentPatterns

ListWorkloadDeploymentPatterns

class LaunchWizard.Paginator.ListWorkloadDeploymentPatterns

paginator = client.get_paginator('list_workload_deployment_patterns')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• workloadName (string) –

  [REQUIRED]

  The name of the workload.

• 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

{
    'workloadDeploymentPatterns': [
        {
            'deploymentPatternName': 'string',
            'description': 'string',
            'displayName': 'string',
            'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
            'statusMessage': 'string',
            'workloadName': 'string',
            'workloadVersionName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • workloadDeploymentPatterns (list) –

    Describes the workload deployment patterns.

    • (dict) –

      Describes a workload deployment pattern.

      • deploymentPatternName (string) –

        The name of a workload deployment pattern.

      • description (string) –

        The description of a workload deployment pattern.

      • displayName (string) –

        The display name of a workload deployment pattern.

      • status (string) –

        The status of a workload deployment pattern.

      • statusMessage (string) –

        A message about a workload deployment pattern’s status.

      • workloadName (string) –

        The name of the workload.

      • workloadVersionName (string) –

        The name of the workload deployment pattern version.

  • NextToken (string) –

    A token to resume pagination.