com.amazonaws.services.iot.model

Class UpdateCertificateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.UpdateCertificateRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class UpdateCertificateRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Updates the status of the specified certificate. This operation is idempotent.

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateCertificateRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCertificateId() The ID of the certificate.
java.lang.String	getNewStatus() The new status.
int	hashCode()
void	setCertificateId(java.lang.String certificateId) The ID of the certificate.
void	setNewStatus(CertificateStatus newStatus) The new status.
void	setNewStatus(java.lang.String newStatus) The new status.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateCertificateRequest	withCertificateId(java.lang.String certificateId) The ID of the certificate.
UpdateCertificateRequest	withNewStatus(CertificateStatus newStatus) The new status.
UpdateCertificateRequest	withNewStatus(java.lang.String newStatus) The new status.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateCertificateRequest

public UpdateCertificateRequest()

Method Detail

getCertificateId

public java.lang.String getCertificateId()

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

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

Returns:

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

setCertificateId

public void setCertificateId(java.lang.String certificateId)

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

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

Parameters:

certificateId -

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

withCertificateId

public UpdateCertificateRequest withCertificateId(java.lang.String certificateId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 64 - 64
Pattern: (0x)?[a-fA-F0-9]+

Parameters:

certificateId -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getNewStatus

public java.lang.String getNewStatus()

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.

Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION

Returns:

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.

See Also:

CertificateStatus

setNewStatus

public void setNewStatus(java.lang.String 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.

Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION

Parameters:

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.

See Also:

CertificateStatus

withNewStatus

public UpdateCertificateRequest withNewStatus(java.lang.String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

CertificateStatus

setNewStatus

public void setNewStatus(CertificateStatus 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.

Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION

Parameters:

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.

See Also:

CertificateStatus

withNewStatus

public UpdateCertificateRequest withNewStatus(CertificateStatus 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

CertificateStatus

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object