Amazon Textract

2026/11/20 - Amazon Textract - 13 new api methods

Changes  Amazon Textract Insights uses generative AI to split, classify, and extract data from documents with one asynchronous API. Get text, layout, and tables as Markdown, HTML, or CSV, plus summaries and figure captions, and extract the fields you define in a blueprint with confidence scores and locations

GetProject (new) Link ¶

Gets the details of a project, including its configuration, status, and timestamps.

See also: AWS API Documentation

Request Syntax

client.get_project(
    ProjectArn='string'
)
type ProjectArn:

string

param ProjectArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the project to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'ProjectArn': 'string',
    'ProjectName': 'string',
    'ProjectDescription': 'string',
    'Status': 'COMPLETED'|'FAILED',
    'ExtractionConfiguration': {
        'BoundingBox': {
            'State': 'ENABLED'|'DISABLED'
        },
        'Granularity': {
            'Types': [
                'DOCUMENT'|'PAGE'|'ELEMENT'|'WORD'|'LINE',
            ]
        },
        'OutputFormat': {
            'AdditionalFileFormat': {
                'State': 'ENABLED'|'DISABLED'
            },
            'TextFormat': {
                'Types': [
                    'PLAIN_TEXT'|'MARKDOWN'|'HTML'|'CSV',
                ]
            }
        }
    },
    'GenerativeConfiguration': {
        'Summarization': {
            'State': 'ENABLED'|'DISABLED'
        },
        'FigureCaption': {
            'State': 'ENABLED'|'DISABLED'
        }
    },
    'CustomConfiguration': {
        'Blueprints': [
            {
                'BlueprintArn': 'string',
                'BlueprintVersion': 'string'
            },
        ],
        'FallbackBlueprints': [
            {
                'BlueprintArn': 'string',
                'BlueprintVersion': 'string'
            },
        ]
    },
    'SplitterConfiguration': {
        'State': 'ENABLED'|'DISABLED'
    },
    'SensitiveDataConfiguration': {
        'DetectionMode': 'DETECTION'|'DETECTION_AND_REDACTION'|'DISABLED',
        'PiiEntitiesConfiguration': {
            'PiiEntityTypes': [
                'ALL'|'ADDRESS'|'AGE'|'NAME'|'EMAIL'|'PHONE'|'USERNAME'|'PASSWORD'|'DRIVER_ID'|'LICENSE_PLATE'|'VEHICLE_IDENTIFICATION_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'PIN'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'SWIFT_CODE'|'IP_ADDRESS'|'MAC_ADDRESS'|'URL'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER',
            ],
            'RedactionMaskMode': 'PII'|'ENTITY_TYPE'
        }
    },
    'EncryptionConfiguration': {
        'KmsKeyId': 'string',
        'KmsEncryptionContext': {
            'string': 'string'
        }
    },
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • ProjectArn (string) --

      The Amazon Resource Name (ARN) of the project.

    • ProjectName (string) --

      The name of the project.

    • ProjectDescription (string) --

      The description of the project.

    • Status (string) --

      The status of the project, indicating whether it was created successfully or failed.

    • ExtractionConfiguration (dict) --

      The configuration that controls how Amazon Textract extracts content from the document, including bounding boxes, granularity, and output format.

      • BoundingBox (dict) --

        Controls whether bounding box geometry is included in the extraction output.

        • State (string) --

          Set to ENABLED to return bounding box geometry, or DISABLED to omit it.

      • Granularity (dict) --

        Controls the granularity levels at which content is extracted.

        • Types (list) --

          The granularity levels at which Amazon Textract extracts content, from the whole document down to individual lines of text. Each type can appear only once.

          • (string) --

      • OutputFormat (dict) --

        Controls the format of the extraction output.

        • AdditionalFileFormat (dict) --

          Controls whether an additional file format is produced alongside the primary output.

          • State (string) --

            Set to ENABLED to produce an additional file format, or DISABLED to omit it.

        • TextFormat (dict) --

          Controls the text formats produced in the extraction output.

          • Types (list) --

            The text formats produced in the extraction output. Each type can appear only once, and CSV can't be the only type.

            • (string) --

    • GenerativeConfiguration (dict) --

      The configuration that controls generative capabilities such as summarization and figure captioning.

      • Summarization (dict) --

        Controls whether a generative summary of the document is produced. If you omit it, no summary is produced.

        • State (string) --

          Set to ENABLED to produce a summary, or DISABLED to omit it.

      • FigureCaption (dict) --

        Controls whether generative captions are produced for figures detected in the document. If you omit it, no figure captions are produced.

        • State (string) --

          Set to ENABLED to produce figure captions, or DISABLED to omit them.

    • CustomConfiguration (dict) --

      The configuration that associates blueprints with the project for custom output extraction.

      • Blueprints (list) --

        The blueprints used to extract custom structured output.

        • (dict) --

          Associates a blueprint, and optionally a specific blueprint version, with a project for custom output extraction.

          • BlueprintArn (string) --

            The Amazon Resource Name (ARN) of the blueprint.

          • BlueprintVersion (string) --

            The version of the blueprint. If omitted, the latest version is used.

      • FallbackBlueprints (list) --

        The blueprint used when a document does not match any of the primary blueprints. Requires at least one blueprint in Blueprints.

        • (dict) --

          Associates a blueprint, and optionally a specific blueprint version, with a project for custom output extraction.

          • BlueprintArn (string) --

            The Amazon Resource Name (ARN) of the blueprint.

          • BlueprintVersion (string) --

            The version of the blueprint. If omitted, the latest version is used.

    • SplitterConfiguration (dict) --

      The configuration that controls whether multi-document packets are split into individual documents.

      • State (string) --

        Set to ENABLED to split multi-document packets, or DISABLED to treat the input as a single document.

    • SensitiveDataConfiguration (dict) --

      The configuration that controls detection and redaction of sensitive data, such as personally identifiable information (PII).

      • DetectionMode (string) --

        The detection mode. Valid values:

        • DETECTION - Only detects sensitive data.

        • DETECTION_AND_REDACTION - Detects and redacts sensitive data in the output.

        • DISABLED - Does not detect sensitive data.

      • PiiEntitiesConfiguration (dict) --

        The configuration that specifies which PII entity types to detect and how to mask them. If you omit it, Amazon Textract detects all PII entity types ( ALL) and masks them with ENTITY_TYPE.

        • PiiEntityTypes (list) --

          The list of PII entity types to detect. Each type can appear only once.

          • (string) --

        • RedactionMaskMode (string) --

          How detected PII is masked in the redacted output.

    • EncryptionConfiguration (dict) --

      The AWS KMS encryption configuration used to encrypt the project at rest.

      • KmsKeyId (string) --

        The identifier of the AWS KMS key to use for encryption. This can be a key ID, key ARN, alias name, or alias ARN.

      • KmsEncryptionContext (dict) --

        A set of key-value pairs that Amazon Textract includes as the AWS KMS encryption context when encrypting and decrypting the resource.

        On UpdateProject and UpdateBlueprint, this member is the one exception to replacing a supplied configuration whole. If you omit it, the stored encryption context is kept. To clear a custom encryption context, specify an empty map ( {}).

        • (string) --

          • (string) --

    • CreationTime (datetime) --

      The date and time that the project was created.

    • LastModifiedTime (datetime) --

      The date and time that the project was last modified.

