list-copy-jobs
Описание
Возвращает метаданные о ваших задачах копирования.
См. также: Документация API AWS
list-copy-jobs является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: CopyJobs
Синтаксис
list-copy-jobs
[--by-resource-arn <value>]
[--by-state <value>]
[--by-created-before <value>]
[--by-created-after <value>]
[--by-resource-type <value>]
[--by-destination-vault-arn <value>]
[--by-account-id <value>]
[--by-complete-before <value>]
[--by-complete-after <value>]
[--by-parent-job-id <value>]
[--by-message-category <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]
Параметры
--by-resource-arn (строка)
--by-state (строка)
Возвращает только задачи копирования, которые находятся в указанном состоянии.
Возможные значения:
CREATEDRUNNINGCOMPLETEDFAILEDPARTIAL
--by-created-before (метка времени)
--by-created-after (метка времени)
--by-resource-type (строка)
Возвращает только задачи резервного копирования для указанных ресурсов:
-
Auroraдля Amazon Aurora -
CloudFormationдля CloudFormation -
DocumentDBдля Amazon DocumentDB (с совместимостью MongoDB) -
DynamoDBдля Amazon DynamoDB -
EBSдля Amazon Elastic Block Store -
EC2для Amazon Elastic Compute Cloud -
EFSдля Amazon Elastic File System -
FSxдля Amazon FSx -
Neptuneдля Amazon Neptune -
RDSдля Amazon Relational Database Service -
Redshiftдля Amazon Redshift -
S3для Amazon Simple Storage Service (Amazon S3) -
SAP HANA on Amazon EC2для баз данных SAP HANA на экземплярах Amazon Elastic Compute Cloud -
Storage Gatewayдля Storage Gateway -
Timestreamдля Amazon Timestream -
VirtualMachineдля виртуальных машин VMware
--by-destination-vault-arn (строка)
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.--by-account-id (строка)
--by-complete-before (метка времени)
--by-complete-after (метка времени)
--by-parent-job-id (строка)
--by-message-category (строка)
Этот необязательный параметр может использоваться для фильтрации задач с MessageCategory, соответствующей введенному значению.
Примеры строк могут включать AccessDenied, SUCCESS, AGGREGATE_ALL и INVALIDPARAMETERS.
См. Мониторинг для списка допустимых строк.
Значение ANY возвращает количество всех категорий сообщений.
AGGREGATE_ALL агрегирует подсчет задач для всех категорий сообщений и возвращает сумму.--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения будут переопределять значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничного вывода. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.
--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.
Вывод
CopyJobs -> (список)
Массив структур, содержащих метаданные о ваших заданиях копирования, возвращаемых в формате JSON.
(структура)
Содержит подробную информацию о задании копирования.
AccountId -> (строка)
CopyJobId -> (строка)
SourceBackupVaultArn -> (строка)
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault .SourceRecoveryPointArn -> (строка)
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .DestinationBackupVaultArn -> (строка)
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault .DestinationRecoveryPointArn -> (строка)
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45 .ResourceArn -> (строка)
CreationDate -> (метка времени)
CreationDate точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 г., 00:11:30.087.CompletionDate -> (метка времени)
CompletionDate точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 г., 00:11:30.087.State -> (строка)
StatusMessage -> (строка)
BackupSizeInBytes -> (целое число большого размера)
IamRoleArn -> (строка)
arn:aws:iam::123456789012:role/S3Access .CreatedBy -> (структура)
Содержит информацию о плане резервного копирования и правиле, которые Backup использовал для инициирования резервного копирования точки восстановления.
BackupPlanId -> (строка)
BackupPlanArn -> (строка)
arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .BackupPlanVersion -> (строка)
BackupRuleId -> (строка)
ResourceType -> (строка)
ParentJobId -> (строка)
IsParent -> (булево)
CompositeMemberIdentifier -> (строка)
NumberOfChildJobs -> (целое число большого размера)
ChildJobsInState -> (карта)
Возвращает статистику включенных дочерних (вложенных) заданий копирования.
ключ -> (строка)
значение -> (целое число большого размера)
ResourceName -> (строка)
MessageCategory -> (строка)
Этот параметр представляет количество заданий для указанной категории сообщений.
Примеры строк могут включать AccessDenied , SUCCESS , AGGREGATE_ALL и InvalidParameters . Список строк MessageCategory см. в разделе Мониторинг.
Значение ANY возвращает количество всех категорий сообщений.
AGGREGATE_ALL агрегирует количество заданий для всех категорий сообщений и возвращает суммуNextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.