IAM / Client / reset_service_specific_credential

reset_service_specific_credential

IAM.Client.reset_service_specific_credential(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.reset_service_specific_credential(
    UserName='string',
    ServiceSpecificCredentialId='string'
)
Parameters:

  • UserName (string) –

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

  • ServiceSpecificCredentialId (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'ServiceSpecificCredential': {
        'CreateDate': datetime(2015, 1, 1),
        'ExpirationDate': datetime(2015, 1, 1),
        'ServiceName': 'string',
        'ServiceUserName': 'string',
        'ServicePassword': 'string',
        'ServiceCredentialAlias': 'string',
        'ServiceCredentialSecret': 'string',
        'ServiceSpecificCredentialId': 'string',
        'UserName': 'string',
        'Status': 'Active'|'Inactive'|'Expired'
    }
}

Response Structure

  • (dict) –

    • ServiceSpecificCredential (dict) –

      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.

      • CreateDate (datetime) –

        The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

      • ExpirationDate (datetime) –

        The date and time when the service specific credential expires. This field is only present for Bedrock API keys that were created with an expiration period.

      • ServiceName (string) –

        The name of the service associated with the service-specific credential.

      • ServiceUserName (string) –

        The generated user name for the service-specific credential. This value is generated by combining the IAM user’s name combined with the ID number of the Amazon Web Services account, as in jane-at-123456789012, for example. This value cannot be configured by the user.

      • ServicePassword (string) –

        The generated password for the service-specific credential.

      • ServiceCredentialAlias (string) –

        For Bedrock API keys, this is the public portion of the credential that includes the IAM user name and a suffix containing version and creation information.

      • ServiceCredentialSecret (string) –

        For Bedrock API keys, this is the secret portion of the credential that should be used to authenticate API calls. This value is returned only when the credential is created.

      • ServiceSpecificCredentialId (string) –

        The unique identifier for the service-specific credential.

      • UserName (string) –

        The name of the IAM user associated with the service-specific credential.

      • Status (string) –

        The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

Exceptions