Skip to content

get_workflow_definition

get_workflow_definition(
    workflow_definition_name: WorkflowDefinitionName,
    *,
    config_overrides: Optional[NovaActClientConfig] = None,
) -> GetWorkflowDefinitionResponse

Retrieves the details and configuration of a specific workflow definition.

Parameters:

Raises:

Source code in docs_src/capo_nova_act/_services/nova_act.py
def get_workflow_definition(
    self,
    workflow_definition_name: "capo_nova_act.types.workflow_definition_name.WorkflowDefinitionName",
    *,
    config_overrides: Optional[NovaActClientConfig] = None,
) -> "capo_nova_act.types.get_workflow_definition_response.GetWorkflowDefinitionResponse":
    """<p>Retrieves the details and configuration of a specific workflow definition.</p>

    Args:
        workflow_definition_name: <p>The name of the workflow definition to retrieve.</p>

    Raises:
        capo_nova_act.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permissions to perform this action.</p>
        capo_nova_act.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Please try again later.</p>
        capo_nova_act.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</p>
        capo_nova_act.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests. Please try again later.</p>
        capo_nova_act.errors.validation_exception.ValidationException: <p>The input parameters for the request are invalid.</p>
        capo_nova_act.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_nova_act.types.get_workflow_definition_request.GetWorkflowDefinitionRequest]",
    ) -> OperationResponse[
        "capo_nova_act.types.get_workflow_definition_response.GetWorkflowDefinitionResponse"
    ]:
        import capo_nova_act._operations.amazon_nova_agents_data_plane.get_workflow_definition

        output, http_response = (
            capo_nova_act._operations.amazon_nova_agents_data_plane.get_workflow_definition.get_workflow_definition(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_nova_act.types.get_workflow_definition_response.GetWorkflowDefinitionResponse",
    ) -> dict[str, Any]:
        import capo_nova_act.types.get_workflow_definition_response

        return (
            capo_nova_act.types.get_workflow_definition_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetWorkflowDefinition", redact_output=_redact_output),
    )
    input_: capo_nova_act.types.get_workflow_definition_request.GetWorkflowDefinitionRequest = {
        "workflow_definition_name": workflow_definition_name
    }

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