Spec-Zone.ru › AWS CLI v2

[ aws . cloudcontrol ]

list-resource-requests

Описание

Возвращает существующие запросы операций с ресурсом. Включает запросы всех типов статусов. Дополнительную информацию см. в разделе Перечисление активных запросов операций с ресурсом в руководстве пользователя API облачного управления Amazon Web Services.

Примечание

Запросы операций с ресурсом истекают через 7 дней.

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

list-resource-requests является постраничным запросом. Для получения всего набора результатов могут быть отправлены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запросов: ResourceRequestStatusSummaries

Синтаксис

  list-resource-requests
[--resource-request-status-filter <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]

Параметры

--resource-request-status-filter (структура)

Критерии фильтрации, которые нужно применить к возвращаемым запросам.

Operations -> (список)

Типы операций, которые нужно включить в фильтр.

(строка)

OperationStatuses -> (список)

Статусы операций, которые нужно включить в фильтр.

  • PENDING : Запрос операции выполнен, но еще не инициирован.
  • IN_PROGRESS : Операция выполняется.
  • SUCCESS : Операция завершена.
  • FAILED : Операция завершилась ошибкой.
  • CANCEL_IN_PROGRESS : Операция отменяется.
  • CANCEL_COMPLETE : Операция отменена.

(строка)

Сокращенная форма записи:

Operations=string,string,OperationStatuses=string,string

Синтаксис JSON:

{
  "Operations": ["CREATE"|"DELETE"|"UPDATE", ...],
  "OperationStatuses": ["PENDING"|"IN_PROGRESS"|"SUCCESS"|"FAILED"|"CANCEL_IN_PROGRESS"|"CANCEL_COMPLETE", ...]
}

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве пользователя AWS CLI в разделе «Начало работы».

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в руководстве пользователя AWS CLI.

Для перечисления активных запросов операций с ресурсом

Следующий пример list-resource-requests перечисляет запросы ресурсов для операций CREATE и UPDATE, завершившихся ошибкой в вашей учетной записи AWS.

aws cloudcontrol list-resource-requests \
    --resource-request-status-filter Operations=CREATE,OperationStatuses=FAILED

Вывод:

{
    "ResourceRequestStatusSummaries": [
        {
            "TypeName": "AWS::Kinesis::Stream",
            "Identifier": "Demo",
            "RequestToken": "e1a6b86e-46bd-41ac-bfba-633abcdfdbd7",
            "Operation": "CREATE",
            "OperationStatus": "FAILED",
            "EventTime": 1632950268.481,
            "StatusMessage": "Resource of type 'AWS::Kinesis::Stream' with identifier 'Demo' already exists.",
            "ErrorCode": "AlreadyExists"
        }
    ]
}

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

Вывод

ResourceRequestStatusSummaries -> (список)

Запросы, соответствующие указанным критериям фильтрации.

(структура)

Представляет текущий статус запроса операции с ресурсом. Дополнительную информацию см. в разделе Управление запросами операций с ресурсами в руководстве пользователя API облачного управления Amazon Web Services.

TypeName -> (строка)

Имя типа ресурса, используемого в операции.

Identifier -> (строка)

Основной идентификатор ресурса.

Примечание

В некоторых случаях идентификатор ресурса может быть доступен до того, как операция с ресурсом достигнет статуса SUCCESS .

RequestToken -> (строка)

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

Используйте RequestToken с GetResourceRequestStatus, чтобы вернуть текущий статус запроса операции с ресурсом.

HooksRequestToken -> (строка)

Уникальный маркер, представляющий операцию Hooks для запроса.

Operation -> (строка)

Тип операции с ресурсом.

OperationStatus -> (строка)

Текущий статус запроса операции с ресурсом.

  • PENDING : Операция с ресурсом еще не началась.
  • IN_PROGRESS : Операция с ресурсом в настоящее время выполняется.
  • SUCCESS : Операция с ресурсом успешно завершена.
  • FAILED : Операция с ресурсом завершилась ошибкой. Для получения дополнительной информации см. код ошибки и сообщение об ошибке.
  • CANCEL_IN_PROGRESS : Операция с ресурсом в процессе отмены.
  • CANCEL_COMPLETE : Операция с ресурсом отменена.

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

Время начала запроса операции с ресурсом.

ResourceModel -> (строка)

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

StatusMessage -> (строка)

Любое сообщение, объясняющее текущий статус.

ErrorCode -> (строка)

Для запросов со статусом FAILED — соответствующий код ошибки.

Для определения кодов ошибок см. Коды ошибок обработчика в руководстве пользователя командной строки CloudFormation для разработки расширений.

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

Время для следующего запроса статуса этого запроса операции с ресурсом.

NextToken -> (строка)

Если запрос не возвращает все оставшиеся результаты, NextToken устанавливается в маркер. Для получения следующего набора результатов вызовите ListResources снова и присвойте этот маркер параметру NextToken объекта запроса. Если запрос возвращает все результаты, NextToken устанавливается в null.

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

Spec-Zone.ru

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