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

Interface PutKeywordRequest.Builder

    • Method Detail

      • originationIdentity

        PutKeywordRequest.Builder originationIdentity​(String originationIdentity)

        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.

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

        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.

      • keyword

        PutKeywordRequest.Builder keyword​(String keyword)

        The new keyword to add.

        Parameters:
        keyword - The new keyword to add.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keywordMessage

        PutKeywordRequest.Builder keywordMessage​(String keywordMessage)

        The message associated with the keyword.

        Parameters:
        keywordMessage - The message associated with the keyword.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keywordAction

        PutKeywordRequest.Builder keywordAction​(String keywordAction)

        The action to perform for the new keyword when it is received.

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

        Parameters:
        keywordAction - The action to perform for the new keyword when it is received.

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

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

      • keywordAction

        PutKeywordRequest.Builder keywordAction​(KeywordAction keywordAction)

        The action to perform for the new keyword when it is received.

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

        Parameters:
        keywordAction - The action to perform for the new keyword when it is received.

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

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