Creates a new group.
For information about the number of groups you can create, see IAM and AWS STS quotas in the IAM User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- GroupName
-
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".
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=,.@-]+Required: Yes
- Path
-
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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
(\u002F)|(\u002F[\u0021-\u007E]+\u002F)Required: No
Response Elements
The following element is returned by the service.
- Group
-
A structure containing details about the new group.
Type: Group object
Errors
For information about the errors that are common to all actions, see Common Errors.
- EntityAlreadyExists
-
The request was rejected because it attempted to create a resource that already exists.
HTTP Status Code: 409
- LimitExceeded
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
HTTP Status Code: 409
- NoSuchEntity
-
The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
HTTP Status Code: 404
- ServiceFailure
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of CreateGroup.
Sample Request
https://iam.amazonaws.com/?Action=CreateGroup
&GroupName=Admins
&Version=2010-05-08
&AUTHPARAMSSample Response
<CreateGroupResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
<CreateGroupResult>
<Group>
<Path>/</Path>
<GroupName>Admins</GroupName>
<GroupId>AGPACKCEVSQ6C2EXAMPLE</GroupId>
<Arn>arn:aws:iam::123456789012:group/Admins</Arn>
</Group>
</CreateGroupResult>
<ResponseMetadata>
<RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
</ResponseMetadata>
</CreateGroupResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
