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.Lightsail.Types.ContactMethod

Description

Synopsis

data ContactMethod = ContactMethod' {
- arn :: Maybe Text
- contactEndpoint :: Maybe Text
- createdAt :: Maybe POSIX
- location :: Maybe ResourceLocation
- name :: Maybe Text
- protocol :: Maybe ContactProtocol
- resourceType :: Maybe ResourceType
- status :: Maybe ContactMethodStatus
- supportCode :: Maybe Text
}
newContactMethod :: ContactMethod
contactMethod_arn :: Lens' ContactMethod (Maybe Text)
contactMethod_contactEndpoint :: Lens' ContactMethod (Maybe Text)
contactMethod_createdAt :: Lens' ContactMethod (Maybe UTCTime)
contactMethod_location :: Lens' ContactMethod (Maybe ResourceLocation)
contactMethod_name :: Lens' ContactMethod (Maybe Text)
contactMethod_protocol :: Lens' ContactMethod (Maybe ContactProtocol)
contactMethod_resourceType :: Lens' ContactMethod (Maybe ResourceType)
contactMethod_status :: Lens' ContactMethod (Maybe ContactMethodStatus)
contactMethod_supportCode :: Lens' ContactMethod (Maybe Text)

Documentation

data ContactMethod Source #

Describes a contact method.

A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.

See: newContactMethod smart constructor.

Constructors

ContactMethod'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the contact method.
contactEndpoint :: Maybe Text
The destination of the contact method, such as an email address or a mobile phone number.
createdAt :: Maybe POSIX
The timestamp when the contact method was created.
location :: Maybe ResourceLocation
An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.
name :: Maybe Text
The name of the contact method.
protocol :: Maybe ContactProtocol
The protocol of the contact method, such as email or SMS (text messaging).
resourceType :: Maybe ResourceType
The Lightsail resource type (e.g., ContactMethod).
status :: Maybe ContactMethodStatus
The current status of the contact method.
A contact method has the following possible status:
- PendingVerification - The contact method has not yet been verified, and the verification has not yet expired.
- Valid - The contact method has been verified.
- InValid - An attempt was made to verify the contact method, but the verification has expired.
supportCode :: Maybe Text
The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.

Instances

Instances details

FromJSON ContactMethod Source #
Instance details Defined in Amazonka.Lightsail.Types.ContactMethod Methods parseJSON :: Value -> Parser ContactMethod # parseJSONList :: Value -> Parser [ContactMethod] #
Generic ContactMethod Source #
Instance details Defined in Amazonka.Lightsail.Types.ContactMethod Associated Types type Rep ContactMethod :: Type -> Type # Methods from :: ContactMethod -> Rep ContactMethod x # to :: Rep ContactMethod x -> ContactMethod #
Read ContactMethod Source #
Instance details Defined in Amazonka.Lightsail.Types.ContactMethod Methods readsPrec :: Int -> ReadS ContactMethod # readList :: ReadS [ContactMethod] # readPrec :: ReadPrec ContactMethod # readListPrec :: ReadPrec [ContactMethod] #
Show ContactMethod Source #
Instance details Defined in Amazonka.Lightsail.Types.ContactMethod Methods showsPrec :: Int -> ContactMethod -> ShowS # show :: ContactMethod -> String # showList :: [ContactMethod] -> ShowS #
NFData ContactMethod Source #
Instance details Defined in Amazonka.Lightsail.Types.ContactMethod Methods rnf :: ContactMethod -> () #
Eq ContactMethod Source #
Instance details Defined in Amazonka.Lightsail.Types.ContactMethod Methods (==) :: ContactMethod -> ContactMethod -> Bool # (/=) :: ContactMethod -> ContactMethod -> Bool #
Hashable ContactMethod Source #
Instance details Defined in Amazonka.Lightsail.Types.ContactMethod Methods hashWithSalt :: Int -> ContactMethod -> Int # hash :: ContactMethod -> Int #
type Rep ContactMethod Source #
Instance details Defined in Amazonka.Lightsail.Types.ContactMethod type Rep ContactMethod = D1 ('MetaData "ContactMethod" "Amazonka.Lightsail.Types.ContactMethod" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "ContactMethod'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "contactEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceLocation)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "protocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContactProtocol))) :: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContactMethodStatus)) :: S1 ('MetaSel ('Just "supportCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newContactMethod :: ContactMethod Source #

Create a value of ContactMethod 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:arn:ContactMethod', contactMethod_arn - The Amazon Resource Name (ARN) of the contact method.

$sel:contactEndpoint:ContactMethod', contactMethod_contactEndpoint - The destination of the contact method, such as an email address or a mobile phone number.

$sel:createdAt:ContactMethod', contactMethod_createdAt - The timestamp when the contact method was created.

$sel:location:ContactMethod', contactMethod_location - An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

$sel:name:ContactMethod', contactMethod_name - The name of the contact method.

$sel:protocol:ContactMethod', contactMethod_protocol - The protocol of the contact method, such as email or SMS (text messaging).

$sel:resourceType:ContactMethod', contactMethod_resourceType - The Lightsail resource type (e.g., ContactMethod).

$sel:status:ContactMethod', contactMethod_status - The current status of the contact method.

A contact method has the following possible status:

PendingVerification - The contact method has not yet been verified, and the verification has not yet expired.
Valid - The contact method has been verified.
InValid - An attempt was made to verify the contact method, but the verification has expired.

$sel:supportCode:ContactMethod', contactMethod_supportCode - The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.

contactMethod_arn :: Lens' ContactMethod (Maybe Text) Source #

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

contactMethod_contactEndpoint :: Lens' ContactMethod (Maybe Text) Source #

The destination of the contact method, such as an email address or a mobile phone number.

contactMethod_createdAt :: Lens' ContactMethod (Maybe UTCTime) Source #

The timestamp when the contact method was created.

contactMethod_location :: Lens' ContactMethod (Maybe ResourceLocation) Source #

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

contactMethod_name :: Lens' ContactMethod (Maybe Text) Source #

The name of the contact method.

contactMethod_protocol :: Lens' ContactMethod (Maybe ContactProtocol) Source #

The protocol of the contact method, such as email or SMS (text messaging).

contactMethod_resourceType :: Lens' ContactMethod (Maybe ResourceType) Source #

The Lightsail resource type (e.g., ContactMethod).

contactMethod_status :: Lens' ContactMethod (Maybe ContactMethodStatus) Source #

The current status of the contact method.

A contact method has the following possible status:

PendingVerification - The contact method has not yet been verified, and the verification has not yet expired.
Valid - The contact method has been verified.
InValid - An attempt was made to verify the contact method, but the verification has expired.

contactMethod_supportCode :: Lens' ContactMethod (Maybe Text) Source #

The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.