# Start Document Analysis

> The **Start Document Analysis** activity uses the Amazon Textract [StartDocumentAnalysis](https://docs.aws.amazon.com/textract/latest/dg/API_StartDocumentAnalysis.html) API to asynchronously start the analysis of a document (**DocumentName** and **Version**) stored in an Amazon S3 bucket (**Bucket**).

The **Start Document Analysis** activity uses the Amazon Textract [StartDocumentAnalysis](https://docs.aws.amazon.com/textract/latest/dg/API_StartDocumentAnalysis.html) API to asynchronously start the analysis of a document (**DocumentName** and **Version**) stored in an Amazon S3 bucket (**Bucket**).

After starting the document analysis, the activity returns the identifier assigned to the document analysis process as a `String` (**JobId**) that you can use as an input variable in the [Get Document Analysis Status](https://docs.uipath.com/activities/other/latest/legacy-integrations/amazon-textract-get-document-analysis-status#get-document-analysis-status) and [Get Document Analysis](https://docs.uipath.com/activities/other/latest/legacy-integrations/amazon-textract-get-document-analysis#get-document-analysis) activities.

## How It Works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

1. Complete the [Setup](https://docs.uipath.com/activities/other/latest/legacy-integrations/amazon-textract-setup#setup) steps.
2. Add the [Amazon Scope](https://docs.uipath.com/activities/other/latest/legacy-integrations/amazon-scope#amazon-scope) activity to your project.
3. Add the **Start Document Analysis** inside the **Amazon Scope** activity.
4. Enter values for the [S3 Storage](https://docs.uipath.com/activities/other/latest/legacy-integrations/amazon-textract-analyze-single-page-document#s3-storage) input properties.
5. Create and enter a `String` variable for your [Output](https://docs.uipath.com/activities/other/latest/legacy-integrations/amazon-textract-analyze-single-page-document#output) property.
6. Run the activity.
   * Your input properties are sent to the [StartDocumentAnalysis](https://docs.aws.amazon.com/textract/latest/dg/API_StartDocumentAnalysis.html) API.
   * The API returns the `String` value to your output property variable.

     ![docs image](https://dev-assets.cms.uipath.com/assets/images/activities/legacy-integrations-docs-image-34491-24965559-eb9b5631.webp)

## Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

![docs image](https://dev-assets.cms.uipath.com/assets/images/activities/legacy-integrations-docs-image-36632-0fcd0a9c-b0c349be.webp)

### Common

#### DisplayName

The display name of the activity.

| Attributes | Details |
| --- | --- |
| **Type** | `String` |
| **Required** | Yes |
| **Default value** | *Start Document Analysis* |
| **Allowed values** | Enter a `String` or `String` variable. |
| **Notes** | N/A |

### S3 Storage

#### Bucket

The name of the S3 bucket where the document is stored.

| Attributes | Details |
| --- | --- |
| **Type** | `String` |
| **Required** | Yes |
| **Default value** | Empty |
| **Allowed values** | Enter a `String` or `String` variable. |
| **Notes** | The AWS Region for the S3 bucket that contains the document must match the **Region** that you selected in the **Amazon Scope** activity.  For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket; for more information, see **step 6** in the [Create IAM User](https://docs.uipath.com/activities/other/latest/legacy-integrations/amazon-textract-setup#setup) section of the **Setup** guide. |

#### DocumentName

The case-sensitive name of the file in the specfied **Bucket** that you want to start analyzing.

| Attributes | Details |
| --- | --- |
| **Type** | `String` |
| **Required** | Yes |
| **Default value** | Empty |
| **Allowed values** | Enter a `String` or `String` variable. |
| **Notes** | Supported document formats: PNG, JPEG, and PDF. |

#### Version

If the bucket has versioning enabled, you can specify the object version.

| Attributes | Details |
| --- | --- |
| **Type** | `String` |
| **Required** | No |
| **Default value** | Empty |
| **Allowed values** | Enter a `String` or `String` variable. |
| **Notes** | N/A |

### Misc

#### Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

| Attributes | Details |
| --- | --- |
| **Type** | Checkbox |
| **Required** | No |
| **Default value** | Not Selected |
| **Allowed values** | Selected or Not Selected |
| **Notes** | N/A |

### Output

#### JobId

The identifier assigned to the document analysis process.

| Attributes | Details |
| --- | --- |
| **Type** | `String` |
| **Required** | No (recommended if you plan to use the output data in subsequent activities) |
| **Default value** | Empty |
| **Allowed values** | Enter a `String` variable |
| **Notes** | The variable you create for this property can be used as an input variable in the [Get Document Analysis Status](https://docs.uipath.com/activities/other/latest/legacy-integrations/amazon-textract-get-document-analysis-status#get-document-analysis-status) and activities.  A **JobId** value is only valid for 7 days. |

### Options

#### AnalysisType

Specifies the types of analysis to perform. Use Tables to return information about the tables that are detected in the input document and Forms to return detected form data.

| Attributes | Details |
| --- | --- |
| **Type** | enum |
| **Required** | No. |
| **Default value** | All |
| **Allowed values** | All, Tables, Forms |
| **Notes** | N/A |

## Example

The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the guides.

![docs image](https://dev-assets.cms.uipath.com/assets/images/activities/legacy-integrations-docs-image-24079-c62a86b6-2e1070df.webp)

![docs image](https://dev-assets.cms.uipath.com/assets/images/activities/legacy-integrations-docs-image-23735-b2f101f2-1d58269a.webp)
