describe-task

Описание

Предоставляет информацию о задаче, которая определяет место и способ передачи данных DataSync.

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

Синтаксис

  describe-task
--task-arn <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]

Параметры

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

Указывает Amazon Resource Name (ARN) задачи передачи, о которой вы хотите получить информацию.

--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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

TaskArn -> (строка)

ARN вашей задачи.

Статус -> (строка)

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

Имя -> (строка)

Имя вашей задачи.

CurrentTaskExecutionArn -> (строка)

ARN последнего выполнения задачи.

SourceLocationArn -> (строка)

ARN исходного расположения вашей передачи.

DestinationLocationArn -> (строка)

ARN целевого расположения вашей передачи.

CloudWatchLogGroupArn -> (строка)

Amazon Resource Name (ARN) группы журналов Amazon CloudWatch для мониторинга вашей задачи.

Для получения дополнительной информации, см. Мониторинг передачи данных с помощью журналов CloudWatch.

SourceNetworkInterfaceArns -> (список)

ARN сетевых интерфейсов, созданных DataSync для вашего исходного расположения.

(строка)

DestinationNetworkInterfaceArns -> (список)

ARN сетевых интерфейсов, созданных DataSync для вашего целевого расположения.

(строка)

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

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

VerifyMode -> (строка)

Указывает, проверяет ли DataSync целостность данных в конце передачи и как.

ONLY_FILES_TRANSFERRED (рекомендуется) — DataSync вычисляет контрольную сумму передаваемых данных (включая метаданные) в исходном месте. В конце передачи DataSync сравнивает эту контрольную сумму с контрольной суммой, вычисленной для этих данных в пункте назначения.

Примечание

Это значение по умолчанию для задач в режиме Улучшенный.

Рекомендуется использовать этот параметр при передаче в хранилище Amazon S3 Glacier Flexible Retrieval или Amazon S3 Glacier Deep Archive. Дополнительная информация в разделе Учет особенностей хранилища при работе с расположениями Amazon S3.

POINT_IN_TIME_CONSISTENT — В конце передачи DataSync проверяет весь исходный и конечный пункты назначения, чтобы убедиться, что оба расположения полностью синхронизированы.

Примечание

Это значение по умолчанию для задач в режиме Базовый и в данный момент не поддерживается для задач в режиме Улучшенный.

Если используется манифест, DataSync сканирует и проверяет только указанные в нём элементы. Данный параметр нельзя использовать при передаче в хранилище Amazon S3 Glacier Flexible Retrieval или Amazon S3 Glacier Deep Archive. Дополнительная информация в разделе Учет особенностей хранилища при работе с расположениями Amazon S3.

NONE — DataSync выполняет проверки целостности данных только во время передачи. В отличие от других параметров, дополнительная проверка в конце передачи не выполняется.

OverwriteMode -> (строка)

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

ALWAYS (по умолчанию) — DataSync изменяет данные в пункте назначения, если исходные данные (включая метаданные) изменились. Если DataSync перезаписывает объекты, могут возникнуть дополнительные расходы для некоторых классов хранилища Amazon S3 (например, для получения или раннего удаления). Дополнительная информация в разделе Учет особенностей хранилища при передаче данных в Amazon S3.
NEVER — DataSync не перезаписывает данные в пункте назначения, даже если исходные данные изменились. Можно использовать этот параметр, чтобы предотвратить перезапись изменений, внесённых в файлы или объекты в пункте назначения.

Atime -> (строка)

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

Примечание

Поведение параметра Atime не является полностью стандартным для всех платформ, поэтому DataSync может выполнять это только в лучшем случае.

BEST_EFFORT (по умолчанию) — DataSync пытается сохранить исходное атрибут Atime во всех исходных файлах (т.е. версию до этапа PREPARING выполнения задачи). Рекомендуется использовать этот параметр.
NONE — Игнорирует Atime.

Примечание

Если Atime установлен в значение BEST_EFFORT, то Mtime должен быть установлен в значение PRESERVE.

Если Atime установлен в значение NONE, то Mtime также должен быть установлен в значение NONE.

Mtime -> (строка)

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

PRESERVE (по умолчанию) — Сохраняет исходное Mtime, что рекомендуется.
NONE — Игнорирует Mtime.

Примечание

Если Mtime установлен в значение PRESERVE, то Atime должен быть установлен в значение BEST_EFFORT.

