update-ca-certificate¶

Description¶

Updates a registered CA certificate.

Requires permission to access the UpdateCACertificate action.

Synopsis¶

  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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--certificate-id (string)

The CA certificate identifier.

--new-status (string)

The updated status of the CA certificate.

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

Possible values:

ACTIVE

INACTIVE

--new-auto-registration-status (string)

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

Possible values:

ENABLE

DISABLE

--registration-config (structure)

Information about the registration configuration.

templateBody -> (string)

The template body.

roleArn -> (string)

The ARN of the role.

templateName -> (string)

The name of the provisioning template.

Shorthand Syntax:

templateBody=string,roleArn=string,templateName=string

JSON Syntax:

{
  "templateBody": "string",
  "roleArn": "string",
  "templateName": "string"
}

--remove-auto-registration | --no-remove-auto-registration (boolean)

If true, removes auto registration.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To update a certificate authority (CA) certificate

The following update-ca-certificate example sets the specified CA certificate to ACTIVE status.

aws iot update-ca-certificate \
    --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 \
    --new-status ACTIVE

This command produces no output.

For more information, see UpdateCACertificate in the AWS IoT API Reference.

Output¶

None

Table of Contents

Feedback

User Guide