Menu
AWS IoT
Developer Guide

UpdateCACertificate

Updates a registered CA certificate.

Request syntax:

PUT /cacertificate/caCertificateId?newStatus=newStatus&newAutoRegistrationStatus=newAutoRegistrationStatus Content-type: application/json { "registrationConfig": { "templateBody": "string", "roleArn": "string" }, "removeAutoRegistration": "boolean" }

URI Request Parameters:

Name

Type

Req?

Description

certificateId

CertificateId

yes

The CA certificate identifier.

newStatus

CACertificateStatus

no

The updated status of the CA certificate.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

newAutoRegistrationStatus

AutoRegistrationStatus

no

The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".

Request Body Parameters:

Name

Type

Req?

Description

registrationConfig

RegistrationConfig

no

Information about the registration configuration.

removeAutoRegistration

RemoveAutoRegistration

no

If true, remove auto registration.

Errors:

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

CLI

Synopsis:

aws iot update-ca-certificate \ --certificate-id <value> \ [--new-status <value>] \ [--new-auto-registration-status <value>] \ [--registration-config <value>] \ [--remove-auto-registration | --no-remove-auto-registration] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "certificateId": "string", "newStatus": "string", "newAutoRegistrationStatus": "string", "registrationConfig": { "templateBody": "string", "roleArn": "string" }, "removeAutoRegistration": "boolean" }

cli-input-json fields:

Name

Type

Description

certificateId

string

length max:64 min:64

pattern: (0x)?[a-fA-F0-9]+

The CA certificate identifier.

newStatus

string

enum: ACTIVE | INACTIVE

java class: iot.identity.service.CACertificateStatus

The updated status of the CA certificate.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

newAutoRegistrationStatus

string

enum: ENABLE | DISABLE

java class: iot.identity.service.AutoRegistrationStatus

The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".

registrationConfig

RegistrationConfig

Information about the registration configuration.

templateBody

string

The template body.

roleArn

string

length max:2048 min:20

The ARN of the role.

removeAutoRegistration

boolean

If true, remove auto registration.

Output:

None

On this page: