Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListHubs

List all existing hubs.

Note

Hub APIs are only callable through SageMaker Studio.

Request Syntax


{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "LastModifiedTimeAfter": number,
   "LastModifiedTimeBefore": 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

Only list hubs that were created after the time specified.

Type: Timestamp

Required: No

CreationTimeBefore

Only list hubs that were created before the time specified.

Type: Timestamp

Required: No

LastModifiedTimeAfter

Only list hubs that were last modified after the time specified.

Type: Timestamp

Required: No

LastModifiedTimeBefore

Only list hubs that were last modified before the time specified.

Type: Timestamp

Required: No

MaxResults

The maximum number of hubs to list.

Type: Integer

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

Required: No

NameContains

Only list hubs with names that contain the specified string.

Type: String

Length Constraints: Maximum length of 63.

Pattern: [a-zA-Z0-9\-]+

Required: No

NextToken

If the response to a previous ListHubs request was truncated, the response includes a NextToken. To retrieve the next set of hubs, use the token in the next request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

Sort hubs by either name or creation time.

Type: String

Valid Values: HubName | CreationTime | HubStatus | AccountIdOwner

Required: No

SortOrder

Sort hubs by ascending or descending order.

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax


{
   "HubSummaries": [ 
      { 
         "CreationTime": number,
         "HubArn": "string",
         "HubDescription": "string",
         "HubDisplayName": "string",
         "HubName": "string",
         "HubSearchKeywords": [ "string" ],
         "HubStatus": "string",
         "LastModifiedTime": number
      }
   ],
   "NextToken": "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.

HubSummaries

The summaries of the listed hubs.

Type: Array of HubInfo objects

NextToken

If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

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