SageMaker / Paginator / ListResourceCatalogs

ListResourceCatalogs

class SageMaker.Paginator.ListResourceCatalogs

paginator = client.get_paginator('list_resource_catalogs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• NameContains (string) – A string that partially matches one or more ResourceCatalog``s names. Filters ``ResourceCatalog by name.

• CreationTimeAfter (datetime) – Use this parameter to search for ``ResourceCatalog``s created after a specific date and time.

• CreationTimeBefore (datetime) – Use this parameter to search for ``ResourceCatalog``s created before a specific date and time.

• SortOrder (string) – The order in which the resource catalogs are listed.

• SortBy (string) – The value on which the resource catalog list is sorted.

• 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

{
    'ResourceCatalogs': [
        {
            'ResourceCatalogArn': 'string',
            'ResourceCatalogName': 'string',
            'Description': 'string',
            'CreationTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • ResourceCatalogs (list) –

    A list of the requested ``ResourceCatalog``s.

    • (dict) –

      A resource catalog containing all of the resources of a specific resource type within a resource owner account. For an example on sharing the Amazon SageMaker Feature Store DefaultFeatureGroupCatalog, see Share Amazon SageMaker Catalog resource type in the Amazon SageMaker Developer Guide.

      • ResourceCatalogArn (string) –

        The Amazon Resource Name (ARN) of the ResourceCatalog.

      • ResourceCatalogName (string) –

        The name of the ResourceCatalog.

      • Description (string) –

        A free form description of the ResourceCatalog.

      • CreationTime (datetime) –

        The time the ResourceCatalog was created.