SageMaker / Client / list_resource_catalogs

list_resource_catalogs#

SageMaker.Client.list_resource_catalogs(**kwargs)#

Lists Amazon SageMaker Catalogs based on given filters and orders. The maximum number of ``ResourceCatalog``s viewable is 1000.

See also: AWS API Documentation

Request Syntax

response = client.list_resource_catalogs(
    NameContains='string',
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    SortOrder='Ascending'|'Descending',
    SortBy='CreationTime',
    MaxResults=123,
    NextToken='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.

  • MaxResults (integer) – The maximum number of results returned by ListResourceCatalogs.

  • NextToken (string) – A token to resume pagination of ListResourceCatalogs results.

Return type:

dict

Returns:

Response Syntax

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

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.

    • NextToken (string) –

      A token to resume pagination of ListResourceCatalogs results.