Operations Actions Resource types Condition keys

Actions, resources, and condition keys for Amazon Textract

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

References:

Learn how to configure this service.
View a list of the API operations available for this service.
Learn how to secure this service and its resources by using IAM permission policies.
View the programmatic service authorization reference for this service.

Topics

API operations defined by Amazon Textract
Actions defined by Amazon Textract
Resource types defined by Amazon Textract
Condition keys for Amazon Textract

API operations defined by Amazon Textract

The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.

Operation	IAM action	Condition key	Possible value(s)	Access level
AnalyzeDocument	textract:AnalyzeDocument			Read
AnalyzeExpense	textract:AnalyzeExpense			Read
AnalyzeID	textract:AnalyzeID			Read
CreateAdapter	textract:CreateAdapter			Write
CreateAdapter	textract:TagResource			Tagging, Write
CreateAdapterVersion	textract:CreateAdapterVersion			Write
CreateAdapterVersion	textract:TagResource			Tagging, Write
DeleteAdapter	textract:DeleteAdapter			Write
DeleteAdapterVersion	textract:DeleteAdapterVersion			Write
DetectDocumentText	textract:DetectDocumentText			Read
GetAdapter	textract:GetAdapter			Read
GetAdapterVersion	textract:GetAdapterVersion			Read
GetDocumentAnalysis	textract:GetDocumentAnalysis			Read
GetDocumentTextDetection	textract:GetDocumentTextDetection			Read
GetExpenseAnalysis	textract:GetExpenseAnalysis			Read
GetLendingAnalysis	textract:GetLendingAnalysis			Read
GetLendingAnalysisSummary	textract:GetLendingAnalysisSummary			Read
ListAdapterVersions	textract:ListAdapterVersions			Read
ListAdapters	textract:ListAdapters			Read
ListTagsForResource	textract:ListTagsForResource			Read
StartDocumentAnalysis	textract:StartDocumentAnalysis			Write
StartDocumentAnalysis	iam:PassRole	iam:PassedToService	textract.amazonaws.com	Write
StartDocumentTextDetection	textract:StartDocumentTextDetection			Write
StartDocumentTextDetection	iam:PassRole	iam:PassedToService	textract.amazonaws.com	Write
StartExpenseAnalysis	textract:StartExpenseAnalysis			Write
StartExpenseAnalysis	iam:PassRole	iam:PassedToService	textract.amazonaws.com	Write
StartLendingAnalysis	textract:StartLendingAnalysis			Write
StartLendingAnalysis	iam:PassRole	iam:PassedToService	textract.amazonaws.com	Write
TagResource	textract:TagResource			Tagging, Write
UntagResource	textract:UntagResource			Tagging, Write
UpdateAdapter	textract:UpdateAdapter			Write

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.

Actions	Description	Resource types (*required)	Condition keys	Access level
AnalyzeDocument	Grants permission to detect instances of real-world document entities within an image provided as input			Read
AnalyzeExpense	Grants permission to detect instances of real-world document entities within an image provided as input			Read
AnalyzeID	Grants permission to detect relevant information from identity documents provided as input			Read
CreateAdapter	Grants permission to create an Amazon Textract adapter		aws:RequestTag/${TagKey} aws:TagKeys	Write
CreateAdapterVersion	Grants permission to create an Amazon Textract adapter version	adapter*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
DeleteAdapter	Grants permission to delete an Amazon Textract adapter	adapter*	aws:ResourceTag/${TagKey}	Write
DeleteAdapterVersion	Grants permission to delete an Amazon Textract adapter version	adapterversion*	aws:ResourceTag/${TagKey}	Write
DetectDocumentText	Grants permission to detect text in document images			Read
GetAdapter	Grants permission to get an Amazon Textract adapter	adapter*	aws:ResourceTag/${TagKey}	Read
GetAdapterVersion	Grants permission to get an Amazon Textract adapter version	adapterversion*	aws:ResourceTag/${TagKey}	Read
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	adapter	aws:ResourceTag/${TagKey}	Read
ListTagsForResource		adapterversion	aws:ResourceTag/${TagKey}	Read
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
StartDocumentTextDetection	Grants permission to start an asynchronous job to detect text in document images or pdfs			Write
StartExpenseAnalysis	Grants permission to start an asynchronous job to detect instances of invoices or receipts within an image or pdf provided as input			Write
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
TagResource	Grants permission to add one or more tags to a resource	adapter	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
TagResource	Grants permission to add one or more tags to a resource	adapterversion	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
UntagResource	Grants permission to remove one or more tags from a resource	adapter	aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
UntagResource		adapterversion	aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
UpdateAdapter	Grants permission to update Amazon Textract adapter	adapter*	aws:ResourceTag/${TagKey}	Write

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.

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.

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

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

Amazon SQS (sqs)

Amazon Timestream (timestream)