Skip to content

put_kms_encryption_key async

put_kms_encryption_key(
    kms_encryption_key_arn: KmsEncryptionKeyArn,
    *,
    config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
) -> PutKMSEncryptionKeyResult

Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.

Parameters:

  • kms_encryption_key_arn (KmsEncryptionKeyArn) –

    The KMS encryption key ARN.

    The KMS key must be single-Region key. Amazon Fraud Detector does not support multi-Region KMS key.

Raises:

  • AccessDeniedException –

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

  • ConflictException –

    An exception indicating there was a conflict during a delete operation.

  • InternalServerException –

    An exception indicating an internal server error.

  • ResourceNotFoundException –

    An exception indicating the specified resource was not found.

  • ThrottlingException –

    An exception indicating a throttling error.

  • ValidationException –

    An exception indicating a specified value is not allowed.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_frauddetector/_services/async_fraud_detector.py
async def put_kms_encryption_key(
    self,
    kms_encryption_key_arn: "capo_frauddetector.types.kms_encryption_key_arn.KmsEncryptionKeyArn",
    *,
    config_overrides: Optional[AsyncFraudDetectorClientConfig] = None,
) -> "capo_frauddetector.types.put_kms_encryption_key_result.PutKMSEncryptionKeyResult":
    """<p>Specifies the KMS key to be used to encrypt content in Amazon Fraud Detector.</p>

    Args:
        kms_encryption_key_arn: <p>The KMS encryption key ARN.</p> <p>The KMS key must be single-Region key. Amazon Fraud Detector does not support multi-Region KMS key.</p>

    Raises:
        capo_frauddetector.errors.access_denied_exception.AccessDeniedException: <p>An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as <code>PutExternalModel</code>, that specifies a role that is not in your account.</p>
        capo_frauddetector.errors.conflict_exception.ConflictException: <p>An exception indicating there was a conflict during a delete operation.</p>
        capo_frauddetector.errors.internal_server_exception.InternalServerException: <p>An exception indicating an internal server error.</p>
        capo_frauddetector.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception indicating the specified resource was not found.</p>
        capo_frauddetector.errors.throttling_exception.ThrottlingException: <p>An exception indicating a throttling error.</p>
        capo_frauddetector.errors.validation_exception.ValidationException: <p>An exception indicating a specified value is not allowed.</p>
        capo_frauddetector.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_frauddetector.types.put_kms_encryption_key_request.PutKMSEncryptionKeyRequest]",
    ) -> AsyncOperationResponse[
        "capo_frauddetector.types.put_kms_encryption_key_result.PutKMSEncryptionKeyResult"
    ]:
        import capo_frauddetector._operations.aws_hawks_nest_service_facade.put_kms_encryption_key

        (
            output,
            http_response,
        ) = await capo_frauddetector._operations.aws_hawks_nest_service_facade.put_kms_encryption_key.async_put_kms_encryption_key(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutKMSEncryptionKey")
    )
    input_: capo_frauddetector.types.put_kms_encryption_key_request.PutKMSEncryptionKeyRequest = {
        "kms_encryption_key_arn": kms_encryption_key_arn
    }

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