ImportHubContent
Import hub content.
Note
Hub APIs are only callable through SageMaker Studio.
Request Syntax
{
"DocumentSchemaVersion": "string",
"HubContentDescription": "string",
"HubContentDisplayName": "string",
"HubContentDocument": "string",
"HubContentMarkdown": "string",
"HubContentName": "string",
"HubContentSearchKeywords": [ "string" ],
"HubContentType": "string",
"HubContentVersion": "string",
"HubName": "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.
- DocumentSchemaVersion
-
The version of the hub content schema to import.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 14.
Pattern:
^\d{1,4}.\d{1,4}.\d{1,4}$Required: Yes
- HubContentDescription
-
A description of the hub content to import.
Type: String
Length Constraints: Maximum length of 1023.
Pattern:
.*Required: No
- HubContentDisplayName
-
The display name of the hub content to import.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
.*Required: No
- HubContentDocument
-
The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
Type: String
Length Constraints: Maximum length of 65535.
Pattern:
.*Required: Yes
- HubContentMarkdown
-
A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
Type: String
Length Constraints: Maximum length of 65535.
Pattern:
.*Required: No
- HubContentName
-
The name of the hub content to import.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
- HubContentSearchKeywords
-
The searchable keywords of the hub content.
Type: Array of strings
Array Members: Maximum number of 50 items.
Length Constraints: Maximum length of 255.
Pattern:
^[^A-Z]*$Required: No
- HubContentType
-
The type of hub content to import.
Type: String
Valid Values:
Model | NotebookRequired: Yes
- HubContentVersion
-
The version of the hub content to import.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 14.
Pattern:
^\d{1,4}.\d{1,4}.\d{1,4}$Required: No
- HubName
-
The name of the hub to import content into.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
- Tags
-
Any tags associated with the hub content.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
Response Syntax
{
"HubArn": "string",
"HubContentArn": "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 ARN of the hub that the content was imported into.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
.* - HubContentArn
-
The ARN of the hub content that was imported.
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
- 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:
