AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginUpdateCertificate and EndUpdateCertificate.

Namespace: Amazon.IoT
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<UpdateCertificateResponse> UpdateCertificateAsync(
         String certificateId,
         CertificateStatus newStatus,
         CancellationToken cancellationToken
)

Parameters

certificateId
Type: System.String

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

newStatus
Type: Amazon.IoT.CertificateStatus

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 IoT. They are not intended for developer use. Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the UpdateCertificate service method, as returned by IoT.

Exceptions

ExceptionCondition
CertificateStateException The certificate operation is not allowed.
InternalFailureException An unexpected error has occurred.
InvalidRequestException The request is not valid.
ResourceNotFoundException The specified resource does not exist.
ServiceUnavailableException The service is temporarily unavailable.
ThrottlingException The rate exceeds the limit.
UnauthorizedException You are not authorized to perform this operation.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also