QuickSight / Client / describe_analysis

describe_analysis#

QuickSight.Client.describe_analysis(**kwargs)#

Provides a summary of the metadata for an analysis.

See also: AWS API Documentation

Request Syntax

response = client.describe_analysis(
    AwsAccountId='string',
    AnalysisId='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

  • AnalysisId (string) –

    [REQUIRED]

    The ID of the analysis that you’re describing. The ID is part of the URL of the analysis.

Return type:

dict

Returns:

Response Syntax

{
    'Analysis': {
        'AnalysisId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
        'Errors': [
            {
                'Type': 'ACCESS_DENIED'|'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE'|'PARAMETER_VALUE_INCOMPATIBLE'|'PARAMETER_TYPE_INVALID'|'PARAMETER_NOT_FOUND'|'COLUMN_TYPE_MISMATCH'|'COLUMN_GEOGRAPHIC_ROLE_MISMATCH'|'COLUMN_REPLACEMENT_MISSING',
                'Message': 'string',
                'ViolatedEntities': [
                    {
                        'Path': 'string'
                    },
                ]
            },
        ],
        'DataSetArns': [
            'string',
        ],
        'ThemeArn': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1),
        'Sheets': [
            {
                'SheetId': 'string',
                'Name': 'string'
            },
        ]
    },
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • Analysis (dict) –

      A metadata structure that contains summary information for the analysis that you’re describing.

      • AnalysisId (string) –

        The ID of the analysis.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the analysis.

      • Name (string) –

        The descriptive name of the analysis.

      • Status (string) –

        Status associated with the analysis.

      • Errors (list) –

        Errors associated with the analysis.

        • (dict) –

          Analysis error.

          • Type (string) –

            The type of the analysis error.

          • Message (string) –

            The message associated with the analysis error.

          • ViolatedEntities (list) –

            Lists the violated entities that caused the analysis error

            • (dict) –

              An object, structure, or sub-structure of an analysis, template, or dashboard.

              • Path (string) –

                The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

      • DataSetArns (list) –

        The ARNs of the datasets of the analysis.

        • (string) –

      • ThemeArn (string) –

        The ARN of the theme of the analysis.

      • CreatedTime (datetime) –

        The time that the analysis was created.

      • LastUpdatedTime (datetime) –

        The time that the analysis was last updated.

      • Sheets (list) –

        A list of the associated sheets with the unique identifier and name of each sheet.

        • (dict) –

          A sheet, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.

          • SheetId (string) –

            The unique identifier associated with a sheet.

          • Name (string) –

            The name of a sheet. This name is displayed on the sheet’s tab in the Amazon QuickSight console.

    • Status (integer) –

      The HTTP status of the request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions