[ aws . textract ]

update-project

Description

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

Synopsis

  update-project
--project-arn <value>
[--project-description <value>]
[--extraction-configuration <value>]
[--generative-configuration <value>]
[--custom-configuration <value>]
[--splitter-configuration <value>]
[--sensitive-data-configuration <value>]
[--encryption-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--project-arn (string) [required]

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

Constraints:

  • min: 1
  • max: 128
  • pattern: ^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):textract:[a-zA-Z0-9-]*:(aws|[0-9]{12}):project/[a-zA-Z0-9-]{12,36}$

--project-description (string)

The updated description of the project.

Constraints:

  • min: 0
  • max: 300
  • pattern: ^[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*$

--extraction-configuration (structure)

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 -> (structure) [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.

Possible values:

  • ENABLED
  • DISABLED

Granularity -> (structure) [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.

Constraints:

  • min: 1
  • max: 5

(string)

Possible values:

  • DOCUMENT
  • PAGE
  • ELEMENT
  • WORD
  • LINE

OutputFormat -> (structure) [required]

Controls the format of the extraction output.

AdditionalFileFormat -> (structure) [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.

Possible values:

  • ENABLED
  • DISABLED

TextFormat -> (structure) [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.

Constraints:

  • min: 1
  • max: 4

(string)

Possible values:

  • PLAIN_TEXT
  • MARKDOWN
  • HTML
  • CSV

JSON Syntax:

{
  "BoundingBox": {
    "State": "ENABLED"|"DISABLED"
  },
  "Granularity": {
    "Types": ["DOCUMENT"|"PAGE"|"ELEMENT"|"WORD"|"LINE", ...]
  },
  "OutputFormat": {
    "AdditionalFileFormat": {
      "State": "ENABLED"|"DISABLED"
    },
    "TextFormat": {
      "Types": ["PLAIN_TEXT"|"MARKDOWN"|"HTML"|"CSV", ...]
    }
  }
}

--generative-configuration (structure)

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

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.

Possible values:

  • ENABLED
  • DISABLED

FigureCaption -> (structure)

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.

Possible values:

  • ENABLED
  • DISABLED

Shorthand Syntax:

Summarization={State=string},FigureCaption={State=string}

JSON Syntax:

{
  "Summarization": {
    "State": "ENABLED"|"DISABLED"
  },
  "FigureCaption": {
    "State": "ENABLED"|"DISABLED"
  }
}

--custom-configuration (structure)

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.

Constraints:

  • min: 0
  • max: 1000

(structure)

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.

Constraints:

  • min: 1
  • max: 128
  • pattern: ^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):textract:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})$

BlueprintVersion -> (string)

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

Constraints:

  • min: 1
  • max: 128
  • pattern: ^[0-9]*$

FallbackBlueprints -> (list)

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

Constraints:

  • min: 0
  • max: 1

(structure)

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.

Constraints:

  • min: 1
  • max: 128
  • pattern: ^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):textract:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})$

BlueprintVersion -> (string)

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

Constraints:

  • min: 1
  • max: 128
  • pattern: ^[0-9]*$

Shorthand Syntax:

Blueprints=[{BlueprintArn=string,BlueprintVersion=string},{BlueprintArn=string,BlueprintVersion=string}],FallbackBlueprints=[{BlueprintArn=string,BlueprintVersion=string},{BlueprintArn=string,BlueprintVersion=string}]

JSON Syntax:

{
  "Blueprints": [
    {
      "BlueprintArn": "string",
      "BlueprintVersion": "string"
    }
    ...
  ],
  "FallbackBlueprints": [
    {
      "BlueprintArn": "string",
      "BlueprintVersion": "string"
    }
    ...
  ]
}

--splitter-configuration (structure)

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.

Possible values:

  • ENABLED
  • DISABLED

Shorthand Syntax:

State=string

JSON Syntax:

{
  "State": "ENABLED"|"DISABLED"
}

--sensitive-data-configuration (structure)

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.

Possible values:

  • DETECTION
  • DETECTION_AND_REDACTION
  • DISABLED

PiiEntitiesConfiguration -> (structure)

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.

Constraints:

  • min: 1
  • max: 32

(string)

Possible values:

  • 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 -> (string) [required]

How detected PII is masked in the redacted output.

Possible values:

  • PII
  • ENTITY_TYPE

Shorthand Syntax:

DetectionMode=string,PiiEntitiesConfiguration={PiiEntityTypes=[string,string],RedactionMaskMode=string}

JSON Syntax:

{
  "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"
  }
}

--encryption-configuration (structure)

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.

Constraints:

  • max: 2048
  • pattern: ^([A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2047})?$

KmsEncryptionContext -> (map)

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 ({} ).

Constraints:

  • max: 10

key -> (string)

Constraints:

  • min: 1
  • max: 2000
  • pattern: ^.*\S.*$

value -> (string)

Constraints:

  • min: 1
  • max: 2000
  • pattern: ^.*\S.*$

Shorthand Syntax:

KmsKeyId=string,KmsEncryptionContext={KeyName1=string,KeyName2=string}

JSON Syntax:

{
  "KmsKeyId": "string",
  "KmsEncryptionContext": {"string": "string"
    ...}
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

ProjectArn -> (string)

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

Constraints:

  • min: 1
  • max: 128
  • pattern: ^arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):textract:[a-zA-Z0-9-]*:(aws|[0-9]{12}):project/[a-zA-Z0-9-]{12,36}$

Status -> (string)

The status of the project after the update.

Possible values:

  • COMPLETED
  • FAILED