UpdateCertificate
Updates the status of the specified certificate. This operation is idempotent.
Requires permission to access the UpdateCertificate action.
Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to AWS IoT.
Within a few minutes of updating a certificate from the ACTIVE state to any other state, AWS IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.
Request Syntax
PUT /certificates/certificateId?newStatus=newStatus HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- certificateId
-
The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
Length Constraints: Fixed length of 64.
Pattern:
(0x)?[a-fA-F0-9]+Required: Yes
- newStatus
-
The new status.
Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are statuses used internally by AWS IoT. They are not intended for developer use.
Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
Valid Values:
ACTIVE | INACTIVE | REVOKED | PENDING_TRANSFER | REGISTER_INACTIVE | PENDING_ACTIVATIONRequired: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
- CertificateStateException
-
The certificate operation is not allowed.
HTTP Status Code: 406
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
- UnauthorizedException
-
You are not authorized to perform this operation.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
