Skip to content

list_workflow_steps

list_workflow_steps(
    workflow_id: MigrationWorkflowId,
    step_group_id: StepGroupId,
    *,
    config_overrides: Optional[MigrationHubOrchestratorClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListWorkflowStepsResponse

List the steps in a workflow.

Parameters:

Raises:

Source code in docs_src/capo_migrationhuborchestrator/_services/migration_hub_orchestrator.py
def list_workflow_steps(
    self,
    workflow_id: "capo_migrationhuborchestrator.types.migration_workflow_id.MigrationWorkflowId",
    step_group_id: "capo_migrationhuborchestrator.types.step_group_id.StepGroupId",
    *,
    config_overrides: Optional[MigrationHubOrchestratorClientConfig] = None,
    next_token: Optional[
        "capo_migrationhuborchestrator.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_migrationhuborchestrator.types.max_results.MaxResults"
    ] = None,
) -> "capo_migrationhuborchestrator.types.list_workflow_steps_response.ListWorkflowStepsResponse":
    """<p>List the steps in a workflow.</p>

    Args:
        next_token: <p>The pagination token.</p>
        max_results: <p>The maximum number of results that can be returned.</p>
        workflow_id: <p>The ID of the migration workflow.</p>
        step_group_id: <p>The ID of the step group.</p>

    Raises:
        capo_migrationhuborchestrator.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_migrationhuborchestrator.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
        capo_migrationhuborchestrator.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_migrationhuborchestrator.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_migrationhuborchestrator.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_migrationhuborchestrator.types.list_workflow_steps_request.ListWorkflowStepsRequest]",
    ) -> OperationResponse[
        "capo_migrationhuborchestrator.types.list_workflow_steps_response.ListWorkflowStepsResponse"
    ]:
        import capo_migrationhuborchestrator._operations.aws_migration_hub_orchestrator.list_workflow_steps

        output, http_response = (
            capo_migrationhuborchestrator._operations.aws_migration_hub_orchestrator.list_workflow_steps.list_workflow_steps(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWorkflowSteps")
    )
    input_: capo_migrationhuborchestrator.types.list_workflow_steps_request.ListWorkflowStepsRequest = {
        "workflow_id": workflow_id,
        "step_group_id": step_group_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