CreateAnalysis - Amazon QuickSight

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

CreateAnalysis

Amazon で分析を作成します QuickSight。

リクエストの構文

POST /accounts/AwsAccountId/analyses/AnalysisId HTTP/1.1 Content-type: application/json { "Name": "string", "Parameters": { "DateTimeParameters": [ { "Name": "string", "Values": [ number ] } ], "DecimalParameters": [ { "Name": "string", "Values": [ number ] } ], "IntegerParameters": [ { "Name": "string", "Values": [ number ] } ], "StringParameters": [ { "Name": "string", "Values": [ "string" ] } ] }, "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "SourceEntity": { "SourceTemplate": { "Arn": "string", "DataSetReferences": [ { "DataSetArn": "string", "DataSetPlaceholder": "string" } ] } }, "Tags": [ { "Key": "string", "Value": "string" } ], "ThemeArn": "string" }

URI リクエストパラメータ

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

AnalysisId

作成する分析の ID。この ID は、分析の URL に表示されます。

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

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

必須: はい

AwsAccountId

分析を作成する AWS アカウントの ID。

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

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

必須: はい

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

Name

作成する分析のわかりやすい名前。この名前は、Amazon で分析に表示されます。 QuickSight console.

Type: 文字列

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

必須: はい

SourceEntity

作成中の分析に使用するソースエンティティ。このメタデータ構造体には、ソーステンプレートと 1 つ以上のデータセットを記述する詳細が含まれています。

型: AnalysisSourceEntity オブジェクト

必須: はい

Parameters

使用するパラメータ名とオーバーライド値。分析には任意のパラメータタイプを指定でき、パラメータによっては複数の値を受け入れることができます。

型: Parameters オブジェクト

必須: いいえ

Permissions

分析に対するプリンシパルとリソースレベルのアクセス許可を記述する構造体。Permissions 構造体を使用して、Amazon リソースネーム (ARN) によってリストされている各プリンシパルの AWS Identity and Access Management (IAM) アクション情報のリストを提供することでアクセス許可を付与します。

アクセス許可を指定しない場合は、Permissions を省略します。

Type: 配列ResourcePermissionオブジェクト

配列メンバー: 最小数は 1 項目です。最大数は 64 項目です。

必須: いいえ

Tags

分析に割り当てられたリソースタグのキーと値のペアのマップが含まれます。

Type: 配列Tagオブジェクト

配列メンバー: 最小数は 1 項目です。最大 200 項目。

必須: いいえ

ThemeArn

作成する分析に適用するテーマの ARN。Amazon でテーマを表示するには QuickSight コンソールでアクセス許可があることを確認します。

Type: 文字列

必須: いいえ

レスポンスの構文

HTTP/1.1 Status Content-type: application/json { "AnalysisId": "string", "Arn": "string", "CreationStatus": "string", "RequestId": "string" }

レスポンス要素

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

Status

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

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

AnalysisId

分析の ID。

Type: 文字列

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

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

Arn

分析の ARN。

Type: 文字列

CreationStatus

分析の作成ステータス。

Type: 文字列

有効な値: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

RequestId

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

Type: 文字列

エラー

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

ConflictException

リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。

HTTP ステータスコード: 409

InternalFailureException

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

HTTP ステータスコード: 500

InvalidParameterValueException

1 つ以上のパラメータに無効な値があります。

HTTP ステータスコード: 400

ResourceExistsException

指定されたリソースは既に存在します。

HTTP ステータスコード: 409

ResourceNotFoundException

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

HTTP ステータスコード: 404

ThrottlingException

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

HTTP ステータスコード: 429

UnsupportedUserEditionException

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

HTTP ステータスコード: 403

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

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