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, go to Working with Roles.

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

Refer to AWS API Documentation.

Refer to AWS help for descriptions of global parameters.

list-roles is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the Roles query expression.

Synopsis

list-roles
  [--path-prefix <value>]
  [--max-items <value>]
  [--starting-token <value>]
  [--page-size <value>]

Options

--path-prefix (string)

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 “!” (u0021) through the DEL character (u007F), including most punctuation characters, digits, and upper and lowercased letters.

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, refer to Pagination in the AWS Command Line Interface User Guide.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, refer to Pagination in the AWS Command Line Interface User Guide.

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, refer to Pagination in the AWS Command Line Interface User Guide.

Refer to AWS help for descriptions of global parameters.

Examples

To list IAM roles for the current account

The following list-roles command lists IAM roles for the current account

aws iam list-roles

Output example:

{
  "Roles": [
    {
      "AssumeRolePolicyDocument": {
        "Version": "2012-10-17",
        "Statement": [
          {
            "Action": "sts:AssumeRole",
            "Principal": {
              "Service": "ec2.amazonaws.com"
            },
            "Effect": "Allow",
            "Sid": ""
          }
        ]
      },
      "RoleId": "AROAJ52OTH4H7LEXAMPLE",
      "CreateDate": "2013-05-11T00:02:27Z",
      "RoleName": "ExampleRole1",
      "Path": "/",
      "Arn": "arn:aws:iam::123456789012:role/ExampleRole1"
    },
    {
      "AssumeRolePolicyDocument": {
        "Version": "2012-10-17",
        "Statement": [
          {
            "Action": "sts:AssumeRole",
            "Principal": {
              "Service": "elastictranscoder.amazonaws.com"
            },
            "Effect": "Allow",
            "Sid": ""
          }
        ]
      },
      "RoleId": "AROAI4QRP7UFT7EXAMPLE",
      "CreateDate": "2013-04-18T05:01:58Z",
      "RoleName": "emr-access",
      "Path": "/",
      "Arn": "arn:aws:iam::123456789012:role/emr-access"
    }
  ]
}

For more information, refer to Creating a Role in the Using IAM guide.

Output

Roles -> (list)

A list of roles.

(structure)

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

Description -> (string)

A description of the role.

Path -> (string)

The path to the role. For more information about paths, refer to the AWS IAM Identifiers documentation.

RoleName -> (string)

The friendly name that identifies the role.

RoleId -> (string)

The stable and unique string identifying the role. For more information about IDs, refer to the AWS IAM Identifiers documentation.

Arn -> (string)

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, refer to the AWS IAM Identifiers documentation.

CreateDate -> (timestamp)

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

AssumeRolePolicyDocument -> (string)

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

MaxSessionDuration -> (integer)

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.

IsTruncated -> (boolean)

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

Marker -> (string)

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.