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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists timeline events for the specified incident record.

This operation returns paginated results.

Synopsis

data ListTimelineEvents = ListTimelineEvents' {
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe TimelineEventSort
- sortOrder :: Maybe SortOrder
- incidentRecordArn :: Text
}
newListTimelineEvents :: Text -> ListTimelineEvents
listTimelineEvents_filters :: Lens' ListTimelineEvents (Maybe [Filter])
listTimelineEvents_maxResults :: Lens' ListTimelineEvents (Maybe Natural)
listTimelineEvents_nextToken :: Lens' ListTimelineEvents (Maybe Text)
listTimelineEvents_sortBy :: Lens' ListTimelineEvents (Maybe TimelineEventSort)
listTimelineEvents_sortOrder :: Lens' ListTimelineEvents (Maybe SortOrder)
listTimelineEvents_incidentRecordArn :: Lens' ListTimelineEvents Text
data ListTimelineEventsResponse = ListTimelineEventsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- eventSummaries :: [EventSummary]
}
newListTimelineEventsResponse :: Int -> ListTimelineEventsResponse
listTimelineEventsResponse_nextToken :: Lens' ListTimelineEventsResponse (Maybe Text)
listTimelineEventsResponse_httpStatus :: Lens' ListTimelineEventsResponse Int
listTimelineEventsResponse_eventSummaries :: Lens' ListTimelineEventsResponse [EventSummary]

Creating a Request

data ListTimelineEvents Source #

See: newListTimelineEvents smart constructor.

Constructors

ListTimelineEvents'

Fields

filters :: Maybe [Filter]
Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys:
- ```
eventTime
```
- ```
eventType
```
Note the following when deciding how to use Filters:
- If you don't specify a Filter, the response includes all timeline events.
- If you specify more than one filter in a single request, the response returns timeline events that match all filters.
- If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.
maxResults :: Maybe Natural
The maximum number of results per page.
nextToken :: Maybe Text
The pagination token to continue to the next page of results.
sortBy :: Maybe TimelineEventSort
Sort by the specified key value pair.
sortOrder :: Maybe SortOrder
Sorts the order of timeline events by the value specified in the sortBy field.
incidentRecordArn :: Text
The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Instances

Instances details

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

newListTimelineEvents Source #

Arguments

:: Text	`ListTimelineEvents`
-> ListTimelineEvents

Create a value of ListTimelineEvents 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:filters:ListTimelineEvents', listTimelineEvents_filters - Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys:

```
eventTime
```
```
eventType
```

Note the following when deciding how to use Filters:

If you don't specify a Filter, the response includes all timeline events.
If you specify more than one filter in a single request, the response returns timeline events that match all filters.
If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.

$sel:maxResults:ListTimelineEvents', listTimelineEvents_maxResults - The maximum number of results per page.

ListTimelineEvents, listTimelineEvents_nextToken - The pagination token to continue to the next page of results.

$sel:sortBy:ListTimelineEvents', listTimelineEvents_sortBy - Sort by the specified key value pair.

$sel:sortOrder:ListTimelineEvents', listTimelineEvents_sortOrder - Sorts the order of timeline events by the value specified in the sortBy field.

ListTimelineEvents, listTimelineEvents_incidentRecordArn - The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Request Lenses

listTimelineEvents_filters :: Lens' ListTimelineEvents (Maybe [Filter]) Source #

Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys:

```
eventTime
```
```
eventType
```

Note the following when deciding how to use Filters:

If you don't specify a Filter, the response includes all timeline events.
If you specify more than one filter in a single request, the response returns timeline events that match all filters.
If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.

listTimelineEvents_maxResults :: Lens' ListTimelineEvents (Maybe Natural) Source #

The maximum number of results per page.

listTimelineEvents_nextToken :: Lens' ListTimelineEvents (Maybe Text) Source #

The pagination token to continue to the next page of results.

listTimelineEvents_sortBy :: Lens' ListTimelineEvents (Maybe TimelineEventSort) Source #

Sort by the specified key value pair.

listTimelineEvents_sortOrder :: Lens' ListTimelineEvents (Maybe SortOrder) Source #

Sorts the order of timeline events by the value specified in the sortBy field.

listTimelineEvents_incidentRecordArn :: Lens' ListTimelineEvents Text Source #

The Amazon Resource Name (ARN) of the incident that includes the timeline event.

Destructuring the Response

data ListTimelineEventsResponse Source #

See: newListTimelineEventsResponse smart constructor.

Constructors

ListTimelineEventsResponse'
Fields nextToken :: Maybe Text The pagination token to continue to the next page of results. httpStatus :: Int The response's http status code. eventSummaries :: [EventSummary] Details about each event that occurred during the incident.

Instances

Instances details

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

newListTimelineEventsResponse Source #

Arguments

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

Create a value of ListTimelineEventsResponse 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:

ListTimelineEvents, listTimelineEventsResponse_nextToken - The pagination token to continue to the next page of results.

$sel:httpStatus:ListTimelineEventsResponse', listTimelineEventsResponse_httpStatus - The response's http status code.

$sel:eventSummaries:ListTimelineEventsResponse', listTimelineEventsResponse_eventSummaries - Details about each event that occurred during the incident.

Response Lenses

listTimelineEventsResponse_nextToken :: Lens' ListTimelineEventsResponse (Maybe Text) Source #

The pagination token to continue to the next page of results.

listTimelineEventsResponse_httpStatus :: Lens' ListTimelineEventsResponse Int Source #

The response's http status code.

listTimelineEventsResponse_eventSummaries :: Lens' ListTimelineEventsResponse [EventSummary] Source #

Details about each event that occurred during the incident.