list_pipeline_endpoints `async` ¶

list_pipeline_endpoints(
    *,
    config_overrides: Optional[AsyncOSISClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListPipelineEndpointsResponse

Lists all pipeline endpoints in your account.

Parameters:

max_results (Optional[MaxResults], default: None ) –

The maximum number of pipeline endpoints to return in the response.
next_token (Optional[NextToken], default: None ) –

If your initial ListPipelineEndpoints operation returns a NextToken, you can include the returned NextToken in subsequent ListPipelineEndpoints operations, which returns results in the next page.

Raises:

AccessDeniedException –

You don't have permissions to access the resource.
DisabledOperationException –

Exception is thrown when an operation has been disabled.
InternalException –

The request failed because of an unknown error, exception, or failure (the failure is internal to the service).
LimitExceededException –

You attempted to create more than the allowed number of tags.
ValidationException –

An exception for missing or invalid input fields.
UnknownServiceError –

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

Source code in docs_src/capo_osis/_services/async_osis.py

async def list_pipeline_endpoints(
    self,
    *,
    config_overrides: Optional[AsyncOSISClientConfig] = None,
    max_results: Optional["capo_osis.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_osis.types.next_token.NextToken"] = None,
) -> (
    "capo_osis.types.list_pipeline_endpoints_response.ListPipelineEndpointsResponse"
):
    """<p>Lists all pipeline endpoints in your account.</p>

    Args:
        max_results: <p>The maximum number of pipeline endpoints to return in the response.</p>
        next_token: <p>If your initial <code>ListPipelineEndpoints</code> operation returns a <code>NextToken</code>, you can include the returned <code>NextToken</code> in subsequent <code>ListPipelineEndpoints</code> operations, which returns results in the next page.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_osis.types.list_pipeline_endpoints_request.ListPipelineEndpointsRequest]",
    ) -> AsyncOperationResponse[
        "capo_osis.types.list_pipeline_endpoints_response.ListPipelineEndpointsResponse"
    ]:
        import capo_osis._operations.amazon_open_search_ingestion_service.list_pipeline_endpoints

        (
            output,
            http_response,
        ) = await capo_osis._operations.amazon_open_search_ingestion_service.list_pipeline_endpoints.async_list_pipeline_endpoints(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPipelineEndpoints")
    )
    input_: capo_osis.types.list_pipeline_endpoints_request.ListPipelineEndpointsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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

list_pipeline_endpoints async ¶

list_pipeline_endpoints `async` ¶