Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

обновить-описание-роли

Описание

Используйте UpdateRole вместо этого.

Изменяет только описание роли. Эта операция выполняет ту же функцию, что и параметр Description в операции UpdateRole.

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

Синтаксис

  update-role-description
--role-name <value>
--description <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]

Параметры

--role-name (строка)

Имя роли, которую нужно изменить.

--description (строка)

Новое описание, которое нужно применить к указанной роли.

--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 по умолчанию команды указанным 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-auto-prompt (логическое)

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

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

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

Примеры

Примечание

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

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

Для изменения описания роли IAM

Следующая update-role команда изменяет описание роли IAM production-role на Main production role.

aws iam update-role-description \
    --role-name production-role \
    --description 'Main production role'

Вывод:

{
    "Role": {
        "Path": "/",
        "RoleName": "production-role",
        "RoleId": "AROA1234567890EXAMPLE",
        "Arn": "arn:aws:iam::123456789012:role/production-role",
        "CreateDate": "2017-12-06T17:16:37+00:00",
        "AssumeRolePolicyDocument": {
            "Version": "2012-10-17",
            "Statement": [
                {
                    "Effect": "Allow",
                    "Principal": {
                        "AWS": "arn:aws:iam::123456789012:root"
                    },
                    "Action": "sts:AssumeRole",
                    "Condition": {}
                }
            ]
        },
        "Description": "Main production role"
    }
}

Дополнительную информацию см. в разделе «Изменение роли» в руководстве пользователя AWS IAM.

Вывод

Роль -> (структура)

Структура, содержащая подробности о изменённой роли.

Путь -> (строка)

Путь к роли. Дополнительную информацию о путях см. в разделе «Идентификаторы IAM» в руководстве пользователя IAM.

ИмяРоли -> (строка)

Дружественное имя, идентифицирующее роль.

ИдентификаторРоли -> (строка)

Устойчивая и уникальная строка, идентифицирующая роль. Дополнительную информацию об идентификаторах см. в разделе «Идентификаторы IAM» в руководстве пользователя IAM.

Arn -> (строка)

Amazon Resource Name (ARN), определяющий роль. Дополнительную информацию об ARN и их использовании в политиках см. в разделе «Идентификаторы IAM» в руководстве пользователя IAM.

ДатаСоздание -> (метка времени)

Дата и время создания роли в формате даты и времени ISO 8601.

AssumeRolePolicyDocument -> (строка)

Политика, предоставляющая сущности разрешение на принятие роли.

Описание -> (строка)

Описание роли, которое вы предоставите.

MaxSessionDuration -> (целое число)

Максимальная продолжительность сеанса (в секундах) для указанной роли. Любой, кто использует CLI или API для принятия роли, может указать продолжительность с помощью необязательного параметра API DurationSeconds или параметра CLI duration-seconds.

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

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

Дополнительную информацию о границах разрешений см. в разделе «Границы разрешений для идентификаторов IAM» в руководстве пользователя IAM.

PermissionsBoundaryType -> (строка)

Тип использования границ разрешений, указывающий, какой тип ресурса IAM используется в качестве границы разрешений для сущности. Этот тип данных может иметь только значение Policy.

PermissionsBoundaryArn -> (строка)

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

Теги -> (список)

Список тегов, прикрепленных к роли. Дополнительную информацию о тегах см. в разделе «Маркирование ресурсов IAM» в руководстве пользователя IAM.

(структура)

Структура, представляющая пользовательские метаданные, которые можно связать с ресурсом IAM. Дополнительную информацию о тегах см. в разделе «Маркирование ресурсов IAM» в руководстве пользователя IAM.

Ключ -> (строка)

Имя ключа, которое можно использовать для поиска или получения связанного значения. Например, Department или Cost Center - распространенные варианты.

Значение -> (строка)

Значение, связанное с этим тегом. Например, теги с именем ключа Department могут иметь значения, такие как Human Resources, Accounting и Support. Теги с именем ключа Cost Center могут иметь значения, состоящие из числа, связанного с различными центрами затрат в вашей компании. Как правило, многие ресурсы имеют теги с одинаковым именем ключа, но с разными значениями.

Примечание

AWS всегда интерпретирует тег Value как одну строку. Если вам нужно сохранить массив, вы можете сохранить значения, разделенные запятыми, в строке. Однако вам необходимо интерпретировать значение в вашем коде.

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

Содержит информацию о последнем использовании роли IAM. Включает дату и время, а также регион, в котором роль была использована в последний раз. Информация о деятельности отслеживается только за последние 400 дней. Этот период может быть короче, если ваш регион начал поддерживать эти функции в течение последнего года. Возможные случаи, когда роль могла быть использована более 400 дней назад. Дополнительную информацию см. в разделе «Регионы, где данные отслеживаются» в руководстве пользователя IAM.

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

Дата и время последнего использования роли в формате даты и времени ISO 8601.

Это поле имеет значение null, если роль не использовалась в течение отслеживаемого периода IAM. Дополнительную информацию об отслеживаемом периоде см. в разделе «Регионы, где отслеживаются данные» в руководстве пользователя IAM.

Регион -> (строка)

Название региона Amazon Web Services, в котором роль была использована в последний раз.

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

Spec-Zone.ru

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