UpdateRoleRequest

APIs.ioEngineeringPlatform

Properties

Name Type Description
RoleName object
Description object
MaxSessionDuration object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-updaterolerequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateRoleRequest",
  "title": "UpdateRoleRequest",
  "type": "object",
  "required": [
    "RoleName"
  ],
  "properties": {
    "RoleName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/roleNameType"
        },
        {
          "description": "The name of the role that you want to modify."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/roleDescriptionType"
        },
        {
          "description": "The new description that you want to apply to the specified role."
        }
      ]
    },
    "MaxSessionDuration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/roleMaxSessionDurationType"
        },
        {
          "description": "<p>The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.</p> <p>Anyone who assumes the role from the CLI or API can use the <code>DurationSeconds</code> API parameter or the <code>duration-seconds</code> CLI parameter to request a longer session. The <code>MaxSessionDuration</code> setting determines the maximum duration that can be requested using the <code>DurationSeconds</code> parameter. If users don't specify a value for the <code>DurationSeconds</code> parameter, their security credentials are valid for one hour by default. This applies when you use the <code>AssumeRole*</code> API operations or the <code>assume-role*</code> CLI operations but does not apply when you use those operations to create a console URL. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html\">Using IAM roles</a> in the <i>IAM User Guide</i>.</p>"
        }
      ]
    }
  }
}