Spec-Zone.ru › AWS CLI v2

[ aws . databrew ]

update-profile-job

Описание

Изменяет определение существующей задачи профилирования.

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

Синтаксис

  update-profile-job
[--configuration <value>]
[--encryption-key-arn <value>]
[--encryption-mode <value>]
--name <value>
[--log-subscription <value>]
[--max-capacity <value>]
[--max-retries <value>]
--output-location <value>
[--validation-configurations <value>]
--role-arn <value>
[--timeout <value>]
[--job-sample <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]

Параметры

--configuration (структура)

Конфигурация для задач профилирования. Используется для выбора столбцов, выполнения оценок и переопределения параметров оценок по умолчанию. Если конфигурация равна null, задача профилирования будет выполнена с параметрами по умолчанию.

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

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

IncludedStatistics -> (список)

Список включенных оценок. Если список не определён, будут включены все поддерживаемые оценки.

(строка)

Overrides -> (список)

Список переопределений для оценок.

(структура)

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

Statistic -> (строка)

Имя оценки

Parameters -> (массив)

Массив, содержащий переопределения параметров оценки.

ключ -> (строка)

значение -> (строка)

ProfileColumns -> (список)

Список селекторов столбцов. ProfileColumns могут использоваться для выбора столбцов из набора данных. Если ProfileColumns не определены, задача профилирования проанализирует все поддерживаемые столбцы.

(структура)

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

Regex -> (строка)

Регулярное выражение для выбора столбца из набора данных.

Name -> (строка)

Имя столбца из набора данных.

ColumnStatisticsConfigurations -> (список)

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

(структура)

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

Selectors -> (список)

Список селекторов столбцов. Селекторы могут использоваться для выбора столбцов из набора данных. Если селекторы не определены, конфигурация будет применена ко всем поддерживаемым столбцам.

(структура)

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

Regex -> (строка)

Регулярное выражение для выбора столбца из набора данных.

Name -> (строка)

Имя столбца из набора данных.

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

Конфигурация для оценок. Statistics могут использоваться для выбора оценок и переопределения параметров оценок.

IncludedStatistics -> (список)

Список включенных оценок. Если список не определён, будут включены все поддерживаемые оценки.

(строка)

Overrides -> (список)

Список переопределений для оценок.

(структура)

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

Statistic -> (строка)

Имя оценки

Parameters -> (массив)

Массив, содержащий переопределения параметров оценки.

ключ -> (строка)

значение -> (строка)

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

Конфигурация обнаружения сущностей для задачи профилирования. Если не определена, обнаружение сущностей отключено.

EntityTypes -> (список)

Типы сущностей для обнаружения. Могут быть любыми из следующих:

  • USA_SSN
  • EMAIL
  • USA_ITIN
  • USA_PASSPORT_NUMBER
  • PHONE_NUMBER
  • USA_DRIVING_LICENSE
  • BANK_ACCOUNT
  • CREDIT_CARD
  • IP_ADDRESS
  • MAC_ADDRESS
  • USA_DEA_NUMBER
  • USA_HCPCS_CODE
  • USA_NATIONAL_PROVIDER_IDENTIFIER
  • USA_NATIONAL_DRUG_CODE
  • USA_HEALTH_INSURANCE_CLAIM_NUMBER
  • USA_MEDICARE_BENEFICIARY_IDENTIFIER
  • USA_CPT_CODE
  • PERSON_NAME
  • DATE

Также поддерживается тип сущности USA_ALL, который включает все вышеперечисленные типы сущностей, за исключением PERSON_NAME и DATE.

(строка)

AllowedStatistics -> (список)

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

(структура)

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

Statistics -> (список)

Одна или несколько статистик столбцов для разрешения столбцов, содержащих обнаруженные сущности.

(строка)

JSON-синтаксис:

