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.CreateContact
Description
Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.
Synopsis
- data CreateContact = CreateContact' {
- idempotencyToken :: Maybe Text
- displayName :: Maybe Text
- tags :: Maybe [Tag]
- alias :: Text
- type' :: ContactType
- plan :: Plan
- newCreateContact :: Text -> ContactType -> Plan -> CreateContact
- createContact_idempotencyToken :: Lens' CreateContact (Maybe Text)
- createContact_displayName :: Lens' CreateContact (Maybe Text)
- createContact_tags :: Lens' CreateContact (Maybe [Tag])
- createContact_alias :: Lens' CreateContact Text
- createContact_type :: Lens' CreateContact ContactType
- createContact_plan :: Lens' CreateContact Plan
- data CreateContactResponse = CreateContactResponse' {
- httpStatus :: Int
- contactArn :: Text
- newCreateContactResponse :: Int -> Text -> CreateContactResponse
- createContactResponse_httpStatus :: Lens' CreateContactResponse Int
- createContactResponse_contactArn :: Lens' CreateContactResponse Text
Creating a Request
data CreateContact Source #
See: newCreateContact
smart constructor.
Constructors
CreateContact' | |
Fields
|
Instances
Arguments
:: Text | |
-> ContactType | |
-> Plan | |
-> CreateContact |
Create a value of CreateContact
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:idempotencyToken:CreateContact'
, createContact_idempotencyToken
- A token ensuring that the operation is called only once with the
specified details.
$sel:displayName:CreateContact'
, createContact_displayName
- The full name of the contact or escalation plan.
$sel:tags:CreateContact'
, createContact_tags
- Adds a tag to the target. You can only tag resources created in the
first Region of your replication set.
$sel:alias:CreateContact'
, createContact_alias
- The short name to quickly identify a contact or escalation plan. The
contact alias must be unique and identifiable.
$sel:type':CreateContact'
, createContact_type
- To create an escalation plan use ESCALATION
. To create a contact use
PERSONAL
.
$sel:plan:CreateContact'
, createContact_plan
- A list of stages. A contact has an engagement plan with stages that
contact specified contact channels. An escalation plan uses stages that
contact specified contacts.
Request Lenses
createContact_idempotencyToken :: Lens' CreateContact (Maybe Text) Source #
A token ensuring that the operation is called only once with the specified details.
createContact_displayName :: Lens' CreateContact (Maybe Text) Source #
The full name of the contact or escalation plan.
createContact_tags :: Lens' CreateContact (Maybe [Tag]) Source #
Adds a tag to the target. You can only tag resources created in the first Region of your replication set.
createContact_alias :: Lens' CreateContact Text Source #
The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.
createContact_type :: Lens' CreateContact ContactType Source #
To create an escalation plan use ESCALATION
. To create a contact use
PERSONAL
.
createContact_plan :: Lens' CreateContact Plan Source #
A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
Destructuring the Response
data CreateContactResponse Source #
See: newCreateContactResponse
smart constructor.
Constructors
CreateContactResponse' | |
Fields
|
Instances
newCreateContactResponse Source #
Arguments
:: Int | |
-> Text | |
-> CreateContactResponse |
Create a value of CreateContactResponse
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:httpStatus:CreateContactResponse'
, createContactResponse_httpStatus
- The response's http status code.
$sel:contactArn:CreateContactResponse'
, createContactResponse_contactArn
- The Amazon Resource Name (ARN) of the created contact or escalation
plan.
Response Lenses
createContactResponse_httpStatus :: Lens' CreateContactResponse Int Source #
The response's http status code.
createContactResponse_contactArn :: Lens' CreateContactResponse Text Source #
The Amazon Resource Name (ARN) of the created contact or escalation plan.