Если Mtime установлен в значение NONE, то Atime также должен быть установлен в значение NONE.

Uid -> (строка)

Указывает идентификатор пользователя POSIX (UID) владельца файла.

INT_VALUE (по умолчанию) — Сохраняет целое значение UID и идентификатора группы (GID), что рекомендуется.
NONE — Игнорирует UID и GID.

Дополнительная информация в разделе Копируемые метаданные файлов DataSync.

Gid -> (строка)

Указывает идентификатор группы POSIX (GID) владельца файла.

INT_VALUE (по умолчанию) — Сохраняет целое значение идентификатора пользователя (UID) и GID, что рекомендуется.
NONE — Игнорирует UID и GID.

Дополнительная информация в разделе Понимание того, как DataSync обрабатывает метаданные файлов и объектов.

PreserveDeletedFiles -> (строка)

Указывает, сохранять ли файлы в пункте назначения, которых нет в исходном расположении. Этот параметр может повлиять на стоимость хранилища Amazon S3. Если задача удаляет объекты, могут возникнуть минимальные расходы на хранение для определённых классов хранилища. Подробная информация в разделе Учет особенностей хранилища Amazon S3 при работе с DataSync.

PRESERVE (по умолчанию) — Игнорирует такие файлы в пункте назначения, что рекомендуется.
REMOVE — Удаляет файлы в пункте назначения, отсутствующие в исходном.

Примечание

Если этот параметр установлен в значение REMOVE, то нельзя установить параметр TransferMode в значение ALL. При передаче всех данных DataSync не сканирует пункт назначения и не знает, что удалить.

PreserveDevices -> (строка)

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

Примечание

DataSync не может копировать фактическое содержимое этих устройств, поскольку они не являются терминальными и не возвращают маркер конца файла (EOF).

NONE (по умолчанию) — Игнорирует специальные устройства (рекомендуется).
PRESERVE — Сохраняет метаданные символьных и блочных устройств. В настоящее время этот параметр не поддерживается для Amazon EFS.

PosixPermissions -> (строка)

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

Дополнительная информация в разделе Понимание того, как DataSync обрабатывает метаданные файлов и объектов.

PRESERVE (по умолчанию) — Сохраняет права доступа в стиле POSIX, что рекомендуется.
NONE — Игнорирует права доступа в стиле POSIX.

Примечание

DataSync может сохранить существующие права доступа исходного расположения.

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

Ограничивает пропускную способность, используемую задачей DataSync. Например, если вы хотите, чтобы DataSync использовал максимум 1 МБ, установите это значение в 1048576 (=1024*1024).

Примечание

Не применимо к задачам в режиме Улучшенный.

TaskQueueing -> (строка)

Указывает, должны ли задачи передачи помещаться в очередь в определённых сценариях при выполнении нескольких задач. По умолчанию это ENABLED.

LogLevel -> (строка)

Указывает тип журналов, которые DataSync публикует в группу журналов Amazon CloudWatch Logs. Чтобы указать группу журналов, см. CloudWatchLogGroupArn.

BASIC — Публикует журналы только с базовой информацией (например, об ошибках передачи).
TRANSFER — Публикует журналы для всех файлов или объектов, которые передаёт и проверяет целостность данных задача DataSync.
OFF — Журналы не публикуются.

TransferMode -> (строка)

Указывает, передаёт ли DataSync только те данные (включая метаданные), которые отличаются между расположениями после начальной копии, или передаёт все данные каждый раз при запуске задачи. Если вы планируете повторяющиеся передачи, возможно, вы захотите передавать только изменения с момента предыдущего выполнения задачи.

CHANGED (по умолчанию) — После начальной полной передачи DataSync копирует только те данные и метаданные, которые отличаются между исходным и конечным расположениями.
ALL — DataSync копирует все данные из исходного расположения в конечное без сравнения различий между расположениями.

SecurityDescriptorCopyFlags -> (строка)

Указывает, какие компоненты дескриптора безопасности SMB копируются из исходных в целевые объекты.

Это значение используется только для передачи между расположениями SMB и Amazon FSx для Windows File Server или между двумя расположениями FSx для Windows File Server. Дополнительная информация в разделе Понимание того, как DataSync обрабатывает метаданные файлов и объектов.

