Spec-Zone.ru › AWS CLI v2

[ aws . backup ]

list-copy-job-summaries

Описание

Этот запрос получает список задач копирования, созданных или выполняемых в течение последних 30 дней. Вы можете использовать параметры AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults или NextToken для фильтрации результатов.

Этот запрос возвращает сводку, содержащую Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime и количество включенных задач.

См. также: AWS API Documentation

Синтаксис

  list-copy-job-summaries
[--account-id <value>]
[--state <value>]
[--resource-type <value>]
[--message-category <value>]
[--aggregation-period <value>]
[--max-results <value>]
[--next-token <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]

Параметры

--account-id (строка)

Возвращает количество задач для указанного аккаунта.

Если запрос отправлен из аккаунта-члена или аккаунта, не являющегося частью Amazon Web Services Organizations, будут возвращены задачи внутри аккаунта-запрашивающего.

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

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

--state (строка)

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

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

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

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

  • CREATED
  • RUNNING
  • ABORTING
  • ABORTED
  • COMPLETING
  • COMPLETED
  • FAILING
  • FAILED
  • PARTIAL
  • AGGREGATE_ALL
  • ANY

--resource-type (строка)

Возвращает количество задач для указанного типа ресурса. Используйте запрос GetSupportedResourceTypes для получения строк поддерживаемых типов ресурсов.

Значение ANY возвращает количество всех типов ресурсов.

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

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

--message-category (строка)

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

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

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

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

--aggregation-period (строка)

Период для возвращаемых результатов.

  • ONE_DAY - Ежедневное количество задач за последние 14 дней.
  • SEVEN_DAYS - Агрегированное количество задач за последние 7 дней.
  • FOURTEEN_DAYS - Агрегированное количество задач за последние 14 дней.

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

  • ONE_DAY
  • SEVEN_DAYS
  • FOURTEEN_DAYS

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

Этот параметр устанавливает максимальное количество возвращаемых элементов.

Значение является целым числом. Диапазон допустимых значений от 1 до 500.

--next-token (строка)

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

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

Вывод

CopyJobSummaries -> (список)

Этот результат показывает сводку, содержащую Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime и количество включенных задач.

(структура)

Это сводка задач копирования, созданных или выполняемых в течение последних 30 дней.

Возвращаемая сводка может содержать следующие данные: Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime и количество включенных задач.

Region -> (строка)

Регионы Amazon Web Services в сводке задач.

AccountId -> (строка)

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

State -> (строка)

Это значение — количество задач для заданного состояния.

ResourceType -> (строка)

Это значение — количество задач для указанного типа ресурса. Запрос GetSupportedResourceTypes возвращает строки для поддерживаемых типов ресурсов.

MessageCategory -> (строка)

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

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

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

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

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

Значение — количество задач в сводке.

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

Значение времени в числовом формате начала работы задачи.

Это значение — время в формате Unix, Coordinated Universal Time (UTC) и с точностью до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 г., 00:11:30.087.

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

Значение времени в числовом формате окончания работы задачи.

Это значение — время в формате Unix, Coordinated Universal Time (UTC) и с точностью до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 г., 00:11:30.087.

AggregationPeriod -> (строка)

Период для возвращаемых результатов.

  • ONE_DAY - Ежедневное количество задач за последние 14 дней.
  • SEVEN_DAYS - Агрегированное количество задач за последние 7 дней.
  • FOURTEEN_DAYS - Агрегированное количество задач за последние 14 дней.

NextToken -> (строка)

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

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

Spec-Zone.ru

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