You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass ListQualificationTypesRequest data as a hash:

{
  query: "String",
  must_be_requestable: false, # required
  must_be_owned_by_caller: false,
  next_token: "PaginationToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#max_resultsInteger

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

Returns:

  • (Integer)


1729
1730
1731
1732
1733
1734
1735
1736
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1729

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

#must_be_owned_by_callerBoolean

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

Returns:

  • (Boolean)


1729
1730
1731
1732
1733
1734
1735
1736
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1729

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

#must_be_requestableBoolean

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)


1729
1730
1731
1732
1733
1734
1735
1736
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1729

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

#next_tokenString

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)


1729
1730
1731
1732
1733
1734
1735
1736
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1729

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

#queryString

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

Returns:

  • (String)


1729
1730
1731
1732
1733
1734
1735
1736
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1729

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