Struct PoolInformation 

#[non_exhaustive]
pub struct PoolInformation {
    pub pool_arn: String,
    pub pool_id: String,
    pub status: PoolStatus,
    pub message_type: MessageType,
    pub two_way_enabled: bool,
    pub two_way_channel_arn: Option<String>,
    pub two_way_channel_role: Option<String>,
    pub self_managed_opt_outs_enabled: bool,
    pub opt_out_list_name: String,
    pub shared_routes_enabled: bool,
    pub deletion_protection_enabled: bool,
    pub created_timestamp: DateTime,
}

The information for a pool in an Amazon Web Services account.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pool_arn: String

The Amazon Resource Name (ARN) for the pool.

pool_id: String

The unique identifier for the pool.

status: PoolStatus

The current status of the pool.

message_type: 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.

two_way_enabled: bool

When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

two_way_channel_arn: Option<String>

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

two_way_channel_role: Option<String>

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

self_managed_opt_outs_enabled: bool

When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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. For more information see Self-managed opt-outs

opt_out_list_name: String

The name of the OptOutList associated with the pool.

shared_routes_enabled: bool

Allows you to enable shared routes on your pool.

By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.

deletion_protection_enabled: bool

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

created_timestamp: DateTime

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

Implementations

impl PoolInformation

pub fn pool_arn(&self) -> &str

The Amazon Resource Name (ARN) for the pool.

pub fn pool_id(&self) -> &str

The unique identifier for the pool.

pub fn status(&self) -> &PoolStatus

The current status of the pool.

pub fn message_type(&self) -> &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.

pub fn two_way_enabled(&self) -> bool

When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

pub fn two_way_channel_arn(&self) -> Option<&str>

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

pub fn two_way_channel_role(&self) -> Option<&str>

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

pub fn self_managed_opt_outs_enabled(&self) -> bool

When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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. For more information see Self-managed opt-outs

pub fn opt_out_list_name(&self) -> &str

The name of the OptOutList associated with the pool.

pub fn shared_routes_enabled(&self) -> bool

Allows you to enable shared routes on your pool.

By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.

pub fn deletion_protection_enabled(&self) -> bool

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

pub fn created_timestamp(&self) -> &DateTime

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

impl PoolInformation

pub fn builder() -> PoolInformationBuilder

Creates a new builder-style object to manufacture PoolInformation.

Trait Implementations

impl Clone for PoolInformation

fn clone(&self) -> PoolInformation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PoolInformation

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

Formats the value using the given formatter.

impl PartialEq for PoolInformation

fn eq(&self, other: &PoolInformation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PoolInformation