libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSMContacts.ListContacts

Description

Lists all contacts and escalation plans in Incident Manager.

This operation returns paginated results.

Synopsis

Creating a Request

data ListContacts Source #

See: newListContacts smart constructor.

Constructors

ListContacts' 

Fields

Instances

Instances details
Eq ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

Read ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

Show ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

Generic ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

Associated Types

type Rep ListContacts :: Type -> Type #

NFData ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

Methods

rnf :: ListContacts -> () #

Hashable ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

ToJSON ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

AWSPager ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

AWSRequest ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

Associated Types

type AWSResponse ListContacts #

ToHeaders ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

ToPath ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

ToQuery ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

type Rep ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

type Rep ListContacts = D1 ('MetaData "ListContacts" "Amazonka.SSMContacts.ListContacts" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "ListContacts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aliasPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContactType)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListContacts Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

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:nextToken:ListContacts', listContacts_nextToken - The pagination token to continue to the next page of results.

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

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

Request Lenses

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

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

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.

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

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

Destructuring the Response

data ListContactsResponse Source #

See: newListContactsResponse smart constructor.

Constructors

ListContactsResponse' 

Fields

Instances

Instances details
Eq ListContactsResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

Read ListContactsResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

Show ListContactsResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

Generic ListContactsResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

Associated Types

type Rep ListContactsResponse :: Type -> Type #

NFData ListContactsResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

Methods

rnf :: ListContactsResponse -> () #

type Rep ListContactsResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.ListContacts

type Rep ListContactsResponse = D1 ('MetaData "ListContactsResponse" "Amazonka.SSMContacts.ListContacts" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "ListContactsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "contacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Contact])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListContactsResponse Source #

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:nextToken:ListContacts', listContactsResponse_nextToken - The pagination token to continue to the next page of results.

$sel:contacts:ListContactsResponse', listContactsResponse_contacts - A list of the contacts and escalation plans in your Incident Manager account.

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

Response Lenses

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

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

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

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