Skip to content

Describe Flow Definition

sagemaker_describe_flow_definition R Documentation

Returns information about the specified flow definition

Description

Returns information about the specified flow definition.

Usage

sagemaker_describe_flow_definition(FlowDefinitionName)

Arguments

FlowDefinitionName

[required] The name of the flow definition.

Value

A list with the following syntax:

list(
  FlowDefinitionArn = "string",
  FlowDefinitionName = "string",
  FlowDefinitionStatus = "Initializing"|"Active"|"Failed"|"Deleting",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  HumanLoopRequestSource = list(
    AwsManagedHumanLoopRequestSource = "AWS/Rekognition/DetectModerationLabels/Image/V3"|"AWS/Textract/AnalyzeDocument/Forms/V1"
  ),
  HumanLoopActivationConfig = list(
    HumanLoopActivationConditionsConfig = list(
      HumanLoopActivationConditions = "string"
    )
  ),
  HumanLoopConfig = list(
    WorkteamArn = "string",
    HumanTaskUiArn = "string",
    TaskTitle = "string",
    TaskDescription = "string",
    TaskCount = 123,
    TaskAvailabilityLifetimeInSeconds = 123,
    TaskTimeLimitInSeconds = 123,
    TaskKeywords = list(
      "string"
    ),
    PublicWorkforceTaskPrice = list(
      AmountInUsd = list(
        Dollars = 123,
        Cents = 123,
        TenthFractionsOfACent = 123
      )
    )
  ),
  OutputConfig = list(
    S3OutputPath = "string",
    KmsKeyId = "string"
  ),
  RoleArn = "string",
  FailureReason = "string"
)

Request syntax

svc$describe_flow_definition(
  FlowDefinitionName = "string"
)