SageMaker / Client / list_hubs
list_hubs#
- SageMaker.Client.list_hubs(**kwargs)#
List all existing hubs.
Note
Hub APIs are only callable through SageMaker Studio.
See also: AWS API Documentation
Request Syntax
response = client.list_hubs( NameContains='string', CreationTimeBefore=datetime(2015, 1, 1), CreationTimeAfter=datetime(2015, 1, 1), LastModifiedTimeBefore=datetime(2015, 1, 1), LastModifiedTimeAfter=datetime(2015, 1, 1), SortBy='HubName'|'CreationTime'|'HubStatus'|'AccountIdOwner', SortOrder='Ascending'|'Descending', MaxResults=123, NextToken='string' )
- Parameters:
NameContains (string) – Only list hubs with names that contain the specified string.
CreationTimeBefore (datetime) – Only list hubs that were created before the time specified.
CreationTimeAfter (datetime) – Only list hubs that were created after the time specified.
LastModifiedTimeBefore (datetime) – Only list hubs that were last modified before the time specified.
LastModifiedTimeAfter (datetime) – Only list hubs that were last modified after the time specified.
SortBy (string) – Sort hubs by either name or creation time.
SortOrder (string) – Sort hubs by ascending or descending order.
MaxResults (integer) – The maximum number of hubs to list.
NextToken (string) – If the response to a previous
ListHubs
request was truncated, the response includes aNextToken
. To retrieve the next set of hubs, use the token in the next request.
- Return type:
dict
- Returns:
Response Syntax
{ 'HubSummaries': [ { 'HubName': 'string', 'HubArn': 'string', 'HubDisplayName': 'string', 'HubDescription': 'string', 'HubSearchKeywords': [ 'string', ], 'HubStatus': 'InService'|'Creating'|'Updating'|'Deleting'|'CreateFailed'|'UpdateFailed'|'DeleteFailed', 'CreationTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
HubSummaries (list) –
The summaries of the listed hubs.
(dict) –
Information about a hub.
HubName (string) –
The name of the hub.
HubArn (string) –
The Amazon Resource Name (ARN) of the hub.
HubDisplayName (string) –
The display name of the hub.
HubDescription (string) –
A description of the hub.
HubSearchKeywords (list) –
The searchable keywords for the hub.
(string) –
HubStatus (string) –
The status of the hub.
CreationTime (datetime) –
The date and time that the hub was created.
LastModifiedTime (datetime) –
The date and time that the hub was last modified.
NextToken (string) –
If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.