Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeDataset

Retrieves information about a dataset.

Request Syntax


GET /datasets/datasetName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

datasetName

The name of the dataset whose information is retrieved.

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

Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$)

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "dataset": { 
      "actions": [ 
         { 
            "actionName": "string",
            "containerAction": { 
               "executionRoleArn": "string",
               "image": "string",
               "resourceConfiguration": { 
                  "computeType": "string",
                  "volumeSizeInGB": number
               },
               "variables": [ 
                  { 
                     "datasetContentVersionValue": { 
                        "datasetName": "string"
                     },
                     "doubleValue": number,
                     "name": "string",
                     "outputFileUriValue": { 
                        "fileName": "string"
                     },
                     "stringValue": "string"
                  }
               ]
            },
            "queryAction": { 
               "filters": [ 
                  { 
                     "deltaTime": { 
                        "offsetSeconds": number,
                        "timeExpression": "string"
                     }
                  }
               ],
               "sqlQuery": "string"
            }
         }
      ],
      "arn": "string",
      "contentDeliveryRules": [ 
         { 
            "destination": { 
               "iotEventsDestinationConfiguration": { 
                  "inputName": "string",
                  "roleArn": "string"
               },
               "s3DestinationConfiguration": { 
                  "bucket": "string",
                  "glueConfiguration": { 
                     "databaseName": "string",
                     "tableName": "string"
                  },
                  "key": "string",
                  "roleArn": "string"
               }
            },
            "entryName": "string"
         }
      ],
      "creationTime": number,
      "lastUpdateTime": number,
      "lateDataRules": [ 
         { 
            "ruleConfiguration": { 
               "deltaTimeSessionWindowConfiguration": { 
                  "timeoutInMinutes": number
               }
            },
            "ruleName": "string"
         }
      ],
      "name": "string",
      "retentionPeriod": { 
         "numberOfDays": number,
         "unlimited": boolean
      },
      "status": "string",
      "triggers": [ 
         { 
            "dataset": { 
               "name": "string"
            },
            "schedule": { 
               "expression": "string"
            }
         }
      ],
      "versioningConfiguration": { 
         "maxVersions": number,
         "unlimited": boolean
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

dataset

An object that contains information about the dataset.

Type: Dataset object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the specified name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400