list_pipelines `async` ¶

list_pipelines(
    workspace_name: WorkspaceName,
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[ListPipelinesRequestMaxResultsInteger] = None,
) -> ListPipelinesResponse

Lists pipelines in a workspace. To get complete details about a pipeline, use DescribePipeline.

Parameters:

workspace_name (WorkspaceName) –

The name of the workspace.
next_token (Optional[PaginationToken], default: None ) –

The token to be used for the next set of paginated results.
max_results (Optional[ListPipelinesRequestMaxResultsInteger], default: None ) –

The maximum number of results to return for each paginated request. Default: 50.

Raises:

AccessDeniedException –

Access is denied.
InternalFailureException –

IoT SiteWise can't process your request right now. Try again later.
InvalidRequestException –

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
ResourceNotFoundException –

The requested resource can't be found.
ThrottlingException –

Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the IoT SiteWise User Guide.
UnknownServiceError –

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

Source code in docs_src/capo_iotsitewise/_services/async_io_t_site_wise.py

async def list_pipelines(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    *,
    config_overrides: Optional[AsyncIoTSiteWiseClientConfig] = None,
    next_token: Optional[
        "capo_iotsitewise.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_iotsitewise.types.list_pipelines_request_max_results_integer.ListPipelinesRequestMaxResultsInteger"
    ] = None,
) -> "capo_iotsitewise.types.list_pipelines_response.ListPipelinesResponse":
    """<p>Lists pipelines in a workspace. To get complete details about a pipeline, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribePipeline.html">DescribePipeline</a>.</p>

    Args:
        workspace_name: <p>The name of the workspace.</p>
        next_token: <p>The token to be used for the next set of paginated results.</p>
        max_results: <p>The maximum number of results to return for each paginated request. Default: 50.</p>

    Raises:
        capo_iotsitewise.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotsitewise.types.list_pipelines_request.ListPipelinesRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotsitewise.types.list_pipelines_response.ListPipelinesResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.list_pipelines

        (
            output,
            http_response,
        ) = await capo_iotsitewise._operations.aws_io_t_site_wise.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_iotsitewise.types.list_pipelines_request.ListPipelinesRequest = {
        "workspace_name": workspace_name
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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

list_pipelines async ¶

list_pipelines `async` ¶