event_sources
Creates, updates, deletes, gets or lists an event_sources resource.
Overview
| Name | event_sources |
| Type | Resource |
| Id | aws.events.event_sources |
Fields
The following fields are returned by SELECT queries:
- describe_event_source
| Name | Datatype | Description |
|---|---|---|
arn | string | The ARN of the partner event source. |
created_by | string | The name of the SaaS partner that created the event source. |
creation_time | string (date-time) | The date and time that the event source was created. |
expiration_time | string (date-time) | The date and time that the event source will expire if you do not create a matching event bus. |
name | string | The name of the partner event source. |
state | string | The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted. (PENDING, ACTIVE, DELETED) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_event_source | select | region | This operation lists details about a partner event source that is shared with your account. | |
list_event_sources | exec | region | You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_event_source
This operation lists details about a partner event source that is shared with your account.
SELECT
arn,
created_by,
creation_time,
expiration_time,
name,
state
FROM aws.events.event_sources
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- list_event_sources
You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus.
EXEC aws.events.event_sources.list_event_sources
@region='{{ region }}' --required
@@json=
'{
"NamePrefix": "{{ NamePrefix }}",
"NextToken": "{{ NextToken }}",
"Limit": {{ Limit }}
}'
;