List Roles
iam_list_roles | R Documentation |
Lists the IAM roles that have the specified path prefix¶
Description¶
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 IAM roles in the IAM User Guide.
IAM resource-listing operations return a subset of the available attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
-
PermissionsBoundary
-
RoleLastUsed
-
Tags
To view all of the information for a role, see get_role
.
You can paginate the results using the MaxItems
and Marker
parameters.
Usage¶
Arguments¶
PathPrefix
The 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 ! (
U+0021
) through the DEL character (U+007F
), including most punctuation characters, digits, and upper and lowercased letters.Marker
Use 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.MaxItems
Use 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 istrue
.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 returnstrue
, andMarker
contains a value to include in the subsequent call that tells the service where to continue from.
Value¶
A list with the following syntax:
list(
Roles = list(
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"
)
)
),
IsTruncated = TRUE|FALSE,
Marker = "string"
)