| 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.CreatePool
Description
Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an Error is returned. A sender ID can be associated with multiple pools.
Synopsis
- data CreatePool = CreatePool' {}
- newCreatePool :: Text -> Text -> MessageType -> CreatePool
- createPool_clientToken :: Lens' CreatePool (Maybe Text)
- createPool_deletionProtectionEnabled :: Lens' CreatePool (Maybe Bool)
- createPool_tags :: Lens' CreatePool (Maybe [Tag])
- createPool_originationIdentity :: Lens' CreatePool Text
- createPool_isoCountryCode :: Lens' CreatePool Text
- createPool_messageType :: Lens' CreatePool MessageType
- data CreatePoolResponse = CreatePoolResponse' {
- 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
- tags :: Maybe [Tag]
- twoWayChannelArn :: Maybe Text
- twoWayEnabled :: Maybe Bool
- httpStatus :: Int
- newCreatePoolResponse :: Int -> CreatePoolResponse
- createPoolResponse_createdTimestamp :: Lens' CreatePoolResponse (Maybe UTCTime)
- createPoolResponse_deletionProtectionEnabled :: Lens' CreatePoolResponse (Maybe Bool)
- createPoolResponse_messageType :: Lens' CreatePoolResponse (Maybe MessageType)
- createPoolResponse_optOutListName :: Lens' CreatePoolResponse (Maybe Text)
- createPoolResponse_poolArn :: Lens' CreatePoolResponse (Maybe Text)
- createPoolResponse_poolId :: Lens' CreatePoolResponse (Maybe Text)
- createPoolResponse_selfManagedOptOutsEnabled :: Lens' CreatePoolResponse (Maybe Bool)
- createPoolResponse_sharedRoutesEnabled :: Lens' CreatePoolResponse (Maybe Bool)
- createPoolResponse_status :: Lens' CreatePoolResponse (Maybe PoolStatus)
- createPoolResponse_tags :: Lens' CreatePoolResponse (Maybe [Tag])
- createPoolResponse_twoWayChannelArn :: Lens' CreatePoolResponse (Maybe Text)
- createPoolResponse_twoWayEnabled :: Lens' CreatePoolResponse (Maybe Bool)
- createPoolResponse_httpStatus :: Lens' CreatePoolResponse Int
Creating a Request
data CreatePool Source #
See: newCreatePool smart constructor.
Constructors
| CreatePool' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> MessageType | |
| -> CreatePool |
Create a value of CreatePool 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:clientToken:CreatePool', createPool_clientToken - Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request. If you don't specify a client token, a
randomly generated token is used for the request to ensure idempotency.
CreatePool, createPool_deletionProtectionEnabled - By default this is set to false. When set to true the pool can't be
deleted. You can change this value using the UpdatePool action.
CreatePool, createPool_tags - An array of tags (key and value pairs) associated with the pool.
CreatePool, createPool_originationIdentity - The origination identity to use such as a PhoneNumberId, PhoneNumberArn,
SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the
values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can
be used to get the values for SenderId and SenderIdArn.
CreatePool, createPool_isoCountryCode - The new two-character code, in ISO 3166-1 alpha-2 format, for the
country or region of the new pool.
CreatePool, createPool_messageType - The type of message. Valid values are TRANSACTIONAL for messages that
are critical or time-sensitive and PROMOTIONAL for messages that aren't
critical or time-sensitive.
Request Lenses
createPool_clientToken :: Lens' CreatePool (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
createPool_deletionProtectionEnabled :: Lens' CreatePool (Maybe Bool) Source #
By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.
createPool_tags :: Lens' CreatePool (Maybe [Tag]) Source #
An array of tags (key and value pairs) associated with the pool.
createPool_originationIdentity :: Lens' CreatePool Text Source #
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
createPool_isoCountryCode :: Lens' CreatePool Text Source #
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
createPool_messageType :: Lens' CreatePool MessageType Source #
The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
Destructuring the Response
data CreatePoolResponse Source #
See: newCreatePoolResponse smart constructor.
Constructors
| CreatePoolResponse' | |
Fields
| |
Instances
newCreatePoolResponse Source #
Arguments
| :: Int | |
| -> CreatePoolResponse |
Create a value of CreatePoolResponse 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:
CreatePoolResponse, createPoolResponse_createdTimestamp - The time when the pool was created, in
UNIX epoch time format.
CreatePool, createPoolResponse_deletionProtectionEnabled - When set to true deletion protection is enabled. By default this is set
to false.
CreatePool, createPoolResponse_messageType - The type of message for the pool to use.
CreatePoolResponse, createPoolResponse_optOutListName - The name of the OptOutList associated with the pool.
CreatePoolResponse, createPoolResponse_poolArn - The Amazon Resource Name (ARN) for the pool.
CreatePoolResponse, createPoolResponse_poolId - The unique identifier for the pool.
CreatePoolResponse, createPoolResponse_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.
CreatePoolResponse, createPoolResponse_sharedRoutesEnabled - Indicates whether shared routes are enabled for the pool.
CreatePoolResponse, createPoolResponse_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.
CreatePool, createPoolResponse_tags - An array of tags (key and value pairs) associated with the pool.
CreatePoolResponse, createPoolResponse_twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.
CreatePoolResponse, createPoolResponse_twoWayEnabled - By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
$sel:httpStatus:CreatePoolResponse', createPoolResponse_httpStatus - The response's http status code.
Response Lenses
createPoolResponse_createdTimestamp :: Lens' CreatePoolResponse (Maybe UTCTime) Source #
The time when the pool was created, in UNIX epoch time format.
createPoolResponse_deletionProtectionEnabled :: Lens' CreatePoolResponse (Maybe Bool) Source #
When set to true deletion protection is enabled. By default this is set to false.
createPoolResponse_messageType :: Lens' CreatePoolResponse (Maybe MessageType) Source #
The type of message for the pool to use.
createPoolResponse_optOutListName :: Lens' CreatePoolResponse (Maybe Text) Source #
The name of the OptOutList associated with the pool.
createPoolResponse_poolArn :: Lens' CreatePoolResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) for the pool.
createPoolResponse_poolId :: Lens' CreatePoolResponse (Maybe Text) Source #
The unique identifier for the pool.
createPoolResponse_selfManagedOptOutsEnabled :: Lens' CreatePoolResponse (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.
createPoolResponse_sharedRoutesEnabled :: Lens' CreatePoolResponse (Maybe Bool) Source #
Indicates whether shared routes are enabled for the pool.
createPoolResponse_status :: Lens' CreatePoolResponse (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.
createPoolResponse_tags :: Lens' CreatePoolResponse (Maybe [Tag]) Source #
An array of tags (key and value pairs) associated with the pool.
createPoolResponse_twoWayChannelArn :: Lens' CreatePoolResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the two way channel.
createPoolResponse_twoWayEnabled :: Lens' CreatePoolResponse (Maybe Bool) Source #
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
createPoolResponse_httpStatus :: Lens' CreatePoolResponse Int Source #
The response's http status code.