[ aws . sagemaker ]

describe-hub-content

Description

Describe the content of a hub.

Note

Hub APIs are only callable through SageMaker Studio.

See also: AWS API Documentation

Synopsis

  describe-hub-content
--hub-name <value>
--hub-content-type <value>
--hub-content-name <value>
[--hub-content-version <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--hub-name (string)

The name of the hub that contains the content to describe.

--hub-content-type (string)

The type of content in the hub.

Possible values:

• Model
• Notebook

--hub-content-name (string)

The name of the content to describe.

--hub-content-version (string)

The version of the content to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

HubContentName -> (string)

The name of the hub content.

HubContentArn -> (string)

The Amazon Resource Name (ARN) of the hub content.

HubContentVersion -> (string)

The version of the hub content.

HubContentType -> (string)

The type of hub content.

DocumentSchemaVersion -> (string)

The document schema version for the hub content.

HubName -> (string)

The name of the hub that contains the content.

HubArn -> (string)

The Amazon Resource Name (ARN) of the hub that contains the content.

HubContentDisplayName -> (string)

The display name of the hub content.

HubContentDescription -> (string)

A description of the hub content.

HubContentMarkdown -> (string)

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

HubContentDocument -> (string)

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

HubContentSearchKeywords -> (list)

The searchable keywords for the hub content.

(string)

HubContentDependencies -> (list)

The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

(structure)

Any dependencies related to hub content, such as scripts, model artifacts, datasets, or notebooks.

DependencyOriginPath -> (string)

The hub content dependency origin path.

DependencyCopyPath -> (string)

The hub content dependency copy path.

HubContentStatus -> (string)

The status of the hub content.

FailureReason -> (string)

The failure reason if importing hub content failed.

CreationTime -> (timestamp)

The date and time that hub content was created.