Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

describe-copy-job

Описание

Возвращает метаданные, связанные с созданием копии ресурса.

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

Синтаксис

  describe-copy-job
--copy-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]

Параметры

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

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

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

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

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

Вывод

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

Содержит подробную информацию о задании копирования.

AccountId -> (строка)

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

CopyJobId -> (строка)

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

SourceBackupVaultArn -> (строка)

Идентификатор Amazon Resource Name (ARN) хранилища копий, являющегося источником; например, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

SourceRecoveryPointArn -> (строка)

ARN, уникально идентифицирующий исходную точку восстановления; например, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

DestinationBackupVaultArn -> (строка)

Идентификатор Amazon Resource Name (ARN) хранилища копий, являющегося местом назначения; например, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

DestinationRecoveryPointArn -> (строка)

ARN, уникально идентифицирующий точку восстановления назначения; например, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

ResourceArn -> (строка)

Ресурс Amazon Web Services, который необходимо скопировать; например, том Amazon Elastic Block Store (Amazon EBS) или база данных Amazon Relational Database Service (Amazon RDS).

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

Дата и время создания задания копирования в формате Unix и по координированному всемирному времени (UTC). Значение CreationDate точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.

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

Дата и время завершения задания копирования в формате Unix и по координированному всемирному времени (UTC). Значение CompletionDate точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.

State -> (строка)

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

StatusMessage -> (строка)

Подробное сообщение, объясняющее состояние задания копирования ресурса.

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

Размер задания копирования в байтах.

IamRoleArn -> (строка)

Указывает ARN роли IAM, используемой для копирования целевой точки восстановления; например, arn:aws:iam::123456789012:role/S3Access.

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

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

BackupPlanId -> (строка)

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

BackupPlanArn -> (строка)

Идентификатор Amazon Resource Name (ARN) плана резервного копирования; например, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

BackupPlanVersion -> (строка)

Идентификаторы версий представляют собой уникальные, случайным образом сгенерированные строки Unicode, закодированные в UTF-8, длиной не более 1024 байт. Их нельзя редактировать.

BackupRuleId -> (строка)

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

ResourceType -> (строка)

Тип ресурса Amazon Web Services, который необходимо скопировать; например, том Amazon Elastic Block Store (Amazon EBS) или база данных Amazon Relational Database Service (Amazon RDS).

ParentJobId -> (строка)

Уникально идентифицирует запрос к Backup для копирования ресурса. Возвращаемый идентификатор — родительский (составной) идентификатор задания.

IsParent -> (булево)

Булево значение, указывающее, является ли это родительским (составным) заданием копирования.

CompositeMemberIdentifier -> (строка)

Идентификатор ресурса в составной группе, например, вложенной (дочерней) точки восстановления, принадлежащей составной (родительской) структуре. ID переносится из логического ID внутри структуры.

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

Количество дочерних (вложенных) заданий копирования.

ChildJobsInState -> (карта)

Возвращает статистику по включённым дочерним (вложенным) заданиям копирования.

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

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

ResourceName -> (строка)

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

MessageCategory -> (строка)

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

Примеры строк могут включать AccessDenied , SUCCESS , AGGREGATE_ALL и InvalidParameters . Список строк MessageCategory см. в разделе Мониторинг.

Значение ANY возвращает количество всех категорий сообщений.

AGGREGATE_ALL агрегирует количество заданий для всех категорий сообщений и возвращает сумму.

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

Spec-Zone.ru

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