- 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.
CreateAccessKeyCommand
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 Syntax
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"),
// },
// };
Example Usage
CreateAccessKeyCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
UserName | string | undefined | The name of the IAM user that the new key will belong to. 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: _+=,.- |
CreateAccessKeyCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
AccessKey Required | AccessKey | undefined | A structure with details about the access key. |
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. |