DataAutomationforBedrock / Client / create_data_automation_project

create_data_automation_project

DataAutomationforBedrock.Client.create_data_automation_project(**kwargs)

Creates an Amazon Bedrock Keystone DataAutomationProject

See also: AWS API Documentation

Request Syntax

response = 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',
                    ]
                },
                'boundingBox': {
                    'state': 'ENABLED'|'DISABLED'
                }
            },
            'generativeField': {
                'state': 'ENABLED'|'DISABLED',
                'types': [
                    'IMAGE_SUMMARY'|'IAB',
                ]
            }
        },
        'video': {
            'extraction': {
                'category': {
                    'state': 'ENABLED'|'DISABLED',
                    'types': [
                        'CONTENT_MODERATION'|'TEXT_DETECTION'|'TRANSCRIPT',
                    ]
                },
                'boundingBox': {
                    'state': 'ENABLED'|'DISABLED'
                }
            },
            'generativeField': {
                'state': 'ENABLED'|'DISABLED',
                'types': [
                    'VIDEO_SUMMARY'|'SCENE_SUMMARY'|'IAB',
                ]
            }
        },
        'audio': {
            'extraction': {
                'category': {
                    'state': 'ENABLED'|'DISABLED',
                    'types': [
                        'AUDIO_CONTENT_MODERATION'|'CHAPTER_CONTENT_MODERATION'|'TRANSCRIPT',
                    ]
                }
            },
            'generativeField': {
                'state': 'ENABLED'|'DISABLED',
                'types': [
                    'AUDIO_SUMMARY'|'CHAPTER_SUMMARY'|'IAB',
                ]
            }
        }
    },
    customOutputConfiguration={
        'blueprints': [
            {
                'blueprintArn': 'string',
                'blueprintVersion': 'string',
                'blueprintStage': 'DEVELOPMENT'|'LIVE'
            },
        ]
    },
    overrideConfiguration={
        'document': {
            'splitter': {
                'state': 'ENABLED'|'DISABLED'
            }
        }
    },
    clientToken='string',
    encryptionConfiguration={
        'kmsKeyId': 'string',
        'kmsEncryptionContext': {
            'string': 'string'
        }
    }
)

Parameters:

• projectName (string) –

  [REQUIRED]

  Name of the DataAutomationProject

• projectDescription (string) – Description of the DataAutomationProject

• projectStage (string) – Stage of the Project

• standardOutputConfiguration (dict) –

  [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) –

• customOutputConfiguration (dict) –

  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

• overrideConfiguration (dict) –

  Override configuration

  • document (dict) –

    Override Configuration of Document

    • splitter (dict) –

      Configuration of Splitter

      • state (string) –

        State

• clientToken (string) –

  Client specified token used for idempotency checks

  This field is autopopulated if not provided.

• encryptionConfiguration (dict) –

  KMS Encryption Configuration

  • kmsKeyId (string) – [REQUIRED]

    KMS Key Identifier

  • kmsEncryptionContext (dict) –

    KMS Encryption Context

    • (string) –

      • (string) –

Return type:

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

Exceptions

• DataAutomationforBedrock.Client.exceptions.ServiceQuotaExceededException

• DataAutomationforBedrock.Client.exceptions.ValidationException

• DataAutomationforBedrock.Client.exceptions.ConflictException

• DataAutomationforBedrock.Client.exceptions.InternalServerException

• DataAutomationforBedrock.Client.exceptions.ThrottlingException

• DataAutomationforBedrock.Client.exceptions.AccessDeniedException