IAM / Client / list_groups

list_groups#

IAM.Client.list_groups(**kwargs)#

Lists the IAM groups that have the specified path prefix.

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

See also: AWS API Documentation

Request Syntax

response = client.list_groups(
    PathPrefix='string',
    Marker='string',
    MaxItems=123
)
Parameters:
  • PathPrefix (string) –

    The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.

    This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. 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.

  • Marker (string) – 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 (integer) –

    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 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.

Return type:

dict

Returns:

Response Syntax

{
    'Groups': [
        {
            'Path': 'string',
            'GroupName': 'string',
            'GroupId': 'string',
            'Arn': 'string',
            'CreateDate': datetime(2015, 1, 1)
        },
    ],
    'IsTruncated': True|False,
    'Marker': 'string'
}

Response Structure

  • (dict) –

    Contains the response to a successful ListGroups request.

    • Groups (list) –

      A list of groups.

      • (dict) –

        Contains information about an IAM group entity.

        This data type is used as a response element in the following operations:

        • CreateGroup

        • GetGroup

        • ListGroups

        • Path (string) –

          The path to the group. For more information about paths, see IAM identifiers in the IAM User Guide.

        • GroupName (string) –

          The friendly name that identifies the group.

        • GroupId (string) –

          The stable and unique string identifying the group. For more information about IDs, see IAM identifiers in the IAM User Guide.

        • Arn (string) –

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

        • CreateDate (datetime) –

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

    • 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.

Exceptions

  • IAM.Client.exceptions.ServiceFailureException

Examples

The following command lists the IAM groups in the current account:

response = client.list_groups(
)

print(response)

Expected Output:

{
    'Groups': [
        {
            'Arn': 'arn:aws:iam::123456789012:group/Admins',
            'CreateDate': datetime(2016, 12, 15, 21, 40, 8, 3, 350, 0),
            'GroupId': 'AGPA1111111111EXAMPLE',
            'GroupName': 'Admins',
            'Path': '/division_abc/subdivision_xyz/',
        },
        {
            'Arn': 'arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test',
            'CreateDate': datetime(2016, 11, 30, 14, 10, 1, 2, 335, 0),
            'GroupId': 'AGP22222222222EXAMPLE',
            'GroupName': 'Test',
            'Path': '/division_abc/subdivision_xyz/product_1234/engineering/',
        },
        {
            'Arn': 'arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers',
            'CreateDate': datetime(2016, 6, 12, 20, 14, 52, 6, 164, 0),
            'GroupId': 'AGPI3333333333EXAMPLE',
            'GroupName': 'Managers',
            'Path': '/division_abc/subdivision_xyz/product_1234/',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}