Class: Aws::DataZone::Types::SearchUserProfilesInput

Inherits:

Struct

• Object
• Struct
• Aws::DataZone::Types::SearchUserProfilesInput

Defined in:

gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:search_text]

Instance Attribute Summary

• #domain_identifier ⇒ String

  The identifier of the Amazon DataZone domain in which you want to search user profiles.

• #max_results ⇒ Integer

  The maximum number of results to return in a single call to SearchUserProfiles.

• #next_token ⇒ String

  When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken.

• #search_text ⇒ String

  Specifies the text for which to search.

• #user_type ⇒ String

  Specifies the user type for the SearchUserProfiles action.

Instance Attribute Details

#domain_identifier ⇒ String

The identifier of the Amazon DataZone domain in which you want to search user profiles.

Returns:

• (String)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 16826

class SearchUserProfilesInput < Struct.new(
  :domain_identifier,
  :max_results,
  :next_token,
  :search_text,
  :user_type)
  SENSITIVE = [:search_text]
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return in a single call to SearchUserProfiles. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchUserProfiles to list the next set of results.

Returns:

• (Integer)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 16826

class SearchUserProfilesInput < Struct.new(
  :domain_identifier,
  :max_results,
  :next_token,
  :search_text,
  :user_type)
  SENSITIVE = [:search_text]
  include Aws::Structure
end

#next_token ⇒ String

When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchUserProfiles to list the next set of results.

Returns:

• (String)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 16826

class SearchUserProfilesInput < Struct.new(
  :domain_identifier,
  :max_results,
  :next_token,
  :search_text,
  :user_type)
  SENSITIVE = [:search_text]
  include Aws::Structure
end

#search_text ⇒ String

Specifies the text for which to search.

Returns:

• (String)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 16826

class SearchUserProfilesInput < Struct.new(
  :domain_identifier,
  :max_results,
  :next_token,
  :search_text,
  :user_type)
  SENSITIVE = [:search_text]
  include Aws::Structure
end

#user_type ⇒ String

Specifies the user type for the SearchUserProfiles action.

Returns:

• (String)

# File 'gems/aws-sdk-datazone/lib/aws-sdk-datazone/types.rb', line 16826

class SearchUserProfilesInput < Struct.new(
  :domain_identifier,
  :max_results,
  :next_token,
  :search_text,
  :user_type)
  SENSITIVE = [:search_text]
  include Aws::Structure
end