Skip to content

set_token_vault_cmk

set_token_vault_cmk(
    kms_configuration: KmsConfiguration,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    token_vault_id: Optional[TokenVaultIdType] = None,
) -> SetTokenVaultCMKResponse

Sets the customer master key (CMK) for a token vault.

Parameters:

  • token_vault_id (Optional[TokenVaultIdType], default: None ) –

    The unique identifier of the token vault to update.

  • kms_configuration (KmsConfiguration) –

    The KMS configuration for the token vault, including the key type and KMS key ARN.

Raises:

Source code in docs_src/capo_bedrock_agentcore_control/_services/bedrock_agent_core_control.py
def set_token_vault_cmk(
    self,
    kms_configuration: "capo_bedrock_agentcore_control.types.kms_configuration.KmsConfiguration",
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    token_vault_id: Optional[
        "capo_bedrock_agentcore_control.types.token_vault_id_type.TokenVaultIdType"
    ] = None,
) -> "capo_bedrock_agentcore_control.types.set_token_vault_cmk_response.SetTokenVaultCMKResponse":
    """<p>Sets the customer master key (CMK) for a token vault.</p>

    Args:
        token_vault_id: <p>The unique identifier of the token vault to update.</p>
        kms_configuration: <p>The KMS configuration for the token vault, including the key type and KMS key ARN.</p>

    Raises:
        capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
        capo_bedrock_agentcore_control.errors.concurrent_modification_exception.ConcurrentModificationException: <p>Exception thrown when a resource is modified concurrently by multiple requests.</p>
        capo_bedrock_agentcore_control.errors.internal_server_exception.InternalServerException: <p>This exception is thrown if there was an unexpected error during processing of request</p>
        capo_bedrock_agentcore_control.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource referenced by the operation does not exist</p>
        capo_bedrock_agentcore_control.errors.throttling_exception.ThrottlingException: <p>This exception is thrown when the number of requests exceeds the limit</p>
        capo_bedrock_agentcore_control.errors.unauthorized_exception.UnauthorizedException: <p>This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access</p>
        capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore_control.types.set_token_vault_cmk_request.SetTokenVaultCMKRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.set_token_vault_cmk_response.SetTokenVaultCMKResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.set_token_vault_cmk

        output, http_response = (
            capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.set_token_vault_cmk.set_token_vault_cmk(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SetTokenVaultCMK")
    )
    input_: capo_bedrock_agentcore_control.types.set_token_vault_cmk_request.SetTokenVaultCMKRequest = {
        "kms_configuration": kms_configuration
    }
    if token_vault_id is not None:
        input_["token_vault_id"] = token_vault_id

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