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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.

Synopsis

data UpdatePool = UpdatePool' {
- deletionProtectionEnabled :: Maybe Bool
- optOutListName :: Maybe Text
- selfManagedOptOutsEnabled :: Maybe Bool
- sharedRoutesEnabled :: Maybe Bool
- twoWayChannelArn :: Maybe Text
- twoWayEnabled :: Maybe Bool
- poolId :: Text
}
newUpdatePool :: Text -> UpdatePool
updatePool_deletionProtectionEnabled :: Lens' UpdatePool (Maybe Bool)
updatePool_optOutListName :: Lens' UpdatePool (Maybe Text)
updatePool_selfManagedOptOutsEnabled :: Lens' UpdatePool (Maybe Bool)
updatePool_sharedRoutesEnabled :: Lens' UpdatePool (Maybe Bool)
updatePool_twoWayChannelArn :: Lens' UpdatePool (Maybe Text)
updatePool_twoWayEnabled :: Lens' UpdatePool (Maybe Bool)
updatePool_poolId :: Lens' UpdatePool Text
data UpdatePoolResponse = UpdatePoolResponse' {
- createdTimestamp :: Maybe POSIX
- deletionProtectionEnabled :: Maybe Bool
- messageType :: Maybe MessageType
- optOutListName :: Maybe Text
- poolArn :: Maybe Text
- poolId :: Maybe Text
- selfManagedOptOutsEnabled :: Maybe Bool
- sharedRoutesEnabled :: Maybe Bool
- status :: Maybe PoolStatus
- twoWayChannelArn :: Maybe Text
- twoWayEnabled :: Maybe Bool
- httpStatus :: Int
}
newUpdatePoolResponse :: Int -> UpdatePoolResponse
updatePoolResponse_createdTimestamp :: Lens' UpdatePoolResponse (Maybe UTCTime)
updatePoolResponse_deletionProtectionEnabled :: Lens' UpdatePoolResponse (Maybe Bool)
updatePoolResponse_messageType :: Lens' UpdatePoolResponse (Maybe MessageType)
updatePoolResponse_optOutListName :: Lens' UpdatePoolResponse (Maybe Text)
updatePoolResponse_poolArn :: Lens' UpdatePoolResponse (Maybe Text)
updatePoolResponse_poolId :: Lens' UpdatePoolResponse (Maybe Text)
updatePoolResponse_selfManagedOptOutsEnabled :: Lens' UpdatePoolResponse (Maybe Bool)
updatePoolResponse_sharedRoutesEnabled :: Lens' UpdatePoolResponse (Maybe Bool)
updatePoolResponse_status :: Lens' UpdatePoolResponse (Maybe PoolStatus)
updatePoolResponse_twoWayChannelArn :: Lens' UpdatePoolResponse (Maybe Text)
updatePoolResponse_twoWayEnabled :: Lens' UpdatePoolResponse (Maybe Bool)
updatePoolResponse_httpStatus :: Lens' UpdatePoolResponse Int

Creating a Request

data UpdatePool Source #

See: newUpdatePool smart constructor.

Constructors

UpdatePool'

Fields

deletionProtectionEnabled :: Maybe Bool
When set to true the pool can't be deleted.
optOutListName :: Maybe Text
The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
selfManagedOptOutsEnabled :: Maybe Bool
By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
sharedRoutesEnabled :: Maybe Bool
Indicates whether shared routes are enabled for the pool.
twoWayChannelArn :: Maybe Text
The Amazon Resource Name (ARN) of the two way channel.
twoWayEnabled :: Maybe Bool
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
poolId :: Text
The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

Instances

Instances details

ToJSON UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods toJSON :: UpdatePool -> Value # toEncoding :: UpdatePool -> Encoding # toJSONList :: [UpdatePool] -> Value # toEncodingList :: [UpdatePool] -> Encoding #
ToHeaders UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods toHeaders :: UpdatePool -> [Header] #
ToPath UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods toPath :: UpdatePool -> ByteString #
ToQuery UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods toQuery :: UpdatePool -> QueryString #
AWSRequest UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Associated Types type AWSResponse UpdatePool # Methods request :: (Service -> Service) -> UpdatePool -> Request UpdatePool # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdatePool -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdatePool))) #
Generic UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Associated Types type Rep UpdatePool :: Type -> Type # Methods from :: UpdatePool -> Rep UpdatePool x # to :: Rep UpdatePool x -> UpdatePool #
Read UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods readsPrec :: Int -> ReadS UpdatePool # readList :: ReadS [UpdatePool] # readPrec :: ReadPrec UpdatePool # readListPrec :: ReadPrec [UpdatePool] #
Show UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods showsPrec :: Int -> UpdatePool -> ShowS # show :: UpdatePool -> String # showList :: [UpdatePool] -> ShowS #
NFData UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods rnf :: UpdatePool -> () #
Eq UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods (==) :: UpdatePool -> UpdatePool -> Bool # (/=) :: UpdatePool -> UpdatePool -> Bool #
Hashable UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods hashWithSalt :: Int -> UpdatePool -> Int # hash :: UpdatePool -> Int #
type AWSResponse UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool type AWSResponse UpdatePool = UpdatePoolResponse
type Rep UpdatePool Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool type Rep UpdatePool = D1 ('MetaData "UpdatePool" "Amazonka.PinpointSmsVoiceV2.UpdatePool" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "UpdatePool'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deletionProtectionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "optOutListName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "selfManagedOptOutsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "sharedRoutesEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "twoWayChannelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "twoWayEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "poolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdatePool Source #

Arguments

:: Text	`UpdatePool`
-> UpdatePool

Create a value of UpdatePool 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:

UpdatePool, updatePool_deletionProtectionEnabled - When set to true the pool can't be deleted.

UpdatePool, updatePool_optOutListName - The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

UpdatePool, updatePool_selfManagedOptOutsEnabled - By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

UpdatePool, updatePool_sharedRoutesEnabled - Indicates whether shared routes are enabled for the pool.

UpdatePool, updatePool_twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.

UpdatePool, updatePool_twoWayEnabled - By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

UpdatePool, updatePool_poolId - The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

Request Lenses

updatePool_deletionProtectionEnabled :: Lens' UpdatePool (Maybe Bool) Source #

When set to true the pool can't be deleted.

updatePool_optOutListName :: Lens' UpdatePool (Maybe Text) Source #

The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

updatePool_selfManagedOptOutsEnabled :: Lens' UpdatePool (Maybe Bool) Source #

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

updatePool_sharedRoutesEnabled :: Lens' UpdatePool (Maybe Bool) Source #

Indicates whether shared routes are enabled for the pool.

updatePool_twoWayChannelArn :: Lens' UpdatePool (Maybe Text) Source #

The Amazon Resource Name (ARN) of the two way channel.

updatePool_twoWayEnabled :: Lens' UpdatePool (Maybe Bool) Source #

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

updatePool_poolId :: Lens' UpdatePool Text Source #

The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

Destructuring the Response

data UpdatePoolResponse Source #

See: newUpdatePoolResponse smart constructor.

Constructors

UpdatePoolResponse'

Fields

createdTimestamp :: Maybe POSIX
The time when the pool was created, in UNIX epoch time format.
deletionProtectionEnabled :: Maybe Bool
When set to true the pool can't be deleted.
messageType :: Maybe MessageType
The type of message for the pool to use.
optOutListName :: Maybe Text
The name of the OptOutList associated with the pool.
poolArn :: Maybe Text
The ARN of the pool.
poolId :: Maybe Text
The unique identifier of the pool.
selfManagedOptOutsEnabled :: Maybe Bool
When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
sharedRoutesEnabled :: Maybe Bool
Indicates whether shared routes are enabled for the pool.
status :: Maybe PoolStatus
The current status of the pool update request.
twoWayChannelArn :: Maybe Text
The Amazon Resource Name (ARN) of the two way channel.
twoWayEnabled :: Maybe Bool
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic UpdatePoolResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Associated Types type Rep UpdatePoolResponse :: Type -> Type # Methods from :: UpdatePoolResponse -> Rep UpdatePoolResponse x # to :: Rep UpdatePoolResponse x -> UpdatePoolResponse #
Read UpdatePoolResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods readsPrec :: Int -> ReadS UpdatePoolResponse # readList :: ReadS [UpdatePoolResponse] # readPrec :: ReadPrec UpdatePoolResponse # readListPrec :: ReadPrec [UpdatePoolResponse] #
Show UpdatePoolResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods showsPrec :: Int -> UpdatePoolResponse -> ShowS # show :: UpdatePoolResponse -> String # showList :: [UpdatePoolResponse] -> ShowS #
NFData UpdatePoolResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods rnf :: UpdatePoolResponse -> () #
Eq UpdatePoolResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool Methods (==) :: UpdatePoolResponse -> UpdatePoolResponse -> Bool # (/=) :: UpdatePoolResponse -> UpdatePoolResponse -> Bool #
type Rep UpdatePoolResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.UpdatePool type Rep UpdatePoolResponse = D1 ('MetaData "UpdatePoolResponse" "Amazonka.PinpointSmsVoiceV2.UpdatePool" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "UpdatePoolResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "deletionProtectionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageType)))) :: (S1 ('MetaSel ('Just "optOutListName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "poolArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "poolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "selfManagedOptOutsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "sharedRoutesEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PoolStatus)))) :: (S1 ('MetaSel ('Just "twoWayChannelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "twoWayEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newUpdatePoolResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdatePoolResponse'`
-> UpdatePoolResponse

Create a value of UpdatePoolResponse 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:

UpdatePoolResponse, updatePoolResponse_createdTimestamp - The time when the pool was created, in UNIX epoch time format.

UpdatePool, updatePoolResponse_deletionProtectionEnabled - When set to true the pool can't be deleted.

UpdatePoolResponse, updatePoolResponse_messageType - The type of message for the pool to use.

UpdatePool, updatePoolResponse_optOutListName - The name of the OptOutList associated with the pool.

UpdatePoolResponse, updatePoolResponse_poolArn - The ARN of the pool.

UpdatePool, updatePoolResponse_poolId - The unique identifier of the pool.

UpdatePool, updatePoolResponse_selfManagedOptOutsEnabled - When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

UpdatePool, updatePoolResponse_sharedRoutesEnabled - Indicates whether shared routes are enabled for the pool.

UpdatePoolResponse, updatePoolResponse_status - The current status of the pool update request.

UpdatePool, updatePoolResponse_twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.

UpdatePool, updatePoolResponse_twoWayEnabled - By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

$sel:httpStatus:UpdatePoolResponse', updatePoolResponse_httpStatus - The response's http status code.

Response Lenses

updatePoolResponse_createdTimestamp :: Lens' UpdatePoolResponse (Maybe UTCTime) Source #

The time when the pool was created, in UNIX epoch time format.

updatePoolResponse_deletionProtectionEnabled :: Lens' UpdatePoolResponse (Maybe Bool) Source #

When set to true the pool can't be deleted.

updatePoolResponse_messageType :: Lens' UpdatePoolResponse (Maybe MessageType) Source #

The type of message for the pool to use.

updatePoolResponse_optOutListName :: Lens' UpdatePoolResponse (Maybe Text) Source #

The name of the OptOutList associated with the pool.

updatePoolResponse_poolArn :: Lens' UpdatePoolResponse (Maybe Text) Source #

The ARN of the pool.

updatePoolResponse_poolId :: Lens' UpdatePoolResponse (Maybe Text) Source #

The unique identifier of the pool.

updatePoolResponse_selfManagedOptOutsEnabled :: Lens' UpdatePoolResponse (Maybe Bool) Source #

When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

updatePoolResponse_sharedRoutesEnabled :: Lens' UpdatePoolResponse (Maybe Bool) Source #

Indicates whether shared routes are enabled for the pool.

updatePoolResponse_status :: Lens' UpdatePoolResponse (Maybe PoolStatus) Source #

The current status of the pool update request.

updatePoolResponse_twoWayChannelArn :: Lens' UpdatePoolResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the two way channel.

updatePoolResponse_twoWayEnabled :: Lens' UpdatePoolResponse (Maybe Bool) Source #

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

updatePoolResponse_httpStatus :: Lens' UpdatePoolResponse Int Source #

The response's http status code.