Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . quicksight ]

describe-template-alias

Description

Describes the template alias for a template.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-template-alias
--aws-account-id <value>
--template-id <value>
--alias-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

The ID of the AWS account that contains the template alias that you're describing.

--template-id (string)

The ID for the template.

--alias-name (string)

The name of the template alias 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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 AWS request ID for this operation.