Skip to content

DescribeFlowDefinitionResponse

Source code in docs_src/capo_sagemaker/types/describe_flow_definition_response.py
class DescribeFlowDefinitionResponse(TypedDict, closed=True):
    flow_definition_arn: NotRequired[
        "capo_sagemaker.types.flow_definition_arn.FlowDefinitionArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the flow defintion.</p>"""
    flow_definition_name: NotRequired[
        "capo_sagemaker.types.flow_definition_name.FlowDefinitionName"
    ]
    """<p>The Amazon Resource Name (ARN) of the flow definition.</p>"""
    flow_definition_status: NotRequired[
        "capo_sagemaker.types.flow_definition_status.FlowDefinitionStatus"
    ]
    """<p>The status of the flow definition. Valid values are listed below.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The timestamp when the flow definition was created.</p>"""
    human_loop_request_source: NotRequired[
        "capo_sagemaker.types.human_loop_request_source.HumanLoopRequestSource"
    ]
    """<p>Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.</p>"""
    human_loop_activation_config: NotRequired[
        "capo_sagemaker.types.human_loop_activation_config.HumanLoopActivationConfig"
    ]
    """<p>An object containing information about what triggers a human review workflow.</p>"""
    human_loop_config: NotRequired[
        "capo_sagemaker.types.human_loop_config.HumanLoopConfig"
    ]
    """<p>An object containing information about who works on the task, the workforce task price, and other task details.</p>"""
    output_config: NotRequired[
        "capo_sagemaker.types.flow_definition_output_config.FlowDefinitionOutputConfig"
    ]
    """<p>An object containing information about the output file.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>The reason your flow definition failed.</p>"""

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The timestamp when the flow definition was created.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

The reason your flow definition failed.

flow_definition_arn instance-attribute

flow_definition_arn: NotRequired[FlowDefinitionArn]

The Amazon Resource Name (ARN) of the flow defintion.

flow_definition_name instance-attribute

flow_definition_name: NotRequired[FlowDefinitionName]

The Amazon Resource Name (ARN) of the flow definition.

flow_definition_status instance-attribute

flow_definition_status: NotRequired[FlowDefinitionStatus]

The status of the flow definition. Valid values are listed below.

human_loop_activation_config instance-attribute

human_loop_activation_config: NotRequired[HumanLoopActivationConfig]

An object containing information about what triggers a human review workflow.

human_loop_config instance-attribute

human_loop_config: NotRequired[HumanLoopConfig]

An object containing information about who works on the task, the workforce task price, and other task details.

human_loop_request_source instance-attribute

human_loop_request_source: NotRequired[HumanLoopRequestSource]

Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

output_config instance-attribute

output_config: NotRequired[FlowDefinitionOutputConfig]

An object containing information about the output file.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.