Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListResourceCatalogs

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

Request Syntax


{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "MaxResults": number,
   "NameContains": "string",
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CreationTimeAfter

Use this parameter to search for ResourceCatalogs created after a specific date and time.

Type: Timestamp

Required: No

CreationTimeBefore

Use this parameter to search for ResourceCatalogs created before a specific date and time.

Type: Timestamp

Required: No

MaxResults

The maximum number of results returned by ListResourceCatalogs.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NameContains

A string that partially matches one or more ResourceCatalogs names. Filters ResourceCatalog by name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

NextToken

A token to resume pagination of ListResourceCatalogs results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The value on which the resource catalog list is sorted.

Type: String

Valid Values: CreationTime

Required: No

SortOrder

The order in which the resource catalogs are listed.

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax


{
   "NextToken": "string",
   "ResourceCatalogs": [ 
      { 
         "CreationTime": number,
         "Description": "string",
         "ResourceCatalogArn": "string",
         "ResourceCatalogName": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

A token to resume pagination of ListResourceCatalogs results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

ResourceCatalogs

A list of the requested ResourceCatalogs.

Type: Array of ResourceCatalog objects

Errors

For information about the errors that are common to all actions, see Common Errors.