Interface PutKeywordRequest.Builder

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

  • Method Details

    • 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

      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:

    • overrideConfiguration

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

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