AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

list-hub-contents

Description

List the contents of a hub.

See also: AWS API Documentation

Synopsis

  list-hub-contents
--hub-name <value>
--hub-content-type <value>
[--name-contains <value>]
[--max-schema-version <value>]
[--creation-time-before <value>]
[--creation-time-after <value>]
[--sort-by <value>]
[--sort-order <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--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>]

Options

--hub-name (string)

The name of the hub to list the contents of.

--hub-content-type (string)

The type of hub content to list.

Possible values:

  • Model
  • Notebook
  • ModelReference

--name-contains (string)

Only list hub content if the name contains the specified string.

--max-schema-version (string)

The upper bound of the hub content schema verion.

--creation-time-before (timestamp)

Only list hub content that was created before the time specified.

--creation-time-after (timestamp)

Only list hub content that was created after the time specified.

--sort-by (string)

Sort hub content versions by either name or creation time.

Possible values:

  • HubContentName
  • CreationTime
  • HubContentStatus

--sort-order (string)

Sort hubs by ascending or descending order.

Possible values:

  • Ascending
  • Descending

--max-results (integer)

The maximum amount of hub content to list.

--next-token (string)

If the response to a previous ListHubContents request was truncated, the response includes a NextToken . To retrieve the next set of hub content, use the token in the next request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--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.

Output

HubContentSummaries -> (list)

The summaries of the listed hub content.

(structure)

Information about hub content.

HubContentName -> (string)

The name of the hub content.

HubContentArn -> (string)

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

SageMakerPublicHubContentArn -> (string)

The ARN of the public hub content.

HubContentVersion -> (string)

The version of the hub content.

HubContentType -> (string)

The type of hub content.

DocumentSchemaVersion -> (string)

The version of the hub content document schema.

HubContentDisplayName -> (string)

The display name of the hub content.

HubContentDescription -> (string)

A description of the hub content.

SupportStatus -> (string)

The support status of the hub content.

HubContentSearchKeywords -> (list)

The searchable keywords for the hub content.

(string)

HubContentStatus -> (string)

The status of the hub content.

CreationTime -> (timestamp)

The date and time that the hub content was created.

OriginalCreationTime -> (timestamp)

The date and time when the hub content was originally created, before any updates or revisions.

NextToken -> (string)

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.