Erstellen eines Schemas aus einem Ereignis JSON in Amazon EventBridge

Wenn Sie über ein Ereignis verfügen, können Sie automatisch ein Schema für diesen Ereignistyp erstellen. JSON

Um ein Schema zu erstellen, das auf dem JSON eines Ereignisses basiert

1. Öffnen Sie die EventBridge Amazon-Konsole unter https://console.aws.amazon.com/events/.

2. Wählen Sie im Navigationsbereich Schemata und dann Schema erstellen aus.

3. (Optional) Wählen Sie eine Schemaregistrierung aus oder erstellen Sie sie.

4. Geben Sie unter Schema details (Schemadetails) einen Namen für Ihr Schema ein.

5. (Optional) Geben Sie eine Beschreibung für das erstellte Schema ein.

6. Wählen Sie als Schematyp Open API 3.0 aus.

   Sie können es nicht verwendenJSONSchema, wenn Sie ein Schema JSON aus einem Ereignis erstellen.

7. Wählen Sie Entdecken von JSON

8. Fügen oder ziehen Sie die JSON Quelle eines Ereignisses in das Textfeld darunter JSON.

   Bei einer fehlgeschlagenen Ausführung könnten Sie beispielsweise die Quelle aus diesem AWS Step Functions Ereignis einfügen.

   {
       "version": "0",
       "id": "315c1398-40ff-a850-213b-158f73e60175",
       "detail-type": "Step Functions Execution Status Change",
       "source": "aws.states",
       "account": "012345678912",
       "time": "2019-02-26T19:42:21Z",
       "region": "us-east-1",
       "resources": [
         "arn:aws:states:us-east-1:012345678912:execution:state-machine-name:execution-name"
       ],
       "detail": {
           "executionArn": "arn:aws:states:us-east-1:012345678912:execution:state-machine-name:execution-name",
           "stateMachineArn": "arn:aws:states:us-east-1:012345678912:stateMachine:state-machine",
           "name": "execution-name",
           "status": "FAILED",
           "startDate": 1551225146847,
           "stopDate": 1551225151881,
           "input": "{}",
           "output": null
       }
   }

9. Klicken Sie auf Discover schema (Schema erkennen).

10. EventBridge generiert ein API Open-Schema für das Ereignis. Beispielsweise wird das folgende Schema für das vorhergehende Step-Functions-Ereignis generiert.

    {
      "openapi": "3.0.0",
      "info": {
        "version": "1.0.0",
        "title": "StepFunctionsExecutionStatusChange"
      },
      "paths": {},
      "components": {
        "schemas": {
          "AWSEvent": {
            "type": "object",
            "required": ["detail-type", "resources", "detail", "id", "source", "time", "region", "version", "account"],
            "x-amazon-events-detail-type": "Step Functions Execution Status Change",
            "x-amazon-events-source": "aws.states",
            "properties": {
              "detail": {
                "$ref": "#/components/schemas/StepFunctionsExecutionStatusChange"
              },
              "account": {
                "type": "string"
              },
              "detail-type": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "region": {
                "type": "string"
              },
              "resources": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "source": {
                "type": "string"
              },
              "time": {
                "type": "string",
                "format": "date-time"
              },
              "version": {
                "type": "string"
              }
            }
          },
          "StepFunctionsExecutionStatusChange": {
            "type": "object",
            "required": ["output", "input", "executionArn", "name", "stateMachineArn", "startDate", "stopDate", "status"],
            "properties": {
              "executionArn": {
                "type": "string"
              },
              "input": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "output": {},
              "startDate": {
                "type": "integer",
                "format": "int64"
              },
              "stateMachineArn": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "stopDate": {
                "type": "integer",
                "format": "int64"
              }
            }
          }
        }
      }
    }

11. Nachdem das Schema generiert wurde, wählen Sie Erstellen aus.