partner_event_sources

Creates, updates, deletes, gets or lists a partner_event_sources resource.

Overview

Name	partner_event_sources
Type	Resource
Id	aws.events.partner_event_sources

Fields

The following fields are returned by SELECT queries:

list_partner_event_sources

Name	Datatype	Description
next_token	string	A token indicating there are more results available. If there are no more results, no token is included in the response. The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged. Using an expired pagination token results in an HTTP 400 InvalidToken error.
partner_event_sources	array	The list of partner event sources returned by the operation.

describe_partner_event_source

Name	Datatype	Description
arn	string	The ARN of the event source.
name	string	The name of the event source.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_partner_event_sources	select	region		An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers.
describe_partner_event_source	select	region		An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them.
create_partner_event_source	insert	region, Account		Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers. Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types. A partner event source creates events based on resources within the SaaS partner's service or application. An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets. Partner event source names follow this format: partner_name/event_namespace/event_name partner_name is determined during partner registration, and identifies the partner to Amazon Web Services customers. event_namespace is determined by the partner, and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The event_name must be unique across all Amazon Web Services customers. This is because the event source is a shared resource between the partner and customer accounts, and each partner event source unique in the partner account. The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.
delete_partner_event_source	delete	region		This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers. When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.

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

list_partner_event_sources

An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers.

SELECT
next_token,
partner_event_sources
FROM aws.events.partner_event_sources
WHERE region = '{{ region }}' -- required
;

describe_partner_event_source

An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them.

SELECT
arn,
name
FROM aws.events.partner_event_sources
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_partner_event_source

Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers. Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types. A partner event source creates events based on resources within the SaaS partner's service or application. An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets. Partner event source names follow this format: partner_name/event_namespace/event_name partner_name is determined during partner registration, and identifies the partner to Amazon Web Services customers. event_namespace is determined by the partner, and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The event_name must be unique across all Amazon Web Services customers. This is because the event source is a shared resource between the partner and customer accounts, and each partner event source unique in the partner account. The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.

INSERT INTO aws.events.partner_event_sources (
Name,
Account,
region
)
SELECT 
'{{ Name }}',
'{{ Account }}' /* required */,
'{{ region }}'
RETURNING
event_source_arn
;

Manifest

# Description fields are for documentation purposes
- name: partner_event_sources
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the partner_event_sources resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the partner event source. This name must be unique and must be in the format partner_name/event_namespace/event_name . The Amazon Web Services account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.
  - name: Account
    value: "{{ Account }}"
    description: |
      The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.

DELETE examples

delete_partner_event_source

This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers. When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.

DELETE FROM aws.events.partner_event_sources
WHERE region = '{{ region }}' --required
;