Class: Aws::CloudWatchOmni::Types::SearchPrincipalsInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain_id ⇒ String

The ID of the domain to search within.

Returns:

  • (String) 


4420
4421
4422
4423
4424
4425
4426
4427
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4420

class SearchPrincipalsInput < Struct.new(
  :domain_id,
  :search_query,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return. Defaults to 10. Valid only when searchQuery is *; other searches reject this parameter and return at most 10 results.

Returns:

  • (Integer) 


4420
4421
4422
4423
4424
4425
4426
4427
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4420

class SearchPrincipalsInput < Struct.new(
  :domain_id,
  :search_query,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A token to retrieve the next page of results. Valid only when searchQuery is *; other searches do not paginate and reject this parameter. Tokens expire after 24 hours.

Returns:

  • (String) 


4420
4421
4422
4423
4424
4425
4426
4427
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4420

class SearchPrincipalsInput < Struct.new(
  :domain_id,
  :search_query,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#search_query ⇒ String

A search term to match against user names, display names, and IDs. Pass * to list all principals. Maximum 128 characters.

Returns:

  • (String) 


4420
4421
4422
4423
4424
4425
4426
4427
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4420

class SearchPrincipalsInput < Struct.new(
  :domain_id,
  :search_query,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end