Interface SendMediaMessageRequest.Builder

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

  • Method Details

    • destinationPhoneNumber

      SendMediaMessageRequest.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

      SendMediaMessageRequest.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

      SendMediaMessageRequest.Builder messageBody(String messageBody)

      The text body of the message.

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

    • mediaUrls

      SendMediaMessageRequest.Builder mediaUrls(Collection<String> mediaUrls)

      An array of URLs to each media file to send.

      The media files have to be stored in an S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket, Uploading objects in the Amazon S3 User Guide, and Setting up an Amazon S3 bucket for MMS files in the Amazon Web Services End User Messaging SMS User Guide.

      Parameters:
      mediaUrls - An array of URLs to each media file to send.

      The media files have to be stored in an S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket, Uploading objects in the Amazon S3 User Guide, and Setting up an Amazon S3 bucket for MMS files in the Amazon Web Services End User Messaging SMS User Guide.

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

    • mediaUrls

      SendMediaMessageRequest.Builder mediaUrls(String... mediaUrls)

      An array of URLs to each media file to send.

      The media files have to be stored in an S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket, Uploading objects in the Amazon S3 User Guide, and Setting up an Amazon S3 bucket for MMS files in the Amazon Web Services End User Messaging SMS User Guide.

      Parameters:
      mediaUrls - An array of URLs to each media file to send.

      The media files have to be stored in an S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket, Uploading objects in the Amazon S3 User Guide, and Setting up an Amazon S3 bucket for MMS files in the Amazon Web Services End User Messaging SMS User Guide.

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

    • configurationSetName

      SendMediaMessageRequest.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

      SendMediaMessageRequest.Builder maxPrice(String maxPrice)

      The maximum amount that you want to spend, in US dollars, per each MMS message.

      Parameters:
      maxPrice - The maximum amount that you want to spend, in US dollars, per each MMS message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeToLive

      SendMediaMessageRequest.Builder timeToLive(Integer timeToLive)

      How long the media message is valid for. By default this is 72 hours.

      Parameters:
      timeToLive - How long the media message is valid for. By default this is 72 hours.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • context

      SendMediaMessageRequest.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.

    • dryRun

      SendMediaMessageRequest.Builder dryRun(Boolean dryRun)

      When set to true, the message is checked and validated, but isn't sent to the end recipient.

      Parameters:
      dryRun - When set to true, the message is checked and validated, but isn't sent to the end recipient.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protectConfigurationId

      SendMediaMessageRequest.Builder protectConfigurationId(String protectConfigurationId)

      The unique identifier of the protect configuration to use.

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

    • messageFeedbackEnabled

      SendMediaMessageRequest.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

      SendMediaMessageRequest.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

      SendMediaMessageRequest.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.