SageMaker / Paginator / ListDataQualityJobDefinitions

ListDataQualityJobDefinitions

class SageMaker.Paginator.ListDataQualityJobDefinitions

paginator = client.get_paginator('list_data_quality_job_definitions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_data_quality_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) – A filter that lists the data quality job definitions 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.

• NameContains (string) – A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.

• CreationTimeBefore (datetime) – A filter that returns only data quality monitoring job definitions created before the specified time.

• CreationTimeAfter (datetime) – A filter that returns only data quality monitoring job definitions created after the 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 list of data 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.