OWNER_DACL (по умолчанию) — Для каждого скопированного объекта DataSync копирует следующие метаданные:
- Владельца объекта.
- NTFS-разрешения на доступ (DACL), определяющие, разрешать ли доступ к объекту. DataSync не копирует NTFS-системные разрешения на доступ (SACL) с этим параметром.
OWNER_DACL_SACL — Для каждого скопированного объекта DataSync копирует следующие метаданные:
- Владельца объекта.
- NTFS-разрешения на доступ (DACL), определяющие, разрешать ли доступ к объекту.
- SACL, которые используются администраторами для регистрации попыток доступа к защищённому объекту. Для копирования SACL необходимо предоставить дополнительные разрешения пользователю Windows, используемому DataSync для доступа к вашему расположению SMB. Информация о выборе пользователя с необходимыми разрешениями приведена в разделе Требуемые разрешения для SMB, FSx для Windows File Server или FSx для ONTAP (в зависимости от типа расположения в вашей передаче).
NONE — Ни один из компонентов дескриптора безопасности SMB не копируется. Владельцем целевых объектов является пользователь, предоставленный для доступа к целевому расположению. DACL и SACL устанавливаются на основе конфигурации целевого сервера.

ObjectTags -> (строка)

Указывает, хотите ли вы, чтобы DataSync PRESERVE теги объектов (поведение по умолчанию) при передаче между системами хранения объектов. Если вы хотите, чтобы ваша задача DataSync игнорировала теги объектов, укажите значение NONE.

Excludes -> (список)

Фильтры исключения, определяющие файлы, объекты и папки в вашем источнике, которые вы не хотите, чтобы DataSync переносил. Дополнительную информацию и примеры см. в разделе Указание, какие данные DataSync переносит с помощью фильтров.

(структура)

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

FilterType -> (строка)

Тип правила фильтрации для применения. DataSync поддерживает только тип правила SIMPLE_PATTERN.

Value -> (строка)

Одна строка фильтра, содержащая шаблоны для включения или исключения. Шаблоны разделяются символом «|» (т.е. вертикальной чертой), например: /folder1|/folder2

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

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

ScheduleExpression -> (строка)

Указывает расписание вашей задачи с помощью выражения cron или скорости.

Используйте выражения cron для расписаний задач, которые выполняются в определенное время и день. Например, следующее выражение cron создает расписание задачи, которое выполняется в 8:00 утра в первый среду каждого месяца:

