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

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

An array of PoolFilter objects to filter the results.

Returns:



3417
3418
3419
3420
3421
3422
3423
3424
3425
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3417

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) 


3417
3418
3419
3420
3421
3422
3423
3424
3425
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3417

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) 


3417
3418
3419
3420
3421
3422
3423
3424
3425
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3417

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) 


3417
3418
3419
3420
3421
3422
3423
3424
3425
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3417

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 End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).

Returns:

  • (Array<String>) 


3417
3418
3419
3420
3421
3422
3423
3424
3425
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 3417

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