[ aws . quicksight ]

create-template-alias

Description

Creates a template alias for a template.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-template-alias
--aws-account-id <value>
--template-id <value>
--alias-name <value>
--template-version-number <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The ID of the Amazon Web Services account that contains the template that you creating an alias for.

--template-id (string)

An ID for the template.

--alias-name (string)

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.

--template-version-number (long)

The version number of the template.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

TemplateAlias -> (structure)

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 -> (long)

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.