DescribeAnalysis - Amazon QuickSight

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

DescribeAnalysis

分析のメタデータの概要を提供します。

リクエストの構文

GET /accounts/AwsAccountId/analyses/AnalysisId HTTP/1.1

URI リクエストパラメータ

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

AnalysisId

記述中の分析の ID。ID は分析の URL の一部です。

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

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

必須: はい

AwsAccountId

の IDAWS分析を含むアカウント。を使用していることが必要ですAWS分析が入っていることを説明してください。

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

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

必須: はい

リクエスト本文

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

レスポンスの構文

HTTP/1.1 Status Content-type: application/json { "Analysis": { "AnalysisId": "string", "Arn": "string", "CreatedTime": number, "DataSetArns": [ "string" ], "Errors": [ { "Message": "string", "Type": "string" } ], "LastUpdatedTime": number, "Name": "string", "Sheets": [ { "Name": "string", "SheetId": "string" } ], "Status": "string", "ThemeArn": "string" }, "RequestId": "string" }

レスポンス要素

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

Status

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

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

Analysis

記述中の分析の概要情報を含むメタデータ構造。

型: Analysis オブジェクト

RequestId

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

Type: 文字列

エラー

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

AccessDeniedException

このアイテムにはアクセスできません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。アカウントがAmazonの使用を許可されていることを確認してください QuickSight ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。

HTTP ステータスコード: 401

InternalFailureException

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

HTTP ステータスコード: 500

InvalidParameterValueException

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

HTTP ステータスコード: 400

ResourceNotFoundException

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

HTTP ステータスコード: 404

ThrottlingException

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

HTTP ステータスコード: 429

UnsupportedUserEditionException

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

HTTP ステータスコード: 403

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

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