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

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

UpdateDashboard

でダッシュボードを更新します。AWSアカウント.

注記

ダッシュボードを更新すると、新しいダッシュボードバージョンが作成されますが、新しいバージョンはすぐには公開されません。ダッシュボードの発行済みバージョンを更新するには、 UpdateDashboardPublishedVersion API オペレーション。

リクエストの構文

PUT /accounts/AwsAccountId/dashboards/DashboardId HTTP/1.1
Content-type: application/json

{
   "DashboardPublishOptions": { 
      "AdHocFilteringOption": { 
         "AvailabilityStatus": "string"
      },
      "ExportToCSVOption": { 
         "AvailabilityStatus": "string"
      },
      "SheetControlsOption": { 
         "VisibilityState": "string"
      }
   },
   "Name": "string",
   "Parameters": { 
      "DateTimeParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "DecimalParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "IntegerParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "StringParameters": [ 
         { 
            "Name": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "SourceEntity": { 
      "SourceTemplate": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      }
   },
   "ThemeArn": "string",
   "VersionDescription": "string"
}

URI リクエストパラメータ

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

AwsAccountId

の IDAWS更新するダッシュボードを含むアカウント。

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

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

: はい

DashboardId

ダッシュボードの ID。

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

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

: はい

リクエストボディ

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

Name

ダッシュボードの表示名。

Type: 文字列

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

: はい

SourceEntity

ダッシュボードを更新するときにソースとして使用しているエンティティ。In (イン)SourceEntityでは、ソースとして使用しているオブジェクトのタイプを指定します。ダッシュボードはテンプレートからしか更新できないため、SourceTemplateエンティティ。分析からダッシュボードを更新する必要がある場合は、まず、 CreateTemplate API オペレーション。SourceTemplate を使用する場合、ソーステンプレートの Amazon リソースネーム (ARN) を指定します。-SourceTemplateARN には任意のものを含めることができますAWSアカウントと任意の Amazon QuickSight-サポートAWS リージョン。

SourceTemplate 内の DataSetReferences エンティティを使用して、オリジナルに一覧表示されているプレースホルダーの代替データセットを一覧表示します。各データセットのスキーマは、そのプレースホルダーと一致する必要があります。

型: DashboardSourceEntity オブジェクト

: はい

DashboardPublishOptions

ダッシュボードの作成時にダッシュボードを公開するためのオプション:

  • AdHocFilteringOption の AvailabilityStatus - このステータスは、ENABLED または DISABLED になります。これを、に設定した場合DISABLED、アマゾン QuickSight で公開ダッシュボードの左側のフィルターペインが無効になります。このペインは、アドホック (ワンタイム) フィルタリングに使用できます。このオプションはデフォルトで ENABLED に設定されています。

  • ExportToCSVOption の AvailabilityStatus - このステータスは、ENABLED または DISABLED になります。これを DISABLED に設定すると、データを .CSV 形式にエクスポートするビジュアルオプションは有効になりません。このオプションはデフォルトで ENABLED に設定されています。

  • VisibilityState の SheetControlsOption - この可視性の状態は、COLLAPSED または EXPANDED になります。このオプションはデフォルトで COLLAPSED に設定されています。

型: DashboardPublishOptions オブジェクト

: いいえ

Parameters

ダッシュボードのパラメータを含む構造体。これらは、ダッシュボードのパラメータオーバーライドです。ダッシュボードには任意のパラメータタイプを指定でき、パラメータによっては複数の値を受け入れることができます。

型: Parameters オブジェクト

: いいえ

ThemeArn

このダッシュボードで使用されているテーマの Amazon リソースネーム (ARN)。このフィールドに値を追加すると、エンティティに元々関連付けられていた値が上書きされます。テーマ ARN は、ダッシュボードを作成する AWS アカウントと同じアカウントに存在する必要があります。

Type: 文字列

: いいえ

VersionDescription

作成されるダッシュボードの最初のバージョンの説明。

Type: 文字列

長さの制約: 最小長は 1 です｡ 最大長は 512 です。

: いいえ

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationStatus": "string",
   "DashboardId": "string",
   "RequestId": "string",
   "Status": number,
   "VersionArn": "string"
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

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

Arn

リソースの Amazon リソースネーム (ARN)。

Type: 文字列

CreationStatus

リクエストの作成ステータス。

Type: 文字列

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

DashboardId

ダッシュボードの ID。

Type: 文字列

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

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

RequestId

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

Type: 文字列

Status

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

Type: 整数

VersionArn

バージョン番号を含むダッシュボードの ARN。

Type: 文字列

エラー

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

ConflictException

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

HTTP ステータスコード: 409

InternalFailureException

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

HTTP ステータスコード: 500

InvalidParameterValueException

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

HTTP ステータスコード: 400

LimitExceededException

制限を超過しています。

HTTP ステータスコード: 409

ResourceNotFoundException

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

HTTP ステータスコード: 404

ThrottlingException

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

HTTP ステータスコード: 429

UnsupportedUserEditionException

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

HTTP ステータスコード: 403

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

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