Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSMContacts.Types.ContactChannel

Description

Documentation

data ContactChannel Source #

The method that Incident Manager uses to engage a contact.

See: newContactChannel smart constructor.

Constructors

ContactChannel'

Fields

type' :: Maybe ChannelType
The type of the contact channel. Incident Manager supports three contact methods:
- SMS
- VOICE
- EMAIL
contactChannelArn :: Text
The Amazon Resource Name (ARN) of the contact channel.
contactArn :: Text
The ARN of the contact that contains the contact channel.
name :: Text
The name of the contact channel.
deliveryAddress :: ContactChannelAddress
The details that Incident Manager uses when trying to engage the contact channel.
activationStatus :: ActivationStatus
A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.

Instances

Instances details

FromJSON ContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.Types.ContactChannel Methods parseJSON :: Value -> Parser ContactChannel # parseJSONList :: Value -> Parser [ContactChannel] #
Generic ContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.Types.ContactChannel Associated Types type Rep ContactChannel :: Type -> Type # Methods from :: ContactChannel -> Rep ContactChannel x # to :: Rep ContactChannel x -> ContactChannel #
Read ContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.Types.ContactChannel Methods readsPrec :: Int -> ReadS ContactChannel # readList :: ReadS [ContactChannel] # readPrec :: ReadPrec ContactChannel # readListPrec :: ReadPrec [ContactChannel] #
Show ContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.Types.ContactChannel Methods showsPrec :: Int -> ContactChannel -> ShowS # show :: ContactChannel -> String # showList :: [ContactChannel] -> ShowS #
NFData ContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.Types.ContactChannel Methods rnf :: ContactChannel -> () #
Eq ContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.Types.ContactChannel Methods (==) :: ContactChannel -> ContactChannel -> Bool # (/=) :: ContactChannel -> ContactChannel -> Bool #
Hashable ContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.Types.ContactChannel Methods hashWithSalt :: Int -> ContactChannel -> Int # hash :: ContactChannel -> Int #
type Rep ContactChannel Source #
Instance details Defined in Amazonka.SSMContacts.Types.ContactChannel type Rep ContactChannel = D1 ('MetaData "ContactChannel" "Amazonka.SSMContacts.Types.ContactChannel" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "ContactChannel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChannelType)) :: (S1 ('MetaSel ('Just "contactChannelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "contactArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "deliveryAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContactChannelAddress) :*: S1 ('MetaSel ('Just "activationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ActivationStatus)))))

newContactChannel Source #

Arguments

:: Text	`$sel:contactChannelArn:ContactChannel'`
-> Text	`$sel:contactArn:ContactChannel'`
-> Text	`$sel:name:ContactChannel'`
-> ContactChannelAddress	`$sel:deliveryAddress:ContactChannel'`
-> ActivationStatus	`$sel:activationStatus:ContactChannel'`
-> ContactChannel

Create a value of ContactChannel 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:type':ContactChannel', contactChannel_type - The type of the contact channel. Incident Manager supports three contact methods:

SMS
VOICE
EMAIL

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

$sel:contactArn:ContactChannel', contactChannel_contactArn - The ARN of the contact that contains the contact channel.

$sel:name:ContactChannel', contactChannel_name - The name of the contact channel.

$sel:deliveryAddress:ContactChannel', contactChannel_deliveryAddress - The details that Incident Manager uses when trying to engage the contact channel.

$sel:activationStatus:ContactChannel', contactChannel_activationStatus - A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.

contactChannel_type :: Lens' ContactChannel (Maybe ChannelType) Source #

The type of the contact channel. Incident Manager supports three contact methods:

SMS
VOICE
EMAIL

contactChannel_contactChannelArn :: Lens' ContactChannel Text Source #

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

contactChannel_contactArn :: Lens' ContactChannel Text Source #

The ARN of the contact that contains the contact channel.

contactChannel_name :: Lens' ContactChannel Text Source #

The name of the contact channel.

contactChannel_deliveryAddress :: Lens' ContactChannel ContactChannelAddress Source #

The details that Incident Manager uses when trying to engage the contact channel.

contactChannel_activationStatus :: Lens' ContactChannel ActivationStatus Source #

A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.