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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all contacts and escalation plans in Incident Manager.

This operation returns paginated results.

Creating a Request

data ListContacts Source #

See: newListContacts smart constructor.

Constructors

ListContacts'

Fields

aliasPrefix :: Maybe Text
Used to list only contacts who's aliases start with the specified prefix.
maxResults :: Maybe Natural
The maximum number of contacts and escalation plans per page of results.
nextToken :: Maybe Text
The pagination token to continue to the next page of results.
type' :: Maybe ContactType
The type of contact. A contact is type PERSONAL and an escalation plan is type ESCALATION.

Instances

Instances details

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

newListContacts :: ListContacts Source #

Create a value of ListContacts 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:aliasPrefix:ListContacts', listContacts_aliasPrefix - Used to list only contacts who's aliases start with the specified prefix.

$sel:maxResults:ListContacts', listContacts_maxResults - The maximum number of contacts and escalation plans per page of results.

ListContacts, listContacts_nextToken - The pagination token to continue to the next page of results.

ListContacts, listContacts_type - The type of contact. A contact is type PERSONAL and an escalation plan is type ESCALATION.

Request Lenses

listContacts_aliasPrefix :: Lens' ListContacts (Maybe Text) Source #

Used to list only contacts who's aliases start with the specified prefix.

listContacts_maxResults :: Lens' ListContacts (Maybe Natural) Source #

The maximum number of contacts and escalation plans per page of results.

listContacts_nextToken :: Lens' ListContacts (Maybe Text) Source #

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

listContacts_type :: Lens' ListContacts (Maybe ContactType) Source #

The type of contact. A contact is type PERSONAL and an escalation plan is type ESCALATION.

Destructuring the Response

data ListContactsResponse Source #

See: newListContactsResponse smart constructor.

Constructors

ListContactsResponse'
Fields contacts :: Maybe [Contact] A list of the contacts and escalation plans in your Incident Manager account. nextToken :: Maybe Text The pagination token to continue to the next page of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListContactsResponse Source #

Arguments

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

Create a value of ListContactsResponse 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:contacts:ListContactsResponse', listContactsResponse_contacts - A list of the contacts and escalation plans in your Incident Manager account.

ListContacts, listContactsResponse_nextToken - The pagination token to continue to the next page of results.

$sel:httpStatus:ListContactsResponse', listContactsResponse_httpStatus - The response's http status code.

Response Lenses

listContactsResponse_contacts :: Lens' ListContactsResponse (Maybe [Contact]) Source #

A list of the contacts and escalation plans in your Incident Manager account.

listContactsResponse_nextToken :: Lens' ListContactsResponse (Maybe Text) Source #

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

listContactsResponse_httpStatus :: Lens' ListContactsResponse Int Source #

The response's http status code.