put_encryption_config `async` ¶

put_encryption_config(
    type: EncryptionType,
    *,
    config_overrides: Optional[AsyncXRayClientConfig] = None,
    key_id: Optional[EncryptionKeyId] = None,
) -> PutEncryptionConfigResult

Updates the encryption configuration for X-Ray data.

Parameters:

key_id (Optional[EncryptionKeyId], default: None ) –
An Amazon Web Services KMS key in one of the following formats:
- Alias - The name of the key. For example, alias/MyKey.
- Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys.
- ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.
Omit this key if you set Type to NONE.
type (EncryptionType) –

The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

Raises:

InvalidRequestException –

The request is missing required parameters or has invalid parameters.
ThrottledException –

The request exceeds the maximum number of requests per second.
UnknownServiceError –

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

Source code in docs_src/capo_xray/_services/async_x_ray.py

async def put_encryption_config(
    self,
    type: "capo_xray.types.encryption_type.EncryptionType",
    *,
    config_overrides: Optional[AsyncXRayClientConfig] = None,
    key_id: Optional["capo_xray.types.encryption_key_id.EncryptionKeyId"] = None,
) -> "capo_xray.types.put_encryption_config_result.PutEncryptionConfigResult":
    """<p>Updates the encryption configuration for X-Ray data.</p>

    Args:
        key_id: <p>An Amazon Web Services KMS key in one of the following formats:</p> <ul> <li> <p> <b>Alias</b> - The name of the key. For example, <code>alias/MyKey</code>.</p> </li> <li> <p> <b>Key ID</b> - The KMS key ID of the key. For example, <code>ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Amazon Web Services X-Ray does not support asymmetric KMS keys.</p> </li> <li> <p> <b>ARN</b> - The full Amazon Resource Name of the key ID or alias. For example, <code>arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Use this format to specify a key in a different account.</p> </li> </ul> <p>Omit this key if you set <code>Type</code> to <code>NONE</code>.</p>
        type: <p>The type of encryption. Set to <code>KMS</code> to use your own key for encryption. Set to <code>NONE</code> for default encryption.</p>

    Raises:
        capo_xray.errors.invalid_request_exception.InvalidRequestException: <p>The request is missing required parameters or has invalid parameters.</p>
        capo_xray.errors.throttled_exception.ThrottledException: <p>The request exceeds the maximum number of requests per second.</p>
        capo_xray.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_xray.types.put_encryption_config_request.PutEncryptionConfigRequest]",
    ) -> AsyncOperationResponse[
        "capo_xray.types.put_encryption_config_result.PutEncryptionConfigResult"
    ]:
        import capo_xray._operations.awsx_ray.put_encryption_config

        (
            output,
            http_response,
        ) = await capo_xray._operations.awsx_ray.put_encryption_config.async_put_encryption_config(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutEncryptionConfig")
    )
    input_: capo_xray.types.put_encryption_config_request.PutEncryptionConfigRequest = {
        "type": type
    }
    if key_id is not None:
        input_["key_id"] = key_id

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

put_encryption_config async ¶

put_encryption_config `async` ¶