Class: Aws::MTurk::Types::ListQualificationTypesRequest

Inherits:

Struct

• Object
• Struct
• Aws::MTurk::Types::ListQualificationTypesRequest

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #max_results ⇒ Integer

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

• #must_be_owned_by_caller ⇒ Boolean

  Specifies that only Qualification types that the Requester created are returned.

• #must_be_requestable ⇒ Boolean

  Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search.

• #next_token ⇒ String

  If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response.

• #query ⇒ String

  A text query against all of the searchable attributes of Qualification types.

Instance Attribute Details

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1447

class ListQualificationTypesRequest < Struct.new(
  :query,
  :must_be_requestable,
  :must_be_owned_by_caller,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#must_be_owned_by_caller ⇒ Boolean

Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types.

Returns:

• (Boolean)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1447

class ListQualificationTypesRequest < Struct.new(
  :query,
  :must_be_requestable,
  :must_be_owned_by_caller,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#must_be_requestable ⇒ Boolean

Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered. Valid values are True | False.

Returns:

• (Boolean)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1447

class ListQualificationTypesRequest < Struct.new(
  :query,
  :must_be_requestable,
  :must_be_owned_by_caller,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1447

class ListQualificationTypesRequest < Struct.new(
  :query,
  :must_be_requestable,
  :must_be_owned_by_caller,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#query ⇒ String

A text query against all of the searchable attributes of Qualification types.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1447

class ListQualificationTypesRequest < Struct.new(
  :query,
  :must_be_requestable,
  :must_be_owned_by_caller,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end