Spec-Zone.ru › AWS CLI v2

[ aws . ram ]

Список ресурсов

Описание

Отображает ресурсы, которые вы добавили в общий доступ к ресурсам или которые с вами поделили.

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

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

Синтаксис

  list-resources
--resource-owner <value>
[--principal <value>]
[--resource-type <value>]
[--resource-arns <value>]
[--resource-share-arns <value>]
[--resource-region-scope <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-owner (строка)

Указывает, что необходимо отобразить только те общие ресурсы, которые соответствуют следующим условиям:

  • **SELF ** – ресурсы, которые ваша учетная запись предоставляет для совместного использования другим учетным записям
  • **OTHER-ACCOUNTS ** – ресурсы, которые другие учетные записи предоставили для совместного использования вашей учетной записи

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

  • SELF
  • OTHER-ACCOUNTS

--principal (строка)

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

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

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

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

--resource-arns (список)

Указывает, что необходимо отобразить только те общие ресурсы, которые включают ресурсы с указанными Amazon Resource Names (ARN).

(строка)

Синтаксис:

"string" "string" ...

--resource-share-arns (список)

Указывает, что необходимо отобразить только ресурсы в общих ресурсах, идентифицированных указанными Amazon Resource Names (ARN).

(строка)

Синтаксис:

"string" "string" ...

--resource-region-scope (строка)

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

  • ALL – результаты включают как глобальные, так и региональные ресурсы или типы ресурсов.
  • GLOBAL – результаты включают только глобальные ресурсы или типы ресурсов.
  • REGIONAL – результаты включают только региональные ресурсы или типы ресурсов.

Значение по умолчанию — ALL.

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

  • ALL
  • REGIONAL
  • GLOBAL

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, сопоставленного с двоичным блоком, 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.

Примеры

Примечание

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

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

Для отображения ресурсов, связанных с общим доступом к ресурсам

Следующий пример list-resources отображает все ресурсы в указанном общем доступе к ресурсам, которые относятся к указанному типу ресурсов.

aws ram list-resources \
    --resource-type ec2:Subnet \
    --resource-owner SELF \
    --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE

Вывод:

{
    "resources": [
        {
            "arn": "aarn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235",
            "type": "ec2:Subnet",
            "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE",
            "creationTime": 1565301545.023,
            "lastUpdatedTime": 1565301545.947
        }
    ]
}

Вывод

resources -> (список)

Массив объектов, содержащих информацию о ресурсах.

(структура)

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

arn -> (строка)

Amazon Resource Name (ARN) ресурса.

type -> (строка)

Тип ресурса. Он имеет вид: service-code :resource-code и не чувствителен к регистру. Например, Amazon EC2 Subnet будет представлен строкой ec2:subnet .

resourceShareArn -> (строка)

Amazon Resource Name (ARN) общего доступа к ресурсам, с которым связан этот ресурс.

resourceGroupArn -> (строка)

Amazon Resource Name (ARN) группы ресурсов. Это значение доступно только если ресурс является частью группы ресурсов.

status -> (строка)

Текущий статус ресурса.

statusMessage -> (строка)

Сообщение о статусе ресурса.

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

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

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

Дата и время, когда последнее обновление связи между ресурсом и общим доступом к ресурсам.

resourceRegionScope -> (строка)

Указывает область видимости этого ресурса:

  • REGIONAL – К ресурсу можно получить доступ только с помощью запросов, ориентированных на Amazon Web Services Region, в котором существует ресурс.
  • GLOBAL – К ресурсу можно получить доступ из любого Amazon Web Services Region.

nextToken -> (строка)

Если присутствует, это значение указывает на то, что в текущем ответе доступно больше вывода. Используйте это значение в параметре запроса NextToken в последующем вызове операции, чтобы получить следующую часть вывода. Повторяйте этот процесс до тех пор, пока элемент ответа NextToken не вернёт значение null. Это означает, что это последняя страница результатов.

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

Spec-Zone.ru

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