DescribeHubCommand

Describes a hub.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SageMakerClient, DescribeHubCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
// const { SageMakerClient, DescribeHubCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
const client = new SageMakerClient(config);
const input = { // DescribeHubRequest
  HubName: "STRING_VALUE", // required
};
const command = new DescribeHubCommand(input);
const response = await client.send(command);
// { // DescribeHubResponse
//   HubName: "STRING_VALUE", // required
//   HubArn: "STRING_VALUE", // required
//   HubDisplayName: "STRING_VALUE",
//   HubDescription: "STRING_VALUE",
//   HubSearchKeywords: [ // HubSearchKeywordList
//     "STRING_VALUE",
//   ],
//   S3StorageConfig: { // HubS3StorageConfig
//     S3OutputPath: "STRING_VALUE",
//   },
//   HubStatus: "InService" || "Creating" || "Updating" || "Deleting" || "CreateFailed" || "UpdateFailed" || "DeleteFailed", // required
//   FailureReason: "STRING_VALUE",
//   CreationTime: new Date("TIMESTAMP"), // required
//   LastModifiedTime: new Date("TIMESTAMP"), // required
// };

DescribeHubCommand Input

See DescribeHubCommandInput for more details

Parameter
Type
Description
HubName
Required
string | undefined

The name of the hub to describe.

DescribeHubCommand Output

See DescribeHubCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreationTime
Required
Date | undefined

The date and time that the hub was created.

HubArn
Required
string | undefined

The Amazon Resource Name (ARN) of the hub.

HubName
Required
string | undefined

The name of the hub.

HubStatus
Required
HubStatus | undefined

The status of the hub.

LastModifiedTime
Required
Date | undefined

The date and time that the hub was last modified.

FailureReason
string | undefined

The failure reason if importing hub content failed.

HubDescription
string | undefined

A description of the hub.

HubDisplayName
string | undefined

The display name of the hub.

HubSearchKeywords
string[] | undefined

The searchable keywords for the hub.

S3StorageConfig
HubS3StorageConfig | undefined

The Amazon S3 storage configuration for the hub.

Throws

Name
Fault
Details
ResourceNotFound
client

Resource being access is not found.

SageMakerServiceException
Base exception class for all service exceptions from SageMaker service.