ListContexts

class SageMaker.Paginator.ListContexts
paginator = client.get_paginator('list_contexts')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SourceUri='string',
    ContextType='string',
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    SortBy='Name'|'CreationTime',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • SourceUri (string) -- A filter that returns only contexts with the specified source URI.
  • ContextType (string) -- A filter that returns only contexts of the specified type.
  • CreatedAfter (datetime) -- A filter that returns only contexts created on or after the specified time.
  • CreatedBefore (datetime) -- A filter that returns only contexts created on or before the specified time.
  • SortBy (string) -- The property used to sort results. The default value is CreationTime .
  • SortOrder (string) -- The sort order. The default value is Descending .
  • 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

{
    'ContextSummaries': [
        {
            'ContextArn': 'string',
            'ContextName': 'string',
            'Source': {
                'SourceUri': 'string',
                'SourceType': 'string',
                'SourceId': 'string'
            },
            'ContextType': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) --

    • ContextSummaries (list) --

      A list of contexts and their properties.

      • (dict) --

        Lists a summary of the properties of a context. A context provides a logical grouping of other entities.

        • ContextArn (string) --

          The Amazon Resource Name (ARN) of the context.

        • ContextName (string) --

          The name of the context.

        • Source (dict) --

          The source of the context.

          • SourceUri (string) --

            The URI of the source.

          • SourceType (string) --

            The type of the source.

          • SourceId (string) --

            The ID of the source.

        • ContextType (string) --

          The type of the context.

        • CreationTime (datetime) --

          When the context was created.

        • LastModifiedTime (datetime) --

          When the context was last modified.