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	awscc.sagemaker.endpoints

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
endpoint_arn	string	The Amazon Resource Name (ARN) of the endpoint.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	endpoints	INSERT	EndpointConfigName, region
delete_resource	endpoints	DELETE	Identifier, region
update_resource	endpoints	UPDATE	Identifier, PatchDocument, region
list_resources	endpoints_list_only	SELECT	region
get_resource	endpoints	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.sagemaker.endpoints
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ endpoint_arn }}';

list (identifiers only)

Lists all endpoints in a region.

SELECT
  region,
  endpoint_arn
FROM awscc.sagemaker.endpoints_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.sagemaker.endpoints (
  DeploymentConfig,
  EndpointConfigName,
  ExcludeRetainedVariantProperties,
  RetainAllVariantProperties,
  RetainDeploymentConfig,
  Tags,
  region
)
SELECT
  '{{ deployment_config }}',
  '{{ endpoint_config_name }}',
  '{{ exclude_retained_variant_properties }}',
  '{{ retain_all_variant_properties }}',
  '{{ retain_deployment_config }}',
  '{{ 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: deployment_config
        value:
          auto_rollback_configuration:
            alarms:
              - alarm_name: '{{ alarm_name }}'
          blue_green_update_policy:
            maximum_execution_timeout_in_seconds: '{{ maximum_execution_timeout_in_seconds }}'
            termination_wait_in_seconds: '{{ termination_wait_in_seconds }}'
            traffic_routing_configuration:
              canary_size:
                type: '{{ type }}'
                value: '{{ value }}'
              linear_step_size: null
              type: '{{ type }}'
              wait_interval_in_seconds: '{{ wait_interval_in_seconds }}'
          rolling_update_policy:
            maximum_batch_size: null
            maximum_execution_timeout_in_seconds: '{{ maximum_execution_timeout_in_seconds }}'
            rollback_maximum_batch_size: null
            wait_interval_in_seconds: '{{ wait_interval_in_seconds }}'
      - name: endpoint_config_name
        value: '{{ endpoint_config_name }}'
      - name: exclude_retained_variant_properties
        value:
          - variant_property_type: '{{ variant_property_type }}'
      - name: retain_all_variant_properties
        value: '{{ retain_all_variant_properties }}'
      - name: retain_deployment_config
        value: '{{ retain_deployment_config }}'
      - name: tags
        value:
          - value: '{{ value }}'
            key: '{{ key }}'

UPDATE example

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

/*+ update */
UPDATE awscc.sagemaker.endpoints
SET PatchDocument = string('{{ {
    "DeploymentConfig": deployment_config,
    "EndpointConfigName": endpoint_config_name,
    "ExcludeRetainedVariantProperties": exclude_retained_variant_properties,
    "RetainAllVariantProperties": retain_all_variant_properties,
    "RetainDeploymentConfig": retain_deployment_config,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ endpoint_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.sagemaker.endpoints
WHERE
  Identifier = '{{ endpoint_arn }}' 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