Skip to content

IAM  >  Operations  >  reset_service_specific_credential

reset_service_specific_credential

Operation

reset_service_specific_credential async

reset_service_specific_credential(request: ResetServiceSpecificCredentialInput | ResetServiceSpecificCredentialInputDict, /, *, plugins: list[Plugin] | None = None) -> ResetServiceSpecificCredentialOutput
reset_service_specific_credential(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ResetServiceSpecificCredentialInputDict]) -> ResetServiceSpecificCredentialOutput

Resets the password for a service-specific credential. The new password is Amazon Web Services generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.

Parameters:

Name Type Description Default
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
ResetServiceSpecificCredentialOutput

An instance of ResetServiceSpecificCredentialOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

ResetServiceSpecificCredentialInput dataclass

Bases: _SerdeShape

Dataclass for ResetServiceSpecificCredentialInput 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.

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

The name of the IAM user associated with the service-specific credential. If this value is not specified, 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: _+=,.@-

Dictionaries

ResetServiceSpecificCredentialInputDict

Bases: TypedDict

Dictionary form of ResetServiceSpecificCredentialInput.

Attributes
service_specific_credential_id instance-attribute
service_specific_credential_id: Required[str]

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.

user_name instance-attribute
user_name: str | None

The name of the IAM user associated with the service-specific credential. If this value is not specified, 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

ResetServiceSpecificCredentialOutput dataclass

Bases: _SerdeShape

Dataclass for ResetServiceSpecificCredentialOutput 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.

service_specific_credential class-attribute instance-attribute
service_specific_credential: ServiceSpecificCredential | None = ...

A structure with details about the updated service-specific credential, including the new password.

Warning

This is the only time that you can access the password. You cannot recover the password later, but you can reset it again.