Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

создать-политику-доступа

Описание

Создаёт политику доступа, предоставляющую указанному идентификатору (пользователю IAM Identity Center, группе IAM Identity Center или пользователю IAM) доступ к указанному порталу или ресурсу проекта IoT SiteWise Monitor.

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

Синтаксис

  create-access-policy
--access-policy-identity <value>
--access-policy-resource <value>
--access-policy-permission <value>
[--client-token <value>]
[--tags <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]

Параметры

--access-policy-identity (структура)

Идентификатор для этой политики доступа. Выберите пользователя IAM Identity Center, группу IAM Identity Center или пользователя IAM.

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

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

id -> (строка)

ID пользователя IAM Identity Center.

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

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

id -> (строка)

ID группы IAM Identity Center.

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

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

arn -> (строка)

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

Примечание

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

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

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

arn -> (строка)

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

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

user={id=string},group={id=string},iamUser={arn=string},iamRole={arn=string}

Синтаксис JSON:

{
  "user": {
    "id": "string"
  },
  "group": {
    "id": "string"
  },
  "iamUser": {
    "arn": "string"
  },
  "iamRole": {
    "arn": "string"
  }
}

--access-policy-resource (структура)

Ресурс IoT SiteWise Monitor для этой политики доступа. Выберите либо портал, либо проект.

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

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

id -> (строка)

ID портала.

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

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

id -> (строка)

ID проекта.

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

portal={id=string},project={id=string}

Синтаксис JSON:

{
  "portal": {
    "id": "string"
  },
  "project": {
    "id": "string"
  }
}

--access-policy-permission (строка)

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

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

  • ADMINISTRATOR
  • VIEWER

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

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

--tags (массив)

Список пар ключ-значение, содержащих метаданные для политики доступа. Дополнительная информация в руководстве пользователя IoT SiteWise в разделе "Размещение тегов ресурсов IoT SiteWise".

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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 команды на указанный.

--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 (булево)

Автоматический запрос параметров командной строки.

--no-cli-auto-prompt (булево)

Отключение автоматического запроса параметров командной строки.

Примеры

Примечание

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

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

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

Следующий create-access-policy пример создаёт политику доступа, предоставляющую пользователю административный доступ к веб-порталу для компании, занимающейся ветроэнергетикой.

aws iotsitewise create-access-policy \
    --cli-input-json file://create-portal-administrator-access-policy.json

Содержимое create-portal-administrator-access-policy.json:

{
    "accessPolicyIdentity": {
        "user": {
            "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
        }
    },
    "accessPolicyPermission": "ADMINISTRATOR",
    "accessPolicyResource": {
        "portal": {
            "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE"
        }
    }
}

Вывод:

{
    "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE",
    "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE"
}

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

Пример 2: Предоставление пользователю только для чтения доступа к проекту

Следующий create-access-policy пример создаёт политику доступа, предоставляющую пользователю доступ только для чтения к проекту ветроэнергетики.

aws iotsitewise create-access-policy \
    --cli-input-json file://create-project-viewer-access-policy.json

Содержимое create-project-viewer-access-policy.json:

{
    "accessPolicyIdentity": {
        "user": {
            "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
        }
    },
    "accessPolicyPermission": "VIEWER",
    "accessPolicyResource": {
        "project": {
            "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE"
        }
    }
}

Вывод:

{
    "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE",
    "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE"
}

Дополнительную информацию см. в руководстве по применению функций мониторинга AWS IoT SiteWise в разделе Назначение просмотрщиков проекта.

Вывод

accessPolicyId -> (строка)

ID политики доступа.

accessPolicyArn -> (строка)

ARN политики доступа, имеющей следующий формат.

arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

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

Spec-Zone.ru

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