list-hits

Описание

Операция ListHITs возвращает все HITы Заказчика. Операция возвращает HITы любого статуса, кроме HITов, которые были удалены операцией DeleteHIT или которые были автоматически удалены.

См. также: Документацию API AWS

list-hits — это операция с постраничной передачей данных. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную передачу, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей, аргумент --query должен извлекать данные из результатов следующих выражений запроса: HITs

Синтаксис

  list-hits
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения перепишут значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания места начала постраничной передачи. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничная передача в Руководстве пользователя командной строки AWS.

--page-size (целое число)

Размер каждой страницы для получения в вызове службы AWS. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов службы AWS, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов службы AWS.

Примеры использования см. в разделе Постраничная передача в Руководстве пользователя командной строки AWS.

--max-items (целое число)

Общее количество элементов, которые необходимо вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной передачи укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная передача в Руководстве пользователя командной строки AWS.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (булево)

Включить отладку регистрации.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (булево)

Отключить автоматическую постраничную передачу. Если автоматическая постраничная передача отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

json
текст
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из вашего файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

включено
выключено
авто

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается в двоичный блок fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла непосредственно, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (булево)

Отключение постраничного отображения вывода CLI.

--cli-auto-prompt (булево)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматический запрос параметров ввода CLI.

Вывод

NextToken -> (строка)

Если предыдущий ответ был неполным (потому что требуется больше данных), Amazon Mechanical Turk возвращает маркер постраничной навигации в ответе. Вы можете использовать этот маркер постраничной навигации для получения следующего набора результатов.

NumResults -> (целое число)

Количество HIT на этой странице в отфильтрованном списке результатов, эквивалентное количеству HIT, возвращаемых этим вызовом.

HITs -> (список)

Список элементов HIT, возвращенных запросом.

(структура)

Структура данных HIT представляет собой одну HIT, включая всю необходимую информацию для Работника для принятия и завершения HIT.

HITId -> (строка)

Уникальный идентификатор для HIT.

HITTypeId -> (строка)

Идентификатор типа HIT для этой HIT

HITGroupId -> (строка)

Идентификатор группы HIT для этой HIT.

HITLayoutId -> (строка)

Идентификатор макета HIT для этой HIT.

CreationTime -> (временная метка)

Дата и время создания HIT.

Title -> (строка)

Название HIT.

Description -> (строка)

Общее описание HIT.

Question -> (строка)

Данные, которые Работник, выполняющий HIT, использует для получения результатов. Это либо структура QuestionForm, HTMLQuestion, либо ExternalQuestion.

Keywords -> (строка)

Одно или несколько слов или словосочетаний, описывающих HIT, разделенных запятыми. Поисковые запросы, похожие на ключевые слова HIT, с большей вероятностью включают HIT в результаты поиска.

HITStatus -> (строка)

Статус HIT и его назначений. Допустимые значения: Assignable | Unassignable | Reviewable | Reviewing | Disposed.

MaxAssignments -> (целое число)

Количество раз, когда HIT может быть принят и завершен, прежде чем HIT станет недоступным.

Reward -> (строка)

Строка, представляющая денежную сумму.

AutoApprovalDelayInSeconds -> (длинное целое число)

Время в секундах после того, как Работник отправляет задание для HIT, по истечении которого Amazon Mechanical Turk автоматически одобряет результаты. Это время, за которое Заказчик может отклонить задание, отправленное Работником, прежде чем задание будет автоматически одобрено, и Работнику будет произведена оплата.

Expiration -> (временная метка)

Дата и время истечения срока действия HIT.

AssignmentDurationInSeconds -> (длинное целое число)

Время в секундах, которое у Работника есть для завершения HIT после его принятия.

RequesterAnnotation -> (строка)

Произвольное поле данных, которое может использовать Заказчик, создавший HIT. Это поле видно только создателю HIT.

QualificationRequirements -> (список)

Условия, которым должны соответствовать квалификации Работника для принятия HIT. HIT может иметь от нуля до десяти требований к квалификации. Все требования должны быть выполнены для того, чтобы Работник мог принять HIT. Кроме того, другие действия могут быть ограничены с помощью поля ActionsGuarded в каждой структуре QualificationRequirement.

(структура)

Структура данных QualificationRequirement описывает квалификацию, которой должен обладать Работник, прежде чем ему будет разрешено принять HIT. Требование может необязательно указать, что Работник должен иметь квалификацию для предварительного просмотра HIT или просмотра HIT в результатах поиска.

QualificationTypeId -> (строка)

Идентификатор типа квалификации для требования.

Comparator -> (строка)

