Class: Aws::PinpointSMSVoiceV2::Types::CreateRcsAgentResult

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

#created_timestamp ⇒ Time

The time when the RCS agent was created, in UNIX epoch time format.

Returns:

  • (Time) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 1186

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

#deletion_protection_enabled ⇒ Boolean

When set to true deletion protection is enabled. By default this is set to false.

Returns:

  • (Boolean) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 1186

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

#opt_out_list_name ⇒ String

The name of the OptOutList associated with the RCS agent.

Returns:

  • (String) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 1186

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

#rcs_agent_arn ⇒ String

The Amazon Resource Name (ARN) of the newly created RCS agent.

Returns:

  • (String) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 1186

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

#rcs_agent_id ⇒ String

The unique identifier for the RCS agent.

Returns:

  • (String) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 1186

class CreateRcsAgentResult < Struct.new(
  :rcs_agent_arn,
  :rcs_agent_id,
  :status,
  :deletion_protection_enabled,
  :opt_out_list_name,
  :created_timestamp,
  :self_managed_opt_outs_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :two_way_enabled,
  :tags)
  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) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 1186

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

#status ⇒ String

The current status of the RCS agent.

Returns:

  • (String) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 1186

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

#tags ⇒ Array<Types::Tag>

An array of tags (key and value pairs) associated with the RCS agent.

Returns:



1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 1186

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

#two_way_channel_arn ⇒ String

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

Returns:

  • (String) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 1186

class CreateRcsAgentResult < Struct.new(
  :rcs_agent_arn,
  :rcs_agent_id,
  :status,
  :deletion_protection_enabled,
  :opt_out_list_name,
  :created_timestamp,
  :self_managed_opt_outs_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :two_way_enabled,
  :tags)
  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) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 1186

class CreateRcsAgentResult < Struct.new(
  :rcs_agent_arn,
  :rcs_agent_id,
  :status,
  :deletion_protection_enabled,
  :opt_out_list_name,
  :created_timestamp,
  :self_managed_opt_outs_enabled,
  :two_way_channel_arn,
  :two_way_channel_role,
  :two_way_enabled,
  :tags)
  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) 


1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 1186

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