AWS API Changes

2025/02/28 - Data Automation for Amazon Bedrock - 3 new5 updated api methods

Changes Renamed and added new StandardConfiguration enums. Added support to update EncryptionConfiguration in UpdateBlueprint and UpdateDataAutomation APIs. Changed HttpStatus code for DeleteBlueprint and DeleteDataAutomationProject APIs to 200 from 204. Added APIs to support tagging.

ListTagsForResource (new)

Link ¶

List tags for an Amazon Bedrock Data Automation resource

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceARN='string'
)

type resourceARN:

string

param resourceARN:

[REQUIRED]

ARN of a taggable resource

rtype:

dict

returns:

Response Syntax

{
    'tags': [
        {
            'key': 'string',
            'value': 'string'
        },
    ]
}

Response Structure

(dict) --
- tags (list) --
  
  List of tags
  - (dict) --
    
    Key value pair of a tag
    - key (string) --
      
      Defines the context of the tag.
    - value (string) --
      
      Defines the value within the context. e.g. <key=reason, value=training>.

TagResource (new)

Link ¶

Tag an Amazon Bedrock Data Automation resource

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceARN='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type resourceARN:

string

param resourceARN:

[REQUIRED]

ARN of a taggable resource

type tags:

list

param tags:

[REQUIRED]

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

{}

Response Structure

(dict) --

UntagResource (new)

Link ¶

Untag an Amazon Bedrock Data Automation resource

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceARN='string',
    tagKeys=[
        'string',
    ]
)

type resourceARN:

string

param resourceARN:

[REQUIRED]

ARN of a taggable resource

type tagKeys:

list

param tagKeys:

[REQUIRED]

List of tag keys

(string) --

Defines the context of the tag.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

CreateBlueprint (updated)

Link ¶
Changes (request)

{'tags': [{'key': 'string', 'value': 'string'}]}

Creates an Amazon Bedrock Data Automation Blueprint

See also: AWS API Documentation

Request Syntax

client.create_blueprint(
    blueprintName='string',
    type='DOCUMENT'|'IMAGE',
    blueprintStage='DEVELOPMENT'|'LIVE',
    schema='string',
    clientToken='string',
    encryptionConfiguration={
        'kmsKeyId': 'string',
        'kmsEncryptionContext': {
            'string': 'string'
        }
    },
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)

type blueprintName:

string

param blueprintName:

[REQUIRED]

Name of the Blueprint

type type:

string

param type:

[REQUIRED]

Type

type blueprintStage:

string

param blueprintStage:

Stage of the Blueprint

type schema:

string

param schema:

[REQUIRED]

Schema of the blueprint

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

{
    'blueprint': {
        'blueprintArn': 'string',
        'schema': 'string',
        'type': 'DOCUMENT'|'IMAGE',
        'creationTime': datetime(2015, 1, 1),
        'lastModifiedTime': datetime(2015, 1, 1),
        'blueprintName': 'string',
        'blueprintVersion': 'string',
        'blueprintStage': 'DEVELOPMENT'|'LIVE',
        'kmsKeyId': 'string',
        'kmsEncryptionContext': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --

Create Blueprint Response
- blueprint (dict) --
  
  Contains the information of a Blueprint.
  - blueprintArn (string) --
    
    ARN of a Blueprint
  - schema (string) --
    
    Schema of the blueprint
  - type (string) --
    
    Type
  - creationTime (datetime) --
    
    Time Stamp
  - lastModifiedTime (datetime) --
    
    Time Stamp
  - blueprintName (string) --
    
    Name of the Blueprint
  - blueprintVersion (string) --
    
    Blueprint Version
  - blueprintStage (string) --
    
    Stage of the Blueprint
  - kmsKeyId (string) --
    
    KMS Key Identifier
  - kmsEncryptionContext (dict) --
    
    KMS Encryption Context
    - (string) --
      
      Encryption context key.
      - (string) --
        
        Encryption context value.

CreateDataAutomationProject (updated)

Link ¶
Changes (request)

{'standardOutputConfiguration': {'audio': {'extraction': {'category': {'types': {'TOPIC_CONTENT_MODERATION'}}},
                                           'generativeField': {'types': {'TOPIC_SUMMARY'}}},
                                 'image': {'extraction': {'category': {'types': {'LOGOS'}}}},
                                 'video': {'extraction': {'category': {'types': {'LOGOS'}}},
                                           'generativeField': {'types': {'CHAPTER_SUMMARY'}}}},
 'tags': [{'key': 'string', 'value': 'string'}]}

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

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': {'standardOutputConfiguration': {'audio': {'extraction': {'category': {'types': {'TOPIC_CONTENT_MODERATION'}}},
                                                       'generativeField': {'types': {'TOPIC_SUMMARY'}}},
                                             'image': {'extraction': {'category': {'types': {'LOGOS'}}}},
                                             'video': {'extraction': {'category': {'types': {'LOGOS'}}},
                                                       'generativeField': {'types': {'CHAPTER_SUMMARY'}}}}}}

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'
                }
            }
        },
        '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) --
      
      Encryption context key.
      - (string) --
        
        Encryption context value.

