com.amazonaws.services.iot.model

Class UpdateCertificateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.UpdateCertificateRequest

All Implemented Interfaces:

Serializable, Cloneable

public class UpdateCertificateRequest
extends AmazonWebServiceRequest
implements Serializable

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

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateCertificateRequest()

Method Summary

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

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateCertificateRequest

public UpdateCertificateRequest()

Method Detail

getCertificateId

public String getCertificateId()

The ID of the certificate.

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

Returns:

The ID of the certificate.

setCertificateId

public void setCertificateId(String certificateId)

The ID of the certificate.

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

Parameters:

certificateId -

The ID of the certificate.

withCertificateId

public UpdateCertificateRequest withCertificateId(String certificateId)

The ID of the certificate.

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.

Returns:

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

getNewStatus

public String getNewStatus()

The new status.

Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is 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 will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is 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(String newStatus)

The new status.

Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is 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 will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is 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(String newStatus)

The new status.

Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is 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 will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is 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 will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is 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 will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is 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 will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is 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 will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is 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 String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object