Update Role Description

iam_update_role_description

R Documentation

Use UpdateRole instead

Description

Use update_role instead.

Modifies only the description of a role. This operation performs the same function as the Description parameter in the update_role operation.

Usage

iam_update_role_description(RoleName, Description)

Arguments

RoleName

[required] The name of the role that you want to modify.

Description

[required] The new description that you want to apply to the specified role.

Value

A list with the following syntax:

list(
  Role = list(
    Path = "string",
    RoleName = "string",
    RoleId = "string",
    Arn = "string",
    CreateDate = as.POSIXct(
      "2015-01-01"
    ),
    AssumeRolePolicyDocument = "string",
    Description = "string",
    MaxSessionDuration = 123,
    PermissionsBoundary = list(
      PermissionsBoundaryType = "PermissionsBoundaryPolicy",
      PermissionsBoundaryArn = "string"
    ),
    Tags = list(
      list(
        Key = "string",
        Value = "string"
      )
    ),
    RoleLastUsed = list(
      LastUsedDate = as.POSIXct(
        "2015-01-01"
      ),
      Region = "string"
    )
  )
)

Request syntax

svc$update_role_description(
  RoleName = "string",
  Description = "string"
)