DescribeHub - Amazon SageMaker

DescribeHub

Describes a hub.

Request Syntax

{ "HubName": "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.

HubName

The name of the hub to describe.

Type: String

Pattern: ^(arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:(\d{12}|aws):hub\/)?[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: Yes

Response Syntax

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

CreationTime

The date and time that the hub was created.

Type: Timestamp

FailureReason

The failure reason if importing hub content failed.

Type: String

Length Constraints: Maximum length of 1024.

HubArn

The Amazon Resource Name (ARN) of the hub.

Type: String

Length Constraints: Maximum length of 255.

Pattern: .*

HubDescription

A description of the hub.

Type: String

Length Constraints: Maximum length of 1023.

Pattern: .*

HubDisplayName

The display name of the hub.

Type: String

Length Constraints: Maximum length of 255.

Pattern: .*

HubName

The name of the hub.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

HubSearchKeywords

The searchable keywords for the hub.

Type: Array of strings

Array Members: Maximum number of 50 items.

Length Constraints: Maximum length of 255.

Pattern: ^[^A-Z]*$

HubStatus

The status of the hub.

Type: String

Valid Values: InService | Creating | Updating | Deleting | CreateFailed | UpdateFailed | DeleteFailed

LastModifiedTime

The date and time that the hub was last modified.

Type: Timestamp

S3StorageConfig

The Amazon S3 storage configuration for the hub.

Type: HubS3StorageConfig object

Errors

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

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: