aws-apigateway-sagemakerendpoint

Todas as classes estão em desenvolvimento ativo e estão sujeitas a alterações ou remoção não compatíveis com versões anteriores em qualquer versão futura. Estes não estão sujeitos àVersionamento semânticoModelo. Isso significa que, embora você possa usá-los, você pode precisar atualizar seu código-fonte ao atualizar para uma versão mais recente deste pacote.

Observações: Para garantir a funcionalidade adequada, os pacotes AWS Solutions Constructs e os pacotes CDK da AWS em seu projeto devem ser da mesma versão.

Linguagem	Pacote
Python	aws_solutions_constructs.aws_apigateway_sagemakerendpoint
TypeScript	@aws-solutions-constructs/aws-apigateway-sagemakerendpoint
Java	software.amazon.awsconstructs.services.apigatewaysagemakerendpoint

Overview

Este AWS Solutions Construct implementa uma API REST do Amazon API Gateway conectada a um endpoint do Amazon SageMaker.

Aqui está uma definição de padrão implantável mínima no 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);

Parâmetros

• escopoConstruct

• idstring

• propsApiGatewayToSageMakerEndpointProps

Adereços de construção de padrão

Nome	Tipo	Descrição
ApigatewayProps?	api.RestApiProps	Props opcionais fornecidos pelo usuário para substituir os adereços padrão para a API REST do API Gateway.
ApigatewayExecutionRole?	iam.Role	Função do IAM usada pelo API Gateway para chamar o endpoint do SageMaker. Se não for especificado, uma função padrão será criada com acesso aendpointName.
EndpointName	string	Nome do ponto de extremidade de inferência do SageMaker implantado.
ResourceName?	string	Nome do recurso opcional onde o método GET estará disponível.
resourcePath	string	Caminho do recurso para o método GET. A variável definida aqui pode ser referenciada emrequestMappingTemplate.
RequestMappingTemplate	string	Modelo de mapeamento para converter solicitações GET recebidas na API REST em solicitações POST esperadas pelo endpoint SageMaker.
ResponseMappingTemplate?	string	Modelo de mapeamento opcional para converter as respostas recebidas do endpoint do SageMaker.
LoggroupProps?	logs.LogGroupProps	Props opcionais fornecidos pelo usuário para substituir os adereços padrão para o grupo de logs do CloudWatch Logs.

Propriedades de padrão

Nome	Tipo	Descrição
ApiGateway	api.LambdaRestApi	Retorna uma instância da API REST Gateway criada pelo padrão.
ApigateWayRole	iam.Role	Retorna uma instância da função do IAM criada pelo padrão para a API REST do API Gateway.
ApigatewayCloudWatchRole	iam.Role	Retorna uma instância da função do IAM criada pelo padrão que permite o log de acesso da API REST do API Gateway para o CloudWatch.
ApigatewayLogGroup	logs.LogGroup	Retorna uma instância do grupo de logs criado pelo padrão para o qual os logs de acesso à API REST do API Gateway são enviados.

Uso da API de amostra

Observações: Cada endpoint do SageMaker é exclusivo e a resposta da API dependerá do modelo implantado. O exemplo dado abaixo assume a amostra dePublicação no blog. Para obter uma referência sobre como isso seria implementado, consulteinteg.apigateway-sagemakerendpoint-overwrite.ts.

Método	O caminho da solicitação	Sequência de consulta	Ação SageMaker	Descrição
GET	/321	items=101,131,162	sagemaker:InvokeEndpoint	Recupera as previsões para um usuário e itens específicos.

Configurações padrão

A implementação imediata desse padrão sem substituições definirá os seguintes padrões:

Amazon API Gateway

• Implantar um endpoint de API otimizado para bordas

• Habilitar o log do CloudWatch para o

• Configurar a função IAM de acesso de menor privilégio para API Gateway

• Defina o AuthorizationType padrão para todos os métodos de API como IAM

• Ativar rastreamento do X-Ray

• Validar parâmetros de solicitação antes de passar dados para o SageMaker

Architecture

GitHub

Para exibir o código desse padrão, crie/exiba problemas e solicitações pull e muito mais:
	@aws -solutions-constructs/aws-apigateway-sagemakerendpoint