list_workflows ¶

def list_workflows(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    *,
    config_overrides: Optional[CustomerProfilesClientConfig] = None,
    workflow_type: Optional[
        "capo_customer_profiles.types.workflow_type.WorkflowType"
    ] = None,
    status: Optional["capo_customer_profiles.types.status.Status"] = None,
    query_start_date: Optional[
        "capo_customer_profiles.types.timestamp.timestamp"
    ] = None,
    query_end_date: Optional[
        "capo_customer_profiles.types.timestamp.timestamp"
    ] = None,
    next_token: Optional["capo_customer_profiles.types.token.token"] = None,
    max_results: Optional[
        "capo_customer_profiles.types.max_size100.maxSize100"
    ] = None,
) -> "capo_customer_profiles.types.list_workflows_response.ListWorkflowsResponse":
    """<p>Query to list all workflows.</p>

    Args:
        domain_name: <p>The unique name of the domain.</p>
        workflow_type: <p>The type of workflow. The only supported value is APPFLOW_INTEGRATION.</p>
        status: <p>Status of workflow execution.</p>
        query_start_date: <p>Retrieve workflows started after timestamp.</p>
        query_end_date: <p>Retrieve workflows ended after timestamp.</p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
        max_results: <p>The maximum number of results to return per page.</p>

    Raises:
        capo_customer_profiles.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_customer_profiles.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_customer_profiles.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred.</p>
        capo_customer_profiles.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist, or access was denied.</p>
        capo_customer_profiles.errors.throttling_exception.ThrottlingException: <p>You exceeded the maximum number of requests.</p>
        capo_customer_profiles.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_customer_profiles.types.list_workflows_request.ListWorkflowsRequest]",
    ) -> OperationResponse[
        "capo_customer_profiles.types.list_workflows_response.ListWorkflowsResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.list_workflows

        output, http_response = (
            capo_customer_profiles._operations.customer_profiles_20200815.list_workflows.list_workflows(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWorkflows")
    )
    input_: capo_customer_profiles.types.list_workflows_request.ListWorkflowsRequest = {
        "domain_name": domain_name
    }
    if workflow_type is not None:
        input_["workflow_type"] = workflow_type
    if status is not None:
        input_["status"] = status
    if query_start_date is not None:
        input_["query_start_date"] = query_start_date
    if query_end_date is not None:
        input_["query_end_date"] = query_end_date
    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