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.CreateServiceSpecificCredential

Description

Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.

You can have a maximum of two sets of service-specific credentials for each supported service per user.

You can create service-specific credentials for CodeCommit and Amazon Keyspaces (for Apache Cassandra).

You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.

For more information about service-specific credentials, see Using IAM with CodeCommit: Git credentials, SSH keys, and Amazon Web Services access keys in the IAM User Guide.

Synopsis

Creating a Request

data CreateServiceSpecificCredential Source #

See: newCreateServiceSpecificCredential smart constructor.

Constructors

CreateServiceSpecificCredential' 

Fields

  • userName :: Text

    The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service.

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

  • serviceName :: Text

    The name of the Amazon Web Services service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials.

Instances

Instances details
Eq CreateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

Read CreateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

Show CreateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

Generic CreateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

Associated Types

type Rep CreateServiceSpecificCredential :: Type -> Type #

NFData CreateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

Hashable CreateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

AWSRequest CreateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

ToHeaders CreateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

ToPath CreateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

ToQuery CreateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

type Rep CreateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

type Rep CreateServiceSpecificCredential = D1 ('MetaData "CreateServiceSpecificCredential" "Amazonka.IAM.CreateServiceSpecificCredential" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "CreateServiceSpecificCredential'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

newCreateServiceSpecificCredential Source #

Create a value of CreateServiceSpecificCredential 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:userName:CreateServiceSpecificCredential', createServiceSpecificCredential_userName - The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service.

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

$sel:serviceName:CreateServiceSpecificCredential', createServiceSpecificCredential_serviceName - The name of the Amazon Web Services service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials.

Request Lenses

createServiceSpecificCredential_userName :: Lens' CreateServiceSpecificCredential Text Source #

The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service.

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

createServiceSpecificCredential_serviceName :: Lens' CreateServiceSpecificCredential Text Source #

The name of the Amazon Web Services service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials.

Destructuring the Response

data CreateServiceSpecificCredentialResponse Source #

Constructors

CreateServiceSpecificCredentialResponse' 

Fields

  • serviceSpecificCredential :: Maybe ServiceSpecificCredential

    A structure that contains information about the newly created service-specific credential.

    This is the only time that the password for this credential set is available. It cannot be recovered later. Instead, you must reset the password with ResetServiceSpecificCredential.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateServiceSpecificCredentialResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

Show CreateServiceSpecificCredentialResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

Generic CreateServiceSpecificCredentialResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

NFData CreateServiceSpecificCredentialResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

type Rep CreateServiceSpecificCredentialResponse Source # 
Instance details

Defined in Amazonka.IAM.CreateServiceSpecificCredential

type Rep CreateServiceSpecificCredentialResponse = D1 ('MetaData "CreateServiceSpecificCredentialResponse" "Amazonka.IAM.CreateServiceSpecificCredential" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "CreateServiceSpecificCredentialResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceSpecificCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceSpecificCredential)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateServiceSpecificCredentialResponse Source #

Create a value of CreateServiceSpecificCredentialResponse 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:serviceSpecificCredential:CreateServiceSpecificCredentialResponse', createServiceSpecificCredentialResponse_serviceSpecificCredential - A structure that contains information about the newly created service-specific credential.

This is the only time that the password for this credential set is available. It cannot be recovered later. Instead, you must reset the password with ResetServiceSpecificCredential.

$sel:httpStatus:CreateServiceSpecificCredentialResponse', createServiceSpecificCredentialResponse_httpStatus - The response's http status code.

Response Lenses

createServiceSpecificCredentialResponse_serviceSpecificCredential :: Lens' CreateServiceSpecificCredentialResponse (Maybe ServiceSpecificCredential) Source #

A structure that contains information about the newly created service-specific credential.

This is the only time that the password for this credential set is available. It cannot be recovered later. Instead, you must reset the password with ResetServiceSpecificCredential.