Amazonka.SSMContacts.ListPagesByEngagement

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

This operation returns paginated results.

Creating a Request

data ListPagesByEngagement

See: newListPagesByEngagement smart constructor.

Constructors

ListPagesByEngagement'

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.

• engagementId :: Text

  The Amazon Resource Name (ARN) of the engagement.

Instances

ToJSON ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

toJSON :: ListPagesByEngagement -> Value

toEncoding :: ListPagesByEngagement -> Encoding

toJSONList :: [ListPagesByEngagement] -> Value

toEncodingList :: [ListPagesByEngagement] -> Encoding

ToHeaders ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

toHeaders :: ListPagesByEngagement -> [Header]

ToPath ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

toPath :: ListPagesByEngagement -> ByteString

ToQuery ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

toQuery :: ListPagesByEngagement -> QueryString

AWSPager ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

page :: ListPagesByEngagement -> AWSResponse ListPagesByEngagement -> Maybe ListPagesByEngagement

AWSRequest ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Associated Types

type AWSResponse ListPagesByEngagement

Methods

request :: (Service -> Service) -> ListPagesByEngagement -> Request ListPagesByEngagement

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListPagesByEngagement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPagesByEngagement)))

Generic ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Associated Types

type Rep ListPagesByEngagement :: Type -> Type

Methods

from :: ListPagesByEngagement -> Rep ListPagesByEngagement x

to :: Rep ListPagesByEngagement x -> ListPagesByEngagement

Read ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

readsPrec :: Int -> ReadS ListPagesByEngagement

readList :: ReadS [ListPagesByEngagement]

readPrec :: ReadPrec ListPagesByEngagement

readListPrec :: ReadPrec [ListPagesByEngagement]

Show ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

showsPrec :: Int -> ListPagesByEngagement -> ShowS

show :: ListPagesByEngagement -> String

showList :: [ListPagesByEngagement] -> ShowS

NFData ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

rnf :: ListPagesByEngagement -> ()

Eq ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

(==) :: ListPagesByEngagement -> ListPagesByEngagement -> Bool

(/=) :: ListPagesByEngagement -> ListPagesByEngagement -> Bool

Hashable ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

hashWithSalt :: Int -> ListPagesByEngagement -> Int

hash :: ListPagesByEngagement -> Int

type AWSResponse ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

type AWSResponse ListPagesByEngagement = ListPagesByEngagementResponse

type Rep ListPagesByEngagement

Defined in Amazonka.SSMContacts.ListPagesByEngagement

type Rep ListPagesByEngagement = D1 ('MetaData "ListPagesByEngagement" "Amazonka.SSMContacts.ListPagesByEngagement" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "ListPagesByEngagement'" '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 "engagementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListPagesByEngagement

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:maxResults:ListPagesByEngagement', listPagesByEngagement_maxResults - The maximum number of engagements to contact channels to list per page of results.

ListPagesByEngagement, listPagesByEngagement_nextToken - The pagination token to continue to the next page of results.

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

Request Lenses

listPagesByEngagement_maxResults :: Lens' ListPagesByEngagement (Maybe Natural)

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

listPagesByEngagement_nextToken :: Lens' ListPagesByEngagement (Maybe Text)

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

listPagesByEngagement_engagementId :: Lens' ListPagesByEngagement Text

The Amazon Resource Name (ARN) of the engagement.

Destructuring the Response

data ListPagesByEngagementResponse

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

Generic ListPagesByEngagementResponse

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Associated Types

type Rep ListPagesByEngagementResponse :: Type -> Type

Methods

from :: ListPagesByEngagementResponse -> Rep ListPagesByEngagementResponse x

to :: Rep ListPagesByEngagementResponse x -> ListPagesByEngagementResponse

Read ListPagesByEngagementResponse

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

readsPrec :: Int -> ReadS ListPagesByEngagementResponse

readList :: ReadS [ListPagesByEngagementResponse]

readPrec :: ReadPrec ListPagesByEngagementResponse

readListPrec :: ReadPrec [ListPagesByEngagementResponse]

Show ListPagesByEngagementResponse

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

showsPrec :: Int -> ListPagesByEngagementResponse -> ShowS

show :: ListPagesByEngagementResponse -> String

showList :: [ListPagesByEngagementResponse] -> ShowS

NFData ListPagesByEngagementResponse

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

rnf :: ListPagesByEngagementResponse -> ()

Eq ListPagesByEngagementResponse

Defined in Amazonka.SSMContacts.ListPagesByEngagement

Methods

(==) :: ListPagesByEngagementResponse -> ListPagesByEngagementResponse -> Bool

(/=) :: ListPagesByEngagementResponse -> ListPagesByEngagementResponse -> Bool

type Rep ListPagesByEngagementResponse

Defined in Amazonka.SSMContacts.ListPagesByEngagement

type Rep ListPagesByEngagementResponse = D1 ('MetaData "ListPagesByEngagementResponse" "Amazonka.SSMContacts.ListPagesByEngagement" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" '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

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:

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)

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

listPagesByEngagementResponse_httpStatus :: Lens' ListPagesByEngagementResponse Int

The response's http status code.

listPagesByEngagementResponse_pages :: Lens' ListPagesByEngagementResponse [Page]

The list of engagements to contact channels.