Menu
AWS Identity and Access Management
API Reference (API Version 2010-05-08)

Role

Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles.

Contents

Arn

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide guide.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

AssumeRolePolicyDocument

The policy that grants an entity permission to assume the role.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 131072.

Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Required: No

CreateDate

The date and time, in ISO 8601 date-time format, when the role was created.

Type: Timestamp

Required: Yes

Description

A description of the role that you provide.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: [\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*

Required: No

MaxSessionDuration

The maximum session duration (in seconds) for the specified role. Anyone who uses the AWS CLI or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

Type: Integer

Valid Range: Minimum value of 3600. Maximum value of 43200.

Required: No

Path

The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Required: Yes

RoleId

The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.

Type: String

Length Constraints: Minimum length of 16. Maximum length of 128.

Pattern: [\w]+

Required: Yes

RoleName

The friendly name that identifies the role.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\w+=,.@-]+

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: