update_encryption_configuration
async
¶
update_encryption_configuration(
encryption_type: EncryptionType,
*,
config_overrides: Optional[AsyncIoTClientConfig] = None,
kms_key_arn: Optional[KmsKeyArn] = None,
kms_access_role_arn: Optional[KmsAccessRoleArn] = None,
) -> UpdateEncryptionConfigurationResponse
Updates the encryption configuration. By default, Amazon Web Services IoT Core encrypts your data at rest using Amazon Web Services owned keys. Amazon Web Services IoT Core also supports symmetric customer managed keys from Key Management Service (KMS). With customer managed keys, you create, own, and manage the KMS keys in your Amazon Web Services account.
Before using this API, you must set up permissions for Amazon Web Services IoT Core to access KMS. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide.
Parameters:
-
encryption_type(EncryptionType) –The type of the KMS key.
-
kms_key_arn(Optional[KmsKeyArn], default:None) –The ARN of the customer managedKMS key.
-
kms_access_role_arn(Optional[KmsAccessRoleArn], default:None) –The Amazon Resource Name (ARN) of the IAM role assumed by Amazon Web Services IoT Core to call KMS on behalf of the customer.
Raises:
-
InternalFailureException–An unexpected error has occurred.
-
InvalidRequestException–The request is not valid.
-
ServiceUnavailableException–The service is temporarily unavailable.
-
ThrottlingException–The rate exceeds the limit.
-
UnauthorizedException–You are not authorized to perform this operation.
-
UnknownServiceError–The service returned an error code this client does not model.
Examples:
UpdateEncryptionConfiguration example This operation updates the encryption configuration.
>>> await client.update_encryption_configuration(encryption_type='CUSTOMER_MANAGED_KMS_KEY', kms_key_arn='arn:aws:iam:us-west-2:111122223333:role/myrole', kms_access_role_arn='arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab')
Source code in docs_src/capo_iot/_services/async_io_t.py
17788 17789 17790 17791 17792 17793 17794 17795 17796 17797 17798 17799 17800 17801 17802 17803 17804 17805 17806 17807 17808 17809 17810 17811 17812 17813 17814 17815 17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 17844 17845 17846 17847 17848 17849 17850 17851 17852 | |