Skip to content

revoke_pipeline_endpoint_connections

revoke_pipeline_endpoint_connections(
    pipeline_arn: PipelineArn,
    endpoint_ids: PipelineEndpointIdsList,
    *,
    config_overrides: Optional[OSISClientConfig] = None,
) -> RevokePipelineEndpointConnectionsResponse

Revokes pipeline endpoints from specified endpoint IDs.

Parameters:

  • pipeline_arn (PipelineArn) –

    The Amazon Resource Name (ARN) of the pipeline from which to revoke endpoint connections.

  • endpoint_ids (PipelineEndpointIdsList) –

    A list of endpoint IDs for which to revoke access to the pipeline.

Raises:

Source code in docs_src/capo_osis/_services/osis.py
def revoke_pipeline_endpoint_connections(
    self,
    pipeline_arn: "capo_osis.types.pipeline_arn.PipelineArn",
    endpoint_ids: "capo_osis.types.pipeline_endpoint_ids_list.PipelineEndpointIdsList",
    *,
    config_overrides: Optional[OSISClientConfig] = None,
) -> "capo_osis.types.revoke_pipeline_endpoint_connections_response.RevokePipelineEndpointConnectionsResponse":
    """<p>Revokes pipeline endpoints from specified endpoint IDs.</p>

    Args:
        pipeline_arn: <p>The Amazon Resource Name (ARN) of the pipeline from which to revoke endpoint connections.</p>
        endpoint_ids: <p>A list of endpoint IDs for which to revoke access to the pipeline.</p>

    Raises:
        capo_osis.errors.access_denied_exception.AccessDeniedException: <p>You don't have permissions to access the resource.</p>
        capo_osis.errors.disabled_operation_exception.DisabledOperationException: <p>Exception is thrown when an operation has been disabled.</p>
        capo_osis.errors.internal_exception.InternalException: <p>The request failed because of an unknown error, exception, or failure (the failure is internal to the service).</p>
        capo_osis.errors.limit_exceeded_exception.LimitExceededException: <p>You attempted to create more than the allowed number of tags.</p>
        capo_osis.errors.validation_exception.ValidationException: <p>An exception for missing or invalid input fields.</p>
        capo_osis.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_osis.types.revoke_pipeline_endpoint_connections_request.RevokePipelineEndpointConnectionsRequest]",
    ) -> OperationResponse[
        "capo_osis.types.revoke_pipeline_endpoint_connections_response.RevokePipelineEndpointConnectionsResponse"
    ]:
        import capo_osis._operations.amazon_open_search_ingestion_service.revoke_pipeline_endpoint_connections

        output, http_response = (
            capo_osis._operations.amazon_open_search_ingestion_service.revoke_pipeline_endpoint_connections.revoke_pipeline_endpoint_connections(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RevokePipelineEndpointConnections")
    )
    input_: capo_osis.types.revoke_pipeline_endpoint_connections_request.RevokePipelineEndpointConnectionsRequest = {
        "pipeline_arn": pipeline_arn,
        "endpoint_ids": endpoint_ids,
    }

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