DescribeDataset

Returns the definition of a specific DataBrew dataset.

Request Syntax


GET /datasets/name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

The name of the dataset to be described.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreateDate": number,
   "CreatedBy": "string",
   "Format": "string",
   "FormatOptions": { 
      "Csv": { 
         "Delimiter": "string",
         "HeaderRow": boolean
      },
      "Excel": { 
         "HeaderRow": boolean,
         "SheetIndexes": [ number ],
         "SheetNames": [ "string" ]
      },
      "Json": { 
         "MultiLine": boolean
      }
   },
   "Input": { 
      "DatabaseInputDefinition": { 
         "DatabaseTableName": "string",
         "GlueConnectionName": "string",
         "QueryString": "string",
         "TempDirectory": { 
            "Bucket": "string",
            "BucketOwner": "string",
            "Key": "string"
         }
      },
      "DataCatalogInputDefinition": { 
         "CatalogId": "string",
         "DatabaseName": "string",
         "TableName": "string",
         "TempDirectory": { 
            "Bucket": "string",
            "BucketOwner": "string",
            "Key": "string"
         }
      },
      "Metadata": { 
         "SourceArn": "string"
      },
      "S3InputDefinition": { 
         "Bucket": "string",
         "BucketOwner": "string",
         "Key": "string"
      }
   },
   "LastModifiedBy": "string",
   "LastModifiedDate": number,
   "Name": "string",
   "PathOptions": { 
      "FilesLimit": { 
         "MaxFiles": number,
         "Order": "string",
         "OrderedBy": "string"
      },
      "LastModifiedDateCondition": { 
         "Expression": "string",
         "ValuesMap": { 
            "string" : "string" 
         }
      },
      "Parameters": { 
         "string" : { 
            "CreateColumn": boolean,
            "DatetimeOptions": { 
               "Format": "string",
               "LocaleCode": "string",
               "TimezoneOffset": "string"
            },
            "Filter": { 
               "Expression": "string",
               "ValuesMap": { 
                  "string" : "string" 
               }
            },
            "Name": "string",
            "Type": "string"
         }
      }
   },
   "ResourceArn": "string",
   "Source": "string",
   "Tags": { 
      "string" : "string" 
   }
}