LaunchWizard / Paginator / ListWorkloads

ListWorkloads

class LaunchWizard.Paginator.ListWorkloads

paginator = client.get_paginator('list_workloads')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'workloads': [
        {
            'workloadName': 'string',
            'displayName': 'string',
            'status': 'ACTIVE'|'INACTIVE'|'DISABLED'|'DELETED',
            'accountConstraints': [
                {
                    'managementAccount': {},
                    'delegatedAdmin': {
                        'servicePrincipal': 'string'
                    }
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • workloads (list) –

    Information about the workloads.

    • (dict) –

      Describes workload data.

      • workloadName (string) –

        The name of the workload.

      • displayName (string) –

        The display name of the workload data.

      • status (string) –

        The status of the workload.

      • accountConstraints (list) –

        Optional list of constraints describing what kind of AWS account is allowed to deploy this workload or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list at this level means no constraint at this level.

        • (dict) –

          A constraint on which AWS account a deployment can be initiated from. Specify one of the supported constraint types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: managementAccount, delegatedAdmin. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          

          • managementAccount (dict) –

            The deployment must be initiated from the AWS Organizations management account.

          • delegatedAdmin (dict) –

            The deployment must be initiated from a delegated administrator account for the specified service principal.

            • servicePrincipal (string) –

              The service principal for which the account must be a delegated administrator. For example, stacksets.cloudformation.amazonaws.com.

  • NextToken (string) –

    A token to resume pagination.