GetBlueprint (new) Link ¶

Gets the details of a blueprint, including its schema, encryption settings, and timestamps.

See also: AWS API Documentation

Request Syntax

client.get_blueprint(
    BlueprintArn='string',
    BlueprintVersion='string'
)
type BlueprintArn:

string

param BlueprintArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the blueprint to retrieve.

type BlueprintVersion:

string

param BlueprintVersion:

The version of the blueprint to retrieve. If omitted, the latest version is returned.

rtype:

dict

returns:

Response Syntax

{
    'BlueprintArn': 'string',
    'BlueprintName': 'string',
    'BlueprintVersion': 'string',
    'Schema': 'string',
    'KmsKeyId': 'string',
    'KmsEncryptionContext': {
        'string': 'string'
    },
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • BlueprintArn (string) --

      The Amazon Resource Name (ARN) of the blueprint.

    • BlueprintName (string) --

      The name of the blueprint.

    • BlueprintVersion (string) --

      The version of the blueprint.

    • Schema (string) --

      The schema of the blueprint, which defines the fields to extract and their expected structure.

    • KmsKeyId (string) --

      The identifier of the AWS KMS key used to encrypt the blueprint.

    • KmsEncryptionContext (dict) --

      The AWS KMS encryption context used when encrypting the blueprint.

      • (string) --

        • (string) --

    • CreationTime (datetime) --

      The date and time that the blueprint was created.

    • LastModifiedTime (datetime) --

      The date and time that the blueprint was last modified.

UpdateBlueprint (new) Link ¶

Updates an existing blueprint, replacing its schema and, optionally, its encryption configuration.

See also: AWS API Documentation

Request Syntax

client.update_blueprint(
    BlueprintArn='string',
    Schema='string',
    EncryptionConfiguration={
        'KmsKeyId': 'string',
        'KmsEncryptionContext': {
            'string': 'string'
        }
    }
)
type BlueprintArn:

string

param BlueprintArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the blueprint to update.

type Schema:

string

param Schema:

The updated schema of the blueprint, which defines the fields to extract and their expected structure.

type EncryptionConfiguration:

dict

param EncryptionConfiguration:

The AWS KMS encryption configuration used to encrypt the blueprint at rest.

  • KmsKeyId (string) -- [REQUIRED]

    The identifier of the AWS KMS key to use for encryption. This can be a key ID, key ARN, alias name, or alias ARN.

  • KmsEncryptionContext (dict) --

    A set of key-value pairs that Amazon Textract includes as the AWS KMS encryption context when encrypting and decrypting the resource.

    On UpdateProject and UpdateBlueprint, this member is the one exception to replacing a supplied configuration whole. If you omit it, the stored encryption context is kept. To clear a custom encryption context, specify an empty map ( {}).

    • (string) --

      • (string) --

rtype:

dict

returns:

Response Syntax

{
    'BlueprintArn': 'string'
}

Response Structure

  • (dict) --

    • BlueprintArn (string) --

      The Amazon Resource Name (ARN) of the blueprint that was updated.

StartDocumentInsights (new) Link ¶

Starts an asynchronous job that analyzes a document using the configuration defined by a project or a set of blueprints. Use GetDocumentInsights to retrieve the results of the job.

See also: AWS API Documentation

Request Syntax

client.start_document_insights(
    InputConfiguration={
        'S3Uri': 'string'
    },
    OutputConfiguration={
        'S3Uri': 'string'
    },
    ProjectArn='string',
    Blueprints=[
        {
            'BlueprintArn': 'string',
            'BlueprintVersion': 'string'
        },
    ],
    EncryptionConfiguration={
        'KmsKeyId': 'string',
        'KmsEncryptionContext': {
            'string': 'string'
        }
    },
    NotificationConfiguration={
        'EventBridgeConfiguration': {
            'State': 'ENABLED'|'DISABLED'
        }
    },
    Tags={
        'string': 'string'
    }
)
type InputConfiguration:

dict

param InputConfiguration:

[REQUIRED]

The Amazon S3 location of the input document to analyze.

  • S3Uri (string) -- [REQUIRED]

    The Amazon S3 URI of the input document.

type OutputConfiguration:

dict

param OutputConfiguration:

[REQUIRED]

The Amazon S3 location where the analysis results are written.

  • S3Uri (string) -- [REQUIRED]

    The Amazon S3 URI where the analysis results are written.

type ProjectArn:

string

param ProjectArn:

The Amazon Resource Name (ARN) of the project whose configuration is used to analyze the document.

type Blueprints:

list

param Blueprints:

The blueprints used to extract custom structured output from the document.

  • (dict) --

    Associates a blueprint, and optionally a specific blueprint version, with a project for custom output extraction.

    • BlueprintArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the blueprint.

    • BlueprintVersion (string) --

      The version of the blueprint. If omitted, the latest version is used.

type EncryptionConfiguration:

dict

param EncryptionConfiguration:

The AWS KMS encryption configuration used to encrypt the analysis output. If you don't specify a value, Amazon Textract encrypts the output using an AWS owned key.

  • KmsKeyId (string) -- [REQUIRED]

    The identifier of the AWS KMS key to use for encryption. This can be a key ID, key ARN, alias name, or alias ARN.

  • KmsEncryptionContext (dict) --

    A set of key-value pairs that Amazon Textract includes as the AWS KMS encryption context when encrypting and decrypting the resource.

    On UpdateProject and UpdateBlueprint, this member is the one exception to replacing a supplied configuration whole. If you omit it, the stored encryption context is kept. To clear a custom encryption context, specify an empty map ( {}).

    • (string) --

      • (string) --

type NotificationConfiguration:

dict

param NotificationConfiguration:

Notification settings for the job.

  • EventBridgeConfiguration (dict) -- [REQUIRED]

    Event bus settings.

    • State (string) -- [REQUIRED]

      Set to ENABLED to send events to an event bus, or DISABLED to not send them.

type Tags:

dict

param Tags:

A set of tags (key-value pairs) to assign to the document insights job.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'JobArn': 'string'
}

