ListModelExplainabilityJobDefinitions

class SageMaker.Paginator.ListModelExplainabilityJobDefinitions

paginator = client.get_paginator('list_model_explainability_job_definitions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_model_explainability_job_definitions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    EndpointName='string',
    SortBy='Name'|'CreationTime',
    SortOrder='Ascending'|'Descending',
    NameContains='string',
    CreationTimeBefore=datetime(2015, 1, 1),
    CreationTimeAfter=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• EndpointName (string) -- Name of the endpoint to monitor for model explainability.
• SortBy (string) -- Whether to sort results by the Name or CreationTime field. The default is CreationTime .
• SortOrder (string) -- Whether to sort the results in Ascending or Descending order. The default is Descending .
• NameContains (string) -- Filter for model explainability jobs whose name contains a specified string.
• CreationTimeBefore (datetime) -- A filter that returns only model explainability jobs created before a specified time.
• CreationTimeAfter (datetime) -- A filter that returns only model explainability jobs created after a specified time.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

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

}

Response Structure

• (dict) --

  • JobDefinitionSummaries (list) --

    A JSON array in which each element is a summary for a explainability bias jobs.

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