amazonka-cloudwatch-events-2.0: Amazon EventBridge SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudWatchEvents.Types.PutEventsRequestEntry

Description

 
Synopsis

Documentation

data PutEventsRequestEntry Source #

Represents an event to be submitted.

See: newPutEventsRequestEntry smart constructor.

Constructors

PutEventsRequestEntry' 

Fields

  • detail :: Maybe Text

    A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested subobjects.

  • detailType :: Maybe Text

    Free-form string used to decide what fields to expect in the event detail.

  • eventBusName :: Maybe Text

    The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are used to match the event. If you omit this, the default event bus is used.

    If you're using a global endpoint with a custom bus, you must enter the name, not the ARN, of the event bus in either the primary or secondary Region here and the corresponding event bus in the other Region will be determined based on the endpoint referenced by the EndpointId.

  • resources :: Maybe [Text]

    Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

  • source :: Maybe Text

    The source of the event.

  • time :: Maybe POSIX

    The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

  • traceHeader :: Maybe Text

    An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.

    To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.

Instances

Instances details
ToJSON PutEventsRequestEntry Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.PutEventsRequestEntry

Generic PutEventsRequestEntry Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.PutEventsRequestEntry

Associated Types

type Rep PutEventsRequestEntry :: Type -> Type #

Read PutEventsRequestEntry Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.PutEventsRequestEntry

Show PutEventsRequestEntry Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.PutEventsRequestEntry

NFData PutEventsRequestEntry Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.PutEventsRequestEntry

Methods

rnf :: PutEventsRequestEntry -> () #

Eq PutEventsRequestEntry Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.PutEventsRequestEntry

Hashable PutEventsRequestEntry Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.PutEventsRequestEntry

type Rep PutEventsRequestEntry Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.PutEventsRequestEntry

type Rep PutEventsRequestEntry = D1 ('MetaData "PutEventsRequestEntry" "Amazonka.CloudWatchEvents.Types.PutEventsRequestEntry" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "PutEventsRequestEntry'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "detail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "detailType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eventBusName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "time") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "traceHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newPutEventsRequestEntry :: PutEventsRequestEntry Source #

Create a value of PutEventsRequestEntry 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:detail:PutEventsRequestEntry', putEventsRequestEntry_detail - A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested subobjects.

$sel:detailType:PutEventsRequestEntry', putEventsRequestEntry_detailType - Free-form string used to decide what fields to expect in the event detail.

$sel:eventBusName:PutEventsRequestEntry', putEventsRequestEntry_eventBusName - The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are used to match the event. If you omit this, the default event bus is used.

If you're using a global endpoint with a custom bus, you must enter the name, not the ARN, of the event bus in either the primary or secondary Region here and the corresponding event bus in the other Region will be determined based on the endpoint referenced by the EndpointId.

$sel:resources:PutEventsRequestEntry', putEventsRequestEntry_resources - Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

$sel:source:PutEventsRequestEntry', putEventsRequestEntry_source - The source of the event.

$sel:time:PutEventsRequestEntry', putEventsRequestEntry_time - The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

$sel:traceHeader:PutEventsRequestEntry', putEventsRequestEntry_traceHeader - An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.

To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.

putEventsRequestEntry_detail :: Lens' PutEventsRequestEntry (Maybe Text) Source #

A valid JSON object. There is no other schema imposed. The JSON object may contain fields and nested subobjects.

putEventsRequestEntry_detailType :: Lens' PutEventsRequestEntry (Maybe Text) Source #

Free-form string used to decide what fields to expect in the event detail.

putEventsRequestEntry_eventBusName :: Lens' PutEventsRequestEntry (Maybe Text) Source #

The name or ARN of the event bus to receive the event. Only the rules that are associated with this event bus are used to match the event. If you omit this, the default event bus is used.

If you're using a global endpoint with a custom bus, you must enter the name, not the ARN, of the event bus in either the primary or secondary Region here and the corresponding event bus in the other Region will be determined based on the endpoint referenced by the EndpointId.

putEventsRequestEntry_resources :: Lens' PutEventsRequestEntry (Maybe [Text]) Source #

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

putEventsRequestEntry_time :: Lens' PutEventsRequestEntry (Maybe UTCTime) Source #

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

putEventsRequestEntry_traceHeader :: Lens' PutEventsRequestEntry (Maybe Text) Source #

An X-Ray trace header, which is an http header (X-Amzn-Trace-Id) that contains the trace-id associated with the event.

To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.