LaunchWizard / Paginator / ListWorkloads


class LaunchWizard.Paginator.ListWorkloads#
paginator = client.get_paginator('list_workloads')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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:



Response Syntax

    'workloads': [
            'displayName': 'string',
            'workloadName': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • workloads (list) –

      Information about the workloads.

      • (dict) –

        Describes workload data.

        • displayName (string) –

          The display name of the workload data.

        • workloadName (string) –

          The name of the workload.

    • NextToken (string) –

      A token to resume pagination.