SWF / Client / describe_workflow_type

describe_workflow_type#

SWF.Client.describe_workflow_type(**kwargs)#

Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.

Access Control

You can use IAM policies to control this action’s access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • workflowType.name: String constraint. The key is swf:workflowType.name.

    • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_workflow_type(
    domain='string',
    workflowType={
        'name': 'string',
        'version': 'string'
    }
)
Parameters:

  • domain (string) –

    [REQUIRED]

    The name of the domain in which this workflow type is registered.

  • workflowType (dict) –

    [REQUIRED]

    The workflow type to describe.

    • name (string) – [REQUIRED]

      The name of the workflow type.

      Note

      The combination of workflow type name and version must be unique with in a domain.

    • version (string) – [REQUIRED]

      The version of the workflow type.

      Note

      The combination of workflow type name and version must be unique with in a domain.

Return type:

dict

Returns:

Response Syntax

{
    'typeInfo': {
        'workflowType': {
            'name': 'string',
            'version': 'string'
        },
        'status': 'REGISTERED'|'DEPRECATED',
        'description': 'string',
        'creationDate': datetime(2015, 1, 1),
        'deprecationDate': datetime(2015, 1, 1)
    },
    'configuration': {
        'defaultTaskStartToCloseTimeout': 'string',
        'defaultExecutionStartToCloseTimeout': 'string',
        'defaultTaskList': {
            'name': 'string'
        },
        'defaultTaskPriority': 'string',
        'defaultChildPolicy': 'TERMINATE'|'REQUEST_CANCEL'|'ABANDON',
        'defaultLambdaRole': 'string'
    }
}

Response Structure

  • (dict) –

    Contains details about a workflow type.

    • typeInfo (dict) –

      General information about the workflow type.

      The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

      • REGISTERED – The type is registered and available. Workers supporting this type should be running.

      • DEPRECATED – The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.

      • workflowType (dict) –

        The workflow type this information is about.

        • name (string) –

          The name of the workflow type.

          Note

          The combination of workflow type name and version must be unique with in a domain.

        • version (string) –

          The version of the workflow type.

          Note

          The combination of workflow type name and version must be unique with in a domain.

      • status (string) –

        The current status of the workflow type.

      • description (string) –

        The description of the type registered through RegisterWorkflowType.

      • creationDate (datetime) –

        The date when this type was registered.

      • deprecationDate (datetime) –

        If the type is in deprecated state, then it is set to the date when the type was deprecated.

    • configuration (dict) –

      Configuration settings of the workflow type registered through RegisterWorkflowType

      • defaultTaskStartToCloseTimeout (string) –

        The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn’tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

        The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

      • defaultExecutionStartToCloseTimeout (string) –

        The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

        The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

      • defaultTaskList (dict) –

        The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

        • name (string) –

          The name of the task list.

      • defaultTaskPriority (string) –

        The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

        Valid values are integers that range from Java’s Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

        For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

      • defaultChildPolicy (string) –

        The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

        The supported child policies are:

        • TERMINATE – The child executions are terminated.

        • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

        • ABANDON – No action is taken. The child executions continue to run.

      • defaultLambdaRole (string) –

        The default IAM role attached to this workflow type.

        Note

        Executions of this workflow type need IAM roles to invoke Lambda functions. If you don’t specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

Exceptions