Response Structure

  • (dict) --

    • JobArn (string) --

      The Amazon Resource Name (ARN) of the document insights job that was started. Use it with GetDocumentInsights to retrieve the results.

CreateBlueprint (new) Link ¶

Creates a blueprint that defines the schema Amazon Textract uses to extract structured data from a document during a document insights job. A blueprint describes the fields to extract and how to normalize them.

See also: AWS API Documentation

Request Syntax

client.create_blueprint(
    ClientRequestToken='string',
    BlueprintName='string',
    Schema='string',
    EncryptionConfiguration={
        'KmsKeyId': 'string',
        'KmsEncryptionContext': {
            'string': 'string'
        }
    },
    Tags={
        'string': 'string'
    }
)
type ClientRequestToken:

string

param ClientRequestToken:

A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you use the same token for a request that matches a previous request, the service ignores the request, but does not return an error.

This field is autopopulated if not provided.

type BlueprintName:

string

param BlueprintName:

[REQUIRED]

A unique name for the blueprint.

type Schema:

string

param Schema:

[REQUIRED]

The schema of the blueprint, which defines the fields to extract and their expected structure.

type EncryptionConfiguration:

dict

param EncryptionConfiguration:

The AWS KMS encryption configuration used to encrypt the blueprint at rest.

  • KmsKeyId (string) -- [REQUIRED]

    The identifier of the AWS KMS key to use for encryption. This can be a key ID, key ARN, alias name, or alias ARN.

  • KmsEncryptionContext (dict) --

    A set of key-value pairs that Amazon Textract includes as the AWS KMS encryption context when encrypting and decrypting the resource.

    On UpdateProject and UpdateBlueprint, this member is the one exception to replacing a supplied configuration whole. If you omit it, the stored encryption context is kept. To clear a custom encryption context, specify an empty map ( {}).

    • (string) --

      • (string) --

type Tags:

dict

param Tags:

A set of tags (key-value pairs) to assign to the blueprint.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'BlueprintArn': 'string'
}

Response Structure

  • (dict) --

    • BlueprintArn (string) --

      The Amazon Resource Name (ARN) of the blueprint that was created.

ListProjects (new) Link ¶

Lists the projects that are available to the caller, with optional filtering by blueprint. The results are paginated. If the response includes a NextToken value, pass it in a subsequent call to retrieve the next page of results.

See also: AWS API Documentation

Request Syntax

client.list_projects(
    MaxResults=123,
    NextToken='string',
    BlueprintFilter={
        'BlueprintArn': 'string',
        'BlueprintVersion': 'string'
    }
)
type MaxResults:

integer

param MaxResults:

The maximum number of projects to return in each page of results. If you don't specify a value, the service selects a default page size. Use the NextToken value in the response to retrieve any remaining results.

type NextToken:

string

param NextToken:

A pagination token returned from a previous call to ListProjects. Use it to retrieve the next page of results.

type BlueprintFilter:

dict

param BlueprintFilter:

A filter that limits the results to projects associated with the specified blueprint.

  • BlueprintArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the blueprint to filter by.

  • BlueprintVersion (string) --

    The version of the blueprint to filter by.

rtype:

dict

returns:

Response Syntax

