Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSMContacts.ListEngagements

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all engagements that have happened in an incident.

This operation returns paginated results.

Synopsis

data ListEngagements = ListEngagements' {
- timeRangeValue :: Maybe TimeRange
- nextToken :: Maybe Text
- incidentId :: Maybe Text
- maxResults :: Maybe Natural
}
newListEngagements :: ListEngagements
listEngagements_timeRangeValue :: Lens' ListEngagements (Maybe TimeRange)
listEngagements_nextToken :: Lens' ListEngagements (Maybe Text)
listEngagements_incidentId :: Lens' ListEngagements (Maybe Text)
listEngagements_maxResults :: Lens' ListEngagements (Maybe Natural)
data ListEngagementsResponse = ListEngagementsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- engagements :: [Engagement]
}
newListEngagementsResponse :: Int -> ListEngagementsResponse
listEngagementsResponse_nextToken :: Lens' ListEngagementsResponse (Maybe Text)
listEngagementsResponse_httpStatus :: Lens' ListEngagementsResponse Int
listEngagementsResponse_engagements :: Lens' ListEngagementsResponse [Engagement]

Creating a Request

data ListEngagements Source #

See: newListEngagements smart constructor.

Constructors

ListEngagements'
Fields timeRangeValue :: Maybe TimeRange The time range to lists engagements for an incident. nextToken :: Maybe Text The pagination token to continue to the next page of results. incidentId :: Maybe Text The Amazon Resource Name (ARN) of the incident you're listing engagements for. maxResults :: Maybe Natural The maximum number of engagements per page of results.

Instances

Instances details

Eq ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods (==) :: ListEngagements -> ListEngagements -> Bool # (/=) :: ListEngagements -> ListEngagements -> Bool #
Read ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods readsPrec :: Int -> ReadS ListEngagements # readList :: ReadS [ListEngagements] # readPrec :: ReadPrec ListEngagements # readListPrec :: ReadPrec [ListEngagements] #
Show ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods showsPrec :: Int -> ListEngagements -> ShowS # show :: ListEngagements -> String # showList :: [ListEngagements] -> ShowS #
Generic ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Associated Types type Rep ListEngagements :: Type -> Type # Methods from :: ListEngagements -> Rep ListEngagements x # to :: Rep ListEngagements x -> ListEngagements #
NFData ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods rnf :: ListEngagements -> () #
Hashable ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods hashWithSalt :: Int -> ListEngagements -> Int # hash :: ListEngagements -> Int #
ToJSON ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods toJSON :: ListEngagements -> Value # toEncoding :: ListEngagements -> Encoding # toJSONList :: [ListEngagements] -> Value # toEncodingList :: [ListEngagements] -> Encoding #
AWSPager ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods page :: ListEngagements -> AWSResponse ListEngagements -> Maybe ListEngagements #
AWSRequest ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Associated Types type AWSResponse ListEngagements # Methods request :: ListEngagements -> Request ListEngagements # response :: MonadResource m => Logger -> Service -> Proxy ListEngagements -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListEngagements))) #
ToHeaders ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods toHeaders :: ListEngagements -> [Header] #
ToPath ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods toPath :: ListEngagements -> ByteString #
ToQuery ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods toQuery :: ListEngagements -> QueryString #
type Rep ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements type Rep ListEngagements = D1 ('MetaData "ListEngagements" "Amazonka.SSMContacts.ListEngagements" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "ListEngagements'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "timeRangeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRange)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "incidentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListEngagements Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements type AWSResponse ListEngagements = ListEngagementsResponse

newListEngagements :: ListEngagements Source #

Create a value of ListEngagements 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:timeRangeValue:ListEngagements', listEngagements_timeRangeValue - The time range to lists engagements for an incident.

$sel:nextToken:ListEngagements', listEngagements_nextToken - The pagination token to continue to the next page of results.

$sel:incidentId:ListEngagements', listEngagements_incidentId - The Amazon Resource Name (ARN) of the incident you're listing engagements for.

$sel:maxResults:ListEngagements', listEngagements_maxResults - The maximum number of engagements per page of results.

Request Lenses

listEngagements_timeRangeValue :: Lens' ListEngagements (Maybe TimeRange) Source #

The time range to lists engagements for an incident.

listEngagements_nextToken :: Lens' ListEngagements (Maybe Text) Source #

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

listEngagements_incidentId :: Lens' ListEngagements (Maybe Text) Source #

The Amazon Resource Name (ARN) of the incident you're listing engagements for.

listEngagements_maxResults :: Lens' ListEngagements (Maybe Natural) Source #

The maximum number of engagements per page of results.

Destructuring the Response

data ListEngagementsResponse Source #

See: newListEngagementsResponse smart constructor.

Constructors

ListEngagementsResponse'
Fields nextToken :: Maybe Text The pagination token to continue to the next page of results. httpStatus :: Int The response's http status code. engagements :: [Engagement] A list of each engagement that occurred during the specified time range of an incident.

Instances

Instances details

Eq ListEngagementsResponse Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods (==) :: ListEngagementsResponse -> ListEngagementsResponse -> Bool # (/=) :: ListEngagementsResponse -> ListEngagementsResponse -> Bool #
Read ListEngagementsResponse Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods readsPrec :: Int -> ReadS ListEngagementsResponse # readList :: ReadS [ListEngagementsResponse] # readPrec :: ReadPrec ListEngagementsResponse # readListPrec :: ReadPrec [ListEngagementsResponse] #
Show ListEngagementsResponse Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods showsPrec :: Int -> ListEngagementsResponse -> ShowS # show :: ListEngagementsResponse -> String # showList :: [ListEngagementsResponse] -> ShowS #
Generic ListEngagementsResponse Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Associated Types type Rep ListEngagementsResponse :: Type -> Type # Methods from :: ListEngagementsResponse -> Rep ListEngagementsResponse x # to :: Rep ListEngagementsResponse x -> ListEngagementsResponse #
NFData ListEngagementsResponse Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements Methods rnf :: ListEngagementsResponse -> () #
type Rep ListEngagementsResponse Source #
Instance details Defined in Amazonka.SSMContacts.ListEngagements type Rep ListEngagementsResponse = D1 ('MetaData "ListEngagementsResponse" "Amazonka.SSMContacts.ListEngagements" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "ListEngagementsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "engagements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Engagement]))))

newListEngagementsResponse Source #

Arguments

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

Create a value of ListEngagementsResponse 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:nextToken:ListEngagements', listEngagementsResponse_nextToken - The pagination token to continue to the next page of results.

$sel:httpStatus:ListEngagementsResponse', listEngagementsResponse_httpStatus - The response's http status code.

$sel:engagements:ListEngagementsResponse', listEngagementsResponse_engagements - A list of each engagement that occurred during the specified time range of an incident.

Response Lenses

listEngagementsResponse_nextToken :: Lens' ListEngagementsResponse (Maybe Text) Source #

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

listEngagementsResponse_httpStatus :: Lens' ListEngagementsResponse Int Source #

The response's http status code.

listEngagementsResponse_engagements :: Lens' ListEngagementsResponse [Engagement] Source #

A list of each engagement that occurred during the specified time range of an incident.