Skip to main content

IAM List Roles

Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, see Working with roles.

IAM resource-listing operations return a subset of the available attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a role, see GetRole.

You can paginate the results using the MaxItems and Marker parameters.

External Documentation

To learn more, visit the AWS documentation.

Basic Parameters

ParameterDescription
AWS Region(s)Enter the desired AWS Region(s).

To execute the action in multiple regions, provide a comma-separated list.
For example: us-east-1,eu-west-2.

If you wish to run the action in all available regions, use the asterisk symbol (*) instead.
Path PrefixThe path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \u0021) through the DEL character ( \u007F), including most punctuation characters, digits, and upper and lowercased letters.

Advanced Parameters

ParameterDescription
Disable XML To JSON Auto ConvertWhen checked, XML responses are not automatically converted into JSON format.
MarkerUse this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
Max ItemsUse this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Example Output

{
"IsTruncated": false,
"Marker": "string",
"Roles": [
{
"Arn": "\u003cp\u003eThe Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.\u003c/p\u003e \u003cp\u003eFor more information about ARNs, go to \u003ca href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"\u003eAmazon Resource Names (ARNs)\u003c/a\u003e in the \u003ci\u003eAmazon Web Services General Reference\u003c/i\u003e. \u003c/p\u003e",
"AssumeRolePolicyDocument": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+",
"CreateDate": "date-time",
"Description": "[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*",
"MaxSessionDuration": 0,
"Path": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)",
"PermissionsBoundary": {
"PermissionsBoundaryArn": "\u003cp\u003eThe Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.\u003c/p\u003e \u003cp\u003eFor more information about ARNs, go to \u003ca href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\"\u003eAmazon Resource Names (ARNs)\u003c/a\u003e in the \u003ci\u003eAmazon Web Services General Reference\u003c/i\u003e. \u003c/p\u003e",
"PermissionsBoundaryType": "string"
},
"RoleId": "[\\w]+",
"RoleLastUsed": {
"LastUsedDate": "date-time",
"Region": "string"
},
"RoleName": "[\\w+=,.@-]+",
"Tags": [
{
"Key": "[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+",
"Value": "[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*"
}
]
}
]
}

Automation Library Example

Iam List Roles with Aws and Send Results Via Email

Automation LibraryPreview this Automation on desktop