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.

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

L'objet décrivant un type de source d'événement `Api`. Si une ressource [AWS::Serverless::Api](sam-resource-api.md) est définie, les valeurs de chemin d'accès et de méthode doivent correspondre à une opération dans la définition OpenAPI de l'API. 

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

Pour déclarer cette entité dans votre modèle AWS Serverless Application Model (AWS SAM), utilisez la syntaxe suivante.

### 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
```

## Propriétés
<a name="sam-property-statemachine-statemachineapi-properties"></a>

 `Auth`   <a name="sam-statemachine-statemachineapi-auth"></a>
La configuration d'autorisation pour cette API, ce chemin d'accès et cette méthode.  
Utilisez cette propriété pour remplacer la propriété `DefaultAuthorizer` pour un chemin d'accès individuel, lorsqu'aucun `DefaultAuthorizer` n'est spécifié, ou pour remplacer le réglage `ApiKeyRequired` par défaut.  
*Type :* [ApiStateMachineAuth](sam-property-statemachine-apistatemachineauth.md)  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Method`   <a name="sam-statemachine-statemachineapi-method"></a>
La méthode HTTP pour laquelle cette fonction est appelée.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `Path`   <a name="sam-statemachine-statemachineapi-path"></a>
Le chemin d'accès d'URI pour lequel cette fonction est appelée. La valeur doit commencer par `/`.  
*Type* : chaîne  
*Obligatoire* : oui  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `RestApiId`   <a name="sam-statemachine-statemachineapi-restapiid"></a>
L'identificateur d'une ressource `RestApi`, qui doit contenir une opération avec le chemin et la méthode donnés. Cela est généralement défini pour faire référence à une ressource [AWS::Serverless::Api](sam-resource-api.md) qui est définie dans ce modèle.  
Si vous ne définissez pas cette propriété, AWS SAM crée une [AWS::Serverless::Api](sam-resource-api.md) ressource par défaut à l'aide d'un `OpenApi` document généré. Cette ressource contient une union de tous les chemins et méthodes définis par `Api` dans le même modèle qui ne spécifient pas un `RestApiId`.  
Cette propriété ne peut pas faire référence à une ressource [AWS::Serverless::Api](sam-resource-api.md) qui est définie dans un autre modèle.  
*Type* : chaîne  
*Obligatoire* : non  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

 `UnescapeMappingTemplate`   <a name="sam-statemachine-statemachineapi-unescapemappingtemplate"></a>
Élimine les guillemets simples, en remplaçant `\'` par `'`, sur l'entrée transmise à la machine d'état. À utiliser lorsque votre entrée contient des guillemets simples.  
Si ce paramètre est défini sur `False` et que votre entrée contient des guillemets simples, une erreur se produira.
*Type* : valeur booléenne  
*Obligatoire* : non  
*Par défaut* : False  
*CloudFormation compatibilité* : cette propriété est unique AWS SAM et n'a pas d' CloudFormation équivalent.

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

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

Voici un exemple d'un événement du type `Api`.

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

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