Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.
Parameters:
-
max_results
(Optional[MaxResults], default:
None
)
–
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
-
next_token
(Optional[NextToken], default:
None
)
–
If your initial ListPipelines operation returns a nextToken, you can include the returned nextToken in subsequent ListPipelines operations, which returns results in the next page.
Raises:
Source code in docs_src/capo_osis/_services/async_osis.py
| async def list_pipelines(
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_pipelines_response.ListPipelinesResponse":
"""<p>Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/list-pipeline.html">Viewing Amazon OpenSearch Ingestion pipelines</a>.</p>
Args:
max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results.</p>
next_token: <p>If your initial <code>ListPipelines</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListPipelines</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.invalid_pagination_token_exception.InvalidPaginationTokenException: <p>An invalid pagination token provided in the request.</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_pipelines_request.ListPipelinesRequest]",
) -> AsyncOperationResponse[
"capo_osis.types.list_pipelines_response.ListPipelinesResponse"
]:
import capo_osis._operations.amazon_open_search_ingestion_service.list_pipelines
(
output,
http_response,
) = await capo_osis._operations.amazon_open_search_ingestion_service.list_pipelines.async_list_pipelines(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListPipelines")
)
input_: capo_osis.types.list_pipelines_request.ListPipelinesRequest = {}
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
|