MachineLearning / Waiter / BatchPredictionAvailable

BatchPredictionAvailable#

class MachineLearning.Waiter.BatchPredictionAvailable#
waiter = client.get_waiter('batch_prediction_available')
wait(**kwargs)#

Polls MachineLearning.Client.describe_batch_predictions() every 30 seconds until a successful state is reached. An error is raised after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    FilterVariable='CreatedAt'|'LastUpdatedAt'|'Status'|'Name'|'IAMUser'|'MLModelId'|'DataSourceId'|'DataURI',
    EQ='string',
    GT='string',
    LT='string',
    GE='string',
    LE='string',
    NE='string',
    Prefix='string',
    SortOrder='asc'|'dsc',
    NextToken='string',
    Limit=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:

  • FilterVariable (string) –

    Use one of the following variables to filter a list of BatchPrediction:

    • CreatedAt - Sets the search criteria to the BatchPrediction creation date.

    • Status - Sets the search criteria to the BatchPrediction status.

    • Name - Sets the search criteria to the contents of the BatchPrediction Name.

    • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.

    • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.

    • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.

    • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

  • EQ (string) – The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.

  • GT (string) – The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.

  • LT (string) – The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.

  • GE (string) – The greater than or equal to operator. The BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE.

  • LE (string) – The less than or equal to operator. The BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE.

  • NE (string) – The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

  • Prefix (string) –

    A string that is found at the beginning of a variable, such as Name or Id.

    For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix:

    • 2014-09

    • 2014-09-09

    • 2014-09-09-Holiday

  • SortOrder (string) –

    A two-value parameter that determines the sequence of the resulting list of ``MLModel``s.

    • asc - Arranges the list in ascending order (A-Z, 0-9).

    • dsc - Arranges the list in descending order (Z-A, 9-0).

    Results are sorted by FilterVariable.

  • NextToken (string) – An ID of the page in the paginated results.

  • Limit (integer) – The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

      The amount of time in seconds to wait between attempts. Default: 30

    • MaxAttempts (integer) –

      The maximum number of attempts to be made. Default: 60

Returns:

None