Bedrock / Client / create_marketplace_model_endpoint

create_marketplace_model_endpoint#

Bedrock.Client.create_marketplace_model_endpoint(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.create_marketplace_model_endpoint(
    modelSourceIdentifier='string',
    endpointConfig={
        'sageMaker': {
            'initialInstanceCount': 123,
            'instanceType': 'string',
            'executionRole': 'string',
            'kmsEncryptionKey': 'string',
            'vpc': {
                'subnetIds': [
                    'string',
                ],
                'securityGroupIds': [
                    'string',
                ]
            }
        }
    },
    acceptEula=True|False,
    endpointName='string',
    clientRequestToken='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters:

  • modelSourceIdentifier (string) –

    [REQUIRED]

    The ARN of the model from Amazon Bedrock Marketplace that you want to deploy to the endpoint.

  • endpointConfig (dict) –

    [REQUIRED]

    The configuration for the endpoint, including the number and type of instances to use.

    Note

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

    • sageMaker (dict) –

      The configuration specific to Amazon SageMaker for the endpoint.

      • initialInstanceCount (integer) – [REQUIRED]

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

      • instanceType (string) – [REQUIRED]

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

      • executionRole (string) – [REQUIRED]

        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) – [REQUIRED]

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

          • (string) –

        • securityGroupIds (list) – [REQUIRED]

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

          • (string) –

  • acceptEula (boolean) – Indicates whether you accept the end-user license agreement (EULA) for the model. Set to true to accept the EULA.

  • endpointName (string) –

    [REQUIRED]

    The name of the endpoint. This name must be unique within your Amazon Web Services account and region.

  • clientRequestToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because Amazon Web Services SDKs automatically generate it for you and set this parameter. If you’re not using the Amazon Web Services SDK or the CLI, you must provide this token or the action will fail.

    This field is autopopulated if not provided.

  • tags (list) –

    An array of key-value pairs to apply to the underlying Amazon SageMaker endpoint. You can use these tags to organize and identify your Amazon Web Services resources.

    • (dict) –

      Definition of the key/value pair for a tag.

      • key (string) – [REQUIRED]

        Key for the tag.

      • value (string) – [REQUIRED]

        Value for the tag.

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