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.SSMContacts.ListPagesByContact

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the engagements to a contact's contact channels.

This operation returns paginated results.

Creating a Request

data ListPagesByContact Source #

See: newListPagesByContact smart constructor.

Constructors

ListPagesByContact'
Fields maxResults :: Maybe Natural The maximum number of engagements to contact channels to list per page of results. nextToken :: Maybe Text The pagination token to continue to the next page of results. contactId :: Text The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.

Instances

Instances details

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

newListPagesByContact Source #

Arguments

:: Text	`ListPagesByContact`
-> ListPagesByContact

Create a value of ListPagesByContact 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:maxResults:ListPagesByContact', listPagesByContact_maxResults - The maximum number of engagements to contact channels to list per page of results.

ListPagesByContact, listPagesByContact_nextToken - The pagination token to continue to the next page of results.

ListPagesByContact, listPagesByContact_contactId - The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.

Request Lenses

listPagesByContact_maxResults :: Lens' ListPagesByContact (Maybe Natural) Source #

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

listPagesByContact_nextToken :: Lens' ListPagesByContact (Maybe Text) Source #

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

listPagesByContact_contactId :: Lens' ListPagesByContact Text Source #

The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.

Destructuring the Response

data ListPagesByContactResponse Source #

See: newListPagesByContactResponse smart constructor.

Constructors

ListPagesByContactResponse'
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 a contact's contact channel.

Instances

Instances details

Generic ListPagesByContactResponse Source #
Instance details Defined in Amazonka.SSMContacts.ListPagesByContact Associated Types type Rep ListPagesByContactResponse :: Type -> Type # Methods from :: ListPagesByContactResponse -> Rep ListPagesByContactResponse x # to :: Rep ListPagesByContactResponse x -> ListPagesByContactResponse #
Read ListPagesByContactResponse Source #
Instance details Defined in Amazonka.SSMContacts.ListPagesByContact Methods readsPrec :: Int -> ReadS ListPagesByContactResponse # readList :: ReadS [ListPagesByContactResponse] # readPrec :: ReadPrec ListPagesByContactResponse # readListPrec :: ReadPrec [ListPagesByContactResponse] #
Show ListPagesByContactResponse Source #
Instance details Defined in Amazonka.SSMContacts.ListPagesByContact Methods showsPrec :: Int -> ListPagesByContactResponse -> ShowS # show :: ListPagesByContactResponse -> String # showList :: [ListPagesByContactResponse] -> ShowS #
NFData ListPagesByContactResponse Source #
Instance details Defined in Amazonka.SSMContacts.ListPagesByContact Methods rnf :: ListPagesByContactResponse -> () #
Eq ListPagesByContactResponse Source #
Instance details Defined in Amazonka.SSMContacts.ListPagesByContact Methods (==) :: ListPagesByContactResponse -> ListPagesByContactResponse -> Bool # (/=) :: ListPagesByContactResponse -> ListPagesByContactResponse -> Bool #
type Rep ListPagesByContactResponse Source #
Instance details Defined in Amazonka.SSMContacts.ListPagesByContact type Rep ListPagesByContactResponse = D1 ('MetaData "ListPagesByContactResponse" "Amazonka.SSMContacts.ListPagesByContact" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "ListPagesByContactResponse'" '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]))))

newListPagesByContactResponse Source #

Arguments

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

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

ListPagesByContact, listPagesByContactResponse_nextToken - The pagination token to continue to the next page of results.

$sel:httpStatus:ListPagesByContactResponse', listPagesByContactResponse_httpStatus - The response's http status code.

$sel:pages:ListPagesByContactResponse', listPagesByContactResponse_pages - The list of engagements to a contact's contact channel.

Response Lenses

listPagesByContactResponse_nextToken :: Lens' ListPagesByContactResponse (Maybe Text) Source #

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

listPagesByContactResponse_httpStatus :: Lens' ListPagesByContactResponse Int Source #

The response's http status code.

listPagesByContactResponse_pages :: Lens' ListPagesByContactResponse [Page] Source #

The list of engagements to a contact's contact channel.