翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
UpdateTemplate
既存の Amazon からテンプレートを更新します。 QuickSight 分析または別のテンプレート。
リクエストの構文
PUT /accounts/AwsAccountId/templates/TemplateId HTTP/1.1
Content-type: application/json
{
"Name": "string",
"SourceEntity": {
"SourceAnalysis": {
"Arn": "string",
"DataSetReferences": [
{
"DataSetArn": "string",
"DataSetPlaceholder": "string"
}
]
},
"SourceTemplate": {
"Arn": "string"
}
},
"VersionDescription": "string"
}URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- AwsAccountId
-
の IDAWSアカウントには、更新中のテンプレートが含まれています。
長さの制約: 固定長は 12 です。
パターン:
^[0-9]{12}$必須: はい
- TemplateId
-
テンプレートの ID。
長さの制約: 最小長は 1 です｡ 最大長は 2,048 です。
パターン:
[\w\-]+必須: はい
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- SourceEntity
-
テンプレートを更新するときにソースとして使用しているエンティティ。
SourceEntityでは、ソースとして使用するオブジェクトのタイプを指定します。テンプレートの場合はSourceTemplate、分析の場合はSourceAnalysisです。いずれも Amazon リソースネーム (ARN) が必要です。SourceTemplateを使用する場合、ソーステンプレートの ARN を指定します。SourceAnalysisを使用する場合、ソース分析の ARN を指定します。-SourceTemplateARN には任意のものを含めることができますAWSアカウントと任意の Amazon QuickSight-サポート外AWS リージョン;。SourceTemplateまたはSourceAnalysis内のDataSetReferencesエンティティを使用して、オリジナルに一覧表示されているプレースホルダーの代替データセットを一覧表示します。各データセットのスキーマは、そのプレースホルダーと一致する必要があります。型: TemplateSourceEntity オブジェクト
必須: はい
- Name
-
テンプレートの名前。
Type: 文字列
長さの制約: 最小長は 1 です｡ 最大長は 2,048 です。
必須: いいえ
- VersionDescription
-
更新中の現在のテンプレートバージョンの説明。電話するたびに
UpdateTemplateでテンプレートの新しいバージョンを作成します。テンプレートの各バージョンには、VersionDescriptionフィールドにそのバージョンの説明が保持されます。Type: 文字列
長さの制約: 最小長は 1 です｡ 最大長は 512 です。
必須: いいえ
レスポンスの構文
HTTP/1.1 Status
Content-type: application/json
{
"Arn": "string",
"CreationStatus": "string",
"RequestId": "string",
"TemplateId": "string",
"VersionArn": "string"
}レスポンス要素
アクションが成功すると、以下の HTTP レスポンスが返されます。
- Status
-
リクエストの HTTP ステータス。
サービスから以下のデータが JSON 形式で返されます。
- Arn
-
テンプレートの Amazon リソースネーム (ARN)。
Type: 文字列
- CreationStatus
-
テンプレートの作成ステータス。
Type: 文字列
有効な値:
CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED - RequestId
-
-AWSこの処理のリクエスト ID。
Type: 文字列
- TemplateId
-
テンプレートの ID。
Type: 文字列
長さの制約: 最小長は 1 です｡ 最大長は 2,048 です。
パターン:
[\w\-]+ - VersionArn
-
最初のバージョンのバージョン情報を含む、テンプレートの ARN。
Type: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- ConflictException
-
リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。
HTTP ステータスコード: 409
- InternalFailureException
-
内部エラーが発生しました。
HTTP ステータスコード: 500
- InvalidParameterValueException
-
1 つ以上のパラメータに無効な値があります。
HTTP ステータスコード: 400
- LimitExceededException
-
制限を超過しています。
HTTP ステータスコード: 409
- ResourceExistsException
-
指定されたリソースは既に存在します。
HTTP ステータスコード: 409
- ResourceNotFoundException
-
1 つ以上のリソースが見つかりません。
HTTP ステータスコード: 404
- ThrottlingException
-
アクセスが調整済みです。
HTTP ステータスコード: 429
- UnsupportedUserEditionException
-
このエラーは、Amazonでオペレーションを呼び出していることを示します。 QuickSightエディションにその操作のサポートが含まれていないサブスクリプション。アマゾンアマゾン QuickSight 現在は、Standard Enterprise ion と Enterprise すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。
HTTP ステータスコード: 403
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
