Struct aws_sdk_pinpointsmsvoicev2::client::fluent_builders::CreatePool

pub struct CreatePool { /* private fields */ }

Fluent builder constructing a request to CreatePool.

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.

Implementations

impl CreatePool

pub async fn send(self) -> Result<CreatePoolOutput, SdkError<CreatePoolError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn origination_identity(self, input: impl Into<String>) -> Self

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.

pub fn set_origination_identity(self, input: Option<String>) -> Self

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.

pub fn iso_country_code(self, input: impl Into<String>) -> Self

The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.

pub fn set_iso_country_code(self, input: Option<String>) -> Self

The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.

pub fn message_type(self, input: MessageType) -> Self

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.

pub fn set_message_type(self, input: Option<MessageType>) -> Self

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.

pub fn deletion_protection_enabled(self, input: bool) -> Self

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.

pub fn set_deletion_protection_enabled(self, input: Option<bool>) -> Self

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.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

An array of tags (key and value pairs) associated with the pool.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

An array of tags (key and value pairs) associated with the pool.

pub fn client_token(self, input: impl Into<String>) -> Self

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.

pub fn set_client_token(self, input: Option<String>) -> Self

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.

Trait Implementations

impl Clone for CreatePool

fn clone(&self) -> CreatePool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreatePool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.