QuickSight / Client / describe_dashboard

describe_dashboard#

QuickSight.Client.describe_dashboard(**kwargs)#

Provides a summary for a dashboard.

See also: AWS API Documentation

Request Syntax

response = client.describe_dashboard(
    AwsAccountId='string',
    DashboardId='string',
    VersionNumber=123,
    AliasName='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the dashboard that you’re describing.

  • DashboardId (string) –

    [REQUIRED]

    The ID for the dashboard.

  • VersionNumber (integer) – The version number for the dashboard. If a version number isn’t passed, the latest published dashboard version is described.

  • AliasName (string) – The alias name.

Return type:

dict

Returns:

Response Syntax

{
    'Dashboard': {
        'DashboardId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'Version': {
            'CreatedTime': datetime(2015, 1, 1),
            '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'
                        },
                    ]
                },
            ],
            'VersionNumber': 123,
            'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
            'Arn': 'string',
            'SourceEntityArn': 'string',
            'DataSetArns': [
                'string',
            ],
            'Description': 'string',
            'ThemeArn': 'string',
            'Sheets': [
                {
                    'SheetId': 'string',
                    'Name': 'string'
                },
            ]
        },
        'CreatedTime': datetime(2015, 1, 1),
        'LastPublishedTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1),
        'LinkEntities': [
            'string',
        ]
    },
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • Dashboard (dict) –

      Information about the dashboard.

      • DashboardId (string) –

        Dashboard ID.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the resource.

      • Name (string) –

        A display name for the dashboard.

      • Version (dict) –

        Version.

        • CreatedTime (datetime) –

          The time that this dashboard version was created.

        • Errors (list) –

          Errors associated with this dashboard version.

          • (dict) –

            Dashboard error.

            • Type (string) –

              Type.

            • Message (string) –

              Message.

            • ViolatedEntities (list) –

              Lists the violated entities that caused the dashboard 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.

        • VersionNumber (integer) –

          Version number for this version of the dashboard.

        • Status (string) –

          The HTTP status of the request.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the resource.

        • SourceEntityArn (string) –

          Source entity ARN.

        • DataSetArns (list) –

          The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.

          • (string) –

        • Description (string) –

          Description.

        • ThemeArn (string) –

          The ARN of the theme associated with a version of the dashboard.

        • 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.

      • CreatedTime (datetime) –

        The time that this dashboard was created.

      • LastPublishedTime (datetime) –

        The last time that this dashboard was published.

      • LastUpdatedTime (datetime) –

        The last time that this dashboard was updated.

      • LinkEntities (list) –

        A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

        • (string) –

    • Status (integer) –

      The HTTP status of this request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions