Actions, resources, and condition keys for Amazon Textract - Service Authorization Reference
ActionsResource typesCondition keys

Actions, resources, and condition keys for Amazon Textract

Amazon Textract (service prefix: textract) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions defined by Amazon Textract

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions Description Access level Resource types (*required) Condition keys Dependent actions
AnalyzeDocument Grants permission to detect instances of real-world document entities within an image provided as input Read

s3:GetObject

AnalyzeExpense Grants permission to detect instances of real-world document entities within an image provided as input Read

s3:GetObject

AnalyzeID Grants permission to detect relevant information from identity documents provided as input Read

s3:GetObject

CreateAdapter Grants permission to create an Amazon Textract adapter Write

aws:RequestTag/${TagKey}

aws:TagKeys

CreateAdapterVersion Grants permission to create an Amazon Textract adapter version Write

adapter*

aws:RequestTag/${TagKey}

aws:TagKeys

DeleteAdapter Grants permission to delete an Amazon Textract adapter Write

adapter*

DeleteAdapterVersion Grants permission to delete an Amazon Textract adapter version Write

adapterversion*

DetectDocumentText Grants permission to detect text in document images Read

s3:GetObject

GetAdapter Grants permission to get an Amazon Textract adapter Read

adapter*

GetAdapterVersion Grants permission to get an Amazon Textract adapter version Read

adapterversion*

GetDocumentAnalysis Grants permission to return information about a document analysis job Read
GetDocumentTextDetection Grants permission to return information about a document text detection job Read
GetExpenseAnalysis Grants permission to return information about an expense analysis job Read
GetLendingAnalysis Grants permission to retrieve page-level information regarding a lending analysis job Read
GetLendingAnalysisSummary Grants permission to retrieve summarized information regarding a lending analysis job Read
ListAdapterVersions Grants permission to list Amazon Textract adapter versions Read
ListAdapters Grants permission to list Amazon Textract adapters Read
ListTagsForResource Grants permission to return a list of tags associated with a resource Read

adapter

adapterversion

StartDocumentAnalysis Grants permission to start an asynchronous job to detect instances of real-world document entities within an image or pdf provided as input Write

s3:GetObject

StartDocumentTextDetection Grants permission to start an asynchronous job to detect text in document images or pdfs Write

s3:GetObject

StartExpenseAnalysis Grants permission to start an asynchronous job to detect instances of invoices or receipts within an image or pdf provided as input Write

s3:GetObject

StartLendingAnalysis Grants permission to start an asynchronous job for detection of entities in a lending document, takes a provided image or PDF as input Write

s3:GetObject

TagResource Grants permission to add one or more tags to a resource Tagging

adapter

adapterversion

aws:TagKeys

aws:RequestTag/${TagKey}

UntagResource Grants permission to remove one or more tags from a resource Tagging

adapter

adapterversion

aws:TagKeys

UpdateAdapter Grants permission to update Amazon Textract adapter Write

adapter*

Resource types defined by Amazon Textract

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.

Resource types ARN Condition keys
adapter arn:${Partition}:textract:${Region}:${Account}:/adapters/${AdapterId}

aws:ResourceTag/${TagKey}

adapterversion arn:${Partition}:textract:${Region}:${Account}:/adapters/${AdapterId}/versions/${AdapterVersion}

aws:ResourceTag/${TagKey}

Condition keys for Amazon Textract

Amazon Textract defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys Description Type
aws:RequestTag/${TagKey} Filters access by tags that are passed in the request String
aws:ResourceTag/${TagKey} Filters access by tags associated with the resource String
aws:TagKeys Filters access by tag keys that are passed in the request ArrayOfString