Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

list-access-policies

Описание

Получает постраничный список политик доступа для идентификатора (пользователя IAM Identity Center, группы IAM Identity Center или пользователя IAM) или ресурса мониторинга IoT SiteWise (портала или проекта).

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

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

Синтаксис

  list-access-policies
[--identity-type <value>]
[--identity-id <value>]
[--resource-type <value>]
[--resource-id <value>]
[--iam-arn <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]

Параметры

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

Тип идентификатора (пользователь IAM Identity Center, группа IAM Identity Center или пользователь IAM). Этот параметр обязателен, если вы указываете identityId .

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

  • USER
  • GROUP
  • IAM

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

Идентификатор идентификатора. Этот параметр обязателен, если вы указываете USER или GROUP для identityType .

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

Тип ресурса (портал или проект). Этот параметр обязателен, если вы указываете resourceId .

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

  • PORTAL
  • PROJECT

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

Идентификатор ресурса. Этот параметр обязателен, если вы указываете resourceType .

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

ARN пользователя IAM. Дополнительную информацию см. в руководстве IAM по ARNs пользователей IAM . Этот параметр обязателен, если вы указываете IAM для identityType .

--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
  • таблица
  • 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.

Примеры

Примечание

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

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

Чтобы перечислить все политики доступа

В следующем примере list-access-policies перечислены все политики доступа для пользователя, являющегося администратором портала.

aws iotsitewise list-access-policies \
    --identity-type USER \
    --identity-id a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE

Вывод:

{
    "accessPolicySummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE",
            "identity": {
                "user": {
                    "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
                }
            },
            "resource": {
                "portal": {
                    "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE"
                }
            },
            "permission": "ADMINISTRATOR"
        }
    ]
}

Дополнительную информацию см. в разделе Управление порталами в Руководстве пользователя AWS IoT SiteWise.

Вывод

accessPolicySummaries -> (список)

Список, обобщающий каждую политику доступа.

(структура)

Содержит политику доступа, определяющую доступ идентификатора к ресурсу мониторинга IoT SiteWise.

id -> (строка)

Идентификатор политики доступа.

identity -> (структура)

Идентификатор (пользователь IAM Identity Center, группа IAM Identity Center или пользователь IAM).

user -> (структура)

Идентификатор пользователя IAM Identity Center.

id -> (строка)

Идентификатор пользователя IAM Identity Center.

group -> (структура)

Идентификатор группы IAM Identity Center.

id -> (строка)

Идентификатор группы IAM Identity Center.

iamUser -> (структура)

Идентификатор пользователя IAM.

arn -> (строка)

ARN пользователя IAM. Дополнительную информацию см. в руководстве IAM по ARNs пользователей IAM .

Примечание

Если вы удалите пользователя IAM, политики доступа, содержащие этот идентификатор, включают пустой arn . Вы можете удалить политику доступа для пользователя IAM, который больше не существует.

iamRole -> (структура)

Идентификатор роли IAM.

arn -> (строка)

ARN роли IAM. Дополнительную информацию см. в руководстве IAM по ARNs ролей IAM.

resource -> (структура)

Ресурс мониторинга IoT SiteWise (портал или проект).

portal -> (структура)

Ресурс портала.

id -> (строка)

Идентификатор портала.

project -> (структура)

Ресурс проекта.

id -> (строка)

Идентификатор проекта.

permission -> (строка)

Разрешения для политики доступа. Обратите внимание, что проект ADMINISTRATOR также известен как владелец проекта.

creationDate -> (временная метка)

Дата создания политики доступа в формате Unix epoch time.

lastUpdateDate -> (временная метка)

Дата последнего обновления политики доступа в формате Unix epoch time.

nextToken -> (строка)

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

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

Spec-Zone.ru

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