Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeDataset

Provides a JSON description of the data in each time series dataset, including names, column names, and data types.

Request Syntax


{
   "DatasetName": "string"
}

Request Parameters

The request accepts the following data in JSON format.

DatasetName

The name of the dataset to be described.

Type: String

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

Pattern: ^[0-9a-zA-Z_-]{1,200}$

Required: Yes

Response Syntax


{
   "CreatedAt": number,
   "DataEndTime": number,
   "DataQualitySummary": { 
      "DuplicateTimestamps": { 
         "TotalNumberOfDuplicateTimestamps": number
      },
      "InsufficientSensorData": { 
         "MissingCompleteSensorData": { 
            "AffectedSensorCount": number
         },
         "SensorsWithShortDateRange": { 
            "AffectedSensorCount": number
         }
      },
      "InvalidSensorData": { 
         "AffectedSensorCount": number,
         "TotalNumberOfInvalidValues": number
      },
      "MissingSensorData": { 
         "AffectedSensorCount": number,
         "TotalNumberOfMissingValues": number
      },
      "UnsupportedTimestamps": { 
         "TotalNumberOfUnsupportedTimestamps": number
      }
   },
   "DatasetArn": "string",
   "DatasetName": "string",
   "DataStartTime": number,
   "IngestedFilesSummary": { 
      "DiscardedFiles": [ 
         { 
            "Bucket": "string",
            "Key": "string"
         }
      ],
      "IngestedNumberOfFiles": number,
      "TotalNumberOfFiles": number
   },
   "IngestionInputConfiguration": { 
      "S3InputConfiguration": { 
         "Bucket": "string",
         "KeyPattern": "string",
         "Prefix": "string"
      }
   },
   "LastUpdatedAt": number,
   "RoleArn": "string",
   "Schema": "string",
   "ServerSideKmsKeyId": "string",
   "SourceDatasetArn": "string",
   "Status": "string"
}

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.

CreatedAt

Specifies the time the dataset was created in Lookout for Equipment.

Type: Timestamp

DataEndTime

Indicates the latest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

Type: Timestamp

DataQualitySummary

Gives statistics associated with the given dataset for the latest successful associated ingestion job id. These statistics primarily relate to quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.

Type: DataQualitySummary object

DatasetArn

The Amazon Resource Name (ARN) of the dataset being described.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:dataset\/[0-9a-zA-Z_-]{1,200}\/.+

DatasetName

The name of the dataset being described.

Type: String

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

Pattern: ^[0-9a-zA-Z_-]{1,200}$

DataStartTime

Indicates the earliest timestamp corresponding to data that was successfully ingested during the most recent ingestion of this particular dataset.

Type: Timestamp

IngestedFilesSummary

IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id.

Type: IngestedFilesSummary object

IngestionInputConfiguration

Specifies the S3 location configuration for the data input for the data ingestion job.

Type: IngestionInputConfiguration object

LastUpdatedAt

Specifies the time the dataset was last updated, if it was.

Type: Timestamp

RoleArn

The Amazon Resource Name (ARN) of the IAM role that you are using for this the data ingestion job.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

Schema

A JSON description of the data that is in each time series dataset, including names, column names, and data types.

Type: String

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

ServerSideKmsKeyId

Provides the identifier of the AWS KMS key used to encrypt dataset data by Amazon Lookout for Equipment.

Type: String

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

Pattern: arn:aws[a-z\-]*:kms:[a-z0-9\-]*:\d{12}:[\w\-\/]+

SourceDatasetArn

The Amazon Resource Name (ARN) of the source dataset from which the current data being described was imported from.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:dataset\/[0-9a-zA-Z_-]{1,200}\/.+

Status

Indicates the status of the dataset.

Type: String

Valid Values: CREATED | INGESTION_IN_PROGRESS | ACTIVE | IMPORT_IN_PROGRESS

Errors

AccessDeniedException

The request could not be completed because you do not have access to the resource.

HTTP Status Code: 400

InternalServerException

Processing of the request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource requested could not be found. Verify the resource ID and retry your request.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

HTTP Status Code: 400