Spec-Zone.ru › AWS CLI v2

[ aws . macie2 ]

list-classification-jobs

Описание

Получает подмножество информации об одной или нескольких задачах классификации.

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

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

Синтаксис

  list-classification-jobs
[--filter-criteria <value>]
[--sort-criteria <value>]
[--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]

Параметры

--filter-criteria (структура)

Критерии для фильтрации результатов.

excludes -> (список)

Массив объектов, по одному для каждого условия, определяющего, какие задачи исключить из результатов.

(структура)

Определяет условие, которое фильтрует результаты запроса информации о задачах классификации. Каждое условие состоит из свойства, оператора и одного или нескольких значений.

comparator -> (строка)

Оператор, используемый для фильтрации результатов.

key -> (строка)

Свойство, используемое для фильтрации результатов.

values -> (список)

Массив, содержащий одно или несколько значений для фильтрации результатов.

(строка)

includes -> (список)

Массив объектов, по одному для каждого условия, определяющего, какие задачи включить в результаты.

(структура)

Определяет условие, которое фильтрует результаты запроса информации о задачах классификации. Каждое условие состоит из свойства, оператора и одного или нескольких значений.

comparator -> (строка)

Оператор, используемый для фильтрации результатов.

key -> (строка)

Свойство, используемое для фильтрации результатов.

values -> (список)

Массив, содержащий одно или несколько значений для фильтрации результатов.

(строка)

Синтаксис JSON:

{
  "excludes": [
    {
      "comparator": "EQ"|"GT"|"GTE"|"LT"|"LTE"|"NE"|"CONTAINS"|"STARTS_WITH",
      "key": "jobType"|"jobStatus"|"createdAt"|"name",
      "values": ["string", ...]
    }
    ...
  ],
  "includes": [
    {
      "comparator": "EQ"|"GT"|"GTE"|"LT"|"LTE"|"NE"|"CONTAINS"|"STARTS_WITH",
      "key": "jobType"|"jobStatus"|"createdAt"|"name",
      "values": ["string", ...]
    }
    ...
  ]
}

--sort-criteria (структура)

Критерии для сортировки результатов.

attributeName -> (строка)

Свойство для сортировки результатов.

orderBy -> (строка)

Порядок сортировки результатов на основе значения свойства, указанного в свойстве attributeName. Допустимые значения: ASC, сортировка результатов по возрастанию; DESC, сортировка результатов по убыванию.

Сокращенный синтаксис:

attributeName=string,orderBy=string

Синтаксис JSON:

{
  "attributeName": "createdAt"|"jobStatus"|"name"|"jobType",
  "orderBy": "ASC"|"DESC"
}

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

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

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

Примеры использования см. в разделе Поэтапная обработка в руководстве пользователя AWS Command Line Interface.

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

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

Примеры использования см. в разделе Поэтапная обработка в руководстве пользователя AWS Command Line Interface.

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

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

Примеры использования см. в разделе Поэтапная обработка в руководстве пользователя AWS Command Line Interface.

--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-auto-prompt (булево)

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

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

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

Выходные данные

items -> (список)

Массив объектов, по одному для каждой задачи, соответствующей критериям фильтра, указанным в запросе.

(структура)

Предоставляет информацию о задаче классификации, включая текущий статус задачи.

bucketCriteria -> (структура)

Условие, заданное на основе свойств и тегов, определяющее, какие ведра S3 включаются или исключаются из анализа задачи. При каждом запуске задачи она использует эти критерии для определения ведер для анализа. Определение задачи может содержать объект bucketCriteria или массив bucketDefinitions, но не оба.

excludes -> (структура)

Условие на основе свойств и тегов, определяющее, какие ведра исключить из задачи.

and -> (список)

Массив условий, по одному для каждого условия, определяющего, какие ведра включать или исключать из задачи. Если вы укажете более одного условия, Amazon Macie использует логику И для объединения условий.

(структура)

Определяет условие на основе свойства или тега, которое определяет критерии включения или исключения ведер S3 из задачи классификации.

simpleCriterion -> (структура)

Условие на основе свойства, определяющее свойство, оператор и одно или несколько значений для включения или исключения ведер из задачи.

comparator -> (строка)

Оператор, используемый в условии. Допустимые значения — EQ (равно) и NE (не равно).