UpdateBlueprint (updated)

Link ¶
Changes (request)

{'encryptionConfiguration': {'kmsEncryptionContext': {'string': 'string'},
                             'kmsKeyId': 'string'}}

Updates an existing Amazon Bedrock Data Automation Blueprint

See also: AWS API Documentation

Request Syntax

client.update_blueprint(
    blueprintArn='string',
    schema='string',
    blueprintStage='DEVELOPMENT'|'LIVE',
    encryptionConfiguration={
        'kmsKeyId': 'string',
        'kmsEncryptionContext': {
            'string': 'string'
        }
    }
)

type blueprintArn:

string

param blueprintArn:

[REQUIRED]

ARN generated at the server side when a Blueprint is created

type schema:

string

param schema:

[REQUIRED]

Schema of the blueprint

type blueprintStage:

string

param blueprintStage:

Stage of the Blueprint

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

{
    'blueprint': {
        'blueprintArn': 'string',
        'schema': 'string',
        'type': 'DOCUMENT'|'IMAGE',
        'creationTime': datetime(2015, 1, 1),
        'lastModifiedTime': datetime(2015, 1, 1),
        'blueprintName': 'string',
        'blueprintVersion': 'string',
        'blueprintStage': 'DEVELOPMENT'|'LIVE',
        'kmsKeyId': 'string',
        'kmsEncryptionContext': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --

Update Blueprint Response
- blueprint (dict) --
  
  Contains the information of a Blueprint.
  - blueprintArn (string) --
    
    ARN of a Blueprint
  - schema (string) --
    
    Schema of the blueprint
  - type (string) --
    
    Type
  - creationTime (datetime) --
    
    Time Stamp
  - lastModifiedTime (datetime) --
    
    Time Stamp
  - blueprintName (string) --
    
    Name of the Blueprint
  - blueprintVersion (string) --
    
    Blueprint Version
  - blueprintStage (string) --
    
    Stage of the Blueprint
  - kmsKeyId (string) --
    
    KMS Key Identifier
  - kmsEncryptionContext (dict) --
    
    KMS Encryption Context
    - (string) --
      
      Encryption context key.
      - (string) --
        
        Encryption context value.

UpdateDataAutomationProject (updated)

Link ¶
Changes (request)

{'encryptionConfiguration': {'kmsEncryptionContext': {'string': 'string'},
                             'kmsKeyId': 'string'},
 'standardOutputConfiguration': {'audio': {'extraction': {'category': {'types': {'TOPIC_CONTENT_MODERATION'}}},
                                           'generativeField': {'types': {'TOPIC_SUMMARY'}}},
                                 'image': {'extraction': {'category': {'types': {'LOGOS'}}}},
                                 'video': {'extraction': {'category': {'types': {'LOGOS'}}},
                                           'generativeField': {'types': {'CHAPTER_SUMMARY'}}}}}

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

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