QuickSight / Client / list_dashboard_versions

list_dashboard_versions#

QuickSight.Client.list_dashboard_versions(**kwargs)#

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

Request Syntax

response = client.list_dashboard_versions(
    AwsAccountId='string',
    DashboardId='string',
    NextToken='string',
    MaxResults=123
)

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.
NextToken (string) – The token for the next set of results, or null if there are no more results.
MaxResults (integer) – The maximum number of results to be returned per request.

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'
        },
    ],
    'NextToken': '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.
- NextToken (string) –
  
  The token for the next set of results, or null if there are no more results.
- Status (integer) –
  
  The HTTP status of the request.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.

Exceptions

QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidNextTokenException
QuickSight.Client.exceptions.UnsupportedUserEditionException
QuickSight.Client.exceptions.InternalFailureException