key -> (строка)

Свойство, используемое в условии.

values -> (список)

Массив, содержащий одно или несколько значений для использования в условии. Если вы укажете несколько значений, Amazon Macie использует логику ИЛИ для объединения значений. Допустимые значения для каждого поддерживаемого свойства (ключа):

  • ACCOUNT_ID — Строка, представляющая уникальный идентификатор учетной записи Amazon Web Services, владеющей ведром.
  • S3_BUCKET_EFFECTIVE_PERMISSION — Строка, представляющая перечислимое значение, определённое Macie для свойства BucketPublicAccess.effectivePermission ведра.
  • S3_BUCKET_NAME — Строка, представляющая имя ведра.
  • S3_BUCKET_SHARED_ACCESS — Строка, представляющая перечислимое значение, определённое Macie для свойства BucketMetadata.sharedAccess ведра.

Значения чувствительны к регистру. Кроме того, Macie не поддерживает использование частичных значений или символов подстановки в этих значениях.

(строка)

tagCriterion -> (структура)

Условие на основе тега, определяющее оператор и ключи тегов, значения тегов или пары ключ и значение тега для включения или исключения ведер из задачи.

comparator -> (строка)

Оператор, используемый в условии. Допустимые значения — EQ (равно) и NE (не равно).

tagValues -> (список)

Ключи тегов, значения тегов или пары ключ и значение тегов для использования в условии.

(структура)

Определяет ключ тега, значение тега или пару ключ и значение (как пару) для использования в условии на основе тега, определяющем, включается или исключается ведро S3 из задачи классификации. Ключи и значения тегов чувствительны к регистру. Также Amazon Macie не поддерживает использование частичных значений или символов подстановки в условиях на основе тегов.

key -> (строка)

Значение для ключа тега, используемого в условии.

value -> (строка)

Значение тега, используемое в условии.

includes -> (структура)

Условие на основе свойств и тегов, определяющее, какие ведра включить в задачу.

and -> (список)

Массив условий, по одному для каждого условия, определяющего, какие ведра включать или исключать из задачи. Если вы укажете более одного условия, Amazon Macie использует логику И для объединения условий.

(структура)

Определяет условие на основе свойства или тега, которое определяет критерии включения или исключения ведер S3 из задачи классификации.

simpleCriterion -> (структура)

Условие на основе свойства, определяющее свойство, оператор и одно или несколько значений для включения или исключения ведер из задачи.

comparator -> (строка)

Оператор, используемый в условии. Допустимые значения — EQ (равно) и NE (не равно).

key -> (строка)

Свойство, используемое в условии.

values -> (список)

Массив, содержащий одно или несколько значений для использования в условии. Если вы укажете несколько значений, Amazon Macie использует логику ИЛИ для объединения значений. Допустимые значения для каждого поддерживаемого свойства (ключа):

  • ACCOUNT_ID — Строка, представляющая уникальный идентификатор учетной записи Amazon Web Services, владеющей ведром.
  • S3_BUCKET_EFFECTIVE_PERMISSION — Строка, представляющая перечислимое значение, определённое Macie для свойства BucketPublicAccess.effectivePermission ведра.
  • S3_BUCKET_NAME — Строка, представляющая имя ведра.
  • S3_BUCKET_SHARED_ACCESS — Строка, представляющая перечислимое значение, определённое Macie для свойства BucketMetadata.sharedAccess ведра.

Значения чувствительны к регистру. Кроме того, Macie не поддерживает использование частичных значений или символов подстановки в этих значениях.

(строка)

tagCriterion -> (структура)

Условие на основе тега, определяющее оператор и ключи тегов, значения тегов или пары ключ и значение тега для включения или исключения ведер из задачи.

comparator -> (строка)

Оператор, используемый в условии. Допустимые значения — EQ (равно) и NE (не равно).

tagValues -> (список)

Ключи тегов, значения тегов или пары ключ и значение тегов для использования в условии.

(структура)

Определяет ключ тега, значение тега или пару ключ и значение (как пару) для использования в условии на основе тега, определяющем, включается или исключается ведро S3 из задачи классификации. Ключи и значения тегов чувствительны к регистру. Также Amazon Macie не поддерживает использование частичных значений или символов подстановки в условиях на основе тегов.

