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

Inherits:

Struct

• Object
• Struct
• Aws::PinpointSMSVoiceV2::Types::DescribeRcsAgentsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Array<Types::RcsAgentFilter>

  An array of RcsAgentFilter objects to filter the results.

• #max_results ⇒ Integer

  The maximum number of results to return per each request.

• #next_token ⇒ String

  The token to be used for the next set of paginated results.

• #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.

• #rcs_agent_ids ⇒ Array<String>

  An array of unique identifiers for the RCS agents.

Instance Attribute Details

#filters ⇒ Array<Types::RcsAgentFilter>

An array of RcsAgentFilter objects to filter the results.

Returns:

• (Array<Types::RcsAgentFilter>)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3567

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)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3567

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)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3567

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)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3567

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>)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3567

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