Data Automation for Amazon Bedrock

2025/04/24 - Data Automation for Amazon Bedrock - 3 updated api methods

Changes  Added support for modality routing and modality enablement on CreateDataAutomationProject and UpdateDataAutomationProject APIs

CreateDataAutomationProject (updated) Link ¶
Changes (request) 
{'overrideConfiguration': {'audio': {'modalityProcessing': {'state': 'ENABLED '
                                                                     '| '
                                                                     'DISABLED'}},
                           'document': {'modalityProcessing': {'state': 'ENABLED '
                                                                        '| '
                                                                        'DISABLED'}},
                           'image': {'modalityProcessing': {'state': 'ENABLED '
                                                                     '| '
                                                                     'DISABLED'}},
                           'modalityRouting': {'jpeg': 'IMAGE | DOCUMENT | '
                                                       'AUDIO | VIDEO',
                                               'mov': 'IMAGE | DOCUMENT | '
                                                      'AUDIO | VIDEO',
                                               'mp4': 'IMAGE | DOCUMENT | '
                                                      'AUDIO | VIDEO',
                                               'png': 'IMAGE | DOCUMENT | '
                                                      'AUDIO | VIDEO'},
                           'video': {'modalityProcessing': {'state': 'ENABLED '
                                                                     '| '
                                                                     'DISABLED'}}}}

Creates an Amazon Bedrock Data Automation Project

See also: AWS API Documentation

Request Syntax

