list_flywheels

Comprehend.Client.list_flywheels(**kwargs)

Gets a list of the flywheels that you have created.

See also: AWS API Documentation

Request Syntax

response = client.list_flywheels(
    Filter={
        'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'CreationTimeAfter': datetime(2015, 1, 1),
        'CreationTimeBefore': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

Parameters

• Filter (dict) --

  Filters the flywheels that are returned. You can filter flywheels on their status, or the date and time that they were submitted. You can only set one filter at a time.

  • Status (string) --

    Filter the flywheels based on the flywheel status.

  • CreationTimeAfter (datetime) --

    Filter the flywheels to include flywheels created after the specified time.

  • CreationTimeBefore (datetime) --

    Filter the flywheels to include flywheels created before the specified time.

• NextToken (string) -- Identifies the next page of results to return.
• MaxResults (integer) -- Maximum number of results to return in a response. The default is 100.

Return type

dict

Returns

Response Syntax

{
    'FlywheelSummaryList': [
        {
            'FlywheelArn': 'string',
            'ActiveModelArn': 'string',
            'DataLakeS3Uri': 'string',
            'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
            'ModelType': 'DOCUMENT_CLASSIFIER'|'ENTITY_RECOGNIZER',
            'Message': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'LatestFlywheelIteration': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • FlywheelSummaryList (list) --

    A list of flywheel properties retrieved by the service in response to the request.

    • (dict) --

      Flywheel summary information.

      • FlywheelArn (string) --

        The Amazon Resource Number (ARN) of the flywheel

      • ActiveModelArn (string) --

        ARN of the active model version for the flywheel.

      • DataLakeS3Uri (string) --

        Amazon S3 URI of the data lake location.

      • Status (string) --

        The status of the flywheel.

      • ModelType (string) --

        Model type of the flywheel's model.

      • Message (string) --

        A description of the status of the flywheel.

      • CreationTime (datetime) --

        Creation time of the flywheel.

      • LastModifiedTime (datetime) --

        Last modified time for the flywheel.

      • LatestFlywheelIteration (string) --

        The most recent flywheel iteration.

  • NextToken (string) --

    Identifies the next page of results to return.

Exceptions

• Comprehend.Client.exceptions.InvalidRequestException
• Comprehend.Client.exceptions.TooManyRequestsException
• Comprehend.Client.exceptions.InvalidFilterException
• Comprehend.Client.exceptions.InternalServerException