cron(0 8 * * 3#1)

Используйте выражения скорости для расписаний задач, которые выполняются с определенным интервалом. Например, следующее выражение скорости создает расписание задачи, которое выполняется каждые 12 часов:

rate(12 hours)

Справочная информация о синтаксисе выражений cron и скорости см. в руководстве пользователя Amazon EventBridge ` Amazon EventBridge User Guide https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html`__ .

Status -> (строка)

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

DataSync может автоматически отключить расписание, если ваша задача неоднократно завершается неудачно с той же ошибкой. Дополнительную информацию см. в разделе TaskScheduleDetails.

ErrorCode -> (строка)

При возникновении проблемы с вашей задачей код ошибки поможет вам устранить проблему. Дополнительную информацию см. в разделе Устранение проблем с переносами DataSync.

ErrorDetail -> (строка)

При возникновении проблемы с вашей задачей подробные сведения об ошибке помогут вам устранить проблему. Дополнительную информацию см. в разделе Устранение проблем с переносами DataSync.

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

Время создания задачи.

Includes -> (список)

Фильтры включения, определяющие файлы, объекты и папки в вашем источнике, которые вы хотите, чтобы DataSync перенес. Дополнительную информацию и примеры см. в разделе Указание, какие данные DataSync переносит с помощью фильтров.

(структура)

FilterType -> (строка)

Тип правила фильтрации для применения. DataSync поддерживает только тип правила SIMPLE_PATTERN.

Value -> (строка)

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

Настройка манифеста, в котором перечислены файлы или объекты, которые вы хотите, чтобы DataSync перенес. Дополнительную информацию см. в разделе Указание, какие данные DataSync переносит с помощью манифеста.

Action -> (строка)

Указывает, для чего DataSync использует манифест.

Format -> (строка)

Указывает формат файла вашего манифеста. Дополнительную информацию см. в разделе Создание манифеста.

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

Указывает манифест, который вы хотите использовать DataSync, и место его размещения.

Примечание

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

В противном случае вы получите код состояния 400 и ошибку ValidationException, указывающую, что отсутствует роль IAM для доступа DataSync к ведру S3, где размещен ваш манифест. Дополнительную информацию см. в разделе Предоставление DataSync доступа к вашему манифесту.

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

Указывает ведро S3, где размещен ваш манифест.

ManifestObjectPath -> (строка)

Указывает ключ объекта Amazon S3 для вашего манифеста. Может включать префикс (например, prefix/my-manifest.csv).

BucketAccessRoleArn -> (строка)

Указывает роль управления доступом к ресурсам (IAM), которая разрешает DataSync доступ к вашему манифесту. Дополнительную информацию см. в разделе Предоставление DataSync доступа к вашему манифесту.

S3BucketArn -> (строка)

Указывает Amazon Resource Name (ARN) ведра S3, где размещен ваш манифест.

ManifestObjectVersionId -> (строка)

Указывает идентификатор версии объекта манифеста, который вы хотите использовать DataSync. Если это не установлено, DataSync использует последнюю версию объекта.

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

Настройка отчета о задаче, предоставляющая подробную информацию о переносе DataSync. Дополнительную информацию см. в разделе Мониторинг переносов DataSync с помощью отчетов о задачах.

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

Указывает ведро Amazon S3, в которое DataSync загружает отчет о задаче. Дополнительную информацию см. в разделе Отчеты о задачах.

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

Указывает ведро Amazon S3, в которое DataSync загружает отчет о задаче.

Subdirectory -> (строка)

Указывает префикс ведра для отчета.

S3BucketArn -> (строка)

Указывает ARN ведра S3, в которое DataSync загружает отчет.

BucketAccessRoleArn -> (строка)

Указывает Amazon Resource Name (ARN) политики IAM, которая разрешает DataSync загружать отчет о задаче в ведро S3. Дополнительную информацию см. в разделе Разрешение DataSync на загрузку отчета о задаче в ведро Amazon S3.

OutputType -> (строка)

Указывает тип отчета о задаче, который вы хотите:

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

ReportLevel -> (строка)

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

ERRORS_ONLY: Отчет показывает, что DataSync не смог перенести, пропустить, проверить и удалить.
SUCCESSES_AND_ERRORS: Отчет показывает, что DataSync смог и не смог перенести, пропустить, проверить и удалить.

ObjectVersionIds -> (строка)

Указывает, включает ли отчет о задаче новую версию каждого переданного объекта в ведро S3. Это применимо только в том случае, если вы включили версионирование в вашем ведре. Имейте в виду, что установка этого значения на INCLUDE может увеличить время выполнения вашей задачи.

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

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

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

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

ReportLevel -> (строка)

Указывает, должен ли отчет о задаче включать только ошибки или успехи и ошибки.

Например, ваш отчет может в основном содержать только то, что не прошло хорошо в процессе переноса (ERRORS_ONLY). В то же время вы хотите проверить, что ваш фильтр задачи работает правильно. В этой ситуации вы можете получить список файлов, которые DataSync успешно пропустил, и если что-то было перенесено, чего вы не должны были переносить (SUCCESSES_AND_ERRORS).

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

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

ReportLevel -> (строка)

Указывает, должен ли отчет о задаче включать только ошибки или успехи и ошибки.

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

Указывает уровень отчетности для файлов, объектов и каталогов, которые DataSync пытался удалить в месте назначения. Это применимо только в том случае, если вы настроите свою задачу на удаление данных в месте назначения, которых нет в источнике.

ReportLevel -> (строка)

Указывает, должен ли отчет о задаче включать только ошибки или успехи и ошибки.

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

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

ReportLevel -> (строка)

Указывает, должен ли отчет о задаче включать только ошибки или успехи и ошибки.

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

Подробности расписания вашей задачи.

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

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

DisabledReason -> (строка)

Приводит причину, если расписание задачи отключено.

Если ваше расписание отключено из-за USER, вы видите сообщение Manually disabled by user..

Если ваше расписание отключено из-за SERVICE, вы видите сообщение об ошибке, чтобы помочь вам понять, почему задача продолжает терпит неудачу. Сведения о решении проблем с DataSync см. в разделе Устранение неполадок при передачах DataSync.

DisabledBy -> (строка)

Указывает, как было отключено расписание вашей задачи.

USER - Ваше расписание было вручную отключено с помощью операции UpdateTask или консоли DataSync.
SERVICE - Ваше расписание было автоматически отключено DataSync, так как задача неоднократно терпит неудачу с той же ошибкой.

TaskMode -> (строка)

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