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.UpdateTimelineEvent

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a timeline event. You can update events of type Custom Event.

Synopsis

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

Constructors

UpdateTimelineEvent'

Fields

clientToken :: Maybe Text
A token ensuring that the operation is called only once with the specified details.
eventData :: Maybe Text
A short description of the event.
eventReferences :: Maybe [EventReference]
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.
eventTime :: Maybe POSIX
The time that the event occurred.
eventType :: Maybe Text
The type of the event. You can update events of type Custom Event.
eventId :: Text
The ID of the event you are updating. You can find this by using ListTimelineEvents.
incidentRecordArn :: Text
The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Instances

Instances details

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

newUpdateTimelineEvent Source #

Arguments

:: Text	`UpdateTimelineEvent`
-> Text	`UpdateTimelineEvent`
-> UpdateTimelineEvent

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.

Constructors

UpdateTimelineEventResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateTimelineEventResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateTimelineEventResponse'`
-> UpdateTimelineEventResponse

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.