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.SSMIncidents.CreateTimelineEvent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- clientToken :: Maybe Text
- eventReferences :: Maybe [EventReference]
- eventData :: Text
- eventTime :: POSIX
- eventType :: Text
- incidentRecordArn :: Text
}
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.

Constructors

CreateTimelineEvent'

Fields

clientToken :: Maybe Text
A token ensuring that the action is called only once with the specified details.
eventReferences :: Maybe [EventReference]
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.
eventData :: Text
A short description of the event.
eventTime :: POSIX
The time that the event occurred.
eventType :: Text
The type of the event. You can create timeline events of type Custom Event.
incidentRecordArn :: Text
The Amazon Resource Name (ARN) of the incident record to which the event will be added.

Instances

Instances details

ToJSON CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods toJSON :: CreateTimelineEvent -> Value # toEncoding :: CreateTimelineEvent -> Encoding # toJSONList :: [CreateTimelineEvent] -> Value # toEncodingList :: [CreateTimelineEvent] -> Encoding #
ToHeaders CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods toHeaders :: CreateTimelineEvent -> [Header] #
ToPath CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods toPath :: CreateTimelineEvent -> ByteString #
ToQuery CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods toQuery :: CreateTimelineEvent -> QueryString #
AWSRequest CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Associated Types type AWSResponse CreateTimelineEvent # Methods request :: (Service -> Service) -> CreateTimelineEvent -> Request CreateTimelineEvent # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateTimelineEvent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateTimelineEvent))) #
Generic CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Associated Types type Rep CreateTimelineEvent :: Type -> Type # Methods from :: CreateTimelineEvent -> Rep CreateTimelineEvent x # to :: Rep CreateTimelineEvent x -> CreateTimelineEvent #
Read CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods readsPrec :: Int -> ReadS CreateTimelineEvent # readList :: ReadS [CreateTimelineEvent] # readPrec :: ReadPrec CreateTimelineEvent # readListPrec :: ReadPrec [CreateTimelineEvent] #
Show CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods showsPrec :: Int -> CreateTimelineEvent -> ShowS # show :: CreateTimelineEvent -> String # showList :: [CreateTimelineEvent] -> ShowS #
NFData CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods rnf :: CreateTimelineEvent -> () #
Eq CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods (==) :: CreateTimelineEvent -> CreateTimelineEvent -> Bool # (/=) :: CreateTimelineEvent -> CreateTimelineEvent -> Bool #
Hashable CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods hashWithSalt :: Int -> CreateTimelineEvent -> Int # hash :: CreateTimelineEvent -> Int #
type AWSResponse CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent type AWSResponse CreateTimelineEvent = CreateTimelineEventResponse
type Rep CreateTimelineEvent Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent type Rep CreateTimelineEvent = D1 ('MetaData "CreateTimelineEvent" "Amazonka.SSMIncidents.CreateTimelineEvent" "amazonka-ssm-incidents-2.0-JEcCJ5TIs2l5vrFa2RYlgd" 'False) (C1 ('MetaCons "CreateTimelineEvent'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "eventReferences") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventReference])) :: S1 ('MetaSel ('Just "eventData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "eventTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "eventType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "incidentRecordArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateTimelineEvent Source #

Arguments

:: Text	`CreateTimelineEvent`
-> UTCTime	`CreateTimelineEvent`
-> Text	`CreateTimelineEvent`
-> Text	`CreateTimelineEvent`
-> 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.

Constructors

CreateTimelineEventResponse'
Fields httpStatus :: Int The response's http status code. eventId :: Text The ID of the event for easy reference later. incidentRecordArn :: Text The ARN of the incident record that you added the event to.

Instances

Instances details

Generic CreateTimelineEventResponse Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Associated Types type Rep CreateTimelineEventResponse :: Type -> Type # Methods from :: CreateTimelineEventResponse -> Rep CreateTimelineEventResponse x # to :: Rep CreateTimelineEventResponse x -> CreateTimelineEventResponse #
Read CreateTimelineEventResponse Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods readsPrec :: Int -> ReadS CreateTimelineEventResponse # readList :: ReadS [CreateTimelineEventResponse] # readPrec :: ReadPrec CreateTimelineEventResponse # readListPrec :: ReadPrec [CreateTimelineEventResponse] #
Show CreateTimelineEventResponse Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods showsPrec :: Int -> CreateTimelineEventResponse -> ShowS # show :: CreateTimelineEventResponse -> String # showList :: [CreateTimelineEventResponse] -> ShowS #
NFData CreateTimelineEventResponse Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods rnf :: CreateTimelineEventResponse -> () #
Eq CreateTimelineEventResponse Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent Methods (==) :: CreateTimelineEventResponse -> CreateTimelineEventResponse -> Bool # (/=) :: CreateTimelineEventResponse -> CreateTimelineEventResponse -> Bool #
type Rep CreateTimelineEventResponse Source #
Instance details Defined in Amazonka.SSMIncidents.CreateTimelineEvent type Rep CreateTimelineEventResponse = D1 ('MetaData "CreateTimelineEventResponse" "Amazonka.SSMIncidents.CreateTimelineEvent" "amazonka-ssm-incidents-2.0-JEcCJ5TIs2l5vrFa2RYlgd" 'False) (C1 ('MetaCons "CreateTimelineEventResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "eventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "incidentRecordArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateTimelineEventResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateTimelineEventResponse'`
-> Text	`CreateTimelineEventResponse`
-> Text	`CreateTimelineEvent`
-> 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.