Event actions - AWS Data Exchange

Event actions

An event action is an object that defines the relationship between a specific event and an automated action that will be taken on behalf of the customer.

This section deļ¬nes the ListEventActions and CreateEventAction operations.

URI

/v1/event-actions

HTTP methods

GET

Operation ID: ListEventActions

This operation lists your event actions.

Query parameters
Name Type Required Description
eventSourceId String False

The unique identifier for the event source.

nextToken String False

The token value retrieved from a previous call to access the next page of results.

maxResults String False

The maximum number of results returned by a single call.

Responses
Status code Response model Description
200 ListOfEventActions

200 response

400 ValidationException

400 response

404 ResourceNotFoundException

404 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

POST

Operation ID: CreateEventAction

This operation creates an event action.

Responses
Status code Response model Description
201 EventAction

201 response

400 ValidationException

400 response

402 ServiceQuotaExceededException

402 response

403 AccessDeniedException

403 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

Schemas

Request bodies

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

Response bodies

{ "EventActions": [ { "Event": { "RevisionPublished": { "DataSetId": "string" } }, "Action": { "ExportRevisionToS3": { "RevisionDestination": { "Bucket": "string", "KeyPattern": "string" }, "Encryption": { "Type": enum, "KmsKeyArn": "string" } } }, "Arn": "string", "Id": "string", "CreatedAt": "string", "UpdatedAt": "string" } ], "NextToken": "string" }
{ "Event": { "RevisionPublished": { "DataSetId": "string" } }, "Action": { "ExportRevisionToS3": { "RevisionDestination": { "Bucket": "string", "KeyPattern": "string" }, "Encryption": { "Type": enum, "KmsKeyArn": "string" } } }, "Arn": "string", "Id": "string", "CreatedAt": "string", "UpdatedAt": "string" }
{ "Message": "string", "ExceptionCause": enum }
{ "Message": "string", "LimitName": enum, "LimitValue": number }
{ "Message": "string" }
{ "Message": "string", "ResourceType": enum, "ResourceId": "string" }
{ "Message": "string" }
{ "Message": "string" }

Properties

AccessDeniedException

Access to the resource is denied.

Property Type Required Description
Message

string

True

Access to the resource is denied.

Action

What occurs after a certain event.

Property Type Required Description
ExportRevisionToS3

AutoExportRevisionToS3RequestDetails

False

Details for the export revision to Amazon S3 action.

AutoExportRevisionDestinationEntry

A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.

Property Type Required Description
Bucket

string

True

The S3 bucket that is the destination for the event action.

KeyPattern

string

False

A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see Key patterns when exporting revisions.

AutoExportRevisionToS3RequestDetails

Details of the operation to be performed by the job.

Property Type Required Description
Encryption

ExportServerSideEncryption

False

Encryption configuration for the auto export job.

RevisionDestination

AutoExportRevisionDestinationEntry

True

A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.

CreateEventActionRequest

A request to create an event action.

Property Type Required Description
Action

Action

True

What occurs after a certain event.

Event

Event

True

What occurs to start an action.

Event

What occurs to start an action.

Property Type Required Description
RevisionPublished

RevisionPublished

False

What occurs to start the revision publish action.

EventAction

An event action is an object that defines the relationship between a specific event and an automated action that will be taken on behalf of the customer.

Property Type Required Description
Action

Action

True

What occurs after a certain event.

Arn

string

True

The ARN for the event action.

CreatedAt

string

True

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

Event

Event

True

What occurs to start an action.

Id

string

True

The unique identifier for the event action.

UpdatedAt

string

True

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

EventActionEntry

An event action is an object that defines the relationship between a specific event and an automated action that will be taken on behalf of the customer.

Property Type Required Description
Action

Action

True

What occurs after a certain event.

Arn

string

True

The Amazon Resource Name (ARN) for the event action.

CreatedAt

string

True

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

Event

Event

True

What occurs to start an action.

Id

string

True

The unique identifier for the event action.

UpdatedAt

string

True

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

ExportServerSideEncryption

Encryption configuration of the export job. Includes the encryption type in addition to the AWS KMS key. The KMS key is only necessary if you chose the KMS encryption. type.

Property Type Required Description
KmsKeyArn

string

False

The Amazon Resource Name (ARN) of the AWS KMS key you want to use to encrypt the Amazon S3 objects. This parameter is required if you choose aws:kms as an encryption type.

Type

ServerSideEncryptionTypes

True

The type of server side encryption used for encrypting the objects in Amazon S3.

InternalServerException

An exception occurred with the service.

Property Type Required Description
Message

string

True

The message identifying the service exception that occurred.

ListOfEventActions

The event entry objects listed by the request.

Property Type Required Description
EventActions

Array of type EventActionEntry

True

The event action objects listed by the request.

NextToken

string

False

The token value retrieved from a previous call to access the next page of results.

ResourceNotFoundException

The resource couldn't be found.

Property Type Required Description
Message

string

True

The resource couldn't be found.

ResourceId

string

False

The unique identifier for the resource that couldn't be found.

ResourceType

string

Values: DATA_SET | REVISION | ASSET | JOB | EVENT_ACTION

False

The type of resource that couldn't be found.

RevisionPublished

Information about the published revision.

Property Type Required Description
DataSetId

string

True

The data set ID of the published revision.

ServerSideEncryptionTypes

The types of encryption supported in export jobs to Amazon S3.

  • aws:kms

  • AES256

ServiceQuotaExceededException

The request has exceeded the quotas imposed by the service.

Property Type Required Description
LimitName

string

Values: Products per account | Data sets per account | Data sets per product | Revisions per data set | Assets per revision | Assets per import job from Amazon S3 | Asset per export job from Amazon S3 | Asset size in GB | Concurrent in progress jobs to export assets to Amazon S3 | Concurrent in progress jobs to export assets to a signed URL | Concurrent in progress jobs to import assets from Amazon S3 | Concurrent in progress jobs to import assets from a signed URL | Concurrent in progress jobs to export revisions to Amazon S3 | Event actions per account | Auto export event actions per data set | Amazon Redshift datashare assets per import job from Redshift | Concurrent in progress jobs to import assets from Amazon Redshift datashares | Revisions per Amazon Redshift datashare data set | Amazon Redshift datashare assets per revision | Revisions per Amazon API Gateway API data set | Amazon API Gateway API assets per revision | Concurrent in progress jobs to import assets from Amazon API Gateway

False

The name of the quota that was exceeded.

LimitValue

number

Format: float

False

The maximum value for the service-specific limit.

Message

string

True

The request has exceeded the quotas imposed by the service.

ThrottlingException

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

Property Type Required Description
Message

string

True

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

ValidationException

The request was invalid.

Property Type Required Description
ExceptionCause

string

Values: InsufficientS3BucketPolicy | S3AccessDenied

False

The message that informs you about what the exception was.

Message

string

True

The message that informs you about what was invalid about the request.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListEventActions

CreateEventAction