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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

A contact channel is the method that Incident Manager uses to engage your contact.

Synopsis

data CreateContactChannel = CreateContactChannel' {
- idempotencyToken :: Maybe Text
- deferActivation :: Maybe Bool
- contactId :: Text
- name :: Text
- type' :: ChannelType
- deliveryAddress :: ContactChannelAddress
}
newCreateContactChannel :: Text -> Text -> ChannelType -> ContactChannelAddress -> CreateContactChannel
createContactChannel_idempotencyToken :: Lens' CreateContactChannel (Maybe Text)
createContactChannel_deferActivation :: Lens' CreateContactChannel (Maybe Bool)
createContactChannel_contactId :: Lens' CreateContactChannel Text
createContactChannel_name :: Lens' CreateContactChannel Text
createContactChannel_type :: Lens' CreateContactChannel ChannelType
createContactChannel_deliveryAddress :: Lens' CreateContactChannel ContactChannelAddress
data CreateContactChannelResponse = CreateContactChannelResponse' {
- httpStatus :: Int
- contactChannelArn :: Text
}
newCreateContactChannelResponse :: Int -> Text -> CreateContactChannelResponse
createContactChannelResponse_httpStatus :: Lens' CreateContactChannelResponse Int
createContactChannelResponse_contactChannelArn :: Lens' CreateContactChannelResponse Text

Creating a Request

data CreateContactChannel Source #

See: newCreateContactChannel smart constructor.

Constructors

CreateContactChannel'

Fields

idempotencyToken :: Maybe Text
A token ensuring that the operation is called only once with the specified details.
deferActivation :: Maybe Bool
If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.
contactId :: Text
The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.
name :: Text
The name of the contact channel.
type' :: ChannelType
Incident Manager supports three types of contact channels:
- ```
SMS
```
- ```
VOICE
```
- ```
EMAIL
```
deliveryAddress :: ContactChannelAddress
The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:
- SMS - '+' followed by the country code and phone number
- VOICE - '+' followed by the country code and phone number
- EMAIL - any standard email format

Instances

Instances details

Eq CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel Methods (==) :: CreateContactChannel -> CreateContactChannel -> Bool # (/=) :: CreateContactChannel -> CreateContactChannel -> Bool #
Read CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel Methods readsPrec :: Int -> ReadS CreateContactChannel # readList :: ReadS [CreateContactChannel] # readPrec :: ReadPrec CreateContactChannel # readListPrec :: ReadPrec [CreateContactChannel] #
Show CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel Methods showsPrec :: Int -> CreateContactChannel -> ShowS # show :: CreateContactChannel -> String # showList :: [CreateContactChannel] -> ShowS #
Generic CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel Associated Types type Rep CreateContactChannel :: Type -> Type # Methods from :: CreateContactChannel -> Rep CreateContactChannel x # to :: Rep CreateContactChannel x -> CreateContactChannel #
NFData CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel Methods rnf :: CreateContactChannel -> () #
Hashable CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel Methods hashWithSalt :: Int -> CreateContactChannel -> Int # hash :: CreateContactChannel -> Int #
ToJSON CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel Methods toJSON :: CreateContactChannel -> Value # toEncoding :: CreateContactChannel -> Encoding # toJSONList :: [CreateContactChannel] -> Value # toEncodingList :: [CreateContactChannel] -> Encoding #
AWSRequest CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel Associated Types type AWSResponse CreateContactChannel # Methods request :: CreateContactChannel -> Request CreateContactChannel # response :: MonadResource m => Logger -> Service -> Proxy CreateContactChannel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateContactChannel))) #
ToHeaders CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel Methods toHeaders :: CreateContactChannel -> [Header] #
ToPath CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel Methods toPath :: CreateContactChannel -> ByteString #
ToQuery CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel Methods toQuery :: CreateContactChannel -> QueryString #
type Rep CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel type Rep CreateContactChannel = D1 ('MetaData "CreateContactChannel" "Amazonka.SSMContacts.CreateContactChannel" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "CreateContactChannel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "deferActivation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "contactId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChannelType) :*: S1 ('MetaSel ('Just "deliveryAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContactChannelAddress)))))
type AWSResponse CreateContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.CreateContactChannel type AWSResponse CreateContactChannel = CreateContactChannelResponse

newCreateContactChannel Source #

Arguments

:: Text	`$sel:contactId:CreateContactChannel'`
-> Text	`$sel:name:CreateContactChannel'`
-> ChannelType	`$sel:type':CreateContactChannel'`
-> ContactChannelAddress	`$sel:deliveryAddress:CreateContactChannel'`
-> CreateContactChannel

Create a value of CreateContactChannel 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:CreateContactChannel', createContactChannel_idempotencyToken - A token ensuring that the operation is called only once with the specified details.

$sel:deferActivation:CreateContactChannel', createContactChannel_deferActivation - If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.

$sel:contactId:CreateContactChannel', createContactChannel_contactId - The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

$sel:name:CreateContactChannel', createContactChannel_name - The name of the contact channel.

$sel:type':CreateContactChannel', createContactChannel_type - Incident Manager supports three types of contact channels:

```
SMS
```
```
VOICE
```
```
EMAIL
```

$sel:deliveryAddress:CreateContactChannel', createContactChannel_deliveryAddress - The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:

SMS - '+' followed by the country code and phone number
VOICE - '+' followed by the country code and phone number
EMAIL - any standard email format

Request Lenses

createContactChannel_idempotencyToken :: Lens' CreateContactChannel (Maybe Text) Source #

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

createContactChannel_deferActivation :: Lens' CreateContactChannel (Maybe Bool) Source #

If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.

createContactChannel_contactId :: Lens' CreateContactChannel Text Source #

The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

createContactChannel_name :: Lens' CreateContactChannel Text Source #

The name of the contact channel.

createContactChannel_type :: Lens' CreateContactChannel ChannelType Source #

Incident Manager supports three types of contact channels:

```
SMS
```
```
VOICE
```
```
EMAIL
```

createContactChannel_deliveryAddress :: Lens' CreateContactChannel ContactChannelAddress Source #

The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:

SMS - '+' followed by the country code and phone number
VOICE - '+' followed by the country code and phone number
EMAIL - any standard email format

Destructuring the Response

data CreateContactChannelResponse Source #

See: newCreateContactChannelResponse smart constructor.

Constructors

CreateContactChannelResponse'
Fields httpStatus :: Int The response's http status code. contactChannelArn :: Text The Amazon Resource Name (ARN) of the contact channel.

Instances

Instances details

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

newCreateContactChannelResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateContactChannelResponse'`
-> Text	`$sel:contactChannelArn:CreateContactChannelResponse'`
-> CreateContactChannelResponse

Create a value of CreateContactChannelResponse 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:CreateContactChannelResponse', createContactChannelResponse_httpStatus - The response's http status code.

$sel:contactChannelArn:CreateContactChannelResponse', createContactChannelResponse_contactChannelArn - The Amazon Resource Name (ARN) of the contact channel.

Response Lenses

createContactChannelResponse_httpStatus :: Lens' CreateContactChannelResponse Int Source #

The response's http status code.

createContactChannelResponse_contactChannelArn :: Lens' CreateContactChannelResponse Text Source #

The Amazon Resource Name (ARN) of the contact channel.