Skip to content

update_ca_certificate async

update_ca_certificate(
    certificate_id: CertificateId,
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    new_status: Optional[CACertificateStatus] = None,
    new_auto_registration_status: Optional[AutoRegistrationStatus] = None,
    registration_config: Optional[RegistrationConfig] = None,
    remove_auto_registration: Optional[RemoveAutoRegistration] = None,
) -> None

Updates a registered CA certificate.

Requires permission to access the UpdateCACertificate action.

Parameters:

  • certificate_id (CertificateId) –

    The CA certificate identifier.

  • new_status (Optional[CACertificateStatus], default: None ) –

    The updated status of the CA certificate.

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

  • new_auto_registration_status (Optional[AutoRegistrationStatus], default: None ) –

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

  • registration_config (Optional[RegistrationConfig], default: None ) –

    Information about the registration configuration.

  • remove_auto_registration (Optional[RemoveAutoRegistration], default: None ) –

    If true, removes auto registration.

Raises:

Source code in docs_src/capo_iot/_services/async_io_t.py
async def update_ca_certificate(
    self,
    certificate_id: "capo_iot.types.certificate_id.CertificateId",
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    new_status: Optional[
        "capo_iot.types.ca_certificate_status.CACertificateStatus"
    ] = None,
    new_auto_registration_status: Optional[
        "capo_iot.types.auto_registration_status.AutoRegistrationStatus"
    ] = None,
    registration_config: Optional[
        "capo_iot.types.registration_config.RegistrationConfig"
    ] = None,
    remove_auto_registration: Optional[
        "capo_iot.types.remove_auto_registration.RemoveAutoRegistration"
    ] = None,
) -> None:
    """<p>Updates a registered CA certificate.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateCACertificate</a> action.</p>

    Args:
        certificate_id: <p>The CA certificate identifier.</p>
        new_status: <p>The updated status of the CA certificate.</p> <p> <b>Note:</b> The status value REGISTER_INACTIVE is deprecated and should not be used.</p>
        new_auto_registration_status: <p>The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".</p>
        registration_config: <p>Information about the registration configuration.</p>
        remove_auto_registration: <p>If true, removes auto registration.</p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iot.types.update_ca_certificate_request.UpdateCACertificateRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_iot._operations.aws_iot_service.update_ca_certificate

        (
            output,
            http_response,
        ) = await capo_iot._operations.aws_iot_service.update_ca_certificate.async_update_ca_certificate(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateCACertificate")
    )
    input_: capo_iot.types.update_ca_certificate_request.UpdateCACertificateRequest = {
        "certificate_id": certificate_id
    }
    if new_status is not None:
        input_["new_status"] = new_status
    if new_auto_registration_status is not None:
        input_["new_auto_registration_status"] = new_auto_registration_status
    if registration_config is not None:
        input_["registration_config"] = registration_config
    if remove_auto_registration is not None:
        input_["remove_auto_registration"] = remove_auto_registration

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output