QuickSight / Client / describe_theme_alias

describe_theme_alias#

QuickSight.Client.describe_theme_alias(**kwargs)#

Describes the alias for a theme.

See also: AWS API Documentation

Request Syntax

response = client.describe_theme_alias(
    AwsAccountId='string',
    ThemeId='string',
    AliasName='string'
)
Parameters:
  • AwsAccountId (string) –

    [REQUIRED]

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

  • ThemeId (string) –

    [REQUIRED]

    The ID for the theme.

  • AliasName (string) –

    [REQUIRED]

    The name of the theme alias that you want to describe.

Return type:

dict

Returns:

Response Syntax

{
    'ThemeAlias': {
        'Arn': 'string',
        'AliasName': 'string',
        'ThemeVersionNumber': 123
    },
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • ThemeAlias (dict) –

      Information about the theme alias.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the theme alias.

      • AliasName (string) –

        The display name of the theme alias.

      • ThemeVersionNumber (integer) –

        The version number of the theme alias.

    • Status (integer) –

      The HTTP status of the request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions

  • QuickSight.Client.exceptions.ConflictException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.UnsupportedUserEditionException

  • QuickSight.Client.exceptions.InternalFailureException