QuickSight / Client / describe_template

describe_template

QuickSight.Client.describe_template(**kwargs)

Describes a template’s metadata.

See also: AWS API Documentation

Request Syntax

response = client.describe_template(
    AwsAccountId='string',
    TemplateId='string',
    VersionNumber=123,
    AliasName='string'
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

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

• TemplateId (string) –

  [REQUIRED]

  The ID for the template.

• VersionNumber (integer) – (Optional) The number for the version to describe. If a VersionNumber parameter value isn’t provided, the latest version of the template is described.

• AliasName (string) – The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn’t apply to templates.

Return type:

dict

Returns:

Response Syntax

{
    'Template': {
        'Arn': 'string',
        'Name': 'string',
        'Version': {
            'CreatedTime': datetime(2015, 1, 1),
            'Errors': [
                {
                    'Type': 'SOURCE_NOT_FOUND'|'DATA_SET_NOT_FOUND'|'INTERNAL_FAILURE'|'ACCESS_DENIED',
                    'Message': 'string',
                    'ViolatedEntities': [
                        {
                            'Path': 'string'
                        },
                    ]
                },
            ],
            'VersionNumber': 123,
            'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
            'DataSetConfigurations': [
                {
                    'Placeholder': 'string',
                    'DataSetSchema': {
                        'ColumnSchemaList': [
                            {
                                'Name': 'string',
                                'DataType': 'string',
                                'GeographicRole': 'string'
                            },
                        ]
                    },
                    'ColumnGroupSchemaList': [
                        {
                            'Name': 'string',
                            'ColumnGroupColumnSchemaList': [
                                {
                                    'Name': 'string'
                                },
                            ]
                        },
                    ]
                },
            ],
            'Description': 'string',
            'SourceEntityArn': 'string',
            'ThemeArn': 'string',
            'Sheets': [
                {
                    'SheetId': 'string',
                    'Name': 'string'
                },
            ]
        },
        'TemplateId': 'string',
        'LastUpdatedTime': datetime(2015, 1, 1),
        'CreatedTime': datetime(2015, 1, 1)
    },
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

• (dict) –

  • Template (dict) –

    The template structure for the object you want to describe.

    • Arn (string) –

      The Amazon Resource Name (ARN) of the template.

    • Name (string) –

      The display name of the template.

    • Version (dict) –

      A structure describing the versions of the template.

      • CreatedTime (datetime) –

        The time that this template version was created.

      • Errors (list) –

        Errors associated with this template version.

        • (dict) –

          List of errors that occurred when the template version creation failed.

          • Type (string) –

            Type of error.

          • Message (string) –

            Description of the error type.

          • ViolatedEntities (list) –

            An error path that shows which entities caused the template 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) –

        The version number of the template version.

      • Status (string) –

        The status that is associated with the template.

        • CREATION_IN_PROGRESS

        • CREATION_SUCCESSFUL

        • CREATION_FAILED

        • UPDATE_IN_PROGRESS

        • UPDATE_SUCCESSFUL

        • UPDATE_FAILED

        • DELETED

      • DataSetConfigurations (list) –

        Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

        • (dict) –

          Dataset configuration.

          • Placeholder (string) –

            Placeholder.

          • DataSetSchema (dict) –

            Dataset schema.

            • ColumnSchemaList (list) –

              A structure containing the list of column schemas.

              • (dict) –

                The column schema.

                • Name (string) –

                  The name of the column schema.

                • DataType (string) –

                  The data type of the column schema.

                • GeographicRole (string) –

                  The geographic role of the column schema.

          • ColumnGroupSchemaList (list) –

            A structure containing the list of column group schemas.

            • (dict) –

              The column group schema.

              • Name (string) –

                The name of the column group schema.

              • ColumnGroupColumnSchemaList (list) –

                A structure containing the list of schemas for column group columns.

                • (dict) –

                  A structure describing the name, data type, and geographic role of the columns.

                  • Name (string) –

                    The name of the column group’s column schema.

      • Description (string) –

        The description of the template.

      • SourceEntityArn (string) –

        The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

      • ThemeArn (string) –

        The ARN of the theme associated with this version of the template.

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

    • TemplateId (string) –

      The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

    • LastUpdatedTime (datetime) –

      Time when this was last updated.

    • CreatedTime (datetime) –

      Time when this was created.

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

• QuickSight.Client.exceptions.ResourceExistsException

• QuickSight.Client.exceptions.ResourceNotFoundException

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.ConflictException

• QuickSight.Client.exceptions.UnsupportedUserEditionException

• QuickSight.Client.exceptions.InternalFailureException