IAM / Client / update_signing_certificate

update_signing_certificate#

IAM.Client.update_signing_certificate(**kwargs)#

Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user’s signing certificate as part of a certificate rotation work flow.

If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

See also: AWS API Documentation

Request Syntax

response = client.update_signing_certificate(
    UserName='string',
    CertificateId='string',
    Status='Active'|'Inactive'
)
Parameters:

  • UserName (string) –

    The name of the IAM user the signing certificate belongs to.

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

  • CertificateId (string) –

    [REQUIRED]

    The ID of the signing certificate you want to update.

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

  • Status (string) –

    [REQUIRED]

    The status you want to assign to the certificate. Active means that the certificate can be used for programmatic calls to Amazon Web Services Inactive means that the certificate cannot be used.

Returns:

None

Exceptions

Examples

The following command changes the status of a signing certificate for a user named Bob to Inactive.

response = client.update_signing_certificate(
    CertificateId='TA7SMP42TDN5Z26OBPJE7EXAMPLE',
    Status='Inactive',
    UserName='Bob',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}