Skip to content

DescribeBatchPredictionsInput

Source code in docs_src/capo_machine_learning/types/describe_batch_predictions_input.py
class DescribeBatchPredictionsInput(TypedDict, closed=True):
    filter_variable: NotRequired[
        "capo_machine_learning.types.batch_prediction_filter_variable.BatchPredictionFilterVariable"
    ]
    """<p>Use one of the following variables to filter a list of <code>BatchPrediction</code>:</p> <ul> <li> <p> <code>CreatedAt</code> - Sets the search criteria to the <code>BatchPrediction</code> creation date.</p> </li> <li> <p> <code>Status</code> - Sets the search criteria to the <code>BatchPrediction</code> status.</p> </li> <li> <p> <code>Name</code> - Sets the search criteria to the contents of the <code>BatchPrediction</code> <b> </b> <code>Name</code>.</p> </li> <li> <p> <code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>BatchPrediction</code> creation.</p> </li> <li> <p> <code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> used in the <code>BatchPrediction</code>.</p> </li> <li> <p> <code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in the <code>BatchPrediction</code>.</p> </li> <li> <p> <code>DataURI</code> - Sets the search criteria to the data file(s) used in the <code>BatchPrediction</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.</p> </li> </ul>"""
    eq: NotRequired["capo_machine_learning.types.comparator_value.ComparatorValue"]
    """<p>The equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>"""
    gt: NotRequired["capo_machine_learning.types.comparator_value.ComparatorValue"]
    """<p>The greater than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>"""
    lt: NotRequired["capo_machine_learning.types.comparator_value.ComparatorValue"]
    """<p>The less than operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>"""
    ge: NotRequired["capo_machine_learning.types.comparator_value.ComparatorValue"]
    """<p>The greater than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>. </p>"""
    le: NotRequired["capo_machine_learning.types.comparator_value.ComparatorValue"]
    """<p>The less than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>"""
    ne: NotRequired["capo_machine_learning.types.comparator_value.ComparatorValue"]
    """<p>The not equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>"""
    prefix: NotRequired["capo_machine_learning.types.comparator_value.ComparatorValue"]
    """<p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p> <p>For example, a <code>Batch Prediction</code> operation could have the <code>Name</code> <code>2014-09-09-HolidayGiftMailer</code>. To search for this <code>BatchPrediction</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the <code>Prefix</code>: </p> <ul> <li> <p>2014-09</p> </li> <li> <p>2014-09-09</p> </li> <li> <p>2014-09-09-Holiday</p> </li> </ul>"""
    sort_order: NotRequired["capo_machine_learning.types.sort_order.SortOrder"]
    """<p>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>s.</p> <ul> <li> <p> <code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</p> </li> <li> <p> <code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</p> </li> </ul> <p>Results are sorted by <code>FilterVariable</code>.</p>"""
    next_token: NotRequired["capo_machine_learning.types.string_type.StringType"]
    """<p>An ID of the page in the paginated results.</p>"""
    limit: NotRequired["capo_machine_learning.types.page_limit.PageLimit"]
    """<p>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>.</p>"""

eq instance-attribute

eq: NotRequired[ComparatorValue]

The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.

filter_variable instance-attribute

filter_variable: NotRequired[BatchPredictionFilterVariable]

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.

ge instance-attribute

ge: NotRequired[ComparatorValue]

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.

gt instance-attribute

gt: NotRequired[ComparatorValue]

The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.

le instance-attribute

le: NotRequired[ComparatorValue]

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.

limit instance-attribute

limit: NotRequired[PageLimit]

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.

lt instance-attribute

lt: NotRequired[ComparatorValue]

The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.

ne instance-attribute

ne: NotRequired[ComparatorValue]

The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

next_token instance-attribute

next_token: NotRequired[StringType]

An ID of the page in the paginated results.

prefix instance-attribute

prefix: NotRequired[ComparatorValue]

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

sort_order instance-attribute

sort_order: NotRequired[SortOrder]

A two-value parameter that determines the sequence of the resulting list of MLModels.

  • 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.