Bedrock / Client / register_marketplace_model_endpoint

register_marketplace_model_endpoint#

Bedrock.Client.register_marketplace_model_endpoint(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.register_marketplace_model_endpoint(
    endpointIdentifier='string',
    modelSourceIdentifier='string'
)
Parameters:

  • endpointIdentifier (string) –

    [REQUIRED]

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

  • modelSourceIdentifier (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'marketplaceModelEndpoint': {
        'endpointArn': 'string',
        'modelSourceIdentifier': 'string',
        'status': 'REGISTERED'|'INCOMPATIBLE_ENDPOINT',
        'statusMessage': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'endpointConfig': {
            'sageMaker': {
                'initialInstanceCount': 123,
                'instanceType': 'string',
                'executionRole': 'string',
                'kmsEncryptionKey': 'string',
                'vpc': {
                    'subnetIds': [
                        'string',
                    ],
                    'securityGroupIds': [
                        'string',
                    ]
                }
            }
        },
        'endpointStatus': 'string',
        'endpointStatusMessage': 'string'
    }
}

Response Structure

  • (dict) –

    • marketplaceModelEndpoint (dict) –

      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 (datetime) –

        The timestamp when the endpoint was registered.

      • updatedAt (datetime) –

        The timestamp when the endpoint was last updated.

      • endpointConfig (dict) –

        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 will be set: sageMaker. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • sageMaker (dict) –

          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 (dict) –

            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.

Exceptions