Amazonka.IAM.CreateAccessKey

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.

Creating a Request

data CreateAccessKey

See: newCreateAccessKey smart constructor.

Constructors

CreateAccessKey'

Fields

• userName :: Maybe Text

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

Instances

ToHeaders CreateAccessKey

Defined in Amazonka.IAM.CreateAccessKey

Methods

toHeaders :: CreateAccessKey -> [Header]

ToPath CreateAccessKey

Defined in Amazonka.IAM.CreateAccessKey

Methods

toPath :: CreateAccessKey -> ByteString

ToQuery CreateAccessKey

Defined in Amazonka.IAM.CreateAccessKey

Methods

toQuery :: CreateAccessKey -> QueryString

AWSRequest CreateAccessKey

Defined in Amazonka.IAM.CreateAccessKey

Associated Types

type AWSResponse CreateAccessKey

Methods

request :: (Service -> Service) -> CreateAccessKey -> Request CreateAccessKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAccessKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAccessKey)))

Generic CreateAccessKey

Defined in Amazonka.IAM.CreateAccessKey

Associated Types

type Rep CreateAccessKey :: Type -> Type

Methods

from :: CreateAccessKey -> Rep CreateAccessKey x

to :: Rep CreateAccessKey x -> CreateAccessKey

Read CreateAccessKey

Defined in Amazonka.IAM.CreateAccessKey

Methods

readsPrec :: Int -> ReadS CreateAccessKey

readList :: ReadS [CreateAccessKey]

readPrec :: ReadPrec CreateAccessKey

readListPrec :: ReadPrec [CreateAccessKey]

Show CreateAccessKey

Defined in Amazonka.IAM.CreateAccessKey

Methods

showsPrec :: Int -> CreateAccessKey -> ShowS

show :: CreateAccessKey -> String

showList :: [CreateAccessKey] -> ShowS

NFData CreateAccessKey

Defined in Amazonka.IAM.CreateAccessKey

Methods

rnf :: CreateAccessKey -> ()

Eq CreateAccessKey

Defined in Amazonka.IAM.CreateAccessKey

Methods

(==) :: CreateAccessKey -> CreateAccessKey -> Bool

(/=) :: CreateAccessKey -> CreateAccessKey -> Bool

Hashable CreateAccessKey

Defined in Amazonka.IAM.CreateAccessKey

Methods

hashWithSalt :: Int -> CreateAccessKey -> Int

hash :: CreateAccessKey -> Int

type AWSResponse CreateAccessKey

Defined in Amazonka.IAM.CreateAccessKey

type AWSResponse CreateAccessKey = CreateAccessKeyResponse

type Rep CreateAccessKey

Defined in Amazonka.IAM.CreateAccessKey

type Rep CreateAccessKey = D1 ('MetaData "CreateAccessKey" "Amazonka.IAM.CreateAccessKey" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "CreateAccessKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newCreateAccessKey :: CreateAccessKey

Create a value of CreateAccessKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

Request Lenses

createAccessKey_userName :: Lens' CreateAccessKey (Maybe Text)

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

Destructuring the Response

data CreateAccessKeyResponse

Contains the response to a successful CreateAccessKey request.

See: newCreateAccessKeyResponse smart constructor.

Constructors

CreateAccessKeyResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• accessKey :: AccessKeyInfo

  A structure with details about the access key.

Instances

Generic CreateAccessKeyResponse

Defined in Amazonka.IAM.CreateAccessKey

Associated Types

type Rep CreateAccessKeyResponse :: Type -> Type

Methods

from :: CreateAccessKeyResponse -> Rep CreateAccessKeyResponse x

to :: Rep CreateAccessKeyResponse x -> CreateAccessKeyResponse

Show CreateAccessKeyResponse

Defined in Amazonka.IAM.CreateAccessKey

Methods

showsPrec :: Int -> CreateAccessKeyResponse -> ShowS

show :: CreateAccessKeyResponse -> String

showList :: [CreateAccessKeyResponse] -> ShowS

NFData CreateAccessKeyResponse

Defined in Amazonka.IAM.CreateAccessKey

Methods

rnf :: CreateAccessKeyResponse -> ()

Eq CreateAccessKeyResponse

Defined in Amazonka.IAM.CreateAccessKey

Methods

(==) :: CreateAccessKeyResponse -> CreateAccessKeyResponse -> Bool

(/=) :: CreateAccessKeyResponse -> CreateAccessKeyResponse -> Bool

type Rep CreateAccessKeyResponse

Defined in Amazonka.IAM.CreateAccessKey

type Rep CreateAccessKeyResponse = D1 ('MetaData "CreateAccessKeyResponse" "Amazonka.IAM.CreateAccessKey" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "CreateAccessKeyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "accessKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccessKeyInfo)))

newCreateAccessKeyResponse

Arguments

:: Int

$sel:httpStatus:CreateAccessKeyResponse'

-> AccessKeyInfo

$sel:accessKey:CreateAccessKeyResponse'

-> CreateAccessKeyResponse

Create a value of CreateAccessKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateAccessKeyResponse', createAccessKeyResponse_httpStatus - The response's http status code.

$sel:accessKey:CreateAccessKeyResponse', createAccessKeyResponse_accessKey - A structure with details about the access key.

Response Lenses

createAccessKeyResponse_httpStatus :: Lens' CreateAccessKeyResponse Int

The response's http status code.

createAccessKeyResponse_accessKey :: Lens' CreateAccessKeyResponse AccessKeyInfo

A structure with details about the access key.