put_default_encryption_configuration ¶

put_default_encryption_configuration(
    encryption_type: EncryptionType,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    kms_key_id: Optional[KmsKeyId] = None,
) -> PutDefaultEncryptionConfigurationResponse

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.

Parameters:

encryption_type (EncryptionType) –

The type of encryption used for the encryption configuration.
kms_key_id (Optional[KmsKeyId], default: None ) –

The Key ID of the customer managed key used for KMS encryption. This is required if you use KMS_BASED_ENCRYPTION.

Raises:

ConflictingOperationException –

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
InternalFailureException –

IoT SiteWise can't process your request right now. Try again later.
InvalidRequestException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
LimitExceededException –

You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the IoT SiteWise User Guide.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.
UnknownServiceError –

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

Source code in docs_src/capo_iotsitewise/_services/io_t_site_wise.py

def put_default_encryption_configuration(
    self,
    encryption_type: "capo_iotsitewise.types.encryption_type.EncryptionType",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    kms_key_id: Optional["capo_iotsitewise.types.kms_key_id.KmsKeyId"] = None,
) -> "capo_iotsitewise.types.put_default_encryption_configuration_response.PutDefaultEncryptionConfigurationResponse":
    """<p>Sets the default encryption configuration for the Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html">Key management</a> in the <i>IoT SiteWise User Guide</i>.</p>

    Args:
        encryption_type: <p>The type of encryption used for the encryption configuration.</p>
        kms_key_id: <p>The Key ID of the customer managed key used for KMS encryption. This is required if you use <code>KMS_BASED_ENCRYPTION</code>.</p>

    Raises:
        capo_iotsitewise.errors.conflicting_operation_exception.ConflictingOperationException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.limit_exceeded_exception.LimitExceededException: <p>You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.put_default_encryption_configuration_request.PutDefaultEncryptionConfigurationRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.put_default_encryption_configuration_response.PutDefaultEncryptionConfigurationResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.put_default_encryption_configuration

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.put_default_encryption_configuration.put_default_encryption_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutDefaultEncryptionConfiguration")
    )
    input_: capo_iotsitewise.types.put_default_encryption_configuration_request.PutDefaultEncryptionConfigurationRequest = {
        "encryption_type": encryption_type
    }
    if kms_key_id is not None:
        input_["kms_key_id"] = kms_key_id

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