endpoints

Creates, updates, deletes or gets an endpoint resource or lists endpoints in a region

Overview

Name	endpoints
Type	Resource
Description	Resource Type definition for AWS::SageMaker::Endpoint
Id	aws.sagemaker.endpoints

Fields

Name	Datatype	Description
deployment_config	object	Specifies deployment configuration for updating the SageMaker endpoint. Includes rollback and update policies.
endpoint_arn	string	The Amazon Resource Name (ARN) of the endpoint.
endpoint_config_name	string	The name of the endpoint configuration for the SageMaker endpoint. This is a required property.
endpoint_name	string	The name of the SageMaker endpoint. This name must be unique within an AWS Region.
exclude_retained_variant_properties	array	Specifies a list of variant properties that you want to exclude when updating an endpoint.
retain_all_variant_properties	boolean	When set to true, retains all variant properties for an endpoint when it is updated.
retain_deployment_config	boolean	When set to true, retains the deployment configuration during endpoint updates.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

For more information, see AWS::SageMaker::Endpoint.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	EndpointConfigName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all endpoints in a region.

SELECT
region,
deployment_config,
endpoint_arn,
endpoint_config_name,
endpoint_name,
exclude_retained_variant_properties,
retain_all_variant_properties,
retain_deployment_config,
tags
FROM aws.sagemaker.endpoints
WHERE region = 'us-east-1';

Gets all properties from an individual endpoint.

SELECT
region,
deployment_config,
endpoint_arn,
endpoint_config_name,
endpoint_name,
exclude_retained_variant_properties,
retain_all_variant_properties,
retain_deployment_config,
tags
FROM aws.sagemaker.endpoints
WHERE region = 'us-east-1' AND data__Identifier = '<EndpointArn>';

INSERT example

Use the following StackQL query and manifest file to create a new endpoint resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.sagemaker.endpoints (
 EndpointConfigName,
 region
)
SELECT 
'{{ EndpointConfigName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.sagemaker.endpoints (
 DeploymentConfig,
 EndpointConfigName,
 ExcludeRetainedVariantProperties,
 RetainAllVariantProperties,
 RetainDeploymentConfig,
 Tags,
 region
)
SELECT 
 '{{ DeploymentConfig }}',
 '{{ EndpointConfigName }}',
 '{{ ExcludeRetainedVariantProperties }}',
 '{{ RetainAllVariantProperties }}',
 '{{ RetainDeploymentConfig }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: endpoint
    props:
      - name: DeploymentConfig
        value:
          AutoRollbackConfiguration:
            Alarms:
              - AlarmName: '{{ AlarmName }}'
          BlueGreenUpdatePolicy:
            MaximumExecutionTimeoutInSeconds: '{{ MaximumExecutionTimeoutInSeconds }}'
            TerminationWaitInSeconds: '{{ TerminationWaitInSeconds }}'
            TrafficRoutingConfiguration:
              CanarySize:
                Type: '{{ Type }}'
                Value: '{{ Value }}'
              LinearStepSize: null
              Type: '{{ Type }}'
              WaitIntervalInSeconds: '{{ WaitIntervalInSeconds }}'
          RollingUpdatePolicy:
            MaximumBatchSize: null
            MaximumExecutionTimeoutInSeconds: '{{ MaximumExecutionTimeoutInSeconds }}'
            RollbackMaximumBatchSize: null
            WaitIntervalInSeconds: '{{ WaitIntervalInSeconds }}'
      - name: EndpointConfigName
        value: '{{ EndpointConfigName }}'
      - name: ExcludeRetainedVariantProperties
        value:
          - VariantPropertyType: '{{ VariantPropertyType }}'
      - name: RetainAllVariantProperties
        value: '{{ RetainAllVariantProperties }}'
      - name: RetainDeploymentConfig
        value: '{{ RetainDeploymentConfig }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM aws.sagemaker.endpoints
WHERE data__Identifier = '<EndpointArn>'
AND region = 'us-east-1';

Permissions

To operate on the endpoints resource, the following permissions are required:

Create

sagemaker:CreateEndpoint,
sagemaker:DescribeEndpoint,
sagemaker:AddTags

Read

sagemaker:DescribeEndpoint,
sagemaker:ListTags

Update

sagemaker:UpdateEndpoint,
sagemaker:DescribeEndpoint,
sagemaker:AddTags,
sagemaker:DeleteTags

Delete

sagemaker:DeleteEndpoint,
sagemaker:DescribeEndpoint

List

sagemaker:ListEndpoints