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

Creating a Request

data CreateContact Source #

See: newCreateContact smart constructor.

Constructors

CreateContact' 

Fields

  • idempotencyToken :: Maybe Text

    A token ensuring that the operation is called only once with the specified details.

  • displayName :: Maybe Text

    The full name of the contact or escalation plan.

  • tags :: Maybe [Tag]

    Adds a tag to the target. You can only tag resources created in the first Region of your replication set.

  • alias :: Text

    The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.

  • type' :: ContactType

    To create an escalation plan use ESCALATION. To create a contact use PERSONAL.

  • plan :: 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.

Instances

Instances details
Eq CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

(==) :: CreateContact -> CreateContact -> Bool #

(/=) :: CreateContact -> CreateContact -> Bool #

Read CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

readsPrec :: Int -> ReadS CreateContact #

readList :: ReadS [CreateContact] #

readPrec :: ReadPrec CreateContact #

readListPrec :: ReadPrec [CreateContact] #

Show CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

showsPrec :: Int -> CreateContact -> ShowS #

show :: CreateContact -> String #

showList :: [CreateContact] -> ShowS #

Generic CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Associated Types

type Rep CreateContact :: Type -> Type #

Methods

from :: CreateContact -> Rep CreateContact x #

to :: Rep CreateContact x -> CreateContact #

NFData CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

rnf :: CreateContact -> () #

Hashable CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

hashWithSalt :: Int -> CreateContact -> Int #

hash :: CreateContact -> Int #

ToJSON CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

toJSON :: CreateContact -> Value #

toEncoding :: CreateContact -> Encoding #

toJSONList :: [CreateContact] -> Value #

toEncodingList :: [CreateContact] -> Encoding #

AWSRequest CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Associated Types

type AWSResponse CreateContact #

Methods

request :: CreateContact -> Request CreateContact #

response :: MonadResource m => Logger -> Service -> Proxy CreateContact -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateContact))) #

ToHeaders CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

toHeaders :: CreateContact -> [Header] #

ToPath CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

toPath :: CreateContact -> ByteString #

ToQuery CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

toQuery :: CreateContact -> QueryString #

type Rep CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

type Rep CreateContact = D1 ('MetaData "CreateContact" "Amazonka.SSMContacts.CreateContact" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "CreateContact'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContactType) :*: S1 ('MetaSel ('Just "plan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Plan)))))
type AWSResponse CreateContact Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

type AWSResponse CreateContact = CreateContactResponse

newCreateContact Source #

Arguments

:: Text

$sel:alias:CreateContact'

-> ContactType

$sel:type':CreateContact'

-> Plan

$sel:plan:CreateContact'

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

  • httpStatus :: Int

    The response's http status code.

  • contactArn :: Text

    The Amazon Resource Name (ARN) of the created contact or escalation plan.

Instances

Instances details
Eq CreateContactResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

(==) :: CreateContactResponse -> CreateContactResponse -> Bool #

(/=) :: CreateContactResponse -> CreateContactResponse -> Bool #

Read CreateContactResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

readsPrec :: Int -> ReadS CreateContactResponse #

readList :: ReadS [CreateContactResponse] #

readPrec :: ReadPrec CreateContactResponse #

readListPrec :: ReadPrec [CreateContactResponse] #

Show CreateContactResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

showsPrec :: Int -> CreateContactResponse -> ShowS #

show :: CreateContactResponse -> String #

showList :: [CreateContactResponse] -> ShowS #

Generic CreateContactResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Associated Types

type Rep CreateContactResponse :: Type -> Type #

Methods

from :: CreateContactResponse -> Rep CreateContactResponse x #

to :: Rep CreateContactResponse x -> CreateContactResponse #

NFData CreateContactResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

Methods

rnf :: CreateContactResponse -> () #

type Rep CreateContactResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.CreateContact

type Rep CreateContactResponse = D1 ('MetaData "CreateContactResponse" "Amazonka.SSMContacts.CreateContact" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "CreateContactResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "contactArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateContactResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateContactResponse'

-> Text

$sel:contactArn:CreateContactResponse'

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