libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudWatchEvents.PutEvents

Description

Sends custom events to Amazon EventBridge so that they can be matched to rules.

Synopsis

Creating a Request

data PutEvents Source #

See: newPutEvents smart constructor.

Constructors

PutEvents' 

Fields

  • entries :: NonEmpty PutEventsRequestEntry

    The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

Instances

Instances details
Eq PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

(==) :: PutEvents -> PutEvents -> Bool #

(/=) :: PutEvents -> PutEvents -> Bool #

Read PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

readsPrec :: Int -> ReadS PutEvents #

readList :: ReadS [PutEvents] #

readPrec :: ReadPrec PutEvents #

readListPrec :: ReadPrec [PutEvents] #

Show PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

showsPrec :: Int -> PutEvents -> ShowS #

show :: PutEvents -> String #

showList :: [PutEvents] -> ShowS #

Generic PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Associated Types

type Rep PutEvents :: Type -> Type #

Methods

from :: PutEvents -> Rep PutEvents x #

to :: Rep PutEvents x -> PutEvents #

NFData PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

rnf :: PutEvents -> () #

Hashable PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

hashWithSalt :: Int -> PutEvents -> Int #

hash :: PutEvents -> Int #

ToJSON PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

toJSON :: PutEvents -> Value #

toEncoding :: PutEvents -> Encoding #

toJSONList :: [PutEvents] -> Value #

toEncodingList :: [PutEvents] -> Encoding #

AWSRequest PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Associated Types

type AWSResponse PutEvents #

Methods

request :: PutEvents -> Request PutEvents #

response :: MonadResource m => Logger -> Service -> Proxy PutEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutEvents))) #

ToHeaders PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

toHeaders :: PutEvents -> [Header] #

ToPath PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

toPath :: PutEvents -> ByteString #

ToQuery PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

toQuery :: PutEvents -> QueryString #

type Rep PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

type Rep PutEvents = D1 ('MetaData "PutEvents" "Amazonka.CloudWatchEvents.PutEvents" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "PutEvents'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty PutEventsRequestEntry))))
type AWSResponse PutEvents Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

type AWSResponse PutEvents = PutEventsResponse

newPutEvents Source #

Arguments

:: NonEmpty PutEventsRequestEntry

$sel:entries:PutEvents'

-> PutEvents 

Create a value of PutEvents 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:entries:PutEvents', putEvents_entries - The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

Request Lenses

putEvents_entries :: Lens' PutEvents (NonEmpty PutEventsRequestEntry) Source #

The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

Destructuring the Response

data PutEventsResponse Source #

See: newPutEventsResponse smart constructor.

Constructors

PutEventsResponse' 

Fields

  • failedEntryCount :: Maybe Int

    The number of failed entries.

  • entries :: Maybe [PutEventsResultEntry]

    The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq PutEventsResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

(==) :: PutEventsResponse -> PutEventsResponse -> Bool #

(/=) :: PutEventsResponse -> PutEventsResponse -> Bool #

Read PutEventsResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

readsPrec :: Int -> ReadS PutEventsResponse #

readList :: ReadS [PutEventsResponse] #

readPrec :: ReadPrec PutEventsResponse #

readListPrec :: ReadPrec [PutEventsResponse] #

Show PutEventsResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

showsPrec :: Int -> PutEventsResponse -> ShowS #

show :: PutEventsResponse -> String #

showList :: [PutEventsResponse] -> ShowS #

Generic PutEventsResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Associated Types

type Rep PutEventsResponse :: Type -> Type #

Methods

from :: PutEventsResponse -> Rep PutEventsResponse x #

to :: Rep PutEventsResponse x -> PutEventsResponse #

NFData PutEventsResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

Methods

rnf :: PutEventsResponse -> () #

type Rep PutEventsResponse Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.PutEvents

type Rep PutEventsResponse = D1 ('MetaData "PutEventsResponse" "Amazonka.CloudWatchEvents.PutEvents" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "PutEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedEntryCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "entries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PutEventsResultEntry])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newPutEventsResponse Source #

Arguments

:: Int

$sel:httpStatus:PutEventsResponse'

-> PutEventsResponse 

Create a value of PutEventsResponse 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:failedEntryCount:PutEventsResponse', putEventsResponse_failedEntryCount - The number of failed entries.

$sel:entries:PutEvents', putEventsResponse_entries - The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

$sel:httpStatus:PutEventsResponse', putEventsResponse_httpStatus - The response's http status code.

Response Lenses

putEventsResponse_failedEntryCount :: Lens' PutEventsResponse (Maybe Int) Source #

The number of failed entries.

putEventsResponse_entries :: Lens' PutEventsResponse (Maybe [PutEventsResultEntry]) Source #

The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

putEventsResponse_httpStatus :: Lens' PutEventsResponse Int Source #

The response's http status code.