Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateEventAction

This operation creates an event action.

Request Syntax


POST /v1/event-actions HTTP/1.1
Content-type: application/json

{
   "Action": { 
      "ExportRevisionToS3": { 
         "Encryption": { 
            "KmsKeyArn": "string",
            "Type": "string"
         },
         "RevisionDestination": { 
            "Bucket": "string",
            "KeyPattern": "string"
         }
      }
   },
   "Event": { 
      "RevisionPublished": { 
         "DataSetId": "string"
      }
   },
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Action

What occurs after a certain event.

Type: Action object

Required: Yes

Event

What occurs to start an action.

Type: Event object

Required: Yes

Tags

Key-value pairs that you can associate with the event action.

Type: String to string map

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "Action": { 
      "ExportRevisionToS3": { 
         "Encryption": { 
            "KmsKeyArn": "string",
            "Type": "string"
         },
         "RevisionDestination": { 
            "Bucket": "string",
            "KeyPattern": "string"
         }
      }
   },
   "Arn": "string",
   "CreatedAt": "string",
   "Event": { 
      "RevisionPublished": { 
         "DataSetId": "string"
      }
   },
   "Id": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UpdatedAt": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

Action

What occurs after a certain event.

Type: Action object

Arn

The ARN for the event action.

Type: String

CreatedAt

The date and time that the event action was created, in ISO 8601 format.

Type: Timestamp

Event

What occurs to start an action.

Type: Event object

Id

The unique identifier for the event action.

Type: String

Tags

The tags for the event action.

Type: String to string map

UpdatedAt

The date and time that the event action was last updated, in ISO 8601 format.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to the resource is denied.

Message: Access to the resource is denied.

HTTP Status Code: 403

InternalServerException

An exception occurred with the service.

Message: The message identifying the service exception that occurred.

HTTP Status Code: 500

ServiceLimitExceededException

The request has exceeded the quotas imposed by the service.

LimitName: The name of the limit that was reached.
LimitValue: The value of the exceeded limit.
Message: The request has exceeded the quotas imposed by the service.

HTTP Status Code: 402

ThrottlingException

The limit on the number of requests per second was exceeded.

Message: The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request was invalid.

ExceptionCause: The unique identifier for the resource that couldn't be found.
Message: The message that informs you about what was invalid about the request.

HTTP Status Code: 400