npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2021 – Pkg Stats / Ryan Hefner

@aws-solutions-constructs/aws-apigateway-sagemakerendpoint

v2.0.0-rc.1

Published

CDK Constructs for AWS API Gateway and Amazon SageMaker Endpoint integration.

Downloads

593

Readme

aws-apigateway-sagemakerendpoint module


Stability: Experimental

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.


| Reference Documentation:| https://docs.aws.amazon.com/solutions/latest/constructs/| |:-------------|:-------------|

| Language | Package | |:-------------|-----------------| |Python Logo Python|aws_solutions_constructs.aws_apigateway_sagemakerendpoint| |Typescript Logo Typescript|@aws-solutions-constructs/aws-apigateway-sagemakerendpoint| |Java Logo Java|software.amazon.awsconstructs.services.apigatewaysagemakerendpoint|

Overview

This AWS Solutions Construct implements an Amazon API Gateway connected to an Amazon SageMaker endpoint pattern.

Here is a minimal deployable pattern definition in Typescript:

import { ApiGatewayToSageMakerEndpoint, ApiGatewayToSageMakerEndpointProps } from '@aws-solutions-constructs/aws-apigateway-sagemakerendpoint';

// Below is an example VTL (Velocity Template Language) mapping template for mapping the Api GET request to the Sagemaker POST request
const requestTemplate =
`{
    "instances": [
#set( $user_id = $input.params("user_id") )
#set( $items = $input.params("items") )
#foreach( $item in $items.split(",") )
    {"in0": [$user_id], "in1": [$item]}#if( $foreach.hasNext ),#end
    $esc.newline
#end
    ]
}`;

// Replace 'my-endpoint' with your Sagemaker Inference Endpoint
new ApiGatewayToSageMakerEndpoint(this, 'test-apigw-sagemakerendpoint', {
    endpointName: 'my-endpoint',
    resourcePath: '{user_id}',
    requestMappingTemplate: requestTemplate
});

Initializer

new ApiGatewayToSageMakerEndpoint(scope: Construct, id: string, props: ApiGatewayToSageMakerEndpointProps);

Parameters

Pattern Construct Props

| Name | Type | Description | |:-------------|:----------------|-----------------| |apiGatewayProps?|api.RestApiProps|Optional user-provided props to override the default props for the API Gateway.| |apiGatewayExecutionRole?|iam.Role|IAM Role used by API Gateway to invoke the SageMaker endpoint. If not specified, a default role is created with access to endpointName.| |endpointName|string|Name of the deployed SageMaker inference endpoint.| |resourceName?|string|Optional resource name where the GET method will be available.| |resourcePath|string|Resource path for the GET method. The variable defined here can be referenced in requestMappingTemplate.| |requestMappingTemplate|string|Mapping template to convert GET requests received on the REST API to POST requests expected by the SageMaker endpoint.| |responseMappingTemplate?|string|Optional mapping template to convert responses received from the SageMaker endpoint.| |logGroupProps?|logs.LogGroupProps|User provided props to override the default props for for the CloudWatchLogs LogGroup.|

Pattern Properties

| Name | Type | Description | |:-------------|:----------------|-----------------| |apiGateway|api.RestApi|Returns an instance of the API Gateway REST API created by the pattern.| |apiGatewayRole|iam.Role|Returns an instance of the iam.Role created by the construct for API Gateway.| |apiGatewayCloudWatchRole|iam.Role|Returns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.| |apiGatewayLogGroup|logs.LogGroup|Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.|

Sample API Usage

Note: Each SageMaker endpoint is unique, and the response from the API will depend on the deployed model. The example given below assumes the sample from this blog post. For a reference on how that'd be implemented, please refer to integ.apigateway-sagemakerendpoint-overwrite.ts.

| Method | Request Path | Query String | SageMaker Action | Description | |:-------------|:----------------|-----------------|-----------------|-----------------| |GET|/321| items=101,131,162 |sagemaker:InvokeEndpoint|Retrieves the predictions for a specific user and items.|

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

Amazon API Gateway

  • Deploy an edge-optimized API endpoint
  • Enable CloudWatch logging for API Gateway
  • Configure least privilege access IAM role for API Gateway
  • Set the default authorizationType for all API methods to IAM
  • Enable X-Ray Tracing
  • Validate request parameters before passing data to SageMaker

Architecture

Architecture Diagram


© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.