libZSservicesZSamazonka-iamZSamazonka-iam
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IAM.CreateUser

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

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

Read CreateUser Source # 
Instance details

Defined in Amazonka.IAM.CreateUser

Show CreateUser Source # 
Instance details

Defined in Amazonka.IAM.CreateUser

Generic CreateUser Source # 
Instance details

Defined in Amazonka.IAM.CreateUser

Associated Types

type Rep CreateUser :: Type -> Type #

NFData CreateUser Source # 
Instance details

Defined in Amazonka.IAM.CreateUser

Methods

rnf :: CreateUser -> () #

Hashable CreateUser Source # 
Instance details

Defined in Amazonka.IAM.CreateUser

AWSRequest CreateUser Source # 
Instance details

Defined in Amazonka.IAM.CreateUser

Associated Types

type 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

ToQuery CreateUser Source # 
Instance details

Defined in Amazonka.IAM.CreateUser

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

newCreateUser Source #

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

Instances

Instances details
Eq CreateUserResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateUser

Read CreateUserResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateUser

Show CreateUserResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateUser

Generic CreateUserResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateUser

Associated Types

type Rep CreateUserResponse :: Type -> Type #

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 #

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.