IAM / Client / create_group

create_group#

IAM.Client.create_group(**kwargs)#

Creates a new group.

For information about the number of groups you can create, see IAM and STS quotas in the IAM User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_group(
    Path='string',
    GroupName='string'
)
Parameters:

  • Path (string) –

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

    This parameter is optional. If it is not included, it defaults to a slash (/).

    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.

  • GroupName (string) –

    [REQUIRED]

    The name of the group to create. Do not include the path in this value.

    IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both “MyResource” and “myresource”.

Return type:

dict

Returns:

Response Syntax

{
    'Group': {
        'Path': 'string',
        'GroupName': 'string',
        'GroupId': 'string',
        'Arn': 'string',
        'CreateDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    Contains the response to a successful CreateGroup request.

    • Group (dict) –

      A structure containing details about the new group.

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

Exceptions

  • IAM.Client.exceptions.LimitExceededException

  • IAM.Client.exceptions.EntityAlreadyExistsException

  • IAM.Client.exceptions.NoSuchEntityException

  • IAM.Client.exceptions.ServiceFailureException

Examples

The following command creates an IAM group named Admins.

response = client.create_group(
    GroupName='Admins',
)

print(response)

Expected Output:

{
    'Group': {
        'Arn': 'arn:aws:iam::123456789012:group/Admins',
        'CreateDate': datetime(2015, 3, 9, 20, 30, 24, 0, 68, 0),
        'GroupId': 'AIDGPMS9RO4H3FEXAMPLE',
        'GroupName': 'Admins',
        'Path': '/',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}