Interface SendTextMessageRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SendTextMessageRequest.Builder,SendTextMessageRequest>, PinpointSmsVoiceV2Request.Builder, SdkBuilder<SendTextMessageRequest.Builder,SendTextMessageRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SendTextMessageRequest
@Mutable @NotThreadSafe public static interface SendTextMessageRequest.Builder extends PinpointSmsVoiceV2Request.Builder, SdkPojo, CopyableBuilder<SendTextMessageRequest.Builder,SendTextMessageRequest>

  • Method Details

    • destinationPhoneNumber

      SendTextMessageRequest.Builder destinationPhoneNumber(String destinationPhoneNumber)

      The destination phone number in E.164 format.

      Parameters:
      destinationPhoneNumber - The destination phone number in E.164 format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • originationIdentity

      SendTextMessageRequest.Builder originationIdentity(String originationIdentity)

      The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

      Parameters:
      originationIdentity - The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messageBody

      SendTextMessageRequest.Builder messageBody(String messageBody)

      The body of the text message.

      Parameters:
      messageBody - The body of the text message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messageType

      SendTextMessageRequest.Builder messageType(String messageType)

      The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

      Parameters:
      messageType - The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • messageType

      SendTextMessageRequest.Builder messageType(MessageType messageType)

      The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

      Parameters:
      messageType - The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • keyword

      SendTextMessageRequest.Builder keyword(String keyword)

      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.

      Parameters:
      keyword - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configurationSetName

      SendTextMessageRequest.Builder configurationSetName(String configurationSetName)

      The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

      Parameters:
      configurationSetName - The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxPrice

      SendTextMessageRequest.Builder maxPrice(String maxPrice)

      The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.

      Parameters:
      maxPrice - The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeToLive

      SendTextMessageRequest.Builder timeToLive(Integer timeToLive)

      How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.

      Parameters:
      timeToLive - How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • context

      SendTextMessageRequest.Builder context(Map<String,String> context)

      You can specify custom data in this field. If you do, that data is logged to the event destination.

      Parameters:
      context - You can specify custom data in this field. If you do, that data is logged to the event destination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationCountryParametersWithStrings

      SendTextMessageRequest.Builder destinationCountryParametersWithStrings(Map<String,String> destinationCountryParameters)

      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.

      • IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.

      • IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.

        Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.

      Parameters:
      destinationCountryParameters - 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.

      • IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.

      • IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.

        Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationCountryParameters

      SendTextMessageRequest.Builder destinationCountryParameters(Map<DestinationCountryParameterKey,String> destinationCountryParameters)

      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.

      • IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.

      • IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.

        Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.

      Parameters:
      destinationCountryParameters - 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.

      • IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.

      • IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.

        Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRun

      SendTextMessageRequest.Builder dryRun(Boolean dryRun)

      When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.

      The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..

      Parameters:
      dryRun - When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.

      The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protectConfigurationId

      SendTextMessageRequest.Builder protectConfigurationId(String protectConfigurationId)

      The unique identifier for the protect configuration.

      Parameters:
      protectConfigurationId - The unique identifier for the protect configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messageFeedbackEnabled

      SendTextMessageRequest.Builder messageFeedbackEnabled(Boolean messageFeedbackEnabled)

      Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.

      Parameters:
      messageFeedbackEnabled - Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      SendTextMessageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SendTextMessageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.