LookoutforVision / Client / list_dataset_entries

list_dataset_entries#

LookoutforVision.Client.list_dataset_entries(**kwargs)#

Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information for a single image, including the image location and the assigned label.

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

See also: AWS API Documentation

Request Syntax

response = client.list_dataset_entries(
    ProjectName='string',
    DatasetType='string',
    Labeled=True|False,
    AnomalyClass='string',
    BeforeCreationDate=datetime(2015, 1, 1),
    AfterCreationDate=datetime(2015, 1, 1),
    NextToken='string',
    MaxResults=123,
    SourceRefContains='string'
)
Parameters:

  • ProjectName (string) –

    [REQUIRED]

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

  • DatasetType (string) –

    [REQUIRED]

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

  • Labeled (boolean) – Specify true to include labeled entries, otherwise specify false. If you don’t specify a value, Lookout for Vision returns all entries.

  • AnomalyClass (string) – Specify normal to include only normal images. Specify anomaly to only include anomalous entries. If you don’t specify a value, Amazon Lookout for Vision returns normal and anomalous images.

  • BeforeCreationDate (datetime) – Only includes entries before the specified date in the response. For example, 2020-06-23T00:00:00.

  • AfterCreationDate (datetime) – Only includes entries after the specified date in the response. For example, 2020-06-23T00:00:00.

  • NextToken (string) – If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.

  • MaxResults (integer) – The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

  • SourceRefContains (string) – Perform a “contains” search on the values of the source-ref key within the dataset. For example a value of “IMG_17” returns all JSON Lines where the source-ref key value matches IMG_17.

Return type:

dict

Returns:

Response Syntax

{
    'DatasetEntries': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DatasetEntries (list) –

      A list of the entries (JSON Lines) within the dataset.

      • (string) –

    • NextToken (string) –

      If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set ofdataset entries.

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