QuickSight / Client / delete_template_alias

delete_template_alias#

QuickSight.Client.delete_template_alias(**kwargs)#

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

See also: AWS API Documentation

Request Syntax

response = client.delete_template_alias(
    AwsAccountId='string',
    TemplateId='string',
    AliasName='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the item to delete.

  • TemplateId (string) –

    [REQUIRED]

    The ID for the template that the specified alias is for.

  • AliasName (string) –

    [REQUIRED]

    The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 123,
    'TemplateId': 'string',
    'AliasName': 'string',
    'Arn': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • Status (integer) –

      The HTTP status of the request.

    • TemplateId (string) –

      An ID for the template associated with the deletion.

    • AliasName (string) –

      The name for the template alias.

    • Arn (string) –

      The Amazon Resource Name (ARN) of the template you want to delete.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.UnsupportedUserEditionException

  • QuickSight.Client.exceptions.ConflictException

  • QuickSight.Client.exceptions.InternalFailureException