Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

describe_hub

describe_hub(**kwargs)

Describe a hub.

Note

Hub APIs are only callable through SageMaker Studio.

See also: AWS API Documentation

Request Syntax

response = client.describe_hub(
    HubName='string'
)
Parameters
HubName (string) --

[REQUIRED]

The name of the hub to describe.

Return type
dict
Returns
Response Syntax
{
    'HubName': 'string',
    'HubArn': 'string',
    'HubDisplayName': 'string',
    'HubDescription': 'string',
    'HubSearchKeywords': [
        'string',
    ],
    'S3StorageConfig': {
        'S3OutputPath': 'string'
    },
    'HubStatus': 'InService'|'Creating'|'Updating'|'Deleting'|'CreateFailed'|'UpdateFailed'|'DeleteFailed',
    'FailureReason': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • HubName (string) --

      The name of the hub.

    • HubArn (string) --

      The Amazon Resource Name (ARN) of the hub.

    • HubDisplayName (string) --

      The display name of the hub.

    • HubDescription (string) --

      A description of the hub.

    • HubSearchKeywords (list) --

      The searchable keywords for the hub.

      • (string) --
    • S3StorageConfig (dict) --

      The Amazon S3 storage configuration for the hub.

      • S3OutputPath (string) --

        The Amazon S3 bucket prefix for hosting hub content.

    • HubStatus (string) --

      The status of the hub.

    • FailureReason (string) --

      The failure reason if importing hub content failed.

    • CreationTime (datetime) --

      The date and time that the hub was created.

    • LastModifiedTime (datetime) --

      The date and time that the hub was last modified.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound