amazonka-pinpoint-sms-voice-v2-2.0: Amazon Pinpoint SMS Voice V2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.PinpointSmsVoiceV2.DeletePool

Description

Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.

If the pool status isn't active or if deletion protection is enabled, an Error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

Synopsis

Creating a Request

data DeletePool Source #

See: newDeletePool smart constructor.

Constructors

DeletePool' 

Fields

  • poolId :: Text

    The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .

Instances

Instances details
ToJSON DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

toJSON :: DeletePool -> Value #

toEncoding :: DeletePool -> Encoding #

toJSONList :: [DeletePool] -> Value #

toEncodingList :: [DeletePool] -> Encoding #

ToHeaders DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

toHeaders :: DeletePool -> [Header] #

ToPath DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

toPath :: DeletePool -> ByteString #

ToQuery DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

toQuery :: DeletePool -> QueryString #

AWSRequest DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Associated Types

type AWSResponse DeletePool #

Methods

request :: (Service -> Service) -> DeletePool -> Request DeletePool #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeletePool -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeletePool))) #

Generic DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Associated Types

type Rep DeletePool :: Type -> Type #

Methods

from :: DeletePool -> Rep DeletePool x #

to :: Rep DeletePool x -> DeletePool #

Read DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

readsPrec :: Int -> ReadS DeletePool #

readList :: ReadS [DeletePool] #

readPrec :: ReadPrec DeletePool #

readListPrec :: ReadPrec [DeletePool] #

Show DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

showsPrec :: Int -> DeletePool -> ShowS #

show :: DeletePool -> String #

showList :: [DeletePool] -> ShowS #

NFData DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

rnf :: DeletePool -> () #

Eq DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

(==) :: DeletePool -> DeletePool -> Bool #

(/=) :: DeletePool -> DeletePool -> Bool #

Hashable DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

hashWithSalt :: Int -> DeletePool -> Int #

hash :: DeletePool -> Int #

type AWSResponse DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

type AWSResponse DeletePool = DeletePoolResponse
type Rep DeletePool Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

type Rep DeletePool = D1 ('MetaData "DeletePool" "Amazonka.PinpointSmsVoiceV2.DeletePool" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DeletePool'" 'PrefixI 'True) (S1 ('MetaSel ('Just "poolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeletePool Source #

Arguments

:: Text

DeletePool

-> DeletePool 

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

DeletePool, deletePool_poolId - The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .

Request Lenses

deletePool_poolId :: Lens' DeletePool Text Source #

The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .

Destructuring the Response

data DeletePoolResponse Source #

See: newDeletePoolResponse smart constructor.

Constructors

DeletePoolResponse' 

Fields

  • createdTimestamp :: Maybe POSIX

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

  • messageType :: Maybe MessageType

    The message type that was associated with the deleted pool.

  • optOutListName :: Maybe Text

    The name of the OptOutList that was associated with the deleted pool.

  • poolArn :: Maybe Text

    The Amazon Resource Name (ARN) of the pool that was deleted.

  • poolId :: Maybe Text

    The PoolId of the pool that was deleted.

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

  • status :: Maybe PoolStatus

    The current status of the pool.

    • CREATING: The pool is currently being created and isn't yet available for use.
    • ACTIVE: The pool is active and available for use.
    • DELETING: The pool is being deleted.
  • twoWayChannelArn :: Maybe Text

    The Amazon Resource Name (ARN) of the TwoWayChannel.

  • 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 DeletePoolResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Associated Types

type Rep DeletePoolResponse :: Type -> Type #

Methods

from :: DeletePoolResponse -> Rep DeletePoolResponse x #

to :: Rep DeletePoolResponse x -> DeletePoolResponse #

Read DeletePoolResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

readsPrec :: Int -> ReadS DeletePoolResponse #

readList :: ReadS [DeletePoolResponse] #

readPrec :: ReadPrec DeletePoolResponse #

readListPrec :: ReadPrec [DeletePoolResponse] #

Show DeletePoolResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

showsPrec :: Int -> DeletePoolResponse -> ShowS #

show :: DeletePoolResponse -> String #

showList :: [DeletePoolResponse] -> ShowS #

NFData DeletePoolResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

rnf :: DeletePoolResponse -> () #

Eq DeletePoolResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

Methods

(==) :: DeletePoolResponse -> DeletePoolResponse -> Bool #

(/=) :: DeletePoolResponse -> DeletePoolResponse -> Bool #

type Rep DeletePoolResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DeletePool

type Rep DeletePoolResponse = D1 ('MetaData "DeletePoolResponse" "Amazonka.PinpointSmsVoiceV2.DeletePool" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DeletePoolResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: 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))))))

newDeletePoolResponse Source #

Arguments

:: Int

$sel:httpStatus:DeletePoolResponse'

-> DeletePoolResponse 

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

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

DeletePoolResponse, deletePoolResponse_messageType - The message type that was associated with the deleted pool.

DeletePoolResponse, deletePoolResponse_optOutListName - The name of the OptOutList that was associated with the deleted pool.

DeletePoolResponse, deletePoolResponse_poolArn - The Amazon Resource Name (ARN) of the pool that was deleted.

DeletePool, deletePoolResponse_poolId - The PoolId of the pool that was deleted.

DeletePoolResponse, deletePoolResponse_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.

DeletePoolResponse, deletePoolResponse_sharedRoutesEnabled - Indicates whether shared routes are enabled for the pool.

DeletePoolResponse, deletePoolResponse_status - The current status of the pool.

  • CREATING: The pool is currently being created and isn't yet available for use.
  • ACTIVE: The pool is active and available for use.
  • DELETING: The pool is being deleted.

DeletePoolResponse, deletePoolResponse_twoWayChannelArn - The Amazon Resource Name (ARN) of the TwoWayChannel.

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

$sel:httpStatus:DeletePoolResponse', deletePoolResponse_httpStatus - The response's http status code.

Response Lenses

deletePoolResponse_createdTimestamp :: Lens' DeletePoolResponse (Maybe UTCTime) Source #

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

deletePoolResponse_messageType :: Lens' DeletePoolResponse (Maybe MessageType) Source #

The message type that was associated with the deleted pool.

deletePoolResponse_optOutListName :: Lens' DeletePoolResponse (Maybe Text) Source #

The name of the OptOutList that was associated with the deleted pool.

deletePoolResponse_poolArn :: Lens' DeletePoolResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pool that was deleted.

deletePoolResponse_poolId :: Lens' DeletePoolResponse (Maybe Text) Source #

The PoolId of the pool that was deleted.

deletePoolResponse_selfManagedOptOutsEnabled :: Lens' DeletePoolResponse (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.

deletePoolResponse_sharedRoutesEnabled :: Lens' DeletePoolResponse (Maybe Bool) Source #

Indicates whether shared routes are enabled for the pool.

deletePoolResponse_status :: Lens' DeletePoolResponse (Maybe PoolStatus) Source #

The current status of the pool.

  • CREATING: The pool is currently being created and isn't yet available for use.
  • ACTIVE: The pool is active and available for use.
  • DELETING: The pool is being deleted.

deletePoolResponse_twoWayChannelArn :: Lens' DeletePoolResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the TwoWayChannel.

deletePoolResponse_twoWayEnabled :: Lens' DeletePoolResponse (Maybe Bool) Source #

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

deletePoolResponse_httpStatus :: Lens' DeletePoolResponse Int Source #

The response's http status code.