{
    'Projects': [
        {
            'ProjectArn': 'string',
            'ProjectName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Projects (list) --

      A list of project summaries that match the request.

      • (dict) --

        A summary of a project, returned in the results of ListProjects.

        • ProjectArn (string) --

          The Amazon Resource Name (ARN) of the project.

        • ProjectName (string) --

          The name of the project.

        • CreationTime (datetime) --

          The date and time that the project was created.

        • LastModifiedTime (datetime) --

          The date and time that the project was last modified.

    • NextToken (string) --

      A pagination token to use in a subsequent call to ListProjects to retrieve the next page of results. This value is null when there are no more results to return.

ListBlueprints (new) Link ¶

Lists the blueprints that are available to the caller, with optional filtering by project and resource owner. The results are paginated. If the response includes a NextToken value, pass it in a subsequent call to retrieve the next page of results.

See also: AWS API Documentation

Request Syntax

client.list_blueprints(
    MaxResults=123,
    NextToken='string',
    BlueprintArn='string',
    ProjectFilter={
        'ProjectArn': 'string'
    },
    ResourceOwner='ACCOUNT'|'SERVICE'
)
type MaxResults:

integer

param MaxResults:

The maximum number of blueprints to return in each page of results. If you don't specify a value, the service selects a default page size. Use the NextToken value in the response to retrieve any remaining results.

type NextToken:

string

param NextToken:

A pagination token returned from a previous call to ListBlueprints. Use it to retrieve the next page of results.

type BlueprintArn:

string

param BlueprintArn:

The Amazon Resource Name (ARN) of a blueprint to filter the results by.

type ProjectFilter:

dict

param ProjectFilter:

A filter that limits the results to blueprints associated with the specified project.

  • ProjectArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the project to filter by.

type ResourceOwner:

string

param ResourceOwner:

A filter that limits the results to blueprints owned by your account or to blueprints provided by Amazon Textract.

rtype:

dict

returns:

Response Syntax

{
    'Blueprints': [
        {
            'BlueprintArn': 'string',
            'BlueprintName': 'string',
            'BlueprintVersion': 'string',
            'ResourceOwner': 'ACCOUNT'|'SERVICE',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Blueprints (list) --

      A list of blueprint summaries that match the request.

      • (dict) --

        A summary of a blueprint, returned in the results of ListBlueprints.

        • BlueprintArn (string) --

          The Amazon Resource Name (ARN) of the blueprint.

        • BlueprintName (string) --

          The name of the blueprint.

        • BlueprintVersion (string) --

          The version of the blueprint.

        • ResourceOwner (string) --

          Whether the blueprint is owned by your account or provided by Amazon Textract.

        • CreationTime (datetime) --

          The date and time that the blueprint was created.

        • LastModifiedTime (datetime) --

          The date and time that the blueprint was last modified.

    • NextToken (string) --

      A pagination token to use in a subsequent call to ListBlueprints to retrieve the next page of results. This value is null when there are no more results to return.

DeleteBlueprint (new) Link ¶

Deletes a blueprint, or a specific version of a blueprint.

See also: AWS API Documentation

Request Syntax

client.delete_blueprint(
    BlueprintArn='string',
    BlueprintVersion='string'
)
type BlueprintArn:

string

param BlueprintArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the blueprint to delete.

type BlueprintVersion:

string

param BlueprintVersion:

The version of the blueprint to delete. If omitted, the entire blueprint and all of its versions are deleted.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

CreateBlueprintVersion (new) Link ¶

Creates a new, immutable version of an existing blueprint so that projects can pin to a specific version.

See also: AWS API Documentation

Request Syntax

client.create_blueprint_version(
    BlueprintArn='string',
    ClientRequestToken='string'
)
type BlueprintArn:

string

param BlueprintArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the blueprint to create a new version of.

type ClientRequestToken:

string

param ClientRequestToken:

A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you use the same token for a request that matches a previous request, the service ignores the request, but does not return an error.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'BlueprintArn': 'string',
    'BlueprintVersion': 'string'
}

Response Structure

  • (dict) --

    • BlueprintArn (string) --

      The Amazon Resource Name (ARN) of the blueprint.

    • BlueprintVersion (string) --

      The version of the blueprint that was created.

CreateProject (new) Link ¶

Creates a project that groups the configuration used to run document insights jobs.

See also: AWS API Documentation

Request Syntax

client.create_project(
    ClientRequestToken='string',
    ProjectName='string',
    ProjectDescription='string',
    ExtractionConfiguration={
        'BoundingBox': {
            'State': 'ENABLED'|'DISABLED'
        },
        'Granularity': {
            'Types': [
                'DOCUMENT'|'PAGE'|'ELEMENT'|'WORD'|'LINE',
            ]
        },
        'OutputFormat': {
            'AdditionalFileFormat': {
                'State': 'ENABLED'|'DISABLED'
            },
            'TextFormat': {
                'Types': [
                    'PLAIN_TEXT'|'MARKDOWN'|'HTML'|'CSV',
                ]
            }
        }
    },
    GenerativeConfiguration={
        'Summarization': {
            'State': 'ENABLED'|'DISABLED'
        },
        'FigureCaption': {
            'State': 'ENABLED'|'DISABLED'
        }
    },
    CustomConfiguration={
        'Blueprints': [
            {
                'BlueprintArn': 'string',
                'BlueprintVersion': 'string'
            },
        ],
        'FallbackBlueprints': [
            {
                'BlueprintArn': 'string',
                'BlueprintVersion': 'string'
            },
        ]
    },
    SplitterConfiguration={
        'State': 'ENABLED'|'DISABLED'
    },
    SensitiveDataConfiguration={
        'DetectionMode': 'DETECTION'|'DETECTION_AND_REDACTION'|'DISABLED',
        'PiiEntitiesConfiguration': {
            'PiiEntityTypes': [
                'ALL'|'ADDRESS'|'AGE'|'NAME'|'EMAIL'|'PHONE'|'USERNAME'|'PASSWORD'|'DRIVER_ID'|'LICENSE_PLATE'|'VEHICLE_IDENTIFICATION_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'PIN'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'SWIFT_CODE'|'IP_ADDRESS'|'MAC_ADDRESS'|'URL'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER',
            ],
            'RedactionMaskMode': 'PII'|'ENTITY_TYPE'
        }
    },
    EncryptionConfiguration={
        'KmsKeyId': 'string',
        'KmsEncryptionContext': {
            'string': 'string'
        }
    },
    Tags={
        'string': 'string'
    }
)
type ClientRequestToken:

string

param ClientRequestToken:

A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you use the same token for a request that matches a previous request, the service ignores the request, but does not return an error.

This field is autopopulated if not provided.

type ProjectName:

string

param ProjectName:

[REQUIRED]

A unique name for the project.

type ProjectDescription:

string

param ProjectDescription:

A description of the project.

type ExtractionConfiguration:

dict

param ExtractionConfiguration:

[REQUIRED]

The configuration that controls how Amazon Textract extracts content from the document, including bounding boxes, granularity, and output format.

  • BoundingBox (dict) -- [REQUIRED]

    Controls whether bounding box geometry is included in the extraction output.

    • State (string) -- [REQUIRED]

      Set to ENABLED to return bounding box geometry, or DISABLED to omit it.

  • Granularity (dict) -- [REQUIRED]

    Controls the granularity levels at which content is extracted.

    • Types (list) --

      The granularity levels at which Amazon Textract extracts content, from the whole document down to individual lines of text. Each type can appear only once.

      • (string) --

  • OutputFormat (dict) -- [REQUIRED]

    Controls the format of the extraction output.

    • AdditionalFileFormat (dict) -- [REQUIRED]

      Controls whether an additional file format is produced alongside the primary output.

      • State (string) -- [REQUIRED]

        Set to ENABLED to produce an additional file format, or DISABLED to omit it.

    • TextFormat (dict) -- [REQUIRED]

      Controls the text formats produced in the extraction output.

      • Types (list) --

        The text formats produced in the extraction output. Each type can appear only once, and CSV can't be the only type.

        • (string) --

type GenerativeConfiguration:

dict

param GenerativeConfiguration:

The configuration that controls generative capabilities such as summarization and figure captioning.

  • Summarization (dict) --

    Controls whether a generative summary of the document is produced. If you omit it, no summary is produced.

    • State (string) -- [REQUIRED]

      Set to ENABLED to produce a summary, or DISABLED to omit it.

  • FigureCaption (dict) --

    Controls whether generative captions are produced for figures detected in the document. If you omit it, no figure captions are produced.

    • State (string) -- [REQUIRED]

      Set to ENABLED to produce figure captions, or DISABLED to omit them.

type CustomConfiguration:

dict

param CustomConfiguration:

The configuration that associates blueprints with the project for custom output extraction.

  • Blueprints (list) -- [REQUIRED]

    The blueprints used to extract custom structured output.

    • (dict) --

      Associates a blueprint, and optionally a specific blueprint version, with a project for custom output extraction.

      • BlueprintArn (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) of the blueprint.

      • BlueprintVersion (string) --

        The version of the blueprint. If omitted, the latest version is used.

  • FallbackBlueprints (list) --

    The blueprint used when a document does not match any of the primary blueprints. Requires at least one blueprint in Blueprints.

    • (dict) --

      Associates a blueprint, and optionally a specific blueprint version, with a project for custom output extraction.

      • BlueprintArn (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) of the blueprint.

      • BlueprintVersion (string) --

        The version of the blueprint. If omitted, the latest version is used.

type SplitterConfiguration:

dict

param SplitterConfiguration:

The configuration that controls whether multi-document packets are split into individual documents.

  • State (string) -- [REQUIRED]

    Set to ENABLED to split multi-document packets, or DISABLED to treat the input as a single document.

type SensitiveDataConfiguration:

dict

param SensitiveDataConfiguration:

The configuration that controls detection and redaction of sensitive data, such as personally identifiable information (PII).

  • DetectionMode (string) -- [REQUIRED]

    The detection mode. Valid values:

    • DETECTION - Only detects sensitive data.

    • DETECTION_AND_REDACTION - Detects and redacts sensitive data in the output.

    • DISABLED - Does not detect sensitive data.

  • PiiEntitiesConfiguration (dict) --

    The configuration that specifies which PII entity types to detect and how to mask them. If you omit it, Amazon Textract detects all PII entity types ( ALL) and masks them with ENTITY_TYPE.

    • PiiEntityTypes (list) -- [REQUIRED]

      The list of PII entity types to detect. Each type can appear only once.

      • (string) --

    • RedactionMaskMode (string) -- [REQUIRED]

      How detected PII is masked in the redacted output.

type EncryptionConfiguration:

dict

param EncryptionConfiguration:

The AWS KMS encryption configuration used to encrypt the project at rest. If you don't specify a value, Amazon Textract encrypts the project using an AWS owned key.

  • KmsKeyId (string) -- [REQUIRED]

    The identifier of the AWS KMS key to use for encryption. This can be a key ID, key ARN, alias name, or alias ARN.

  • KmsEncryptionContext (dict) --

    A set of key-value pairs that Amazon Textract includes as the AWS KMS encryption context when encrypting and decrypting the resource.

    On UpdateProject and UpdateBlueprint, this member is the one exception to replacing a supplied configuration whole. If you omit it, the stored encryption context is kept. To clear a custom encryption context, specify an empty map ( {}).

    • (string) --

      • (string) --

type Tags:

dict

param Tags:

A set of tags (key-value pairs) to assign to the project.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'ProjectArn': 'string',
    'Status': 'COMPLETED'|'FAILED'
}

Response Structure

  • (dict) --

    • ProjectArn (string) --

      The Amazon Resource Name (ARN) of the project that was created.

    • Status (string) --

      The status of the project, indicating whether creation completed successfully or failed.

UpdateProject (new) Link ¶

Updates the configuration of an existing project. If you omit a configuration, UpdateProject leaves it unchanged. A configuration that you supply replaces the stored one, so include every setting that you want to keep.

See also: AWS API Documentation

Request Syntax

client.update_project(
    ProjectArn='string',
    ProjectDescription='string',
    ExtractionConfiguration={
        'BoundingBox': {
            'State': 'ENABLED'|'DISABLED'
        },
        'Granularity': {
            'Types': [
                'DOCUMENT'|'PAGE'|'ELEMENT'|'WORD'|'LINE',
            ]
        },
        'OutputFormat': {
            'AdditionalFileFormat': {
                'State': 'ENABLED'|'DISABLED'
            },
            'TextFormat': {
                'Types': [
                    'PLAIN_TEXT'|'MARKDOWN'|'HTML'|'CSV',
                ]
            }
        }
    },
    GenerativeConfiguration={
        'Summarization': {
            'State': 'ENABLED'|'DISABLED'
        },
        'FigureCaption': {
            'State': 'ENABLED'|'DISABLED'
        }
    },
    CustomConfiguration={
        'Blueprints': [
            {
                'BlueprintArn': 'string',
                'BlueprintVersion': 'string'
            },
        ],
        'FallbackBlueprints': [
            {
                'BlueprintArn': 'string',
                'BlueprintVersion': 'string'
            },
        ]
    },
    SplitterConfiguration={
        'State': 'ENABLED'|'DISABLED'
    },
    SensitiveDataConfiguration={
        'DetectionMode': 'DETECTION'|'DETECTION_AND_REDACTION'|'DISABLED',
        'PiiEntitiesConfiguration': {
            'PiiEntityTypes': [
                'ALL'|'ADDRESS'|'AGE'|'NAME'|'EMAIL'|'PHONE'|'USERNAME'|'PASSWORD'|'DRIVER_ID'|'LICENSE_PLATE'|'VEHICLE_IDENTIFICATION_NUMBER'|'CREDIT_DEBIT_CARD_CVV'|'CREDIT_DEBIT_CARD_EXPIRY'|'CREDIT_DEBIT_CARD_NUMBER'|'PIN'|'INTERNATIONAL_BANK_ACCOUNT_NUMBER'|'SWIFT_CODE'|'IP_ADDRESS'|'MAC_ADDRESS'|'URL'|'AWS_ACCESS_KEY'|'AWS_SECRET_KEY'|'US_BANK_ACCOUNT_NUMBER'|'US_BANK_ROUTING_NUMBER'|'US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER'|'US_PASSPORT_NUMBER'|'US_SOCIAL_SECURITY_NUMBER'|'CA_HEALTH_NUMBER'|'CA_SOCIAL_INSURANCE_NUMBER'|'UK_NATIONAL_HEALTH_SERVICE_NUMBER'|'UK_NATIONAL_INSURANCE_NUMBER'|'UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER',
            ],
            'RedactionMaskMode': 'PII'|'ENTITY_TYPE'
        }
    },
    EncryptionConfiguration={
        'KmsKeyId': 'string',
        'KmsEncryptionContext': {
            'string': 'string'
        }
    }
)
type ProjectArn:

string

param ProjectArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the project to update.

type ProjectDescription:

string

param ProjectDescription:

The updated description of the project.

type ExtractionConfiguration:

dict

param ExtractionConfiguration:

The configuration that controls how Amazon Textract extracts content from the document, including bounding boxes, granularity, and output format. Replaces the stored extraction configuration.

  • BoundingBox (dict) -- [REQUIRED]

    Controls whether bounding box geometry is included in the extraction output.

    • State (string) -- [REQUIRED]

      Set to ENABLED to return bounding box geometry, or DISABLED to omit it.

  • Granularity (dict) -- [REQUIRED]

    Controls the granularity levels at which content is extracted.

    • Types (list) --

      The granularity levels at which Amazon Textract extracts content, from the whole document down to individual lines of text. Each type can appear only once.

      • (string) --

  • OutputFormat (dict) -- [REQUIRED]

    Controls the format of the extraction output.

    • AdditionalFileFormat (dict) -- [REQUIRED]

      Controls whether an additional file format is produced alongside the primary output.

      • State (string) -- [REQUIRED]

        Set to ENABLED to produce an additional file format, or DISABLED to omit it.

    • TextFormat (dict) -- [REQUIRED]

      Controls the text formats produced in the extraction output.

      • Types (list) --

        The text formats produced in the extraction output. Each type can appear only once, and CSV can't be the only type.

        • (string) --

type GenerativeConfiguration:

dict

param GenerativeConfiguration:

The configuration that controls generative capabilities such as summarization and figure captioning. Replaces the stored generative configuration, so a capability that you omit is turned off.

  • Summarization (dict) --

    Controls whether a generative summary of the document is produced. If you omit it, no summary is produced.

    • State (string) -- [REQUIRED]

      Set to ENABLED to produce a summary, or DISABLED to omit it.

  • FigureCaption (dict) --

    Controls whether generative captions are produced for figures detected in the document. If you omit it, no figure captions are produced.

    • State (string) -- [REQUIRED]

      Set to ENABLED to produce figure captions, or DISABLED to omit them.

type CustomConfiguration:

dict

param CustomConfiguration:

The configuration that associates blueprints with the project for custom output extraction. Replaces the stored custom configuration. To disable custom configuration, specify an empty Blueprints list.

  • Blueprints (list) -- [REQUIRED]

    The blueprints used to extract custom structured output.

    • (dict) --

      Associates a blueprint, and optionally a specific blueprint version, with a project for custom output extraction.

      • BlueprintArn (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) of the blueprint.

      • BlueprintVersion (string) --

        The version of the blueprint. If omitted, the latest version is used.

  • FallbackBlueprints (list) --

    The blueprint used when a document does not match any of the primary blueprints. Requires at least one blueprint in Blueprints.

    • (dict) --

      Associates a blueprint, and optionally a specific blueprint version, with a project for custom output extraction.

      • BlueprintArn (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) of the blueprint.

      • BlueprintVersion (string) --

        The version of the blueprint. If omitted, the latest version is used.

type SplitterConfiguration:

dict

param SplitterConfiguration:

The configuration that controls whether multi-document packets are split into individual documents. Replaces the stored splitter configuration.

  • State (string) -- [REQUIRED]

    Set to ENABLED to split multi-document packets, or DISABLED to treat the input as a single document.

type SensitiveDataConfiguration:

dict

param SensitiveDataConfiguration:

The configuration that controls detection and redaction of sensitive data, such as personally identifiable information (PII). Replaces the stored sensitive data configuration. To turn off detection, set DetectionMode to DISABLED.

  • DetectionMode (string) -- [REQUIRED]

    The detection mode. Valid values:

    • DETECTION - Only detects sensitive data.

    • DETECTION_AND_REDACTION - Detects and redacts sensitive data in the output.

    • DISABLED - Does not detect sensitive data.

  • PiiEntitiesConfiguration (dict) --

    The configuration that specifies which PII entity types to detect and how to mask them. If you omit it, Amazon Textract detects all PII entity types ( ALL) and masks them with ENTITY_TYPE.

    • PiiEntityTypes (list) -- [REQUIRED]

      The list of PII entity types to detect. Each type can appear only once.

      • (string) --

    • RedactionMaskMode (string) -- [REQUIRED]

      How detected PII is masked in the redacted output.

type EncryptionConfiguration:

dict

param EncryptionConfiguration:

The AWS KMS encryption configuration used to encrypt the project at rest.

  • KmsKeyId (string) -- [REQUIRED]

    The identifier of the AWS KMS key to use for encryption. This can be a key ID, key ARN, alias name, or alias ARN.

  • KmsEncryptionContext (dict) --

    A set of key-value pairs that Amazon Textract includes as the AWS KMS encryption context when encrypting and decrypting the resource.

    On UpdateProject and UpdateBlueprint, this member is the one exception to replacing a supplied configuration whole. If you omit it, the stored encryption context is kept. To clear a custom encryption context, specify an empty map ( {}).

    • (string) --

      • (string) --

rtype:

dict

returns:

Response Syntax

{
    'ProjectArn': 'string',
    'Status': 'COMPLETED'|'FAILED'
}

Response Structure

  • (dict) --

    • ProjectArn (string) --

      The Amazon Resource Name (ARN) of the project that was updated.

    • Status (string) --

      The status of the project after the update.

GetDocumentInsights (new) Link ¶

Gets the status and results of a document insights job that was started by StartDocumentInsights.

See also: AWS API Documentation

Request Syntax

client.get_document_insights(
    JobArn='string'
)
type JobArn:

string

param JobArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the document insights job to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'PARTIAL_SUCCESS',
    'OutputConfiguration': {
        'S3Uri': 'string'
    },
    'ErrorType': 'string',
    'ErrorMessage': 'string'
}

Response Structure

  • (dict) --

    • Status (string) --

      The current status of the document insights job, indicating whether it is still running, has completed, or has failed. When the job has failed, inspect ErrorType and ErrorMessage for details.

    • OutputConfiguration (dict) --

      The Amazon S3 location where the analysis results are written.

      • S3Uri (string) --

        The Amazon S3 URI where the analysis results are written.

    • ErrorType (string) --

      The type of error that caused the job to fail. Present only when the job status is a failure state.

    • ErrorMessage (string) --

      A human-readable description of the error that caused the job to fail. Present only when the job status is a failure state.

DeleteProject (new) Link ¶

Deletes a project.

See also: AWS API Documentation

Request Syntax

client.delete_project(
    ProjectArn='string'
)
type ProjectArn:

string

param ProjectArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the project to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --