amazonka-iam-2.0: Amazon Identity and Access Management SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IAM.UpdateServiceSpecificCredential

Description

Sets the status of a service-specific credential to Active or Inactive. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow.

Synopsis

Creating a Request

data UpdateServiceSpecificCredential Source #

See: newUpdateServiceSpecificCredential smart constructor.

Constructors

UpdateServiceSpecificCredential' 

Fields

  • userName :: Maybe Text

    The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.

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

  • serviceSpecificCredentialId :: Text

    The unique identifier of the service-specific credential.

    This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

  • status :: StatusType

    The status to be assigned to the service-specific credential.

Instances

Instances details
ToHeaders UpdateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

ToPath UpdateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

ToQuery UpdateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

AWSRequest UpdateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

Generic UpdateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

Associated Types

type Rep UpdateServiceSpecificCredential :: Type -> Type #

Read UpdateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

Show UpdateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

NFData UpdateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

Eq UpdateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

Hashable UpdateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

type AWSResponse UpdateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

type Rep UpdateServiceSpecificCredential Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

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

newUpdateServiceSpecificCredential Source #

Create a value of UpdateServiceSpecificCredential 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:

UpdateServiceSpecificCredential, updateServiceSpecificCredential_userName - The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.

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

UpdateServiceSpecificCredential, updateServiceSpecificCredential_serviceSpecificCredentialId - The unique identifier of the service-specific credential.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

UpdateServiceSpecificCredential, updateServiceSpecificCredential_status - The status to be assigned to the service-specific credential.

Request Lenses

updateServiceSpecificCredential_userName :: Lens' UpdateServiceSpecificCredential (Maybe Text) Source #

The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.

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

updateServiceSpecificCredential_serviceSpecificCredentialId :: Lens' UpdateServiceSpecificCredential Text Source #

The unique identifier of the service-specific credential.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

updateServiceSpecificCredential_status :: Lens' UpdateServiceSpecificCredential StatusType Source #

The status to be assigned to the service-specific credential.

Destructuring the Response

data UpdateServiceSpecificCredentialResponse Source #

Instances

Instances details
Generic UpdateServiceSpecificCredentialResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

Read UpdateServiceSpecificCredentialResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

Show UpdateServiceSpecificCredentialResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

NFData UpdateServiceSpecificCredentialResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

Eq UpdateServiceSpecificCredentialResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

type Rep UpdateServiceSpecificCredentialResponse Source # 
Instance details

Defined in Amazonka.IAM.UpdateServiceSpecificCredential

type Rep UpdateServiceSpecificCredentialResponse = D1 ('MetaData "UpdateServiceSpecificCredentialResponse" "Amazonka.IAM.UpdateServiceSpecificCredential" "amazonka-iam-2.0-5DxkArXx9sD3CCYYGFyGET" 'False) (C1 ('MetaCons "UpdateServiceSpecificCredentialResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateServiceSpecificCredentialResponse :: UpdateServiceSpecificCredentialResponse Source #

Create a value of UpdateServiceSpecificCredentialResponse with all optional fields omitted.

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