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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update.

This operation returns paginated results.

Synopsis

Creating a Request

data ListIncidentRecords Source #

See: newListIncidentRecords smart constructor.

Constructors

ListIncidentRecords'

Fields

filters :: Maybe [Filter]
Filters the list of incident records through which you are searching. You can filter on the following keys:
- ```
creationTime
```
- ```
impact
```
- ```
status
```
- ```
createdBy
```
Note the following when deciding how to use Filters:
- If you don't specify a Filter, the response includes all incident records.
- If you specify more than one filter in a single request, the response returns incident records that match all filters.
- If you specify a filter with more than one value, the response returns incident records 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.

Instances

Instances details

ToJSON ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords Methods toJSON :: ListIncidentRecords -> Value # toEncoding :: ListIncidentRecords -> Encoding # toJSONList :: [ListIncidentRecords] -> Value # toEncodingList :: [ListIncidentRecords] -> Encoding #
ToHeaders ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords Methods toHeaders :: ListIncidentRecords -> [Header] #
ToPath ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords Methods toPath :: ListIncidentRecords -> ByteString #
ToQuery ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords Methods toQuery :: ListIncidentRecords -> QueryString #
AWSPager ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords Methods page :: ListIncidentRecords -> AWSResponse ListIncidentRecords -> Maybe ListIncidentRecords #
AWSRequest ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords Associated Types type AWSResponse ListIncidentRecords # Methods request :: (Service -> Service) -> ListIncidentRecords -> Request ListIncidentRecords # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListIncidentRecords -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListIncidentRecords))) #
Generic ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords Associated Types type Rep ListIncidentRecords :: Type -> Type # Methods from :: ListIncidentRecords -> Rep ListIncidentRecords x # to :: Rep ListIncidentRecords x -> ListIncidentRecords #
Read ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords Methods readsPrec :: Int -> ReadS ListIncidentRecords # readList :: ReadS [ListIncidentRecords] # readPrec :: ReadPrec ListIncidentRecords # readListPrec :: ReadPrec [ListIncidentRecords] #
Show ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords Methods showsPrec :: Int -> ListIncidentRecords -> ShowS # show :: ListIncidentRecords -> String # showList :: [ListIncidentRecords] -> ShowS #
NFData ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords Methods rnf :: ListIncidentRecords -> () #
Eq ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords Methods (==) :: ListIncidentRecords -> ListIncidentRecords -> Bool # (/=) :: ListIncidentRecords -> ListIncidentRecords -> Bool #
Hashable ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords Methods hashWithSalt :: Int -> ListIncidentRecords -> Int # hash :: ListIncidentRecords -> Int #
type AWSResponse ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords type AWSResponse ListIncidentRecords = ListIncidentRecordsResponse
type Rep ListIncidentRecords Source #
Instance details Defined in Amazonka.SSMIncidents.ListIncidentRecords type Rep ListIncidentRecords = D1 ('MetaData "ListIncidentRecords" "Amazonka.SSMIncidents.ListIncidentRecords" "amazonka-ssm-incidents-2.0-JEcCJ5TIs2l5vrFa2RYlgd" 'False) (C1 ('MetaCons "ListIncidentRecords'" '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)))))

newListIncidentRecords :: ListIncidentRecords Source #

Create a value of ListIncidentRecords 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:ListIncidentRecords', listIncidentRecords_filters - Filters the list of incident records through which you are searching. You can filter on the following keys:

```
creationTime
```
```
impact
```
```
status
```
```
createdBy
```

Note the following when deciding how to use Filters:

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

$sel:maxResults:ListIncidentRecords', listIncidentRecords_maxResults - The maximum number of results per page.

ListIncidentRecords, listIncidentRecords_nextToken - The pagination token to continue to the next page of results.

Request Lenses

listIncidentRecords_filters :: Lens' ListIncidentRecords (Maybe [Filter]) Source #

Filters the list of incident records through which you are searching. You can filter on the following keys:

```
creationTime
```
```
impact
```
```
status
```
```
createdBy
```

Note the following when deciding how to use Filters:

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

listIncidentRecords_maxResults :: Lens' ListIncidentRecords (Maybe Natural) Source #

The maximum number of results per page.

listIncidentRecords_nextToken :: Lens' ListIncidentRecords (Maybe Text) Source #

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

Destructuring the Response

data ListIncidentRecordsResponse Source #

See: newListIncidentRecordsResponse smart constructor.

Constructors

ListIncidentRecordsResponse'
Fields nextToken :: Maybe Text The pagination token to continue to the next page of results. httpStatus :: Int The response's http status code. incidentRecordSummaries :: [IncidentRecordSummary] The details of each listed incident record.

Instances

Instances details

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

newListIncidentRecordsResponse Source #

Arguments

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

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

ListIncidentRecords, listIncidentRecordsResponse_nextToken - The pagination token to continue to the next page of results.

$sel:httpStatus:ListIncidentRecordsResponse', listIncidentRecordsResponse_httpStatus - The response's http status code.

$sel:incidentRecordSummaries:ListIncidentRecordsResponse', listIncidentRecordsResponse_incidentRecordSummaries - The details of each listed incident record.

Response Lenses

listIncidentRecordsResponse_nextToken :: Lens' ListIncidentRecordsResponse (Maybe Text) Source #

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

listIncidentRecordsResponse_httpStatus :: Lens' ListIncidentRecordsResponse Int Source #

The response's http status code.

listIncidentRecordsResponse_incidentRecordSummaries :: Lens' ListIncidentRecordsResponse [IncidentRecordSummary] Source #

The details of each listed incident record.