- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
AddUserToGroupCommand
Adds the specified user to the specified group.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IAMClient, AddUserToGroupCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, AddUserToGroupCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // AddUserToGroupRequest
GroupName: "STRING_VALUE", // required
UserName: "STRING_VALUE", // required
};
const command = new AddUserToGroupCommand(input);
const response = await client.send(command);
// {};
Example Usage
AddUserToGroupCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
GroupName Required | string | undefined | The name of the group to update. This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.- |
UserName Required | string | undefined | The name of the user to add. This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.- |
AddUserToGroupCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
LimitExceededException | client | The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded. |
NoSuchEntityException | client | The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource. |
ServiceFailureException | server | The request processing has failed because of an unknown error, exception or failure. |
IAMServiceException | Base exception class for all service exceptions from IAM service. |