Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IAM.CreateUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new IAM user for your Amazon Web Services account.

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

Synopsis

data CreateUser = CreateUser' {
- path :: Maybe Text
- permissionsBoundary :: Maybe Text
- tags :: Maybe [Tag]
- userName :: Text
}
newCreateUser :: Text -> CreateUser
createUser_path :: Lens' CreateUser (Maybe Text)
createUser_permissionsBoundary :: Lens' CreateUser (Maybe Text)
createUser_tags :: Lens' CreateUser (Maybe [Tag])
createUser_userName :: Lens' CreateUser Text
data CreateUserResponse = CreateUserResponse' {
- user :: Maybe User
- httpStatus :: Int
}
newCreateUserResponse :: Int -> CreateUserResponse
createUserResponse_user :: Lens' CreateUserResponse (Maybe User)
createUserResponse_httpStatus :: Lens' CreateUserResponse Int

Creating a Request

data CreateUser Source #

See: newCreateUser smart constructor.

Constructors

CreateUser'

Fields

path :: Maybe Text
The path for the user name. For more information about paths, see IAM identifiers in the IAM User Guide.
This parameter is optional. If it is not included, it defaults to a slash (/).
This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
permissionsBoundary :: Maybe Text
The ARN of the policy that is used to set the permissions boundary for the user.
tags :: Maybe [Tag]
A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
userName :: Text
The name of the user to create.
IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Instances

Instances details

Eq CreateUser Source #
Instance details Defined in Amazonka.IAM.CreateUser Methods (==) :: CreateUser -> CreateUser -> Bool # (/=) :: CreateUser -> CreateUser -> Bool #
Read CreateUser Source #
Instance details Defined in Amazonka.IAM.CreateUser Methods readsPrec :: Int -> ReadS CreateUser # readList :: ReadS [CreateUser] # readPrec :: ReadPrec CreateUser # readListPrec :: ReadPrec [CreateUser] #
Show CreateUser Source #
Instance details Defined in Amazonka.IAM.CreateUser Methods showsPrec :: Int -> CreateUser -> ShowS # show :: CreateUser -> String # showList :: [CreateUser] -> ShowS #
Generic CreateUser Source #
Instance details Defined in Amazonka.IAM.CreateUser Associated Types type Rep CreateUser :: Type -> Type # Methods from :: CreateUser -> Rep CreateUser x # to :: Rep CreateUser x -> CreateUser #
NFData CreateUser Source #
Instance details Defined in Amazonka.IAM.CreateUser Methods rnf :: CreateUser -> () #
Hashable CreateUser Source #
Instance details Defined in Amazonka.IAM.CreateUser Methods hashWithSalt :: Int -> CreateUser -> Int # hash :: CreateUser -> Int #
AWSRequest CreateUser Source #
Instance details Defined in Amazonka.IAM.CreateUser Associated Types type AWSResponse CreateUser # Methods request :: CreateUser -> Request CreateUser # response :: MonadResource m => Logger -> Service -> Proxy CreateUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUser))) #
ToHeaders CreateUser Source #
Instance details Defined in Amazonka.IAM.CreateUser Methods toHeaders :: CreateUser -> [Header] #
ToPath CreateUser Source #
Instance details Defined in Amazonka.IAM.CreateUser Methods toPath :: CreateUser -> ByteString #
ToQuery CreateUser Source #
Instance details Defined in Amazonka.IAM.CreateUser Methods toQuery :: CreateUser -> QueryString #
type Rep CreateUser Source #
Instance details Defined in Amazonka.IAM.CreateUser type Rep CreateUser = D1 ('MetaData "CreateUser" "Amazonka.IAM.CreateUser" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "CreateUser'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "permissionsBoundary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateUser Source #
Instance details Defined in Amazonka.IAM.CreateUser type AWSResponse CreateUser = CreateUserResponse

newCreateUser Source #

Arguments

:: Text	`$sel:userName:CreateUser'`
-> CreateUser

Create a value of CreateUser 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:path:CreateUser', createUser_path - The path for the user name. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

$sel:permissionsBoundary:CreateUser', createUser_permissionsBoundary - The ARN of the policy that is used to set the permissions boundary for the user.

$sel:tags:CreateUser', createUser_tags - A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

$sel:userName:CreateUser', createUser_userName - The name of the user to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Request Lenses

createUser_path :: Lens' CreateUser (Maybe Text) Source #

The path for the user name. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.

createUser_permissionsBoundary :: Lens' CreateUser (Maybe Text) Source #

The ARN of the policy that is used to set the permissions boundary for the user.

createUser_tags :: Lens' CreateUser (Maybe [Tag]) Source #

A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

createUser_userName :: Lens' CreateUser Text Source #

The name of the user to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Destructuring the Response

data CreateUserResponse Source #

Contains the response to a successful CreateUser request.

See: newCreateUserResponse smart constructor.

Constructors

CreateUserResponse'
Fields user :: Maybe User A structure with details about the new IAM user. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateUserResponse Source #
Instance details Defined in Amazonka.IAM.CreateUser Methods (==) :: CreateUserResponse -> CreateUserResponse -> Bool # (/=) :: CreateUserResponse -> CreateUserResponse -> Bool #
Read CreateUserResponse Source #
Instance details Defined in Amazonka.IAM.CreateUser Methods readsPrec :: Int -> ReadS CreateUserResponse # readList :: ReadS [CreateUserResponse] # readPrec :: ReadPrec CreateUserResponse # readListPrec :: ReadPrec [CreateUserResponse] #
Show CreateUserResponse Source #
Instance details Defined in Amazonka.IAM.CreateUser Methods showsPrec :: Int -> CreateUserResponse -> ShowS # show :: CreateUserResponse -> String # showList :: [CreateUserResponse] -> ShowS #
Generic CreateUserResponse Source #
Instance details Defined in Amazonka.IAM.CreateUser Associated Types type Rep CreateUserResponse :: Type -> Type # Methods from :: CreateUserResponse -> Rep CreateUserResponse x # to :: Rep CreateUserResponse x -> CreateUserResponse #
NFData CreateUserResponse Source #
Instance details Defined in Amazonka.IAM.CreateUser Methods rnf :: CreateUserResponse -> () #
type Rep CreateUserResponse Source #
Instance details Defined in Amazonka.IAM.CreateUser type Rep CreateUserResponse = D1 ('MetaData "CreateUserResponse" "Amazonka.IAM.CreateUser" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "CreateUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe User)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateUserResponse'`
-> CreateUserResponse

Create a value of CreateUserResponse 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:user:CreateUserResponse', createUserResponse_user - A structure with details about the new IAM user.

$sel:httpStatus:CreateUserResponse', createUserResponse_httpStatus - The response's http status code.

Response Lenses

createUserResponse_user :: Lens' CreateUserResponse (Maybe User) Source #

A structure with details about the new IAM user.

createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #

The response's http status code.