Class: Aws::PinpointSMSVoiceV2::Types::DescribePoolsRequest

Inherits:

Struct

• Object
• Struct
• Aws::PinpointSMSVoiceV2::Types::DescribePoolsRequest

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::PoolFilter>

  An array of PoolFilter 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 Pools to ones your account owns or use `SHARED` to filter on Pools shared with your account.

• #pool_ids ⇒ Array<String>

  The unique identifier of pools to find.

Instance Attribute Details

#filters ⇒ Array<Types::PoolFilter>

An array of PoolFilter objects to filter the results.

Returns:

• (Array<Types::PoolFilter>)

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

class DescribePoolsRequest < Struct.new(
  :pool_ids,
  :filters,
  :next_token,
  :max_results,
  :owner)
  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 2515

class DescribePoolsRequest < Struct.new(
  :pool_ids,
  :filters,
  :next_token,
  :max_results,
  :owner)
  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 2515

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

#owner ⇒ String

Use ‘SELF` to filter the list of Pools to ones your account owns or use `SHARED` to filter on Pools shared with your account. The `Owner` and `PoolIds` parameters can’t be used at the same time.

Returns:

• (String)

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

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

#pool_ids ⇒ Array<String>

The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Returns:

• (Array<String>)

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

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