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 |
Updates a timeline event. You can update events of type Custom Event
.
Synopsis
- data UpdateTimelineEvent = UpdateTimelineEvent' {}
- newUpdateTimelineEvent :: Text -> Text -> UpdateTimelineEvent
- updateTimelineEvent_clientToken :: Lens' UpdateTimelineEvent (Maybe Text)
- updateTimelineEvent_eventData :: Lens' UpdateTimelineEvent (Maybe Text)
- updateTimelineEvent_eventReferences :: Lens' UpdateTimelineEvent (Maybe [EventReference])
- updateTimelineEvent_eventTime :: Lens' UpdateTimelineEvent (Maybe UTCTime)
- updateTimelineEvent_eventType :: Lens' UpdateTimelineEvent (Maybe Text)
- updateTimelineEvent_eventId :: Lens' UpdateTimelineEvent Text
- updateTimelineEvent_incidentRecordArn :: Lens' UpdateTimelineEvent Text
- data UpdateTimelineEventResponse = UpdateTimelineEventResponse' {
- httpStatus :: Int
- newUpdateTimelineEventResponse :: Int -> UpdateTimelineEventResponse
- updateTimelineEventResponse_httpStatus :: Lens' UpdateTimelineEventResponse Int
Creating a Request
data UpdateTimelineEvent Source #
See: newUpdateTimelineEvent
smart constructor.
UpdateTimelineEvent' | |
|
Instances
newUpdateTimelineEvent Source #
Create a value of UpdateTimelineEvent
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:clientToken:UpdateTimelineEvent'
, updateTimelineEvent_clientToken
- A token ensuring that the operation is called only once with the
specified details.
UpdateTimelineEvent
, updateTimelineEvent_eventData
- A short description of the event.
UpdateTimelineEvent
, updateTimelineEvent_eventReferences
- Updates all existing references in a TimelineEvent
. A reference can be
an Amazon Web Services resource involved in the incident or in some way
associated with it. When you specify a reference, you enter the Amazon
Resource Name (ARN) of the resource. You can also specify a related
item. As an example, you could specify the ARN of an Amazon DynamoDB
(DynamoDB) table. The table for this example is the resource. You could
also specify a Amazon CloudWatch metric for that table. The metric is
the related item.
This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes them and enters only new references.
UpdateTimelineEvent
, updateTimelineEvent_eventTime
- The time that the event occurred.
UpdateTimelineEvent
, updateTimelineEvent_eventType
- The type of the event. You can update events of type Custom Event
.
UpdateTimelineEvent
, updateTimelineEvent_eventId
- The ID of the event you are updating. You can find this by using
ListTimelineEvents
.
UpdateTimelineEvent
, updateTimelineEvent_incidentRecordArn
- The Amazon Resource Name (ARN) of the incident that includes the
timeline event.
Request Lenses
updateTimelineEvent_clientToken :: Lens' UpdateTimelineEvent (Maybe Text) Source #
A token ensuring that the operation is called only once with the specified details.
updateTimelineEvent_eventData :: Lens' UpdateTimelineEvent (Maybe Text) Source #
A short description of the event.
updateTimelineEvent_eventReferences :: Lens' UpdateTimelineEvent (Maybe [EventReference]) Source #
Updates all existing references in a TimelineEvent
. A reference can be
an Amazon Web Services resource involved in the incident or in some way
associated with it. When you specify a reference, you enter the Amazon
Resource Name (ARN) of the resource. You can also specify a related
item. As an example, you could specify the ARN of an Amazon DynamoDB
(DynamoDB) table. The table for this example is the resource. You could
also specify a Amazon CloudWatch metric for that table. The metric is
the related item.
This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes them and enters only new references.
updateTimelineEvent_eventTime :: Lens' UpdateTimelineEvent (Maybe UTCTime) Source #
The time that the event occurred.
updateTimelineEvent_eventType :: Lens' UpdateTimelineEvent (Maybe Text) Source #
The type of the event. You can update events of type Custom Event
.
updateTimelineEvent_eventId :: Lens' UpdateTimelineEvent Text Source #
The ID of the event you are updating. You can find this by using
ListTimelineEvents
.
updateTimelineEvent_incidentRecordArn :: Lens' UpdateTimelineEvent Text Source #
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
Destructuring the Response
data UpdateTimelineEventResponse Source #
See: newUpdateTimelineEventResponse
smart constructor.
UpdateTimelineEventResponse' | |
|
Instances
newUpdateTimelineEventResponse Source #
Create a value of UpdateTimelineEventResponse
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:httpStatus:UpdateTimelineEventResponse'
, updateTimelineEventResponse_httpStatus
- The response's http status code.
Response Lenses
updateTimelineEventResponse_httpStatus :: Lens' UpdateTimelineEventResponse Int Source #
The response's http status code.