Struct aws_sdk_pinpointsmsvoicev2::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

Client for Amazon Pinpoint SMS Voice V2

Client for invoking operations on Amazon Pinpoint SMS Voice V2. Each operation on Amazon Pinpoint SMS Voice V2 is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_pinpointsmsvoicev2::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_pinpointsmsvoicev2::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_pinpointsmsvoicev2::Client::from_conf(config);

Implementations

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn associate_origination_identity(&self) -> AssociateOriginationIdentity

Constructs a fluent builder for the AssociateOriginationIdentity operation.

The fluent builder is configurable:
- pool_id(impl Into<String>) / set_pool_id(Option<String>):
 The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.
- origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
 The origination identity to use, such as 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.
- iso_country_code(impl Into<String>) / set_iso_country_code(Option<String>):
 The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 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.
On success, responds with AssociateOriginationIdentityOutput with field(s):
- pool_arn(Option<String>):
 The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.
- pool_id(Option<String>):
 The PoolId of the pool that is now associated with the origination identity.
- origination_identity_arn(Option<String>):
 The PhoneNumberArn or SenderIdArn of the origination identity.
- origination_identity(Option<String>):
 The PhoneNumberId or SenderId of the origination identity.
- iso_country_code(Option<String>):
 The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
On failure, responds with SdkError<AssociateOriginationIdentityError>

source

pub fn create_configuration_set(&self) -> CreateConfigurationSet

Constructs a fluent builder for the CreateConfigurationSet operation.

The fluent builder is configurable:
- configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
 The name to use for the new configuration set.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 An array of key and value pair tags that’s associated with the new configuration set.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 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.
On success, responds with CreateConfigurationSetOutput with field(s):
- configuration_set_arn(Option<String>):
 The Amazon Resource Name (ARN) of the newly created configuration set.
- configuration_set_name(Option<String>):
 The name of the new configuration set.
- tags(Option<Vec<Tag>>):
 An array of key and value pair tags that’s associated with the configuration set.
- created_timestamp(Option<DateTime>):
 The time when the configuration set was created, in UNIX epoch time format.
On failure, responds with SdkError<CreateConfigurationSetError>

source

pub fn create_event_destination(&self) -> CreateEventDestination

Constructs a fluent builder for the CreateEventDestination operation.

The fluent builder is configurable:
- configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
 Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
- event_destination_name(impl Into<String>) / set_event_destination_name(Option<String>):
 The name that identifies the event destination.
- matching_event_types(Vec<EventType>) / set_matching_event_types(Option<Vec<EventType>>):
 An array of event types that determine which events to log. If “ALL” is used, then Amazon Pinpoint logs every event type.
- cloud_watch_logs_destination(CloudWatchLogsDestination) / set_cloud_watch_logs_destination(Option<CloudWatchLogsDestination>):
 An object that contains information about an event destination for logging to Amazon CloudWatch logs.
- kinesis_firehose_destination(KinesisFirehoseDestination) / set_kinesis_firehose_destination(Option<KinesisFirehoseDestination>):
 An object that contains information about an event destination for logging to Amazon Kinesis Data Firehose.
- sns_destination(SnsDestination) / set_sns_destination(Option<SnsDestination>):
 An object that contains information about an event destination for logging to Amazon SNS.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 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.
On success, responds with CreateEventDestinationOutput with field(s):
- configuration_set_arn(Option<String>):
 The ARN of the configuration set.
- configuration_set_name(Option<String>):
 The name of the configuration set.
- event_destination(Option<EventDestination>):
 The details of the destination where events are logged.
On failure, responds with SdkError<CreateEventDestinationError>

source

pub fn create_opt_out_list(&self) -> CreateOptOutList

Constructs a fluent builder for the CreateOptOutList operation.

The fluent builder is configurable:
- opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
 The name of the new OptOutList.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 An array of tags (key and value pairs) to associate with the new OptOutList.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 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.
On success, responds with CreateOptOutListOutput with field(s):
- opt_out_list_arn(Option<String>):
 The Amazon Resource Name (ARN) for the OptOutList.
- opt_out_list_name(Option<String>):
 The name of the new OptOutList.
- tags(Option<Vec<Tag>>):
 An array of tags (key and value pairs) associated with the new OptOutList.
- created_timestamp(Option<DateTime>):
 The time when the pool was created, in UNIX epoch time format.
On failure, responds with SdkError<CreateOptOutListError>

source

pub fn create_pool(&self) -> CreatePool

Constructs a fluent builder for the CreatePool operation.

The fluent builder is configurable:
- origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
 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.
- iso_country_code(impl Into<String>) / set_iso_country_code(Option<String>):
 The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
- message_type(MessageType) / set_message_type(Option<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.
- deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
 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.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 An array of tags (key and value pairs) associated with the pool.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 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.
On success, responds with CreatePoolOutput with field(s):
- pool_arn(Option<String>):
 The Amazon Resource Name (ARN) for the pool.
- pool_id(Option<String>):
 The unique identifier for the pool.
- status(Option<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.
- message_type(Option<MessageType>):
 The type of message for the pool to use.
- two_way_enabled(bool):
 By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- two_way_channel_arn(Option<String>):
 The Amazon Resource Name (ARN) of the two way channel.
- self_managed_opt_outs_enabled(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.
- opt_out_list_name(Option<String>):
 The name of the OptOutList associated with the pool.
- shared_routes_enabled(bool):
 Indicates whether shared routes are enabled for the pool.
- deletion_protection_enabled(bool):
 When set to true deletion protection is enabled. By default this is set to false.
- tags(Option<Vec<Tag>>):
 An array of tags (key and value pairs) associated with the pool.
- created_timestamp(Option<DateTime>):
 The time when the pool was created, in UNIX epoch time format.
On failure, responds with SdkError<CreatePoolError>

source

pub fn delete_configuration_set(&self) -> DeleteConfigurationSet

Constructs a fluent builder for the DeleteConfigurationSet operation.

The fluent builder is configurable:
- configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
 The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
On success, responds with DeleteConfigurationSetOutput with field(s):
- configuration_set_arn(Option<String>):
 The Amazon Resource Name (ARN) of the deleted configuration set.
- configuration_set_name(Option<String>):
 The name of the deleted configuration set.
- event_destinations(Option<Vec<EventDestination>>):
 An array of any EventDestination objects that were associated with the deleted configuration set.
- default_message_type(Option<MessageType>):
 The default message type of the configuration set that was deleted.
- default_sender_id(Option<String>):
 The default Sender ID of the configuration set that was deleted.
- created_timestamp(Option<DateTime>):
 The time that the deleted configuration set was created in UNIX epoch time format.
On failure, responds with SdkError<DeleteConfigurationSetError>

source

pub fn delete_default_message_type(&self) -> DeleteDefaultMessageType

Constructs a fluent builder for the DeleteDefaultMessageType operation.

The fluent builder is configurable:
- configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
 The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
On success, responds with DeleteDefaultMessageTypeOutput with field(s):
- configuration_set_arn(Option<String>):
 The Amazon Resource Name (ARN) of the configuration set.
- configuration_set_name(Option<String>):
 The name of the configuration set.
- message_type(Option<MessageType>):
 The current message type for the configuration set.
On failure, responds with SdkError<DeleteDefaultMessageTypeError>

source

pub fn delete_default_sender_id(&self) -> DeleteDefaultSenderId

Constructs a fluent builder for the DeleteDefaultSenderId operation.

The fluent builder is configurable:
- configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
 The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
On success, responds with DeleteDefaultSenderIdOutput with field(s):
- configuration_set_arn(Option<String>):
 The Amazon Resource Name (ARN) of the configuration set.
- configuration_set_name(Option<String>):
 The name of the configuration set.
- sender_id(Option<String>):
 The current sender ID for the configuration set.
On failure, responds with SdkError<DeleteDefaultSenderIdError>

source

pub fn delete_event_destination(&self) -> DeleteEventDestination

Constructs a fluent builder for the DeleteEventDestination operation.

The fluent builder is configurable:
- configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
 The name of the configuration set or the configuration set’s Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
- event_destination_name(impl Into<String>) / set_event_destination_name(Option<String>):
 The name of the event destination to delete.
On success, responds with DeleteEventDestinationOutput with field(s):
- configuration_set_arn(Option<String>):
 The Amazon Resource Name (ARN) of the configuration set.
- configuration_set_name(Option<String>):
 The name of the configuration set the event destination was deleted from.
- event_destination(Option<EventDestination>):
 The event destination object that was deleted.
On failure, responds with SdkError<DeleteEventDestinationError>

source

pub fn delete_keyword(&self) -> DeleteKeyword

Constructs a fluent builder for the DeleteKeyword operation.

The fluent builder is configurable:
- origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
 The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.
- keyword(impl Into<String>) / set_keyword(Option<String>):
 The keyword to delete.
On success, responds with DeleteKeywordOutput with field(s):
- origination_identity_arn(Option<String>):
 The PhoneNumberArn or PoolArn that the keyword was associated with.
- origination_identity(Option<String>):
 The PhoneNumberId or PoolId that the keyword was associated with.
- keyword(Option<String>):
 The keyword that was deleted.
- keyword_message(Option<String>):
 The message that was associated with the deleted keyword.
- keyword_action(Option<KeywordAction>):
 The action that was associated with the deleted keyword.
On failure, responds with SdkError<DeleteKeywordError>

source

pub fn delete_opted_out_number(&self) -> DeleteOptedOutNumber

Constructs a fluent builder for the DeleteOptedOutNumber operation.

The fluent builder is configurable:
- opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
 The OptOutListName or OptOutListArn to remove the phone number from.
- opted_out_number(impl Into<String>) / set_opted_out_number(Option<String>):
 The phone number, in E.164 format, to remove from the OptOutList.
On success, responds with DeleteOptedOutNumberOutput with field(s):
- opt_out_list_arn(Option<String>):
 The OptOutListArn that the phone number was removed from.
- opt_out_list_name(Option<String>):
 The OptOutListName that the phone number was removed from.
- opted_out_number(Option<String>):
 The phone number that was removed from the OptOutList.
- opted_out_timestamp(Option<DateTime>):
 The time that the number was removed at, in UNIX epoch time format.
- end_user_opted_out(bool):
 This is true if it was the end user who requested their phone number be removed.
On failure, responds with SdkError<DeleteOptedOutNumberError>

source

pub fn delete_opt_out_list(&self) -> DeleteOptOutList

Constructs a fluent builder for the DeleteOptOutList operation.

The fluent builder is configurable:
- opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
 The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
On success, responds with DeleteOptOutListOutput with field(s):
- opt_out_list_arn(Option<String>):
 The Amazon Resource Name (ARN) of the OptOutList that was removed.
- opt_out_list_name(Option<String>):
 The name of the OptOutList that was removed.
- created_timestamp(Option<DateTime>):
 The time when the OptOutList was created, in UNIX epoch time format.
On failure, responds with SdkError<DeleteOptOutListError>

source

pub fn delete_pool(&self) -> DeletePool

Constructs a fluent builder for the DeletePool operation.

The fluent builder is configurable:
- pool_id(impl Into<String>) / set_pool_id(Option<String>):
 The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
On success, responds with DeletePoolOutput with field(s):
- pool_arn(Option<String>):
 The Amazon Resource Name (ARN) of the pool that was deleted.
- pool_id(Option<String>):
 The PoolId of the pool that was deleted.
- status(Option<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.
- message_type(Option<MessageType>):
 The message type that was associated with the deleted pool.
- two_way_enabled(bool):
 By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- two_way_channel_arn(Option<String>):
 The Amazon Resource Name (ARN) of the TwoWayChannel.
- self_managed_opt_outs_enabled(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.
- opt_out_list_name(Option<String>):
 The name of the OptOutList that was associated with the deleted pool.
- shared_routes_enabled(bool):
 Indicates whether shared routes are enabled for the pool.
- created_timestamp(Option<DateTime>):
 The time when the pool was created, in UNIX epoch time format.
On failure, responds with SdkError<DeletePoolError>

source

pub fn delete_text_message_spend_limit_override(
&self
) -> DeleteTextMessageSpendLimitOverride

Constructs a fluent builder for the DeleteTextMessageSpendLimitOverride operation.

The fluent builder takes no input, just send it.
On success, responds with DeleteTextMessageSpendLimitOverrideOutput with field(s):
- monthly_limit(Option<i64>):
 The current monthly limit, in US dollars.
On failure, responds with SdkError<DeleteTextMessageSpendLimitOverrideError>

source

pub fn delete_voice_message_spend_limit_override(
&self
) -> DeleteVoiceMessageSpendLimitOverride

Constructs a fluent builder for the DeleteVoiceMessageSpendLimitOverride operation.

The fluent builder takes no input, just send it.
On success, responds with DeleteVoiceMessageSpendLimitOverrideOutput with field(s):
- monthly_limit(Option<i64>):
 The current monthly limit, in US dollars.
On failure, responds with SdkError<DeleteVoiceMessageSpendLimitOverrideError>

source

pub fn describe_account_attributes(&self) -> DescribeAccountAttributes

Constructs a fluent builder for the DescribeAccountAttributes operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per each request.
On success, responds with DescribeAccountAttributesOutput with field(s):
- account_attributes(Option<Vec<AccountAttribute>>):
 An array of AccountAttributes objects.
- next_token(Option<String>):
 The token to be used for the next set of paginated results. If this field is empty then there are no more results.
On failure, responds with SdkError<DescribeAccountAttributesError>

source

pub fn describe_account_limits(&self) -> DescribeAccountLimits

Constructs a fluent builder for the DescribeAccountLimits operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per each request.
On success, responds with DescribeAccountLimitsOutput with field(s):
- account_limits(Option<Vec<AccountLimit>>):
 An array of AccountLimit objects that show the current spend limits.
- next_token(Option<String>):
 The token to be used for the next set of paginated results. If this field is empty then there are no more results.
On failure, responds with SdkError<DescribeAccountLimitsError>

source

pub fn describe_configuration_sets(&self) -> DescribeConfigurationSets

Constructs a fluent builder for the DescribeConfigurationSets operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- configuration_set_names(Vec<String>) / set_configuration_set_names(Option<Vec<String>>):
 An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
- filters(Vec<ConfigurationSetFilter>) / set_filters(Option<Vec<ConfigurationSetFilter>>):
 An array of filters to apply to the results that are returned.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per each request.
On success, responds with DescribeConfigurationSetsOutput with field(s):
- configuration_sets(Option<Vec<ConfigurationSetInformation>>):
 An array of ConfigurationSets objects.
- next_token(Option<String>):
 The token to be used for the next set of paginated results. If this field is empty then there are no more results.
On failure, responds with SdkError<DescribeConfigurationSetsError>

source

pub fn describe_keywords(&self) -> DescribeKeywords

Constructs a fluent builder for the DescribeKeywords operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
 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.
- keywords(Vec<String>) / set_keywords(Option<Vec<String>>):
 An array of keywords to search for.
- filters(Vec<KeywordFilter>) / set_filters(Option<Vec<KeywordFilter>>):
 An array of keyword filters to filter the results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per each request.
On success, responds with DescribeKeywordsOutput with field(s):
- origination_identity_arn(Option<String>):
 The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
- origination_identity(Option<String>):
 The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
- keywords(Option<Vec<KeywordInformation>>):
 An array of KeywordInformation objects that contain the results.
- next_token(Option<String>):
 The token to be used for the next set of paginated results. If this field is empty then there are no more results.
On failure, responds with SdkError<DescribeKeywordsError>

source

pub fn describe_opted_out_numbers(&self) -> DescribeOptedOutNumbers

Constructs a fluent builder for the DescribeOptedOutNumbers operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
 The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
- opted_out_numbers(Vec<String>) / set_opted_out_numbers(Option<Vec<String>>):
 An array of phone numbers to search for in the OptOutList.
- filters(Vec<OptedOutFilter>) / set_filters(Option<Vec<OptedOutFilter>>):
 An array of OptedOutFilter objects to filter the results on.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per each request.
On success, responds with DescribeOptedOutNumbersOutput with field(s):
- opt_out_list_arn(Option<String>):
 The Amazon Resource Name (ARN) of the OptOutList.
- opt_out_list_name(Option<String>):
 The name of the OptOutList.
- opted_out_numbers(Option<Vec<OptedOutNumberInformation>>):
 An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
- next_token(Option<String>):
 The token to be used for the next set of paginated results. If this field is empty then there are no more results.
On failure, responds with SdkError<DescribeOptedOutNumbersError>

source

pub fn describe_opt_out_lists(&self) -> DescribeOptOutLists

Constructs a fluent builder for the DescribeOptOutLists operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- opt_out_list_names(Vec<String>) / set_opt_out_list_names(Option<Vec<String>>):
 The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per each request.
On success, responds with DescribeOptOutListsOutput with field(s):
- opt_out_lists(Option<Vec<OptOutListInformation>>):
 An array of OptOutListInformation objects that contain the details for the requested OptOutLists.
- next_token(Option<String>):
 The token to be used for the next set of paginated results. If this field is empty then there are no more results.
On failure, responds with SdkError<DescribeOptOutListsError>

source

pub fn describe_phone_numbers(&self) -> DescribePhoneNumbers

Constructs a fluent builder for the DescribePhoneNumbers operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- phone_number_ids(Vec<String>) / set_phone_number_ids(Option<Vec<String>>):
 The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
- filters(Vec<PhoneNumberFilter>) / set_filters(Option<Vec<PhoneNumberFilter>>):
 An array of PhoneNumberFilter objects to filter the results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per each request.
On success, responds with DescribePhoneNumbersOutput with field(s):
- phone_numbers(Option<Vec<PhoneNumberInformation>>):
 An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.
- next_token(Option<String>):
 The token to be used for the next set of paginated results. If this field is empty then there are no more results.
On failure, responds with SdkError<DescribePhoneNumbersError>

source

pub fn describe_pools(&self) -> DescribePools

Constructs a fluent builder for the DescribePools operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- pool_ids(Vec<String>) / set_pool_ids(Option<Vec<String>>):
 The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
- filters(Vec<PoolFilter>) / set_filters(Option<Vec<PoolFilter>>):
 An array of PoolFilter objects to filter the results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per each request.
On success, responds with DescribePoolsOutput with field(s):
- pools(Option<Vec<PoolInformation>>):
 An array of PoolInformation objects that contain the details for the requested pools.
- next_token(Option<String>):
 The token to be used for the next set of paginated results. If this field is empty then there are no more results.
On failure, responds with SdkError<DescribePoolsError>

source

pub fn describe_sender_ids(&self) -> DescribeSenderIds

Constructs a fluent builder for the DescribeSenderIds operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- sender_ids(Vec<SenderIdAndCountry>) / set_sender_ids(Option<Vec<SenderIdAndCountry>>):
 An array of SenderIdAndCountry objects to search for.
- filters(Vec<SenderIdFilter>) / set_filters(Option<Vec<SenderIdFilter>>):
 An array of SenderIdFilter objects to filter the results.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per each request.
On success, responds with DescribeSenderIdsOutput with field(s):
- sender_ids(Option<Vec<SenderIdInformation>>):
 An array of SernderIdInformation objects that contain the details for the requested SenderIds.
- next_token(Option<String>):
 The token to be used for the next set of paginated results. If this field is empty then there are no more results.
On failure, responds with SdkError<DescribeSenderIdsError>

source

pub fn describe_spend_limits(&self) -> DescribeSpendLimits

Constructs a fluent builder for the DescribeSpendLimits operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per each request.
On success, responds with DescribeSpendLimitsOutput with field(s):
- spend_limits(Option<Vec<SpendLimit>>):
 An array of SpendLimit objects that contain the details for the requested spend limits.
- next_token(Option<String>):
 The token to be used for the next set of paginated results. If this field is empty then there are no more results.
On failure, responds with SdkError<DescribeSpendLimitsError>

source

pub fn disassociate_origination_identity(
&self
) -> DisassociateOriginationIdentity

Constructs a fluent builder for the DisassociateOriginationIdentity operation.

The fluent builder is configurable:
- pool_id(impl Into<String>) / set_pool_id(Option<String>):
 The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
- origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
 The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.
- iso_country_code(impl Into<String>) / set_iso_country_code(Option<String>):
 The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 Unique, case-sensitive identifier 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.
On success, responds with DisassociateOriginationIdentityOutput with field(s):
- pool_arn(Option<String>):
 The Amazon Resource Name (ARN) of the pool.
- pool_id(Option<String>):
 The PoolId of the pool no longer associated with the origination identity.
- origination_identity_arn(Option<String>):
 The PhoneNumberArn or SenderIdArn of the origination identity.
- origination_identity(Option<String>):
 The PhoneNumberId or SenderId of the origination identity.
- iso_country_code(Option<String>):
 The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
On failure, responds with SdkError<DisassociateOriginationIdentityError>

source

pub fn list_pool_origination_identities(&self) -> ListPoolOriginationIdentities

Constructs a fluent builder for the ListPoolOriginationIdentities operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- pool_id(impl Into<String>) / set_pool_id(Option<String>):
 The unique identifier for the pool. This value can be either the PoolId or PoolArn.
- filters(Vec<PoolOriginationIdentitiesFilter>) / set_filters(Option<Vec<PoolOriginationIdentitiesFilter>>):
 An array of PoolOriginationIdentitiesFilter objects to filter the results..
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results to return per each request.
On success, responds with ListPoolOriginationIdentitiesOutput with field(s):
- pool_arn(Option<String>):
 The Amazon Resource Name (ARN) for the pool.
- pool_id(Option<String>):
 The unique PoolId of the pool.
- origination_identities(Option<Vec<OriginationIdentityMetadata>>):
 An array of any OriginationIdentityMetadata objects.
- next_token(Option<String>):
 The token to be used for the next set of paginated results. If this field is empty then there are no more results.
On failure, responds with SdkError<ListPoolOriginationIdentitiesError>

source

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the resource to query for.
On success, responds with ListTagsForResourceOutput with field(s):
- resource_arn(Option<String>):
 The ARN of the resource.
- tags(Option<Vec<Tag>>):
 An array of key and value pair tags that are associated with the resource.
On failure, responds with SdkError<ListTagsForResourceError>

source

pub fn put_keyword(&self) -> PutKeyword

Constructs a fluent builder for the PutKeyword operation.

The fluent builder is configurable:
- origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
 The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
- keyword(impl Into<String>) / set_keyword(Option<String>):
 The new keyword to add.
- keyword_message(impl Into<String>) / set_keyword_message(Option<String>):
 The message associated with the keyword.
 - AUTOMATIC_RESPONSE: A message is sent to the recipient.
 - OPT_OUT: Keeps the recipient from receiving future messages.
 - OPT_IN: The recipient wants to receive future messages.
- keyword_action(KeywordAction) / set_keyword_action(Option<KeywordAction>):
 The action to perform for the new keyword when it is received.
On success, responds with PutKeywordOutput with field(s):
- origination_identity_arn(Option<String>):
 The PhoneNumberArn or PoolArn that the keyword was associated with.
- origination_identity(Option<String>):
 The PhoneNumberId or PoolId that the keyword was associated with.
- keyword(Option<String>):
 The keyword that was added.
- keyword_message(Option<String>):
 The message associated with the keyword.
- keyword_action(Option<KeywordAction>):
 The action to perform when the keyword is used.
On failure, responds with SdkError<PutKeywordError>

source

pub fn put_opted_out_number(&self) -> PutOptedOutNumber

Constructs a fluent builder for the PutOptedOutNumber operation.

The fluent builder is configurable:
- opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
 The OptOutListName or OptOutListArn to add the phone number to.
- opted_out_number(impl Into<String>) / set_opted_out_number(Option<String>):
 The phone number to add to the OptOutList in E.164 format.
On success, responds with PutOptedOutNumberOutput with field(s):
- opt_out_list_arn(Option<String>):
 The OptOutListArn that the phone number was removed from.
- opt_out_list_name(Option<String>):
 The OptOutListName that the phone number was removed from.
- opted_out_number(Option<String>):
 The phone number that was added to the OptOutList.
- opted_out_timestamp(Option<DateTime>):
 The time that the phone number was added to the OptOutList, in UNIX epoch time format.
- end_user_opted_out(bool):
 This is true if it was the end user who requested their phone number be removed.
On failure, responds with SdkError<PutOptedOutNumberError>

source

pub fn release_phone_number(&self) -> ReleasePhoneNumber

Constructs a fluent builder for the ReleasePhoneNumber operation.

The fluent builder is configurable:
- phone_number_id(impl Into<String>) / set_phone_number_id(Option<String>):
 The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
On success, responds with ReleasePhoneNumberOutput with field(s):
- phone_number_arn(Option<String>):
 The PhoneNumberArn of the phone number that was released.
- phone_number_id(Option<String>):
 The PhoneNumberId of the phone number that was released.
- phone_number(Option<String>):
 The phone number that was released.
- status(Option<NumberStatus>):
 The current status of the request.
- iso_country_code(Option<String>):
 The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- message_type(Option<MessageType>):
 The message type that was associated with the phone number.
- number_capabilities(Option<Vec<NumberCapability>>):
 Specifies if the number could be used for text messages, voice, or both.
- number_type(Option<NumberType>):
 The type of number that was released.
- monthly_leasing_price(Option<String>):
 The monthly price of the phone number, in US dollars.
- two_way_enabled(bool):
 By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- two_way_channel_arn(Option<String>):
 The Amazon Resource Name (ARN) of the TwoWayChannel.
- self_managed_opt_outs_enabled(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.
- opt_out_list_name(Option<String>):
 The name of the OptOutList that was associated with the phone number.
- created_timestamp(Option<DateTime>):
 The time when the phone number was created, in UNIX epoch time format.
On failure, responds with SdkError<ReleasePhoneNumberError>

source

pub fn request_phone_number(&self) -> RequestPhoneNumber

Constructs a fluent builder for the RequestPhoneNumber operation.

The fluent builder is configurable:
- iso_country_code(impl Into<String>) / set_iso_country_code(Option<String>):
 The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- message_type(MessageType) / set_message_type(Option<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.
- number_capabilities(Vec<NumberCapability>) / set_number_capabilities(Option<Vec<NumberCapability>>):
 Indicates if the phone number will be used for text messages, voice messages, or both.
- number_type(RequestableNumberType) / set_number_type(Option<RequestableNumberType>):
 The type of phone number to request.
- opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
 The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.
- pool_id(impl Into<String>) / set_pool_id(Option<String>):
 The pool to associated with the phone number. You can use the PoolId or PoolArn.
- registration_id(impl Into<String>) / set_registration_id(Option<String>):
 Use this field to attach your phone number for an external registration process.
- deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
 By default this is set to false. When set to true the phone number can’t be deleted.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 An array of tags (key and value pairs) associate with the requested phone number.
- client_token(impl Into<String>) / set_client_token(Option<String>):
 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.
On success, responds with RequestPhoneNumberOutput with field(s):
- phone_number_arn(Option<String>):
 The Amazon Resource Name (ARN) of the requested phone number.
- phone_number_id(Option<String>):
 The unique identifier of the new phone number.
- phone_number(Option<String>):
 The new phone number that was requested.
- status(Option<NumberStatus>):
 The current status of the request.
- iso_country_code(Option<String>):
 The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- message_type(Option<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.
- number_capabilities(Option<Vec<NumberCapability>>):
 Indicates if the phone number will be used for text messages, voice messages or both.
- number_type(Option<RequestableNumberType>):
 The type of number that was released.
- monthly_leasing_price(Option<String>):
 The monthly price, in US dollars, to lease the phone number.
- two_way_enabled(bool):
 By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- two_way_channel_arn(Option<String>):
 The ARN used to identify the two way channel.
- self_managed_opt_outs_enabled(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.
- opt_out_list_name(Option<String>):
 The name of the OptOutList that is associated with the requested phone number.
- deletion_protection_enabled(bool):
 By default this is set to false. When set to true the phone number can’t be deleted.
- pool_id(Option<String>):
 The unique identifier of the pool associated with the phone number
- tags(Option<Vec<Tag>>):
 An array of key and value pair tags that are associated with the phone number.
- created_timestamp(Option<DateTime>):
 The time when the phone number was created, in UNIX epoch time format.
On failure, responds with SdkError<RequestPhoneNumberError>

source

pub fn send_text_message(&self) -> SendTextMessage

Constructs a fluent builder for the SendTextMessage operation.

The fluent builder is configurable:
- destination_phone_number(impl Into<String>) / set_destination_phone_number(Option<String>):
 The destination phone number in E.164 format.
- origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
 The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
- message_body(impl Into<String>) / set_message_body(Option<String>):
 The body of the text message.
- message_type(MessageType) / set_message_type(Option<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.
- keyword(impl Into<String>) / set_keyword(Option<String>):
 When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
- configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
 The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
- max_price(impl Into<String>) / set_max_price(Option<String>):
 The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
- time_to_live(i32) / set_time_to_live(Option<i32>):
 How long the text message is valid for. By default this is 72 hours.
- context(HashMap<String, String>) / set_context(Option<HashMap<String, String>>):
 You can specify custom data in this field. If you do, that data is logged to the event destination.
- destination_country_parameters(HashMap<DestinationCountryParameterKey, String>) / set_destination_country_parameters(Option<HashMap<DestinationCountryParameterKey, String>>):
 This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
- dry_run(bool) / set_dry_run(bool):
 When set to true, the message is checked and validated, but isn’t sent to the end recipient.
On success, responds with SendTextMessageOutput with field(s):
- message_id(Option<String>):
 The unique identifier for the message.
On failure, responds with SdkError<SendTextMessageError>

source

pub fn send_voice_message(&self) -> SendVoiceMessage

Constructs a fluent builder for the SendVoiceMessage operation.

The fluent builder is configurable:
- destination_phone_number(impl Into<String>) / set_destination_phone_number(Option<String>):
 The destination phone number in E.164 format.
- origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
 The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
- message_body(impl Into<String>) / set_message_body(Option<String>):
 The text to convert to a voice message.
- message_body_text_type(VoiceMessageBodyTextType) / set_message_body_text_type(Option<VoiceMessageBodyTextType>):
 Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
 - TEXT: This is the default value. When used the maximum character limit is 3000.
 - SSML: When used the maximum character limit is 6000 including SSML tagging.
- voice_id(VoiceId) / set_voice_id(Option<VoiceId>):
 The voice for the Amazon Polly service to use. By default this is set to “MATTHEW”.
- configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
 The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
- max_price_per_minute(impl Into<String>) / set_max_price_per_minute(Option<String>):
 The maximum amount to spend per voice message, in US dollars.
- time_to_live(i32) / set_time_to_live(Option<i32>):
 How long the voice message is valid for. By default this is 72 hours.
- context(HashMap<String, String>) / set_context(Option<HashMap<String, String>>):
 You can specify custom data in this field. If you do, that data is logged to the event destination.
- dry_run(bool) / set_dry_run(bool):
 When set to true, the message is checked and validated, but isn’t sent to the end recipient.
On success, responds with SendVoiceMessageOutput with field(s):
- message_id(Option<String>):
 The unique identifier for the message.
On failure, responds with SdkError<SendVoiceMessageError>

source

pub fn set_default_message_type(&self) -> SetDefaultMessageType

Constructs a fluent builder for the SetDefaultMessageType operation.

The fluent builder is configurable:
- configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
 The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.
- message_type(MessageType) / set_message_type(Option<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.
On success, responds with SetDefaultMessageTypeOutput with field(s):
- configuration_set_arn(Option<String>):
 The Amazon Resource Name (ARN) of the updated configuration set.
- configuration_set_name(Option<String>):
 The name of the configuration set that was updated.
- message_type(Option<MessageType>):
 The new default message type of the configuration set.
On failure, responds with SdkError<SetDefaultMessageTypeError>

source

pub fn set_default_sender_id(&self) -> SetDefaultSenderId

Constructs a fluent builder for the SetDefaultSenderId operation.

The fluent builder is configurable:
- configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
 The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.
- sender_id(impl Into<String>) / set_sender_id(Option<String>):
 The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as ‘NOTICE’.
On success, responds with SetDefaultSenderIdOutput with field(s):
- configuration_set_arn(Option<String>):
 The Amazon Resource Name (ARN) of the updated configuration set.
- configuration_set_name(Option<String>):
 The name of the configuration set that was updated.
- sender_id(Option<String>):
 The default sender ID to set for the ConfigurationSet.
On failure, responds with SdkError<SetDefaultSenderIdError>

source

pub fn set_text_message_spend_limit_override(
&self
) -> SetTextMessageSpendLimitOverride

Constructs a fluent builder for the SetTextMessageSpendLimitOverride operation.

The fluent builder is configurable:
- monthly_limit(i64) / set_monthly_limit(Option<i64>):
 The new monthly limit to enforce on text messages.
On success, responds with SetTextMessageSpendLimitOverrideOutput with field(s):
- monthly_limit(Option<i64>):
 The current monthly limit to enforce on sending text messages.
On failure, responds with SdkError<SetTextMessageSpendLimitOverrideError>

source

pub fn set_voice_message_spend_limit_override(
&self
) -> SetVoiceMessageSpendLimitOverride

Constructs a fluent builder for the SetVoiceMessageSpendLimitOverride operation.

The fluent builder is configurable:
- monthly_limit(i64) / set_monthly_limit(Option<i64>):
 The new monthly limit to enforce on voice messages.
On success, responds with SetVoiceMessageSpendLimitOverrideOutput with field(s):
- monthly_limit(Option<i64>):
 The current monthly limit to enforce on sending voice messages.
On failure, responds with SdkError<SetVoiceMessageSpendLimitOverrideError>

source

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the resource.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 An array of key and value pair tags that are associated with the resource.
On success, responds with TagResourceOutput
On failure, responds with SdkError<TagResourceError>

source

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the resource.
- tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):
 An array of tag key values to unassociate with the resource.
On success, responds with UntagResourceOutput
On failure, responds with SdkError<UntagResourceError>

source

pub fn update_event_destination(&self) -> UpdateEventDestination

Constructs a fluent builder for the UpdateEventDestination operation.

The fluent builder is configurable:
- configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
 The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.
- event_destination_name(impl Into<String>) / set_event_destination_name(Option<String>):
 The name to use for the event destination.
- enabled(bool) / set_enabled(Option<bool>):
 When set to true logging is enabled.
- matching_event_types(Vec<EventType>) / set_matching_event_types(Option<Vec<EventType>>):
 An array of event types that determine which events to log.
- cloud_watch_logs_destination(CloudWatchLogsDestination) / set_cloud_watch_logs_destination(Option<CloudWatchLogsDestination>):
 An object that contains information about an event destination that sends data to CloudWatch Logs.
- kinesis_firehose_destination(KinesisFirehoseDestination) / set_kinesis_firehose_destination(Option<KinesisFirehoseDestination>):
 An object that contains information about an event destination for logging to Kinesis Data Firehose.
- sns_destination(SnsDestination) / set_sns_destination(Option<SnsDestination>):
 An object that contains information about an event destination that sends data to Amazon SNS.
On success, responds with UpdateEventDestinationOutput with field(s):
- configuration_set_arn(Option<String>):
 The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
- configuration_set_name(Option<String>):
 The name of the configuration set.
- event_destination(Option<EventDestination>):
 An EventDestination object containing the details of where events will be logged.
On failure, responds with SdkError<UpdateEventDestinationError>

source

pub fn update_phone_number(&self) -> UpdatePhoneNumber

Constructs a fluent builder for the UpdatePhoneNumber operation.

The fluent builder is configurable:
- phone_number_id(impl Into<String>) / set_phone_number_id(Option<String>):
 The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
- two_way_enabled(bool) / set_two_way_enabled(Option<bool>):
 By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- two_way_channel_arn(impl Into<String>) / set_two_way_channel_arn(Option<String>):
 The Amazon Resource Name (ARN) of the two way channel.
- self_managed_opt_outs_enabled(bool) / set_self_managed_opt_outs_enabled(Option<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.
- opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
 The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
- deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
 By default this is set to false. When set to true the phone number can’t be deleted.
On success, responds with UpdatePhoneNumberOutput with field(s):
- phone_number_arn(Option<String>):
 The Amazon Resource Name (ARN) of the updated phone number.
- phone_number_id(Option<String>):
 The unique identifier of the phone number.
- phone_number(Option<String>):
 The phone number that was updated.
- status(Option<NumberStatus>):
 The current status of the request.
- iso_country_code(Option<String>):
 The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
- message_type(Option<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.
- number_capabilities(Option<Vec<NumberCapability>>):
 Specifies if the number could be used for text messages, voice or both.
- number_type(Option<NumberType>):
 The type of number that was requested.
- monthly_leasing_price(Option<String>):
 The monthly leasing price of the phone number, in US dollars.
- two_way_enabled(bool):
 By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- two_way_channel_arn(Option<String>):
 The Amazon Resource Name (ARN) of the two way channel.
- self_managed_opt_outs_enabled(bool):
 This is true if self managed opt-out are enabled.
- opt_out_list_name(Option<String>):
 The name of the OptOutList associated with the phone number.
- deletion_protection_enabled(bool):
 When set to true the phone number can’t be deleted.
- created_timestamp(Option<DateTime>):
 The time when the phone number was created, in UNIX epoch time format.
On failure, responds with SdkError<UpdatePhoneNumberError>

source

pub fn update_pool(&self) -> UpdatePool

Constructs a fluent builder for the UpdatePool operation.

The fluent builder is configurable:
- pool_id(impl Into<String>) / set_pool_id(Option<String>):
 The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
- two_way_enabled(bool) / set_two_way_enabled(Option<bool>):
 By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- two_way_channel_arn(impl Into<String>) / set_two_way_channel_arn(Option<String>):
 The Amazon Resource Name (ARN) of the two way channel.
- self_managed_opt_outs_enabled(bool) / set_self_managed_opt_outs_enabled(Option<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.
- opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
 The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
- shared_routes_enabled(bool) / set_shared_routes_enabled(Option<bool>):
 Indicates whether shared routes are enabled for the pool.
- deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
 When set to true the pool can’t be deleted.
On success, responds with UpdatePoolOutput with field(s):
- pool_arn(Option<String>):
 The ARN of the pool.
- pool_id(Option<String>):
 The unique identifier of the pool.
- status(Option<PoolStatus>):
 The current status of the pool update request.
- message_type(Option<MessageType>):
 The type of message for the pool to use.
- two_way_enabled(bool):
 By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
- two_way_channel_arn(Option<String>):
 The Amazon Resource Name (ARN) of the two way channel.
- self_managed_opt_outs_enabled(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.
- opt_out_list_name(Option<String>):
 The name of the OptOutList associated with the pool.
- shared_routes_enabled(bool):
 Indicates whether shared routes are enabled for the pool.
- deletion_protection_enabled(bool):
 When set to true the pool can’t be deleted.
- created_timestamp(Option<DateTime>):
 The time when the pool was created, in UNIX epoch time format.
On failure, responds with SdkError<UpdatePoolError>