기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
DescribeDataSet
데이터 세트를 설명합니다. 이 작업은 업로드된 파일을 소스로 포함하는 데이터셋을 지원하지 않습니다.
요청 구문
GET /accounts/AwsAccountId
/data-sets/DataSetId
HTTP/1.1
URI 요청 파라미터
요청은 다음의 URI 파라미터를 사용합니다.
- AwsAccountId
-
AWS 계정 ID입니다.
길이 제약: 고정 길이는 12입니다.
패턴:
^[0-9]{12}$
필수: 예
- DataSetId
-
생성하려는 데이터 세트의 ID입니다. 이 ID는 다음에 대해 고유합니다AWS 리전For eachAWS계정.
필수: 예
요청 본문
요청에 요청 본문이 없습니다.
응답 구문
HTTP/1.1 Status
Content-type: application/json
{
"DataSet": {
"Arn": "string",
"ColumnGroups": [
{
"GeoSpatialColumnGroup": {
"Columns": [ "string" ],
"CountryCode": "string",
"Name": "string"
}
}
],
"ColumnLevelPermissionRules": [
{
"ColumnNames": [ "string" ],
"Principals": [ "string" ]
}
],
"ConsumedSpiceCapacityInBytes": number,
"CreatedTime": number,
"DataSetId": "string",
"DataSetUsageConfiguration": {
"DisableUseAsDirectQuerySource": boolean,
"DisableUseAsImportedSource": boolean
},
"FieldFolders": {
"string" : {
"columns": [ "string" ],
"description": "string"
}
},
"ImportMode": "string",
"LastUpdatedTime": number,
"LogicalTableMap": {
"string" : {
"Alias": "string",
"DataTransforms": [
{
"CastColumnTypeOperation": {
"ColumnName": "string",
"Format": "string",
"NewColumnType": "string"
},
"CreateColumnsOperation": {
"Columns": [
{
"ColumnId": "string",
"ColumnName": "string",
"Expression": "string"
}
]
},
"FilterOperation": {
"ConditionExpression": "string"
},
"ProjectOperation": {
"ProjectedColumns": [ "string" ]
},
"RenameColumnOperation": {
"ColumnName": "string",
"NewColumnName": "string"
},
"TagColumnOperation": {
"ColumnName": "string",
"Tags": [
{
"ColumnDescription": {
"Text": "string"
},
"ColumnGeographicRole": "string"
}
]
},
"UntagColumnOperation": {
"ColumnName": "string",
"TagNames": [ "string" ]
}
}
],
"Source": {
"DataSetArn": "string",
"JoinInstruction": {
"LeftJoinKeyProperties": {
"UniqueKey": boolean
},
"LeftOperand": "string",
"OnClause": "string",
"RightJoinKeyProperties": {
"UniqueKey": boolean
},
"RightOperand": "string",
"Type": "string"
},
"PhysicalTableId": "string"
}
}
},
"Name": "string",
"OutputColumns": [
{
"Description": "string",
"Name": "string",
"Type": "string"
}
],
"PhysicalTableMap": {
"string" : {
"CustomSql": {
"Columns": [
{
"Name": "string",
"Type": "string"
}
],
"DataSourceArn": "string",
"Name": "string",
"SqlQuery": "string"
},
"RelationalTable": {
"Catalog": "string",
"DataSourceArn": "string",
"InputColumns": [
{
"Name": "string",
"Type": "string"
}
],
"Name": "string",
"Schema": "string"
},
"S3Source": {
"DataSourceArn": "string",
"InputColumns": [
{
"Name": "string",
"Type": "string"
}
],
"UploadSettings": {
"ContainsHeader": boolean,
"Delimiter": "string",
"Format": "string",
"StartFromRow": number,
"TextQualifier": "string"
}
}
}
},
"RowLevelPermissionDataSet": {
"Arn": "string",
"FormatVersion": "string",
"Namespace": "string",
"PermissionPolicy": "string",
"Status": "string"
},
"RowLevelPermissionTagConfiguration": {
"Status": "string",
"TagRules": [
{
"ColumnName": "string",
"MatchAllValue": "string",
"TagKey": "string",
"TagMultiValueDelimiter": "string"
}
]
}
},
"RequestId": "string"
}
응답 요소
작업이 성공하면 서비스가 다음 HTTP 응답을 다시 전송합니다.
- Status
-
요청의 HTTP 상태입니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
오류
모든 작업에 공통적인 오류에 대한 자세한 내용은 단원을 참조하십시오.일반적인 오류.
- AccessDeniedException
-
항목에 액세스할 수 없음 제공된 자격 증명을 검증할 수 없습니다. 요청을 수행할 권한이 없을 수도 있습니다. 계정이 Amazon을 사용할 수 있도록 승인되었는지 확인합니다. QuickSight 서비스에 있고 정책에 올바른 권한이 있고 올바른 액세스 키를 사용하고 있는지 확인합니다.
HTTP 상태 코드: 401
- InternalFailureException
-
내부 실패가 발생했습니다.
HTTP 상태 코드: 500
- InvalidParameterValueException
-
하나 이상의 매개변수에 유효하지 않은 값이 있습니다.
HTTP 상태 코드: 400
- ResourceNotFoundException
-
리소스를 하나 이상 찾을 수 없음
HTTP 상태 코드: 404
- ThrottlingException
-
액세스가 제한되었습니다.
HTTP 상태 코드: 429
예
예
이 예는 의 한 가지 사용법을 보여줍니다. DescribeDataSet.
예제 요청
GET /accounts/{AwsAccountId}/data-sets/{DataSetId} HTTP/1.1
Content-type: application/json
참고 항목
이 API를 언어별 AWS SDK 중 하나로 사용하는 방법에 대한 자세한 내용은 다음을 참조하세요.