Skip to content

IAM  >  Operations  >  update_service_specific_credential

update_service_specific_credential

Operation

update_service_specific_credential async 

update_service_specific_credential(input: UpdateServiceSpecificCredentialInput, plugins: list[Plugin] | None = None) -> UpdateServiceSpecificCredentialOutput

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.

Parameters:

Name Type Description Default
input UpdateServiceSpecificCredentialInput

An instance of UpdateServiceSpecificCredentialInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
UpdateServiceSpecificCredentialOutput

An instance of UpdateServiceSpecificCredentialOutput.

Input

UpdateServiceSpecificCredentialInput dataclass

Bases: _SerdeShape

Dataclass for UpdateServiceSpecificCredentialInput structure.

Attributes

service_specific_credential_id class-attribute instance-attribute 
service_specific_credential_id: str | None = ...

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 class-attribute instance-attribute 
status: str | None = ...

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

user_name class-attribute instance-attribute 
user_name: str | None = ...

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

Output

UpdateServiceSpecificCredentialOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateServiceSpecificCredentialOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.