SageMaker / Client / describe_flow_definition

describe_flow_definition#

SageMaker.Client.describe_flow_definition(**kwargs)#

Returns information about the specified flow definition.

Request Syntax

response = client.describe_flow_definition(
    FlowDefinitionName='string'
)

Parameters:

FlowDefinitionName (string) –

[REQUIRED]

The name of the flow definition.

Return type:

dict

Returns:

Response Syntax

{
    'FlowDefinitionArn': 'string',
    'FlowDefinitionName': 'string',
    'FlowDefinitionStatus': 'Initializing'|'Active'|'Failed'|'Deleting',
    'CreationTime': datetime(2015, 1, 1),
    'HumanLoopRequestSource': {
        'AwsManagedHumanLoopRequestSource': 'AWS/Rekognition/DetectModerationLabels/Image/V3'|'AWS/Textract/AnalyzeDocument/Forms/V1'|'AWS/Textract/AnalyzeExpense'|'AWS/Handshake/VerifyIdentity'|'AWS/Bedrock/ModelEvaluation'
    },
    'HumanLoopActivationConfig': {
        'HumanLoopActivationConditionsConfig': {
            'HumanLoopActivationConditions': 'string'
        }
    },
    'HumanLoopConfig': {
        'WorkteamArn': 'string',
        'HumanTaskUiArn': 'string',
        'TaskTitle': 'string',
        'TaskDescription': 'string',
        'TaskCount': 123,
        'TaskAvailabilityLifetimeInSeconds': 123,
        'TaskTimeLimitInSeconds': 123,
        'TaskKeywords': [
            'string',
        ],
        'PublicWorkforceTaskPrice': {
            'AmountInUsd': {
                'Dollars': 123,
                'Cents': 123,
                'TenthFractionsOfACent': 123
            }
        }
    },
    'OutputConfig': {
        'S3OutputPath': 'string',
        'KmsKeyId': 'string'
    },
    'RoleArn': 'string',
    'FailureReason': 'string'
}

Response Structure

(dict) –
- FlowDefinitionArn (string) –
  
  The Amazon Resource Name (ARN) of the flow defintion.
- FlowDefinitionName (string) –
  
  The Amazon Resource Name (ARN) of the flow definition.
- FlowDefinitionStatus (string) –
  
  The status of the flow definition. Valid values are listed below.
- CreationTime (datetime) –
  
  The timestamp when the flow definition was created.
- HumanLoopRequestSource (dict) –
  
  Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.
  - AwsManagedHumanLoopRequestSource (string) –
    
    Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:
- HumanLoopActivationConfig (dict) –
  
  An object containing information about what triggers a human review workflow.
  - HumanLoopActivationConditionsConfig (dict) –
    
    Container structure for defining under what conditions SageMaker creates a human loop.
    - HumanLoopActivationConditions (string) –
      
      JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.
- HumanLoopConfig (dict) –
  
  An object containing information about who works on the task, the workforce task price, and other task details.
  - WorkteamArn (string) –
    
    Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.
  - HumanTaskUiArn (string) –
    
    The Amazon Resource Name (ARN) of the human task user interface.
    
    You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.
    
    To learn how to create a custom HTML template, see Create Custom Worker Task Template.
    
    To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.
  - TaskTitle (string) –
    
    A title for the human worker task.
  - TaskDescription (string) –
    
    A description for the human worker task.
  - TaskCount (integer) –
    
    The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.
  - TaskAvailabilityLifetimeInSeconds (integer) –
    
    The length of time that a task remains available for review by human workers.
  - TaskTimeLimitInSeconds (integer) –
    
    The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).
  - TaskKeywords (list) –
    
    Keywords used to describe the task so that workers can discover the task.
    - (string) –
  - PublicWorkforceTaskPrice (dict) –
    
    Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.
    
    Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.
    - 0.036
    - 0.048
    - 0.060
    - 0.072
    - 0.120
    - 0.240
    - 0.360
    - 0.480
    - 0.600
    - 0.720
    - 0.840
    - 0.960
    - 1.080
    - 1.200
    Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.
    - 0.012
    - 0.024
    - 0.036
    - 0.048
    - 0.060
    - 0.072
    - 0.120
    - 0.240
    - 0.360
    - 0.480
    - 0.600
    - 0.720
    - 0.840
    - 0.960
    - 1.080
    - 1.200
    Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.
    - 0.840
    - 0.960
    - 1.080
    - 1.200
    Use one of the following prices for Textract AnalyzeDocument Important Form Key Amazon Augmented AI review tasks. Prices are in US dollars.
    - 2.400
    - 2.280
    - 2.160
    - 2.040
    - 1.920
    - 1.800
    - 1.680
    - 1.560
    - 1.440
    - 1.320
    - 1.200
    - 1.080
    - 0.960
    - 0.840
    - 0.720
    - 0.600
    - 0.480
    - 0.360
    - 0.240
    - 0.120
    - 0.072
    - 0.060
    - 0.048
    - 0.036
    - 0.024
    - 0.012
    Use one of the following prices for Rekognition DetectModerationLabels Amazon Augmented AI review tasks. Prices are in US dollars.
    - 1.200
    - 1.080
    - 0.960
    - 0.840
    - 0.720
    - 0.600
    - 0.480
    - 0.360
    - 0.240
    - 0.120
    - 0.072
    - 0.060
    - 0.048
    - 0.036
    - 0.024
    - 0.012
    Use one of the following prices for Amazon Augmented AI custom human review tasks. Prices are in US dollars.
    - 1.200
    - 1.080
    - 0.960
    - 0.840
    - 0.720
    - 0.600
    - 0.480
    - 0.360
    - 0.240
    - 0.120
    - 0.072
    - 0.060
    - 0.048
    - 0.036
    - 0.024
    - 0.012
    - AmountInUsd (dict) –
      
      Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.
      - Dollars (integer) –
        
        The whole number of dollars in the amount.
      - Cents (integer) –
        
        The fractional portion, in cents, of the amount.
      - TenthFractionsOfACent (integer) –
        
        Fractions of a cent, in tenths.
- OutputConfig (dict) –
  
  An object containing information about the output file.
  - S3OutputPath (string) –
    
    The Amazon S3 path where the object containing human output will be made available.
    
    To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.
  - KmsKeyId (string) –
    
    The Amazon Key Management Service (KMS) key ID for server-side encryption.
- RoleArn (string) –
  
  The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.
- FailureReason (string) –
  
  The reason your flow definition failed.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound