Skip to content

Latest commit

 

History

History
95 lines (82 loc) · 3.58 KB

README.md

File metadata and controls

95 lines (82 loc) · 3.58 KB
Raw

Main State Machine

The main state machine is the entry point to process a new ingest request. It serializes the ingest workflow and analysis workflow using AWS Step Function Nested Workflows technique.

Main state machine

State machine definition

{
    "Comment": "main state machine to run ingest and anlysis sub state machines",
    "StartAt": "Start ingest state machine",
    "States": {
        "Start ingest state machine": {
            "Type": "Task",
            "Resource": "arn:aws:states:::states:startExecution.sync",
            "Parameters": {
                "Input": {
                    "input.$": "$.input"
                },
                "StateMachineArn": "${IngestStateMachine}"
            },
            "ResultSelector": {
                "ingestOutput.$": "States.StringToJson($.Input)"
            },
            "Next": "Start analysis state machine"
        },
        "Start analysis state machine": {
            "Type": "Task",
            "Resource": "arn:aws:states:::states:startExecution.sync",
            "Parameters": {
                "Input": {
                    "uuid.$": "$.ingestOutput.input.uuid",
                    "input.$": "$.ingestOutput.input"
                },
                "StateMachineArn": "${AnalysisStateMachine}"
            },
            "End": true
        }
    }
}

The main state machine starts and waits the ingest workflow where it creates and standardizes proxies. When the ingest workflow successfully completes, it transitions to the analysis workflow to extract AI/ML metadata.

__

Execution input

{
  "input": {
    "uuid": "UUID",
    "bucket": "INGEST_BUCKET",
    "key": "S3_OBJECT_KEY",
    "destination": {
      "bucket": "PROXY_BUCKET",
      "prefix": "PREFIX"
    },
    "group": "GROUP",
    "attributes": {
        "key01": "value01",
        ...
    },
    "aiOptions": {
        "celeb": true,
        "label": false,
        ...
    }
  }
}
Field Description Required?
input.uuid Universally unique identifier (Version 4) Mandatory
input.bucket Ingest bucket where it stores the uploaded media file Mandatory
input.key Location of the uploaded media file Mandatory
input.destination.bucket Proxy bucket where it stores generated proxies, thumbnail images, AI/ML metadata JSON files. If not specified, it uses the proxy bucket created by the solution Optional
input.destination.prefix Location of where to store generated proxies, thumbnail images, AI/ML metadata JSON files. If not specified, it uses the UUID prefix. Optional
input.group Grouping multiple uploaded media files and store them in the ingest bucket with a top-level prefix of the specified "GROUP" Optional
input.attributes.* key value pair of additional attributes of the media file, stored as object metadata. Optional
input.aiOptions.* AI/ML options to run the analysis workflow. If not specified, the solution uses the default AI/ML options specified when the Amazon CloudFormation stack was created Optional

__

Related topics

__

Back to Table of contents