Skip to content

put_cluster_policy async

put_cluster_policy(
    cluster_arn: __string,
    *,
    config_overrides: Optional[AsyncKafkaClientConfig] = None,
    current_version: Optional[__string] = None,
    policy: Optional[__string] = None,
) -> PutClusterPolicyResponse

Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.

Parameters:

  • cluster_arn (__string) –

    The Amazon Resource Name (ARN) of the cluster.

  • current_version (Optional[__string], default: None ) –

    The policy version.

  • policy (Optional[__string], default: None ) –

    The policy.

Raises:

Source code in docs_src/capo_kafka/_services/async_kafka.py
async def put_cluster_policy(
    self,
    cluster_arn: "capo_kafka.types.__string.__string",
    *,
    config_overrides: Optional[AsyncKafkaClientConfig] = None,
    current_version: Optional["capo_kafka.types.__string.__string"] = None,
    policy: Optional["capo_kafka.types.__string.__string"] = None,
) -> "capo_kafka.types.put_cluster_policy_response.PutClusterPolicyResponse":
    """<p>Creates or updates the MSK cluster policy specified by the cluster Amazon Resource Name (ARN) in the request.</p>

    Args:
        cluster_arn: <p>The Amazon Resource Name (ARN) of the cluster.</p>
        current_version: <p>The policy version.</p>
        policy: <p>The policy.</p>

    Raises:
        capo_kafka.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_kafka.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
        capo_kafka.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
        capo_kafka.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kafka.types.put_cluster_policy_request.PutClusterPolicyRequest]",
    ) -> AsyncOperationResponse[
        "capo_kafka.types.put_cluster_policy_response.PutClusterPolicyResponse"
    ]:
        import capo_kafka._operations.kafka.put_cluster_policy

        (
            output,
            http_response,
        ) = await capo_kafka._operations.kafka.put_cluster_policy.async_put_cluster_policy(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutClusterPolicy")
    )
    input_: capo_kafka.types.put_cluster_policy_request.PutClusterPolicyRequest = {
        "cluster_arn": cluster_arn
    }
    if current_version is not None:
        input_["current_version"] = current_version
    if policy is not None:
        input_["policy"] = policy

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