You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IoT::Types::UpdateCertificateRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass UpdateCertificateRequest data as a hash:

{
  certificate_id: "CertificateId", # required
  new_status: "ACTIVE", # required, accepts ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, REGISTER_INACTIVE, PENDING_ACTIVATION
}

The input for the UpdateCertificate operation.

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_idString

The ID of the certificate.

Returns:

  • (String)


6699
6700
6701
6702
6703
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6699

class UpdateCertificateRequest < Struct.new(
  :certificate_id,
  :new_status)
  include Aws::Structure
end

#new_statusString

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:

  • (String)


6699
6700
6701
6702
6703
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6699

class UpdateCertificateRequest < Struct.new(
  :certificate_id,
  :new_status)
  include Aws::Structure
end