client.create_data_automation_project(
    projectName='string',
    projectDescription='string',
    projectStage='DEVELOPMENT'|'LIVE',
    standardOutputConfiguration={
        'document': {
            'extraction': {
                'granularity': {
                    'types': [
                        'DOCUMENT'|'PAGE'|'ELEMENT'|'WORD'|'LINE',
                    ]
                },
                'boundingBox': {
                    'state': 'ENABLED'|'DISABLED'
                }
            },
            'generativeField': {
                'state': 'ENABLED'|'DISABLED'
            },
            'outputFormat': {
                'textFormat': {
                    'types': [
                        'PLAIN_TEXT'|'MARKDOWN'|'HTML'|'CSV',
                    ]
                },
                'additionalFileFormat': {
                    'state': 'ENABLED'|'DISABLED'
                }
            }
        },
        'image': {
            'extraction': {
                'category': {
                    'state': 'ENABLED'|'DISABLED',
                    'types': [
                        'CONTENT_MODERATION'|'TEXT_DETECTION'|'LOGOS',
                    ]
                },
                'boundingBox': {
                    'state': 'ENABLED'|'DISABLED'
                }
            },
            'generativeField': {
                'state': 'ENABLED'|'DISABLED',
                'types': [
                    'IMAGE_SUMMARY'|'IAB',
                ]
            }
        },
        'video': {
            'extraction': {
                'category': {
                    'state': 'ENABLED'|'DISABLED',
                    'types': [
                        'CONTENT_MODERATION'|'TEXT_DETECTION'|'TRANSCRIPT'|'LOGOS',
                    ]
                },
                'boundingBox': {
                    'state': 'ENABLED'|'DISABLED'
                }
            },
            'generativeField': {
                'state': 'ENABLED'|'DISABLED',
                'types': [
                    'VIDEO_SUMMARY'|'IAB'|'CHAPTER_SUMMARY',
                ]
            }
        },
        'audio': {
            'extraction': {
                'category': {
                    'state': 'ENABLED'|'DISABLED',
                    'types': [
                        'AUDIO_CONTENT_MODERATION'|'TRANSCRIPT'|'TOPIC_CONTENT_MODERATION',
                    ]
                }
            },
            'generativeField': {
                'state': 'ENABLED'|'DISABLED',
                'types': [
                    'AUDIO_SUMMARY'|'IAB'|'TOPIC_SUMMARY',
                ]
            }
        }
    },
    customOutputConfiguration={
        'blueprints': [
            {
                'blueprintArn': 'string',
                'blueprintVersion': 'string',
                'blueprintStage': 'DEVELOPMENT'|'LIVE'
            },
        ]
    },
    overrideConfiguration={
        'document': {
            'splitter': {
                'state': 'ENABLED'|'DISABLED'
            },
            'modalityProcessing': {
                'state': 'ENABLED'|'DISABLED'
            }
        },
        'image': {
            'modalityProcessing': {
                'state': 'ENABLED'|'DISABLED'
            }
        },
        'video': {
            'modalityProcessing': {
                'state': 'ENABLED'|'DISABLED'
            }
        },
        'audio': {
            'modalityProcessing': {
                'state': 'ENABLED'|'DISABLED'
            }
        },
        'modalityRouting': {
            'jpeg': 'IMAGE'|'DOCUMENT'|'AUDIO'|'VIDEO',
            'png': 'IMAGE'|'DOCUMENT'|'AUDIO'|'VIDEO',
            'mp4': 'IMAGE'|'DOCUMENT'|'AUDIO'|'VIDEO',
            'mov': 'IMAGE'|'DOCUMENT'|'AUDIO'|'VIDEO'
        }
    },
    clientToken='string',
    encryptionConfiguration={
        'kmsKeyId': 'string',
        'kmsEncryptionContext': {
            'string': 'string'
        }
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
type projectName:

string

param projectName:

[REQUIRED]

Name of the DataAutomationProject

type projectDescription:

string

param projectDescription:

Description of the DataAutomationProject

type projectStage:

string

param projectStage:

Stage of the Project

type standardOutputConfiguration:

dict

param standardOutputConfiguration:

[REQUIRED]

Standard output configuration

  • document (dict) --

    Standard Output Configuration of Document

    • extraction (dict) --

      Standard Extraction Configuration of Document

      • granularity (dict) -- [REQUIRED]

        Granularity of Document Extraction

        • types (list) --

          List of Document Extraction Granularity Type

          • (string) --

      • boundingBox (dict) -- [REQUIRED]

        Bounding Box Configuration of Document Extraction

        • state (string) -- [REQUIRED]

          State

    • generativeField (dict) --

      Standard Generative Field Configuration of Document

      • state (string) -- [REQUIRED]

        State

    • outputFormat (dict) --

      Output Format of Document

      • textFormat (dict) -- [REQUIRED]

        Text Format of Document Output

        • types (list) --

          List of Document Output Text Format Type

          • (string) --

      • additionalFileFormat (dict) -- [REQUIRED]

        Additional File Format of Document Output

        • state (string) -- [REQUIRED]

          State

  • image (dict) --

    Standard Output Configuration of Image

    • extraction (dict) --

      Standard Extraction Configuration of Image

      • category (dict) -- [REQUIRED]

        Category of Image Extraction

        • state (string) -- [REQUIRED]

          State

        • types (list) --

          List of Image Extraction Category

          • (string) --

      • boundingBox (dict) -- [REQUIRED]

        Bounding Box Configuration of Image Extraction

        • state (string) -- [REQUIRED]

          State

    • generativeField (dict) --

      Standard Generative Field Configuration of Image

      • state (string) -- [REQUIRED]

        State

      • types (list) --

        List of Image Standard Generative Field Type

        • (string) --

  • video (dict) --

    Standard Output Configuration of Video

    • extraction (dict) --

      Standard Extraction Configuration of Video

      • category (dict) -- [REQUIRED]

        Category of Video Extraction

        • state (string) -- [REQUIRED]

          State

        • types (list) --

          List of Video Extraction Category Type

          • (string) --

      • boundingBox (dict) -- [REQUIRED]

        Bounding Box Configuration of Video Extraction

        • state (string) -- [REQUIRED]

          State

    • generativeField (dict) --

      Standard Generative Field Configuration of Video

      • state (string) -- [REQUIRED]

        State

      • types (list) --

        List of Video Standard Generative Field Type

        • (string) --

  • audio (dict) --

    Standard Output Configuration of Audio

    • extraction (dict) --

      Standard Extraction Configuration of Audio

      • category (dict) -- [REQUIRED]

        Category of Audio Extraction

        • state (string) -- [REQUIRED]

          State

        • types (list) --

          List of Audio Extraction Category Type

          • (string) --

    • generativeField (dict) --

      Standard Generative Field Configuration of Audio

      • state (string) -- [REQUIRED]

        State

      • types (list) --

        List of Audio Standard Generative Field Type

        • (string) --

type customOutputConfiguration:

dict

param customOutputConfiguration:

Custom output configuration

  • blueprints (list) --

    List of Blueprint Item

    • (dict) --

      Blueprint Item

      • blueprintArn (string) -- [REQUIRED]

        ARN of a Blueprint

      • blueprintVersion (string) --

        Blueprint Version

      • blueprintStage (string) --

        Stage of the Blueprint

type overrideConfiguration:

dict

param overrideConfiguration:

Override configuration

  • document (dict) --

    Override Configuration of Document

    • splitter (dict) --

      Configuration of Splitter

      • state (string) --

        State

    • modalityProcessing (dict) --

      Configuration to enable/disable processing of modality

      • state (string) --

        State

  • image (dict) --

    Override Configuration of Image

    • modalityProcessing (dict) --

      Configuration to enable/disable processing of modality

      • state (string) --

        State

  • video (dict) --

    Override Configuration of Video

    • modalityProcessing (dict) --

      Configuration to enable/disable processing of modality

      • state (string) --

        State

  • audio (dict) --

    Override Configuration of Audio

    • modalityProcessing (dict) --

      Configuration to enable/disable processing of modality

      • state (string) --

        State

  • modalityRouting (dict) --

    Configuration for routing file type to desired modality

    • jpeg (string) --

      Desired Modality types

    • png (string) --

      Desired Modality types

    • mp4 (string) --

      Desired Modality types

    • mov (string) --

      Desired Modality types

type clientToken:

string

param clientToken:

Client specified token used for idempotency checks

This field is autopopulated if not provided.

type encryptionConfiguration:

dict

param encryptionConfiguration:

KMS Encryption Configuration

  • kmsKeyId (string) -- [REQUIRED]

    KMS Key Identifier

  • kmsEncryptionContext (dict) --

    KMS Encryption Context

    • (string) --

      Encryption context key.

      • (string) --

        Encryption context value.

type tags:

list

param tags:

List of tags

  • (dict) --

    Key value pair of a tag

    • key (string) -- [REQUIRED]

      Defines the context of the tag.

    • value (string) -- [REQUIRED]

      Defines the value within the context. e.g. <key=reason, value=training>.

rtype:

dict

returns:

Response Syntax

{
    'projectArn': 'string',
    'projectStage': 'DEVELOPMENT'|'LIVE',
    'status': 'COMPLETED'|'IN_PROGRESS'|'FAILED'
}

Response Structure

  • (dict) --

    Create DataAutomationProject Response

    • projectArn (string) --

      ARN of a DataAutomationProject

    • projectStage (string) --

      Stage of the Project

    • status (string) --

      Status of Data Automation Project

GetDataAutomationProject (updated) Link ¶
Changes (response) 
{'project': {'overrideConfiguration': {'audio': {'modalityProcessing': {'state': 'ENABLED '
                                                                                 '| '
                                                                                 'DISABLED'}},
                                       'document': {'modalityProcessing': {'state': 'ENABLED '
                                                                                    '| '
                                                                                    'DISABLED'}},
                                       'image': {'modalityProcessing': {'state': 'ENABLED '
                                                                                 '| '
                                                                                 'DISABLED'}},
                                       'modalityRouting': {'jpeg': 'IMAGE | '
                                                                   'DOCUMENT | '
                                                                   'AUDIO | '
                                                                   'VIDEO',
                                                           'mov': 'IMAGE | '
                                                                  'DOCUMENT | '
                                                                  'AUDIO | '
                                                                  'VIDEO',
                                                           'mp4': 'IMAGE | '
                                                                  'DOCUMENT | '
                                                                  'AUDIO | '
                                                                  'VIDEO',
                                                           'png': 'IMAGE | '
                                                                  'DOCUMENT | '
                                                                  'AUDIO | '
                                                                  'VIDEO'},
                                       'video': {'modalityProcessing': {'state': 'ENABLED '
                                                                                 '| '
                                                                                 'DISABLED'}}}}}

Gets an existing Amazon Bedrock Data Automation Project

See also: AWS API Documentation

Request Syntax

client.get_data_automation_project(
    projectArn='string',
    projectStage='DEVELOPMENT'|'LIVE'
)
type projectArn:

string

param projectArn:

[REQUIRED]

ARN generated at the server side when a DataAutomationProject is created

type projectStage:

string

param projectStage:

Optional field to delete a specific DataAutomationProject stage

rtype:

dict

returns:

Response Syntax

{
    'project': {
        'projectArn': 'string',
        'creationTime': datetime(2015, 1, 1),
        'lastModifiedTime': datetime(2015, 1, 1),
        'projectName': 'string',
        'projectStage': 'DEVELOPMENT'|'LIVE',
        'projectDescription': 'string',
        'standardOutputConfiguration': {
            'document': {
                'extraction': {
                    'granularity': {
                        'types': [
                            'DOCUMENT'|'PAGE'|'ELEMENT'|'WORD'|'LINE',
                        ]
                    },
                    'boundingBox': {
                        'state': 'ENABLED'|'DISABLED'
                    }
                },
                'generativeField': {
                    'state': 'ENABLED'|'DISABLED'
                },
                'outputFormat': {
                    'textFormat': {
                        'types': [
                            'PLAIN_TEXT'|'MARKDOWN'|'HTML'|'CSV',
                        ]
                    },
                    'additionalFileFormat': {
                        'state': 'ENABLED'|'DISABLED'
                    }
                }
            },
            'image': {
                'extraction': {
                    'category': {
                        'state': 'ENABLED'|'DISABLED',
                        'types': [
                            'CONTENT_MODERATION'|'TEXT_DETECTION'|'LOGOS',
                        ]
                    },
                    'boundingBox': {
                        'state': 'ENABLED'|'DISABLED'
                    }
                },
                'generativeField': {
                    'state': 'ENABLED'|'DISABLED',
                    'types': [
                        'IMAGE_SUMMARY'|'IAB',
                    ]
                }
            },
            'video': {
                'extraction': {
                    'category': {
                        'state': 'ENABLED'|'DISABLED',
                        'types': [
                            'CONTENT_MODERATION'|'TEXT_DETECTION'|'TRANSCRIPT'|'LOGOS',
                        ]
                    },
                    'boundingBox': {
                        'state': 'ENABLED'|'DISABLED'
                    }
                },
                'generativeField': {
                    'state': 'ENABLED'|'DISABLED',
                    'types': [
                        'VIDEO_SUMMARY'|'IAB'|'CHAPTER_SUMMARY',
                    ]
                }
            },
            'audio': {
                'extraction': {
                    'category': {
                        'state': 'ENABLED'|'DISABLED',
                        'types': [
                            'AUDIO_CONTENT_MODERATION'|'TRANSCRIPT'|'TOPIC_CONTENT_MODERATION',
                        ]
                    }
                },
                'generativeField': {
                    'state': 'ENABLED'|'DISABLED',
                    'types': [
                        'AUDIO_SUMMARY'|'IAB'|'TOPIC_SUMMARY',
                    ]
                }
            }
        },
        'customOutputConfiguration': {
            'blueprints': [
                {
                    'blueprintArn': 'string',
                    'blueprintVersion': 'string',
                    'blueprintStage': 'DEVELOPMENT'|'LIVE'
                },
            ]
        },
        'overrideConfiguration': {
            'document': {
                'splitter': {
                    'state': 'ENABLED'|'DISABLED'
                },
                'modalityProcessing': {
                    'state': 'ENABLED'|'DISABLED'
                }
            },
            'image': {
                'modalityProcessing': {
                    'state': 'ENABLED'|'DISABLED'
                }
            },
            'video': {
                'modalityProcessing': {
                    'state': 'ENABLED'|'DISABLED'
                }
            },
            'audio': {
                'modalityProcessing': {
                    'state': 'ENABLED'|'DISABLED'
                }
            },
            'modalityRouting': {
                'jpeg': 'IMAGE'|'DOCUMENT'|'AUDIO'|'VIDEO',
                'png': 'IMAGE'|'DOCUMENT'|'AUDIO'|'VIDEO',
                'mp4': 'IMAGE'|'DOCUMENT'|'AUDIO'|'VIDEO',
                'mov': 'IMAGE'|'DOCUMENT'|'AUDIO'|'VIDEO'
            }
        },
        'status': 'COMPLETED'|'IN_PROGRESS'|'FAILED',
        'kmsKeyId': 'string',
        'kmsEncryptionContext': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    Get DataAutomationProject Response

    • project (dict) --

      Contains the information of a DataAutomationProject.

      • projectArn (string) --

        ARN of a DataAutomationProject

      • creationTime (datetime) --

        Time Stamp

      • lastModifiedTime (datetime) --

        Time Stamp

      • projectName (string) --

        Name of the DataAutomationProject

      • projectStage (string) --

        Stage of the Project

      • projectDescription (string) --

        Description of the DataAutomationProject

      • standardOutputConfiguration (dict) --

        Standard output configuration

        • document (dict) --

          Standard Output Configuration of Document

          • extraction (dict) --

            Standard Extraction Configuration of Document

            • granularity (dict) --

              Granularity of Document Extraction

              • types (list) --

                List of Document Extraction Granularity Type

                • (string) --

            • boundingBox (dict) --

              Bounding Box Configuration of Document Extraction

              • state (string) --

                State

          • generativeField (dict) --

            Standard Generative Field Configuration of Document

            • state (string) --

              State

          • outputFormat (dict) --

            Output Format of Document

            • textFormat (dict) --

              Text Format of Document Output

              • types (list) --

                List of Document Output Text Format Type

                • (string) --

            • additionalFileFormat (dict) --

              Additional File Format of Document Output

              • state (string) --

                State

        • image (dict) --

          Standard Output Configuration of Image

          • extraction (dict) --

            Standard Extraction Configuration of Image

            • category (dict) --

              Category of Image Extraction

              • state (string) --

                State

              • types (list) --

                List of Image Extraction Category

                • (string) --

            • boundingBox (dict) --

              Bounding Box Configuration of Image Extraction

              • state (string) --

                State

          • generativeField (dict) --

            Standard Generative Field Configuration of Image

            • state (string) --

              State

            • types (list) --

              List of Image Standard Generative Field Type

              • (string) --

        • video (dict) --

          Standard Output Configuration of Video

          • extraction (dict) --

            Standard Extraction Configuration of Video

            • category (dict) --

              Category of Video Extraction

              • state (string) --

                State

              • types (list) --

                List of Video Extraction Category Type

                • (string) --

            • boundingBox (dict) --

              Bounding Box Configuration of Video Extraction

              • state (string) --

                State

          • generativeField (dict) --

            Standard Generative Field Configuration of Video

            • state (string) --

              State

            • types (list) --

              List of Video Standard Generative Field Type

              • (string) --

        • audio (dict) --

          Standard Output Configuration of Audio

          • extraction (dict) --

            Standard Extraction Configuration of Audio

            • category (dict) --

              Category of Audio Extraction

              • state (string) --

                State

              • types (list) --

                List of Audio Extraction Category Type

                • (string) --

          • generativeField (dict) --

            Standard Generative Field Configuration of Audio

            • state (string) --

              State

            • types (list) --

              List of Audio Standard Generative Field Type

              • (string) --

      • customOutputConfiguration (dict) --

        Custom output configuration

        • blueprints (list) --

          List of Blueprint Item

          • (dict) --

            Blueprint Item

            • blueprintArn (string) --

              ARN of a Blueprint

            • blueprintVersion (string) --

              Blueprint Version

            • blueprintStage (string) --

              Stage of the Blueprint

      • overrideConfiguration (dict) --

        Override configuration

        • document (dict) --

          Override Configuration of Document

          • splitter (dict) --

            Configuration of Splitter

            • state (string) --

              State

          • modalityProcessing (dict) --

            Configuration to enable/disable processing of modality

            • state (string) --

              State

        • image (dict) --

          Override Configuration of Image

          • modalityProcessing (dict) --

            Configuration to enable/disable processing of modality

            • state (string) --

              State

        • video (dict) --

          Override Configuration of Video

          • modalityProcessing (dict) --

            Configuration to enable/disable processing of modality

            • state (string) --

              State

        • audio (dict) --

          Override Configuration of Audio

          • modalityProcessing (dict) --

            Configuration to enable/disable processing of modality

            • state (string) --

              State

        • modalityRouting (dict) --

          Configuration for routing file type to desired modality

          • jpeg (string) --

            Desired Modality types

          • png (string) --

            Desired Modality types

          • mp4 (string) --

            Desired Modality types

          • mov (string) --

            Desired Modality types

      • status (string) --

        Status of Data Automation Project

      • kmsKeyId (string) --

        KMS Key Identifier

      • kmsEncryptionContext (dict) --

        KMS Encryption Context

        • (string) --

          Encryption context key.

          • (string) --

            Encryption context value.

UpdateDataAutomationProject (updated) Link ¶
Changes (request) 
{'overrideConfiguration': {'audio': {'modalityProcessing': {'state': 'ENABLED '
                                                                     '| '
                                                                     'DISABLED'}},
                           'document': {'modalityProcessing': {'state': 'ENABLED '
                                                                        '| '
                                                                        'DISABLED'}},
                           'image': {'modalityProcessing': {'state': 'ENABLED '
                                                                     '| '
                                                                     'DISABLED'}},
                           'modalityRouting': {'jpeg': 'IMAGE | DOCUMENT | '
                                                       'AUDIO | VIDEO',
                                               'mov': 'IMAGE | DOCUMENT | '
                                                      'AUDIO | VIDEO',
                                               'mp4': 'IMAGE | DOCUMENT | '
                                                      'AUDIO | VIDEO',
                                               'png': 'IMAGE | DOCUMENT | '
                                                      'AUDIO | VIDEO'},
                           'video': {'modalityProcessing': {'state': 'ENABLED '
                                                                     '| '
                                                                     'DISABLED'}}}}

Updates an existing Amazon Bedrock Data Automation Project

See also: AWS API Documentation

Request Syntax

client.update_data_automation_project(
    projectArn='string',
    projectStage='DEVELOPMENT'|'LIVE',
    projectDescription='string',
    standardOutputConfiguration={
        'document': {
            'extraction': {
                'granularity': {
                    'types': [
                        'DOCUMENT'|'PAGE'|'ELEMENT'|'WORD'|'LINE',
                    ]
                },
                'boundingBox': {
                    'state': 'ENABLED'|'DISABLED'
                }
            },
            'generativeField': {
                'state': 'ENABLED'|'DISABLED'
            },
            'outputFormat': {
                'textFormat': {
                    'types': [
                        'PLAIN_TEXT'|'MARKDOWN'|'HTML'|'CSV',
                    ]
                },
                'additionalFileFormat': {
                    'state': 'ENABLED'|'DISABLED'
                }
            }
        },
        'image': {
            'extraction': {
                'category': {
                    'state': 'ENABLED'|'DISABLED',
                    'types': [
                        'CONTENT_MODERATION'|'TEXT_DETECTION'|'LOGOS',
                    ]
                },
                'boundingBox': {
                    'state': 'ENABLED'|'DISABLED'
                }
            },
            'generativeField': {
                'state': 'ENABLED'|'DISABLED',
                'types': [
                    'IMAGE_SUMMARY'|'IAB',
                ]
            }
        },
        'video': {
            'extraction': {
                'category': {
                    'state': 'ENABLED'|'DISABLED',
                    'types': [
                        'CONTENT_MODERATION'|'TEXT_DETECTION'|'TRANSCRIPT'|'LOGOS',
                    ]
                },
                'boundingBox': {
                    'state': 'ENABLED'|'DISABLED'
                }
            },
            'generativeField': {
                'state': 'ENABLED'|'DISABLED',
                'types': [
                    'VIDEO_SUMMARY'|'IAB'|'CHAPTER_SUMMARY',
                ]
            }
        },
        'audio': {
            'extraction': {
                'category': {
                    'state': 'ENABLED'|'DISABLED',
                    'types': [
                        'AUDIO_CONTENT_MODERATION'|'TRANSCRIPT'|'TOPIC_CONTENT_MODERATION',
                    ]
                }
            },
            'generativeField': {
                'state': 'ENABLED'|'DISABLED',
                'types': [
                    'AUDIO_SUMMARY'|'IAB'|'TOPIC_SUMMARY',
                ]
            }
        }
    },
    customOutputConfiguration={
        'blueprints': [
            {
                'blueprintArn': 'string',
                'blueprintVersion': 'string',
                'blueprintStage': 'DEVELOPMENT'|'LIVE'
            },
        ]
    },
    overrideConfiguration={
        'document': {
            'splitter': {
                'state': 'ENABLED'|'DISABLED'
            },
            'modalityProcessing': {
                'state': 'ENABLED'|'DISABLED'
            }
        },
        'image': {
            'modalityProcessing': {
                'state': 'ENABLED'|'DISABLED'
            }
        },
        'video': {
            'modalityProcessing': {
                'state': 'ENABLED'|'DISABLED'
            }
        },
        'audio': {
            'modalityProcessing': {
                'state': 'ENABLED'|'DISABLED'
            }
        },
        'modalityRouting': {
            'jpeg': 'IMAGE'|'DOCUMENT'|'AUDIO'|'VIDEO',
            'png': 'IMAGE'|'DOCUMENT'|'AUDIO'|'VIDEO',
            'mp4': 'IMAGE'|'DOCUMENT'|'AUDIO'|'VIDEO',
            'mov': 'IMAGE'|'DOCUMENT'|'AUDIO'|'VIDEO'
        }
    },
    encryptionConfiguration={
        'kmsKeyId': 'string',
        'kmsEncryptionContext': {
            'string': 'string'
        }
    }
)
type projectArn:

string

param projectArn:

[REQUIRED]

ARN generated at the server side when a DataAutomationProject is created

type projectStage:

string

param projectStage:

Stage of the Project

type projectDescription:

string

param projectDescription:

Description of the DataAutomationProject

type standardOutputConfiguration:

dict

param standardOutputConfiguration:

[REQUIRED]

Standard output configuration

  • document (dict) --

    Standard Output Configuration of Document

    • extraction (dict) --

      Standard Extraction Configuration of Document

      • granularity (dict) -- [REQUIRED]

        Granularity of Document Extraction

        • types (list) --

          List of Document Extraction Granularity Type

          • (string) --

      • boundingBox (dict) -- [REQUIRED]

        Bounding Box Configuration of Document Extraction

        • state (string) -- [REQUIRED]

          State

    • generativeField (dict) --

      Standard Generative Field Configuration of Document

      • state (string) -- [REQUIRED]

        State

    • outputFormat (dict) --

      Output Format of Document

      • textFormat (dict) -- [REQUIRED]

        Text Format of Document Output

        • types (list) --

          List of Document Output Text Format Type

          • (string) --

      • additionalFileFormat (dict) -- [REQUIRED]

        Additional File Format of Document Output

        • state (string) -- [REQUIRED]

          State

  • image (dict) --

    Standard Output Configuration of Image

    • extraction (dict) --

      Standard Extraction Configuration of Image

      • category (dict) -- [REQUIRED]

        Category of Image Extraction

        • state (string) -- [REQUIRED]

          State

        • types (list) --

          List of Image Extraction Category

          • (string) --

      • boundingBox (dict) -- [REQUIRED]

        Bounding Box Configuration of Image Extraction

        • state (string) -- [REQUIRED]

          State

    • generativeField (dict) --

      Standard Generative Field Configuration of Image

      • state (string) -- [REQUIRED]

        State

      • types (list) --

        List of Image Standard Generative Field Type

        • (string) --

  • video (dict) --

    Standard Output Configuration of Video

    • extraction (dict) --

      Standard Extraction Configuration of Video

      • category (dict) -- [REQUIRED]

        Category of Video Extraction

        • state (string) -- [REQUIRED]

          State

        • types (list) --

          List of Video Extraction Category Type

          • (string) --

      • boundingBox (dict) -- [REQUIRED]

        Bounding Box Configuration of Video Extraction

        • state (string) -- [REQUIRED]

          State

    • generativeField (dict) --

      Standard Generative Field Configuration of Video

      • state (string) -- [REQUIRED]

        State

      • types (list) --

        List of Video Standard Generative Field Type

        • (string) --

  • audio (dict) --

    Standard Output Configuration of Audio

    • extraction (dict) --

      Standard Extraction Configuration of Audio

      • category (dict) -- [REQUIRED]

        Category of Audio Extraction

        • state (string) -- [REQUIRED]

          State

        • types (list) --

          List of Audio Extraction Category Type

          • (string) --

    • generativeField (dict) --

      Standard Generative Field Configuration of Audio

      • state (string) -- [REQUIRED]

        State

      • types (list) --

        List of Audio Standard Generative Field Type

        • (string) --

type customOutputConfiguration:

dict

param customOutputConfiguration:

Custom output configuration

  • blueprints (list) --

    List of Blueprint Item

    • (dict) --

      Blueprint Item

      • blueprintArn (string) -- [REQUIRED]

        ARN of a Blueprint

      • blueprintVersion (string) --

        Blueprint Version

      • blueprintStage (string) --

        Stage of the Blueprint

type overrideConfiguration:

dict

param overrideConfiguration:

Override configuration

  • document (dict) --

    Override Configuration of Document

    • splitter (dict) --

      Configuration of Splitter

      • state (string) --

        State

    • modalityProcessing (dict) --

      Configuration to enable/disable processing of modality

      • state (string) --

        State

  • image (dict) --

    Override Configuration of Image

    • modalityProcessing (dict) --

      Configuration to enable/disable processing of modality

      • state (string) --

        State

  • video (dict) --

    Override Configuration of Video

    • modalityProcessing (dict) --

      Configuration to enable/disable processing of modality

      • state (string) --

        State

  • audio (dict) --

    Override Configuration of Audio

    • modalityProcessing (dict) --

      Configuration to enable/disable processing of modality

      • state (string) --

        State

  • modalityRouting (dict) --

    Configuration for routing file type to desired modality

    • jpeg (string) --

      Desired Modality types

    • png (string) --

      Desired Modality types

    • mp4 (string) --

      Desired Modality types

    • mov (string) --

      Desired Modality types

type encryptionConfiguration:

dict

param encryptionConfiguration:

KMS Encryption Configuration

  • kmsKeyId (string) -- [REQUIRED]

    KMS Key Identifier

  • kmsEncryptionContext (dict) --

    KMS Encryption Context

    • (string) --

      Encryption context key.

      • (string) --

        Encryption context value.

rtype:

dict

returns:

Response Syntax

{
    'projectArn': 'string',
    'projectStage': 'DEVELOPMENT'|'LIVE',
    'status': 'COMPLETED'|'IN_PROGRESS'|'FAILED'
}

Response Structure

  • (dict) --

    Update DataAutomationProject Response

    • projectArn (string) --

      ARN of a DataAutomationProject

    • projectStage (string) --

      Stage of the Project

    • status (string) --

      Status of Data Automation Project