describe_dataset

describe_dataset(**kwargs)

Describe an Amazon Lookout for Vision dataset.

This operation requires permissions to perform the lookoutvision:DescribeDataset operation.

See also: AWS API Documentation

Request Syntax

response = client.describe_dataset(
    ProjectName='string',
    DatasetType='string'
)

Parameters

• ProjectName (string) --

  [REQUIRED]

  The name of the project that contains the dataset that you want to describe.

• DatasetType (string) --

  [REQUIRED]

  The type of the dataset to describe. Specify train to describe the training dataset. Specify test to describe the test dataset. If you have a single dataset project, specify train

Return type

dict

Returns

Response Syntax

{
    'DatasetDescription': {
        'ProjectName': 'string',
        'DatasetType': 'string',
        'CreationTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED_ROLLBACK_IN_PROGRESS'|'UPDATE_FAILED_ROLLBACK_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED',
        'StatusMessage': 'string',
        'ImageStats': {
            'Total': 123,
            'Labeled': 123,
            'Normal': 123,
            'Anomaly': 123
        }
    }
}

Response Structure

• (dict) --

  • DatasetDescription (dict) --

    The description of the requested dataset.

    • ProjectName (string) --

      The name of the project that contains the dataset.

    • DatasetType (string) --

      The type of the dataset. The value train represents a training dataset or single dataset project. The value test represents a test dataset.

    • CreationTimestamp (datetime) --

      The Unix timestamp for the time and date that the dataset was created.

    • LastUpdatedTimestamp (datetime) --

      The Unix timestamp for the date and time that the dataset was last updated.

    • Status (string) --

      The status of the dataset.

    • StatusMessage (string) --

      The status message for the dataset.

    • ImageStats (dict) --

      Statistics about the images in a dataset.

      • Total (integer) --

        The total number of images in the dataset.

      • Labeled (integer) --

        The total number of labeled images.

      • Normal (integer) --

        The total number of images labeled as normal.

      • Anomaly (integer) --

        the total number of images labeled as an anomaly.

Exceptions

• LookoutforVision.Client.exceptions.AccessDeniedException
• LookoutforVision.Client.exceptions.InternalServerException
• LookoutforVision.Client.exceptions.ValidationException
• LookoutforVision.Client.exceptions.ConflictException
• LookoutforVision.Client.exceptions.ResourceNotFoundException
• LookoutforVision.Client.exceptions.ThrottlingException