DescribeHubContent
Describe the content of a hub.
Request Syntax
{ "HubContentName": "string", "HubContentType": "string", "HubContentVersion": "string", "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.
- HubContentName
-
The name of the content to describe.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
- HubContentType
-
The type of content in the hub.
Type: String
Valid Values:
Model | Notebook | ModelReferenceRequired: Yes
- HubContentVersion
-
The version of the content to describe.
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 that contains the content 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, "DocumentSchemaVersion": "string", "FailureReason": "string", "HubArn": "string", "HubContentArn": "string", "HubContentDependencies": [ { "DependencyCopyPath": "string", "DependencyOriginPath": "string" } ], "HubContentDescription": "string", "HubContentDisplayName": "string", "HubContentDocument": "string", "HubContentMarkdown": "string", "HubContentName": "string", "HubContentSearchKeywords": [ "string" ], "HubContentStatus": "string", "HubContentType": "string", "HubContentVersion": "string", "HubName": "string", "LastModifiedTime": number, "ReferenceMinVersion": "string", "SageMakerPublicHubContentArn": "string", "SupportStatus": "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 hub content was created.
Type: Timestamp
- DocumentSchemaVersion
-
The document schema version for the hub content.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 14.
Pattern:
\d{1,4}.\d{1,4}.\d{1,4} - FailureReason
-
The failure reason if importing hub content failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- HubArn
-
The Amazon Resource Name (ARN) of the hub that contains the content.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
.* - HubContentArn
-
The Amazon Resource Name (ARN) of the hub content.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
.* - HubContentDependencies
-
The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.
Type: Array of HubContentDependency objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
- HubContentDescription
-
A description of the hub content.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1023.
Pattern:
.* - HubContentDisplayName
-
The display name of the hub content.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
.* - HubContentDocument
-
The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 65535.
Pattern:
.* - 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: Minimum length of 0. Maximum length of 65535.
- HubContentName
-
The name of the hub content.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - HubContentSearchKeywords
-
The searchable keywords for the hub content.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
[^A-Z]* - HubContentStatus
-
The status of the hub content.
Type: String
Valid Values:
Available | Importing | Deleting | ImportFailed | DeleteFailed - HubContentType
-
The type of hub content.
Type: String
Valid Values:
Model | Notebook | ModelReference - HubContentVersion
-
The version of the hub content.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 14.
Pattern:
\d{1,4}.\d{1,4}.\d{1,4} - HubName
-
The name of the hub that contains the content.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern:
[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - LastModifiedTime
-
The last modified time of the hub content.
Type: Timestamp
- ReferenceMinVersion
-
The minimum version of the hub content.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 14.
Pattern:
\d{1,4}.\d{1,4}.\d{1,4} - SageMakerPublicHubContentArn
-
The ARN of the public hub content.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
arn:[a-z0-9-\.]{1,63}:sagemaker:\w+(?:-\w+)+:aws:hub-content\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}\/Model\/[a-zA-Z0-9](-*[a-zA-Z0-9]){0,63} - SupportStatus
-
The support status of the hub content.
Type: String
Valid Values:
Supported | Deprecated | Restricted
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: