DescribeDataset
Describe an Amazon Lookout for Vision dataset.
This operation requires permissions to perform the
lookoutvision:DescribeDataset
operation.
Request Syntax
GET /2020-11-20/projects/projectName
/datasets/datasetType
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- datasetType
-
The type of the dataset to describe. Specify
train
to describe the training dataset. Specifytest
to describe the test dataset. If you have a single dataset project, specifytrain
Length Constraints: Minimum length of 1. Maximum length of 10.
Pattern:
train|test
Required: Yes
- projectName
-
The name of the project that contains the dataset that you want to describe.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9][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
{
"DatasetDescription": {
"CreationTimestamp": number,
"DatasetType": "string",
"ImageStats": {
"Anomaly": number,
"Labeled": number,
"Normal": number,
"Total": number
},
"LastUpdatedTimestamp": number,
"ProjectName": "string",
"Status": "string",
"StatusMessage": "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.
- DatasetDescription
-
The description of the requested dataset.
Type: DatasetDescription object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform the action.
HTTP Status Code: 403
- ConflictException
-
The update or deletion of a resource caused an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
Amazon Lookout for Vision experienced a service issue. Try your call again.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource could not be found.
HTTP Status Code: 404
- ThrottlingException
-
Amazon Lookout for Vision is temporarily unable to process the request. Try your call again.
HTTP Status Code: 429
- ValidationException
-
An input validation error occured. For example, invalid characters in a project name, or if a pagination token is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: