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

Interface UpdatePhoneNumberRequest.Builder

    • Method Detail

      • phoneNumberId

        UpdatePhoneNumberRequest.Builder phoneNumberId​(String phoneNumberId)

        The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

        Parameters:
        phoneNumberId - The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • twoWayEnabled

        UpdatePhoneNumberRequest.Builder twoWayEnabled​(Boolean twoWayEnabled)

        By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

        Parameters:
        twoWayEnabled - By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • twoWayChannelArn

        UpdatePhoneNumberRequest.Builder twoWayChannelArn​(String twoWayChannelArn)

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

        Parameters:
        twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • twoWayChannelRole

        UpdatePhoneNumberRequest.Builder twoWayChannelRole​(String twoWayChannelRole)

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

        Parameters:
        twoWayChannelRole - An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • selfManagedOptOutsEnabled

        UpdatePhoneNumberRequest.Builder selfManagedOptOutsEnabled​(Boolean selfManagedOptOutsEnabled)

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

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

      • optOutListName

        UpdatePhoneNumberRequest.Builder optOutListName​(String optOutListName)

        The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

        Parameters:
        optOutListName - The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deletionProtectionEnabled

        UpdatePhoneNumberRequest.Builder deletionProtectionEnabled​(Boolean deletionProtectionEnabled)

        By default this is set to false. When set to true the phone number can't be deleted.

        Parameters:
        deletionProtectionEnabled - By default this is set to false. When set to true the phone number can't be deleted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.