Package software.amazon.awssdk.services.pinpointsmsvoicev2.model

Class SendMediaMessageRequest

    • Method Detail

      • destinationPhoneNumber

        public final String destinationPhoneNumber()

        The destination phone number in E.164 format.

        Returns:
        The destination phone number in E.164 format.

      • originationIdentity

        public final String originationIdentity()

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

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

      • messageBody

        public final String messageBody()

        The text body of the message.

        Returns:
        The text body of the message.

      • hasMediaUrls

        public final boolean hasMediaUrls()
        For responses, this returns true if the service returned a value for the MediaUrls property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • mediaUrls

        public final List<String> mediaUrls()

        An array of URLs to each media file to send.

        The media files have to be stored in a publicly available 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 and Uploading objects in the S3 user guide.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMediaUrls() method.

        Returns:
        An array of URLs to each media file to send.

        The media files have to be stored in a publicly available 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 and Uploading objects in the S3 user guide.

      • configurationSetName

        public final String configurationSetName()

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

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

      • maxPrice

        public final String maxPrice()

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

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

      • timeToLive

        public final Integer timeToLive()

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

        Returns:
        How long the text message is valid for. By default this is 72 hours.

      • hasContext

        public final boolean hasContext()
        For responses, this returns true if the service returned a value for the Context property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • context

        public final Map<String,​String> context()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContext() method.

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

      • dryRun

        public final Boolean dryRun()

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

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

      • protectConfigurationId

        public final String protectConfigurationId()

        The unique identifier of the protect configuration to use.

        Returns:
        The unique identifier of the protect configuration to use.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object