UpdateSigningCertificate
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 AWS access key ID used to sign the request. This operation
works for access keys under the AWS account. Consequently, you can use this operation
to manage AWS account root user credentials even if the AWS account has no associated
users.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- CertificateId
-
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. Type: String
Length Constraints: Minimum length of 24. Maximum length of 128.
Pattern:
[\w]+
Required: Yes
- Status
-
The status you want to assign to the certificate.
Active
means that the certificate can be used for programmatic calls to AWSInactive
means that the certificate cannot be used.Type: String
Valid Values:
Active | Inactive
Required: Yes
- UserName
-
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: _+=,.@- Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=,.@-]+
Required: No
Errors
For information about the errors that are common to all actions, see Common Errors.
- LimitExceeded
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
HTTP Status Code: 409
- NoSuchEntity
-
The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
HTTP Status Code: 404
- ServiceFailure
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of UpdateSigningCertificate.
Sample Request
https://iam.amazonaws.com/?Action=UpdateSigningCertificate
&UserName=Bob
&CertificateId=TA7SMP42TDN5Z26OBPJE7EXAMPLE
&Status=Inactive
&Version=2010-05-08
&AUTHPARAMS
Sample Response
<UpdateSigningCertificateResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
<ResponseMetadata>
<RequestId>EXAMPLE8-90ab-cdef-fedc-ba987EXAMPLE</RequestId>
</ResponseMetadata>
</UpdateSigningCertificateResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: