aws-apigateway-sagemakerendpoint - Construcciones de Soluciones de AWS
Información generalInitializerPatrón de construcciónPropiedades de patrónUso de las API de ejemploConfiguración predeterminadaArquitecturaGitHub

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

aws-apigateway-sagemakerendpoint

Two labels: "STABILITY" in gray and "EXPERIMENTAL" in orange.

Todas las clases están en desarrollo activo y están sujetas a cambios o eliminación no compatibles con versiones anteriores en cualquier versión futura. Éstos no están sujetos a laVersiones semánticasEl modelo. Esto significa que, aunque puede usarlos, es posible que necesite actualizar el código fuente cuando actualice a una versión más reciente de este paquete.

Nota: Para garantizar una funcionalidad adecuada, los paquetes de AWS Solutions Constructs y los paquetes CDK de AWS del proyecto deben tener la misma versión.

Idioma Paquete
Python 		aws_solutions_constructs.aws_apigateway_sagemakerendpoint
Mecanografía 		@aws-solutions-constructs/aws-apigateway-sagemakerendpoint
Java 		software.amazon.awsconstructs.services.apigatewaysagemakerendpoint

Overview

Este constructo de soluciones de AWS implementa una API REST de Amazon API Gateway conectada a un extremo de Amazon SageMaker.

Aquí hay una definición mínima de patrón implementable en 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

Patrón de construcción

Nombre Tipo Descripción
¿ApigateWayProps? api.RestApiProps Props opcionales proporcionados por el usuario para anular los apoyos predeterminados para la API REST de API Gateway.
ApigatewayExecutionRole? iam.Role Función de IAM utilizada por API Gateway para invocar el punto de enlace de SageMaker. Si no se especifica, se crea un rol predeterminado con acceso aendpointName.
EndpointName string Nombre del extremo de inferencia de SageMaker desplegado.
ResourceName string Nombre de recurso opcional donde estará disponible el método GET.
resourcePath string Ruta de acceso del recurso para el método GET. La variable definida aquí puede ser referenciada enrequestMappingTemplate.
RequestMappingTemplate string Plantilla de asignación para convertir las solicitudes GET recibidas en la API REST a solicitudes POST esperadas por el extremo de SageMaker.
ResponseMappingTemplate string Plantilla de asignación opcional para convertir las respuestas recibidas desde el extremo de SageMaker.
LogGroupProps? logs.LogGroupProps Elementos opcionales proporcionados por el usuario para anular los accesorios predeterminados para el grupo de registros de CloudWatch Logs.

Propiedades de patrón

Nombre Tipo Descripción
ApiGateway api.LambdaRestApi Devuelve una instancia de la API REST de API Gateway creada por el patrón.
ApigateWayRole iam.Role Devuelve una instancia de la función de IAM creada por el patrón para la API de REST de puerta de enlace de API.
ApigatewayCloudWatchRole iam.Role Devuelve una instancia de la función de IAM creada por el patrón que permite el registro de acceso desde API Gateway REST API a CloudWatch.
ApigatewayLogGroup logs.LogGroup Devuelve una instancia del grupo de registros creado por el patrón al que se envían los registros de acceso de API REST de API de API Gateway de API.

Uso de las API de ejemplo

Nota: Cada extremo de SageMaker es único y la respuesta de la API dependerá del modelo implementado. El ejemplo que se da a continuación supone que la muestra deEsta entrada de blog. Para obtener una referencia sobre cómo se implementaría, consulteinteg.apigateway-sagemakerendpoint-overwrite.ts.

Método Ruta de solicitud Cadena de consulta Acción de SageMaker Descripción
GET /321 items=101,131,162 sagemaker:InvokeEndpoint Recupera las predicciones para un usuario y elementos específicos.

Configuración predeterminada

La implementación lista para usar de este patrón sin anulación establecerá los siguientes valores predeterminados:

Amazon API Gateway

  • Implementación de un extremo de API optimizado para bordes

  • Habilitar el registro de CloudWatch para API Gateway

  • Configurar el rol de IAM de acceso mínimo con privilegios para API Gateway

  • Establezca el AuthorizationType predeterminado para todos los métodos API en IAM

  • Habilitación de X-Ray streo

  • Validar los parámetros de solicitud antes de pasar datos a SageMaker

Architecture

Diagram showing Amazon CloudWatch, API Gateway, SageMaker AI endpoint, and IAM roles connections.

GitHub

Para ver el código de este patrón, crear/ver problemas y solicitudes de extracción, y mucho más:
Circular icon with a graduation cap symbol representing education or learning.
@aws -soluciones-constructs/aws-apigateway-sagemakerendpoint