aws-solutions-constructs.aws-apigateway-sagemakerendpoint

v1.83.0

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

PyPI

README

GitHub

Website

Apache-2.0

Latest version published 1 month ago

    pip install aws-solutions-constructs-aws-apigateway-sagemakerendpoint

We couldn't find any similar packages Browse all packages

Package Health Score

77 / 100

Popularity
Limited
Maintenance
Healthy
Security
No known security issues
Community
Active

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Total Weekly Downloads (900)

Dependents: 0
GitHub Stars: 315
Forks: 55
Contributors: 20

The PyPI package aws-solutions-constructs.aws-apigateway-sagemakerendpoint receives a total of 900 downloads a week. As such, we scored aws-solutions-constructs.aws-apigateway-sagemakerendpoint popularity level to be Limited.

Based on project statistics from the GitHub repository for the PyPI package aws-solutions-constructs.aws-apigateway-sagemakerendpoint, we found that it has been starred 315 times, and that 0 other projects in the ecosystem are dependent on it.

The download numbers shown are the average weekly downloads from the last 6 weeks.

Security

No known security issues

Security and license risk for latest version

Version: 1.83.0 See all versions
Release Date: 01/2021
Direct Vulnerabilities: 0
H

0
M

0
L
Indirect Vulnerabilities: 0
H

0
M

0
L
License Risk: 0
H

0
M

0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like aws-solutions-constructs.aws-apigateway-sagemakerendpoint is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 25
Merged PR: 11
Open PR: 2
Last Commit: 1 month ago

Further analysis of the maintenance status of aws-solutions-constructs.aws-apigateway-sagemakerendpoint based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that aws-solutions-constructs.aws-apigateway-sagemakerendpoint demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 20
Funding: No

With more than 10 contributors for the aws-solutions-constructs.aws-apigateway-sagemakerendpoint repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Package

Python Versions Compatibility: >=3.6

Age: 5 months
Latest Release: 1 month ago
Dependencies: 0
Versions: 16
Maintainers: 1
Wheels: OS Independent

aws-apigateway-sagemakerendpoint module

---

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	`aws_solutions_constructs.aws_apigateway_sagemakerendpoint`
Typescript	`@aws-solutions-constructs/aws-apigateway-sagemakerendpoint`
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

scope Construct
id string
props ApiGatewayToSageMakerEndpointProps

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

Last updated on 24 January-2021, at 12:37 (UTC).