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á.

# Api
<a name="sam-property-statemachine-statemachineapi"></a>

O objeto que descreve um tipo de origem do evento `Api`. Se um recurso [AWS::Serverless::Api](sam-resource-api.md) for definido, os valores do caminho e do método devem corresponder a uma operação na definição de OpenAPI da API. 

## Sintaxe
<a name="sam-property-statemachine-statemachineapi-syntax"></a>

Para declarar essa entidade em seu modelo AWS Serverless Application Model (AWS SAM), use a sintaxe a seguir.

### YAML
<a name="sam-property-statemachine-statemachineapi-syntax.yaml"></a>

```
  [Auth](#sam-statemachine-statemachineapi-auth): ApiStateMachineAuth
  [Method](#sam-statemachine-statemachineapi-method): String
  [Path](#sam-statemachine-statemachineapi-path): String
  [RestApiId](#sam-statemachine-statemachineapi-restapiid): String
  UnescapeMappingTemplate: Boolean
```

## Propriedades
<a name="sam-property-statemachine-statemachineapi-properties"></a>

 `Auth`   <a name="sam-statemachine-statemachineapi-auth"></a>
A configuração de autorização para essa API, caminho e método.  
Use essa propriedade para substituir a configuração `DefaultAuthorizer` da API para um caminho individual, quando nenhum `DefaultAuthorizer` for especificado, ou para substituir a configuração padrão `ApiKeyRequired`.  
*Digite*: [ApiStateMachineAuth](sam-property-statemachine-apistatemachineauth.md)  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

 `Method`   <a name="sam-statemachine-statemachineapi-method"></a>
O método HTTP para o qual essa função é invocada.  
*Tipo:* string  
*Obrigatório*: Sim  
*CloudFormation compatibilidade*: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

 `Path`   <a name="sam-statemachine-statemachineapi-path"></a>
O caminho do URI para o qual esta função é invocada. O valor deve começar com `/`.  
*Tipo:* string  
*Obrigatório*: Sim  
*CloudFormation compatibilidade*: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

 `RestApiId`   <a name="sam-statemachine-statemachineapi-restapiid"></a>
O identificador de um recurso `RestApi`, que deve conter uma operação com o caminho e o método fornecidos. Normalmente, isso é definido para fazer referência a um recurso [AWS::Serverless::Api](sam-resource-api.md) definido nesse modelo.  
Se você não definir essa propriedade, AWS SAM cria um [AWS::Serverless::Api](sam-resource-api.md) recurso padrão usando um `OpenApi` documento gerado. Esse recurso contém uma união de todos os caminhos e métodos definidos por eventos `Api` no mesmo modelo que não especificam um arquivo `RestApiId`.  
Esta propriedade não pode fazer referência a um recurso [AWS::Serverless::Api](sam-resource-api.md) definido em outro modelo.  
*Tipo:* string  
*Obrigatório*: não  
*CloudFormation compatibilidade*: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

 `UnescapeMappingTemplate`   <a name="sam-statemachine-statemachineapi-unescapemappingtemplate"></a>
Elimina aspas simples, substituindo `\'` por `'`, na entrada que é passada para a máquina de estado. Use quando sua entrada contiver aspas simples.  
Se definido como `False` e sua entrada contiver aspas simples, ocorrerá um erro.
*Tipo*: booliano  
*Obrigatório*: não  
*Padrão*: False  
*CloudFormation compatibilidade*: essa propriedade é exclusiva AWS SAM e não tem CloudFormation equivalente.

## Exemplos
<a name="sam-property-statemachine-statemachineapi--examples"></a>

### ApiEvent
<a name="sam-property-statemachine-statemachineapi--examples--apievent"></a>

A seguir está um exemplo de um evento do tipo `Api`.

#### YAML
<a name="sam-property-statemachine-statemachineapi--examples--apievent--yaml"></a>

```
Events:
  ApiEvent:
    Type: Api
    Properties:
      Path: /path
      Method: get
```