list_model_quality_job_definitions

SageMaker.Client.list_model_quality_job_definitions(**kwargs)

Gets a list of model quality monitoring job definitions in your account.

See also: AWS API Documentation

Request Syntax

response = client.list_model_quality_job_definitions(
    EndpointName='string',
    SortBy='Name'|'CreationTime',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123,
    NameContains='string',
    CreationTimeBefore=datetime(2015, 1, 1),
    CreationTimeAfter=datetime(2015, 1, 1)
)

Parameters

• EndpointName (string) -- A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.
• SortBy (string) -- The field to sort results by. The default is CreationTime .
• SortOrder (string) -- The sort order for results. The default is Descending .
• NextToken (string) -- If the result of the previous ListModelQualityJobDefinitions request was truncated, the response includes a NextToken . To retrieve the next set of model quality monitoring job definitions, use the token in the next request.
• MaxResults (integer) -- The maximum number of results to return in a call to ListModelQualityJobDefinitions .
• NameContains (string) -- A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.
• CreationTimeBefore (datetime) -- A filter that returns only model quality monitoring job definitions created before the specified time.
• CreationTimeAfter (datetime) -- A filter that returns only model quality monitoring job definitions created after the specified time.

Return type

dict

Returns

Response Syntax

{
    'JobDefinitionSummaries': [
        {
            'MonitoringJobDefinitionName': 'string',
            'MonitoringJobDefinitionArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'EndpointName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • JobDefinitionSummaries (list) --

    A list of summaries of model quality monitoring job definitions.

    • (dict) --

      Summary information about a monitoring job.

      • MonitoringJobDefinitionName (string) --

        The name of the monitoring job.

      • MonitoringJobDefinitionArn (string) --

        The Amazon Resource Name (ARN) of the monitoring job.

      • CreationTime (datetime) --

        The time that the monitoring job was created.

      • EndpointName (string) --

        The name of the endpoint that the job monitors.

  • NextToken (string) --

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.