{
  "DatasetStatisticsConfiguration": {
    "IncludedStatistics": ["string", ...],
    "Overrides": [
      {
        "Statistic": "string",
        "Parameters": {"string": "string"
          ...}
      }
      ...
    ]
  },
  "ProfileColumns": [
    {
      "Regex": "string",
      "Name": "string"
    }
    ...
  ],
  "ColumnStatisticsConfigurations": [
    {
      "Selectors": [
        {
          "Regex": "string",
          "Name": "string"
        }
        ...
      ],
      "Statistics": {
        "IncludedStatistics": ["string", ...],
        "Overrides": [
          {
            "Statistic": "string",
            "Parameters": {"string": "string"
              ...}
          }
          ...
        ]
      }
    }
    ...
  ],
  "EntityDetectorConfiguration": {
    "EntityTypes": ["string", ...],
    "AllowedStatistics": [
      {
        "Statistics": ["string", ...]
      }
      ...
    ]
  }
}

--encryption-key-arn (строка)

Amazon Resource Name (ARN) ключа шифрования, используемого для защиты задачи.

--encryption-mode (строка)

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

  • SSE-KMS — Шифрование на стороне сервера с ключами, управляемыми KMS.
  • SSE-S3 — Шифрование на стороне сервера с ключами, управляемыми Amazon S3.

Возможные значения:

  • SSE-KMS
  • SSE-S3

--name (строка)

Имя задачи, подлежащей обновлению.

--log-subscription (строка)

Включает или отключает ведение журнала Amazon CloudWatch для задачи. Если ведение журнала включено, CloudWatch записывает один журнал потока для каждого выполнения задачи.

Возможные значения:

  • ENABLE
  • DISABLE

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

Максимальное количество вычислительных узлов, которые DataBrew может использовать при обработке данных задачей.

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

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

--output-location (структура)

Представляет расположение Amazon S3 (имя ведра, владелец ведра и ключевое имя объекта), где DataBrew может читать входные данные или записывать выходные данные из задачи.

Bucket -> (строка)

Имя ведра Amazon S3.

Key -> (строка)

Уникальное имя объекта в ведре.

BucketOwner -> (строка)

Идентификатор учетной записи Amazon Web Services владельца ведра.

Краткая запись:

Bucket=string,Key=string,BucketOwner=string

JSON-синтаксис:

{
  "Bucket": "string",
  "Key": "string",
  "BucketOwner": "string"
}

--validation-configurations (список)

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

(структура)

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

RulesetArn -> (строка)

Amazon Resource Name (ARN) набора правил, подлежащего проверке в задаче профилирования. TargetArn выбранного набора правил должен совпадать с Amazon Resource Name (ARN) набора данных, связанного с задачей профилирования.

ValidationMode -> (строка)

Режим проверки качества данных. Режим по умолчанию — «CHECK_ALL», который проверяет все правила, определенные в выбранном наборе правил.

Краткая запись:

RulesetArn=string,ValidationMode=string ...

JSON-синтаксис:

[
  {
    "RulesetArn": "string",
    "ValidationMode": "CHECK_ALL"
  }
  ...
]

--role-arn (строка)

Amazon Resource Name (ARN) роли Identity and Access Management (IAM), которая должна быть принята при запуске DataBrew.

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

Таймаут задачи в минутах. Задача, которая пытается выполнить работу дольше этого таймаута, завершается со статусом TIMEOUT.

--job-sample (структура)

Конфигурация выборки только для задач профилирования. Определяет количество строк, на которых будет выполняться задача профилирования. Если значение JobSample не указано для задач профилирования, будет использоваться значение по умолчанию. Значение по умолчанию — CUSTOM_ROWS для параметра mode и 20000 для параметра size.

Mode -> (строка)

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

  • FULL_DATASET — Задача профилирования выполняется на всем наборе данных.
  • CUSTOM_ROWS — Задача профилирования выполняется на количестве строк, указанном в параметре Size.

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

Параметр Size требуется только в том случае, если режим равен CUSTOM_ROWS. Задача профилирования выполняется на указанном количестве строк. Максимальное значение для размера равно Long.MAX_VALUE.

Long.MAX_VALUE = 9223372036854775807

Краткая запись:

Mode=string,Size=long

JSON-синтаксис:

{
  "Mode": "FULL_DATASET"|"CUSTOM_ROWS",
  "Size": long
}

--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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить вывод пейджера CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

Имя -> (string)

Имя задачи, которая была обновлена.

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

Spec-Zone.ru

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