event_integration_associations
Creates, updates, deletes, gets or lists an event_integration_associations resource.
Overview
| Name | event_integration_associations |
| Type | Resource |
| Id | aws.appintegrations.event_integration_associations |
Fields
The following fields are returned by SELECT queries:
- list_event_integration_associations
| Name | Datatype | Description |
|---|---|---|
client_association_metadata | object | The metadata associated with the client. |
client_id | string | The identifier for the client that is associated with the event integration. (pattern: <code>.*</code>) |
event_bridge_rule_name | string | The name of the EventBridge rule. (pattern: <code>^[a-zA-Z0-9/._-]+$</code>) |
event_integration_association_arn | string | The Amazon Resource Name (ARN) for the event integration association. (pattern: <code>^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$</code>) |
event_integration_association_id | string | The identifier for the event integration association. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>) |
event_integration_name | string | The name of the event integration. (pattern: <code>^[a-zA-Z0-9/._-]+$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_event_integration_associations | select | name, region | nextToken, maxResults | Returns a paginated list of event integration associations in the account. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
name | string | The name of the event integration. |
region | string | AWS region (default: us-east-1) |
maxResults | integer | The maximum number of results to return per page. |
nextToken | string | The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. |
SELECT examples
- list_event_integration_associations
Returns a paginated list of event integration associations in the account.
SELECT
client_association_metadata,
client_id,
event_bridge_rule_name,
event_integration_association_arn,
event_integration_association_id,
event_integration_name
FROM aws.appintegrations.event_integration_associations
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;