AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateAccessKeyAsync.

Namespace: Amazon.IdentityManagement
Assembly: AWSSDK.IdentityManagement.dll
Version: 3.x.y.z

Syntax

C#
public virtual CreateAccessKeyResponse CreateAccessKey(
         CreateAccessKeyRequest request
)

Parameters

request
Type: Amazon.IdentityManagement.Model.CreateAccessKeyRequest

Container for the necessary parameters to execute the CreateAccessKey service method.

Return Value


The response from the CreateAccessKey service method, as returned by IdentityManagementService.

Exceptions

ExceptionCondition
LimitExceededException 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 The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
ServiceFailureException The request processing has failed because of an unknown error, exception or failure.

Examples

The following command creates an access key (access key ID and secret access key) for the IAM user named Bob.

To create an access key for an IAM user


var client = new AmazonIdentityManagementServiceClient();
var response = client.CreateAccessKey(new CreateAccessKeyRequest 
{
    UserName = "Bob"
});

AccessKey accessKey = response.AccessKey;

            

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also