key -> (строка)

Значение для ключа тега, используемого в условии.

value -> (строка)

Значение тега, используемое в условии.

bucketDefinitions -> (список)

Массив объектов, по одному для каждой учетной записи Amazon Web Services, владеющей конкретными ведрами S3 для анализа задачи. Каждый объект указывает идентификатор учетной записи для учетной записи и одно или несколько ведер для анализа для этой учетной записи. Определение задачи может содержать массив bucketDefinitions или объект bucketCriteria, но не оба.

(структура)

Указывает учетную запись Amazon Web Services, владеющую ведрами S3 для анализа задачи классификации, и одно или несколько конкретных ведер для анализа для этой учетной записи.

accountId -> (строка)

Уникальный идентификатор учетной записи Amazon Web Services, владеющей ведрами.

buckets -> (список)

Массив, содержащий имена ведер.

(строка)

createdAt -> (метка времени)

Дата и время создания задачи в формате UTC и расширенном формате ISO 8601.

jobId -> (строка)

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

jobStatus -> (строка)

Текущий статус задачи. Возможные значения:

  • CANCELLED — Вы отменили задачу или, если это разовая задача, вы приостановили задачу и не возобновили её в течение 30 дней.
  • COMPLETE — Для разовой задачи Amazon Macie завершила обработку данных, указанных для задачи. Это значение не относится к периодическим задачам.
  • IDLE — Для периодической задачи предыдущий запланированный запуск завершен, а следующий запланированный запуск ожидает. Это значение не относится к разовым задачам.
  • PAUSED — Macie начала запуск задачи, но дополнительная обработка превысит месячный лимит обнаружения конфиденциальных данных для вашей учетной записи или одной или нескольких учетных записей участников, для которых задача анализирует данные.
  • RUNNING — Для разовой задачи задача выполняется. Для периодической задачи выполняется запланированный запуск.
  • USER_PAUSED — Вы приостановили задачу. Если вы приостановили задачу, когда её статус был RUNNING, и не возобновите её в течение 30 дней после приостановки, задача или запуск задачи истекут и будут отменены в зависимости от типа задачи. Чтобы проверить дату истечения срока действия, обратитесь к свойству UserPausedDetails.jobExpiresAt.

jobType -> (строка)

График выполнения задачи. Возможные значения:

  • ONE_TIME — Задача выполняется только один раз.
  • SCHEDULED — Задача выполняется ежедневно, еженедельно или ежемесячно.

lastRunErrorStatus -> (структура)

Указывает, произошли ли какие-либо ошибки доступа на уровне учетной записи или ведра во время выполнения задачи. Для периодической задачи это значение указывает статус ошибки последнего запуска задачи.

code -> (строка)

Указывает, произошли ли какие-либо ошибки доступа на уровне учетной записи или ведра во время выполнения задачи. Для периодической задачи это значение указывает статус ошибки последнего запуска задачи. Возможные значения:

  • ERROR — Произошла одна или несколько ошибок. Amazon Macie не обработала все данные, указанные для задачи.
  • NONE — Ошибки не произошли. Macie обработала все данные, указанные для задачи.

name -> (строка)

Пользовательское имя задачи.

userPausedDetails -> (структура)

Если текущий статус задачи — USER_PAUSED, указывает, когда задача была приостановлена и когда задача или запуск задачи истекут и будут отменены, если она не будет возобновлена. Это значение присутствует только в том случае, если значение для jobStatus равно USER_PAUSED.

jobExpiresAt -> (метка времени)

Дата и время истечения срока действия задачи или запуска задачи в формате UTC и расширенном формате ISO 8601, если вы не возобновите её.

jobImminentExpirationHealthEventArn -> (строка)

Amazon Resource Name (ARN) события состояния, которое Amazon Macie отправила, чтобы уведомить вас о предстоящем истечении срока действия задачи или запуска задачи и об их отмене. Это значение равно null, если задача была приостановлена менее 23 дней.

jobPausedAt -> (метка времени)

Дата и время приостановки задачи в формате UTC и расширенном формате ISO 8601.

nextToken -> (строка)

Строка, используемая в последующем запросе для получения следующей страницы результатов в отформатированном по страницам ответе. Это значение равно null, если дополнительных страниц нет.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API