DescribeDashboard - Amazon QuickSight
リクエストの構文URI リクエストパラメータリクエスト本文レスポンスの構文レスポンス要素エラー以下の資料も参照してください。

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

DescribeDashboard

ダッシュボードの概要を提供します。

リクエストの構文

GET /accounts/AwsAccountId/dashboards/DashboardId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

URI リクエストパラメータ

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

AliasName

エイリアス名。

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

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

AwsAccountId

の IDAWS説明しているダッシュボードを含むアカウント。

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

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

必須: はい

DashboardId

ダッシュボードの ID。

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

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

必須: はい

VersionNumber

ダッシュボードのバージョン番号。バージョン番号が渡されない場合、最新の公開されたダッシュボードバージョンが表示されます。

有効範囲: 最小値は 1 です。

リクエスト本文

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

レスポンスの構文

HTTP/1.1 Status
Content-type: application/json

{
   "Dashboard": { 
      "Arn": "string",
      "CreatedTime": number,
      "DashboardId": "string",
      "LastPublishedTime": number,
      "LastUpdatedTime": number,
      "Name": "string",
      "Version": { 
         "Arn": "string",
         "CreatedTime": number,
         "DataSetArns": [ "string" ],
         "Description": "string",
         "Errors": [ 
            { 
               "Message": "string",
               "Type": "string"
            }
         ],
         "Sheets": [ 
            { 
               "Name": "string",
               "SheetId": "string"
            }
         ],
         "SourceEntityArn": "string",
         "Status": "string",
         "ThemeArn": "string",
         "VersionNumber": number
      }
   },
   "RequestId": "string"
}

レスポンス要素

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

Status

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

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

Dashboard

ダッシュボードに関する情報。

型: Dashboard オブジェクト

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 があります。すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。​

HTTP ステータスコード: 403

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

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