reset-service-specific-credential¶

Description¶

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

Synopsis¶

  reset-service-specific-credential
[--user-name <value>]
--service-specific-credential-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

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

--service-specific-credential-id (string)

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.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Reset the password for a service-specific credential attached to the user making the request

The following reset-service-specific-credential example generates a new cryptographically strong password for the specified service-specific credential attached to the user making the request.

aws iam reset-service-specific-credential --service-specific-credential-id ACCAEXAMPLE123EXAMPLE

Output:

{
    "ServiceSpecificCredential": {
        "CreateDate": "2019-04-18T20:45:36+00:00",
        "ServiceName": "codecommit.amazonaws.com",
        "ServiceUserName": "sofia-at-123456789012",
        "ServicePassword": "+oaFsNk7tLco+C/obP9GhhcOzGcKOayTmE3LnAmAmH4=",
        "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE",
        "UserName": "sofia",
        "Status": "Active"
    }
}

Reset the password for a service-specific credential attached to a specified user

The following reset-service-specific-credential example generates a new cryptographically strong password for a service-specific credential attached to the specified user.

aws iam reset-service-specific-credential --user-name sofia --service-specific-credential-id ACCAEXAMPLE123EXAMPLE

Output:

{
    "ServiceSpecificCredential": {
        "CreateDate": "2019-04-18T20:45:36+00:00",
        "ServiceName": "codecommit.amazonaws.com",
        "ServiceUserName": "sofia-at-123456789012",
        "ServicePassword": "+oaFsNk7tLco+C/obP9GhhcOzGcKOayTmE3LnAmAmH4=",
        "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE",
        "UserName": "sofia",
        "Status": "Active"
    }
}

For more information, see Create Git Credentials for HTTPS Connections to CodeCommit in the AWS CodeCommit User Guide

Output¶

ServiceSpecificCredential -> (structure)

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 -> (timestamp)

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

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

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.

Table of Contents

Feedback

User Guide