

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

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


 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ântico](https://semver.org/)Modelo. 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**  | 
| --- | --- | 
|  ![\[alt text not found\]](http://docs.aws.amazon.com/pt_br/solutions/latest/constructs/images/python.png) Python  |  aws\$1solutions\$1constructs.aws\$1apigateway\$1sagemakerendpoint  | 
|  ![\[alt text not found\]](http://docs.aws.amazon.com/pt_br/solutions/latest/constructs/images/typescript.png) TypeScript  |  @aws-solutions-constructs/aws-apigateway-sagemakerendpoint  | 
|  ![\[alt text not found\]](http://docs.aws.amazon.com/pt_br/solutions/latest/constructs/images/java.png) Java  |  software.amazon.awsconstructs.services.apigatewaysagemakerendpoint  | 

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

 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
<a name="initializer-33"></a>

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

 *Parâmetros* 
+  escopo[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) 

## Adereços de construção de padrão
<a name="pattern-construct-props-33"></a>


|  **Nome**  |  **Tipo**  |  **Descrição**  | 
| --- | --- | --- | 
|  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 opcionais fornecidos pelo usuário para substituir os adereços padrão para a API REST do API Gateway.  | 
|  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)  |  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?  |  [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)  |  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
<a name="pattern-properties-33"></a>


|  **Nome**  |  **Tipo**  |  **Descrição**  | 
| --- | --- | --- | 
|  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)  |  Retorna uma instância da API REST Gateway criada pelo padrão.  | 
|  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)  |  Retorna uma instância da função do IAM criada pelo padrão para a API REST do API Gateway.  | 
|  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)  |  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  |  [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)  |  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
<a name="sample-api-usage"></a>

**Observações:** Cada endpoint do SageMaker é exclusivo e a resposta da API dependerá do modelo implantado. O exemplo dado abaixo assume a amostra de[Publicação no blog](https://aws.amazon.com/blogs/machine-learning/creating-a-machine-learning-powered-rest-api-with-amazon-api-gateway-mapping-templates-and-amazon-sagemaker/). Para obter uma referência sobre como isso seria implementado, consulte[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é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 name="default-settings-33"></a>

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

### Amazon API Gateway
<a name="amazon-api-gateway-33"></a>
+  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
<a name="architecture-33"></a>

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


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


|  **Para exibir o código desse padrão, crie/exiba problemas e solicitações pull e muito mais:**  | 
| --- | 
|  ![\[Circular icon with a graduation cap symbol representing education or learning.\]](http://docs.aws.amazon.com/pt_br/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)  | 