Skip to main content

CreateAccessKey

Creates a new AWS secret access key and corresponding AWS access key ID for the specified role. The default status for new keys is Active.

If you do not specify a role, IAM determines the role implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root account credentials.

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

caution

To ensure the security of your AWS 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.

Permissions​

ActionDescriptionResource
CreateAccessKeyGrants permission to create access key and secret access key for the specified IAM useruser

Request Parameters​

For information about the parameters that are common to all actions, see Common Parameters.

UserName

The role name that the new key will belong to.

caution

The parameter is called UserName even though it takes a role name as a value. This is to preserve the ability to use the AWS SDK and AWS CLI.

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: _+=,.@-

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+=,.@-]+

Required: No

Response Elements​

The following element is returned by the service.

AccessKey

A structure with details about the access key.

Type: AccessKey object

Errors​

LimitExceeded create-access

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

Examples​

Example​

This example illustrates one usage of CreateAccessKey.

https://<partition>.iam.astran.io/?Action=CreateAccessKey
&UserName=Bob
&Version=2010-05-08
&AUTHPARAMS
<CreateAccessKeyResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
  <CreateAccessKeyResult>
    <AccessKey>
      <UserName>Bob</UserName>
      <AccessKeyId>AKIAIOSFODNN7EXAMPLE</AccessKeyId>
      <Status>Active</Status>
      <SecretAccessKey>wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY
      </SecretAccessKey>
    </AccessKey>
  </CreateAccessKeyResult>
  <ResponseMetadata>
    <RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
  </ResponseMetadata>
</CreateAccessKeyResponse>

See Also​

For more information about using this API in one of the language-specific AWS SDKs, see the following: