| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CloudWatchEvents.PutEvents
Description
Sends custom events to Amazon EventBridge so that they can be matched to rules.
PutEvents will only process nested JSON up to 1100 levels deep.
Synopsis
- data PutEvents = PutEvents' {}
- newPutEvents :: NonEmpty PutEventsRequestEntry -> PutEvents
- putEvents_endpointId :: Lens' PutEvents (Maybe Text)
- putEvents_entries :: Lens' PutEvents (NonEmpty PutEventsRequestEntry)
- data PutEventsResponse = PutEventsResponse' {}
- newPutEventsResponse :: Int -> PutEventsResponse
- putEventsResponse_entries :: Lens' PutEventsResponse (Maybe [PutEventsResultEntry])
- putEventsResponse_failedEntryCount :: Lens' PutEventsResponse (Maybe Int)
- putEventsResponse_httpStatus :: Lens' PutEventsResponse Int
Creating a Request
See: newPutEvents smart constructor.
Constructors
| PutEvents' | |
Fields
| |
Instances
Arguments
| :: NonEmpty PutEventsRequestEntry | |
| -> 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:
PutEvents, putEvents_endpointId - The URL subdomain of the endpoint. For example, if the URL for Endpoint
is abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is
abcde.veo.
When using Java, you must include auth-crt on the class path.
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_endpointId :: Lens' PutEvents (Maybe Text) Source #
The URL subdomain of the endpoint. For example, if the URL for Endpoint
is abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is
abcde.veo.
When using Java, you must include auth-crt on the class path.
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
| |
Instances
Arguments
| :: Int | |
| -> 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:
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:failedEntryCount:PutEventsResponse', putEventsResponse_failedEntryCount - The number of failed entries.
$sel:httpStatus:PutEventsResponse', putEventsResponse_httpStatus - The response's http status code.
Response Lenses
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_failedEntryCount :: Lens' PutEventsResponse (Maybe Int) Source #
The number of failed entries.
putEventsResponse_httpStatus :: Lens' PutEventsResponse Int Source #
The response's http status code.