Spec-Zone.ru › AWS CLI v2

[ aws . ram ]

get-resource-shares

Описание

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

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

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

Синтаксис

  get-resource-shares
[--resource-share-arns <value>]
[--resource-share-status <value>]
--resource-owner <value>
[--name <value>]
[--tag-filters <value>]
[--permission-arn <value>]
[--permission-version <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-share-arns (список)

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

(строка)

Синтаксис:

"string" "string" ...

--resource-share-status (строка)

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

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

  • PENDING
  • ACTIVE
  • FAILED
  • DELETING
  • DELETED

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

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

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

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

  • SELF
  • OTHER-ACCOUNTS

--name (строка)

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

--tag-filters (список)

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

(структура)

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

tagKey -> (строка)

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

tagValues -> (список)

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

(строка)

Сокращённый синтаксис:

tagKey=string,tagValues=string,string ...

Синтаксис JSON:

[
  {
    "tagKey": "string",
    "tagValues": ["string", ...]
  }
  ...
]

--permission-arn (строка)

Указывает, что вы хотите получить сведения только о тех ресурсных разделах, которые используют управляемое разрешение с этим Amazon Resource Name (ARN).

--permission-version (целое число)

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

--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-auto-prompt (логическое)

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

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

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

Примеры

Примечание

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

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

Пример 1: Список ресурсных разделов, которые вы владеете и которыми поделились с другими

В следующем get-resource-shares примере перечислены ресурсные разделы, которые были созданы и с которыми поделились с другими.

aws ram get-resource-shares \
    --resource-owner SELF

Вывод:

{
    "resourceShares": [
        {
            "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/3ab63985-99d9-1cd2-7d24-75e93EXAMPLE",
            "name": "my-resource-share",
            "owningAccountId": "123456789012",
            "allowExternalPrincipals": false,
            "status": "ACTIVE",
            "tags": [
                {
                    "key": "project",
                    "value": "lima"
                }
            ]
            "creationTime": 1565295733.282,
            "lastUpdatedTime": 1565295733.282
        },
        {
            "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE",
            "name": "my-resource-share",
            "owningAccountId": "123456789012",
            "allowExternalPrincipals": true,
            "status": "ACTIVE",
            "creationTime": 1565295733.282,
            "lastUpdatedTime": 1565295733.282
        }
    ]
}

Пример 2: Список ресурсных разделов, созданных другими и с которыми вы поделились

В следующем get-resource-shares примере перечислены ресурсные разделы, которые были созданы другими и с которыми вы поделились. В этом примере таких нет.

aws ram get-resource-shares \
    --resource-owner OTHER-ACCOUNTS

Вывод:

{
    "resourceShares": []
}

Вывод

resourceShares -> (список)

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

(структура)

Описывает ресурсное совместное пространство в оперативной памяти.

resourceShareArn -> (строка)

Amazon Resource Name (ARN) ресурсного совместного пространства

name -> (строка)

Имя ресурсного совместного пространства.

owningAccountId -> (строка)

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

allowExternalPrincipals -> (булево)

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

  • True – ресурсное совместное пространство может быть разделено с любой учетной записью Amazon Web Services.
  • False – ресурсное совместное пространство может быть разделено только с учетными записями в той же организации, что и учетной записью, владеющей ресурсным совместным пространством.

status -> (строка)

Текущий статус ресурсного совместного пространства.

statusMessage -> (строка)

Сообщение о статусе ресурсного совместного пространства.

tags -> (список)

Ключи и значения тегов, прикрепленных к ресурсному совместному пространству.

(структура)

Структура, содержащая тег. Тег — это метаданные, которые вы можете прикрепить к своим ресурсам, чтобы помочь организовать и классифицировать их. Вы также можете использовать их для защиты ресурсов. Дополнительную информацию см. в разделе Управление доступом к ресурсам Amazon Web Services с помощью тегов.

Дополнительную информацию о тегах см. в разделе Тегирование ресурсов Amazon Web Services в Руководстве Amazon Web Services General Reference Guide.

key -> (строка)

Ключ или имя, прикрепленное к тегу. Каждый тег должен иметь ключ. Имена ключей чувствительны к регистру.

value -> (строка)

Строковое значение, прикрепленное к тегу. Значение может быть пустой строкой. Значения ключей чувствительны к регистру.

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

Дата и время создания ресурсного совместного пространства.

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

Дата и время последнего обновления ресурсного совместного пространства.

featureSet -> (строка)

Указывает, какие функции доступны для этого ресурсного совместного пространства. Этот параметр может иметь одно из следующих значений:

  • STANDARD – ресурсное совместное пространство, поддерживающее все функции. Эти ресурсные совместные пространства видны всем принципалам, с которыми вы делитесь ресурсным совместным пространством. Вы можете изменять эти ресурсные совместные пространства в RAM с помощью консоли или API. Это ресурсное совместное пространство может быть создано RAM, или оно может быть CREATED_FROM_POLICY, а затем продвинуто.
  • CREATED_FROM_POLICY – клиент вручную поделился ресурсом, прикрепив политику на основе ресурса. Эта политика не соответствовала никаким существующим управляемым разрешениям, поэтому RAM автоматически создал это управляемое клиентом разрешение от имени клиента на основе прикрепленного документа политики. Этот тип ресурсного совместного пространства виден только учетной записи Amazon Web Services, которая его создала. Вы не можете изменить его в RAM, пока не переведете в стандартный режим.
  • PROMOTING_TO_STANDARD – это ресурсное совместное пространство изначально CREATED_FROM_POLICY, но клиент запустил PromoteResourceShareCreatedFromPolicy, и эта операция все еще выполняется. Это значение меняется на STANDARD по завершении.

nextToken -> (строка)

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

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

Spec-Zone.ru

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