Spec-Zone.ru › AWS CLI v2

[ aws . sagemaker ]

describe-processing-job

Описание

Возвращает описание задания обработки.

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

Синтаксис

  describe-processing-job
--processing-job-name <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]

Параметры

--processing-job-name (строка)

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

--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 (строка)

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

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

--query (строка)

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

--profile (строка)

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

--region (строка)

Область, которую нужно использовать. Переопределяет настройки конфигурации/окружения.

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Вывод

ProcessingInputs -> (список)

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

(структура)

Вводные данные для задачи обработки. Вводные данные обработки должны указывать ровно один из типов S3Input или DatasetDefinition.

InputName -> (строка)

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

AppManaged -> (булево)

Когда True , операции ввода, такие как загрузка данных, управляются непосредственно приложением задачи обработки. Когда False (по умолчанию), операции ввода управляются Amazon SageMaker.

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

Настройки для загрузки входных данных из Amazon S3 в контейнер обработки.

S3Uri -> (строка)

URI префикса Amazon S3, из которого Amazon SageMaker загружает данные, необходимые для выполнения задачи обработки.

LocalPath -> (строка)

Локальный путь в вашем контейнере, куда Amazon SageMaker должен записать входные данные. LocalPath — это абсолютный путь к входным данным и должен начинаться с /opt/ml/processing/. LocalPath — это обязательный параметр, когда AppManaged равен False (по умолчанию).

S3DataType -> (строка)

Используется ли S3Prefix или ManifestFile для типа данных. Если выбран S3Prefix, S3Uri идентифицирует префикс имени ключа. Amazon SageMaker использует все объекты с указанным префиксом имени ключа для задачи обработки. Если выбран ManifestFile, S3Uri идентифицирует объект, который является файлом манифеста, содержащим список ключей объектов, которые Amazon SageMaker должен использовать для задачи обработки.

S3InputMode -> (строка)

Используется ли режим ввода File или Pipe. В режиме файла Amazon SageMaker копирует данные из источника во временный объем локального хранилища перед запуском контейнера обработки. Это наиболее часто используемый режим ввода. В режиме Pipe Amazon SageMaker передает входные данные из источника непосредственно в контейнер обработки в именованные каналы без использования временного объема локального хранилища.

S3DataDistributionType -> (строка)

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

S3CompressionType -> (строка)

Нужно ли выполнять GZIP-распаковку данных в Amazon S3 по мере их потоковой передачи в контейнер обработки. Gzip может быть использовано только при указании режима Pipe в качестве режима S3InputMode. В режиме Pipe Amazon SageMaker передает входные данные из источника непосредственно в контейнер без использования тома EBS.

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

Настройки для входных данных определения набора данных.

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

Настройки для входных данных определения набора данных Athena.

Catalog -> (строка)

Имя каталога данных, используемого в Athena для выполнения запросов.

Database -> (строка)

Имя базы данных, используемой в Athena для выполнения запросов.

QueryString -> (строка)

SQL-запросы для выполнения.

WorkGroup -> (строка)

Имя рабочей группы, в которой запускается запрос Athena.

OutputS3Uri -> (строка)

Расположение в Amazon S3, где хранятся результаты запроса Athena.

KmsKeyId -> (строка)

Ключ Amazon Web Services Key Management Service (Amazon Web Services KMS), используемый Amazon SageMaker для шифрования данных, созданных при выполнении запроса Athena.

OutputFormat -> (строка)

Формат хранения данных для результатов запроса Athena.

OutputCompression -> (строка)

Сжатие, используемое для результатов запроса Athena.

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

Настройки для входных данных определения набора данных Redshift.

ClusterId -> (строка)

Идентификатор кластера Redshift.

Database -> (строка)

Имя базы данных Redshift, используемой при выполнении запроса Redshift.

DbUser -> (строка)

Имя пользователя базы данных, используемое при выполнении запроса Redshift.

QueryString -> (строка)

SQL-запросы для выполнения.

ClusterRoleArn -> (строка)

IAM-роль, прикрепленная к вашему кластеру Redshift, которую Amazon SageMaker использует для создания наборов данных.

OutputS3Uri -> (строка)

Расположение в Amazon S3, где хранятся результаты запроса Redshift.

KmsKeyId -> (строка)

Ключ Amazon Web Services Key Management Service (Amazon Web Services KMS), используемый Amazon SageMaker для шифрования данных из выполнения Redshift.

OutputFormat -> (строка)

Формат хранения данных для результатов запроса Redshift.

OutputCompression -> (строка)

Сжатие, используемое для результатов запроса Redshift.

LocalPath -> (строка)

Локальный путь, куда Amazon SageMaker должен загрузить входные данные определения набора данных для выполнения задачи обработки. LocalPath — это абсолютный путь к входным данным. Это обязательный параметр, когда AppManaged равен False (по умолчанию).

DataDistributionType -> (строка)

Создаваемый набор данных — FullyReplicated или ShardedByS3Key (по умолчанию).

InputMode -> (строка)

Используется ли режим ввода File или Pipe. В режиме File (по умолчанию) Amazon SageMaker копирует данные из источника в локальные тома Amazon Elastic Block Store (Amazon EBS) перед запуском алгоритма обучения. Это наиболее часто используемый режим ввода. В режиме Pipe Amazon SageMaker передает входные данные из источника непосредственно в алгоритм без использования тома EBS.

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

Настройки вывода для задачи обработки.

Outputs -> (список)

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

(структура)

Описание результатов задачи обработки. Выходные данные обработки должны указывать ровно один из типов S3Output или FeatureStoreOutput.

OutputName -> (строка)

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

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

Настройки для выходных данных задачи обработки в Amazon S3.

S3Uri -> (строка)