Тип сравнения, который необходимо выполнить со значением квалификации. Вы можете сравнить значение квалификации с IntegerValue, чтобы проверить, меньше оно, меньше или равно, больше, больше или равно, равно или не равно IntegerValue. Вы можете сравнить его с LocaleValue, чтобы проверить, равно ли оно или не равно LocaleValue. Вы можете проверить, входит ли значение в набор значений IntegerValue или LocaleValue или нет. Наконец, требование квалификации также может проверить, существует ли квалификация в профиле пользователя или нет, независимо от ее значения.

IntegerValues -> (список)

Целое значение для сравнения со значением квалификации. IntegerValue не должен присутствовать, если Comparator равен Exists или DoesNotExist. IntegerValue может быть использован только в том случае, если тип квалификации имеет целое значение; он не может быть использован с идентификатором типа квалификации Worker_Locale. При выполнении сравнения по набору с использованием компаратора In или NotIn вы можете использовать до 15 элементов IntegerValue в структуре данных QualificationRequirement.

(целое число)

LocaleValues -> (список)

Значение регионального формата для сравнения со значением квалификации. Значение регионального формата должно быть корректным кодом страны ISO 3166 или поддерживать подразделения ISO 3166-2. LocaleValue может использоваться только с идентификатором типа квалификации Worker_Locale. LocaleValue может использоваться только с компараторами EqualTo, NotEqualTo, In и NotIn. При использовании компараторов EqualTo или NotEqualTo вы должны использовать только один элемент LocaleValue. При выполнении сравнения по набору с использованием компараторов In или NotIn вы можете использовать до 30 элементов LocaleValue в структуре данных QualificationRequirement.

(структура)

Структура данных Locale представляет географический регион или местоположение.

Country -> (строка)

Страна регионального формата. Должен быть корректным кодом страны ISO 3166. Например, код US относится к Соединенным Штатам Америки.

Subdivision -> (строка)

Штат или подразделение регионального формата. Действительный код подразделения ISO 3166-2. Например, код WA относится к штату Вашингтон.

RequiredToPreview -> (булево)

УСТАРЕЛО: Используйте поле ActionsGuarded вместо этого. Если RequiredToPreview равно true, данные вопроса для HIT не будут отображаться, когда Работник, чьи квалификации не соответствуют этому требованию, пытается предварительно просмотреть HIT. То есть, квалификации Работника должны соответствовать всем требованиям, для которых RequiredToPreview равно true, чтобы предварительно просмотреть HIT. Если Работник соответствует всем требованиям, где RequiredToPreview равно true (или если таких требований нет), но не соответствует всем требованиям для HIT, Работнику будет разрешено предварительно просмотреть данные вопроса HIT, но ему не будет разрешено принять и выполнить HIT. По умолчанию значение false. Это не должно использоваться в сочетании с полем ActionsGuarded.

ActionsGuarded -> (строка)

Установка этого атрибута предотвращает Работникам, чьи квалификации не соответствуют этому требованию QualificationRequirement, выполнение указанного действия. Допустимые значения включают «Accept» (Работник не может принять HIT, но может предварительно просмотреть HIT и увидеть его в результатах поиска), «PreviewAndAccept» (Работник не может принять или предварительно просмотреть HIT, но может увидеть HIT в результатах поиска) и «DiscoverPreviewAndAccept» (Работник не может принять, предварительно просмотреть или увидеть HIT в результатах поиска). Возможно создать HIT с несколькими требованиями QualificationRequirements (которые могут иметь разные значения для атрибута ActionGuarded). В этом случае Работнику разрешается выполнять действие только при выполнении всех требований QualificationRequirements, контролирующих действие. Действия в порядке от наименее ограничительного к наиболее ограничительному: Discover, Preview и Accept. Например, если Работник соответствует всем требованиям QualificationRequirements, установленным как DiscoverPreviewAndAccept, но не соответствует всем требованиям, установленным как PreviewAndAccept, Работник сможет выполнить Discover, т.е. увидеть HIT в результатах поиска, но не сможет предварительно просмотреть или принять HIT. ActionsGuarded не следует использовать в сочетании с полем RequiredToPreview.

HITReviewStatus -> (строка)

Указывает статус проверки HIT. Допустимые значения: NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

NumberOfAssignmentsPending -> (целое число)

Количество заданий для этой HIT, которые просматриваются или были приняты Работниками, но еще не были отправлены, возвращены или оставлены.

NumberOfAssignmentsAvailable -> (целое число)

Количество заданий для этой HIT, которые доступны для принятия Работниками.

NumberOfAssignmentsCompleted -> (целое число)

Количество заданий для этой HIT, которые были одобрены или отклонены.

END_OF_DOCUMENT_MARKER