Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudWatchEvents.CreatePartnerEventSource

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.

Creating a Request

data CreatePartnerEventSource Source #

See: newCreatePartnerEventSource smart constructor.

Constructors

CreatePartnerEventSource'

Fields

name :: Text
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.
account :: Text
The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.

Instances

Instances details

Eq CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods (==) :: CreatePartnerEventSource -> CreatePartnerEventSource -> Bool # (/=) :: CreatePartnerEventSource -> CreatePartnerEventSource -> Bool #
Read CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods readsPrec :: Int -> ReadS CreatePartnerEventSource # readList :: ReadS [CreatePartnerEventSource] # readPrec :: ReadPrec CreatePartnerEventSource # readListPrec :: ReadPrec [CreatePartnerEventSource] #
Show CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods showsPrec :: Int -> CreatePartnerEventSource -> ShowS # show :: CreatePartnerEventSource -> String # showList :: [CreatePartnerEventSource] -> ShowS #
Generic CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Associated Types type Rep CreatePartnerEventSource :: Type -> Type # Methods from :: CreatePartnerEventSource -> Rep CreatePartnerEventSource x # to :: Rep CreatePartnerEventSource x -> CreatePartnerEventSource #
NFData CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods rnf :: CreatePartnerEventSource -> () #
Hashable CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods hashWithSalt :: Int -> CreatePartnerEventSource -> Int # hash :: CreatePartnerEventSource -> Int #
ToJSON CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods toJSON :: CreatePartnerEventSource -> Value # toEncoding :: CreatePartnerEventSource -> Encoding # toJSONList :: [CreatePartnerEventSource] -> Value # toEncodingList :: [CreatePartnerEventSource] -> Encoding #
AWSRequest CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Associated Types type AWSResponse CreatePartnerEventSource # Methods request :: CreatePartnerEventSource -> Request CreatePartnerEventSource # response :: MonadResource m => Logger -> Service -> Proxy CreatePartnerEventSource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePartnerEventSource))) #
ToHeaders CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods toHeaders :: CreatePartnerEventSource -> [Header] #
ToPath CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods toPath :: CreatePartnerEventSource -> ByteString #
ToQuery CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods toQuery :: CreatePartnerEventSource -> QueryString #
type Rep CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource type Rep CreatePartnerEventSource = D1 ('MetaData "CreatePartnerEventSource" "Amazonka.CloudWatchEvents.CreatePartnerEventSource" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "CreatePartnerEventSource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "account") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreatePartnerEventSource Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource type AWSResponse CreatePartnerEventSource = CreatePartnerEventSourceResponse

newCreatePartnerEventSource Source #

Arguments

:: Text	`$sel:name:CreatePartnerEventSource'`
-> Text	`$sel:account:CreatePartnerEventSource'`
-> CreatePartnerEventSource

Create a value of CreatePartnerEventSource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:CreatePartnerEventSource', createPartnerEventSource_name - 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.

$sel:account:CreatePartnerEventSource', createPartnerEventSource_account - The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.

Request Lenses

createPartnerEventSource_name :: Lens' CreatePartnerEventSource Text Source #

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.

createPartnerEventSource_account :: Lens' CreatePartnerEventSource Text Source #

The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.

Destructuring the Response

data CreatePartnerEventSourceResponse Source #

See: newCreatePartnerEventSourceResponse smart constructor.

Constructors

CreatePartnerEventSourceResponse'
Fields eventSourceArn :: Maybe Text The ARN of the partner event source. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreatePartnerEventSourceResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods (==) :: CreatePartnerEventSourceResponse -> CreatePartnerEventSourceResponse -> Bool # (/=) :: CreatePartnerEventSourceResponse -> CreatePartnerEventSourceResponse -> Bool #
Read CreatePartnerEventSourceResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods readsPrec :: Int -> ReadS CreatePartnerEventSourceResponse # readList :: ReadS [CreatePartnerEventSourceResponse] # readPrec :: ReadPrec CreatePartnerEventSourceResponse # readListPrec :: ReadPrec [CreatePartnerEventSourceResponse] #
Show CreatePartnerEventSourceResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods showsPrec :: Int -> CreatePartnerEventSourceResponse -> ShowS # show :: CreatePartnerEventSourceResponse -> String # showList :: [CreatePartnerEventSourceResponse] -> ShowS #
Generic CreatePartnerEventSourceResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Associated Types type Rep CreatePartnerEventSourceResponse :: Type -> Type # Methods from :: CreatePartnerEventSourceResponse -> Rep CreatePartnerEventSourceResponse x # to :: Rep CreatePartnerEventSourceResponse x -> CreatePartnerEventSourceResponse #
NFData CreatePartnerEventSourceResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource Methods rnf :: CreatePartnerEventSourceResponse -> () #
type Rep CreatePartnerEventSourceResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.CreatePartnerEventSource type Rep CreatePartnerEventSourceResponse = D1 ('MetaData "CreatePartnerEventSourceResponse" "Amazonka.CloudWatchEvents.CreatePartnerEventSource" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "CreatePartnerEventSourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreatePartnerEventSourceResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreatePartnerEventSourceResponse'`
-> CreatePartnerEventSourceResponse

Create a value of CreatePartnerEventSourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eventSourceArn:CreatePartnerEventSourceResponse', createPartnerEventSourceResponse_eventSourceArn - The ARN of the partner event source.

$sel:httpStatus:CreatePartnerEventSourceResponse', createPartnerEventSourceResponse_httpStatus - The response's http status code.

Response Lenses

createPartnerEventSourceResponse_eventSourceArn :: Lens' CreatePartnerEventSourceResponse (Maybe Text) Source #

The ARN of the partner event source.

createPartnerEventSourceResponse_httpStatus :: Lens' CreatePartnerEventSourceResponse Int Source #

The response's http status code.