Class: Aws::PinpointSMSVoiceV2::Types::DescribeRcsAgentsRequest

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

#filters ⇒ Array<Types::RcsAgentFilter>

An array of RcsAgentFilter objects to filter the results.

Returns:



3421
3422
3423
3424
3425
3426
3427
3428
3429
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3421

class DescribeRcsAgentsRequest < Struct.new(
  :rcs_agent_ids,
  :owner,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return per each request.

Returns:

  • (Integer) 


3421
3422
3423
3424
3425
3426
3427
3428
3429
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3421

class DescribeRcsAgentsRequest < Struct.new(
  :rcs_agent_ids,
  :owner,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Returns:

  • (String) 


3421
3422
3423
3424
3425
3426
3427
3428
3429
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3421

class DescribeRcsAgentsRequest < Struct.new(
  :rcs_agent_ids,
  :owner,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#owner ⇒ String

Use SELF to filter the list of RCS agents to ones your account owns or use SHARED to filter on RCS agents shared with your account. The Owner and RcsAgentIds parameters can't be used at the same time.

Returns:

  • (String) 


3421
3422
3423
3424
3425
3426
3427
3428
3429
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3421

class DescribeRcsAgentsRequest < Struct.new(
  :rcs_agent_ids,
  :owner,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#rcs_agent_ids ⇒ Array<String>

An array of unique identifiers for the RCS agents. This is an array of strings that can be either the RcsAgentId or RcsAgentArn.

Returns:

  • (Array<String>) 


3421
3422
3423
3424
3425
3426
3427
3428
3429
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3421

class DescribeRcsAgentsRequest < Struct.new(
  :rcs_agent_ids,
  :owner,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end