describe-classification-job

Описание

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

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

Синтаксис

  describe-classification-job
--job-id <value>
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--job-id (строка)

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

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

--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.

Вывод

allowListIds -> (список)

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

(строка)

clientToken -> (строка)

Токен, который был предоставлен для обеспечения идемпотентности запроса для создания задания.

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

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

customDataIdentifierIds -> (список)

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

(строка)

description -> (строка)

Пользовательское описание задания.

initialRun -> (логическое значение)

Для повторяющегося задания указывает, настроили ли вы задание для анализа всех существующих подходящих объектов сразу после создания задания (true). Если вы настроили задание для анализа только тех объектов, которые были созданы или изменены после создания задания и до первого запланированного запуска задания, это значение равно false. Это значение также равно false для задания разового выполнения.

jobArn -> (строка)

Amazon Resource Name (ARN) задания.

jobId -> (строка)

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

jobStatus -> (строка)

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

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

jobType -> (строка)

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

ONE_TIME - Задание выполняется только один раз.
SCHEDULED - Задание выполняется ежедневно, еженедельно или ежемесячно. Свойство scheduleFrequency указывает образец повторения для задания.

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

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

code -> (строка)

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

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

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

managedDataIdentifierIds -> (список)

Массив уникальных идентификаторов, по одному для каждого управляемого идентификатора данных, который задание явно настроено включать (использовать) или исключать (не использовать) при анализе данных. Включение или исключение зависит от типа выбора управляемого идентификатора данных, указанного для задания (managedDataIdentifierSelector).

Это значение равно null, если тип выбора управляемого идентификатора данных задания — ALL, NONE или RECOMMENDED.

(строка)

managedDataIdentifierSelector -> (строка)

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

ALL - Использовать все управляемые идентификаторы данных.
EXCLUDE - Использовать все управляемые идентификаторы данных, кроме указанных в свойстве managedDataIdentifierIds.
INCLUDE - Использовать только управляемые идентификаторы данных, указанные в свойстве managedDataIdentifierIds.
NONE - Не использовать ни одного управляемого идентификатора данных. Использовать только пользовательские идентификаторы данных (customDataIdentifierIds).
RECOMMENDED (по умолчанию) - Использовать рекомендуемый набор управляемых идентификаторов данных.

Если это значение равно null, задание использует рекомендуемый набор управляемых идентификаторов данных.

Если задание повторяющееся, и это значение — ALL или EXCLUDE, каждый запуск задания автоматически использует новые управляемые идентификаторы данных, которые выпускаются. Если это значение равно null или RECOMMENDED для повторяющегося задания, каждый запуск задания использует все управляемые идентификаторы данных, которые входят в рекомендуемый набор на момент начала запуска.

Чтобы узнать о каждом управляемом идентификаторе данных или определить, какие из них входят в рекомендуемый набор, см. Использование управляемых идентификаторов данных или Рекомендованные управляемые идентификаторы данных в Руководстве пользователя Amazon Macie.

name -> (строка)

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

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

Ведра S3, содержащие объекты для анализа, и объем этого анализа.

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 -> (список)

(структура)

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

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

comparator -> (строка)

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

key -> (строка)

Свойство для использования в условии.

values -> (список)

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

(строка)

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

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

comparator -> (строка)

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

tagValues -> (список)

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

(структура)

key -> (строка)

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

value -> (строка)

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

bucketDefinitions -> (список)

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

(структура)

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

accountId -> (строка)

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

buckets -> (список)

Массив, в котором перечислены имена ведер.

(строка)

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

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

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

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

and -> (список)

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

(структура)

Определяет условие на основе свойств или тегов, определяющее критерии для включения или исключения объектов S3 из задачи классификации. Объект JobScopeTerm может содержать только один объект simpleScopeTerm или один объект tagScopeTerm.

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

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

comparator -> (строка)

Оператор, используемый в условии. Допустимые значения для каждого поддерживаемого свойства (ключа) такие:

OBJECT_EXTENSION - РАВНО (equals) или НЕ РАВНО (not equals)
OBJECT_KEY - НАЧИНАЕТСЯ С (STARTS_WITH)
OBJECT_LAST_MODIFIED_DATE - РАВНО (equals), БОЛЬШЕ (GT), БОЛЬШЕ ИЛИ РАВНО (GTE), МЕНЬШЕ (LT), МЕНЬШЕ ИЛИ РАВНО (LTE) или НЕ РАВНО (not equals)
OBJECT_SIZE - РАВНО (equals), БОЛЬШЕ (GT), БОЛЬШЕ ИЛИ РАВНО (GTE), МЕНЬШЕ (LT), МЕНЬШЕ ИЛИ РАВНО (LTE) или НЕ РАВНО (not equals)

