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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the engagements to contact channels that occurred by engaging a contact.

This operation returns paginated results.

Synopsis

data ListPagesByEngagement = ListPagesByEngagement' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- engagementId :: Text
}
newListPagesByEngagement :: Text -> ListPagesByEngagement
listPagesByEngagement_nextToken :: Lens' ListPagesByEngagement (Maybe Text)
listPagesByEngagement_maxResults :: Lens' ListPagesByEngagement (Maybe Natural)
listPagesByEngagement_engagementId :: Lens' ListPagesByEngagement Text
data ListPagesByEngagementResponse = ListPagesByEngagementResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- pages :: [Page]
}
newListPagesByEngagementResponse :: Int -> ListPagesByEngagementResponse
listPagesByEngagementResponse_nextToken :: Lens' ListPagesByEngagementResponse (Maybe Text)
listPagesByEngagementResponse_httpStatus :: Lens' ListPagesByEngagementResponse Int
listPagesByEngagementResponse_pages :: Lens' ListPagesByEngagementResponse [Page]

Creating a Request

data ListPagesByEngagement Source #

See: newListPagesByEngagement smart constructor.

Constructors

ListPagesByEngagement'
Fields nextToken :: Maybe Text The pagination token to continue to the next page of results. maxResults :: Maybe Natural The maximum number of engagements to contact channels to list per page of results. engagementId :: Text The Amazon Resource Name (ARN) of the engagement.

Instances

Instances details

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

newListPagesByEngagement Source #

Arguments

:: Text	`$sel:engagementId:ListPagesByEngagement'`
-> ListPagesByEngagement

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

$sel:maxResults:ListPagesByEngagement', listPagesByEngagement_maxResults - The maximum number of engagements to contact channels to list per page of results.

$sel:engagementId:ListPagesByEngagement', listPagesByEngagement_engagementId - The Amazon Resource Name (ARN) of the engagement.

Request Lenses

listPagesByEngagement_nextToken :: Lens' ListPagesByEngagement (Maybe Text) Source #

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

listPagesByEngagement_maxResults :: Lens' ListPagesByEngagement (Maybe Natural) Source #

The maximum number of engagements to contact channels to list per page of results.

listPagesByEngagement_engagementId :: Lens' ListPagesByEngagement Text Source #

The Amazon Resource Name (ARN) of the engagement.

Destructuring the Response

data ListPagesByEngagementResponse Source #

See: newListPagesByEngagementResponse smart constructor.

Constructors

ListPagesByEngagementResponse'
Fields nextToken :: Maybe Text The pagination token to continue to the next page of results. httpStatus :: Int The response's http status code. pages :: [Page] The list of engagements to contact channels.

Instances

Instances details

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

newListPagesByEngagementResponse Source #

Arguments

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

Create a value of ListPagesByEngagementResponse 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:ListPagesByEngagement', listPagesByEngagementResponse_nextToken - The pagination token to continue to the next page of results.

$sel:httpStatus:ListPagesByEngagementResponse', listPagesByEngagementResponse_httpStatus - The response's http status code.

$sel:pages:ListPagesByEngagementResponse', listPagesByEngagementResponse_pages - The list of engagements to contact channels.

Response Lenses

listPagesByEngagementResponse_nextToken :: Lens' ListPagesByEngagementResponse (Maybe Text) Source #

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

listPagesByEngagementResponse_httpStatus :: Lens' ListPagesByEngagementResponse Int Source #

The response's http status code.

listPagesByEngagementResponse_pages :: Lens' ListPagesByEngagementResponse [Page] Source #

The list of engagements to contact channels.