QuickSight / Client / create_template_alias

create_template_alias#

QuickSight.Client.create_template_alias(**kwargs)#

Creates a template alias for a template.

Request Syntax

response = client.create_template_alias(
    AwsAccountId='string',
    TemplateId='string',
    AliasName='string',
    TemplateVersionNumber=123
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the template that you creating an alias for.
TemplateId (string) –
[REQUIRED]

An ID for the template.
AliasName (string) –
[REQUIRED]

The name that you want to give to the template alias that you’re creating. Don’t start the alias name with the $ character. Alias names that start with $ are reserved by Amazon QuickSight.
TemplateVersionNumber (integer) –
[REQUIRED]

The version number of the template.

Return type:

dict

Returns:

Response Syntax

{
    'TemplateAlias': {
        'AliasName': 'string',
        'Arn': 'string',
        'TemplateVersionNumber': 123
    },
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

(dict) –
- TemplateAlias (dict) –
  
  Information about the template alias.
  - AliasName (string) –
    
    The display name of the template alias.
  - Arn (string) –
    
    The Amazon Resource Name (ARN) of the template alias.
  - TemplateVersionNumber (integer) –
    
    The version number of the template alias.
- Status (integer) –
  
  The HTTP status of the request.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.ConflictException
QuickSight.Client.exceptions.ResourceExistsException
QuickSight.Client.exceptions.LimitExceededException
QuickSight.Client.exceptions.UnsupportedUserEditionException
QuickSight.Client.exceptions.ConflictException
QuickSight.Client.exceptions.InternalFailureException