Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateHub

Create a hub.

Note

Hub APIs are only callable through SageMaker Studio.

Request Syntax


{
   "HubDescription": "string",
   "HubDisplayName": "string",
   "HubName": "string",
   "HubSearchKeywords": [ "string" ],
   "S3StorageConfig": { 
      "S3OutputPath": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

HubDescription

A description of the hub.

Type: String

Length Constraints: Maximum length of 1023.

Pattern: .*

Required: Yes

HubDisplayName

The display name of the hub.

Type: String

Length Constraints: Maximum length of 255.

Pattern: .*

Required: No

HubName

The name of the hub to create.

Type: String

Length Constraints: Maximum length of 63.

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

Required: Yes

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]*$

Required: No

S3StorageConfig

The Amazon S3 storage configuration for the hub.

Type: HubS3StorageConfig object

Required: No

Tags

Any tags to associate with the hub.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax


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

HubArn

The Amazon Resource Name (ARN) of the hub.

Type: String

Length Constraints: Maximum length of 255.

Pattern: .*

Errors

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

ResourceInUse

Resource being accessed is in use.

HTTP Status Code: 400

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400