key -> (строка)

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

values -> (список)

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

Допустимые значения для каждого поддерживаемого свойства (ключа) такие:

OBJECT_EXTENSION — строка, представляющая расширение имени файла объекта. Например: docx или pdf
OBJECT_KEY — строка, представляющая префикс ключа (имя папки или путь) объекта. Например: logs или awslogs/eventlogs. Это значение применяет условие к объектам, ключи (имена) которых начинаются с указанного значения.
OBJECT_LAST_MODIFIED_DATE — дата и время (в UTC и расширенном формате ISO 8601) создания или последнего изменения объекта, то есть более позднее из двух. Например: 2023-09-24T14:31:13Z
OBJECT_SIZE — целое число, представляющее размер хранилища (в байтах) объекта.

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

(строка)

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

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

comparator -> (строка)

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

key -> (строка)

Свойство объекта, используемое в условии. Единственное допустимое значение — TAG.

tagValues -> (список)

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

(структура)

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

key -> (строка)

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

value -> (строка)

Значение тега, связанное с указанным ключом тега (ключ), используемое в условии. Чтобы указать только ключ тега в условии, укажите ключ тега для свойства key и установите это значение в пустую строку.

target -> (строка)

Тип объекта, к которому применяется условие.

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

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

and -> (список)

(структура)

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

comparator -> (строка)

Оператор, используемый в условии. Допустимые значения для каждого поддерживаемого свойства (ключа) такие:

OBJECT_EXTENSION - РАВНО (equals) или НЕ РАВНО (not equals)
OBJECT_KEY - НАЧИНАЕТСЯ С (STARTS_WITH)
OBJECT_LAST_MODIFIED_DATE - РАВНО (equals), БОЛЬШЕ (GT), БОЛЬШЕ ИЛИ РАВНО (GTE), МЕНЬШЕ (LT), МЕНЬШЕ ИЛИ РАВНО (LTE) или НЕ РАВНО (not equals)
OBJECT_SIZE - РАВНО (equals), БОЛЬШЕ (GT), БОЛЬШЕ ИЛИ РАВНО (GTE), МЕНЬШЕ (LT), МЕНЬШЕ ИЛИ РАВНО (LTE) или НЕ РАВНО (not equals)

key -> (строка)

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

values -> (список)

Допустимые значения для каждого поддерживаемого свойства (ключа) такие:

OBJECT_EXTENSION — строка, представляющая расширение имени файла объекта. Например: docx или pdf
OBJECT_KEY — строка, представляющая префикс ключа (имя папки или путь) объекта. Например: logs или awslogs/eventlogs. Это значение применяет условие к объектам, ключи (имена) которых начинаются с указанного значения.
OBJECT_LAST_MODIFIED_DATE — дата и время (в UTC и расширенном формате ISO 8601) создания или последнего изменения объекта, то есть более позднее из двух. Например: 2023-09-24T14:31:13Z
OBJECT_SIZE — целое число, представляющее размер хранилища (в байтах) объекта.

(строка)

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

Глубина выборки в процентах, определяющая процент подходящих объектов, которые анализирует задача.

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

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

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

Указывает схему ежедневного повторения запуска задачи.

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

Указывает схему ежемесячного повторения запуска задачи.

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

Числовое число месяца, когда Amazon Macie запускает задачу. Это значение может быть целым числом от 1 до 31.

Если это значение превышает количество дней в определенном месяце, Macie не запускает задачу в этом месяце. Macie запускает задачу только в месяцах, имеющих указанный день. Например, если это значение равно 31, а месяц имеет только 30 дней, Macie не запускает задачу в этом месяце. Чтобы запускать задачу каждый месяц, укажите значение меньше 29.

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

Указывает схему еженедельного повторения запуска задачи.

dayOfWeek -> (строка)

День недели, когда Amazon Macie запускает задачу.

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

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

approximateNumberOfObjectsToProcess -> (двойное число)

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

numberOfRuns -> (двойное число)

Количество запусков задачи.

tags -> (карта)

Карта пар ключ-значение, которая определяет, какие теги (ключи и значения) связаны с задачей.

key -> (строка)

value -> (строка)

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

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

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

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

jobImminentExpirationHealthEventArn -> (строка)

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

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

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