Class: Aws::PinpointSMSVoiceV2::Types::PutKeywordRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#keywordString

The new keyword to add.

Returns:

  • (String)


3931
3932
3933
3934
3935
3936
3937
3938
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3931

class PutKeywordRequest < Struct.new(
  :origination_identity,
  :keyword,
  :keyword_message,
  :keyword_action)
  SENSITIVE = []
  include Aws::Structure
end

#keyword_actionString

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:

  • (String)


3931
3932
3933
3934
3935
3936
3937
3938
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3931

class PutKeywordRequest < Struct.new(
  :origination_identity,
  :keyword,
  :keyword_message,
  :keyword_action)
  SENSITIVE = []
  include Aws::Structure
end

#keyword_messageString

The message associated with the keyword.

Returns:

  • (String)


3931
3932
3933
3934
3935
3936
3937
3938
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3931

class PutKeywordRequest < Struct.new(
  :origination_identity,
  :keyword,
  :keyword_message,
  :keyword_action)
  SENSITIVE = []
  include Aws::Structure
end

#origination_identityString

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.

Returns:

  • (String)


3931
3932
3933
3934
3935
3936
3937
3938
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3931

class PutKeywordRequest < Struct.new(
  :origination_identity,
  :keyword,
  :keyword_message,
  :keyword_action)
  SENSITIVE = []
  include Aws::Structure
end