Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

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

Das Objekt, das einen `Api` Ereignisquellentyp beschreibt. Wenn eine [AWS::Serverless::Api](sam-resource-api.md) Ressource definiert ist, müssen der Pfad und die Methodenwerte einer Operation in der OpenAPI-Definition der API entsprechen. 

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

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer Vorlage AWS Serverless Application Model (AWS SAM) zu deklarieren.

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

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

 `Auth`   <a name="sam-statemachine-statemachineapi-auth"></a>
Die Autorisierungskonfiguration für diese API, diesen Pfad und diese Methode.  
Verwenden Sie diese Eigenschaft, um die `DefaultAuthorizer` API-Einstellung für einen einzelnen Pfad zu überschreiben, wenn kein Pfad angegeben `DefaultAuthorizer` ist, oder um die `ApiKeyRequired` Standardeinstellung zu überschreiben.  
*Typ:* [ApiStateMachineAuth](sam-property-statemachine-apistatemachineauth.md)  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Method`   <a name="sam-statemachine-statemachineapi-method"></a>
Die HTTP-Methode, für die diese Funktion aufgerufen wird.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `Path`   <a name="sam-statemachine-statemachineapi-path"></a>
Der URI-Pfad, für den diese Funktion aufgerufen wird. Der Wert muss mit `/` beginnen.  
*Typ:* Zeichenfolge  
*Erforderlich*: Ja  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `RestApiId`   <a name="sam-statemachine-statemachineapi-restapiid"></a>
Der Bezeichner einer `RestApi` Ressource, die eine Operation mit dem angegebenen Pfad und der angegebenen Methode enthalten muss. In der Regel ist dies so eingestellt, dass es auf eine [AWS::Serverless::Api](sam-resource-api.md) Ressource verweist, die in dieser Vorlage definiert ist.  
Wenn Sie diese Eigenschaft nicht definieren, AWS SAM wird mithilfe eines generierten `OpenApi` Dokuments eine [AWS::Serverless::Api](sam-resource-api.md) Standardressource erstellt. Diese Ressource enthält eine Vereinigung aller Pfade und Methoden, die durch `Api` Ereignisse in derselben Vorlage definiert wurden, ohne dass a angegeben ist`RestApiId`.  
Diese Eigenschaft kann nicht auf eine [AWS::Serverless::Api](sam-resource-api.md) Ressource verweisen, die in einer anderen Vorlage definiert ist.  
*Typ:* Zeichenfolge  
*Required*: No  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

 `UnescapeMappingTemplate`   <a name="sam-statemachine-statemachineapi-unescapemappingtemplate"></a>
Macht einfache Anführungszeichen rückgängig, indem sie `\'` bei der Eingabe`'`, die an die Zustandsmaschine übergeben wird, durch ersetzt werden. Wird verwendet, wenn Ihre Eingabe einfache Anführungszeichen enthält.  
Wenn dieser Wert auf gesetzt ist `False` und Ihre Eingabe einfache Anführungszeichen enthält, tritt ein Fehler auf.
*Typ*: Boolesch  
*Required*: No  
*Standard*: False  
*CloudFormation Kompatibilität*: Diese Eigenschaft ist einzigartig für AWS SAM und hat kein CloudFormation Äquivalent.

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

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

Das Folgende ist ein Beispiel für ein Ereignis dieses `Api` Typs.

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

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