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

의 ID입니다.AWS업데이트하려는 대시보드가 포함된 계정입니다.

길이 제약: 고정 길이는 12자입니다.

패턴: ^[0-9]{12}$

필수 사항 예

DashboardId

대시보드의 ID입니다.

길이 제약: 최소 길이는 1이고, 최대 길이 2048.

패턴: [\w\-]+

필수 사항 예

요청 본문

요청은 JSON 형식의 다음 데이터를 받습니다.

Name

대시보드의 표시 이름입니다.

Type: 문자열

길이 제약: 최소 길이는 1이고, 최대 길이 2048.

필수 사항 예

SourceEntity

대시보드를 업데이트할 때 소스로 사용하는 엔터티입니다. InSourceEntity소스로 사용할 객체 유형을 지정합니다. 템플릿에서만 대시보드를 업데이트할 수 있으므로SourceTemplate엔터티. 분석에서 대시보드를 업데이트해야 하는 경우 먼저 CreateTemplate API 연산. 용SourceTemplate소스 템플릿의 Amazon 리소스 이름 (ARN) 을 지정합니다. 이SourceTemplateARN에는 임의의 항목이 포함될 수AWS계정 및 모든 아마존 QuickSight-는 지원되는AWS 리전.

사용DataSetReferences내 엔티티SourceTemplate원본에 나열된 자리 표시자의 대체 데이터셋을 나열합니다. 각 데이터셋의 스키마는 자리 표시자와 일치해야 합니다.

유형: DashboardSourceEntity 객체

필수 사항 예

DashboardPublishOptions

대시보드를 만들 때 대시보드를 게시하는 옵션은 다음과 같습니다.

  • AvailabilityStatus...에 대한AdHocFilteringOption- 이 상태는 다음ENABLED또는DISABLED. 이를 로 설정할 경우DISABLED, Amazon QuickSight 게시된 대시보드에서 임시 (일회성) 필터링에 사용할 수 있는 왼쪽 필터 창을 비활성화합니다. 이 옵션은 다음과 같습니다.ENABLED기본적으로 입니다.

  • AvailabilityStatus...에 대한ExportToCSVOption- 이 상태는 다음ENABLED또는DISABLED. 데이터를.CSV 형식으로 내보내는 시각적 옵션은 로 설정된 경우 활성화되지 않습니다.DISABLED. 이 옵션은 다음과 같습니다.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이고, 최대 길이 2048.

패턴: [\w\-]+

RequestId

이AWS작업에 대한 요청 ID입니다.

Type: 문자열

Status

요청의 HTTP 상태입니다.

Type: Integer

VersionArn

대시보드의 ARN이며 버전 번호가 포함됩니다.

Type: 문자열

오류

모든 작업에 공통적인 오류에 대한 자세한 내용은 단원을 참조하십시오.일반적인 오류.

ConflictException

리소스를 업데이트하거나 삭제하면 일관성 없는 상태가 발생할 수 있습니다.

HTTP 상태 코드: 409

InternalFailureException

내부 실패가 발생했습니다.

HTTP 상태 코드: 500

InvalidParameterValueException

하나 이상의 매개변수에 유효하지 않은 값이 있습니다.

HTTP 상태 코드: 400

LimitExceededException

한도를 초과했습니다.

HTTP 상태 코드: 409

ResourceNotFoundException

리소스를 하나 이상 찾을 수 없습니다.

HTTP 상태 코드: 404

ThrottlingException

액세스가 제한되었습니다.

HTTP 상태 코드: 429

UnsupportedUserEditionException

이 오류는 아마존에서 작업을 호출하고 있음을 나타냅니다. QuickSight구독: 에디션에는 해당 작업에 대한 지원이 포함되어 있지 않습니다. Amazon Amazon QuickSight 현재 스탠다드 에디션과 엔터프라이즈 에디션이 있습니다. 모든 에디션에서 모든 작동 및 기능을 사용할 수 있는 것은 아닙니다.

HTTP 상태 코드: 403

참고 항목

이 API를 언어별 AWS SDK 중 하나로 사용하는 방법에 대한 자세한 내용은 다음을 참조하세요.