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.SESV2.Types.DedicatedIp

Description

Synopsis

data DedicatedIp = DedicatedIp' {
- poolName :: Maybe Text
- ip :: Text
- warmupStatus :: WarmupStatus
- warmupPercentage :: Int
}
newDedicatedIp :: Text -> WarmupStatus -> Int -> DedicatedIp
dedicatedIp_poolName :: Lens' DedicatedIp (Maybe Text)
dedicatedIp_ip :: Lens' DedicatedIp Text
dedicatedIp_warmupStatus :: Lens' DedicatedIp WarmupStatus
dedicatedIp_warmupPercentage :: Lens' DedicatedIp Int

Documentation

data DedicatedIp Source #

Contains information about a dedicated IP address that is associated with your Amazon SES account.

To learn more about requesting dedicated IP addresses, see Requesting and Relinquishing Dedicated IP Addresses in the Amazon SES Developer Guide.

See: newDedicatedIp smart constructor.

Constructors

DedicatedIp'

Fields

poolName :: Maybe Text
The name of the dedicated IP pool that the IP address is associated with.
ip :: Text
An IPv4 address.
warmupStatus :: WarmupStatus
The warm-up status of a dedicated IP address. The status can have one of the following values:
- IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.
- DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.
warmupPercentage :: Int
Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

Instances

Instances details

Eq DedicatedIp Source #
Instance details Defined in Amazonka.SESV2.Types.DedicatedIp Methods (==) :: DedicatedIp -> DedicatedIp -> Bool # (/=) :: DedicatedIp -> DedicatedIp -> Bool #
Read DedicatedIp Source #
Instance details Defined in Amazonka.SESV2.Types.DedicatedIp Methods readsPrec :: Int -> ReadS DedicatedIp # readList :: ReadS [DedicatedIp] # readPrec :: ReadPrec DedicatedIp # readListPrec :: ReadPrec [DedicatedIp] #
Show DedicatedIp Source #
Instance details Defined in Amazonka.SESV2.Types.DedicatedIp Methods showsPrec :: Int -> DedicatedIp -> ShowS # show :: DedicatedIp -> String # showList :: [DedicatedIp] -> ShowS #
Generic DedicatedIp Source #
Instance details Defined in Amazonka.SESV2.Types.DedicatedIp Associated Types type Rep DedicatedIp :: Type -> Type # Methods from :: DedicatedIp -> Rep DedicatedIp x # to :: Rep DedicatedIp x -> DedicatedIp #
NFData DedicatedIp Source #
Instance details Defined in Amazonka.SESV2.Types.DedicatedIp Methods rnf :: DedicatedIp -> () #
Hashable DedicatedIp Source #
Instance details Defined in Amazonka.SESV2.Types.DedicatedIp Methods hashWithSalt :: Int -> DedicatedIp -> Int # hash :: DedicatedIp -> Int #
FromJSON DedicatedIp Source #
Instance details Defined in Amazonka.SESV2.Types.DedicatedIp Methods parseJSON :: Value -> Parser DedicatedIp # parseJSONList :: Value -> Parser [DedicatedIp] #
type Rep DedicatedIp Source #
Instance details Defined in Amazonka.SESV2.Types.DedicatedIp type Rep DedicatedIp = D1 ('MetaData "DedicatedIp" "Amazonka.SESV2.Types.DedicatedIp" "libZSservicesZSamazonka-sesv2ZSamazonka-sesv2" 'False) (C1 ('MetaCons "DedicatedIp'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "poolName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ip") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "warmupStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WarmupStatus) :*: S1 ('MetaSel ('Just "warmupPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDedicatedIp Source #

Arguments

:: Text	`$sel:ip:DedicatedIp'`
-> WarmupStatus	`$sel:warmupStatus:DedicatedIp'`
-> Int	`$sel:warmupPercentage:DedicatedIp'`
-> DedicatedIp

Create a value of DedicatedIp 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:poolName:DedicatedIp', dedicatedIp_poolName - The name of the dedicated IP pool that the IP address is associated with.

$sel:ip:DedicatedIp', dedicatedIp_ip - An IPv4 address.

$sel:warmupStatus:DedicatedIp', dedicatedIp_warmupStatus - The warm-up status of a dedicated IP address. The status can have one of the following values:

IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.
DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

$sel:warmupPercentage:DedicatedIp', dedicatedIp_warmupPercentage - Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

dedicatedIp_poolName :: Lens' DedicatedIp (Maybe Text) Source #

The name of the dedicated IP pool that the IP address is associated with.

dedicatedIp_ip :: Lens' DedicatedIp Text Source #

An IPv4 address.

dedicatedIp_warmupStatus :: Lens' DedicatedIp WarmupStatus Source #

The warm-up status of a dedicated IP address. The status can have one of the following values:

IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.
DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

dedicatedIp_warmupPercentage :: Lens' DedicatedIp Int Source #

Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.