QuickSight / Paginator / ListDashboardVersions

ListDashboardVersions#

class QuickSight.Paginator.ListDashboardVersions#
paginator = client.get_paginator('list_dashboard_versions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from QuickSight.Client.list_dashboard_versions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AwsAccountId='string',
    DashboardId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the dashboard that you’re listing versions for.

  • DashboardId (string) –

    [REQUIRED]

    The ID for the dashboard.

  • 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

{
    'DashboardVersionSummaryList': [
        {
            'Arn': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'VersionNumber': 123,
            'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
            'SourceEntityArn': 'string',
            'Description': 'string'
        },
    ],
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • DashboardVersionSummaryList (list) –

      A structure that contains information about each version of the dashboard.

      • (dict) –

        Dashboard version summary.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the resource.

        • CreatedTime (datetime) –

          The time that this dashboard version was created.

        • VersionNumber (integer) –

          Version number.

        • Status (string) –

          The HTTP status of the request.

        • SourceEntityArn (string) –

          Source entity ARN.

        • Description (string) –

          Description.

    • Status (integer) –

      The HTTP status of the request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.