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

register-marketplace-model-endpoint

Description

Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.

See also: AWS API Documentation

Synopsis

  register-marketplace-model-endpoint
--endpoint-identifier <value>
--model-source-identifier <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

--endpoint-identifier (string)

The ARN of the Amazon SageMaker endpoint you want to register with Amazon Bedrock Marketplace.

--model-source-identifier (string)

The ARN of the model from Amazon Bedrock Marketplace that is deployed on the endpoint.

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

marketplaceModelEndpoint -> (structure)

Details about the registered endpoint.

endpointArn -> (string)

The Amazon Resource Name (ARN) of the endpoint.

modelSourceIdentifier -> (string)

The ARN of the model from Amazon Bedrock Marketplace that is deployed on this endpoint.

status -> (string)

The overall status of the endpoint in Amazon Bedrock Marketplace (e.g., ACTIVE, INACTIVE).

statusMessage -> (string)

Additional information about the overall status, if available.

createdAt -> (timestamp)

The timestamp when the endpoint was registered.

updatedAt -> (timestamp)

The timestamp when the endpoint was last updated.

endpointConfig -> (tagged union structure)

The configuration of the endpoint, including the number and type of instances used.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: sageMaker.

sageMaker -> (structure)

The configuration specific to Amazon SageMaker for the endpoint.

initialInstanceCount -> (integer)

The number of Amazon EC2 compute instances to deploy for initial endpoint creation.

instanceType -> (string)

The Amazon EC2 compute instance type to deploy for hosting the model.

executionRole -> (string)

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on Amazon EC2 compute instances or for batch transform jobs.

kmsEncryptionKey -> (string)

The Amazon Web Services KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the Amazon EC2 compute instance that hosts the endpoint.

vpc -> (structure)

The VPC configuration for the endpoint.

subnetIds -> (list)

An array of IDs for each subnet in the VPC to use.

(string)

securityGroupIds -> (list)

An array of IDs for each security group in the VPC to use.

(string)

endpointStatus -> (string)

The current status of the endpoint (e.g., Creating, InService, Updating, Failed).

endpointStatusMessage -> (string)

Additional information about the endpoint status, if available.