Skip to content

delete_public_key

delete_public_key(
    arn: PublicKeyArn, *, config_overrides: Optional[IVSRealTimeClientConfig] = None
) -> DeletePublicKeyResponse

Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.

Parameters:

  • arn (PublicKeyArn) –

    ARN of the public key to be deleted.

Raises:

Source code in docs_src/capo_ivs_realtime/_services/ivs_real_time.py
def delete_public_key(
    self,
    arn: "capo_ivs_realtime.types.public_key_arn.PublicKeyArn",
    *,
    config_overrides: Optional[IVSRealTimeClientConfig] = None,
) -> "capo_ivs_realtime.types.delete_public_key_response.DeletePublicKeyResponse":
    """<p>Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key. </p>

    Args:
        arn: <p>ARN of the public key to be deleted.</p>

    Raises:
        capo_ivs_realtime.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_ivs_realtime.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_ivs_realtime.errors.pending_verification.PendingVerification: <p>Your account is pending verification.</p>
        capo_ivs_realtime.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_ivs_realtime.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_ivs_realtime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ivs_realtime.types.delete_public_key_request.DeletePublicKeyRequest]",
    ) -> OperationResponse[
        "capo_ivs_realtime.types.delete_public_key_response.DeletePublicKeyResponse"
    ]:
        import capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.delete_public_key

        output, http_response = (
            capo_ivs_realtime._operations.amazon_interactive_video_service_real_time.delete_public_key.delete_public_key(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeletePublicKey")
    )
    input_: capo_ivs_realtime.types.delete_public_key_request.DeletePublicKeyRequest = {
        "arn": arn
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output