Class: Aws::PinpointSMSVoiceV2::Types::UpdateRcsAgentRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deletion_protection_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9235

class UpdateRcsAgentRequest < Struct.new(
  :rcs_agent_id,
  :deletion_protection_enabled,
  :opt_out_list_name,
  :self_managed_opt_outs_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :two_way_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#opt_out_list_name ⇒ String

The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.

Returns:

  • (String) 


9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9235

class UpdateRcsAgentRequest < Struct.new(
  :rcs_agent_id,
  :deletion_protection_enabled,
  :opt_out_list_name,
  :self_managed_opt_outs_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :two_way_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#rcs_agent_id ⇒ String

The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.

Returns:

  • (String) 


9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9235

class UpdateRcsAgentRequest < Struct.new(
  :rcs_agent_id,
  :deletion_protection_enabled,
  :opt_out_list_name,
  :self_managed_opt_outs_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :two_way_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#self_managed_opt_outs_enabled ⇒ Boolean

By default this is set to false. 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:

  • (Boolean) 


9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9235

class UpdateRcsAgentRequest < Struct.new(
  :rcs_agent_id,
  :deletion_protection_enabled,
  :opt_out_list_name,
  :self_managed_opt_outs_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :two_way_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#two_way_channel_arn ⇒ String

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

Returns:

  • (String) 


9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9235

class UpdateRcsAgentRequest < Struct.new(
  :rcs_agent_id,
  :deletion_protection_enabled,
  :opt_out_list_name,
  :self_managed_opt_outs_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :two_way_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#two_way_channel_role ⇒ String

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

Returns:

  • (String) 


9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9235

class UpdateRcsAgentRequest < Struct.new(
  :rcs_agent_id,
  :deletion_protection_enabled,
  :opt_out_list_name,
  :self_managed_opt_outs_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :two_way_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#two_way_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9235

class UpdateRcsAgentRequest < Struct.new(
  :rcs_agent_id,
  :deletion_protection_enabled,
  :opt_out_list_name,
  :self_managed_opt_outs_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :two_way_enabled)
  SENSITIVE = []
  include Aws::Structure
end