Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# aws-apigateway-sagemakerendpoint
<a name="aws-apigateway-sagemakerendpoint"></a>

![\[Two labels: "STABILITY" in gray and "EXPERIMENTAL" in orange.\]](http://docs.aws.amazon.com/fr_fr/solutions/latest/constructs/images/experimental.png)


 Toutes les classes sont en cours de développement actif et sujettes à des modifications ou à des suppressions non rétrocompatibles dans toute version future. Ceux-ci ne sont pas assujettis à la[Gestion sémantique des versions](https://semver.org/)modèle. Cela signifie que même si vous pouvez les utiliser, vous devrez peut-être mettre à jour votre code source lors de la mise à niveau vers une version plus récente de ce package. 

**Remarque:** Pour garantir une bonne fonctionnalité, les packages AWS Solutions Constructs et AWS CDK de votre projet doivent être la même version. 


|  **Langage**  |  **Package**  | 
| --- | --- | 
|  ![\[alt text not found\]](http://docs.aws.amazon.com/fr_fr/solutions/latest/constructs/images/python.png) Python  |  aws\$1solutions\$1constructs.aws\$1apigateway\$1sagemakerendpoint  | 
|  ![\[alt text not found\]](http://docs.aws.amazon.com/fr_fr/solutions/latest/constructs/images/typescript.png) TypeScript  |  @aws-solutions-constructs/aws-apigateway-sagemakerendpoint  | 
|  ![\[alt text not found\]](http://docs.aws.amazon.com/fr_fr/solutions/latest/constructs/images/java.png) Java  |  software.amazon.awsconstructs.services.apigatewaysagemakerendpoint  | 

## Overview
<a name="overview-33"></a>

 AWS Solutions Construct implémente une API REST Amazon API Gateway connectée à un point de terminaison Amazon SageMaker.

 Voici une définition de modèle déployable minimale dans 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
<a name="initializer-33"></a>

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

 *Paramètres* 
+  scope[https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html) 
+  id`string` 
+  props[`ApiGatewayToSageMakerEndpointProps`](#pattern-construct-props-33) 

## Accessoires de construction de modèle
<a name="pattern-construct-props-33"></a>


|  **Nom**  |  **Type**  |  **Description**  | 
| --- | --- | --- | 
|  ApigatewayProps ?  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApiProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApiProps.html)  |  Props fournis par l'utilisateur en option pour remplacer les accessoires par défaut de l'API Gateway API.  | 
|  ApigatewayExecutionRole ?  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html)  |  Rôle IAM utilisé par API Gateway pour appeler le point de terminaison SageMaker. Si ce n'est pas spécifié, un rôle par défaut est créé avec accès àendpointName.  | 
|  EnpointName  |  string  |  Nom du point de terminaison d'inférence SageMaker déployé.  | 
|  ResourceName ?  |  string  |  Nom de ressource facultatif où la méthode GET sera disponible.  | 
|  chemin de la ressource  |  string  |  Chemin de la ressource pour la méthode GET. La variable définie ici peut être référencée dansrequestMappingTemplate.  | 
|  RequestMappingTemplate  |  string  |  Modèle de mappage pour convertir les requêtes GET reçues sur l'API REST en requêtes POST attendues par le point de terminaison SageMaker.  | 
|  ResponseMappingTemplate ?  |  string  |  Modèle de mappage facultatif pour convertir les réponses reçues du point de terminaison SageMaker.  | 
|  LogGroupProps ?  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html)  |  Exemples facultatifs fournis par l'utilisateur pour remplacer les accessoires par défaut pour le groupe de journaux CloudWatch Logs.  | 

## Propriétés du modèle
<a name="pattern-properties-33"></a>


|  **Nom**  |  **Type**  |  **Description**  | 
| --- | --- | --- | 
|  Apigateway  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.LambdaRestApi.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.LambdaRestApi.html)  |  Renvoie une instance de l'API Gateway API créée par le modèle.  | 
|  ApigateWayRole  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html)  |  Renvoie une instance du rôle IAM créé par le modèle pour l'API Gateway API.  | 
|  ApigateWayCloudWatchRole  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html)  |  Renvoie une instance du rôle IAM créé par le modèle qui active la journalisation des accès à partir de l'API Gateway API vers CloudWatch.  | 
|  ApigateWayLogGroup  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroup.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroup.html)  |  Renvoie une instance du groupe de journaux créé par le modèle auquel les journaux d'accès API REST de API Gateway d'API sont envoyés.  | 

## Exemple d'utilisation de l'API
<a name="sample-api-usage"></a>

**Remarque:** Chaque point de terminaison SageMaker est unique et la réponse de l'API dépend du modèle déployé. L'exemple donné ci-dessous suppose que l'échantillon de[cet article de blog](https://aws.amazon.com/blogs/machine-learning/creating-a-machine-learning-powered-rest-api-with-amazon-api-gateway-mapping-templates-and-amazon-sagemaker/). Pour obtenir une référence sur la façon dont cela serait mis en œuvre, veuillez vous référer à[integ.apigateway-sagemakerendpoint-overwrite.ts](https://github.com/awslabs/aws-solutions-constructs/blob/f02997ea4fa6515fc4429771d21821d2c26a8584/source/patterns/%40aws-solutions-constructs/aws-apigateway-sagemakerendpoint/test/integ.apigateway-sagemakerendpoint-overwrite.ts).


|  **Méthode**  |  **Chemin de la demande**  |  **Chaîne de requête**  |  **Action SageMaker**  |  **Description**  | 
| --- | --- | --- | --- | --- | 
|  GET  |  /321  |  items=101,131,162  |  sagemaker:InvokeEndpoint  |  Récupère les prédictions d'un utilisateur et d'éléments spécifiques.  | 

## Paramètres par défaut
<a name="default-settings-33"></a>

 L'implémentation prête à l'emploi de ce modèle sans remplacement définira les valeurs par défaut suivantes :

### Amazon API Gateway
<a name="amazon-api-gateway-33"></a>
+  Déployer un point de terminaison API optimisé pour les périphériques 
+  Activer la journalisation CloudWatch pour API Gateway 
+  Configurer le rôle IAM d'accès minimal aux privilèges pour API Gateway 
+  Définissez l'AuthorizationType par défaut pour toutes les méthodes d'API sur IAM 
+  Activer le suivi X-Ray 
+  Valider les paramètres de demande avant de transmettre les données à SageMaker 

## Architecture
<a name="architecture-33"></a>

![\[Diagram showing Amazon CloudWatch, API Gateway, SageMaker endpoint, and IAM roles connections.\]](http://docs.aws.amazon.com/fr_fr/solutions/latest/constructs/images/aws-apigateway-sagemakerendpoint.png)


## GitHub
<a name="github-33"></a>


|  **Pour afficher le code de ce modèle, créer/afficher les problèmes et les demandes d'extraction, et plus encore :**  | 
| --- | 
|  ![\[Circular icon with a graduation cap symbol representing education or learning.\]](http://docs.aws.amazon.com/fr_fr/solutions/latest/constructs/images/GitHub-Mark-32px.png)  |  [@aws -solutions-constructs/aws-apigateway-sagemakerendpoint](https://github.com/awslabs/aws-solutions-constructs/tree/master/source/patterns/%40aws-solutions-constructs/aws-apigateway-sagemakerendpoint)  |