SageMaker / Client / list_inference_experiments

list_inference_experiments#

SageMaker.Client.list_inference_experiments(**kwargs)#

Returns the list of all inference experiments.

See also: AWS API Documentation

Request Syntax

response = client.list_inference_experiments(
    NameContains='string',
    Type='ShadowMode',
    StatusEquals='Creating'|'Created'|'Updating'|'Running'|'Starting'|'Stopping'|'Completed'|'Cancelled',
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    LastModifiedTimeAfter=datetime(2015, 1, 1),
    LastModifiedTimeBefore=datetime(2015, 1, 1),
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NameContains (string) – Selects inference experiments whose names contain this name.

  • Type (string) – Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperimentRequest$Type.

  • StatusEquals (string) – Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperimentResponse$Status.

  • CreationTimeAfter (datetime) – Selects inference experiments which were created after this timestamp.

  • CreationTimeBefore (datetime) – Selects inference experiments which were created before this timestamp.

  • LastModifiedTimeAfter (datetime) – Selects inference experiments which were last modified after this timestamp.

  • LastModifiedTimeBefore (datetime) – Selects inference experiments which were last modified before this timestamp.

  • SortBy (string) – The column by which to sort the listed inference experiments.

  • SortOrder (string) – The direction of sorting (ascending or descending).

  • NextToken (string) – The response from the last list when returning a list large enough to need tokening.

  • MaxResults (integer) – The maximum number of results to select.

Return type:

dict

Returns:

Response Syntax

{
    'InferenceExperiments': [
        {
            'Name': 'string',
            'Type': 'ShadowMode',
            'Schedule': {
                'StartTime': datetime(2015, 1, 1),
                'EndTime': datetime(2015, 1, 1)
            },
            'Status': 'Creating'|'Created'|'Updating'|'Running'|'Starting'|'Stopping'|'Completed'|'Cancelled',
            'StatusReason': 'string',
            'Description': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'CompletionTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'RoleArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • InferenceExperiments (list) –

      List of inference experiments.

      • (dict) –

        Lists a summary of properties of an inference experiment.

        • Name (string) –

          The name of the inference experiment.

        • Type (string) –

          The type of the inference experiment.

        • Schedule (dict) –

          The duration for which the inference experiment ran or will run.

          The maximum duration that you can set for an inference experiment is 30 days.

          • StartTime (datetime) –

            The timestamp at which the inference experiment started or will start.

          • EndTime (datetime) –

            The timestamp at which the inference experiment ended or will end.

        • Status (string) –

          The status of the inference experiment.

        • StatusReason (string) –

          The error message for the inference experiment status result.

        • Description (string) –

          The description of the inference experiment.

        • CreationTime (datetime) –

          The timestamp at which the inference experiment was created.

        • CompletionTime (datetime) –

          The timestamp at which the inference experiment was completed.

        • LastModifiedTime (datetime) –

          The timestamp when you last modified the inference experiment.

        • RoleArn (string) –

          The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

    • NextToken (string) –

      The token to use when calling the next page of results.