Skip to content

list_data_integration_flows

list_data_integration_flows(
    instance_id: UUID,
    *,
    config_overrides: Optional[SupplyChainClientConfig] = None,
    next_token: Optional[DataIntegrationFlowNextToken] = None,
    max_results: Optional[DataIntegrationFlowMaxResults] = None,
) -> ListDataIntegrationFlowsResponse

Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.

Parameters:

  • instance_id (UUID) –

    The Amazon Web Services Supply Chain instance identifier.

  • next_token (Optional[DataIntegrationFlowNextToken], default: None ) –

    The pagination token to fetch the next page of the DataIntegrationFlows.

  • max_results (Optional[DataIntegrationFlowMaxResults], default: None ) –

    Specify the maximum number of DataIntegrationFlows to fetch in one paginated request.

Raises:

Examples:

Successful ListDataIntegrationFlow

>>> client.list_data_integration_flows(instance_id='8850c54e-e187-4fa7-89d4-6370f165174d')
Source code in docs_src/capo_supplychain/_services/supply_chain.py
def list_data_integration_flows(
    self,
    instance_id: "capo_supplychain.types.uuid.UUID",
    *,
    config_overrides: Optional[SupplyChainClientConfig] = None,
    next_token: Optional[
        "capo_supplychain.types.data_integration_flow_next_token.DataIntegrationFlowNextToken"
    ] = None,
    max_results: Optional[
        "capo_supplychain.types.data_integration_flow_max_results.DataIntegrationFlowMaxResults"
    ] = None,
) -> "capo_supplychain.types.list_data_integration_flows_response.ListDataIntegrationFlowsResponse":
    """<p>Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.</p>

    Args:
        instance_id: <p>The Amazon Web Services Supply Chain instance identifier.</p>
        next_token: <p>The pagination token to fetch the next page of the DataIntegrationFlows.</p>
        max_results: <p>Specify the maximum number of DataIntegrationFlows to fetch in one paginated request.</p>

    Raises:
        capo_supplychain.errors.access_denied_exception.AccessDeniedException: <p>You do not have the required privileges to perform this action.</p>
        capo_supplychain.errors.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</p>
        capo_supplychain.errors.internal_server_exception.InternalServerException: <p>Unexpected error during processing of request.</p>
        capo_supplychain.errors.resource_not_found_exception.ResourceNotFoundException: <p>Request references a resource which does not exist.</p>
        capo_supplychain.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Request would cause a service quota to be exceeded.</p>
        capo_supplychain.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_supplychain.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an AWS service.</p>
        capo_supplychain.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Successful ListDataIntegrationFlow

        >>> client.list_data_integration_flows(instance_id='8850c54e-e187-4fa7-89d4-6370f165174d')
    """

    def _handler(
        req: "OperationRequest[capo_supplychain.types.list_data_integration_flows_request.ListDataIntegrationFlowsRequest]",
    ) -> OperationResponse[
        "capo_supplychain.types.list_data_integration_flows_response.ListDataIntegrationFlowsResponse"
    ]:
        import capo_supplychain._operations.galaxy_public_api_gateway.list_data_integration_flows

        output, http_response = (
            capo_supplychain._operations.galaxy_public_api_gateway.list_data_integration_flows.list_data_integration_flows(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_supplychain.types.list_data_integration_flows_response.ListDataIntegrationFlowsResponse",
    ) -> dict[str, Any]:
        import capo_supplychain.types.list_data_integration_flows_response

        return capo_supplychain.types.list_data_integration_flows_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListDataIntegrationFlows", redact_output=_redact_output),
    )
    input_: capo_supplychain.types.list_data_integration_flows_request.ListDataIntegrationFlowsRequest = {
        "instance_id": instance_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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