QuickSight / Client / describe_template

describe_template#

QuickSight.Client.describe_template(**kwargs)#

Describes a template’s metadata.

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',
                    'Images': [
                        {
                            'SheetImageId': 'string',
                            'Source': {
                                'SheetImageStaticFileSource': {
                                    'StaticFileId': 'string'
                                }
                            },
                            'Scaling': {
                                'ScalingType': 'SCALE_TO_WIDTH'|'SCALE_TO_HEIGHT'|'SCALE_TO_CONTAINER'|'SCALE_NONE'
                            },
                            'Tooltip': {
                                'TooltipText': {
                                    'PlainText': 'string'
                                },
                                'Visibility': 'HIDDEN'|'VISIBLE'
                            },
                            'ImageContentAltText': 'string',
                            'Interactions': {
                                'ImageMenuOption': {
                                    'AvailabilityStatus': 'ENABLED'|'DISABLED'
                                }
                            },
                            'Actions': [
                                {
                                    'CustomActionId': 'string',
                                    'Name': 'string',
                                    'Status': 'ENABLED'|'DISABLED',
                                    'Trigger': 'CLICK'|'MENU',
                                    'ActionOperations': [
                                        {
                                            'NavigationOperation': {
                                                'LocalNavigationConfiguration': {
                                                    'TargetSheetId': 'string'
                                                }
                                            },
                                            'URLOperation': {
                                                'URLTemplate': 'string',
                                                'URLTarget': 'NEW_TAB'|'NEW_WINDOW'|'SAME_TAB'
                                            },
                                            'SetParametersOperation': {
                                                'ParameterValueConfigurations': [
                                                    {
                                                        'DestinationParameterName': 'string',
                                                        'Value': {
                                                            'CustomValuesConfiguration': {
                                                                'IncludeNullValue': True|False,
                                                                'CustomValues': {
                                                                    'StringValues': [
                                                                        'string',
                                                                    ],
                                                                    'IntegerValues': [
                                                                        123,
                                                                    ],
                                                                    'DecimalValues': [
                                                                        123.0,
                                                                    ],
                                                                    'DateTimeValues': [
                                                                        datetime(2015, 1, 1),
                                                                    ]
                                                                }
                                                            },
                                                            'SelectAllValueOptions': 'ALL_VALUES',
                                                            'SourceParameterName': 'string',
                                                            'SourceField': 'string',
                                                            'SourceColumn': {
                                                                'DataSetIdentifier': 'string',
                                                                'ColumnName': '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.
        
        Images (list) –
        
        A list of images on a sheet.
        
        (dict) –
        
        An image that is located on a sheet.
        
        SheetImageId (string) –
        
        The ID of the sheet image.
        
        Source (dict) –
        
        The source of the image.
        
        SheetImageStaticFileSource (dict) –
        
        The source of the static file that contains the image.
        
        StaticFileId (string) –
        
        The ID of the static file that contains the image.
        
        Scaling (dict) –
        
        Determines how the image is scaled.
        
        ScalingType (string) –
        
        The scaling option to use when fitting the image inside the container.
        
        Valid values are defined as follows:
        
        SCALE_TO_WIDTH: The image takes up the entire width of the container. The image aspect ratio is preserved.
        
        SCALE_TO_HEIGHT: The image takes up the entire height of the container. The image aspect ratio is preserved.
        
        SCALE_TO_CONTAINER: The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
        
        SCALE_NONE: The image is displayed in its original size and is not scaled to the container.
        
        Tooltip (dict) –
        
        The tooltip to be shown when hovering over the image.
        
        TooltipText (dict) –
        
        The text that appears in the tooltip.
        
        PlainText (string) –
        
        The plain text format.
        
        Visibility (string) –
        
        The visibility of the tooltip.
        
        ImageContentAltText (string) –
        
        The alt text for the image.
        
        Interactions (dict) –
        
        The general image interactions setup for an image.
        
        ImageMenuOption (dict) –
        
        The menu options for the image.
        
        AvailabilityStatus (string) –
        
        The availability status of the image menu. If the value of this property is set to ENABLED, dashboard readers can interact with the image menu.
        
        Actions (list) –
        
        A list of custom actions that are configured for an image.
        
        (dict) –
        
        A custom action defined on an image.
        
        CustomActionId (string) –
        
        The ID of the custom action.
        
        Name (string) –
        
        The name of the custom action.
        
        Status (string) –
        
        The status of the custom action.
        
        Trigger (string) –
        
        The trigger of the VisualCustomAction.
        
        Valid values are defined as follows:
        
        CLICK: Initiates a custom action by a left pointer click on a data point.
        
        MENU: Initiates a custom action by right pointer click from the menu.
        
        ActionOperations (list) –
        
        A list of ImageCustomActionOperations.
        
        This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
        
        (dict) –
        
        The operation that is defined by the custom action.
        
        This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
        
        NavigationOperation (dict) –
        
        The navigation operation that navigates between different sheets in the same analysis.
        
        This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
        
        LocalNavigationConfiguration (dict) –
        
        The configuration that chooses the navigation target.
        
        TargetSheetId (string) –
        
        The sheet that is targeted for navigation in the same analysis.
        
        URLOperation (dict) –
        
        The URL operation that opens a link to another webpage.
        
        URLTemplate (string) –
        
        THe URL link of the CustomActionURLOperation.
        
        URLTarget (string) –
        
        The target of the CustomActionURLOperation.
        
        Valid values are defined as follows:
        
        NEW_TAB: Opens the target URL in a new browser tab.
        
        NEW_WINDOW: Opens the target URL in a new browser window.
        
        SAME_TAB: Opens the target URL in the same browser tab.
        
        SetParametersOperation (dict) –
        
        The set parameter operation that sets parameters in custom action.
        
        ParameterValueConfigurations (list) –
        
        The parameter that determines the value configuration.
        
        (dict) –
        
        The configuration of adding parameters in action.
        
        DestinationParameterName (string) –
        
        The destination parameter name of the SetParameterValueConfiguration.
        
        Value (dict) –
        
        The configuration of destination parameter values.
        
        This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
        
        CustomValuesConfiguration (dict) –
        
        The configuration of custom values for destination parameter in DestinationParameterValueConfiguration.
        
        IncludeNullValue (boolean) –
        
        Includes the null value in custom action parameter values.
        
        CustomValues (dict) –
        
        The customized parameter values.
        
        This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
        
        StringValues (list) –
        
        A list of string-type parameter values.
        
        (string) –
        
        IntegerValues (list) –
        
        A list of integer-type parameter values.
        
        (integer) –
        
        DecimalValues (list) –
        
        A list of decimal-type parameter values.
        
        (float) –
        
        DateTimeValues (list) –
        
        A list of datetime-type parameter values.
        
        (datetime) –
        
        SelectAllValueOptions (string) –
        
        The configuration that selects all options.
        
        SourceParameterName (string) –
        
        The source parameter name of the destination parameter.
        
        SourceField (string) –
        
        The source field ID of the destination parameter.
        
        SourceColumn (dict) –
        
        A column of a data set.
        
        DataSetIdentifier (string) –
        
        The data set that the column belongs to.
        
        ColumnName (string) –
        
        The name of the column.
  - 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