marketplace_model_endpoints

Creates, updates, deletes, gets or lists a marketplace_model_endpoints resource.

Overview

Name	marketplace_model_endpoints
Type	Resource
Id	aws.bedrock.marketplace_model_endpoints

Fields

The following fields are returned by SELECT queries:

get_marketplace_model_endpoint

Name	Datatype	Description
created_at	string (date-time)	The timestamp when the endpoint was registered.
endpoint_arn	string	The Amazon Resource Name (ARN) of the endpoint.
endpoint_config	object	Specifies the configuration for the endpoint.
endpoint_status	string	The current status of the endpoint (e.g., Creating, InService, Updating, Failed).
endpoint_status_message	string	Additional information about the endpoint status, if available.
model_source_identifier	string	The ARN of the model from Amazon Bedrock Marketplace that is deployed on this endpoint. (pattern: <code>.arn:aws:sagemaker:.:hub-content/SageMakerPublicHub/Model/.*</code>)
status	string	The overall status of the endpoint in Amazon Bedrock Marketplace (e.g., ACTIVE, INACTIVE). (REGISTERED, INCOMPATIBLE_ENDPOINT)
status_message	string	Additional information about the overall status, if available.
updated_at	string (date-time)	The timestamp when the endpoint was last updated.

list_marketplace_model_endpoints

Name	Datatype	Description
created_at	string (date-time)	The timestamp when the endpoint was created.
endpoint_arn	string	The Amazon Resource Name (ARN) of the endpoint.
model_source_identifier	string	The ARN of the model from Amazon Bedrock Marketplace that is deployed on this endpoint. (pattern: <code>.arn:aws:sagemaker:.:hub-content/SageMakerPublicHub/Model/.*</code>)
status	string	The overall status of the endpoint in Amazon Bedrock Marketplace. (REGISTERED, INCOMPATIBLE_ENDPOINT)
status_message	string	Additional information about the overall status, if available.
updated_at	string (date-time)	The timestamp when the endpoint was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_marketplace_model_endpoint	select	endpoint_arn, region		Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.
list_marketplace_model_endpoints	select	region	maxResults, nextToken, modelSourceIdentifier	Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.
create_marketplace_model_endpoint	insert	region, modelSourceIdentifier, endpointConfig, endpointName		Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.
register_marketplace_model_endpoint	insert	endpoint_identifier, region, modelSourceIdentifier		Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.
update_marketplace_model_endpoint	update	endpoint_arn, region, endpointConfig		Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.
delete_marketplace_model_endpoint	delete	endpoint_arn, region		Deletes an endpoint for a model from Amazon Bedrock Marketplace.
deregister_marketplace_model_endpoint	exec	endpoint_arn, region		Deregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint_arn	string	The Amazon Resource Name (ARN) of the endpoint you want to deregister.
endpoint_identifier	string	The ARN of the Amazon SageMaker endpoint you want to register with Amazon Bedrock Marketplace.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in a single call. If more results are available, the operation returns a NextToken value.
modelSourceIdentifier	string	If specified, only endpoints for the given model source identifier are returned.
nextToken	string	The token for the next set of results. You receive this token from a previous ListMarketplaceModelEndpoints call.

SELECT examples

get_marketplace_model_endpoint

Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.

SELECT
created_at,
endpoint_arn,
endpoint_config,
endpoint_status,
endpoint_status_message,
model_source_identifier,
status,
status_message,
updated_at
FROM aws.bedrock.marketplace_model_endpoints
WHERE endpoint_arn = '{{ endpoint_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_marketplace_model_endpoints

Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.

SELECT
created_at,
endpoint_arn,
model_source_identifier,
status,
status_message,
updated_at
FROM aws.bedrock.marketplace_model_endpoints
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND modelSourceIdentifier = '{{ modelSourceIdentifier }}'
;

INSERT examples

create_marketplace_model_endpoint

Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.

INSERT INTO aws.bedrock.marketplace_model_endpoints (
modelSourceIdentifier,
endpointConfig,
acceptEula,
endpointName,
clientRequestToken,
tags,
region
)
SELECT 
'{{ modelSourceIdentifier }}' /* required */,
'{{ endpointConfig }}' /* required */,
{{ acceptEula }},
'{{ endpointName }}' /* required */,
'{{ clientRequestToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
marketplace_model_endpoint
;

register_marketplace_model_endpoint

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

INSERT INTO aws.bedrock.marketplace_model_endpoints (
modelSourceIdentifier,
endpoint_identifier,
region
)
SELECT 
'{{ modelSourceIdentifier }}' /* required */,
'{{ endpoint_identifier }}',
'{{ region }}'
RETURNING
marketplace_model_endpoint
;

Manifest

# Description fields are for documentation purposes
- name: marketplace_model_endpoints
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the marketplace_model_endpoints resource.
  - name: endpoint_identifier
    value: "{{ endpoint_identifier }}"
    description: Required parameter for the marketplace_model_endpoints resource.
  - name: modelSourceIdentifier
    value: "{{ modelSourceIdentifier }}"
  - name: endpointConfig
    description: |
      Specifies the configuration for the endpoint.
    value:
      sageMaker:
        initialInstanceCount: {{ initialInstanceCount }}
        instanceType: "{{ instanceType }}"
        executionRole: "{{ executionRole }}"
        kmsEncryptionKey: "{{ kmsEncryptionKey }}"
        vpc:
          subnetIds:
            - "{{ subnetIds }}"
          securityGroupIds:
            - "{{ securityGroupIds }}"
  - name: acceptEula
    value: {{ acceptEula }}
  - name: endpointName
    value: "{{ endpointName }}"
  - name: clientRequestToken
    value: "{{ clientRequestToken }}"
  - name: tags
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_marketplace_model_endpoint

Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.

UPDATE aws.bedrock.marketplace_model_endpoints
SET 
endpointConfig = '{{ endpointConfig }}',
clientRequestToken = '{{ clientRequestToken }}'
WHERE 
endpoint_arn = '{{ endpoint_arn }}' --required
AND region = '{{ region }}' --required
AND endpointConfig = '{{ endpointConfig }}' --required
RETURNING
marketplace_model_endpoint;

DELETE examples

delete_marketplace_model_endpoint

Deletes an endpoint for a model from Amazon Bedrock Marketplace.

DELETE FROM aws.bedrock.marketplace_model_endpoints
WHERE endpoint_arn = '{{ endpoint_arn }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

deregister_marketplace_model_endpoint

Deregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint.

EXEC aws.bedrock.marketplace_model_endpoints.deregister_marketplace_model_endpoint 
@endpoint_arn='{{ endpoint_arn }}' --required, 
@region='{{ region }}' --required
;