URI, определяющий ведро Amazon S3, куда Amazon SageMaker должен сохранить результаты задачи обработки.

LocalPath -> (строка)

Локальный путь к каталогу, куда Amazon SageMaker должен загрузить содержимое в Amazon S3. LocalPath — это абсолютный путь к каталогу, содержащему выходные файлы. Этот каталог будет создан платформой и существовать при вызове точки входа вашего контейнера.

S3UploadMode -> (строка)

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

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

Настройки для выходных данных задачи обработки в Amazon SageMaker Feature Store. Этот тип выходных данных обработки поддерживается только при указании AppManaged.

FeatureGroupName -> (строка)

Имя Amazon SageMaker FeatureGroup, используемое в качестве назначения для выходных данных задачи обработки. Обратите внимание, что ваша скрипт обработки отвечает за размещение записей в Feature Store.

AppManaged -> (булево)

Когда True , операции вывода, такие как загрузка данных, управляются непосредственно приложением задачи обработки. Когда False (по умолчанию), операции вывода управляются Amazon SageMaker.

KmsKeyId -> (строка)

Ключ Amazon Web Services Key Management Service (Amazon Web Services KMS), используемый Amazon SageMaker для шифрования выходных данных задачи обработки. KmsKeyId может быть идентификатором ключа KMS, ARN ключа KMS или псевдонимом ключа KMS. KmsKeyId применяется ко всем выходам.

ProcessingJobName -> (строка)

Имя задачи обработки. Имя должно быть уникальным в данном регионе Amazon Web Services и для учетной записи Amazon Web Services.

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

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

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

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

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

Количество экземпляров вычислительных машин ML, используемых в задаче обработки. Для распределенных задач обработки укажите значение больше 1. По умолчанию — 1.

InstanceType -> (строка)

Тип вычислительного экземпляра ML для задачи обработки.

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

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

Примечание

Некоторые экземпляры на основе Nitro включают локальное хранилище с фиксированным общим размером, зависящим от типа экземпляра. При использовании этих экземпляров для обработки Amazon SageMaker подключает локальное хранилище экземпляра вместо хранилища Amazon EBS gp2. Вы не можете запросить VolumeSizeInGB, превышающий общий размер локального хранилища экземпляра.

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

VolumeKmsKeyId -> (строка)

Ключ Amazon Web Services Key Management Service (Amazon Web Services KMS), который Amazon SageMaker использует для шифрования данных на томе хранилища, подключенном к экземплярам вычислительной машины ML, выполняющим задачу обработки.

Примечание

Некоторые экземпляры на основе Nitro включают локальное хранилище, зависящее от типа экземпляра. Тома локального хранилища шифруются с помощью аппаратного модуля на экземпляре. Вы не можете запросить VolumeKmsKeyId при использовании типа экземпляра с локальным хранилищем.

Список типов экземпляров, поддерживающих локальное хранилище экземпляров, см. в разделе Тома хранилища экземпляров.

Дополнительную информацию о шифровании локального хранилища экземпляра см. в разделе Тома хранилища экземпляров SSD.

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

Ограничение по времени выполнения задачи обработки.

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

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

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

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

ImageUri -> (строка)

Изображение контейнера, которое должна выполнить задача обработки.

ContainerEntrypoint -> (список)

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

(строка)

ContainerArguments -> (список)

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

(строка)

Environment -> (массив)

Переменные среды, установленные в контейнере Docker.

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

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

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

Параметры сети для обработки задания.

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

Нужно ли шифровать все коммуникации между распределенными заданиями обработки. Выберите True, чтобы зашифровать коммуникации. Шифрование обеспечивает большую безопасность для распределенных заданий обработки, но обработка может занять больше времени.

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

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

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

Указывает виртуальную частную сеть Amazon (VPC), к которой имеют доступ ваши задания SageMaker, размещенные модели и вычислительные ресурсы. Вы можете контролировать доступ к ресурсам и из них, настроив VPC. Дополнительную информацию см. в разделе Предоставление SageMaker доступа к ресурсам в вашей Amazon VPC.

SecurityGroupIds -> (список)

Идентификаторы групп безопасности VPC в формате sg-xxxxxxxx. Укажите группы безопасности для VPC, указанной в поле Subnets.

(строка)

Subnets -> (список)

Идентификатор подсетей в VPC, к которым вы хотите подключить задание обучения или модель. Информацию о доступности определенных типов экземпляров см. в разделе Поддерживаемые типы экземпляров и доступные зоны.

(строка)

RoleArn -> (строка)

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

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

Конфигурационная информация, используемая для создания эксперимента.

ExperimentName -> (строка)

Имя существующего эксперимента, который нужно связать с компонентом испытания.

TrialName -> (строка)

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

TrialComponentDisplayName -> (строка)

Имя для отображения компонента испытания. Если этот ключ не указан, имя для отображения — это имя компонента испытания.

RunName -> (строка)

Имя выполнения эксперимента, которое нужно связать с компонентом испытания.

ProcessingJobArn -> (строка)

Идентификатор ресурса Amazon (ARN) задания обработки.

ProcessingJobStatus -> (строка)

Предоставляет статус задания обработки.

ExitMessage -> (строка)

Необязательная строка размером до одного КБ, содержащая метаданные из контейнера обработки при выходе задания обработки.

FailureReason -> (строка)

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

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

Время завершения задания обработки.

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

Время начала задания обработки.

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

Время последнего изменения задания обработки.

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

Время создания задания обработки.

MonitoringScheduleArn -> (строка)

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

AutoMLJobArn -> (строка)

ARN задания AutoML, связанного с этим заданием обработки.

TrainingJobArn -> (строка)

ARN задания обучения, связанного с этим заданием обработки.

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

Spec-Zone.ru

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