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 |
Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager.
Synopsis
- data CreateTimelineEvent = CreateTimelineEvent' {}
- newCreateTimelineEvent :: Text -> UTCTime -> Text -> Text -> CreateTimelineEvent
- createTimelineEvent_clientToken :: Lens' CreateTimelineEvent (Maybe Text)
- createTimelineEvent_eventReferences :: Lens' CreateTimelineEvent (Maybe [EventReference])
- createTimelineEvent_eventData :: Lens' CreateTimelineEvent Text
- createTimelineEvent_eventTime :: Lens' CreateTimelineEvent UTCTime
- createTimelineEvent_eventType :: Lens' CreateTimelineEvent Text
- createTimelineEvent_incidentRecordArn :: Lens' CreateTimelineEvent Text
- data CreateTimelineEventResponse = CreateTimelineEventResponse' {
- httpStatus :: Int
- eventId :: Text
- incidentRecordArn :: Text
- newCreateTimelineEventResponse :: Int -> Text -> Text -> CreateTimelineEventResponse
- createTimelineEventResponse_httpStatus :: Lens' CreateTimelineEventResponse Int
- createTimelineEventResponse_eventId :: Lens' CreateTimelineEventResponse Text
- createTimelineEventResponse_incidentRecordArn :: Lens' CreateTimelineEventResponse Text
Creating a Request
data CreateTimelineEvent Source #
See: newCreateTimelineEvent
smart constructor.
CreateTimelineEvent' | |
|
Instances
newCreateTimelineEvent Source #
:: Text | |
-> UTCTime | |
-> Text | |
-> Text | |
-> CreateTimelineEvent |
Create a value of CreateTimelineEvent
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:CreateTimelineEvent'
, createTimelineEvent_clientToken
- A token ensuring that the action is called only once with the specified
details.
CreateTimelineEvent
, createTimelineEvent_eventReferences
- Adds one or more references to the 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.
CreateTimelineEvent
, createTimelineEvent_eventData
- A short description of the event.
CreateTimelineEvent
, createTimelineEvent_eventTime
- The time that the event occurred.
CreateTimelineEvent
, createTimelineEvent_eventType
- The type of the event. You can create timeline events of type
Custom Event
.
CreateTimelineEvent
, createTimelineEvent_incidentRecordArn
- The Amazon Resource Name (ARN) of the incident record to which the event
will be added.
Request Lenses
createTimelineEvent_clientToken :: Lens' CreateTimelineEvent (Maybe Text) Source #
A token ensuring that the action is called only once with the specified details.
createTimelineEvent_eventReferences :: Lens' CreateTimelineEvent (Maybe [EventReference]) Source #
Adds one or more references to the 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.
createTimelineEvent_eventData :: Lens' CreateTimelineEvent Text Source #
A short description of the event.
createTimelineEvent_eventTime :: Lens' CreateTimelineEvent UTCTime Source #
The time that the event occurred.
createTimelineEvent_eventType :: Lens' CreateTimelineEvent Text Source #
The type of the event. You can create timeline events of type
Custom Event
.
createTimelineEvent_incidentRecordArn :: Lens' CreateTimelineEvent Text Source #
The Amazon Resource Name (ARN) of the incident record to which the event will be added.
Destructuring the Response
data CreateTimelineEventResponse Source #
See: newCreateTimelineEventResponse
smart constructor.
CreateTimelineEventResponse' | |
|
Instances
newCreateTimelineEventResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CreateTimelineEventResponse |
Create a value of CreateTimelineEventResponse
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:CreateTimelineEventResponse'
, createTimelineEventResponse_httpStatus
- The response's http status code.
CreateTimelineEventResponse
, createTimelineEventResponse_eventId
- The ID of the event for easy reference later.
CreateTimelineEvent
, createTimelineEventResponse_incidentRecordArn
- The ARN of the incident record that you added the event to.
Response Lenses
createTimelineEventResponse_httpStatus :: Lens' CreateTimelineEventResponse Int Source #
The response's http status code.
createTimelineEventResponse_eventId :: Lens' CreateTimelineEventResponse Text Source #
The ID of the event for easy reference later.
createTimelineEventResponse_incidentRecordArn :: Lens' CreateTimelineEventResponse Text Source #
The ARN of the incident record that you added the event to.