| 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.ListContacts
Description
Lists all contacts and escalation plans in Incident Manager.
This operation returns paginated results.
Synopsis
- data ListContacts = ListContacts' {}
- newListContacts :: ListContacts
- listContacts_aliasPrefix :: Lens' ListContacts (Maybe Text)
- listContacts_nextToken :: Lens' ListContacts (Maybe Text)
- listContacts_type :: Lens' ListContacts (Maybe ContactType)
- listContacts_maxResults :: Lens' ListContacts (Maybe Natural)
- data ListContactsResponse = ListContactsResponse' {}
- newListContactsResponse :: Int -> ListContactsResponse
- listContactsResponse_nextToken :: Lens' ListContactsResponse (Maybe Text)
- listContactsResponse_contacts :: Lens' ListContactsResponse (Maybe [Contact])
- listContactsResponse_httpStatus :: Lens' ListContactsResponse Int
Creating a Request
data ListContacts Source #
See: newListContacts smart constructor.
Constructors
| ListContacts' | |
Fields
| |
Instances
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' | |
Instances
newListContactsResponse Source #
Arguments
| :: Int | |
| -> 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: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.
listContactsResponse_httpStatus :: Lens' ListContactsResponse Int Source #
The response's http status code.