Class CreateAccessKeyCommandProtected

Creates a new Amazon Web Services secret access key and corresponding Amazon Web Services access key ID for the specified user. The default status for new keys is Active.

If you do not specify a user name, IAM determines the user name implicitly based on the Amazon Web Services access key ID signing the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials. This is true even if the Amazon Web Services account has no associated users.

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

To ensure the security of your Amazon Web Services account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

Example

Use a bare-bones client and the command you need to make an API call.

import { IAMClient, CreateAccessKeyCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, CreateAccessKeyCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // CreateAccessKeyRequest
  UserName: "STRING_VALUE",
};
const command = new CreateAccessKeyCommand(input);
const response = await client.send(command);
// { // CreateAccessKeyResponse
//   AccessKey: { // AccessKey
//     UserName: "STRING_VALUE", // required
//     AccessKeyId: "STRING_VALUE", // required
//     Status: "Active" || "Inactive", // required
//     SecretAccessKey: "STRING_VALUE", // required
//     CreateDate: new Date("TIMESTAMP"),
//   },
// };

Param

CreateAccessKeyCommandInput

Returns

CreateAccessKeyCommandOutput

See

• CreateAccessKeyCommandInput for command's input shape.
• CreateAccessKeyCommandOutput for command's response shape.
• config for IAMClient's config shape.

Throws

LimitExceededException (client fault)

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.

Throws

NoSuchEntityException (client fault)

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

Throws

ServiceFailureException (server fault)

The request processing has failed because of an unknown error, exception or failure.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.

Example

To create an access key for an IAM user

// The following command creates an access key (access key ID and secret access key) for the IAM user named Bob.
const input = {
  "UserName": "Bob"
};
const command = new CreateAccessKeyCommand(input);
const response = await client.send(command);
/* response ==
{
  "AccessKey": {
    "AccessKeyId": "AKIAIOSFODNN7EXAMPLE",
    "CreateDate": "2015-03-09T18:39:23.411Z",
    "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY",
    "Status": "Active",
    "UserName": "Bob"
  }
}
*/
// example id: 1fbb3211-4cf2-41db-8c20-ba58d9f5802d