DescribeTemplate - Amazon QuickSight
요청 구문URI 요청 파라미터요청 본문응답 구문응답 요소오류참고 항목

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

DescribeTemplate

템플릿의 메타데이터 설명

요청 구문

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

URI 요청 파라미터

요청은 다음의 URI 파라미터를 사용합니다.

AliasName

설명할 템플릿의 별칭입니다. 특정 별칭의 이름을 지정하는 경우 별칭이 가리키는 버전을 기술합니다. 키워드를 제공하여 템플릿의 최신 버전을 지정할 수 있습니다.$LATEST의AliasName파라미터. 키워드$PUBLISHED템플릿에는 적용되지 않습니다.

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

패턴: [\w\-]+|(\$LATEST)|(\$PUBLISHED)

AwsAccountId

의 ID입니다.AWS설명하는 템플릿이 포함된 계정입니다.

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

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

필수: 필수 예

TemplateId

템플릿의 ID입니다.

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

패턴: [\w\-]+

필수: 필수 예

VersionNumber

(선택 사항) 기술할 버전 번호입니다. 만약 aVersionNumber매개 변수 값이 제공되지 않으면 템플릿의 최신 버전이 설명됩니다.

유효 범위: 최소값 1.

요청 본문

요청에 요청 본문이 없습니다.

응답 구문

HTTP/1.1 Status
Content-type: application/json

{
   "RequestId": "string",
   "Template": { 
      "Arn": "string",
      "CreatedTime": number,
      "LastUpdatedTime": number,
      "Name": "string",
      "TemplateId": "string",
      "Version": { 
         "CreatedTime": number,
         "DataSetConfigurations": [ 
            { 
               "ColumnGroupSchemaList": [ 
                  { 
                     "ColumnGroupColumnSchemaList": [ 
                        { 
                           "Name": "string"
                        }
                     ],
                     "Name": "string"
                  }
               ],
               "DataSetSchema": { 
                  "ColumnSchemaList": [ 
                     { 
                        "DataType": "string",
                        "GeographicRole": "string",
                        "Name": "string"
                     }
                  ]
               },
               "Placeholder": "string"
            }
         ],
         "Description": "string",
         "Errors": [ 
            { 
               "Message": "string",
               "Type": "string"
            }
         ],
         "Sheets": [ 
            { 
               "Name": "string",
               "SheetId": "string"
            }
         ],
         "SourceEntityArn": "string",
         "Status": "string",
         "ThemeArn": "string",
         "VersionNumber": number
      }
   }
}

응답 요소

작업이 성공하면 서비스가 다음 HTTP 응답을 다시 전송합니다.

Status

요청의 HTTP 상태입니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

RequestId

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

Type: 문자열

Template

설명할 객체의 템플릿 구조입니다.

유형: Template 객체

오류

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

AccessDeniedException

이 항목에 액세스할 수 없음 제공된 자격 증명을 검증할 수 없습니다. 요청을 수행할 권한이 없을 수도 있습니다. 계정이 Amazon을 사용할 수 있도록 승인되었는지 확인합니다. QuickSight 서비스에 올바른 권한이 있고 올바른 액세스 키를 사용하고 있는지 확인합니다.

HTTP 상태 코드: 401

ConflictException

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

HTTP 상태 코드: 409

InternalFailureException

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

HTTP 상태 코드: 500

InvalidParameterValueException

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

HTTP 상태 코드: 400

ResourceExistsException

지정한 리소스가 이미 존재합니다.

HTTP 상태 코드: 409

ResourceNotFoundException

리소스를 하나 이상 찾을 수 없음

HTTP 상태 코드: 404

ThrottlingException

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

HTTP 상태 코드: 429

UnsupportedUserEditionException

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

HTTP 상태 코드: 403

참고 항목

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