SageMaker / Client / create_hub

create_hub#

SageMaker.Client.create_hub(**kwargs)#

Create a hub.

Note

Hub APIs are only callable through SageMaker Studio.

See also: AWS API Documentation

Request Syntax

response = client.create_hub(
    HubName='string',
    HubDescription='string',
    HubDisplayName='string',
    HubSearchKeywords=[
        'string',
    ],
    S3StorageConfig={
        'S3OutputPath': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • HubName (string) –

    [REQUIRED]

    The name of the hub to create.

  • HubDescription (string) –

    [REQUIRED]

    A description of the hub.

  • HubDisplayName (string) – The display name 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.

  • Tags (list) –

    Any tags to associate with the hub.

    • (dict) –

      A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

      You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.

      For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.

      • Key (string) – [REQUIRED]

        The tag key. Tag keys must be unique per resource.

      • Value (string) – [REQUIRED]

        The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'HubArn': 'string'
}

Response Structure

  • (dict) –

    • HubArn (string) –

      The Amazon Resource Name (ARN) of the hub.

Exceptions

  • SageMaker.Client.exceptions.ResourceInUse

  • SageMaker.Client.exceptions.ResourceLimitExceeded