list_analyses

QuickSight.Client.list_analyses(**kwargs)

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

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

Parameters

• AwsAccountId (string) --

  [REQUIRED]

  The ID of the Amazon Web Services account that contains the analyses.

• NextToken (string) -- A pagination token that can be used in a subsequent request.
• MaxResults (integer) -- The maximum number of results to return.

Return type

dict

Returns

Response Syntax

{
    'AnalysisSummaryList': [
        {
            'Arn': 'string',
            'AnalysisId': 'string',
            'Name': 'string',
            'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

• (dict) --

  • AnalysisSummaryList (list) --

    Metadata describing each of the analyses that are listed.

    • (dict) --

      The summary metadata that describes an analysis.

      • Arn (string) --

        The Amazon Resource Name (ARN) for the analysis.

      • AnalysisId (string) --

        The ID of the analysis. This ID displays in the URL.

      • Name (string) --

        The name of the analysis. This name is displayed in the Amazon QuickSight console.

      • Status (string) --

        The last known status for the analysis.

      • CreatedTime (datetime) --

        The time that the analysis was created.

      • LastUpdatedTime (datetime) --

        The time that the analysis was last updated.

  • NextToken (string) --

    A pagination token that can be used in a subsequent request.

  • Status (integer) --

    The HTTP status of the request.

  • RequestId (string) --

    The Amazon Web Services request ID for this operation.

Exceptions

• QuickSight.Client.exceptions.ThrottlingException
• QuickSight.Client.exceptions.InvalidNextTokenException
• QuickSight.Client.exceptions.UnsupportedUserEditionException
• QuickSight.Client.exceptions.InternalFailureException