DataAutomationforBedrock / Client / get_data_automation_project

get_data_automation_project#

DataAutomationforBedrock.Client.get_data_automation_project(**kwargs)#

Gets an existing Amazon Bedrock Data Automation Project

See also: AWS API Documentation

Request Syntax

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

  • projectArn (string) –

    [REQUIRED]

    ARN generated at the server side when a DataAutomationProject is created

  • projectStage (string) – Optional field to delete a specific DataAutomationProject stage

Return type:

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',
                        ]
                    },
                    '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'
                }
            }
        },
        '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

      • status (string) –

        Status of Data Automation Project

      • kmsKeyId (string) –

        KMS Key Identifier

      • kmsEncryptionContext (dict) –

        KMS Encryption Context

        • (string) –

          • (string) –

Exceptions