AWS API Changes

2024/12/04 - Data Automation for Amazon Bedrock - 11 new api methods

Changes Introduced two APIs ListPromptRouters and GetPromptRouter for Intelligent Prompt Router feature. Add support for Bedrock Guardrails image content filter. New Bedrock Marketplace feature enabling a wider range of bedrock compatible models with self-hosted capability.

GetBlueprint (new)

Link ¶

Gets an existing Amazon Bedrock Keystone Blueprint

See also: AWS API Documentation

Request Syntax

client.get_blueprint(
    blueprintArn='string',
    blueprintVersion='string',
    blueprintStage='DEVELOPMENT'|'LIVE'
)

type blueprintArn:

string

param blueprintArn:

[REQUIRED]

ARN generated at the server side when a Blueprint is created

type blueprintVersion:

string

param blueprintVersion:

Optional field to get a specific Blueprint version

type blueprintStage:

string

param blueprintStage:

Optional field to get a specific Blueprint stage

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

Get 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) --
      - (string) --

DeleteBlueprint (new)

Link ¶

Deletes an existing Amazon Bedrock Keystone Blueprint

See also: AWS API Documentation

Request Syntax

client.delete_blueprint(
    blueprintArn='string',
    blueprintVersion='string'
)

type blueprintArn:

string

param blueprintArn:

[REQUIRED]

ARN generated at the server side when a Blueprint is created

type blueprintVersion:

string

param blueprintVersion:

Optional field to delete a specific Blueprint version

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

Delete Blueprint Response

DeleteDataAutomationProject (new)

Link ¶

Deletes an existing Amazon Bedrock Keystone DataAutomationProject

See also: AWS API Documentation

Request Syntax

client.delete_data_automation_project(
    projectArn='string'
)

type projectArn:

string

param projectArn:

[REQUIRED]

ARN generated at the server side when a DataAutomationProject is created

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --

Delete DataAutomationProject Response
- projectArn (string) --
  
  ARN of a DataAutomationProject
- status (string) --
  
  Status of Data Automation Project

CreateBlueprint (new)

Link ¶

Creates an Amazon Bedrock Keystone 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'
        }
    }
)

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) --
  - (string) --

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) --
      - (string) --

CreateDataAutomationProject (new)

Link ¶

Creates an Amazon Bedrock Keystone DataAutomationProject

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

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) --
  - (string) --

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

UpdateBlueprint (new)

Link ¶

Updates an existing Amazon Bedrock Blueprint

See also: AWS API Documentation

Request Syntax

client.update_blueprint(
    blueprintArn='string',
    schema='string',
    blueprintStage='DEVELOPMENT'|'LIVE'
)

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

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) --
      - (string) --

ListDataAutomationProjects (new)

Link ¶

Lists all existing Amazon Bedrock Keystone DataAutomationProjects

See also: AWS API Documentation

Request Syntax

client.list_data_automation_projects(
    maxResults=123,
    nextToken='string',
    projectStageFilter='DEVELOPMENT'|'LIVE'|'ALL',
    blueprintFilter={
        'blueprintArn': 'string',
        'blueprintVersion': 'string',
        'blueprintStage': 'DEVELOPMENT'|'LIVE'
    },
    resourceOwner='SERVICE'|'ACCOUNT'
)

type maxResults:

integer

param maxResults:

Max Results

type nextToken:

string

param nextToken:

Pagination token

type projectStageFilter:

string

param projectStageFilter:

Project Stage filter

type blueprintFilter:

dict

param blueprintFilter:

Blueprint Filter

blueprintArn (string) -- [REQUIRED]

ARN of a Blueprint
blueprintVersion (string) --

Blueprint Version
blueprintStage (string) --

Stage of the Blueprint

type resourceOwner:

string

param resourceOwner:

Resource Owner

rtype:

dict

returns:

Response Syntax

{
    'projects': [
        {
            'projectArn': 'string',
            'projectStage': 'DEVELOPMENT'|'LIVE',
            'projectName': 'string',
            'creationTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --

List DataAutomationProject Response
- projects (list) --
  
  List of DataAutomationProjectSummary
  - (dict) --
    
    Summary of a DataAutomationProject
    - projectArn (string) --
      
      ARN of a DataAutomationProject
    - projectStage (string) --
      
      Stage of the Project
    - projectName (string) --
      
      Name of the DataAutomationProject
    - creationTime (datetime) --
      
      Time Stamp
- nextToken (string) --
  
  Pagination token

UpdateDataAutomationProject (new)

Link ¶

Updates an existing Amazon Bedrock DataAutomationProject

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

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

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

ListBlueprints (new)

Link ¶

Lists all existing Amazon Bedrock Keystone Blueprints

See also: AWS API Documentation

Request Syntax

client.list_blueprints(
    blueprintArn='string',
    resourceOwner='SERVICE'|'ACCOUNT',
    blueprintStageFilter='DEVELOPMENT'|'LIVE'|'ALL',
    maxResults=123,
    nextToken='string',
    projectFilter={
        'projectArn': 'string',
        'projectStage': 'DEVELOPMENT'|'LIVE'
    }
)

type blueprintArn:

string

param blueprintArn:

ARN of a Blueprint

type resourceOwner:

string

param resourceOwner:

Resource Owner

type blueprintStageFilter:

string

param blueprintStageFilter:

Blueprint Stage filter

type maxResults:

integer

param maxResults:

Max Results

type nextToken:

string

param nextToken:

Pagination token

type projectFilter:

dict

param projectFilter:

Data Automation Project Filter

projectArn (string) -- [REQUIRED]

ARN of a DataAutomationProject
projectStage (string) --

Stage of the Project

rtype:

dict

returns:

Response Syntax

{
    'blueprints': [
        {
            'blueprintArn': 'string',
            'blueprintVersion': 'string',
            'blueprintStage': 'DEVELOPMENT'|'LIVE',
            'blueprintName': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --

List Blueprint Response
- blueprints (list) --
  
  List of Blueprints
  - (dict) --
    
    Summary of a Blueprint
    - blueprintArn (string) --
      
      ARN of a Blueprint
    - blueprintVersion (string) --
      
      Blueprint Version
    - blueprintStage (string) --
      
      Stage of the Blueprint
    - blueprintName (string) --
      
      Name of the Blueprint
    - creationTime (datetime) --
      
      Time Stamp
    - lastModifiedTime (datetime) --
      
      Time Stamp
- nextToken (string) --
  
  Pagination token

GetDataAutomationProject (new)

Link ¶

Gets an existing Amazon Bedrock Keystone DataAutomationProject

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

CreateBlueprintVersion (new)

Link ¶

Creates a new version of an existing Amazon Bedrock Keystone Blueprint

See also: AWS API Documentation

Request Syntax

client.create_blueprint_version(
    blueprintArn='string',
    clientToken='string'
)

type blueprintArn:

string

param blueprintArn:

[REQUIRED]

ARN generated at the server side when a Blueprint is created

type clientToken:

string

param clientToken:

Client specified token used for idempotency checks

This field is autopopulated if not provided.

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 Version 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) --
      - (string) --