DescribeTemplateAlias - Amazon QuickSight

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

DescribeTemplateAlias

テンプレートのテンプレートエイリアスを説明します。

リクエストの構文

GET /accounts/AwsAccountId/templates/TemplateId/aliases/AliasName HTTP/1.1

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

AliasName

記述するテンプレートエイリアスの名前。特定のエイリアスに名前を付ける場合は、エイリアスが指すバージョンを説明します。キーワードを指定すると、テンプレートの最新バージョンを指定できます。$LATESTAliasNameパラメータ。キーワード$PUBLISHEDテンプレートには適用されません。

長さの制約: 最小長は 1 です。 最大長は 2,048 です。

パターン: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

必須: はい

AwsAccountId

の IDAWS記述しているテンプレートエイリアスを含むアカウント。

長さの制約: 固定長は 12 です。

パターン: ^[0-9]{12}$

必須: はい

TemplateId

テンプレートの ID。

長さの制約: 最小長は 1 です。 最大長は 2,048 です。

パターン: [\w\-]+

必須: はい

リクエスト本文

リクエストにリクエスト本文がありません。

レスポンスの構文

HTTP/1.1 Status Content-type: application/json { "RequestId": "string", "TemplateAlias": { "AliasName": "string", "Arn": "string", "TemplateVersionNumber": number } }

レスポンス要素

アクションが成功すると、以下の HTTP レスポンスが返されます。

Status

リクエストの HTTP ステータス。

サービスから以下のデータが JSON 形式で返されます。

RequestId

-AWSこの処理のリクエスト ID。

Type: 文字列

TemplateAlias

テンプレートエイリアスに関する情報。

型: TemplateAlias オブジェクト

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InternalFailureException

内部エラーが発生しました。

HTTP ステータスコード: 500

ResourceNotFoundException

1 つ以上のリソースが見つかりません。

HTTP ステータスコード: 404

ThrottlingException

アクセスが調整済みです。

HTTP ステータスコード: 429

UnsupportedUserEditionException

このエラーは、Amazonでオペレーションを呼び出していることを示します。 QuickSightエディションにその操作のサポートが含まれていないサブスクリプション。アマゾンアマゾン QuickSight には現在、Standard Edition があります。すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。​

HTTP ステータスコード: 403

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。