Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
systems-manager-ug-888	systems-manager-ug.pdf	888	see Document conventions. April 21, 2021 New topic: Document conventions 3181 AWS Systems Manager User Guide Updated topic: About patching applications The topic About patching applications released by April 12, 2021 released by Microsoft on Microsoft on Windows Server Windows Server now clariﬁes that, in order for Patch Manager to be able to patch applications released by Microsoft on your Windows Server managed instances, the Windows update option Give me updates for other Microsoft products when I update Windows must be allowed on the instance. Automation runbook reference reorganization To help you ﬁnd the runbooks you need and navigate the April 12, 2021 reference more eﬃcient ly, we reorganized the content in the Automatio n runbook reference by the relevant AWS service. To view these changes, see Systems Manager Automation runbook reference. 3182 AWS Systems Manager User Guide Patch Manager: Generate .csv patch compliance reports Patch Manager now supports the ability to generate April 9, 2021 patch compliance reports for your instances and save the report in an S3 bucket of your choice, in .csv format. Then, using a tool like Amazon QuickSight, you can analyze the patch compliance report data. You can generate a patch compliance report for a single instance, or for all instances in your AWS account. You can generate a one-time report on demand, or set up a schedule for reports to be created automatic ally. You can also specify an Amazon Simple Notiﬁcat ion Service topic to provide notiﬁcations when a report is generated. For more informati on, see Generating CSV patch compliance reports. You can now delete Parameter Store parameter labels by using either the Systems Manager console or the AWS CLI. For more information, see Working with parameter labels. Delete Parameter Store parameter labels April 6, 2021 3183 AWS Systems Manager User Guide Schedule instance reboots when using Patch Now Patch Manager now supports scheduling a time for your April 1, 2021 instances to reboot after patches are installed using the Patch Now feature. This is in addition to existing options to reboot instances only if needed to complete a patch installation or to skip all rebooting after the patching operation. For information, see Patching instances on demand. Parameter Store public parameters can now be found using the AWS CLI or Systems Manager console. For more information, see Finding public parameters. April 1, 2021 New topic: Discover public parameters 3184 AWS Systems Manager User Guide Patch now updates: Store logs in S3 & and run lifecycle hooks March 31, 2021 When you run the Patch Manager Patch now operation, you can choose an S3 bucket in which to automatically store patching logs. In addition, you can choose to run Systems Manager Command documents (SSM documents ) as lifecycle hooks at three points during the operation : Before installation, After installation, and On exit. For more information, see Patching instances on demand. Systems Manager now reports changes to its AWS managed Beginning March 24, 2021, changes to managed policies March 24, 2021 policies are reported in the topic Systems Manager updates to AWS managed policies. The ﬁrst change listed is the addition of support for the Explorer tool to report OpsData and OpsItems from multiple accounts and Regions. 3185 AWS Systems Manager User Guide Explorer automatically allows all OpsData sources for When you create a resource data sync, if you choose one March 24, 2021 resource data syncs based on of the AWS Organizations accounts in AWS Organizat options, Systems Manager ions Systems Manager Automatio n provides a new system variable for your runbooks automatically allows all OpsData sources in the selected AWS Regions for all AWS accounts in your organization (or in the selected organization units). This means, for example, that even if you haven't allowed Explorer in an AWS Region, if you select an AWS Organizat ions option for your resource data sync, then Systems Manager automatically collects OpsData from that Region. For more information, see About multiple account and Region resource data syncs. With the new global:AW S_PARTITION system variable, you can specify the AWS partition a resource is located in when authoring your runbooks. For more information, see Automation system variables. March 18, 2021 3186 AWS Systems Manager User Guide Allow multiple levels of approval for Change Manager When you create a Change Manager change template, March 4, 2021 change requests you can now require that more than one level of approvers grant permissio n for a change request to run. For example, you might require technical reviewers to approve a change request created from a change template ﬁrst, and then require a second level of approvals from one or more managers. For more informati on, see Creating change templates. Patch Manager now supports Oracle Linux 8.x You can now use Patch Manager to patch Oracle March 1, 2021 Linux
systems-manager-ug-889	systems-manager-ug.pdf	889	Allow multiple levels of approval for Change Manager When you create a Change Manager change template, March 4, 2021 change requests you can now require that more than one level of approvers grant permissio n for a change request to run. For example, you might require technical reviewers to approve a change request created from a change template ﬁrst, and then require a second level of approvals from one or more managers. For more informati on, see Creating change templates. Patch Manager now supports Oracle Linux 8.x You can now use Patch Manager to patch Oracle March 1, 2021 Linux 8.x instances, through version 8.3. For more information, see the following topics: • How security patches are selected • How patches are installed • How patch baseline rules work on Oracle Linux 3187 AWS Systems Manager User Guide OpsCenter displays other OpsItems for a selected resource March 1, 2021 To help you investigate issues and provide context for a problem, you can view a list of OpsItems for a speciﬁc AWS resource. The list displays the status, severity, and title of each OpsItem. The list also includes deep links to each OpsItem. For more information, see Viewing other OpsItems for a speciﬁc resource. Deﬁne patching preferences at runtime You can now deﬁne patching preferences at runtime using February 25, 2021 the baseline override feature. For information more, see Using the BaselineOverride parameter. New Systems Manager document type AWS CloudFormation templates can now be February 9, 2021 stored as Systems Manager documents. Storing CloudFormation templates as Systems Manager documents allows you to beneﬁt from Systems Manager document features like versioning, comparing version content, and sharing with accounts. For more information, see AWS Systems Manager documents. 3188 AWS Systems Manager Patch instances using optional hooks The new SSM document February 2, 2021 User Guide AWS-RunPatchBaseli neWithHooks provides hooks you can use to run SSM documents at three points during the instance patching cycle. For information about AWS-RunPatchBaseli neWithHooks , see About the AWS-RunPatchBaseli neWithHooks SSM document. For a sample walkthrough of a patching operation that uses all three hooks, see Walkthrou gh: Update application dependencies, patch an instance, and perform an application-specific health check. 3189 AWS Systems Manager User Guide New topic: Validating on- premises servers and virtual SSM Agent veriﬁes the identify of on-premises machines using a hardware servers and virtual machines January 25, 2021 ﬁngerprint New topic: SSM Agent technical reference and VMs that you register with the service by using a computed ﬁngerprint. The ﬁngerprint is an opaque string, stored in the Vault that the agent passes to certain Systems Manager APIs. For information about the hardware ﬁngerprint and instructions for conﬁguri ng a similarity threshold to assist in machine veriﬁcation, see Validating on-premises servers and virtual machines using a hardware ﬁngerprint. The topic SSM Agent technical reference brings together information to help you implement AWS Systems Manager SSM Agent and understand how the agent works. This topic includes an all-new section, SSM Agent rolling updates by AWS Regions. January 21, 2021 3190 AWS Systems Manager User Guide SSM Agent on Windows Server 2008 January 5, 2021 As of January 14, 2020, Windows Server 2008 is no longer supported for feature or security updates from Microsoft. Windows Server 2008 AMIs do include SSM Agent, but the agent is no longer updated for this operating system. Improved support for maintenance window tasks You can now create maintenance window tasks that don't require speciﬁed without having specify a targets (AWS CLI and API target in the task if one December 23, 2020 only) isn't required (AWS CLI and API only). This applies to Automation, AWS Lambda and AWS Step Functions task types. For example, if you create an Automation task and the resources to update are speciﬁed in the Automatio n runbook parameters, you no longer need to specify a target in the task itself. For more information, see Registering maintenance window tasks without targets and Schedule automations with maintenance windows. 3191 AWS Systems Manager User Guide New Automation features New topic: Working with associations using IAM December 21, 2020 December 18, 2020 A new shared property has been added to Systems Manager Automation runbooks. The onCancel property allows you to specify which step the automation should go to in the event that a user cancels the automatio n. For more information, see Properties shared by all actions. A new topic has been added to the Systems Manager State Manager chapter that describes the best practices for creating associations using IAM. For more information, see Working with associations using IAM. State Manager now supports multi-regions and multi-acc Associations can now be created or updated with December 15, 2020 ounts multiple regions or accounts. For more information, see Creating associations. 3192 AWS Systems Manager New tool: Fleet Manager User Guide December 15,
systems-manager-ug-890	systems-manager-ug.pdf	890	specify which step the automation should go to in the event that a user cancels the automatio n. For more information, see Properties shared by all actions. A new topic has been added to the Systems Manager State Manager chapter that describes the best practices for creating associations using IAM. For more information, see Working with associations using IAM. State Manager now supports multi-regions and multi-acc Associations can now be created or updated with December 15, 2020 ounts multiple regions or accounts. For more information, see Creating associations. 3192 AWS Systems Manager New tool: Fleet Manager User Guide December 15, 2020 Fleet Manager, a tool in AWS Systems Manager, is a uniﬁed user interface (UI) experience that helps you remotely manage your server ﬂeet running on AWS, or on- premises. With Fleet Manager, you can view the health and performance status of your entire server ﬂeet from one console. You can also gather data from individua l instances to perform common troubleshooting and management tasks from the console. For information, see AWS Systems Manager Fleet Manager. 3193 AWS Systems Manager User Guide New tool: Change Manager December 15, 2020 Amazon Web Services has released Change Manager, an enterprise change management framework for requesting, approving, implementing, and reporting on operational changes to your application conﬁgura tion and infrastructure. From a single delegated administrator account, if you use AWS Organizations, you can manage changes across multiple AWS accounts in multiple AWS Regions. Alternatively, using a local account, you can manage changes for a single AWS account. Use Change Manager for managing changes to both AWS resources and on-premises resources. For information, see AWS Systems Manager Change Manager. 3194 User Guide December 15, 2020 AWS Systems Manager New tool: Application Manager Application Manager helps you investigate and remediate issues with your AWS resources in the context of your applicati ons. Application Manager aggregates operations information from multiple AWS services and Systems Manager tools to a single AWS Management Console. For information, see AWS Systems Manager Application Manager. 3195 AWS Systems Manager User Guide AWS Systems Manager supports Amazon EC2 In tandem with the release of Amazon Elastic Compute instances for macOS Cloud (Amazon EC2) support November 30, 2020 for macOS instances, Systems Manager now supports many operations on EC2 instances for macOS. Supported versions include macOS 10.14.x (Mojave) and 10.15.x (Catalina). For more informati on, see the following topics. • For information about installing SSM Agent on EC2 instances for macOS, see Installing and conﬁguri ng SSM Agent on EC2 instances for macOS.. • For information about patching EC2 instances for macOS, see How patches are installed, and Creating a custom patch baseline (macOS). • For general information about support for EC2 instances for macOS, see Amazon EC2 Mac instances in the Amazon EC2 User Guide. 3196 AWS Systems Manager User Guide Maintenance window pseudo parameters: New An additional resource type is now available for use resource type supported with the pseudo parameter November 27, 2020 for {{TARGET_ID}} and {{RESOURCE_ID}} s {{TARGET_ID}} and {{RESOURCE_ID}} . You can now use the resource type AWS::RDS::DBCluste r with both these pseudo parameters. For information about maintenance window pseudo parameters, see Using pseudo parameters when registering maintenance window tasks. Session Manager plugin for the AWS CLI version 1.2.30.0 A new version of the Session Manager plugin for the AWS November 24, 2020 CLI has been released. For more information, see Session Manager plugin latest version and release history. New topic: Comparing SSM document versions You can now compare the diﬀerences in content November 24, 2020 Systems Manager now supports VPC endpoint policies between versions of SSM documents in the Systems Manager Documents console. For more information, see Comparing SSM document versions. You can now create policies for VPC interface endpoints for Systems Manager. For more information, see Create an interface VPC endpoint policy. November 18, 2020 3197 AWS Systems Manager User Guide New topic: Specify an idle session timeout value November 18, 2020 You can now specify the amount of time to allow a user to be inactive before a session ends with Session Manager. For more informati on, see Specify an idle session timeout value. New Session Manager logging feature You can now send a continual stream of JSON-formatted November 18, 2020 session data logs to Amazon CloudWatch Logs. For more information, see Streaming session data using Amazon CloudWatch Logs. New topic: Verify the signature of the SSM Agent You can now verify the cryptographic signature of November 17, 2020 the installer package for the SSM Agent on Linux instances . For more information, see SSM document schemas and features. New topic: Understanding automation statuses A new topic has been added to the Systems Manager November 17, 2020 Automation chapter that describes the statuses for actions and automations. For more information, see Understanding automation statuses. 3198
systems-manager-ug-891	systems-manager-ug.pdf	891	stream of JSON-formatted November 18, 2020 session data logs to Amazon CloudWatch Logs. For more information, see Streaming session data using Amazon CloudWatch Logs. New topic: Verify the signature of the SSM Agent You can now verify the cryptographic signature of November 17, 2020 the installer package for the SSM Agent on Linux instances . For more information, see SSM document schemas and features. New topic: Understanding automation statuses A new topic has been added to the Systems Manager November 17, 2020 Automation chapter that describes the statuses for actions and automations. For more information, see Understanding automation statuses. 3198 AWS Systems Manager User Guide New source types for the aws:downloadContent plugin Git and HTTP are now supported as source types for the aws:downl oadContent For more information, see plugin. aws:downloadContent . November 17, 2020 New Systems Manager document (SSM document) In SSM documents with schema version 2.2 or November 17, 2020 schema feature later, the precondition parameter now supports referencing your document' s input parameters. For more information, see SSM document schemas and features. New data source in Explorer: AWS Conﬁg Explorer now displays information about AWS November 11, 2020 Conﬁg compliance, including an overall summary of compliant and non-compliant AWS Conﬁg rules, the number of compliant and non-compl iant resources, and speciﬁc details about each (when you drill down into a non-compl iant rule or resource). For more information, see Editing Systems Manager Explorer data sources. 3199 AWS Systems Manager User Guide New topic: Running Auto Scaling groups with associati A new section has been added to State Manager that November 10, 2020 ons describes the best practices for creating associations to run Auto Scaling groups. For more information, see Running Auto Scaling groups with associations. Quick Setup now supports targeting a resource group Quick Setup now supports choosing a resource group as November 5, 2020 a target for the local setup type. For more information, see Choosing Targets for Quick Setup. Patch Manager adds support for Debian Server 10 LTS, You can now use Patch Manager to patch Debian Oracle Linux 7.9 LTS, and Server 10 LTS, Oracle Linux Ubuntu Server 20.10 STR 7.9 LTS, and Ubuntu Server November 4, 2020 20.10 STR instances. For more information, see the following topics: • Patch Manager prerequis ites • How security patches are selected • How patches are installed • How patch baseline rules work on Debian Server • How patch baseline rules work on Oracle Linux • How patch baseline rules work on Ubuntu Server 3200 AWS Systems Manager User Guide New EventBridge support for AWS Systems Amazon EventBridge now provides support for Change Manager Change Calendar Calendar events events November 4, 2020 in event rules. When the state of a calendar changes, EventBridge can initiate the target action you deﬁned an EventBridge rule. For information about working with EventBridge and Systems Manager events, see the following topics. • Conﬁguring EventBridge for Systems Manager events • Reference: Amazon EventBridge event patterns and types for Systems Manager Conﬁgure CloudWatch to create OpsItems from alarms You can conﬁgure Amazon CloudWatch to automatically November 4, 2020 create an OpsItem in Systems Manager OpsCenter when an alarm enters the ALARM state. Doing so allows you to quickly diagnose and remediate issues with AWS resources from a single console. For more information, see Conﬁguring CloudWatch to create OpsItems from alarms. 3201 AWS Systems Manager User Guide Support for Ubuntu Server 20.10 AWS Systems Manager now supports Ubuntu Server 20.10 October 22, 2020 short-term release (STR). For more information, see the following topics: • Supported operating systems • Install SSM Agent for a hybrid environment (Linux) • Manually install SSM Agent on Ubuntu Server instances • Checking SSM Agent status and starting the agent New topic: Allow conﬁgurable shell proﬁles You can now allow conﬁgura ble shell proﬁles with October 21, 2020 Session Manager. By allowing conﬁgurable shell proﬁles, you can customize preferenc es within sessions such as shell preferences, environme nt variables, working directori es, and running multiple commands when a session is started. For more informati on, see Allow conﬁgurable shell proﬁles. 3202 AWS Systems Manager User Guide Patch compliance results now report which CVEs are For most supported Linux systems, when you view resolved by which patches patch compliance results October 20, 2020 for your managed instances , the details you can view now report which Common Vulnerabilities and Exposure (CVE) bulletin issues are resolved by which available patches. This information can help you determine how urgently you need to install a missing or failed patch. For more information, see Viewing patch compliance results. 3203 AWS Systems Manager User Guide Expanded support for Linux patch metadata You can now view many details about available Linux October 16, 2020 patches in Patch Manager. You can choose to view patch data such as
systems-manager-ug-892	systems-manager-ug.pdf	892	you view resolved by which patches patch compliance results October 20, 2020 for your managed instances , the details you can view now report which Common Vulnerabilities and Exposure (CVE) bulletin issues are resolved by which available patches. This information can help you determine how urgently you need to install a missing or failed patch. For more information, see Viewing patch compliance results. 3203 AWS Systems Manager User Guide Expanded support for Linux patch metadata You can now view many details about available Linux October 16, 2020 patches in Patch Manager. You can choose to view patch data such as architect ure, epoch, version, CVE ID, Advisory ID, Bugzilla ID, repository, and more. In addition, the DescribeA vailablePatches API operation has been updated to support Linux operating systems and ﬁltering according to these newly available patch metadata types. For more information, see the following topics: • Viewing available patches • DescribeAvailablePatches and Patch in the AWS Systems Manager API Reference • describe-available-patches in the AWS Systems Manager section of the AWS CLI Command Reference A new version of the Session Manager plugin for the AWS CLI has been released. For more information, see Session Manager plugin latest version and release history. Session Manager plugin for the AWS CLI version 1.2.7.0 October 15, 2020 3204 AWS Systems Manager User Guide New topic: Session document schema The new topic Session document schema describes October 15, 2020 New topic: Free text search for SSM documents the schema elements for a Session document. This information can help you create custom Session documents where you specify preferences for the types of sessions you use with Session Manager. The search box on the Systems Manager Documents page now supports free text search. Free text search compares the search term or terms that you enter against the document name in each SSM document. For more information, see Using free text search. October 15, 2020 New topic: Troubleshooting Amazon EC2 managed The new topic Troublesh ooting Amazon EC2 managed October 6, 2020 instance availability instance availability helps you investigate why an Amazon EC2 instance that you have conﬁrmed is running isn't available in lists of available managed instances in Systems Manager. 3205 AWS Systems Manager User Guide Parameter Store chapter reorganization To help you ﬁnd the informati on you need more eﬃcient October 1, 2020 ly, we reorganized content in the Parameter Store chapter of the AWS Systems Manager User Guide. Most content is now organized in the sections Setting up Parameter Store and Working with Parameter Store. In addition, the topic AWS Systems Manager Parameter Store has been expanded to include the following sections: • How can Parameter Store beneﬁt my organization? • Who should use Parameter Store? • What are the features of Parameter Store? • What is a parameter? 3206 User Guide September 24, 2020 AWS Systems Manager New patch compliance- related topics The following topics have been added to help you identify managed instances that are out of patch compliance, understand the diﬀerent types of patch compliance scans, and take the appropriate steps to bring your instances into complianc e. • Identifying noncompliant instances • Patching noncompliant instances • Viewing patch compliance results SSM Agent version 3.0 Systems Manager launched a new version of SSM Agent. September 21, 2020 3207 AWS Systems Manager User Guide New and updated topics: Amazon EventBridge replaces CloudWatch Events and EventBridge are the same CloudWatch Events for event underlying service and API, management but EventBridge provides September 18, 2020 more features and is now the preferred way to manage your events in AWS. (Changes you make in either CloudWatch or EventBridge are reﬂected in each console.) Reference s to CloudWatch Events and existing procedures throughout the AWS Systems Manager User Guide have been updated to reﬂect EventBridge support. In addition, the following new topics have been added. • Monitoring Systems Manager events • Conﬁguring EventBridge for Systems Manager events • Systems Manager target type examples • Reference: Amazon EventBridge event patterns and types for Systems Manager 3208 AWS Systems Manager User Guide Integrating AWS Security Hub and Patch Manager You can now integrate Patch Manager with AWS Security September 17, 2020 Hub. Security Hub provides a comprehensive view of your security state in AWS and helps you check your environment against security industry standards and best practices. When integrated with Patch Manager, Security Hub monitors the patching status of your ﬂeets from a security point of view. For more information, see Integrating Patch Manager with AWS Security Hub. 3209 AWS Systems Manager User Guide Maintenance window pseudo parameters: New When you register a maintenance window task, resource types supported you use the --task-in September 14, 2020 for {{TARGET_ID}} and {{RESOURCE_ID}} vocation-parameter s option to specify the parameters that are unique to each of the four task types. You can
systems-manager-ug-893	systems-manager-ug.pdf	893	your security state in AWS and helps you check your environment against security industry standards and best practices. When integrated with Patch Manager, Security Hub monitors the patching status of your ﬂeets from a security point of view. For more information, see Integrating Patch Manager with AWS Security Hub. 3209 AWS Systems Manager User Guide Maintenance window pseudo parameters: New When you register a maintenance window task, resource types supported you use the --task-in September 14, 2020 for {{TARGET_ID}} and {{RESOURCE_ID}} vocation-parameter s option to specify the parameters that are unique to each of the four task types. You can also reference certain values using pseudo parameter syntax, such as {{TARGET_ID}} and {{RESOURCE_ID}} . When the maintenance window task runs, it passes the correct values instead of the pseudo parameter placeholders. Two additional resource types are now available for use with the pseudo parameter s {{TARGET_ID}} and {{RESOURCE_ID}} . You can now use the resources types AWS::RDS::DBInstance and AWS::SSM::ManagedI nstance with both these pseudo parameter s. For information about maintenance window pseudo parameters, see Using pseudo parameters when registering maintenance window tasks. 3210 AWS Systems Manager User Guide Patch instances on demand with new 'Patch now' option You can now use the Systems Manager console to patch September 9, 2020 instances, or scan for missing patches, at any time. You can do this without having to create or modify a schedule, or specify full patching conﬁguration options to accommodate an immediate patching need. You need only specify whether to scan or install patches and identify the target instances for the operation. Patch Manager automatically applies the current default patch baseline for your instance types and applies best practice options for how many instances are patched at once, and how many errors are permitted before the operation fails. For more information, see Patching instances on demand. The new topic Checking SSM Agent status and starting the agent provides commands to check whether SSM Agent is running on each supportin g operating system. It also provides the commands to start the agent if it isn't running. September 7, 2020 3211 New topic: Checking SSM Agent status and starting the agent AWS Systems Manager User Guide Patch Manager now supports Ubuntu Server 20.04 LTS You can now use Patch Manager to patch Ubuntu August 31, 2020 Server 20.04 LTS instances. For more information, see the following topics: • How security patches are selected • How patches are installed • How patch baseline rules work on Ubuntu Server New topic for Use cases and best practices We've added a new topic to help users quickly understan August 28, 2020 New OpsCenter features New data source in Explorer: AWS Support cases d the diﬀerences between Maintenance Windows and State Manager. For more information, see Choosing between State Manager and Maintenance Windows. OpsCenter include new features to help you quickly locate and run Automation runbooks to remediate issues. For more information, see Automation runbook features in OpsCenter. Explorer now displays information about Support cases. You must have either an Enterprise or Business account set up with Support. For more information, see Editing Systems Manager Explorer data sources. August 19, 2020 August 13, 2020 3212 AWS Systems Manager User Guide Distributor now provides a third-party package from Trend Micro. Distributor now includes a third-party package from Trend Micro. You can use August 12, 2020 The aws:configurePacka ge document plugin now includes the additiona lArguments parameter. Distributor to install the Trend Micro Cloud One agent on your managed instances. Trend Micro Cloud One helps you secure your workloads in the cloud. For more informati on, see AWSDistributor. The Systems Manager Command document plugin aws:configurePacka ge now supports providing additional parameters to your scripts (install, uninstall , and update) with the new additionalArgument s parameter. For more information, see the topic aws:configurePackage . August 11, 2020 AppConﬁg content moved into a separate user guide Information about AWS AppConﬁg has been moved August 3, 2020 into a separate user guide. For more information, see What Is AWSAppConﬁg? AppConﬁg also has a separate documentation landing page with links to the user guide, the AppConﬁg API reference , and a new AppConﬁg workshop. 3213 AWS Systems Manager User Guide Quick Setup now supports AWS Organizations Quick Setup now supports AWS Organizations allowing July 23, 2020 you to quickly conﬁgure required security roles and commonly used Systems Manager tools across multiple accounts and Regions. For more information, see AWS Systems Manager Quick Setup. New data source in Explorer: association compliance Explorer now displays association compliance data July 23, 2020 New Systems Manager Command document to turn on and turn oﬀ Kernel Live Patching from State Manager. For more information, see Editing Systems Manager Explorer data sources . The document AWS-Confi July 22, 2020 gureKernelLivePatc hing is now available to use with Run Command
systems-manager-ug-894	systems-manager-ug.pdf	894	supports AWS Organizations Quick Setup now supports AWS Organizations allowing July 23, 2020 you to quickly conﬁgure required security roles and commonly used Systems Manager tools across multiple accounts and Regions. For more information, see AWS Systems Manager Quick Setup. New data source in Explorer: association compliance Explorer now displays association compliance data July 23, 2020 New Systems Manager Command document to turn on and turn oﬀ Kernel Live Patching from State Manager. For more information, see Editing Systems Manager Explorer data sources . The document AWS-Confi July 22, 2020 gureKernelLivePatc hing is now available to use with Run Command when you want to turn on or turn oﬀ Kernel Live Patching on Amazon Linux 2 instances. This document replaces the need for creating your own custom Command documents for these tasks. For more information, see Use Kernel Live Patching on Amazon Linux 2 instances 3214 AWS Systems Manager User Guide Updated Automation quotas July 20, 2020 Service quotas for Automatio n have been updated including a separate queue for rate control automatio ns. For more information, see AWS Systems Manager Automation. Specify the number of schedule oﬀset days for a Using the Systems Manager console, you can now specify July 17, 2020 maintenance window using a number of days to wait the console after the date and time speciﬁed by a CRON expressio n before running a maintenan ce window. (Previously, this option was available only when using an AWS SDK or a command line tool.) For example, if your CRON expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM – cron(0 30 23 ? * TUE#3 ) – and you specify a schedule oﬀset of 2, the window won't run until two days later at 11:30 PM. For more information, see Cron and rate expressions for Systems Manager and Specify the number of schedule oﬀset days for a maintenance window. 3215 AWS Systems Manager User Guide Update PowerShell using Run Command To help you update PowerShell to version 5.1 on June 30, 2020 your Windows Server 2012 and 2012 R2 instances, we added a walkthrough to the AWS Systems Manager User Guide. For more information, see Update PowerShell using Run Command. Patch Manager now supports CentOS 8.0 and 8.1 You can now use Patch Manager to patch CentOS June 27, 2020 8.0 and 8.1 instances. For more information, see the the following topics: • How security patches are selected • How patches are installed • How patch baseline rules work on CentOS • Manually install SSM Agent on CentOS instances • How to install the SSM Agent on hybrid Linux nodes 3216 AWS Systems Manager User Guide AppConﬁg integrates with AWS CodePipeline AppConﬁg is an integrate d deploy action for AWS June 25, 2020 CodePipeline (CodePipe line). CodePipeline is a fully managed continual delivery service that helps you automate your release pipelines for fast and reliable application and infrastru cture updates. CodePipeline automates the build, test, and deploy phases of your release process every time there is a code change, based on the release model you deﬁne. The integration of AppConﬁg with CodePipeline oﬀers the following beneﬁts. For more information, see AppConﬁg integration with CodePipeline. • Customers who use CodePipeline to manage orchestration now have a lightweight means of deploying conﬁgura tion changes to their applications without having to deploy their entire codebase. • Customers who want to use AppConﬁg to manage conﬁguration deploymen ts but are limited because AppConﬁg doesn't support their current code or 3217 AWS Systems Manager User Guide conﬁguration store, now have additional options. CodePipeline supports AWS CodeCommit, GitHub, and BitBucket (to name a few). New chapter: Product and service integrations To help you understand how Systems Manager integrate June 23, 2020 s with AWS services and other products and services, a new chapter has been added to the AWS Systems Manager User Guide. For more information, see Product and service integrati ons with Systems Manager. Automation chapter reorganiz ation To help you ﬁnd what you need, we reorganized topics June 23, 2020 in the Automation chapter of the AWS Systems Manager User Guide. For example, the Automation actions and Automation runbooks references are now top-level sections in the chapter. For more information, see AWS Systems Manager Automatio n. 3218 AWS Systems Manager User Guide Specify the number of schedule oﬀset days for a Using a command line tool or AWS SDK, you can now maintenance window specify a number of days to June 19, 2020 wait after the date and time speciﬁed by a CRON expressio n before running a maintenan ce window. For example, if your CRON expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM – cron(0 30 23 ? TUE#3 *) – and
systems-manager-ug-895	systems-manager-ug.pdf	895	sections in the chapter. For more information, see AWS Systems Manager Automatio n. 3218 AWS Systems Manager User Guide Specify the number of schedule oﬀset days for a Using a command line tool or AWS SDK, you can now maintenance window specify a number of days to June 19, 2020 wait after the date and time speciﬁed by a CRON expressio n before running a maintenan ce window. For example, if your CRON expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM – cron(0 30 23 ? * TUE#3 *) – and you specify a schedule oﬀset of 2, the window won't run until two days later at 11:30 PM. For more information, see Cron and rate expressions for Systems Manager and Specify the number of schedule oﬀset days for a maintenance window. Patch Manager support for Kernel Live Patching on Kernel Live Patching for Amazon Linux 2 allows you Amazon Linux 2 instances to apply security vulnerabi June 16, 2020 lity and critical bug patches to a running Linux kernel, without reboots or disruptio ns to running applications. You can now allow the feature and apply kernel live patches using Patch Manager. For information, see Use Kernel Live Patching on Amazon Linux 2 instances. 3219 AWS Systems Manager User Guide Patch Manager increases Oracle Linux version support Previously, Patch Manager supported only version 7.6 June 16, 2020 Sample scenario for using the InstallOverrideLis t parameter in patching operations June 11, 2020 of Oracle Linux. As listed in Patch Manager prerequisites, support now covers versions 7.5-7.8. The new topic Sample scenario for using the InstallOverrideLis t parameter describes a strategy for using the InstallOverrideList parameter in the AWS-RunPa tchBaseline document to apply diﬀerent types of patches to a target group, on diﬀerent maintenance window schedules, while still using a single patch baseline. Predeﬁned deployment strategies for AppConﬁg AppConﬁg now oﬀers predeﬁned deployment June 10, 2020 strategies. For more informati on, see Creating a deploymen t strategy. 3220 AWS Systems Manager User Guide Patch Manager now supports Red Hat Enterprise Linux You can now use Patch Manager to patch RHEL June 9, 2020 (RHEL) 7.8-8.2 7.8–8.2 instances. For more information, see the the following topics: • How security patches are selected • How patches are installed • How patch baseline rules work on RHEL • Manually install SSM Agent on Red Hat Enterprise Linux instances • How to install the SSM Agent on hybrid Linux nodes 3221 AWS Systems Manager User Guide Explorer supports delegated administration If you aggregate Explorer data from multiple AWS June 3, 2020 Regions and AWS accounts by using resource data sync with AWS Organizations, then we suggest that you conﬁgure a delegated administrator for Explorer. A delegated administrator improves Explorer security by limiting the number of Explorer administrators who can create or delete multi-account and Region resource data syncs to only one individual. You also no longer need to be logged into the AWS Organizations management account to administer resource data syncs in Explorer. For more information, see Conﬁguring a Delegated Administrator. Apply State Manager associati on only at the next speciﬁed If you don't want a State Manager association to June 3, 2020 Cron interval run immediately after you create it, you can choose the Apply association only at the next speciﬁed Cron interval option in the Systems Manager console. For more information, see Creating associations. 3222 AWS Systems Manager User Guide New data source in Explorer: AWS Compute Optimizer Explorer now displays data from AWS Compute May 26, 2020 Optimizer. This includes a count of Under provision ed and Over provisioned EC2 instances, optimization ﬁndings, on-demand pricing details, and recommendations for instance type and price. For more information, see the details for setting up AWS Compute Optimizer in Setting up related services. Install Windows Service Packs and Linux minor The new topic Tutorial: Create a patch baseline for installin May 21, 2020 version upgrades using Patch g Windows Service Packs Manager (console) demonstrates how you can create a patch baseline devoted exclusively to installing Windows Service Packs. The topic Create a custom patch baseline (Linux) has been updated with information about including minor version upgrades for Linux operating systems in patch baselines. 3223 AWS Systems Manager User Guide Parameter Store chapter reorganization May 18, 2020 All topics that deal with conﬁguring or setting options for Parameter Store operation s have been consolida ted into the Setting up Parameter Store section. This includes the topics Managing parameter tiers and Increasin g Parameter Store throughpu t, which have been relocated from other parts of the chapter. New topic for creating date and time strings for interacti The new topic Creating formatted date and time ng with Systems Manager API strings for Systems Manager May 13, 2020 operations. About
systems-manager-ug-896	systems-manager-ug.pdf	896	Linux operating systems in patch baselines. 3223 AWS Systems Manager User Guide Parameter Store chapter reorganization May 18, 2020 All topics that deal with conﬁguring or setting options for Parameter Store operation s have been consolida ted into the Setting up Parameter Store section. This includes the topics Managing parameter tiers and Increasin g Parameter Store throughpu t, which have been relocated from other parts of the chapter. New topic for creating date and time strings for interacti The new topic Creating formatted date and time ng with Systems Manager API strings for Systems Manager May 13, 2020 operations. About permissions for encrypting SecureString parameters describes how to create formatted date and time strings for interacting with Systems Manager API operations. The new topic Restricting access to Systems Manager parameters using IAM policies explains the diﬀerence between encrypting your SecureString parameter s using an AWS KMS key and using the AWS managed key provided by AWS. May 13, 2020 3224 AWS Systems Manager User Guide Patch Manager now supports the Debian Server and Oracle You can now use Patch Manager to patch Debian Linux 7.6 operating systems Server and Oracle Linux May 7, 2020 instances. Patch Manager supports patching Debian Server 8.x and 9.x and Oracle Linux 7.6 versions. For more information, see the following topics: • How security patches are selected • How patches are installed • How patch baseline rules work on Debian Server • How patch baseline rules work on Oracle Linux Create State Manager associations that target AWS In addition to targeting tags, individual instances, and May 7, 2020 Resource Groups all instances in your AWS account, you can now create State Manager associati ons that target instances in AWS Resource Groups. For more information, see About targets and rate controls in State Manager associations 3225 AWS Systems Manager User Guide New aws:ec2:image data type in Parameter Store to When you create a String parameter, you can now May 5, 2020 validate AMI IDs specify a data type as aws:ec2:image to ensure that the parameter value you enter is a valid Amazon Machine Image (AMI) ID format. Support for AMI ID formats means you don't have to update all your scripts and templates with a new ID each time the AMI that you want to use in your processes changes. You can create a parameter with the data type aws:ec2:image , and for its value, enter the ID of an AMI. This is the AMI from which you want new instances to be created. You then reference this parameter in your templates, commands. When you're ready to use a diﬀerent AMI, update the parameter value. Parameter Store validates the new AMI ID, and you don't need to update your scripts and templates. For more informati on, see Native parameter support for Amazon Machine Image IDs. 3226 AWS Systems Manager User Guide Managing exit codes in Run Command commands Run Command enables you to deﬁne how exit codes May 5, 2020 are handled in your scripts. By default, the exit code of the last command run in a script is reported as the exit code for the entire script. However, you can include a shell conditional statement to exit the script if any command before the ﬁnal one fails using the following approach. For examples, see the new topic Managing exit codes in Run Command commands. New public parameters released for availability zones Public parameters have been released to make information May 4, 2020 and local zones about AWS availability zones and local zones available programmatically. These are in addition to existing global infrastructure public parameters for AWS services and AWS Regions. For more information, see Calling public parameters for AWS services, Regions, endpoints, Availability Zones, local zones, and Wavelength Zones . 3227 AWS Systems Manager User Guide New data source in Explorer: AWS Trusted Advisor Explorer now displays data from AWS Trusted Advisor. May 4, 2020 This includes the status of best practice checks and recommendations in the following areas: cost optimization, security, fault tolerance, performance, and service quotas. For more information, see the details for setting up Trusted Advisor in Setting up related services. 3228 AWS Systems Manager User Guide Create State Manager associations that run Chef You can create State Manager associations that run Chef March 19, 2020 recipes cookbooks and recipes by using the AWS-Apply ChefRecipes document. This document oﬀers the following beneﬁts for running Chef recipes: • Supports multiple releases of Chef (Chef 11 through Chef 14). • Automatically installs the Chef client software on target instances. • Optionally runs Systems Manager compliance checks on target instances , and stores the results of compliance checks in an S3 bucket. • Runs multiple cookbooks and recipes in a single run of the document. • Optionally runs recipes in why-run mode, to show which
systems-manager-ug-897	systems-manager-ug.pdf	897	run Chef You can create State Manager associations that run Chef March 19, 2020 recipes cookbooks and recipes by using the AWS-Apply ChefRecipes document. This document oﬀers the following beneﬁts for running Chef recipes: • Supports multiple releases of Chef (Chef 11 through Chef 14). • Automatically installs the Chef client software on target instances. • Optionally runs Systems Manager compliance checks on target instances , and stores the results of compliance checks in an S3 bucket. • Runs multiple cookbooks and recipes in a single run of the document. • Optionally runs recipes in why-run mode, to show which recipes will change on target instances without making changes. • Optionally applies custom JSON attributes to chef- client runs. 3229 AWS Systems Manager User Guide For more information, see Creating associations that run Chef recipes Synchronize inventory data from multiple AWS accounts You can synchronize Systems Manager Inventory data to a central Amazon S3 from multiple AWS accounts March 16, 2020 bucket to a central S3 bucket. The accounts must be deﬁned in AWS Organizations. For more information, see Creating an Inventory resource data sync for multiple accounts deﬁned in AWS Organizations. Store AppConﬁg conﬁgura tions in Amazon S3 Previously, AppConﬁg only supported applicati March 13, 2020 on conﬁgurations that were stored in Systems Manager (SSM) documents or Parameter Store parameters. In addition to these options, AppConﬁg now supports storing conﬁgurations in Amazon S3. For more information, see About conﬁgurations stored in Amazon S3. SSM Agent is now installed by default on Amazon ECS- Optimized AMIs. For more information, see Working with SSM Agent. SSM Agent installed by default on Amazon ECS-optim ized AMIs February 25, 2020 3230 AWS Systems Manager User Guide Create AppConﬁg conﬁgura tions in the console AppConﬁg now allows you to create an application February 13, 2020 conﬁguration in the console at the time you create a conﬁguration proﬁle. For more information, see Creating a conﬁguration and a conﬁguration proﬁle. Auto-approve only patches released up to a speciﬁed In addition to the option for automatically approving February 12, 2020 date patches for installation a speciﬁed number of days after they're released, Patch Manager now supports the ability to auto-approve only patches released on or before a date that you specify. For example, if you specify July 7, 2020, as the cutoﬀ date in your patch baseline, no patches released on or after July 8, 2020, are installed automatically. For more information, see About custom baselines and Working with custom patch baselines (console). 3231 AWS Systems Manager User Guide Use the {{RESOURCE_ID}} pseudo parameter in When you register a maintenance window task, maintenance window tasks you specify the parameter February 6, 2020 s that are unique to the task type. You can reference certain values using pseudo parameter syntax, such as {{TARGET_ID}} , {{TARGET_TYPE}} , and {{WINDOW_TARGET_ID }} . When the maintenance window task runs, it passes the correct values instead of the pseudo parameter placeholders. To support resources that are part of a resource group as a target, you can use the {{RESOURC E_ID}} pseudo parameter to pass values for resources such as DynamoDB tables, S3 buckets, and other supported types. For more information, see the following topics in Tutorial: Create and conﬁgure a maintenance window (AWS CLI): • Using pseudo parameters when registering maintenan ce window tasks • Examples: Register tasks with a maintenance window 3232 AWS Systems Manager User Guide Quickly rerun commands February 5, 2020 Systems Manager includes two options to help you rerun a command from the Run Command page in the AWS Systems Manager console. Rerun: This button allows you to run the same command without making changes to it. Copy to new: This button copies the settings of one command to a new command and gives you the option to edit those settings before you run it. For more information, see Rerunning commands. Reverting from the advanced- instances tier to the standard- If you previously conﬁgure d all on-premises instances January 16, 2020 instances tier running in your hybrid environment to use the advanced-instances tier, you can now quickly conﬁgure those instances to use the standard-instance tier. Reverting to the standard- instances tier applies to all hybrid instances in an AWS account and a single AWS Region. Reverting to the standard-instances tier impacts the availability of some Systems Manager tools. For more information, see Reverting from the advanced- instances tier to the standard- instances tier. 3233 AWS Systems Manager User Guide New option to skip instance reboots after patch installat Previously, managed instances were always January 15, 2020 ion rebooted after Patch Manager installed patches on them. A new RebootOption parameter in the SSM document AWS-RunPa tchBaseline allows you to specify whether or not you want your instances to reboot automatically after new patches are installed. For more information, see
systems-manager-ug-898	systems-manager-ug.pdf	898	AWS account and a single AWS Region. Reverting to the standard-instances tier impacts the availability of some Systems Manager tools. For more information, see Reverting from the advanced- instances tier to the standard- instances tier. 3233 AWS Systems Manager User Guide New option to skip instance reboots after patch installat Previously, managed instances were always January 15, 2020 ion rebooted after Patch Manager installed patches on them. A new RebootOption parameter in the SSM document AWS-RunPa tchBaseline allows you to specify whether or not you want your instances to reboot automatically after new patches are installed. For more information, see Parameter name: RebootOpt ion in the topic About the SSM document AWS-RunPa tchBaseline . New topic: 'Running PowerShell scripts on Linux A new topic that describes how to use Run Command January 10, 2020 instances' Updates to 'conﬁgure SSM Agent to use a proxy' to run PowerShell scripts on Linux instances. For more information, see Running PowerShell scripts on Linux instances. The values to specify when conﬁguring SSM Agent to use a proxy have been updated to reﬂect options for both HTTP proxy servers and HTTPS proxy servers. For more information, see Conﬁgure SSM Agent to use a proxy. January 9, 2020 3234 AWS Systems Manager User Guide New "Security" chapter outlines practices for securing A new Security chapter in the AWS Systems Manager User Systems Manager resources Guide helps you understan December 24, 2019 d how to apply the shared responsibility model when using Systems Manager. Topics in the chapter show you how to conﬁgure Systems Manager to meet your security and compliance objectives. You also learn how to use other AWS services that help you to monitor and secure your Systems Manager resources. Note As part of this update, the user guide chapter "Authentication and Access Control" has been replaced by a new, simpler section, Identity and access management for AWS Systems Manager. 3235 AWS Systems Manager New sample custom Automation runbooks Support for the Oracle Linux A set of sample custom Automation runbooks has been added to the user guide. These samples show how to use various Automation actions to simplify deploymen t, troubleshooting, and maintenance tasks, and are intended to help you write your own custom Automation runbooks. For more information, see Custom Automation runbook samples. You can also view Amazon managed Automatio n runbook content in the Systems Manager console. For more information, see Systems Manager Automation runbook reference. Systems Manager now supports Oracle Linux 7.5 and 7.7. For information about manually installing SSM Agent on EC2 instances for Oracle Linux instances, see Oracle Linux. For information about installing SSM Agent on Oracle Linux servers in a hybrid environment, see How to install the SSM Agent on hybrid Linux nodes. User Guide December 23, 2019 December 19, 2019 3236 AWS Systems Manager User Guide Launch Session Manager sessions from the Amazon EC2 console December 18, 2019 You can now start Session Manager sessions from the Amazon Elastic Compute Cloud (Amazon EC2) console. Working with session-related tasks from the Amazon EC2 console requires diﬀerent IAM permissions for both users and administrators. You can provide permissions for using the Session Manager console and AWS CLI only, for using the Amazon EC2 console only, or for using all three tools. For more information, see the following topics. • Quickstart default IAM policies for Session Manager • Starting a session (Amazon EC2 console) 3237 AWS Systems Manager User Guide CloudWatch support for Run Command metrics and alarms AWS Systems Manager now publishes metrics about the December 17, 2019 status of Run Command commands to CloudWatch, allowing you to set alarms based on those metrics. The terminal status values for commands for which you can track metrics include Success, Failed, and Delivery Timed Out. For more information, see Monitoring Run Command metrics using Amazon CloudWatch. New Systems Manager tool: Change Calendar Use Systems Manager Change Calendar to specify periods December 11, 2019 of time (events) during which you want to limit or prevent code changes (such as from Systems Manager Automatio n runbooks or AWS Lambda functions) to resources. A change calendar is a new Systems Manager document type that stores iCalendar 2.0 data in plaintext format. For more information, see AWS Systems Manager Change Calendar. 3238 AWS Systems Manager User Guide New Systems Manager tool: AWSAppConﬁg Use AppConﬁg to create, manage, and quickly deploy November 25, 2019 application conﬁgurations. AppConﬁg supports controlle d deployments to applicati ons of any size. You can use AppConﬁg with applicati ons hosted on EC2 instances , AWS Lambda, container s, mobile applications, or IoT devices. To prevent errors when deploying application conﬁgurations, AppConﬁg includes validator s. A validator provides a syntactic or semantic check to ensure that the conﬁguration you want to deploy works as intended. During a conﬁgura tion deployment, AppConﬁg monitors
systems-manager-ug-899	systems-manager-ug.pdf	899	see AWS Systems Manager Change Calendar. 3238 AWS Systems Manager User Guide New Systems Manager tool: AWSAppConﬁg Use AppConﬁg to create, manage, and quickly deploy November 25, 2019 application conﬁgurations. AppConﬁg supports controlle d deployments to applicati ons of any size. You can use AppConﬁg with applicati ons hosted on EC2 instances , AWS Lambda, container s, mobile applications, or IoT devices. To prevent errors when deploying application conﬁgurations, AppConﬁg includes validator s. A validator provides a syntactic or semantic check to ensure that the conﬁguration you want to deploy works as intended. During a conﬁgura tion deployment, AppConﬁg monitors the application to ensure that the deploymen t is successful. If the system encounters an error or if the deployment starts an alarm, AppConﬁg rolls back the change to minimize impact for your application users. For more information, see AWSAppConﬁg. 3239 AWS Systems Manager User Guide New Systems Manager tool: Systems Manager Explorer AWS Systems Manager Explorer is a customizable November 18, 2019 operations dashboard that reports information about your AWS resources. Explorer displays an aggregated view of operations data (OpsData) for your AWS accounts and across AWS Regions. In Explorer, OpsData includes metadata about your EC2 instances, patch compliance details, and operational work items (OpsItems). Explorer provides context about how OpsItems are distributed across your business units or applications, how they trend over time, and how they vary by category. You can group and ﬁlter information in Explorer to focus on items that are relevant to you and that require action. When you identify high priority issues, you can use Systems Manager OpsCenter to run Automation runbooks and quickly resolve those issues. For information see, AWS Systems Manager Explorer. Note Set up for Systems Manager OpsCenter is integrated with 3240 AWS Systems Manager User Guide set up for Explorer. If you already set up OpsCenter, you still need to complete Integrated Setup to verify settings and options. If you haven't set up OpsCenter , then you can use Integrated Setup to get started with both tools. For more information, see Getting started with Explorer and OpsCenter. Improved parameter search capabilities The tools for searching for parameters now make it November 15, 2019 easier to ﬁnd parameters when you have large number of them in your account or when you don't remember the exact name of a parameter . With the search tool, you ﬁlter by contains. Previousl y, the search tools supported searching for parameter names only by equals and begins-with . For more information, see Searching for Systems Manager parameters. 3241 AWS Systems Manager User Guide New console-based Document Builder for You can now use Systems Manager Automation to Automation \| Support for build and share standardi running scripts in Automation zed operational playbooks November 14, 2019 steps to ensure consistency across users, AWS accounts, and AWS Regions. With this ability to run scripts and add inline documentation to your Automation runbooks using Markdown, you can reduce errors and eliminate manual steps such as navigatin g written procedures in wikis and running terminal commands. For more information, see the following topics. • Walkthrough: Using Document Builder to create a custom Automation runbook • aws:executeScript (Automation actions reference) • Creating Automation runbooks using Document Builder • New Automation Features In Systems Manager on the AWS News Blog 3242 AWS Systems Manager User Guide Perform an in-place package update using Distributor Previously, when you wanted to install an update to a November 11, 2019 package using Distribut or, your only choice was to uninstall the entire package and reinstall the new version. Now you can choose to perform an in-place update instead. During an in-place update, Distributor installs only ﬁles that are new or changed since the last installation, according to the update script you include in your package. With this option, your package applicati on can remain available and not be taken oﬄine during the update. For more information, see the following topics. • Create a package • Install or update packages With one click, you can conﬁgure all instances in your AWS account to automatic ally check for and download new versions of SSM Agent. To do this, choose Agent auto update on the Managed instances page in the AWS Systems Manager console. For information, see Automate updates to SSM Agent. November 5, 2019 3243 New SSM Agent auto update feature AWS Systems Manager User Guide Restrict Session Manager access using AWS-supplied A second method for controlli ng user access to session October 2, 2019 tags actions is now available. With this new method, you create IAM access policies using AWS-supplied session tags instead of using the {aws:username} variable. Using these AWS-supplied session tags makes it possible for organizations that use federated IDs to control user access to sessions. For information, see Allow a user to terminate only
systems-manager-ug-900	systems-manager-ug.pdf	900	the AWS Systems Manager console. For information, see Automate updates to SSM Agent. November 5, 2019 3243 New SSM Agent auto update feature AWS Systems Manager User Guide Restrict Session Manager access using AWS-supplied A second method for controlli ng user access to session October 2, 2019 tags actions is now available. With this new method, you create IAM access policies using AWS-supplied session tags instead of using the {aws:username} variable. Using these AWS-supplied session tags makes it possible for organizations that use federated IDs to control user access to sessions. For information, see Allow a user to terminate only sessions they started. 3244 AWS Systems Manager User Guide New SSM Command document to apply Ansible You can create State Manager associations that run Ansible September 24, 2019 Playbooks Playbooks by using the AWS-ApplyAnsiblePl aybooks document. This document oﬀers the following beneﬁts for running Playbooks: • Support for running complex Playbooks • Support for downloading Playbooks from GitHub and Amazon Simple Storage Service (Amazon S3) • Support for compressed Playbook structure • Enhanced logging • Ability to specify which Playbook to run when Playbooks are bundled For more information, see Creating associations that run Ansible playbooks 3245 AWS Systems Manager User Guide Port forwarding support for Session Manager Session Manager now supports port forwardin August 29, 2019 g sessions. Port forwardin g allows you to securely create tunnels between your instances deployed in private subnets, without the need to start the SSH service on the server, to open the SSH port in the security group, or to use a bastion host. Similar to SSH tunnels, port forwarding allows you to forward traﬃc between your laptop to open ports on your instance. Once port forwarding is conﬁgured, you can connect to the local port and access the server application running inside the instance. For more informati on, see the following topics: • Port Forwarding Using AWS Systems Manager Session Manager on the AWS News Blog • Starting a session (port forwarding) 3246 AWS Systems Manager User Guide Specify a default parameter tier or automate tier selection You can now specify a default parameter tier to use for August 27, 2019 requests to create or update a parameter that don't specify a tier. You can set the default tier to standard parameter s, advanced parameters, or a new option, Intelligent- Tiering. Intelligent-Tiering evaluates each PutParame ter request and creates an advanced parameter only when required. (Advanced parameters are required if the size of the parameter value is more than 4 KB, a parameter policy is associate d with the parameter, or the maximum 10,000 parameter s supported for the standard tier are already created.) For more information about specifying a default tier and using Intelligent-Tierin g, see Specifying a default parameter tier. The Working with Associati ons section has been updated to include procedural documentation for managing associations using the AWS CLI or AWS Tools for PowerShell. For information see, Working with associati ons in Systems Manager. August 26, 2019 3247 Working with associations section updated with CLI and PowerShell procedures AWS Systems Manager User Guide Working with Automation executions section updated The Working with Automatio n Executions section has been August 20, 2019 with CLI and PowerShell updated to include procedura procedures l documentation for running Automation workﬂows using the AWS CLI or AWS Tools for PowerShell. For information see, Working with Automation executions. OpsCenter integrates with application insights OpsCenter integrates with Amazon CloudWatch Applicati August 7, 2019 on Insights for .NET and SQL Server. This means you can automatically create OpsItems for problems detected in your applications. For information about how to conﬁgure Application Insights to create OpsItems, see Set up, conﬁgure, and manage your application for monitorin g in the Amazon CloudWatch User Guide. 3248 AWS Systems Manager User Guide New console feature: AWS Systems Manager Quick Quick Setup is a new feature in the Systems Manager August 7, 2019 Setup console that helps you quickly conﬁgure several Systems Manager components on your EC2 instances. Speciﬁca lly, Quick Setup helps you conﬁgure the following components on the instances you choose or target by using tags: • An AWS Identity and Access Management (IAM) instance proﬁle role for Systems Manager. • A scheduled, bi-monthly update of SSM Agent. • A scheduled collection of Inventory metadata every 30 minutes. • A daily scan of your instances to identify missing patches. • A one-time installation and conﬁguration of the Amazon CloudWatch agent. • A scheduled, monthly update of the CloudWatch agent. For more information, see AWS Systems Manager Quick Setup. 3249 AWS Systems Manager User Guide Register a resource group as a maintenance window target In addition to registeri ng managed instances as July 23, 2019 the target of a maintenan ce window, you can now register a resource group as a
systems-manager-ug-901	systems-manager-ug.pdf	901	• A scheduled, bi-monthly update of SSM Agent. • A scheduled collection of Inventory metadata every 30 minutes. • A daily scan of your instances to identify missing patches. • A one-time installation and conﬁguration of the Amazon CloudWatch agent. • A scheduled, monthly update of the CloudWatch agent. For more information, see AWS Systems Manager Quick Setup. 3249 AWS Systems Manager User Guide Register a resource group as a maintenance window target In addition to registeri ng managed instances as July 23, 2019 the target of a maintenan ce window, you can now register a resource group as a maintenance window target. Maintenance Windows supports all the AWS resource types that are supported by AWS Resource Groups including AWS::EC2: :Instance , AWS::Dyna moDB::Table , AWS::OpsW orks::Instance , AWS::Redshift::Clu ster , and more. With this release you can also send commands to a resource group, for example by using the Run Command console or the AWS CLI send-command command. For more informati on, see the following topics: • Assign targets to a maintenance window (console) • Examples: Register targets with a maintenance window • Using targets and rate controls to send commands to a ﬂeet 3250 AWS Systems Manager User Guide Simpliﬁed package creation and versioning with AWS Distributor has a new, simpliﬁed package creation Systems Manager Distributor workﬂow that can generate July 22, 2019 a package manifest, scripts, and ﬁle hashes for you. You can also use the simpliﬁe d workﬂow when you add a version to an existing package. New document categories pane for Systems Manager Systems Manager includes a new Document categorie July 18, 2019 Automation s pane when you run an Automation in the console. Use this pane to ﬁlter Automation runbooks based on their purpose. Support for starting Session Manager sessions using By default, Session Manager sessions are launched using July 9, 2019 operating system user the credentials of a system- credentials generated ssm-user account that is created on a managed instance. On Linux machines, you can now instead launch sessions using the credentia ls of an operating system account. For information, see Turn on Run As support for Linux instances. 3251 AWS Systems Manager User Guide Support for starting Session Manager sessions using SSH You can now use the AWS CLI to start an SSH session July 9, 2019 on a managed instance using Session Manager. For information about allowing SSH sessions with Session Manager, see (Optional) Turn on SSH Session Manager sessions. For information about starting an SSH session using Session Manager, see Starting a session (SSH). You can now reset passwords on machines that you manage using Systems Manager (managed instances). You can reset the password using the Systems Manager console or the AWS CLI. For information, see Resetting passwords on managed instances. July 9, 2019 Support for changing passwords on managed instances Revisions to "What is AWS Systems Manager?" The introductory content in What is AWS Systems June 10, 2019 Manager? has been expanded to provide a broader introduct ion to the service and reﬂect Systems Manager tools that have been released recently. In addition, other content in the section has been moved into individual topics for better discoverability. 3252 AWS Systems Manager User Guide New Systems Manager tool: OpsCenter OpsCenter provides a central location where operations June 6, 2019 engineers and IT professio nals can view, investigate, and resolve operational work items (OpsItems) related to AWS resources. OpsCenter is designed to reduce mean time to resolution for issues impacting AWS resources. This Systems Manager tool aggregates and standardi zes OpsItems across services while providing contextual investigation data about each OpsItem, related OpsItems, and related resources. OpsCenter also provides Systems Manager Automation runbooks that you can use to quickly resolve issues. You can specify searchable, custom data for each OpsItem. You can also view automatic ally-generated summary reports about OpsItems by status and source. For more information, see AWS Systems Manager OpsCenter. 3253 AWS Systems Manager User Guide Changes to Systems Manager left navigation pane in the The Systems Manager left navigation pane in the AWS Management Console AWS Management Console June 6, 2019 includes new headings, including a new heading for Ops Center, that provide a more logical grouping of Systems Manager tools. 3254 AWS Systems Manager User Guide Revised tutorial for creating and conﬁguring a maintenan Tutorial: Create and conﬁgure a maintenance window (AWS May 31, 2019 ce window using the AWS CLI CLI) has been overhauled to provide a simple path through the practice steps. You create a single maintenan ce window, identify a single target, and set up a simple task for the maintenance window to run. Along the way, we provide informati on and examples you can use to create your own task registration commands, including information for using pseudo parameters such as {{TARGET_ID}} . For
systems-manager-ug-902	systems-manager-ug.pdf	902	Systems Manager tools. 3254 AWS Systems Manager User Guide Revised tutorial for creating and conﬁguring a maintenan Tutorial: Create and conﬁgure a maintenance window (AWS May 31, 2019 ce window using the AWS CLI CLI) has been overhauled to provide a simple path through the practice steps. You create a single maintenan ce window, identify a single target, and set up a simple task for the maintenance window to run. Along the way, we provide informati on and examples you can use to create your own task registration commands, including information for using pseudo parameters such as {{TARGET_ID}} . For additional information and examples, see the following topics: • Examples: Register targets with a maintenance window • Examples: Register tasks with a maintenance window • About register-task-with -maintenance-windows options • Using pseudo parameters when registering maintenan ce window tasks To be notiﬁed about SSM Agent updates, subscribe to the SSM Agent Release Notes page on GitHub. Notiﬁcations about SSM Agent updates May 24, 2019 3255 AWS Systems Manager User Guide Receive notiﬁcations or trigger actions based on The topic Set up notiﬁcat ions or trigger actions changes in Parameter Store based on Parameter Store May 22, 2019 events now helps you set up Amazon EventBridge rules to respond to changes in Parameter Store. You can receive notiﬁcations or trigger other actions when any of the following occur: • A parameter is created, updated, or deleted. • A parameter label version is created, updated, or deleted. • A parameter expires, is going to expire, or hasn't changed in a speciﬁed period of time. 3256 AWS Systems Manager User Guide Major revisions to setting up and getting started content We have expanded and reorganized the Setting May 15, 2019 Up and Getting Started content in the AWS Systems Manager User Guide. Setting Up content has been divided into two sections. One section focuses on tasks for setting up Systems Manager to conﬁgure and manage your EC2 instances. The other focuses on tasks for setting up Systems Manager to conﬁgure and manage your on-premises servers and virtual machines (VMs) in a hybrid environment. Both sections now present all setup topics as major numbered steps, in the recommend ed order of completion. A new Getting Started chapter focuses on helping end-users get started with Systems Manager after account and service conﬁguration tasks have been completed. • Setting up AWS Systems Manager • Setting up AWS Systems Manager for hybrid environments • Getting started with AWS Systems Manager 3257 AWS Systems Manager User Guide Include patches for applicati ons released by Microsoft in Patch Manager now supports patch updates for applicati May 7, 2019 patch baselines (Windows) ons released by Microsoft on Windows Server instances. Previously, only patches for the Windows Server operating system were supported. Patch Manager provides two predeﬁned patch baselines for Windows Server instances. The patch baseline AWS-WindowsPredefi nedPatchBaseline-OS applies to operating system patches only. AWS-Windo wsPredefinedPatchB aseline-OS-Applica tions applies to both the Windows Server operating system and applications released by Microsoft on Windows. For information about creating a custom patch baseline that includes patches for applications released by Microsoft, see the ﬁrst procedure in Create a custom patch baseline. Also, as part of this update, the names of AWS-provided predeﬁned patch baselines are being changed. For more information, see Predeﬁned baselines. 3258 AWS Systems Manager User Guide Examples for registering maintenance window targets The new topic Examples: Register targets with a May 3, 2019 using the AWS CLI Updates to patch group topics May 1, 2019 maintenance window provides three sample commands to demonstra te diﬀerent ways you can specify the targets for a maintenance window when you use the AWS CLI. The topic also explains the best use case for each of the sample commands. The topic About patch groups has been updated to include a section on how managed instances determine the appropriate patch baseline to use during patching operation s. Additionally, instructions have been added for using the AWS CLI or Systems Manager console to add Patch Group or PatchGrou p tags to your managed instances, and how to add a Patch Group or PatchGrou p to a patch baseline. (You must use PatchGroup , without a space, if you have allowed tags in EC2 instance metadata.) For more information see Create a patch group and Add a patch group to a patch baseline. 3259 AWS Systems Manager User Guide New Parameter Store features Parameter Store oﬀers the following new features: April 25, 2019 • Advanced parameter s: Parameter Store now allows you to individua lly conﬁgure parameters to use either a standard- parameter tier (the default tier) or an advanced- parameter tier. Advanced parameters oﬀer a larger size quota for the parameter value, a higher quota for the number of parameters you can create per AWS account
systems-manager-ug-903	systems-manager-ug.pdf	903	if you have allowed tags in EC2 instance metadata.) For more information see Create a patch group and Add a patch group to a patch baseline. 3259 AWS Systems Manager User Guide New Parameter Store features Parameter Store oﬀers the following new features: April 25, 2019 • Advanced parameter s: Parameter Store now allows you to individua lly conﬁgure parameters to use either a standard- parameter tier (the default tier) or an advanced- parameter tier. Advanced parameters oﬀer a larger size quota for the parameter value, a higher quota for the number of parameters you can create per AWS account and AWS Region, and the ability to use parameter policies. For more information about advanced parameters, see About Systems Manager advanced parameters. • Parameter policies: Parameter policies help you manage a growing set of parameters by allowing you to assign speciﬁc criteria to a parameter, such as an expiration date or time to live. Parameter policies are especially helpful in forcing you to update or delete passwords and conﬁguration data stored in Parameter Store. Parameter 3260 AWS Systems Manager User Guide policies are only available for parameters that use the advanced-parameter tier. For more information, see Working with parameter policies. • Higher throughput: You can now increase the Parameter Store throughpu t quota to a maximum of 1,000 transactions per second. For more information, see Increasing Parameter Store throughpu t. Updates to the Automation section The Automation section has been updated for improved April 17, 2019 discoverability. In addition, three new topics have been added to the Automation section: • Run an automation step by step • Run an automation that requires approvals • Scheduling automatio ns with State Manager associations 3261 AWS Systems Manager User Guide Encrypt session data using an AWS KMS key By default, Session Manager uses TLS 1.2 to encrypt April 4, 2019 session data transmitted between the local machines of users in your account and your EC2 instances. Now you can choose to further encrypt that data using an AWS KMS key that has been created in AWS Key Management Service. You can use a KMS key that has been created in your AWS account or one that has been shared with you from another account. For information about specifying a KMS key to encrypt session data, see Turn on AWS KMS key encryption of session data (console), Create Session Manager preferences (AWS CLI), or Update Session Manager preferences (AWS CLI). Added instructions for using the AWS CLI or Systems Manager console to conﬁgure Amazon SNS notiﬁcations for Run Command and Run Command tasks registered to a maintenance window. For more information see Conﬁguring Amazon SNS notiﬁcations for AWS Systems Manager. March 6, 2019 3262 Conﬁguring Amazon SNS notiﬁcations for AWS Systems Manager AWS Systems Manager User Guide Advanced instances for servers and VMs in hybrid AWS Systems Manager oﬀers a standard-instances tier and March 4, 2019 environments an advanced-instances tier for servers and VMs in your hybrid environment. The standard-instances tier allows you to register a maximum of 1,000 servers or VMs per AWS account per AWS Region. If you need to register more than 1,000 servers or VMs in a single account and Region, then use the advanced- instances tier. You can create as many instances as you like in the advanced-instances tier, but all instances conﬁgure d for Systems Manager are available on a pay-per-use basis. Advanced instances also allow you to connect to your hybrid machines by using AWS Systems Manager Session Manager. Session Manager provides interactive shell access to your instances . For more information about allowing advanced instances , see Using the advanced- instances tier. 3263 AWS Systems Manager User Guide Create State Manager associations that use shared You can create State Manager associations that use SSM February 28, 2019 SSM documents Command and Automatio n runbooks shared from other AWS accounts. Creating associations by using shared SSM documents helps to keep your Amazon EC2 and hybrid infrastructure in a consisten t state even when instances aren't in the same account. For information about sharing SSM documents, see AWS Systems Manager Documents . For information about creating a State Manager association, see Create an association. View lists of Systems Manager events supported for Amazon The new topic Monitoring Systems Manager events with EventBridge rules Amazon EventBridge provides February 25, 2019 a summary of the various events emitted by Systems Manager for which you can set up event monitoring rules in EventBridge. 3264 AWS Systems Manager User Guide Add tags when you create Systems Manager resources Systems Manager now supports the ability to add February 24, 2019 tags to certain resource types when you create them. The resources you can tag when you create them with the AWS CLI or an SDK include maintenance windows, patch baselines, Parameter Store parameters,
systems-manager-ug-904	systems-manager-ug.pdf	904	Manager events supported for Amazon The new topic Monitoring Systems Manager events with EventBridge rules Amazon EventBridge provides February 25, 2019 a summary of the various events emitted by Systems Manager for which you can set up event monitoring rules in EventBridge. 3264 AWS Systems Manager User Guide Add tags when you create Systems Manager resources Systems Manager now supports the ability to add February 24, 2019 tags to certain resource types when you create them. The resources you can tag when you create them with the AWS CLI or an SDK include maintenance windows, patch baselines, Parameter Store parameters, and SSM documents. You can also assign tags to a managed instance when you create an activation for it. When you use the Systems Manager console, you can add tags to maintenance windows, patch baselines, and parameters. 3265 AWS Systems Manager User Guide Automatic IAM role creation for Systems Manager Previously you had to create an AWS Identity and Access February 14, 2019 Inventory Maintenance Windows walkthroughs to update SSM Agent Management (IAM) role and attach separate policies to this role to view inventory data on the Inventory Detail View page in the console. You no longer need to create this role or attach policies to it. When you choose a Remote Data Sync on the Inventory Detail View page, Systems Manager automatically creates the Amazon-GlueService role and PolicyForSSM assigns the Amazon-Gl ueServicePolicyForSSM-{S3 bucket name} policy and the AWSGlueServiceRole policy to it. For more information, see Querying inventory data from multiple Regions and accounts. Added two new walkthrou ghs to the Maintenance Windows documentation. The walkthroughs detail how to use the Systems Manager console or the AWS CLI to create a maintenance window that keeps SSM Agent up-to- date automatically. For more information, see Maintenance Windows walkthroughs. February 11, 2019 3266 AWS Systems Manager User Guide Using Parameter Store public parameters Added short section describin g Parameter Store public January 31, 2019 parameters. For more information, see Using Systems Manager public parameters. Use the AWS CLI to create Session Manager preferences Added instructions for using the AWS CLI to create Session January 22, 2019 Manager preferences, such as CloudWatch Logs, S3 bucket logging options, and session encryption settings. For more information, see Use the AWS CLI to create Session Manager preferences. Executing Systems Manager automation workﬂows by AWS Systems Manager State Manager now supports using State Manager creating associations that use January 22, 2019 SSM Automation runbooks. State Manager previously supported only command and policy documents , which meant that you could only create associati ons that targeted managed instances. With support for SSM Automation runbooks, you can now create associati ons that target diﬀerent types of AWS resources. For more information, see Executing Systems Manager Automatio n workﬂows by using State Manager. 3267 AWS Systems Manager User Guide Reference updates for cron and rate expressions The reference topic Cron and rate expressions for Systems December 6, 2018 and maintenance window Manager has been revised. scheduling options The new version provides more examples and improved explanations of how to use cron and rate expressions to schedule your maintenance windows and State Manager associations. In addition, the new topic Maintenan ce Windows scheduling and active period options explains how the various schedule- related options for maintenan ce windows (Start date, End date, Time zone, Schedule frequency) relate to one another. Turn on SSM Agent debug logging You can turn on SSM Agent debug logging by editing the November 30, 2018 seelog.xml.template ﬁle on the managed instance. For more information, see Turn on SSM Agent debug logging. 3268 AWS Systems Manager User Guide Support for ARM64 processor architectures AWS Systems Manager now supports ARM64 versions November 26, 2018 of the Amazon Linux 2, Red Hat Enterprise Linux 7.6, and Ubuntu Server (18.04 LTS and 16.04 LTS) operating systems. For more information, see the instructions for installin g Amazon Linux 2, RHEL, and Ubuntu Server 18.04 and 16.04 LTS with Snap packages. For more informati on about the A1 instance type, see General purpose instances in the Amazon EC2 User Guide. 3269 AWS Systems Manager User Guide Create and deploy packages by using AWS Systems Using AWS Systems Manager Distributor, you package your Manager Distributor own software—or ﬁnd AWS- November 20, 2018 provided agent software packages, such as AmazonClo udWatchAgent —to install on AWS Systems Manager managed instances. Distribut or publishes resources, such as software packages, to AWS Systems Manager managed instances. Publishing a package advertises speciﬁc versions of the package's document—a Systems Manager document that you create when you add the package in Distributor— to managed instances that you identify by managed instance IDs, AWS account IDs, tags, or an AWS Region. For more information, see AWS Systems ManagerDistributor. 3270 AWS Systems Manager User Guide Concurrently run AWS Systems Manager Automatio You
systems-manager-ug-905	systems-manager-ug.pdf	905	Manager Distributor own software—or ﬁnd AWS- November 20, 2018 provided agent software packages, such as AmazonClo udWatchAgent —to install on AWS Systems Manager managed instances. Distribut or publishes resources, such as software packages, to AWS Systems Manager managed instances. Publishing a package advertises speciﬁc versions of the package's document—a Systems Manager document that you create when you add the package in Distributor— to managed instances that you identify by managed instance IDs, AWS account IDs, tags, or an AWS Region. For more information, see AWS Systems ManagerDistributor. 3270 AWS Systems Manager User Guide Concurrently run AWS Systems Manager Automatio You can concurrently run AWS Systems Manager automatio n workﬂows across multiple n workﬂows across multiple AWS Regions and AWS AWS Regions and AWS accounts from a central accounts or AWS Organizat November 19, 2018 account ional Units (OUs) from an Automation managemen t account. Concurrently executing Automations in multiple Regions and accounts or OUs reduces the time required to administe r your AWS resources while enhancing the security of your computing environme nt. For more information see Executing Automation workﬂows in multiple AWS Regions and AWS accounts. Query inventory data from multiple AWS Regions and Systems Manager Inventory integrates with Amazon November 15, 2018 AWS accounts Athena to help you query inventory data from multiple AWS Regions and AWS accounts. Athena integrati on uses resource data sync so that you can view inventory data from all of your managed instances on the Inventory Detail View page in the AWS Systems Manager console. For more information see Querying Inventory data from multiple Regions and accounts. 3271 AWS Systems Manager User Guide Create State Manager associations that run MOF ﬁles November 15, 2018 You can run Managed Object Format (MOF) ﬁles to enforce a targeted state on Windows Server managed instances with State Manager by using the AWS-ApplyDSCMofs SSM document. The AWS- ApplyDSCMofs document has two execution modes. With the ﬁrst mode, you can conﬁgure the associati on to scan and report if the managed instances are currently in the targeted state deﬁned in the speciﬁed MOF ﬁles. In the second mode, you can run the MOF ﬁles and change the conﬁguration of your instances based on the resources and their values deﬁned in the MOF ﬁles. The AWS-ApplyDSCMofs document allows you to download and run MOF conﬁguration ﬁles from Amazon Simple Storage Service (Amazon S3), a local share, or from a secure web site with an HTTPS domain. For more information, see Creating associations that run MOF ﬁles. 3272 AWS Systems Manager User Guide Restrict administrative access in Session Manager sessions Session Manager sessions are launched using the credentia November 13, 2018 ls of a user account that is created with default root or administrator permissions called ssm-user. Informati on about restricting administr ative control for this account is now available in the topic Turn on or turn oﬀ ssm- user account administrative permissions. YAML examples in Automatio n actions reference The Automations actions reference now includes a October 31, 2018 YAML sample for each action that already includes a JSON sample. Assign compliance severity levels to associations You can now assign complianc e severity levels to State October 26, 2018 Manager associations. These severity levels are reported in the Compliance Dashboard and can also be used to ﬁlter your compliance reports. The severity levels you can assign include Critical, High, Medium, Low, and Unspeciﬁ ed. For more information, see Create an association (console). 3273 AWS Systems Manager User Guide Use targets and rate controls with Automation and State Control the execution of Automations and State October 23, 2018 Manager Manager associations across your ﬂeet of resources by using targets, concurrency, and error thresholds. For more information see Using targets and rate controls to run Automation workﬂows on a ﬂeet and Using targets and rate controls with State Manager associations. Specify active time ranges and international time zones You can also specify dates that a maintenance window for maintenance windows shouldn't run before or after October 9, 2018 (start date and end date), and you can specify the international time zone on which to base the maintenan ce window schedule. For more information see Create a maintenance window (console) and Update a maintenance window (AWS CLI). 3274 AWS Systems Manager User Guide Maintain a custom list of patches for your patch With the new 'InstallO verrideList' parameter in the baseline in an S3 bucket SSM command document October 5, 2018 AWS-RunPatchBaseli ne , you can specify an https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML format, overrides the patches speciﬁed by the default patch baseline. For more information, see Parameter name: InstallOv errideList. Expanded control over
systems-manager-ug-906	systems-manager-ug.pdf	906	a maintenance window (AWS CLI). 3274 AWS Systems Manager User Guide Maintain a custom list of patches for your patch With the new 'InstallO verrideList' parameter in the baseline in an S3 bucket SSM command document October 5, 2018 AWS-RunPatchBaseli ne , you can specify an https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML format, overrides the patches speciﬁed by the default patch baseline. For more information, see Parameter name: InstallOv errideList. Expanded control over whether patch dependencies Previously, if a patch in your Rejected patches list was October 5, 2018 are installed identiﬁed as a dependency of another patch, it would still be installed. Now you can choose whether to install these dependencies or block them from being installed . For more information, see Create a patch baseline. 3275 AWS Systems Manager User Guide Create dynamic automation workﬂows with conditional The aws:branch Automatio n action allows you to create September 26, 2018 branching a dynamic Automation workﬂow that evaluates multiple choices in a single step and then jumps to a diﬀerent step in the Automation runbook based on the results of that evaluation. For more information, see Using conditional statements in runbooks. Use the AWS CLI to update Session Manager preferences Instructions for using the CLI to update Session September 25, 2018 Manager preferences, such as CloudWatch Logs and S3 bucket logging options, have been added to the AWS Systems Manager User Guide. For information, see Use the AWS CLI to update Session Manager preferences. Session Manager now requires SSM Agent version 2.3.68.0 or later. For more informati on about Session Manager prerequisites, see Complete Session Manager prerequis ites. September 17, 2018 Updated SSM Agent requirement for Session Manager 3276 AWS Systems Manager User Guide Manage instances without opening inbound ports or Using Session Manager, a fully managed tool in AWS maintaining bastion hosts Systems Manager, you can using Session Manager manage your EC2 instances September 11, 2018 through an interactive one- click browser-based shell or through the AWS CLI. Session Manager provides secure and auditable instance management without the need to open inbound ports, maintain bastion hosts, or manage SSH keys. Session Manager also allows you to comply with corporate policies that require controlle d access to instances, strict security practices, and fully auditable logs with instance access details, while still providing end users with simple one-click cross-pla tform access to your EC2 instances. For more informati on, see Learn more about Session Manager. 3277 AWS Systems Manager User Guide Invoking other AWS services from a Systems Manager You can invoke other AWS services and other Systems Automation workﬂow Manager tools in your August 28, 2018 Automation workﬂow by using three new Automatio n actions (or plugins) in your Automation runbooks. For more information, see For more information, see Using action outputs as inputs. Use Systems Manager-speciﬁc condition keys in IAM policies The topic Specifying conditions in a policy has August 18, 2018 been updated to list the IAM condition keys for Systems Manager that you can incorporate in policies. You can use these keys to specify the conditions under which a policy should take eﬀect. The topic also includes links to example policies and other related topics. Aggregate inventory data with groups to see which Groups allow you to quickly see a count of which managed August 16, 2018 instances are and aren't conﬁgured to collect an inventory type instances are and aren’t conﬁgured to collect one or more Inventory types. With groups, you specify one or more Inventory types and a ﬁlter that uses the exists operator. For more informati on, see Aggregating Inventory data. 3278 AWS Systems Manager User Guide View history and change tracking for Inventory and You can now view history and change tracking for Inventory August 9, 2018 Conﬁguration Compliance collected from your managed instances. You can also viewing history and changing tracking for Patch Manager patching and State Manager associations reported by Conﬁguration Compliance. For more information, see Viewing Inventory history and change tracking. 3279 AWS Systems Manager User Guide Parameter Store integrates with Secrets Manager Parameter Store is now integrated with AWS Secrets July 26, 2018 Manager so that you can retrieve Secrets Manager secrets when using other AWS services that already support references to Parameter Store parameters. These services include Amazon EC2, Amazon Elastic Container Service, AWS Lambda, AWS CloudForm ation, AWS CodeBuild, AWS CodeDeploy, and other Systems Manager tools. By using Parameter Store to reference Secrets Manager secrets, you create a consisten t and secure process for calling and using secrets and reference data in your code and conﬁguration scripts. For information, see Referenci ng AWS Secrets Manager secrets from Parameter Store parameters.
systems-manager-ug-907	systems-manager-ug.pdf	907	Parameter Store is now integrated with AWS Secrets July 26, 2018 Manager so that you can retrieve Secrets Manager secrets when using other AWS services that already support references to Parameter Store parameters. These services include Amazon EC2, Amazon Elastic Container Service, AWS Lambda, AWS CloudForm ation, AWS CodeBuild, AWS CodeDeploy, and other Systems Manager tools. By using Parameter Store to reference Secrets Manager secrets, you create a consisten t and secure process for calling and using secrets and reference data in your code and conﬁguration scripts. For information, see Referenci ng AWS Secrets Manager secrets from Parameter Store parameters. 3280 AWS Systems Manager User Guide Attach labels to Parameter Store parameters A parameter label is a user- deﬁned alias to help you July 26, 2018 manage diﬀerent versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increment s the version number by one. A label can help you remember the purpose of a parameter version when there are multiple versions. For information, see Labeling parameters. Create dynamic Automation workﬂows By default, the steps (or actions) that you deﬁne in July 18, 2018 the mainSteps section of an Automation runbook run in sequential order. After one action is complete, the next action speciﬁed in the mainSteps section begins. With this release, you can now create Automation workﬂows that perform conditional branching. This means that you can create Automation workﬂows that dynamically respond to condition changes and jump to a speciﬁed step. For information, see Using conditional statements in runbooks. 3281 AWS Systems Manager User Guide SSM Agent now pre-installed on Ubuntu Server 16.04 AMIs Beginning with instances created from Ubuntu Server July 7, 2018 using Snap 16.04 AMIs identiﬁed with 20180627, the SSM Agent is pre-installed using Snap packages. On instances created from earlier AMIs, you should continue using deb installer packages. For information, see About SSM Agent installations on 64- bit Ubuntu Server 16.04 instances. Review minimum S3 permissions required by SSM The new topic Minimum S3 bucket permissions for SSM July 5, 2018 Agent View complete execution history for a speciﬁc State Manager association ID Agent provides information about the Amazon Simple Storage Service (Amazon S3) buckets that resources might need to access to perform Systems Manager operations. You can specify these buckets in a custom policy if you want to limit S3 bucket access for an instance proﬁle or VPC endpoint to the minimum required to use Systems Manager. The new topic Viewing association histories describes how to view all executions for a speciﬁc association ID and then view execution details for one or more resources. July 2, 2018 3282 AWS Systems Manager User Guide Patch Manager introduces support for Amazon Linux 2 You can now use Patch Manager to apply patches June 26, 2018 to Amazon Linux 2 instances . For general informati on about Patch Manager operating system support, see Patch Manager prerequis ites. For information about the supported key-value pairs for Amazon Linux 2 when deﬁning a patch ﬁlter, see PatchFilter in the AWS Systems Manager API Reference. The new topic Conﬁguring Amazon CloudWatch Logs for Run Command describes how to send Run Command output to CloudWatch Logs. June 18, 2018 Send command output to Amazon CloudWatch Logs 3283 AWS Systems Manager User Guide Quickly create or delete resource data sync for You can use AWS CloudForm ation to create or delete June 11, 2018 Inventory by using AWS a resource data sync for CloudFormation Systems Manager Inventory . To use AWS CloudForm ation, add the AWS::SSM: :ResourceDataSync resource to your AWS CloudFormation template. For more informati on, see Working with AWS CloudFormation Templates in the AWS CloudFormation User Guide. You can also manually create a resource data sync for Inventory as described in Creating a resource data sync for Inventory. AWS Systems Manager User Guide update notiﬁcations The HTML version of the Systems Manager User now available through RSS Guide now supports an RSS June 6, 2018 feed of updates that are documented in the Systems Manager Documentation update history page. The RSS feed includes updates made in June, 2018, and later. Previously announced updates are still available in the Systems Manager documentation update history page. Use the RSS button in the top menu panel to subscribe to the feed. 3284 AWS Systems Manager User Guide Specify an exit code in scripts to reboot managed instances The new topic Rebooting managed instances from June 3, 2018 scripts describes how to instruct Systems Manager to reboot managed instances by specifying an exit code in scripts that you run with Run Command. Create an event in Amazon EventBridge whenever The new topic Viewing inventory delete actions custom inventory is deleted in EventBridge describes June 1, 2018 how to conﬁgure Amazon EventBridge to create an event anytime a
systems-manager-ug-908	systems-manager-ug.pdf	908	page. Use the RSS button in the top menu panel to subscribe to the feed. 3284 AWS Systems Manager User Guide Specify an exit code in scripts to reboot managed instances The new topic Rebooting managed instances from June 3, 2018 scripts describes how to instruct Systems Manager to reboot managed instances by specifying an exit code in scripts that you run with Run Command. Create an event in Amazon EventBridge whenever The new topic Viewing inventory delete actions custom inventory is deleted in EventBridge describes June 1, 2018 how to conﬁgure Amazon EventBridge to create an event anytime a user deletes custom Inventory. Updates prior to June 2018 The following table describes important changes in each release of the AWS Systems Manager User Guide before June 2018. Change Description Inventory all managed instances in your AWS account You can inventory all managed instances in your AWS account by creating a global inventory association. For more information, see Inventory all managed nodes in your AWS account. Note Global inventory associations are available in SSM Agent version 2.0.790.0 or later. For informati on about how to update SSM Agent on your Release date May 3, 2018 Updates prior to June 2018 3285 AWS Systems Manager Change Description User Guide Release date instances, see Updating the SSM Agent using Run Command. SSM Agent installed by default on SSM Agent is installed, by default, on Ubuntu Server 18.04 LTS 64-bit and 32-bit AMIs. May 2, 2018 Ubuntu Server 18 New topic The new topic Running commands using a speciﬁc document version describes how to use the document- version parameter to specify which version of an SSM document to use when the command runs. May 1, 2018 New topic The new topic Deleting custom inventory describes how to delete custom Inventory data from Amazon S3 April 19, 2018 by using the AWS CLI. The topic also describes how to use the SchemaDeleteOption inventory by turning oﬀ or deleting a custom inventory to manage custom type. This new feature uses the DeleteInventory API operation. Amazon SNS notiﬁcations for You can subscribe to an Amazon SNS topic to receive notiﬁcations when a new version of SSM Agent is April 9, 2018 SSM Agent available. For more information, see Subscribing to SSM Agent notiﬁcations. CentOS patching support Systems Manager now supports patching CentOS instances. For information about supported CentOS versions, see Patch Manager prerequisites. For more information about how patching works, see How Patch Manager operations work. March 29, 2018 Updates prior to June 2018 3286 AWS Systems Manager Change Description User Guide Release date New section To provide a single source for reference information in the AWS Systems Manager User Guide, a new section March 15, 2018 has been introduced, AWS Systems Manager reference . Additional content will be added to this section as it becomes available. New topic The new topic Package name formats for approved and rejected patch lists details the package name formats you March 9, 2018 can enter in the lists of approved patches and rejected patches for a custom patch baseline. Sample formats are provided for each operating system type supported by Patch Manager. New topic Systems Manager now integrates with ChefChef InSpec. InSpec is an open-source, runtime framework that allows March 7, 2018 you to create human-readable proﬁles on GitHub or Amazon S3. Then you can use Systems Manager to run compliance scans and view compliant and noncompliant instances. For more information, see Using Chef InSpec proﬁles with Systems Manager Compliance. New topic The new topic Using service-linked roles for Systems Manager describes how to use an AWS Identity and Access February 27, 2018 Management (IAM) service-linked role with Systems Manager. Currently, service-linked roles are only required when using Systems Manager Inventory to collect metadata about tags and Resource Groups. Updates prior to June 2018 3287 AWS Systems Manager Change Description User Guide Release date New and updated topics You can now use Patch Manager to install patches that are in a diﬀerent source repository than the default one February 6, 2018 conﬁgured on the instance. This is useful for patching instances with updates not related to security; with the content of Personal Package Archives (PPA) for Ubuntu Server; with updates for internal corporate applications; and so on. You specify alternative patch source repositor ies when you create a custom patch baseline. For more information, see the following topics: • How to specify an alternative patch source repository (Linux) • Working with custom patch baselines • Create a patch baseline with custom repositories for diﬀerent OS versions In addition, you can now use Patch Manager to patch SUSE Linux Enterprise Server instances. Patch Manager supports patching SLES 12.* versions (64-bit only). For more information, see the SLES-speciﬁc information in the following topics: • How security patches are selected • How
systems-manager-ug-909	systems-manager-ug.pdf	909	updates for internal corporate applications; and so on. You specify alternative patch source repositor ies when you create a custom patch baseline. For more information, see the following topics: • How to specify an alternative patch source repository (Linux) • Working with custom patch baselines • Create a patch baseline with custom repositories for diﬀerent OS versions In addition, you can now use Patch Manager to patch SUSE Linux Enterprise Server instances. Patch Manager supports patching SLES 12.* versions (64-bit only). For more information, see the SLES-speciﬁc information in the following topics: • How security patches are selected • How patches are installed • How patch baseline rules work on SUSE Linux Enterpris e Server New topic The new topic SSM Command documents for patching managed nodes describes the seven SSM documents available to help you keep your managed instances patched with the latest security-related updates. January 10, 2018 Updates prior to June 2018 3288 AWS Systems Manager Change Description Important updates regarding Linux support Updated various topics with the following information: • SSM Agent is installed, by default, on Amazon Linux 1 base AMIs dated 2017.09 and later. • Manually install SSM Agent on other versions of Linux, including non-base images like Amazon ECS-Optimized AMIs. New topic A new topic, SSM Command document for patching: AWS-RunPatchBaseline , provides details of how this SSM document operates on both Windows and Linux systems. It also provides information about the two available parameters in the AWS-RunPatchBaseline document, Operation and Snapshot ID. User Guide Release date January 9, 2018 January 5, 2018 New topics A new section, How Patch Manager operations work, provides technical details that explain how Patch Manager January 2, 2018 determines which security patches to install and how it installs them on each supported operating system. It also provides information about how patch baseline rules work on diﬀerent distributions of the Linux operating system Retitled and moved the Systems Based on customer feedback, the Automation actions reference is now called the Systems Manager Automation December 20, 2017 Manager Automatio runbook reference. Furthermore, we moved the reference n Actions Reference into the Shared Resources > Documents node so it is closer to the Command document plugin reference. For more information, see Systems Manager Automation actions reference. Updates prior to June 2018 3289 AWS Systems Manager Change Description User Guide Release date New Monitorin g chapter and A new chapter, Logging and monitoring in AWS Systems Manager, provides instructions for sending metrics and December 14, 2017 content log data to Amazon CloudWatch Logs. A new topic, Sending node logs to uniﬁed CloudWatch Logs (CloudWat ch agent), provides instructions for migrating on-instan ce monitoring tasks, on 64-bit Windows Server instances only, from SSM Agent to the CloudWatch agent. New chapter A new chapter, Identity and access management for AWS Systems Manager, provides comprehensive informati December 11, 2017 on about using AWS Identity and Access Management (IAM) and AWS Systems Manager to help secure access to your resources through the use of credentials. These credentials provide the permissions required to access AWS resources, such as accessing data stored in S3 buckets and sending commands to and reading the tags on EC2 instances. Changes to the left navigation We changed the headings in the left navigation of this user guide to match the headings in the new AWS December 8, 2017 Systems Manager console. Multiple changes for re:Invent 2017 • Oﬃcial launch of AWS Systems Manager: AWS Systems Manager (formerly Amazon EC2 Systems November 29, 2017 Manager) is a uniﬁed interface that allows you to centralize operational data and automate tasks across your AWS resources. You can access the new AWS Systems Manager console here. For more information, see What is AWS Systems Manager? • YAML Support: You can create SSM documents in YAML. For more information, see AWS Systems Manager Documents. Updates prior to June 2018 3290 AWS Systems Manager Change Description User Guide Release date Using Run Command to Using Run Command, you can take application-consis tent snapshots of all Amazon Elastic Block Store (Amazon November 20, 2017 Take VSS-Enabled EBS) volumes attached to your Amazon EC2 Windows Snapshots of EBS instances. The snapshot process uses the Windows Volumes Volume Shadow Copy Service (VSS) to take image-level backups of VSS-aware applications, including data from pending transactions between these applications and the disk. Furthermore, you don't need to shut down your instances or disconnect them when you need to back up all attached volumes. For more information, see Take Microsoft VSS-Enabled Snapshots Using AWS Systems Manager in the Amazon EC2 User Guide. Enhanced Systems Manager Security You can improve the security posture of your managed instances (including managed instances in your hybrid November 7, 2017 Available By Using environment) by conﬁguring Systems Manager to use VPC Endpoints an interface VPC endpoint. Interface endpoints are
systems-manager-ug-910	systems-manager-ug.pdf	910	(VSS) to take image-level backups of VSS-aware applications, including data from pending transactions between these applications and the disk. Furthermore, you don't need to shut down your instances or disconnect them when you need to back up all attached volumes. For more information, see Take Microsoft VSS-Enabled Snapshots Using AWS Systems Manager in the Amazon EC2 User Guide. Enhanced Systems Manager Security You can improve the security posture of your managed instances (including managed instances in your hybrid November 7, 2017 Available By Using environment) by conﬁguring Systems Manager to use VPC Endpoints an interface VPC endpoint. Interface endpoints are powered by PrivateLink, a technology that allows you to privately access Amazon EC2 and Systems Manager APIs by using private IP addresses. PrivateLink restricts all network traﬃc between your managed instances, Systems Manager, and EC2 to the Amazon network (managed instances don't have access to the Internet). Also, you don't need an Internet gateway, a NAT device, or a virtual private gateway. For more information, see Improve the security of EC2 instances by using VPC endpoints for Systems Manager. Updates prior to June 2018 3291 AWS Systems Manager Change Description User Guide Release date Inventory Support for Files, Services, SSM Inventory now supports gathering the following information from your managed instances. November 6, 2017 Windows Roles, and the Windows Registry • Files: Name, size, version, installed date, modiﬁcation and last accessed times, and so on. • Services: Name, display name, status, dependent services, service type, start type, and so on. • Windows Registry: Registry key path, value name, value type, and value. • Windows roles: Name, display name, path, feature type, installed state, and so on. Before you attempt to collect information for these inventory types, update SSM Agent on the instances you want to inventory. By running the latest version of SSM Agent, you ensure that you can collect metadata for all supported inventory types. For information about how to update SSM Agent by using State Manager, see Walkthrou gh: Automatically update SSM Agent with the AWS CLI. For more information Inventory, see Learn more about Systems Manager Inventory. Updates to Automation documentation Fixed several issues in the information about setting up and conﬁguring access for Systems Manager Automation. For more information, see Setting up Automation. October 31, 2017 Updates prior to June 2018 3292 AWS Systems Manager Change Description User Guide Release date GitHub and Amazon S3 Integration Run remote scripts: Systems Manager now supports downloading and running scripts from a private or public October 26, 2017 GitHub repository, and from Amazon S3. Using either the AWS-RunRemoteScript pre-deﬁned SSM document or the aws:downloadContent plugin in a custom SSM document, you can run Ansible Playbooks and scripts in Python, Ruby, or PowerShell, to name a few. These changes further enhance infrastructure as code when you use Systems Manager to automate conﬁguration and deployment of EC2 instances and on-premises managed instances in your hybrid environment. For more informati on, see Running scripts from GitHub and Running scripts from Amazon S3. Create composite SSM documents: Systems Manager now supports running one or more secondary SSM documents from a primary SSM document. These primary documents that run other documents are called composite documents. Composite documents allow you to create and share a standard set of secondary SSM documents across AWS accounts for common tasks such as boot-stra pping anti-virus software or domain-joining instances. You can run composite and secondary documents stored in Systems Manager, GitHub, or Amazon S3. After you create a composite document, you can run it by using the AWS-RunDocument pre-deﬁned SSM document. For more information, see Creating composite documents and Running documents from remote locations. SSM document plugin reference: For easier access, we moved the SSM Plugin Reference for SSM documents out of the Systems Manager API Reference and into the User Guide. For more information, see Command document plugin reference. Updates prior to June 2018 3293 AWS Systems Manager Change Description User Guide Release date Support for Parameter Versions When you edit a parameter, Parameter Store now automatically iterates the version number by 1. You can October 24, 2017 in Parameter Store specify a parameter name and a speciﬁc version number in API calls and SSM documents. If you don't specify a version number, the system automatically uses the latest version. Parameter versions provide a layer of protection in the event that a parameter is accidentally changed. You can view the values of all versions, and reference older versions if necessary. You can also use parameter versions to see how many times a parameter changed over a period of time. For more information, see Working with parameter versions in Parameter Store. Support for Tagging Systems You can now use the AddTagsToResource API, the AWS CLI, or the AWS Tools for PowerShell to tag Systems October 3, 2017 Manager
systems-manager-ug-911	systems-manager-ug.pdf	911	you don't specify a version number, the system automatically uses the latest version. Parameter versions provide a layer of protection in the event that a parameter is accidentally changed. You can view the values of all versions, and reference older versions if necessary. You can also use parameter versions to see how many times a parameter changed over a period of time. For more information, see Working with parameter versions in Parameter Store. Support for Tagging Systems You can now use the AddTagsToResource API, the AWS CLI, or the AWS Tools for PowerShell to tag Systems October 3, 2017 Manager Documents Manager documents with key-value pairs. Tagging helps you quickly identify speciﬁc resources based on the tags you've assigned to them. This is in addition to existing tagging support for managed instances, maintenan ce windows, Parameter Store parameters, and patch baselines. Updates prior to June 2018 3294 User Guide Release date October 2, 2017 AWS Systems Manager Change Description Various Documenta tion Updates to Fix • Updated Managing nodes in hybrid and multicloud environments with Systems Manager with information Errors or Update for Raspbian Linux. Content Based on Feedback • Updated Managing EC2 instances with Systems Manager with new requirement for Windows Server instances. SSM Agent requires Windows PowerShell 3.0 or later to run certain SSM Documents on Windows Server instances (for example, the legacy AWS-Apply SSM document). Verify that PatchBaseline your Windows Server instances are running Windows Management Framework 3.0 or later. The framework includes PowerShell. For more information, see Windows Management Framework 3.0. Troubleshoot Unreachable EC2Rescue can help you diagnose and troubleshoot problems on Amazon EC2 Windows Server instances. September 29, 2017 Windows Instances by Using the EC2Rescue Automation Workﬂow You can run the tool as a Systems Manager Automation workﬂow by using the AWSSupport-ExecuteEC2Rescue document. The AWSSupport-ExecuteEC2Rescue document is designed to perform a combination of Systems Manager actions, AWS CloudFormation actions, and Lambda functions that automate the steps normally required to use EC2Rescue. For more information, see Run the EC2Rescue tool on unreachable instances. SSM Agent Installed By Default on Amazon Linux SSM Agent is installed, by default, on Amazon Linux AMIs dated 2017.09 and later. Manually install SSM Agent on other versions of Linux, as described in Working with SSM Agent on EC2 instances for Linux. September 27, 2017 Updates prior to June 2018 3295 User Guide Release date September 12, 2017 AWS Systems Manager Change Description Run Command Enhancements Run Command includes the following enhancements. • You can restrict command execution to speciﬁc instances by creating and assigning an IAM policy that includes a condition that the user can only run commands on instances that are tagged with speciﬁc Amazon EC2 tags. For more information, see Restricting Run Command access based on tags. • You have more options for targeting instances by using Amazon EC2 tags. You can now specify multiple tag keys and multiple tag values when sending commands. For more information, see Run commands at scale. Systems Manager Supported on Systems Manager can now run on Raspbian Jessie and Raspbian Stretch devices, including Raspberry Pi (32-Bit). September 7, 2017 Raspbian Automatically Send SSM Agent Logs to You can now make a simple conﬁguration change on your instances to have SSM Agent send log ﬁles to CloudWatc September 7, 2017 Amazon CloudWatc h. For more information, see Sending SSM Agent logs to h Logs CloudWatch Logs. Encrypt resource data sync With Systems Manager resource data sync, you can aggregate Inventory data collected on dozens or September 1, 2017 hundreds of managed instance in a central S3 bucket. You can now encrypt resource data sync by using an AWS Key Management Service key. For more information, see Walkthrough: Using resource data sync to aggregate inventory data. Updates prior to June 2018 3296 AWS Systems Manager Change Description User Guide Release date New State Manager Walkthroughs Added two new walkthroughs to the State Manager documentation: August 31, 2017 Walkthrough: Automatically update SSM Agent with the AWS CLI Walkthrough: Automatically update PV drivers on EC2 instances for Windows Server Systems Manager Conﬁguration Use Conﬁguration Compliance to scan your ﬂeet of managed instances for patch compliance and conﬁgura August 28, 2017 Compliance tion inconsistencies. You can collect and aggregate data from multiple AWS accounts and AWS Regions, and then drill down into speciﬁc resources that aren’t compliant. By default, Conﬁguration Compliance displays complianc e data about Patch Manager patching and State Manager associations. You can also customize the service and create your own compliance types based on your IT or business requirements. For more information, see AWS Systems Manager Compliance. New Automation Action: aws:execu Runs a secondary Automation workﬂow by calling a secondary Automation runbook. With this action, you August 22, 2017 teAutomation can create Automation runbooks for your most common workﬂows, and reference those documents during an
systems-manager-ug-912	systems-manager-ug.pdf	912	aggregate data from multiple AWS accounts and AWS Regions, and then drill down into speciﬁc resources that aren’t compliant. By default, Conﬁguration Compliance displays complianc e data about Patch Manager patching and State Manager associations. You can also customize the service and create your own compliance types based on your IT or business requirements. For more information, see AWS Systems Manager Compliance. New Automation Action: aws:execu Runs a secondary Automation workﬂow by calling a secondary Automation runbook. With this action, you August 22, 2017 teAutomation can create Automation runbooks for your most common workﬂows, and reference those documents during an Automation execution. This action can simplify your Automation runbooks by removing the need to duplicate steps across similar runbooks. For more information, see aws:executeAutomation – Run another automation. Updates prior to June 2018 3297 AWS Systems Manager Change Description User Guide Release date Automation as the Target of a You can start an Automation workﬂow by specifying an Automation runbook as the target of an Amazon August 21, 2017 CloudWatch Event CloudWatch event. You can start workﬂows according to a schedule, or when a speciﬁc AWS system event occurs. For more information, see Run automations based on EventBridge events. State Manager Association You can now create diﬀerent State Manager associati on versions. There is a quota of 1,000 versions for August 21, 2017 Versioning and each association. You can also specify names for your General Updates associations. Also, the State Manager documentation has been updated to address outdated information and inconsistencies. For more information, see AWS Systems Manager State Manager. Updates prior to June 2018 3298 AWS Systems Manager Change Description User Guide Release date Changes to Maintenance Windows Maintenance Windows include the following changes or enhancements: August 16, 2017 • Previously, Maintenance Windows could only perform tasks by using Run Command. You can now perform tasks by using Systems Manager Automation, AWS Lambda, and AWS Step Functions. • You can edit the targets of a maintenance window, specify a target name, description, and owner. • You can edit tasks in a maintenance window, including specifying a new SSM document for Run Command and Automation tasks. • All Run Command parameters are now supported , including DocumentHash, DocumentHashType, TimeoutSeconds, Comment, and NotiﬁcationConﬁg. • You can now use a safe ﬂag when you attempt to deregister a target. If turned on, the system returns an error if the target is referenced by any task. For more information, see AWS Systems Manager Maintenance Windows. New Automation Action: aws:appro ve This new action for Automation runbooks temporari ly pauses an Automation execution until designated principals either approve or reject the action. After the required number of approvals is reached, the Automation execution resumes. August 10, 2017 For more information, see Systems Manager Automation actions reference. Updates prior to June 2018 3299 AWS Systems Manager Change Description User Guide Release date Automation assume role no longer Automation previously required that you specify a service role (or assume role) so that the service had permission August 3, 2017 required to perform actions on your behalf. Automation no longer requires this role because the service now operates by using the context of the user who invoked the execution. However, the following situations still require that you specify a service role for Automation: • When you want to restrict a user's permissions on a resource, but you want the user to run an Automatio n workﬂow that requires elevated permissions. In this scenario, you can create a service role with elevated permissions and allow the user to run the workﬂow. • Operations that you expect to run longer than 12 hours require a service role. For more information, see Setting up Automation. Conﬁguration Compliance Use Amazon EC2 Systems Manager Conﬁguration Compliance to scan your ﬂeet of managed instances August 8, 2017 for patch compliance and conﬁguration inconsistencies. You can collect and aggregate data from multiple AWS accounts and AWS Regions, and then drill down into speciﬁc resources that aren’t compliant. For more information, see AWS Systems Manager Compliance. Updates prior to June 2018 3300 AWS Systems Manager Change Description User Guide Release date SSM Document Enhancements SSM Command and Policy documents now oﬀer cross-pla tform support. This means that a single SSM document July 12, 2017 can process plugins for Windows and Linux operating systems. Cross-platform support allows you to consolida te the number of documents you manage. Cross-platform support is oﬀered in SSM documents that use schema version 2.2 or later. SSM Command documents that use schema version 2.0 or later can now include multiple plugins of the same type. For example, you can create a Command document that calls the aws:runRunShellScript times. plugin multiple For more information about schema version 2.2 changes, see AWS Systems Manager documents. For more information about SSM plugins, see Command
systems-manager-ug-913	systems-manager-ug.pdf	913	means that a single SSM document July 12, 2017 can process plugins for Windows and Linux operating systems. Cross-platform support allows you to consolida te the number of documents you manage. Cross-platform support is oﬀered in SSM documents that use schema version 2.2 or later. SSM Command documents that use schema version 2.0 or later can now include multiple plugins of the same type. For example, you can create a Command document that calls the aws:runRunShellScript times. plugin multiple For more information about schema version 2.2 changes, see AWS Systems Manager documents. For more information about SSM plugins, see Command document plugin reference. Updates prior to June 2018 3301 AWS Systems Manager Change Description Linux Patching Patch Manager can now patch the following Linux distributions: User Guide Release date July 6, 2017 64-bit and 32-bit systems • Amazon Linux 2014.03, 2014.09, or later • Ubuntu Server 16.04 LTS, 14.04 LTS, or 12.04 LTS • Red Hat Enterprise Linux (RHEL) 6.5 or later 64-bit systems only • Amazon Linux 2015.03, 2015.09, or later • Red Hat Enterprise Linux (RHEL) 7.x or later For more information, see AWS Systems Manager Patch Manager. Note • To patch Linux instances, your instances must be running SSM Agent version 2.0.834.0 or later. For information about updating the agent, see the section titled Example: Update SSM Agent in Running commands from the console. • The AWS-ApplyPatchBaseline SSM document is being replaced by the AWS-RunPa tchBaseline document. Updates prior to June 2018 3302 AWS Systems Manager Change Description User Guide Release date Resource data sync You can use Systems Manager resource data sync to send Inventory data collected from all of your managed June 29, 2017 instances to a single Amazon S3 bucket. Resource data sync then automatically updates the centralized data when new Inventory data is collected. With all Inventory data stored in a target S3 bucket, you can use services like Amazon Athena and Amazon QuickSight to query and analyze the aggregated data.For more information, see Creating a resource data sync for Inventory. For an example of how to work with resource data sync, see Walkthrough: Using resource data sync to aggregate inventory data. Systems Manager Parameter Hierarchi Managing dozens or hundreds of Systems Manager parameters as a ﬂat list is time-consuming and prone June 22, 2017 es to errors. You can use parameter hierarchies to help you organize and manage Systems Manager parameters. A hierarchy is a parameter name that includes a path that you deﬁne by using forward slashes. Here is an example that uses three hierarchy levels in the name to identify the following: /Environment/Type of computer/Application/Data /Dev/DBServer/MySQL/db-string13 For more information, see Working with parameter hierarchies in Parameter Store. SSM Agent Support for SUSE Linux Enterprise Server You can install SSM Agent on 64-bit SUSE Linux Enterpris e Server (SLES). For more information, see Working with SSM Agent on EC2 instances for Linux. June 14, 2017 Updates prior to June 2018 3303 AWS Systems Manager User Guide Document conventions The following are common typographical conventions for the AWS Systems Manager User Guide. Diﬀerentiated examples for local operating systems or command line languages We use tabs to present diﬀerent examples of commands based on a user's local operating system type. For Linux and macOS examples, we use the backslash (\ ) character to break long commands into multiple lines. For Windows Server examples, we use the caret (^) character to break commands into multiple lines. Example: Linux & macOS aws ssm update-service-setting \ --setting-id arn:aws:ssm:region:aws-account-id:servicesetting/ssm/managed- instance/activation-tier \ --setting-value advanced Windows aws ssm update-service-setting ^ --setting-id arn:aws:ssm:region:aws-account-id:servicesetting/ssm/managed- instance/activation-tier ^ --setting-value advanced Elements in the user interface Formatting: Text in bold Example: Choose File, Properties. User input (text that a user types) Formatting: Text in a monospace font Example: For the name, type my-new-resource. Placeholder text for a required value Formatting: Text in italics 3304 AWS Systems Manager Example: User Guide aws ec2 register-image --image-location amzn-s3-demo-bucket/image.manifest.xml 3305
ta-api-001	ta-api.pdf	1	API Reference AWS Trusted Advisor API Version 2022-09-15 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS Trusted Advisor API Reference AWS Trusted Advisor: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS Trusted Advisor Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 BatchUpdateRecommendationResourceExclusion ................................................................................. 3 Request Syntax ........................................................................................................................................ 3 URI Request Parameters ........................................................................................................................ 3 Request Body ........................................................................................................................................... 3 Response Syntax ...................................................................................................................................... 4 Response Elements ................................................................................................................................. 4 Errors .......................................................................................................................................................... 4 Examples ................................................................................................................................................... 5 See Also ..................................................................................................................................................... 6 GetOrganizationRecommendation ............................................................................................................ 7 Request Syntax ........................................................................................................................................ 7 URI Request Parameters ........................................................................................................................ 7 Request Body ........................................................................................................................................... 7 Response Syntax ...................................................................................................................................... 7 Response Elements ................................................................................................................................. 8 Errors .......................................................................................................................................................... 8 Examples ................................................................................................................................................... 9 See Also .................................................................................................................................................. 10 GetRecommendation ................................................................................................................................. 12 Request Syntax ...................................................................................................................................... 12 URI Request Parameters ...................................................................................................................... 12 Request Body ......................................................................................................................................... 12 Response Syntax ................................................................................................................................... 12 Response Elements ............................................................................................................................... 13 Errors ....................................................................................................................................................... 13 Examples ................................................................................................................................................. 14 See Also .................................................................................................................................................. 15 ListChecks ..................................................................................................................................................... 17 Request Syntax ...................................................................................................................................... 17 URI Request Parameters ...................................................................................................................... 17 Request Body ......................................................................................................................................... 18 Response Syntax ................................................................................................................................... 18 API Version 2022-09-15 iii AWS Trusted Advisor API Reference Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 19 Examples ................................................................................................................................................. 20 See Also .................................................................................................................................................. 22 ListOrganizationRecommendationAccounts ......................................................................................... 24 Request Syntax ...................................................................................................................................... 24 URI Request Parameters ...................................................................................................................... 24 Request Body ......................................................................................................................................... 25 Response Syntax ................................................................................................................................... 25 Response Elements ............................................................................................................................... 25 Errors ....................................................................................................................................................... 26 Examples ................................................................................................................................................. 26 See Also .................................................................................................................................................. 27 ListOrganizationRecommendationResources ........................................................................................ 28 Request Syntax ...................................................................................................................................... 28 URI Request Parameters ...................................................................................................................... 28 Request Body ......................................................................................................................................... 29 Response Syntax ................................................................................................................................... 29 Response Elements ............................................................................................................................... 30 Errors ....................................................................................................................................................... 30 Examples ................................................................................................................................................. 31 See Also .................................................................................................................................................. 33 ListOrganizationRecommendations ........................................................................................................ 34 Request Syntax ...................................................................................................................................... 34 URI Request Parameters ...................................................................................................................... 34 Request Body ......................................................................................................................................... 35 Response Syntax ................................................................................................................................... 35 Response Elements ............................................................................................................................... 36 Errors ....................................................................................................................................................... 37 Examples ................................................................................................................................................. 37 See Also .................................................................................................................................................. 41 ListRecommendationResources ............................................................................................................... 42 Request Syntax ...................................................................................................................................... 42 URI Request Parameters ...................................................................................................................... 42 Request Body ......................................................................................................................................... 43 Response Syntax ................................................................................................................................... 43 API Version 2022-09-15 iv AWS Trusted Advisor API Reference Response Elements ............................................................................................................................... 43 Errors ....................................................................................................................................................... 44 Examples ................................................................................................................................................. 45 See Also .................................................................................................................................................. 47 ListRecommendations ............................................................................................................................... 48 Request Syntax ...................................................................................................................................... 48 URI Request Parameters ...................................................................................................................... 48 Request Body ......................................................................................................................................... 49 Response Syntax ................................................................................................................................... 49 Response Elements ............................................................................................................................... 50 Errors ....................................................................................................................................................... 51 Examples ................................................................................................................................................. 51 See Also .................................................................................................................................................. 55 UpdateOrganizationRecommendationLifecycle ................................................................................... 57 Request Syntax ...................................................................................................................................... 57 URI Request Parameters ...................................................................................................................... 57 Request Body ......................................................................................................................................... 57 Response Syntax ................................................................................................................................... 58 Response Elements ............................................................................................................................... 58 Errors ....................................................................................................................................................... 58 Examples ................................................................................................................................................. 59 See Also .................................................................................................................................................. 60 UpdateRecommendationLifecycle ........................................................................................................... 61 Request Syntax ...................................................................................................................................... 61 URI Request Parameters ...................................................................................................................... 61 Request Body ......................................................................................................................................... 61 Response Syntax ................................................................................................................................... 62 Response Elements ............................................................................................................................... 62 Errors ....................................................................................................................................................... 62 Examples ................................................................................................................................................. 63 See Also .................................................................................................................................................. 64 Data Types ..................................................................................................................................... 65 AccountRecommendationLifecycleSummary ........................................................................................ 66 Contents .................................................................................................................................................. 66 See Also .................................................................................................................................................. 68 CheckSummary ........................................................................................................................................... 69 API Version 2022-09-15 v AWS Trusted Advisor API Reference Contents .................................................................................................................................................. 69 See Also .................................................................................................................................................. 70 OrganizationRecommendation ................................................................................................................ 72 Contents .................................................................................................................................................. 72 See Also .................................................................................................................................................. 76 OrganizationRecommendationResourceSummary .............................................................................. 77 Contents .................................................................................................................................................. 77 See Also .................................................................................................................................................. 79 OrganizationRecommendationSummary .............................................................................................. 80 Contents .................................................................................................................................................. 80 See Also .................................................................................................................................................. 83 Recommendation ........................................................................................................................................ 84 Contents .................................................................................................................................................. 84 See Also .................................................................................................................................................. 88 RecommendationCostOptimizingAggregates ....................................................................................... 89 Contents .................................................................................................................................................. 89 See Also .................................................................................................................................................. 89 RecommendationPillarSpeciﬁcAggregates ............................................................................................ 90 Contents .................................................................................................................................................. 90 See Also .................................................................................................................................................. 90 RecommendationResourceExclusion ...................................................................................................... 91 Contents .................................................................................................................................................. 91 See Also .................................................................................................................................................. 91 RecommendationResourcesAggregates ................................................................................................. 92 Contents .................................................................................................................................................. 92 See Also .................................................................................................................................................. 92 RecommendationResourceSummary ...................................................................................................... 94 Contents .................................................................................................................................................. 94 See Also .................................................................................................................................................. 96 RecommendationSummary ...................................................................................................................... 97 Contents .................................................................................................................................................. 97 See Also ................................................................................................................................................ 100 UpdateRecommendationResourceExclusionError .............................................................................. 101 Contents ............................................................................................................................................... 101 See Also ................................................................................................................................................ 101 Common Parameters ................................................................................................................... 103 API Version 2022-09-15 vi AWS Trusted Advisor API Reference Common Errors ............................................................................................................................ 106 API Version 2022-09-15 vii AWS Trusted Advisor Welcome TrustedAdvisor Public API This document was last published on May 21, 2025. API Reference API Version 2022-09-15 1 AWS Trusted Advisor Actions The following actions are supported: • BatchUpdateRecommendationResourceExclusion • GetOrganizationRecommendation • GetRecommendation • ListChecks • ListOrganizationRecommendationAccounts • ListOrganizationRecommendationResources • ListOrganizationRecommendations • ListRecommendationResources • ListRecommendations • UpdateOrganizationRecommendationLifecycle • UpdateRecommendationLifecycle API Reference API Version 2022-09-15 2 AWS Trusted Advisor API Reference BatchUpdateRecommendationResourceExclusion Update one or more exclusion statuses for a list of recommendation resources. This API supports up to 25 unique recommendation resource ARNs per request. This API currently doesn't support prioritized recommendation resources. This API updates global recommendations, eliminating the need to call the API in each AWS Region. After submitting an exclusion update,
ta-api-002	ta-api.pdf	2	API Version 2022-09-15 1 AWS Trusted Advisor Actions The following actions are supported: • BatchUpdateRecommendationResourceExclusion • GetOrganizationRecommendation • GetRecommendation • ListChecks • ListOrganizationRecommendationAccounts • ListOrganizationRecommendationResources • ListOrganizationRecommendations • ListRecommendationResources • ListRecommendations • UpdateOrganizationRecommendationLifecycle • UpdateRecommendationLifecycle API Reference API Version 2022-09-15 2 AWS Trusted Advisor API Reference BatchUpdateRecommendationResourceExclusion Update one or more exclusion statuses for a list of recommendation resources. This API supports up to 25 unique recommendation resource ARNs per request. This API currently doesn't support prioritized recommendation resources. This API updates global recommendations, eliminating the need to call the API in each AWS Region. After submitting an exclusion update, note that it might take a few minutes for the changes to be reﬂected in the system. Request Syntax PUT /v1/batch-update-recommendation-resource-exclusion HTTP/1.1 Content-type: application/json { "recommendationResourceExclusions": [ { "arn": "string", "isExcluded": boolean } ] } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. recommendationResourceExclusions A list of recommendation resource ARNs and exclusion status to update Type: Array of RecommendationResourceExclusion objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: Yes BatchUpdateRecommendationResourceExclusion API Version 2022-09-15 3 API Reference AWS Trusted Advisor Response Syntax HTTP/1.1 200 Content-type: application/json { "batchUpdateRecommendationResourceExclusionErrors": [ { "arn": "string", "errorCode": "string", "errorMessage": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. batchUpdateRecommendationResourceExclusionErrors A list of recommendation resource ARNs whose exclusion status failed to update, if any Type: Array of UpdateRecommendationResourceExclusionError objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 ConﬂictException Exception that the request was denied due to conﬂictions in state HTTP Status Code: 409 Response Syntax API Version 2022-09-15 4 AWS Trusted Advisor InternalServerException API Reference Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Examples Update one or more exclusion status for a list of recommendation resources Batch update one or more exclusion status for a list of recommendation resources Sample Request { "recommendationResourceExclusions": [ { "arn": "arn:aws:trustedadvisor::000000000000:recommendation- resource/55fa4d2e- bbb7-491a-833b-5773e9589578/18959a1f1973cff8e706e9d9bde28bba36cd602a6b2cb86c8b61252835236010", "isExcluded": true } ] } Sample Response { "batchUpdateRecommendationResourceExclusionErrors": [ { Examples API Version 2022-09-15 5 AWS Trusted Advisor API Reference "arn": "arn:aws:trustedadvisor::000000000000:recommendation- resource/55fa4d2e- bbb7-491a-833b-5773e9589578/18959a1f1973cff8e706e9d9bde28bba36cd602a6b2cb86c8b61252835236010", "errorCode": "404", "errorMessage": "Exception that the requested resource has not been found" } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-09-15 6 AWS Trusted Advisor API Reference GetOrganizationRecommendation Get a speciﬁc recommendation within an AWS Organizations organization. This API supports only prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region. Request Syntax GET /v1/organization-recommendations/organizationRecommendationIdentifier HTTP/1.1 URI Request Parameters The request uses the following URI parameters. organizationRecommendationIdentiﬁer The Recommendation identiﬁer Length Constraints: Minimum length of 20. Maximum length of 200. Pattern: ^arn:[\w-]+:trustedadvisor:::organization-recommendation\/[\w-]+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "organizationRecommendation": { "arn": "string", "awsServices": [ "string" ], "checkArn": "string", "createdAt": "string", "createdBy": "string", "description": "string", GetOrganizationRecommendation API Version 2022-09-15 7 AWS Trusted Advisor API Reference "id": "string", "lastUpdatedAt": "string", "lifecycleStage": "string", "name": "string", "pillars": [ "string" ], "pillarSpecificAggregates": { "costOptimizing": { "estimatedMonthlySavings": number, "estimatedPercentMonthlySavings": number } }, "resolvedAt": "string", "resourcesAggregates": { "errorCount": number, "okCount": number, "warningCount": number }, "source": "string", "status": "string", "type": "string", "updatedOnBehalfOf": "string", "updatedOnBehalfOfJobTitle": "string", "updateReason": "string", "updateReasonCode": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. organizationRecommendation The Recommendation Type: OrganizationRecommendation object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2022-09-15 8 AWS Trusted Advisor AccessDeniedException API Reference Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ResourceNotFoundException Exception that the requested resource has not been found HTTP Status Code: 404 ThrottlingException Exception to notify that requests are being throttled HTTP
ta-api-003	ta-api.pdf	3	following data is returned in JSON format by the service. organizationRecommendation The Recommendation Type: OrganizationRecommendation object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2022-09-15 8 AWS Trusted Advisor AccessDeniedException API Reference Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ResourceNotFoundException Exception that the requested resource has not been found HTTP Status Code: 404 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Examples Get Organization Recommendation Get an organization recommendation by identiﬁer. Sample Request { "organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b- bf3a-44e8-8213-2ed68b39d9d5" } Examples API Version 2022-09-15 9 AWS Trusted Advisor Sample Response { API Reference "organizationRecommendation": { "arn": "arn:aws:trustedadvisor:::organization- recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", "name": "Lambda Runtime Deprecation Warning", "description": "One or more lambdas are using a deprecated runtime", "awsServices": [ "lambda" ], "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", "id": "9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", "lifecycleStage": "resolved", "pillars": [ "security" ], "resourcesAggregates": { "errorCount": 0, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "warning", "type": "priority" } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2022-09-15 10 AWS Trusted Advisor • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-09-15 11 AWS Trusted Advisor API Reference GetRecommendation Get a speciﬁc Recommendation. This API provides global recommendations, eliminating the need to call the API in each AWS Region. Request Syntax GET /v1/recommendations/recommendationIdentifier HTTP/1.1 URI Request Parameters The request uses the following URI parameters. recommendationIdentiﬁer The Recommendation identiﬁer Length Constraints: Minimum length of 20. Maximum length of 200. Pattern: ^arn:[\w-]+:trustedadvisor::\d{12}:recommendation\/[\w-]+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "recommendation": { "arn": "string", "awsServices": [ "string" ], "checkArn": "string", "createdAt": "string", "createdBy": "string", "description": "string", GetRecommendation API Version 2022-09-15 12 AWS Trusted Advisor API Reference "id": "string", "lastUpdatedAt": "string", "lifecycleStage": "string", "name": "string", "pillars": [ "string" ], "pillarSpecificAggregates": { "costOptimizing": { "estimatedMonthlySavings": number, "estimatedPercentMonthlySavings": number } }, "resolvedAt": "string", "resourcesAggregates": { "errorCount": number, "okCount": number, "warningCount": number }, "source": "string", "status": "string", "type": "string", "updatedOnBehalfOf": "string", "updatedOnBehalfOfJobTitle": "string", "updateReason": "string", "updateReasonCode": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. recommendation The Recommendation Type: Recommendation object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2022-09-15 13 AWS Trusted Advisor AccessDeniedException API Reference Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ResourceNotFoundException Exception that the requested resource has not been found HTTP Status Code: 404 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Examples Get A Recommendation Get a recommendation by identiﬁer. Sample Request { "recommendationIdentifier": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e- bbb7-491a-833b-5773e9589578", } Examples API Version 2022-09-15 14 API Reference AWS Trusted Advisor Sample Response { "recommendation": { "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e- bbb7-491a-833b-5773e9589578", "name": "MFA Recommendation", "description": "Enable multi-factor authentication", "awsServices": [ "iam" ], "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos", "id": "55fa4d2e-bbb7-491a-833b-5773e9589578", "lastUpdatedAt": "2023-11-01T15:57:58.673Z", "pillarSpecificAggregates": { "costOptimizing": { "estimatedMonthlySavings": 0.0, "estimatedPercentMonthlySavings": 0.0 } }, "pillars": [ "security" ], "resourcesAggregates": { "errorCount": 1, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "error", "type": "standard" } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also API Version 2022-09-15 15 API Reference AWS Trusted Advisor • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-09-15 16 AWS Trusted Advisor ListChecks API Reference List a ﬁlterable set of Checks. This API provides global recommendations, eliminating the need to call the API in each AWS Region. Request Syntax GET /v1/checks? awsService=awsService&language=language&maxResults=maxResults&nextToken=nextToken&pillar=pillar&source=source HTTP/1.1 URI Request Parameters The request uses the following URI parameters. awsService The aws service associated with the check Length Constraints:
ta-api-004	ta-api.pdf	4	• AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-09-15 16 AWS Trusted Advisor ListChecks API Reference List a ﬁlterable set of Checks. This API provides global recommendations, eliminating the need to call the API in each AWS Region. Request Syntax GET /v1/checks? awsService=awsService&language=language&maxResults=maxResults&nextToken=nextToken&pillar=pillar&source=source HTTP/1.1 URI Request Parameters The request uses the following URI parameters. awsService The aws service associated with the check Length Constraints: Minimum length of 2. Maximum length of 30. language The ISO 639-1 code for the language that you want your checks to appear in. Valid Values: en \| ja \| zh \| fr \| de \| ko \| zh_TW \| it \| es \| pt_BR \| id maxResults The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 200. nextToken The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Length Constraints: Minimum length of 4. Maximum length of 10000. pillar The pillar of the check ListChecks API Version 2022-09-15 17 AWS Trusted Advisor API Reference Valid Values: cost_optimizing \| performance \| security \| service_limits \| fault_tolerance \| operational_excellence source The source of the check Valid Values: aws_config \| compute_optimizer \| cost_explorer \| lse \| manual \| pse \| rds \| resilience \| resilience_hub \| security_hub \| stir \| ta_check \| well_architected Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "checkSummaries": [ { "arn": "string", "awsServices": [ "string" ], "description": "string", "id": "string", "metadata": { "string" : "string" }, "name": "string", "pillars": [ "string" ], "source": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. Request Body API Version 2022-09-15 18 AWS Trusted Advisor API Reference The following data is returned in JSON format by the service. checkSummaries The list of Checks Type: Array of CheckSummary objects nextToken The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Type: String Length Constraints: Minimum length of 4. Maximum length of 10000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Errors API Version 2022-09-15 19 API Reference AWS Trusted Advisor Examples List Checks With A Max Result List at most two Checks. Sample Request { "maxResults": 2 } Sample Response { "checkSummaries": [ { "arn": "arn:aws:trustedadvisor:::check/1iG5NDGVre", "awsServices": [ "EC2" ], "description": "Checks security groups for rules that allow unrestricted access to a resource. Unrestricted access increases opportunities for malicious activity (hacking, denial-of-service attacks, loss of data)", "id": "1iG5NDGVre", "metadata": { "0": "Region", "1": "Security Group Name", "2": "Security Group ID", "3": "Protocol", "4": "Port", "5": "Status", "6": "IP Range" }, "name": "Security Groups - Unrestricted Access", "pillars": [ "security" ], "source": "ta_check" }, { "arn": "arn:aws:trustedadvisor:::check/1qazXsw23e", "awsServices": [ Examples API Version 2022-09-15 20 AWS Trusted Advisor "RDS" API Reference ], "description": "Checks your usage of RDS and provides recommendations on purchase of Reserved Instances to help reduce costs incurred from using RDS On-Demand. AWS generates these recommendations by analyzing your On- Demand usage for the past 30 days. We then simulate every combination of reservations in the generated category of usage in order to identify the best number of each type of Reserved Instance to purchase to maximize your savings. This check covers recommendations based on partial upfront payment option with 1-year or 3-year commitment. This check is not available to accounts linked in Consolidated Billing. Recommendations are only available for the Paying Account.", "id": "1qazXsw23e", "metadata": { "0": "Region", "1": "Family", "2": "Instance Type", "3": "License Model", "4": "Database Edition", "5": "Database Engine", "6": "Deployment Option", "7": "Recommended number of Reserved Instances to purchase", "8": "Expected Average Reserved Instance Utilization", "9": "Estimated Savings with Recommendation (monthly)" "10": "Upfront Cost of Reserved Instances", "11": "Estimated cost of Reserved Instances (monthly)", "12": "Estimated On-Demand Cost Post Recommended Reserved Instance Purchase (monthly)", "13": "Estimated Break Even (months)", "14": "Lookback Period (days)", "15": "Term (years)" }, "name": "Amazon Relational Database Service (RDS) Reserved Instance Optimization", "pillars": [ "cost_optimizing" ], "source": "ta_check" }, { "arn":
ta-api-005	ta-api.pdf	5	the Paying Account.", "id": "1qazXsw23e", "metadata": { "0": "Region", "1": "Family", "2": "Instance Type", "3": "License Model", "4": "Database Edition", "5": "Database Engine", "6": "Deployment Option", "7": "Recommended number of Reserved Instances to purchase", "8": "Expected Average Reserved Instance Utilization", "9": "Estimated Savings with Recommendation (monthly)" "10": "Upfront Cost of Reserved Instances", "11": "Estimated cost of Reserved Instances (monthly)", "12": "Estimated On-Demand Cost Post Recommended Reserved Instance Purchase (monthly)", "13": "Estimated Break Even (months)", "14": "Lookback Period (days)", "15": "Term (years)" }, "name": "Amazon Relational Database Service (RDS) Reserved Instance Optimization", "pillars": [ "cost_optimizing" ], "source": "ta_check" }, { "arn": "arn:aws:trustedadvisor:::check/1qw23er45t", "awsServices": [ "Redshift" ], Examples API Version 2022-09-15 21 AWS Trusted Advisor API Reference "description": "Checks your usage of Redshift and provides recommendations on purchase of Reserved Nodes to help reduce costs incurred from using Redshift On-Demand. AWS generates these recommendations by analyzing your On-Demand usage for the past 30 days. We then simulate every combination of reservations in the generated category of usage in order to identify the best number of each type of Reserved Nodes to purchase to maximize your savings. This check covers recommendations based on partial upfront payment option with 1-year or 3-year commitment. This check is not available to accounts linked in Consolidated Billing. Recommendations are only available for the Paying Account.", "id": "1qw23er45t", "metadata": { "0": "Region", "1": "Family", "2": "Node Type", "3": "Recommended number of Reserved Nodes to purchase", "4": "Expected Average Reserved Node Utilization", "5": "Estimated Savings with Recommendation (monthly)", "6": "Upfront Cost of Reserved Nodes", "7": "Estimated cost of Reserved Nodes (monthly)", "8": "Estimated On-Demand Cost Post Recommended Reserved Nodes Purchase (monthly)", "9": "Estimated Break Even (months)", "10": "Lookback Period (days)", "11": "Term (years)", }, "name": "Amazon Redshift Reserved Node Optimization", "pillars": [ "cost_optimizing" ], "source": "ta_check" }, ], "nextToken": "REDACTED" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also API Version 2022-09-15 22 API Reference AWS Trusted Advisor • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-09-15 23 AWS Trusted Advisor API Reference ListOrganizationRecommendationAccounts Lists the accounts that own the resources for an organization aggregate recommendation. This API only supports prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region. Request Syntax GET /v1/organization-recommendations/organizationRecommendationIdentifier/accounts? affectedAccountId=affectedAccountId&maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. aﬀectedAccountId An account aﬀected by this organization recommendation Length Constraints: Fixed length of 12. Pattern: ^\d+$ maxResults The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 200. nextToken The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Length Constraints: Minimum length of 4. Maximum length of 10000. organizationRecommendationIdentiﬁer The Recommendation identiﬁer Length Constraints: Minimum length of 20. Maximum length of 200. Pattern: ^arn:[\w-]+:trustedadvisor:::organization-recommendation\/[\w-]+$ Required: Yes ListOrganizationRecommendationAccounts API Version 2022-09-15 24 API Reference AWS Trusted Advisor Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "accountRecommendationLifecycleSummaries": [ { "accountId": "string", "accountRecommendationArn": "string", "lastUpdatedAt": "string", "lifecycleStage": "string", "updatedOnBehalfOf": "string", "updatedOnBehalfOfJobTitle": "string", "updateReason": "string", "updateReasonCode": "string" } ], "nextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. accountRecommendationLifecycleSummaries The account recommendations lifecycles that are applicable to the Recommendation Type: Array of AccountRecommendationLifecycleSummary objects nextToken The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Type: String Request Body API Version 2022-09-15 25 AWS Trusted Advisor API Reference Length Constraints: Minimum length of 4. Maximum length of 10000. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ResourceNotFoundException Exception that the requested resource has not been found HTTP Status Code: 404 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Examples List Accounts For An Organization Recommendation List all account recommendation summaries for an organization recommendation by its identiﬁer. Sample Request { Errors API Version
ta-api-006	ta-api.pdf	6	AccessDeniedException Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ResourceNotFoundException Exception that the requested resource has not been found HTTP Status Code: 404 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Examples List Accounts For An Organization Recommendation List all account recommendation summaries for an organization recommendation by its identiﬁer. Sample Request { Errors API Version 2022-09-15 26 AWS Trusted Advisor API Reference "organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization-recommendation/9534ec9b- bf3a-44e8-8213-2ed68b39d9d5" } Sample Response { "accountRecommendationLifecycleSummaries": [{ "accountId": "000000000000", "accountRecommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/9534ec9b- bf3a-44e8-8213-2ed68b39d9d5", "lifecycleStage": "resolved", "updateReason": "Resolved issue", "updateReasonCode": "valid_business_case", "lastUpdatedAt": "2023-01-17T18:25:44.552Z" }], "nextToken": "REDACTED" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-09-15 27 AWS Trusted Advisor API Reference ListOrganizationRecommendationResources List Resources of a Recommendation within an Organization. This API only supports prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region. Request Syntax GET /v1/organization-recommendations/organizationRecommendationIdentifier/resources? affectedAccountId=affectedAccountId&exclusionStatus=exclusionStatus&maxResults=maxResults&nextToken=nextToken&regionCode=regionCode&status=status HTTP/1.1 URI Request Parameters The request uses the following URI parameters. aﬀectedAccountId An account aﬀected by this organization recommendation Length Constraints: Fixed length of 12. Pattern: ^\d+$ exclusionStatus The exclusion status of the resource Valid Values: excluded \| included maxResults The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 200. nextToken The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Length Constraints: Minimum length of 4. Maximum length of 10000. ListOrganizationRecommendationResources API Version 2022-09-15 28 AWS Trusted Advisor API Reference organizationRecommendationIdentiﬁer The AWS Organization organization's Recommendation identiﬁer Length Constraints: Minimum length of 20. Maximum length of 200. Pattern: ^arn:[\w-]+:trustedadvisor:::organization-recommendation\/[\w-]+$ Required: Yes regionCode The AWS Region code of the resource status The status of the resource Valid Values: ok \| warning \| error Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "organizationRecommendationResourceSummaries": [ { "accountId": "string", "arn": "string", "awsResourceId": "string", "exclusionStatus": "string", "id": "string", "lastUpdatedAt": "string", "metadata": { "string" : "string" }, "recommendationArn": "string", "regionCode": "string", "status": "string" Request Body API Version 2022-09-15 29 AWS Trusted Advisor } ] } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextToken The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Type: String Length Constraints: Minimum length of 4. Maximum length of 10000. organizationRecommendationResourceSummaries A list of Recommendation Resources Type: Array of OrganizationRecommendationResourceSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ResourceNotFoundException Exception that the requested resource has not been found HTTP Status Code: 404 Response Elements API Version 2022-09-15 30 AWS Trusted Advisor ThrottlingException API Reference Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Examples List All Organization Recommendation Resources List all resources for an organization recommendation by its identiﬁer. Sample Request { "organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization-recommendation/5a694939-2e54-45a2- ae72-730598fa89d0" } Sample Response { "organizationRecommendationResourceSummaries": [ { "arn": "arn:aws:trustedadvisor::000000000000:recommendation- resource/5a694939-2e54-45a2-ae72-730598fa89d0/ bb38affc0ce0681d9a6cd13f30238ba03a8f63dfe7a379dc403c619119d86af", "awsResourceId": "database-1-instance-1", "id": "bb38affc0ce0681d9a6cd13f302383ba03a8f63dfe7a379dc403c619119d86af", "lastUpdatedAt": "2023-11-01T15:09:51.891Z", "metadata": { "0": "14", "1": "208.79999999999998", "2": "database-1-instance-1", "3": "db.r5.large", Examples API Version 2022-09-15 31 AWS Trusted Advisor API Reference "4": "false", "5": "us-west-2", "6": "arn:aws:rds:us-west-2:000000000000:db:database-1-instance-1", "7": "1" }, "recommendationArn": "arn:aws:trustedadvisor:::organization- recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", "regionCode": "us-west-2", "exclusionStatus": "included", "status": "warning" }, { "arn": "arn:aws:trustedadvisor::000000000000:recommendation- resource/5a694939-2e54-45a2- ae72-730598fa89d0/51fded4d7a3278818df9cfe344ff5762cec46c095a6763d1ba1ba53bd0e1b0e6", "awsResourceId": "database-1", "id": "51fded4d7a3278818df9cfe344ff5762cec46c095a6763d1ba1ba53bd0e1b0e6", "lastUpdatedAt": "2023-11-01T15:09:51.891Z", "metadata": { "0": "14", "1": "31.679999999999996", "2": "database-1", "3": "db.t3.small", "4": "false", "5": "us-west-2", "6": "arn:aws:rds:us-west-2:000000000000:db:database-1", "7": "20" }, "recommendationArn": "arn:aws:trustedadvisor:::organization- recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", "regionCode": "us-west-2", "exclusionStatus": "included", "status": "warning" }, { "arn": "arn:aws:trustedadvisor::000000000000:recommendation- resource/5a694939-2e54-45a2-ae72-730598fa89d0/ f4d01bd20f4cd5372062aafc8786c489e48f0ead7cdab121463bf9f89e40a36b", "awsResourceId": "database-2-instance-1-us-west-2a", "id": "f4d01bd20f4cd5372062aafc8786c489e48f0ead7cdab121463bf9f89e40a36b", "lastUpdatedAt": "2023-11-01T15:09:51.891Z", "metadata": { Examples API Version 2022-09-15 32 AWS Trusted Advisor API Reference "0": "14", "1": "187.20000000000002", "2": "database-2-instance-1-us-west-2a", "3": "db.r6g.large", "4": "true", "5": "us-west-2", "6": "arn:aws:rds:us-west-2:000000000000:db:database-2-instance-1- us-west-2a", "7": "1"
ta-api-007	ta-api.pdf	7	Reference "4": "false", "5": "us-west-2", "6": "arn:aws:rds:us-west-2:000000000000:db:database-1-instance-1", "7": "1" }, "recommendationArn": "arn:aws:trustedadvisor:::organization- recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", "regionCode": "us-west-2", "exclusionStatus": "included", "status": "warning" }, { "arn": "arn:aws:trustedadvisor::000000000000:recommendation- resource/5a694939-2e54-45a2- ae72-730598fa89d0/51fded4d7a3278818df9cfe344ff5762cec46c095a6763d1ba1ba53bd0e1b0e6", "awsResourceId": "database-1", "id": "51fded4d7a3278818df9cfe344ff5762cec46c095a6763d1ba1ba53bd0e1b0e6", "lastUpdatedAt": "2023-11-01T15:09:51.891Z", "metadata": { "0": "14", "1": "31.679999999999996", "2": "database-1", "3": "db.t3.small", "4": "false", "5": "us-west-2", "6": "arn:aws:rds:us-west-2:000000000000:db:database-1", "7": "20" }, "recommendationArn": "arn:aws:trustedadvisor:::organization- recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", "regionCode": "us-west-2", "exclusionStatus": "included", "status": "warning" }, { "arn": "arn:aws:trustedadvisor::000000000000:recommendation- resource/5a694939-2e54-45a2-ae72-730598fa89d0/ f4d01bd20f4cd5372062aafc8786c489e48f0ead7cdab121463bf9f89e40a36b", "awsResourceId": "database-2-instance-1-us-west-2a", "id": "f4d01bd20f4cd5372062aafc8786c489e48f0ead7cdab121463bf9f89e40a36b", "lastUpdatedAt": "2023-11-01T15:09:51.891Z", "metadata": { Examples API Version 2022-09-15 32 AWS Trusted Advisor API Reference "0": "14", "1": "187.20000000000002", "2": "database-2-instance-1-us-west-2a", "3": "db.r6g.large", "4": "true", "5": "us-west-2", "6": "arn:aws:rds:us-west-2:000000000000:db:database-2-instance-1- us-west-2a", "7": "1" }, "recommendationArn": "arn:aws:trustedadvisor:::organization- recommendation/5a694939-2e54-45a2-ae72-730598fa89d0", "regionCode": "us-west-2", "exclusionStatus": "included", "status": "warning" }, ], "nextToken": "REDACTED" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-09-15 33 AWS Trusted Advisor API Reference ListOrganizationRecommendations List a ﬁlterable set of Recommendations within an Organization. This API only supports prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region. Request Syntax GET /v1/organization-recommendations? afterLastUpdatedAt=afterLastUpdatedAt&awsService=awsService&beforeLastUpdatedAt=beforeLastUpdatedAt&checkIdentifier=checkIdentifier&maxResults=maxResults&nextToken=nextToken&pillar=pillar&source=source&status=status&type=type HTTP/1.1 URI Request Parameters The request uses the following URI parameters. afterLastUpdatedAt After the last update of the Recommendation awsService The aws service associated with the Recommendation Length Constraints: Minimum length of 2. Maximum length of 30. beforeLastUpdatedAt Before the last update of the Recommendation checkIdentiﬁer The check identiﬁer of the Recommendation Length Constraints: Minimum length of 20. Maximum length of 64. Pattern: ^arn:[\w-]+:trustedadvisor:::check\/[\w-]+$ maxResults The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 200. ListOrganizationRecommendations API Version 2022-09-15 34 AWS Trusted Advisor nextToken API Reference The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Length Constraints: Minimum length of 4. Maximum length of 10000. pillar The pillar of the Recommendation Valid Values: cost_optimizing \| performance \| security \| service_limits \| fault_tolerance \| operational_excellence source The source of the Recommendation Valid Values: aws_config \| compute_optimizer \| cost_explorer \| lse \| manual \| pse \| rds \| resilience \| resilience_hub \| security_hub \| stir \| ta_check \| well_architected status The status of the Recommendation Valid Values: ok \| warning \| error type The type of the Recommendation Valid Values: standard \| priority Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Request Body API Version 2022-09-15 35 AWS Trusted Advisor API Reference Content-type: application/json { "nextToken": "string", "organizationRecommendationSummaries": [ { "arn": "string", "awsServices": [ "string" ], "checkArn": "string", "createdAt": "string", "id": "string", "lastUpdatedAt": "string", "lifecycleStage": "string", "name": "string", "pillars": [ "string" ], "pillarSpecificAggregates": { "costOptimizing": { "estimatedMonthlySavings": number, "estimatedPercentMonthlySavings": number } }, "resourcesAggregates": { "errorCount": number, "okCount": number, "warningCount": number }, "source": "string", "status": "string", "type": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextToken The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Response Elements API Version 2022-09-15 36 AWS Trusted Advisor Type: String API Reference Length Constraints: Minimum length of 4. Maximum length of 10000. organizationRecommendationSummaries The list of Recommendations Type: Array of OrganizationRecommendationSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Examples List All Organization Recommendations List all organization recommendations and do not include a ﬁlter. Errors API Version 2022-09-15 37 API Reference AWS Trusted Advisor Sample Response { "organizationRecommendationSummaries": [ { "arn": "arn:aws:trustedadvisor:::organization- recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", "name": "Lambda Runtime Deprecation Warning", "awsServices": [ "lambda" ], "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", "id": "9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", "lifecycleStage": "resolved", "pillars": [ "security" ], "resourcesAggregates": { "errorCount": 0, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "warning", "type": "priority" }, { "arn": "arn:aws:trustedadvisor:::organization- recommendation/4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", "name": "Lambda Runtime Deprecation Warning", "awsServices": [ "lambda" ], "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", "id": "4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", "lifecycleStage": "resolved", "pillars": [ "security" ], "resourcesAggregates": { "errorCount": 0, "okCount": 0, "warningCount": 0 }, Examples API Version 2022-09-15 38 AWS Trusted Advisor
ta-api-008	ta-api.pdf	8	and do not include a ﬁlter. Errors API Version 2022-09-15 37 API Reference AWS Trusted Advisor Sample Response { "organizationRecommendationSummaries": [ { "arn": "arn:aws:trustedadvisor:::organization- recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", "name": "Lambda Runtime Deprecation Warning", "awsServices": [ "lambda" ], "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", "id": "9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", "lifecycleStage": "resolved", "pillars": [ "security" ], "resourcesAggregates": { "errorCount": 0, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "warning", "type": "priority" }, { "arn": "arn:aws:trustedadvisor:::organization- recommendation/4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", "name": "Lambda Runtime Deprecation Warning", "awsServices": [ "lambda" ], "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", "id": "4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", "lifecycleStage": "resolved", "pillars": [ "security" ], "resourcesAggregates": { "errorCount": 0, "okCount": 0, "warningCount": 0 }, Examples API Version 2022-09-15 38 AWS Trusted Advisor API Reference "source": "ta_check", "status": "warning", "type": "priority" }, ], "nextToken": "REDACTED" } List Organization Recommendations With Filter Filter and return a max of one organization recommendation that is a part of the "security" pillar. Sample Request { "pillar": "security", "maxResults": 100 } Sample Response { "organizationRecommendationSummaries": [{ "arn": "arn:aws:trustedadvisor:::organization- recommendation/9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", "name": "Lambda Runtime Deprecation Warning", "awsServices": [ "lambda" ], "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", "id": "9534ec9b-bf3a-44e8-8213-2ed68b39d9d5", "lifecycleStage": "resolved", "pillars": [ "security" ], "resourcesAggregates": { "errorCount": 0, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "warning", "type": "priority" Examples API Version 2022-09-15 39 AWS Trusted Advisor API Reference }], "nextToken": "REDACTED" } Fetch The Next Page Of A Previous Request Use the "nextToken" returned from a previous request to fetch the next page of ﬁltered organization recommendations that are a part of the "security" pillar. Sample Request { "nextToken": "REDACTED", "pillar": "security", "maxResults": 100 } Sample Response { "organizationRecommendationSummaries": [{ "arn": "arn:aws:trustedadvisor:::organization- recommendation/4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", "name": "Lambda Runtime Deprecation Warning", "awsServices": [ "lambda" ], "checkArn": "arn:aws:trustedadvisor:::check/L4dfs2Q4C5", "id": "4ecff4d4-1bc1-4c99-a5b8-0fff9ee500d6", "lifecycleStage": "resolved", "pillars": [ "security" ], "resourcesAggregates": { "errorCount": 0, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "warning", "type": "priority" }] Examples API Version 2022-09-15 40 AWS Trusted Advisor } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-09-15 41 AWS Trusted Advisor API Reference ListRecommendationResources List Resources of a Recommendation. This API provides global recommendations, eliminating the need to call the API in each AWS Region. Request Syntax GET /v1/recommendations/recommendationIdentifier/resources? exclusionStatus=exclusionStatus&maxResults=maxResults&nextToken=nextToken&regionCode=regionCode&status=status HTTP/1.1 URI Request Parameters The request uses the following URI parameters. exclusionStatus The exclusion status of the resource Valid Values: excluded \| included maxResults The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 200. nextToken The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Length Constraints: Minimum length of 4. Maximum length of 10000. recommendationIdentiﬁer The Recommendation identiﬁer Length Constraints: Minimum length of 20. Maximum length of 200. Pattern: ^arn:[\w-]+:trustedadvisor::\d{12}:recommendation\/[\w-]+$ Required: Yes ListRecommendationResources API Version 2022-09-15 42 API Reference AWS Trusted Advisor regionCode The AWS Region code of the resource status The status of the resource Valid Values: ok \| warning \| error Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "recommendationResourceSummaries": [ { "arn": "string", "awsResourceId": "string", "exclusionStatus": "string", "id": "string", "lastUpdatedAt": "string", "metadata": { "string" : "string" }, "recommendationArn": "string", "regionCode": "string", "status": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Request Body API Version 2022-09-15 43 AWS Trusted Advisor nextToken API Reference The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Type: String Length Constraints: Minimum length of 4. Maximum length of 10000. recommendationResourceSummaries A list of Recommendation Resources Type: Array of RecommendationResourceSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ResourceNotFoundException Exception that the requested resource has not been found HTTP Status Code: 404 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Errors API Version 2022-09-15 44 API Reference AWS Trusted Advisor Examples List All Recommendation Resources List all resources for a recommendation by its identiﬁer. Sample Request { "recommendationIdentifier": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e- bbb7-491a-833b-5773e9589578" } Sample Response { "recommendationResourceSummaries": [ {
ta-api-009	ta-api.pdf	9	Status Code: 403 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ResourceNotFoundException Exception that the requested resource has not been found HTTP Status Code: 404 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Errors API Version 2022-09-15 44 API Reference AWS Trusted Advisor Examples List All Recommendation Resources List all resources for a recommendation by its identiﬁer. Sample Request { "recommendationIdentifier": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e- bbb7-491a-833b-5773e9589578" } Sample Response { "recommendationResourceSummaries": [ { "arn": "arn:aws:trustedadvisor::000000000000:recommendation- resource/55fa4d2e- bbb7-491a-833b-5773e9589578/18959a1f1973cff8e706e9d9bde28bba36cd602a6b2cb86c8b61252835236010", "id": "18959a1f1973cff8e706e9d9bde28bba36cd602a6b2cb86c8b61252835236010", "awsResourceId": "webcms-dev-01", "lastUpdatedAt": "2023-11-01T15:09:51.891Z", "metadata": { "0": "14", "1": "123.12000000000002", "2": "webcms-dev-01", "3": "db.m6i.large", "4": "false", "5": "us-east-1", "6": "arn:aws:rds:us-east-1:000000000000:db:webcms-dev-01", "7": "20" }, "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e- bbb7-491a-833b-5773e9589578", "regionCode": "us-east-1", "exclusionStatus": "included", "status": "warning" }, Examples API Version 2022-09-15 45 AWS Trusted Advisor { API Reference "arn": "arn:aws:trustedadvisor::000000000000:recommendation- resource/55fa4d2e-bbb7-491a-833b-5773e9589578/ e6367ff500ac90db8e4adeb4892e39ee9c36bbf812dcbce4b9e4fefcec9eb63e", "id": "e6367ff500ac90db8e4adeb4892e39ee9c36bbf812dcbce4b9e4fefcec9eb63e", "awsResourceId": "aws-dev-db-stack-instance-1", "lastUpdatedAt": "2023-11-01T15:09:51.891Z", "metadata": { "0": "14", "1": "29.52", "2": "aws-dev-db-stack-instance-1", "3": "db.t2.small", "4": "false", "5": "us-east-1", "6": "arn:aws:rds:us-east-1:000000000000:db:aws-dev-db-stack- instance-1", "7": "1" }, "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e- bbb7-491a-833b-5773e9589578", "regionCode": "us-east-1", "exclusionStatus": "included", "status": "warning" }, { "arn": "arn:aws:trustedadvisor::000000000000:recommendation- resource/55fa4d2e- bbb7-491a-833b-5773e9589578/31aa78ba050a5015d2d38cca7f5f1ce88f70857c4e1c3ad03f8f9fd95dad7459", "id": "31aa78ba050a5015d2d38cca7f5f1ce88f70857c4e1c3ad03f8f9fd95dad7459", "awsResourceId": "aws-awesome-apps-stack-db", "lastUpdatedAt": "2023-11-01T15:09:51.891Z", "metadata": { "0": "14", "1": "114.48000000000002", "2": "aws-awesome-apps-stack-db", "3": "db.m6g.large", "4": "false", "5": "us-east-1", "6": "arn:aws:rds:us-east-1:000000000000:db:aws-awesome-apps-stack- db", "7": "100" Examples API Version 2022-09-15 46 AWS Trusted Advisor }, "recommendationArn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e- API Reference bbb7-491a-833b-5773e9589578", "regionCode": "us-east-1", "exclusionStatus": "included", "status": "warning" } ], "nextToken": "REDACTED" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-09-15 47 AWS Trusted Advisor API Reference ListRecommendations List a ﬁlterable set of Recommendations. This API provides global recommendations, eliminating the need to call the API in each AWS Region. Request Syntax GET /v1/recommendations? afterLastUpdatedAt=afterLastUpdatedAt&awsService=awsService&beforeLastUpdatedAt=beforeLastUpdatedAt&checkIdentifier=checkIdentifier&maxResults=maxResults&nextToken=nextToken&pillar=pillar&source=source&status=status&type=type HTTP/1.1 URI Request Parameters The request uses the following URI parameters. afterLastUpdatedAt After the last update of the Recommendation awsService The aws service associated with the Recommendation Length Constraints: Minimum length of 2. Maximum length of 30. beforeLastUpdatedAt Before the last update of the Recommendation checkIdentiﬁer The check identiﬁer of the Recommendation Length Constraints: Minimum length of 20. Maximum length of 64. Pattern: ^arn:[\w-]+:trustedadvisor:::check\/[\w-]+$ maxResults The maximum number of results to return per page. Valid Range: Minimum value of 1. Maximum value of 200. ListRecommendations API Version 2022-09-15 48 AWS Trusted Advisor nextToken API Reference The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Length Constraints: Minimum length of 4. Maximum length of 10000. pillar The pillar of the Recommendation Valid Values: cost_optimizing \| performance \| security \| service_limits \| fault_tolerance \| operational_excellence source The source of the Recommendation Valid Values: aws_config \| compute_optimizer \| cost_explorer \| lse \| manual \| pse \| rds \| resilience \| resilience_hub \| security_hub \| stir \| ta_check \| well_architected status The status of the Recommendation Valid Values: ok \| warning \| error type The type of the Recommendation Valid Values: standard \| priority Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Request Body API Version 2022-09-15 49 AWS Trusted Advisor API Reference Content-type: application/json { "nextToken": "string", "recommendationSummaries": [ { "arn": "string", "awsServices": [ "string" ], "checkArn": "string", "createdAt": "string", "id": "string", "lastUpdatedAt": "string", "lifecycleStage": "string", "name": "string", "pillars": [ "string" ], "pillarSpecificAggregates": { "costOptimizing": { "estimatedMonthlySavings": number, "estimatedPercentMonthlySavings": number } }, "resourcesAggregates": { "errorCount": number, "okCount": number, "warningCount": number }, "source": "string", "status": "string", "type": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextToken The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. Response Elements API Version 2022-09-15 50 AWS Trusted Advisor Type: String API Reference Length Constraints: Minimum length of 4. Maximum length of 10000. recommendationSummaries The list of Recommendations Type: Array of RecommendationSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception
ta-api-010	ta-api.pdf	10	set of results. Response Elements API Version 2022-09-15 50 AWS Trusted Advisor Type: String API Reference Length Constraints: Minimum length of 4. Maximum length of 10000. recommendationSummaries The list of Recommendations Type: Array of RecommendationSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Examples List All Recommendations List all recommendations and do not include a ﬁlter. Errors API Version 2022-09-15 51 API Reference AWS Trusted Advisor Sample Response { "recommendationSummaries": [ { "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e- bbb7-491a-833b-5773e9589578", "name": "MFA Recommendation", "awsServices": [ "iam" ], "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos", "id": "55fa4d2e-bbb7-491a-833b-5773e9589578", "lastUpdatedAt": "2023-11-01T15:57:58.673Z", "pillarSpecificAggregates": { "costOptimizing": { "estimatedMonthlySavings": 0.0, "estimatedPercentMonthlySavings": 0.0 } }, "pillars": [ "security" ], "resourcesAggregates": { "errorCount": 1, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "error", "type": "standard" }, { "arn": "arn:aws:trustedadvisor::000000000000:recommendation/8b602b6f-452d-4cb2-8a9e- c7650955d9cd", "name": "RDS clusters quota warning", "awsServices": [ "rds" ], "checkArn": "arn:aws:trustedadvisor:::check/gjqMBn6pjz", "id": "8b602b6f-452d-4cb2-8a9e-c7650955d9cd", "lastUpdatedAt": "2023-11-01T15:58:17.397Z", Examples API Version 2022-09-15 52 AWS Trusted Advisor API Reference "pillarSpecificAggregates": { "costOptimizing": { "estimatedMonthlySavings": 0.0, "estimatedPercentMonthlySavings": 0.0 } }, "pillars": [ "service_limits" ], "resourcesAggregates": { "errorCount": 0, "okCount": 3, "warningCount": 6 }, "source": "ta_check", "status": "warning", "type": "standard" } ], "nextToken": "REDACTED" } List Recommendations With Filter Filter and return a max of one Recommendation that regards AWS IAM. Sample Request { "awsService": "iam", "maxResults": 100 } Sample Response { "recommendationSummaries": [{ "arn": "arn:aws:trustedadvisor::000000000000:recommendation/55fa4d2e- bbb7-491a-833b-5773e9589578", "name": "MFA Recommendation", "awsServices": [ "iam" Examples API Version 2022-09-15 53 AWS Trusted Advisor ], API Reference "checkArn": "arn:aws:trustedadvisor:::check/7DAFEmoDos", "id": "55fa4d2e-bbb7-491a-833b-5773e9589578", "lastUpdatedAt": "2023-11-01T15:57:58.673Z", "pillarSpecificAggregates": { "costOptimizing": { "estimatedMonthlySavings": 0.0, "estimatedPercentMonthlySavings": 0.0 } }, "pillars": [ "security" ], "resourcesAggregates": { "errorCount": 1, "okCount": 0, "warningCount": 0 }, "source": "ta_check", "status": "error", "type": "standard" }], "nextToken": "REDACTED" } Fetch The Next Page Of A Previous Request Use the "nextToken" returned from a previous request to fetch the next page of ﬁltered Recommendations. Sample Request { "nextToken": "REDACTED", "awsService": "rds", "maxResults": 100 } Sample Response { "recommendationSummaries": [{ Examples API Version 2022-09-15 54 AWS Trusted Advisor "arn": API Reference "arn:aws:trustedadvisor::000000000000:recommendation/8b602b6f-452d-4cb2-8a9e- c7650955d9cd", "name": "RDS clusters quota warning", "awsServices": [ "rds" ], "checkArn": "arn:aws:trustedadvisor:::check/gjqMBn6pjz", "id": "8b602b6f-452d-4cb2-8a9e-c7650955d9cd", "lastUpdatedAt": "2023-11-01T15:58:17.397Z", "pillarSpecificAggregates": { "costOptimizing": { "estimatedMonthlySavings": 0.0, "estimatedPercentMonthlySavings": 0.0 } }, "pillars": [ "service_limits" ], "resourcesAggregates": { "errorCount": 0, "okCount": 3, "warningCount": 6 }, "source": "ta_check", "status": "warning", "type": "standard" }] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2022-09-15 55 AWS Trusted Advisor • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-09-15 56 AWS Trusted Advisor API Reference UpdateOrganizationRecommendationLifecycle Update the lifecycle of a Recommendation within an Organization. This API only supports prioritized recommendations and updates global priority recommendations, eliminating the need to call the API in each AWS Region. Request Syntax PUT /v1/organization-recommendations/organizationRecommendationIdentifier/lifecycle HTTP/1.1 Content-type: application/json { "lifecycleStage": "string", "updateReason": "string", "updateReasonCode": "string" } URI Request Parameters The request uses the following URI parameters. organizationRecommendationIdentiﬁer The Recommendation identiﬁer for AWS Trusted Advisor Priority recommendations Length Constraints: Minimum length of 20. Maximum length of 200. Pattern: ^arn:[\w-]+:trustedadvisor:::organization-recommendation\/[\w-]+$ Required: Yes Request Body The request accepts the following data in JSON format. lifecycleStage The new lifecycle stage Type: String UpdateOrganizationRecommendationLifecycle API Version 2022-09-15 57 AWS Trusted Advisor API Reference Valid Values: pending_response \| in_progress \| dismissed \| resolved Required: Yes updateReason Reason for the lifecycle stage change Type: String Length Constraints: Minimum length of 10. Maximum length of 4096. Pattern: ^[\s\S]*$ Required: No updateReasonCode Reason code for the lifecycle state change Type: String Valid Values: non_critical_account \| temporary_account \| valid_business_case \| other_methods_available \| low_priority \| not_applicable \| other Required: No Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Exception that access has been denied due to insuﬃcient access Response Syntax API Version 2022-09-15 58 AWS Trusted Advisor HTTP Status Code: 403 ConﬂictException Exception that the request was denied due to conﬂictions in state HTTP Status Code: 409 InternalServerException API Reference Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status
ta-api-011	ta-api.pdf	11	Required: No Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Exception that access has been denied due to insuﬃcient access Response Syntax API Version 2022-09-15 58 AWS Trusted Advisor HTTP Status Code: 403 ConﬂictException Exception that the request was denied due to conﬂictions in state HTTP Status Code: 409 InternalServerException API Reference Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ResourceNotFoundException Exception that the requested resource has not been found HTTP Status Code: 404 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Examples Update the Lifecycle of an Organization Recommendation Update the lifecycle stage of an organization recommendation that is managed by AWS Trusted Advisor Priority. Sample Request { "organizationRecommendationIdentifier": "arn:aws:trustedadvisor:::organization- recommendation/96b5e5ca-7930-444c-90c6-06d386128100", Examples API Version 2022-09-15 59 AWS Trusted Advisor API Reference "lifecycleStage": "dismissed", "updateReasonCode": "not_applicable", "updateReason": "Does not apply to this resource" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-09-15 60 AWS Trusted Advisor API Reference UpdateRecommendationLifecycle Update the lifecyle of a Recommendation. This API only supports prioritized recommendations and updates global priority recommendations, eliminating the need to call the API in each AWS Region. Request Syntax PUT /v1/recommendations/recommendationIdentifier/lifecycle HTTP/1.1 Content-type: application/json { "lifecycleStage": "string", "updateReason": "string", "updateReasonCode": "string" } URI Request Parameters The request uses the following URI parameters. recommendationIdentiﬁer The Recommendation identiﬁer for AWS Trusted Advisor Priority recommendations Length Constraints: Minimum length of 20. Maximum length of 200. Pattern: ^arn:[\w-]+:trustedadvisor::\d{12}:recommendation\/[\w-]+$ Required: Yes Request Body The request accepts the following data in JSON format. lifecycleStage The new lifecycle stage Type: String Valid Values: pending_response \| in_progress \| dismissed \| resolved UpdateRecommendationLifecycle API Version 2022-09-15 61 API Reference AWS Trusted Advisor Required: Yes updateReason Reason for the lifecycle stage change Type: String Length Constraints: Minimum length of 10. Maximum length of 4096. Pattern: ^[\s\S]*$ Required: No updateReasonCode Reason code for the lifecycle state change Type: String Valid Values: non_critical_account \| temporary_account \| valid_business_case \| other_methods_available \| low_priority \| not_applicable \| other Required: No Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Exception that access has been denied due to insuﬃcient access HTTP Status Code: 403 Response Syntax API Version 2022-09-15 62 AWS Trusted Advisor ConﬂictException API Reference Exception that the request was denied due to conﬂictions in state HTTP Status Code: 409 InternalServerException Exception to notify that an unexpected internal error occurred during processing of the request HTTP Status Code: 500 ResourceNotFoundException Exception that the requested resource has not been found HTTP Status Code: 404 ThrottlingException Exception to notify that requests are being throttled HTTP Status Code: 429 ValidationException Exception that the request failed to satisfy service constraints HTTP Status Code: 400 Examples Update the Lifecycle of a Recommendation Update the lifecycle stage of a recommendation managed by AWS Trusted Advisor Priority. Sample Request { "recommendationIdentifier": "arn:aws:trustedadvisor::000000000000:recommendation/861c9c6e- f169-405a-8b59-537a8caccd7a", "lifecycleStage": "resolved", "updateReasonCode": "valid_business_case", "updateReason": "Resolved the recommendation" Examples API Version 2022-09-15 63 AWS Trusted Advisor } See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-09-15 64 AWS Trusted Advisor Data Types API Reference The TrustedAdvisor Public API API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AccountRecommendationLifecycleSummary • CheckSummary • OrganizationRecommendation • OrganizationRecommendationResourceSummary • OrganizationRecommendationSummary • Recommendation • RecommendationCostOptimizingAggregates • RecommendationPillarSpeciﬁcAggregates • RecommendationResourceExclusion • RecommendationResourcesAggregates • RecommendationResourceSummary • RecommendationSummary • UpdateRecommendationResourceExclusionError API Version 2022-09-15 65 AWS Trusted
ta-api-012	ta-api.pdf	12	Python • AWS SDK for Ruby V3 See Also API Version 2022-09-15 64 AWS Trusted Advisor Data Types API Reference The TrustedAdvisor Public API API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AccountRecommendationLifecycleSummary • CheckSummary • OrganizationRecommendation • OrganizationRecommendationResourceSummary • OrganizationRecommendationSummary • Recommendation • RecommendationCostOptimizingAggregates • RecommendationPillarSpeciﬁcAggregates • RecommendationResourceExclusion • RecommendationResourcesAggregates • RecommendationResourceSummary • RecommendationSummary • UpdateRecommendationResourceExclusionError API Version 2022-09-15 65 AWS Trusted Advisor API Reference AccountRecommendationLifecycleSummary Summary of an AccountRecommendationLifecycle for an Organization Recommendation Contents accountId The AWS account ID Type: String Length Constraints: Fixed length of 12. Pattern: ^\d+$ Required: No accountRecommendationArn The Recommendation ARN Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor::\d{12}:recommendation\/[\w-]+$ Required: No lastUpdatedAt When the Recommendation was last updated Type: Timestamp Required: No lifecycleStage The lifecycle stage from AWS Trusted Advisor Priority Type: String Valid Values: in_progress \| pending_response \| dismissed \| resolved AccountRecommendationLifecycleSummary API Version 2022-09-15 66 AWS Trusted Advisor Required: No updatedOnBehalfOf API Reference The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority Type: String Required: No updatedOnBehalfOfJobTitle The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority Type: String Required: No updateReason Reason for the lifecycle stage change Type: String Length Constraints: Minimum length of 10. Maximum length of 4096. Pattern: ^[\s\S]*$ Required: No updateReasonCode Reason code for the lifecycle state change Type: String Valid Values: non_critical_account \| temporary_account \| valid_business_case \| other_methods_available \| low_priority \| not_applicable \| other Required: No Contents API Version 2022-09-15 67 AWS Trusted Advisor See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-09-15 68 API Reference AWS Trusted Advisor CheckSummary A summary of an AWS Trusted Advisor Check Contents arn The ARN of the AWS Trusted Advisor Check Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor:::check\/[\w-]+$ Required: Yes awsServices The AWS Services that the Check applies to Type: Array of strings Length Constraints: Minimum length of 2. Maximum length of 30. Required: Yes description A description of what the AWS Trusted Advisor Check is monitoring Type: String Required: Yes id The unique identiﬁer of the AWS Trusted Advisor Check Type: String Required: Yes metadata The column headings for the metadata returned in the resource CheckSummary API Version 2022-09-15 69 API Reference AWS Trusted Advisor Type: String to string map Required: Yes name The name of the AWS Trusted Advisor Check Type: String Required: Yes pillars The Recommendation pillars that the AWS Trusted Advisor Check falls under Type: Array of strings Valid Values: cost_optimizing \| performance \| security \| service_limits \| fault_tolerance \| operational_excellence Required: Yes source The source of the Recommendation Type: String Valid Values: aws_config \| compute_optimizer \| cost_explorer \| lse \| manual \| pse \| rds \| resilience \| resilience_hub \| security_hub \| stir \| ta_check \| well_architected Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-09-15 70 AWS Trusted Advisor API Reference See Also API Version 2022-09-15 71 AWS Trusted Advisor API Reference OrganizationRecommendation A Recommendation for accounts within an Organization Contents arn The ARN of the Recommendation Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor:::organization-recommendation\/[\w-]+$ Required: Yes description A description for AWS Trusted Advisor recommendations Type: String Required: Yes id The ID which identiﬁes where the Recommendation was produced Type: String Required: Yes name The name of the AWS Trusted Advisor Recommendation Type: String Required: Yes pillars The Pillars that the Recommendation is optimizing OrganizationRecommendation API Version 2022-09-15 72 AWS Trusted Advisor Type: Array of strings API Reference Valid Values: cost_optimizing \| performance \| security \| service_limits \| fault_tolerance \| operational_excellence Required: Yes resourcesAggregates An aggregation of all resources Type: RecommendationResourcesAggregates object Required: Yes source The source of the Recommendation Type: String Valid Values: aws_config \| compute_optimizer \| cost_explorer \| lse \| manual \| pse \| rds \| resilience \| resilience_hub \| security_hub \| stir \| ta_check \| well_architected Required: Yes status The status of
ta-api-013	ta-api.pdf	13	name of the AWS Trusted Advisor Recommendation Type: String Required: Yes pillars The Pillars that the Recommendation is optimizing OrganizationRecommendation API Version 2022-09-15 72 AWS Trusted Advisor Type: Array of strings API Reference Valid Values: cost_optimizing \| performance \| security \| service_limits \| fault_tolerance \| operational_excellence Required: Yes resourcesAggregates An aggregation of all resources Type: RecommendationResourcesAggregates object Required: Yes source The source of the Recommendation Type: String Valid Values: aws_config \| compute_optimizer \| cost_explorer \| lse \| manual \| pse \| rds \| resilience \| resilience_hub \| security_hub \| stir \| ta_check \| well_architected Required: Yes status The status of the Recommendation Type: String Valid Values: ok \| warning \| error Required: Yes type Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority Type: String Valid Values: standard \| priority Required: Yes Contents API Version 2022-09-15 73 AWS Trusted Advisor awsServices API Reference The AWS Services that the Recommendation applies to Type: Array of strings Length Constraints: Minimum length of 2. Maximum length of 30. Required: No checkArn The AWS Trusted Advisor Check ARN that relates to the Recommendation Type: String Required: No createdAt When the Recommendation was created, if created by AWS Trusted Advisor Priority Type: Timestamp Required: No createdBy The creator, if created by AWS Trusted Advisor Priority Type: String Required: No lastUpdatedAt When the Recommendation was last updated Type: Timestamp Required: No lifecycleStage The lifecycle stage from AWS Trusted Advisor Priority Type: String Contents API Version 2022-09-15 74 AWS Trusted Advisor API Reference Valid Values: in_progress \| pending_response \| dismissed \| resolved Required: No pillarSpeciﬁcAggregates The pillar aggregations for cost savings Type: RecommendationPillarSpeciﬁcAggregates object Required: No resolvedAt When the Recommendation was resolved Type: Timestamp Required: No updatedOnBehalfOf The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority Type: String Required: No updatedOnBehalfOfJobTitle The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority Type: String Required: No updateReason Reason for the lifecycle stage change Type: String Length Constraints: Minimum length of 10. Maximum length of 4096. Contents API Version 2022-09-15 75 AWS Trusted Advisor Pattern: ^[\s\S]*$ Required: No updateReasonCode Reason code for the lifecycle state change Type: String API Reference Valid Values: non_critical_account \| temporary_account \| valid_business_case \| other_methods_available \| low_priority \| not_applicable \| other Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-09-15 76 AWS Trusted Advisor API Reference OrganizationRecommendationResourceSummary Organization Recommendation Resource Summary Contents arn The ARN of the Recommendation Resource Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor::\d{12}:recommendation-resource\/[\w-]+ \/[\w-]+$ Required: Yes awsResourceId The AWS resource identiﬁer. There are certain checks that generate recommendation resources without an awsResourceId. Type: String Required: Yes id The ID of the Recommendation Resource Type: String Required: Yes lastUpdatedAt When the Recommendation Resource was last updated Type: Timestamp Required: Yes OrganizationRecommendationResourceSummary API Version 2022-09-15 77 AWS Trusted Advisor metadata Metadata associated with the Recommendation Resource API Reference Type: String to string map Required: Yes recommendationArn The Recommendation ARN Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor:::organization-recommendation\/[\w-]+$ Required: Yes regionCode The AWS Region code that the Recommendation Resource is in Type: String Length Constraints: Minimum length of 9. Maximum length of 20. Required: Yes status The current status of the Recommendation Resource Type: String Valid Values: ok \| warning \| error Required: Yes accountId The AWS account ID Type: String Length Constraints: Fixed length of 12. Contents API Version 2022-09-15 78 API Reference AWS Trusted Advisor Pattern: ^\d+$ Required: No exclusionStatus The exclusion status of the Recommendation Resource Type: String Valid Values: excluded \| included Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-09-15 79 AWS Trusted Advisor API Reference OrganizationRecommendationSummary Summary of recommendation for accounts within an Organization Contents arn The ARN of the Recommendation Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor:::organization-recommendation\/[\w-]+$ Required: Yes id The ID which identiﬁes where the Recommendation was produced Type: String Required: Yes name The name of the AWS Trusted Advisor Recommendation Type: String Required: Yes pillars The Pillars that the Recommendation is optimizing Type: Array of strings Valid Values: cost_optimizing \|
ta-api-014	ta-api.pdf	14	for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-09-15 79 AWS Trusted Advisor API Reference OrganizationRecommendationSummary Summary of recommendation for accounts within an Organization Contents arn The ARN of the Recommendation Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor:::organization-recommendation\/[\w-]+$ Required: Yes id The ID which identiﬁes where the Recommendation was produced Type: String Required: Yes name The name of the AWS Trusted Advisor Recommendation Type: String Required: Yes pillars The Pillars that the Recommendation is optimizing Type: Array of strings Valid Values: cost_optimizing \| performance \| security \| service_limits \| fault_tolerance \| operational_excellence Required: Yes OrganizationRecommendationSummary API Version 2022-09-15 80 API Reference AWS Trusted Advisor resourcesAggregates An aggregation of all resources Type: RecommendationResourcesAggregates object Required: Yes source The source of the Recommendation Type: String Valid Values: aws_config \| compute_optimizer \| cost_explorer \| lse \| manual \| pse \| rds \| resilience \| resilience_hub \| security_hub \| stir \| ta_check \| well_architected Required: Yes status The status of the Recommendation Type: String Valid Values: ok \| warning \| error Required: Yes type Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority Type: String Valid Values: standard \| priority Required: Yes awsServices The AWS Services that the Recommendation applies to Type: Array of strings Contents API Version 2022-09-15 81 AWS Trusted Advisor API Reference Length Constraints: Minimum length of 2. Maximum length of 30. Required: No checkArn The AWS Trusted Advisor Check ARN that relates to the Recommendation Type: String Required: No createdAt When the Recommendation was created, if created by AWS Trusted Advisor Priority Type: Timestamp Required: No lastUpdatedAt When the Recommendation was last updated Type: Timestamp Required: No lifecycleStage The lifecycle stage from AWS Trusted Advisor Priority Type: String Valid Values: in_progress \| pending_response \| dismissed \| resolved Required: No pillarSpeciﬁcAggregates The pillar aggregations for cost savings Type: RecommendationPillarSpeciﬁcAggregates object Required: No Contents API Version 2022-09-15 82 AWS Trusted Advisor See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-09-15 83 API Reference AWS Trusted Advisor Recommendation A Recommendation for an Account Contents arn The ARN of the Recommendation Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor::\d{12}:recommendation\/[\w-]+$ Required: Yes description A description for AWS Trusted Advisor recommendations Type: String Required: Yes id The ID which identiﬁes where the Recommendation was produced Type: String Required: Yes name The name of the AWS Trusted Advisor Recommendation Type: String Required: Yes pillars The Pillars that the Recommendation is optimizing Recommendation API Version 2022-09-15 84 AWS Trusted Advisor Type: Array of strings API Reference Valid Values: cost_optimizing \| performance \| security \| service_limits \| fault_tolerance \| operational_excellence Required: Yes resourcesAggregates An aggregation of all resources Type: RecommendationResourcesAggregates object Required: Yes source The source of the Recommendation Type: String Valid Values: aws_config \| compute_optimizer \| cost_explorer \| lse \| manual \| pse \| rds \| resilience \| resilience_hub \| security_hub \| stir \| ta_check \| well_architected Required: Yes status The status of the Recommendation Type: String Valid Values: ok \| warning \| error Required: Yes type Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority Type: String Valid Values: standard \| priority Required: Yes Contents API Version 2022-09-15 85 AWS Trusted Advisor awsServices API Reference The AWS Services that the Recommendation applies to Type: Array of strings Length Constraints: Minimum length of 2. Maximum length of 30. Required: No checkArn The AWS Trusted Advisor Check ARN that relates to the Recommendation Type: String Required: No createdAt When the Recommendation was created, if created by AWS Trusted Advisor Priority Type: Timestamp Required: No createdBy The creator, if created by AWS Trusted Advisor Priority Type: String Required: No lastUpdatedAt When the Recommendation was last updated Type: Timestamp Required: No lifecycleStage The lifecycle stage from AWS Trusted Advisor Priority Type: String Contents API Version 2022-09-15 86 AWS Trusted Advisor API Reference Valid Values: in_progress \| pending_response \| dismissed \| resolved Required: No pillarSpeciﬁcAggregates The pillar aggregations for cost savings Type: RecommendationPillarSpeciﬁcAggregates object Required: No resolvedAt When the Recommendation was resolved Type: Timestamp Required: No updatedOnBehalfOf The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority Type: String Required: No updatedOnBehalfOfJobTitle The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority Type: String Required:
ta-api-015	ta-api.pdf	15	cost savings Type: RecommendationPillarSpeciﬁcAggregates object Required: No resolvedAt When the Recommendation was resolved Type: Timestamp Required: No updatedOnBehalfOf The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority Type: String Required: No updatedOnBehalfOfJobTitle The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority Type: String Required: No updateReason Reason for the lifecycle stage change Type: String Length Constraints: Minimum length of 10. Maximum length of 4096. Contents API Version 2022-09-15 87 AWS Trusted Advisor Pattern: ^[\s\S]*$ Required: No updateReasonCode Reason code for the lifecycle state change Type: String API Reference Valid Values: non_critical_account \| temporary_account \| valid_business_case \| other_methods_available \| low_priority \| not_applicable \| other Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-09-15 88 AWS Trusted Advisor API Reference RecommendationCostOptimizingAggregates Cost optimizing aggregates for a Recommendation Contents estimatedMonthlySavings The estimated monthly savings Type: Double Required: Yes estimatedPercentMonthlySavings The estimated percently monthly savings Type: Double Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RecommendationCostOptimizingAggregates API Version 2022-09-15 89 AWS Trusted Advisor API Reference RecommendationPillarSpeciﬁcAggregates Recommendation pillar aggregates Contents costOptimizing Cost optimizing aggregates Type: RecommendationCostOptimizingAggregates object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RecommendationPillarSpeciﬁcAggregates API Version 2022-09-15 90 AWS Trusted Advisor API Reference RecommendationResourceExclusion The request entry for Recommendation Resource exclusion. Each entry is a combination of Recommendation Resource ARN and corresponding exclusion status Contents arn The ARN of the Recommendation Resource Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor::\d{12}:recommendation-resource\/[\w-]+ \/[\w-]+$ Required: Yes isExcluded The exclusion status Type: Boolean Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RecommendationResourceExclusion API Version 2022-09-15 91 AWS Trusted Advisor API Reference RecommendationResourcesAggregates Aggregation of Recommendation Resources Contents errorCount The number of AWS resources that were ﬂagged to have errors according to the Trusted Advisor check Type: Long Required: Yes okCount The number of AWS resources that were ﬂagged to be OK according to the Trusted Advisor check Type: Long Required: Yes warningCount The number of AWS resources that were ﬂagged to have warning according to the Trusted Advisor check Type: Long Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RecommendationResourcesAggregates API Version 2022-09-15 92 AWS Trusted Advisor API Reference See Also API Version 2022-09-15 93 AWS Trusted Advisor API Reference RecommendationResourceSummary Summary of a Recommendation Resource Contents arn The ARN of the Recommendation Resource Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor::\d{12}:recommendation-resource\/[\w-]+ \/[\w-]+$ Required: Yes awsResourceId The AWS resource identiﬁer. There are certain checks that generate recommendation resources without an awsResourceId. Type: String Required: Yes id The ID of the Recommendation Resource Type: String Required: Yes lastUpdatedAt When the Recommendation Resource was last updated Type: Timestamp Required: Yes RecommendationResourceSummary API Version 2022-09-15 94 AWS Trusted Advisor metadata Metadata associated with the Recommendation Resource API Reference Type: String to string map Required: Yes recommendationArn The Recommendation ARN Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor::\d{12}:recommendation\/[\w-]+$ Required: Yes regionCode The AWS Region code that the Recommendation Resource is in Type: String Length Constraints: Minimum length of 9. Maximum length of 20. Required: Yes status The current status of the Recommendation Resource Type: String Valid Values: ok \| warning \| error Required: Yes exclusionStatus The exclusion status of the Recommendation Resource Type: String Valid Values: excluded \| included Contents API Version 2022-09-15 95 AWS Trusted Advisor Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-09-15
ta-api-016	ta-api.pdf	16	String Length Constraints: Minimum length of 9. Maximum length of 20. Required: Yes status The current status of the Recommendation Resource Type: String Valid Values: ok \| warning \| error Required: Yes exclusionStatus The exclusion status of the Recommendation Resource Type: String Valid Values: excluded \| included Contents API Version 2022-09-15 95 AWS Trusted Advisor Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-09-15 96 AWS Trusted Advisor API Reference RecommendationSummary Summary of Recommendation for an Account Contents arn The ARN of the Recommendation Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor::\d{12}:recommendation\/[\w-]+$ Required: Yes id The ID which identiﬁes where the Recommendation was produced Type: String Required: Yes name The name of the AWS Trusted Advisor Recommendation Type: String Required: Yes pillars The Pillars that the Recommendation is optimizing Type: Array of strings Valid Values: cost_optimizing \| performance \| security \| service_limits \| fault_tolerance \| operational_excellence Required: Yes RecommendationSummary API Version 2022-09-15 97 API Reference AWS Trusted Advisor resourcesAggregates An aggregation of all resources Type: RecommendationResourcesAggregates object Required: Yes source The source of the Recommendation Type: String Valid Values: aws_config \| compute_optimizer \| cost_explorer \| lse \| manual \| pse \| rds \| resilience \| resilience_hub \| security_hub \| stir \| ta_check \| well_architected Required: Yes status The status of the Recommendation Type: String Valid Values: ok \| warning \| error Required: Yes type Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority Type: String Valid Values: standard \| priority Required: Yes awsServices The AWS Services that the Recommendation applies to Type: Array of strings Contents API Version 2022-09-15 98 AWS Trusted Advisor API Reference Length Constraints: Minimum length of 2. Maximum length of 30. Required: No checkArn The AWS Trusted Advisor Check ARN that relates to the Recommendation Type: String Required: No createdAt When the Recommendation was created, if created by AWS Trusted Advisor Priority Type: Timestamp Required: No lastUpdatedAt When the Recommendation was last updated Type: Timestamp Required: No lifecycleStage The lifecycle stage from AWS Trusted Advisor Priority Type: String Valid Values: in_progress \| pending_response \| dismissed \| resolved Required: No pillarSpeciﬁcAggregates The pillar aggregations for cost savings Type: RecommendationPillarSpeciﬁcAggregates object Required: No Contents API Version 2022-09-15 99 AWS Trusted Advisor See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-09-15 100 AWS Trusted Advisor API Reference UpdateRecommendationResourceExclusionError The error entry for Recommendation Resource exclusion. Each entry is a combination of Recommendation Resource ARN, error code and error message Contents arn The ARN of the Recommendation Resource Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:[\w-]+:trustedadvisor::\d{12}:recommendation-resource\/[\w-]+ \/[\w-]+$ Required: No errorCode The error code Type: String Required: No errorMessage The error message Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ UpdateRecommendationResourceExclusionError API Version 2022-09-15 101 AWS Trusted Advisor • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2022-09-15 102 AWS Trusted Advisor API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2022-09-15 103 AWS Trusted Advisor API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601
ta-api-017	ta-api.pdf	17	which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2022-09-15 103 AWS Trusted Advisor API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2022-09-15 104 AWS Trusted Advisor Type: string Required: Conditional X-Amz-SignedHeaders API Reference Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2022-09-15 105 AWS Trusted Advisor API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm speciﬁed by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2022-09-15 106 AWS Trusted Advisor HTTP Status Code: 403 RequestAbortedException API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2022-09-15 107 AWS Trusted Advisor UnknownOperationException API Reference The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 API Version 2022-09-15 108
tag-editor-userguide-001	tag-editor-userguide.pdf	1	User Guide Tagging AWS Resources and Tag Editor Version 1.0 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Tagging AWS Resources and Tag Editor User Guide Tagging AWS Resources and Tag Editor: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Tagging AWS Resources and Tag Editor Table of Contents User Guide .......................................................................................................................................................... v What is Tag Editor? ......................................................................................................................... 1 Tagging methods .......................................................................................................................................... 1 Learn more ............................................................................................................................................... 2 Best practices and strategies ..................................................................................................................... 3 Best practices ........................................................................................................................................... 3 Tag naming best practices .................................................................................................................... 4 Common tagging strategies ................................................................................................................. 5 Tagging categories ....................................................................................................................................... 7 Getting started ................................................................................................................................ 9 Prerequisites ................................................................................................................................................ 10 Sign up for an AWS account .............................................................................................................. 10 Create a user with administrative access ......................................................................................... 10 Create resources .................................................................................................................................... 12 Set up permissions ..................................................................................................................................... 12 Permissions for individual services ................................................................................................... 12 Permissions required to use the Tag Editor console ..................................................................... 13 Granting permissions for using Tag Editor ...................................................................................... 15 Authorization and access control based on tags ............................................................................ 16 Finding resources to tag ............................................................................................................... 18 View and edit existing tags for a selected resource ........................................................................... 20 Export results to .csv ﬁle ..................................................................................................................... 21 Managing tags ............................................................................................................................... 22 Add tags to selected resources ............................................................................................................... 23 Edit tags of selected resources ............................................................................................................... 24 Remove tags from selected resources ................................................................................................... 25 Using tags in IAM policies ............................................................................................................ 27 Tags and attribute-based access control ............................................................................................... 27 Tag-related condition keys ....................................................................................................................... 27 Example IAM policies that use tags ....................................................................................................... 28 AWS Organizations tag policies ................................................................................................... 30 Prerequisites and permissions ................................................................................................................. 30 Prerequisites for evaluating compliance with tag policies ........................................................... 30 Permissions for evaluating compliance for an account ................................................................ 31 Version 1.0 iii Tagging AWS Resources and Tag Editor User Guide Permissions for evaluating organization-wide compliance .......................................................... 31 Amazon S3 bucket policy for report storage .................................................................................. 34 Evaluating compliance for an account .................................................................................................. 35 Evaluating organization-wide compliance ............................................................................................ 37 Monitoring tag changes ................................................................................................................ 41 Tag changes generate EventBridge events ........................................................................................... 41 Lambda and serverless ............................................................................................................................. 43 Monitoring tutorial .................................................................................................................................... 43 Step 1. Create the Lambda function ................................................................................................ 45 Step 2. Set up the required IAM permissions ................................................................................. 48 Step 3. Do a preliminary test of your Lambda function ............................................................... 49 Step 4. Create the EventBridge rule that launches the function ................................................ 52 Step 5. Test the complete solution ................................................................................................... 53 Tutorial summary .................................................................................................................................. 55 Troubleshooting tag changes ....................................................................................................... 56 Retry failed tag changes .......................................................................................................................... 56 Security .......................................................................................................................................... 57 Data protection ........................................................................................................................................... 57 Data encryption ..................................................................................................................................... 58 Internetwork traﬃc privacy ................................................................................................................ 59 Identity and access management ........................................................................................................... 59 Audience .................................................................................................................................................. 60 Authenticating with identities ............................................................................................................ 60 Managing access using policies .......................................................................................................... 63 How Tag Editor works with IAM ........................................................................................................ 66 Identity-based policy examples ......................................................................................................... 69 Troubleshooting .................................................................................................................................... 73 Logging and monitoring ........................................................................................................................... 74 CloudTrail Integration .......................................................................................................................... 75 Compliance validation ............................................................................................................................... 77 Resilience ...................................................................................................................................................... 78 Infrastructure security ............................................................................................................................... 79 Tag Editor service quotas ............................................................................................................. 80 Document history .......................................................................................................................... 82 Version 1.0 iv Tagging AWS Resources and Tag Editor User Guide AWS has moved Tag Editor tag management functionality from the AWS Resource Groups console to the AWS Resource Explorer console. With Resource Explorer, you can search and ﬁlter resources and then manage resource tags from a single console. To learn more about managing resource tags in Resource Explorer, review Managing resources in the Resource Explorer user guide. Version 1.0 v Tagging AWS Resources and Tag Editor User Guide What is Tag Editor? Tag Editor enables you to eﬀectively manage tags. Tags are key and value pairs that act as metadata for organizing your AWS resources. With most AWS resources, you have the option of adding tags when you create the resource. Examples of resources include an Amazon Elastic Compute Cloud (Amazon EC2) instance, an Amazon Simple Storage Service (Amazon S3) bucket, or a secret in AWS Secrets Manager. Important Do not store personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Tags can help you manage, identify, organize, search for, and ﬁlter resources. You can create tags to categorize resources by purpose, owner, environment, or other criteria. Each tag has two parts: • A tag key (for example, CostCenter, Environment, or Project). Tag keys are case sensitive. • A tag value (for example, 111122223333 or Production). Like tag keys, tag values are case sensitive.
tag-editor-userguide-002	tag-editor-userguide.pdf	2	not store personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Tags can help you manage, identify, organize, search for, and ﬁlter resources. You can create tags to categorize resources by purpose, owner, environment, or other criteria. Each tag has two parts: • A tag key (for example, CostCenter, Environment, or Project). Tag keys are case sensitive. • A tag value (for example, 111122223333 or Production). Like tag keys, tag values are case sensitive. Note Although tag keys are case sensitive, IAM has additional validations for IAM resources to prevent the application of tag keys that only diﬀer in casing. We recommend not using keys that only diﬀer in casing. Instead, you can use Service Control Policies (SCPs), which provide central control over the maximum available permissions for the IAM users and IAM roles in your organization. Resource tagging methods There are three ways to add tags to your AWS resources: Tagging methods Version 1.0 1 Tagging AWS Resources and Tag Editor User Guide • AWS service API operation – The tagging API operations supported directly an AWS service. To discover what tagging functionality each AWS service provides, see the service's documentation in the AWS documentation index. • Tag Editor console – Some services support tagging with the Tag Editor console. • Resource Groups Tagging API – Most services also support tagging using the AWS Resource Groups Tagging API. Note You can also use AWS Service Catalog TagOptions Library to easily manage tags on provisioned products. A TagOption is a key-value pair managed in Service Catalog. It is not an AWS tag, but serves as a template for creating an AWS tag based on the TagOption. You can tag resources for all cost-accruing services in AWS. For the following services, AWS recommends newer alternative AWS services that support tagging to better meet customer use cases. Amazon Cloud Directory Amazon CloudSearch Amazon Cognito Sync AWS Data Pipeline Amazon Elastic Transcoder Amazon Machine Learning AWS OpsWorks Stacks Amazon S3 Glacier Direct Amazon SimpleDB Amazon WorkSpaces Applicati on Manager AWS DeepLens Learn more This page provides general information on tagging AWS resources. For more information about tagging resources in a particular AWS service, see its documentation. The following are also good sources of information about tagging: • For information about the AWS Resource Groups Tagging API, see the Resource Groups Tagging API Reference Guide. Learn more Version 1.0 2 Tagging AWS Resources and Tag Editor User Guide • For information about the tagging functionality each AWS service provides, see the service's documentation in the AWS documentation index. • For information about using tags in IAM policies to help control who can view and interact with your AWS resources, see Controlling access to and for IAM users and roles using tags in the IAM User Guide. Best practices and strategies These sections provide information about best practices and strategies when tagging your AWS resources and using Tag Editor. Tagging best practices As you create a tagging strategy for AWS resources, follow best practices: • Do not add personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. Tags are accessible to many AWS services, including billing. Tags are not intended to be used for private or sensitive data. • Use a standardized, case-sensitive format for tags, and apply it consistently across all resource types. • Consider tag guidelines that support multiple purposes, like managing resource access control, cost tracking, automation, and organization. • Use automated tools to help manage resource tags. Tag Editor and the Resource Groups Tagging API enable programmatic control of tags, making it easier to automatically manage, search, and ﬁlter tags and resources. • Use too many tags rather than too few tags. • Remember that it is easy to change tags to accommodate changing business requirements, but consider the consequences of future changes. For example, changing access control tags means you must also update the policies that reference those tags and control access to your resources. • You can automatically enforce the tagging standards that your organization chooses to adopt by creating and deploying tag policies using AWS Organizations. Tag policies let you specify tagging rules that deﬁne valid key names and the values that are valid for each key. You can choose to only monitor, giving you an opportunity to evaluate and clean up your existing tags. Once your tags are in compliance with your chosen standards, you can then turn on enforcement in the Best practices and strategies Version 1.0 3 Tagging AWS Resources and Tag Editor User Guide tag policies to prevent non-compliant tags from being created. For more information, see Tag policies in the AWS Organizations User Guide.
tag-editor-userguide-003	tag-editor-userguide.pdf	3	and deploying tag policies using AWS Organizations. Tag policies let you specify tagging rules that deﬁne valid key names and the values that are valid for each key. You can choose to only monitor, giving you an opportunity to evaluate and clean up your existing tags. Once your tags are in compliance with your chosen standards, you can then turn on enforcement in the Best practices and strategies Version 1.0 3 Tagging AWS Resources and Tag Editor User Guide tag policies to prevent non-compliant tags from being created. For more information, see Tag policies in the AWS Organizations User Guide. Tag naming best practices These are some best practices and naming conventions that we recommend that you use with your tags. Key names for AWS tags are case sensitive so ensure that they are used consistently. For example, the tags keys CostCenter and costcenter are diﬀerent. One tag key might be conﬁgured as a cost allocation tag for ﬁnancial analysis and reporting, and the other tag key might not be conﬁgured for the same use. A number of tags are predeﬁned by AWS or created automatically by various AWS services. Many AWS generated tags use key names that are all lowercase, with hyphens separating words in the name, and preﬁxes followed by colons to identify the source service for the tag. For example, see the following: • aws:ec2spot:fleet-request-id is a tag that identiﬁes the Amazon EC2 Spot Instance Request that launched the instance. • aws:cloudformation:stack-name is a tag that identiﬁes the AWS CloudFormation stack that created the resource. • elasticbeanstalk:environment-name is a tag that identiﬁes the application that created the resource. Consider naming your tags using the following rules: • Use all lowercase for the words. • Use hyphens to separate words. • Use a preﬁx followed by a colon to identify the organization name or abbreviated name. For example, for a ﬁctitious company named AnyCompany, you might deﬁne tags such as: • anycompany:cost-center to identify the internal Cost Center code. • anycompany:environment-type to identify whether the environment is development, test, or production. Tag naming best practices Version 1.0 4 Tagging AWS Resources and Tag Editor User Guide • anycompany:application-id to identify the application that the resource was created for. The preﬁx ensures that tags are clearly recognizable as deﬁned by your organization and not by AWS or a third-party tool that you might be using. Using all lowercase with hyphens for separators avoids confusion about how to capitalize a tag name. For example, anycompany:project- id is simpler to remember than ANYCOMPANY:ProjectID, anycompany:projectID, or Anycompany:ProjectId. Tag naming limits and requirements The following basic naming and usage requirements apply to tags: • Each resource can have a maximum of 50 user created tags. • System created tags that begin with aws: are reserved for AWS use, and do not count against this limit. You can't edit or delete a tag that begins with the aws: preﬁx. • For each resource, each tag key must be unique, and each tag key can have only one value. • The tag key must be a minimum of 1 and a maximum of 128 Unicode characters in UTF-8. • The tag value must be a minimum of 0 and a maximum of 256 Unicode characters in UTF-8. • Allowed characters can vary by AWS service. For information about what characters you can use to tag resources in a particular AWS service, see its documentation. In general, the allowed characters are letters, numbers, spaces representable in UTF-8, and the following characters: _ . : / = + - @. • Tag keys and values are case sensitive. As a best practice, decide on a strategy for capitalizing tags, and consistently implement that strategy across all resource types. For example, decide whether to use Costcenter, costcenter, or CostCenter, and use the same convention for all tags. Avoid using similar tags with inconsistent case treatment. Common tagging strategies Use the following tagging strategies to help identify and manage AWS resources. Contents • Tags for resource organization • Tags for cost allocation • Tags for automation Common tagging strategies Version 1.0 5 Tagging AWS Resources and Tag Editor • Tags for access control • Tagging governance Tags for resource organization User Guide Tags are a good way to organize AWS resources in the AWS Management Console. You can conﬁgure tags to be displayed with resources, and can search and ﬁlter by tag. With the AWS Resource Groups service, you can create groups of AWS resources based on one or more tags or portions of tags. You can also create groups based on their occurrence in an AWS CloudFormation stack. Using Resource Groups and Tag Editor, you can consolidate and view data for applications that consist of multiple services, resources, and Regions in one place. Tags for cost allocation AWS
tag-editor-userguide-004	tag-editor-userguide.pdf	4	organization User Guide Tags are a good way to organize AWS resources in the AWS Management Console. You can conﬁgure tags to be displayed with resources, and can search and ﬁlter by tag. With the AWS Resource Groups service, you can create groups of AWS resources based on one or more tags or portions of tags. You can also create groups based on their occurrence in an AWS CloudFormation stack. Using Resource Groups and Tag Editor, you can consolidate and view data for applications that consist of multiple services, resources, and Regions in one place. Tags for cost allocation AWS Cost Explorer and detailed billing reports let you break down AWS costs by tag. Typically, you use business tags such as cost center/business unit, customer, or project to associate AWS costs with traditional cost-allocation dimensions. But a cost allocation report can include any tag. This lets you associate costs with technical or security dimensions, such as speciﬁc applications, environments, or compliance programs. For some services, you can use an AWS-generated createdBy tag for cost allocation purposes, to help account for resources that might otherwise go uncategorized. The createdBy tag is available only for supported AWS services and resources. Its value contains data associated with speciﬁc API or console events. For more information, see AWS-Generated Cost Allocation Tags in the AWS Billing and Cost Management User Guide. Tags for automation Resource or service-speciﬁc tags are often used to ﬁlter resources during automation activities. Automation tags are used to opt in or opt out of automated tasks or to identify speciﬁc versions of resources to archive, update, or delete. For example, you can run automated start or stop scripts that turn oﬀ development environments during nonbusiness hours to reduce costs. In this scenario, Amazon Elastic Compute Cloud (Amazon EC2) instance tags are a simple way to identify instances to opt out of this action. For scripts that ﬁnd and delete stale, out-of-date, or rolling Amazon EBS snapshots, snapshot tags can add an extra dimension of search criteria. Common tagging strategies Version 1.0 6 Tagging AWS Resources and Tag Editor Tags for access control User Guide IAM policies support tag-based conditions, letting you constrain IAM permissions based on speciﬁc tags or tag values. For example, IAM user or role permissions can include conditions to limit EC2 API calls to speciﬁc environments (such as development, test, or production) based on their tags. The same strategy can be used to limit API calls to speciﬁc Amazon Virtual Private Cloud (Amazon VPC) networks. Support for tag-based, resource-level IAM permissions is service speciﬁc. When you use tag-based conditions for access control, be sure to deﬁne and restrict who can modify the tags. For more information about using tags to control API access to AWS resources, see AWS services that work with IAM in the IAM User Guide. Tagging governance An eﬀective tagging strategy uses standardized tags and applies them consistently and programmatically across AWS resources. You can use both reactive and proactive approaches for governing tags in your AWS environment. • Reactive governance is for ﬁnding resources that are not properly tagged using tools such as the Resource Groups Tagging API, AWS Conﬁg Rules, and custom scripts. To ﬁnd resources manually, you can use Tag Editor and detailed billing reports. • Proactive governance uses tools such as AWS CloudFormation, Service Catalog, tag policies in AWS Organizations, or IAM resource-level permissions to ensure standardized tags are consistently applied at resource creation. For example, you can use the AWS CloudFormation Resource Tags property to apply tags to resource types. In Service Catalog, you can add portfolio and product tags that are combined and applied to a product automatically when it is launched. More rigorous forms of proactive governance include automated tasks. For example, you can use the Resource Groups Tagging API to search an AWS environment’s tags, or run scripts to quarantine or delete improperly tagged resources. Tagging categories Companies that are most eﬀective in their use of tags typically create business-relevant tag groupings to organize their resources along technical, business, and security dimensions. Companies that use automated processes to manage their infrastructure also include additional, automation-speciﬁc tags. Tagging categories Version 1.0 7 Tagging AWS Resources and Tag Editor User Guide Technical tags Tags for automation Business tags Security tags • Name – Identify • Date/Time – individual resources Identify the date • Project – Identify projects that the • Conﬁdentiality – An identiﬁer for • Application ID – Identify resources that are related to a speciﬁc applicati on • Application Role – Describe the function of a particular resource (such as web server, message broker, database) or time a resource resource supports the speciﬁc data should be started, stopped, deleted, or rotated • Opt in/Opt out – Indicate whether a resource should be included in an automated activity
tag-editor-userguide-005	tag-editor-userguide.pdf	5	User Guide Technical tags Tags for automation Business tags Security tags • Name – Identify • Date/Time – individual resources Identify the date • Project – Identify projects that the • Conﬁdentiality – An identiﬁer for • Application ID – Identify resources that are related to a speciﬁc applicati on • Application Role – Describe the function of a particular resource (such as web server, message broker, database) or time a resource resource supports the speciﬁc data should be started, stopped, deleted, or rotated • Opt in/Opt out – Indicate whether a resource should be included in an automated activity such as starting, stopping, or resizing instances • Owner – Identify who is responsible conﬁdentiality level a resource supports for the resource • Compliance – An identiﬁer for workloads that must adhere to speciﬁc compliance requirements • Cost Center/ Business Unit – Identify the cost center or business unit associated with a resource, typically for cost allocation and • Cluster – Identify resource farms that • Security – Determine tracking • Customer – Identify a speciﬁc client that a particular group of resources serves requirements, such as encryptio n or enabling of Amazon VPC ﬂow logs; identify route tables or security groups that need extra scrutiny share a common conﬁguration and perform a speciﬁc function for an application • Environme nt – Distingui sh between development, test, and production resources • Version – Help distinguish between versions of resources or applications Tagging categories Version 1.0 8 Tagging AWS Resources and Tag Editor User Guide Getting started with Tag Editor Important Do not store personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. To add tags to—or edit or delete tags of—multiple resources at once, use Tag Editor. With Tag Editor, you search for the resources that you want to tag, and then manage tags for the resources in your search results. To start Tag Editor 1. Sign in to the AWS Management Console. 2. Perform either of the following steps: • Choose Services. Then, under Management & Governance, choose Resource Groups & Tag Editor. In the navigation pane on the left, choose Tag Editor. • Use the direct link: AWS Tag Editor console. Not all resources can have tags applied. For information about which resources Tag Editor supports, see the Tag Editor taggingcolumn at Supported resource types in the AWS Resource Groups User Guide. If a resource type that you want to tag isn't supported, let AWS know by choosing Feedback in the lower left corner of the console window. For information about permissions and roles that are required to tag resources, see Set up permissions. Topics • Prerequisites for working with Tag Editor • Set up permissions Version 1.0 9 Tagging AWS Resources and Tag Editor User Guide Prerequisites for working with Tag Editor Before you get started working to tag your resources, be sure you have an active AWS account with existing resources and appropriate rights to tag resources and create groups. Topics • Sign up for an AWS account • Create a user with administrative access • Create resources Sign up for an AWS account If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a veriﬁcation code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. AWS sends you a conﬁrmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Prerequisites Version 1.0 10 Tagging AWS Resources and Tag Editor User Guide Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. 2. Turn on multi-factor authentication (MFA) for your root
tag-editor-userguide-006	tag-editor-userguide.pdf	6	user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Prerequisites Version 1.0 10 Tagging AWS Resources and Tag Editor User Guide Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. 2. Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Create a user with administrative access 1. Enable IAM Identity Center. For instructions, see Enabling AWS IAM Identity Center in the AWS IAM Identity Center User Guide. 2. In IAM Identity Center, grant administrative access to a user. For a tutorial about using the IAM Identity Center directory as your identity source, see Conﬁgure user access with the default IAM Identity Center directory in the AWS IAM Identity Center User Guide. Sign in as the user with administrative access • To sign in with your IAM Identity Center user, use the sign-in URL that was sent to your email address when you created the IAM Identity Center user. For help signing in using an IAM Identity Center user, see Signing in to the AWS access portal in the AWS Sign-In User Guide. Assign access to additional users 1. In IAM Identity Center, create a permission set that follows the best practice of applying least- privilege permissions. For instructions, see Create a permission set in the AWS IAM Identity Center User Guide. Create a user with administrative access Version 1.0 11 Tagging AWS Resources and Tag Editor User Guide 2. Assign users to a group, and then assign single sign-on access to the group. For instructions, see Add groups in the AWS IAM Identity Center User Guide. Create resources You must have resources in your AWS account to tag. For more information about the supported resource types, see the Tag Editor Tagging column under Supported resource types in the AWS Resource Groups User Guide. Set up permissions To make full use of Tag Editor, you might need additional permissions to tag resources or to see a resource's tag keys and values. These permissions are in the following categories: • Permissions for individual services so that you can tag resources from those services and include them in resource groups. • Permissions that are required to use the Tag Editor console. If you're an administrator, you can provide permissions for your users by creating policies through the AWS Identity and Access Management (IAM) service. You ﬁrst create IAM roles, users, or groups, and then apply the policies with the permissions that they need. For information about creating and attaching IAM policies, see Working with policies. Permissions for individual services Important This section describes permissions that are required if you want to tag resources from other AWS service consoles and APIs. To add tags to a resource, you need the permissions required for the service to which the resource belongs. For example, to tag Amazon EC2 instances, you must have permissions to the tagging operations in that service's API, such as the Amazon EC2 CreateTags operation. Create resources Version 1.0 12 Tagging AWS Resources and Tag Editor User Guide Permissions required to use the Tag Editor console To use the Tag Editor console to list and tag resources, the following permissions must be added to a user's policy statement in IAM. You can add either AWS managed policies that are maintained and kept up to date by AWS, or you can create and maintain your own custom policy. Using AWS managed policies for Tag Editor permissions Tag Editor supports the following AWS managed policies that you can use to provide a predeﬁned set of permissions to your users. You can attach these managed policies to any role, user, or group just as you would any other policy that you create. ResourceGroupsandTagEditorReadOnlyAccess This policy grants the attached IAM role or user permission to call the read-only operations for both AWS Resource Groups and Tag Editor. To read a resource's tags, you must also have permissions for that resource through a separate policy. Learn more in the following Important note. ResourceGroupsandTagEditorFullAccess This policy grants the attached IAM role or user permission to call any Resource Groups operation and the read and write tag operations in Tag Editor. To read or write a resource's tags, you must also have permissions for that resource through a separate policy. Learn more in the following Important note. Important The two previous policies grant permission to call the Tag Editor
tag-editor-userguide-007	tag-editor-userguide.pdf	7	the read-only operations for both AWS Resource Groups and Tag Editor. To read a resource's tags, you must also have permissions for that resource through a separate policy. Learn more in the following Important note. ResourceGroupsandTagEditorFullAccess This policy grants the attached IAM role or user permission to call any Resource Groups operation and the read and write tag operations in Tag Editor. To read or write a resource's tags, you must also have permissions for that resource through a separate policy. Learn more in the following Important note. Important The two previous policies grant permission to call the Tag Editor operations and use the Tag Editor console. However, you must also have permissions not only to invoke the operation, but also appropriate permissions to the speciﬁc resource whose tags you're trying to access. To grant that access to the tags, you must also attach one of the following policies: • The AWS managed policy ReadOnlyAccess grants permissions to the read-only operations for every service's resources. AWS automatically keeps this policy up to date with new AWS services as they become available. Permissions required to use the Tag Editor console Version 1.0 13 Tagging AWS Resources and Tag Editor User Guide • Many services provide service-speciﬁc read-only AWS managed policies that you can use to limit access to only the resources provided by that service. For example, Amazon EC2 provides AmazonEC2ReadOnlyAccess. • You can create your own policy that grants access to only the speciﬁc read-only operations for the few services and resources you want your users to access. This policy uses either an allowlist strategy or a denylist strategy. An allowlist strategy takes advantage of the fact that access is denied by default until you explicitly allow it in a policy. So, you can use a policy like the following example. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "tag:" ], "Resource": "<ARNs of resources to allow tagging>" } ] } Alternatively, you could use a denylist strategy that allows access to all resources except those that you explicitly block. This requires a separate policy that applies to the relevant users that allows access. The following example policy then denies access to the speciﬁc resources listed by the Amazon Resource Name (ARN). { "Version": "2012-10-17", "Statement": [ { "Effect": "Deny", "Action": [ "tag:" ], "Resource": "<ARNs of resources to disallow tagging>" } ] } Permissions required to use the Tag Editor console Version 1.0 14 Tagging AWS Resources and Tag Editor User Guide Adding Tag Editor permissions manually • tag:* (This permission allows all Tag Editor actions. If you instead want to restrict actions that are available to a user, you can replace the asterisk with a speciﬁc action, or with a comma- separated list of actions.) • tag:GetResources • tag:TagResources • tag:UntagResources • tag:getTagKeys • tag:getTagValues • resource-explorer:* • resource-groups:SearchResources • resource-groups:ListResourceTypes Note The resource-groups:SearchResources permission allows Tag Editor to list resources when you ﬁlter your search using tag keys or values. The resource-explorer:ListResources permission allows Tag Editor to list resources when you search resources without deﬁning search tags. Granting permissions for using Tag Editor To add a policy for using AWS Resource Groups and Tag Editor to a role, do the following. 1. Open the IAM console to the Roles page. 2. Find the role to which you want to grant Tag Editor permissions. Choose the role's name to open the role's Summary page. 3. On the Permissions tab, choose Add permissions. 4. Choose Attach existing policies directly. 5. Choose Create policy. 6. On the JSON tab, paste the following policy statement. Granting permissions for using Tag Editor Version 1.0 15 Tagging AWS Resources and Tag Editor User Guide { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "tag:GetResources", "tag:TagResources", "tag:UntagResources", "tag:getTagKeys", "tag:getTagValues", "resource-explorer:", "resource-groups:SearchResources", "resource-groups:ListResourceTypes" ], "Resource": "" } ] } Note This example policy statement grants permissions to perform only Tag Editor actions. 7. Choose Next: Tags and then choose Next: Review. 8. Enter a name and description for the new policy. For example, AWSTaggingAccess. 9. Choose Create policy. Now that the policy is saved in IAM, you can attach it to other principals, such as roles, groups, or users. For more information about how to add a policy to a principal, see Adding and removing IAM identity permissions in the IAM User Guide. Authorization and access control based on tags AWS services support the following: • Action-based policies – For example, you can create a policy that allows users to perform GetTagKeys or GetTagValues operations, but no others. Authorization and access control based on tags Version 1.0 16 Tagging AWS Resources and Tag Editor User Guide • Resource-level permissions in policies – Many services support using ARNs to specify individual resources in the policy. • Authorization based on tags – Many services
tag-editor-userguide-008	tag-editor-userguide.pdf	8	about how to add a policy to a principal, see Adding and removing IAM identity permissions in the IAM User Guide. Authorization and access control based on tags AWS services support the following: • Action-based policies – For example, you can create a policy that allows users to perform GetTagKeys or GetTagValues operations, but no others. Authorization and access control based on tags Version 1.0 16 Tagging AWS Resources and Tag Editor User Guide • Resource-level permissions in policies – Many services support using ARNs to specify individual resources in the policy. • Authorization based on tags – Many services support using resource tags in the condition of a policy. For example, you can create a policy that allows users full access to a group that has the same tag as the users. For more information, see What is ABAC for AWS? in the AWS Identity and Access Management User Guide. • Temporary credentials – Users can assume a role with a policy that allows Tag Editor operations. Tag Editor doesn't use any service-linked roles. For more information about how Tag Editor integrates with AWS Identity and Access Management (IAM), see the following topics in the AWS Identity and Access Management User Guide: • AWS services that work with IAM • Actions, resources, and condition keys for Tag Editor • Controlling access to AWS resources using policies Authorization and access control based on tags Version 1.0 17 Tagging AWS Resources and Tag Editor User Guide Finding resources to tag With Tag Editor, you build a query to ﬁnd resources in one or more AWS Regions that are available for tagging. You can choose up to 20 individual resource types, or build a query on All resource types. Your query can include resources that already have tags, or resources that have no tags. For more information, see the Tag Editor Tagging column at Supported resource types in the AWS Resource Groups User Guide. After you ﬁnd resources to tag, you can use Tag Editor to add tags, or view, edit, or delete tags. To ﬁnd resources to tag 1. Open the Tag Editor console. 2. (Optional) Choose the AWS Regions in which to search for resources to tag. By default, your current Region is used. For this procedure, choose us-east-1 and us-west-2. 3. Choose at least one resource type from the Resource types dropdown list. You can add or edit tags for up to 20 individual resource types at a time, or choose All resource types. For this procedure, choose AWS::EC2::Instance and AWS::S3::Bucket. 4. (Optional) In the Tags ﬁelds, enter a tag key, or a tag key and value pair, to limit the resources in the current AWS Region to only those that are tagged with your speciﬁed values. As you enter a tag key, matching tag keys in the current Region appear in a list. You can choose a tag key from the list. Tag Editor auto-completes the tag key for you as you type enough characters to match an existing key. Choose Add or press Enter when you've ﬁnished your tag. In this example, ﬁlter for resources that have a tag key of Stage. The tag value is optional but narrows the results of the query further. To add more tags, choose Add. Queries assign an AND operator to tags, so only resources that match both the speciﬁed resource type and all speciﬁed tags are returned by the query. Note The Tag Editor console doesn't currently support wildcards. To ﬁnd resources with multiple values for a tag key, add another tag with the same key to the query, but specify a diﬀerent value. The results include all resources that are tagged with the same tag key and that have any of the selected values. The search is case sensitive. Version 1.0 18 Tagging AWS Resources and Tag Editor User Guide Leave the Tags boxes empty to ﬁnd all resources of the speciﬁed type in the selected AWS Regions. This query returns resources that have any tags, and includes those that have no tags. To remove a tag from your query, choose X on the tag's label. To ﬁnd resources that have a tag, but with an empty value, choose (empty value). Note Before you can ﬁnd resources with the speciﬁed tags, they must have been applied to at least one resource of the speciﬁed type in the current AWS Region. 5. When your query is ready, choose Search resources. Results are displayed as a table in the Resource search results area. To ﬁlter a large number of resources, enter any ﬁlter text, such as part of the name of a resource, in Filter resources. Note You can use substrings to ﬁlter your results. 6. (Optional) To conﬁgure the columns that Tag Editor displays in your resource search results, choose
tag-editor-userguide-009	tag-editor-userguide.pdf	9	(empty value). Note Before you can ﬁnd resources with the speciﬁed tags, they must have been applied to at least one resource of the speciﬁed type in the current AWS Region. 5. When your query is ready, choose Search resources. Results are displayed as a table in the Resource search results area. To ﬁlter a large number of resources, enter any ﬁlter text, such as part of the name of a resource, in Filter resources. Note You can use substrings to ﬁlter your results. 6. (Optional) To conﬁgure the columns that Tag Editor displays in your resource search results, choose the Preferences gear icon in the Resource search results. On the Preferences page, choose the number of rows that you want displayed in your search results. If you'd like to see all the text in the table, select the Wrap lines check box. Turn on columns that you want Tag Editor to display in your results. You can show a column for each tag that occurs in your search results or a selected subset of your search results. You can do this anytime after you ﬁnd resources to tag. To enable a column, choose the switch icon next to the tag and change it from oﬀ to on. When you are ﬁnished conﬁguring visible columns and number of displayed rows, choose Conﬁrm. Version 1.0 19 Tagging AWS Resources and Tag Editor User Guide View and edit existing tags for a selected resource Tag Editor shows you the existing tags on selected resources that are in the results of your Find resources to tag query. If you enabled any Tag columns as described in the previous section, you can see the current value of that tag for each resource in the search results. Note This topic explains how to edit the tag for an individual resource. You can also bulk edit tags for several selected resources at the same time. For more information, see Managing tags with Tag Editor. To edit tags inline in the search results table 1. Choose the value for the tag on the resource that you want to edit. Note • If the chosen resource currently does not have a tag with the chosen key, the value displays as (not tagged). • If the chosen resource does have a tag with the chosen key but without a value, the value displays as '–'. 2. You can enter a new value or choose from any of the values already present on other resources with this tag. You can also delete the tag from this one resource by choosing Remove tag. To view all tags for an individual resource 1. In the results of your Find resources to tag query, choose the number in the Tags column for any resource for which you want to view existing tags. Resources with a dash in the Tags column do not have existing tags. 2. View existing tags in Resource tags. You can also open this window by choosing Manage tags of selected resources, when you're changing or removing tags from the Manage tags page. View and edit existing tags for a selected resource Version 1.0 20 Tagging AWS Resources and Tag Editor User Guide Note If you don’t see a tag that you recently applied to a resource, try refreshing your browser window. Export results to .csv ﬁle You can export the results of a Find resources to tag query to a comma-separated values (.csv) ﬁle. The .csv ﬁle includes the resource names, services, Region, resource IDs, the total number of tags, and a column for each unique tag key in the collection. The .csv ﬁle can help you develop a tagging strategy for resources in your organization, or determine where there are overlaps or inconsistencies in tagging across resources. 1. In the results of your Find resources to tag query, choose Export resources to CSV. 2. When you're prompted by your browser, choose to open the .csv ﬁle, or save it to a convenient location. Export results to .csv ﬁle Version 1.0 21 Tagging AWS Resources and Tag Editor User Guide Managing tags with Tag Editor After you ﬁnd resources that you want to tag, you can add, remove, and edit the tags for some or all of your search results. Tag Editor shows you any tags that are attached to resources. It also shows you whether those tags were added in Tag Editor, by the resource's service console, or by using the API. Important Do not store personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Other ways to manage your tags This topic discusses tagging resources by using Tag Editor in the
tag-editor-userguide-010	tag-editor-userguide.pdf	10	edit the tags for some or all of your search results. Tag Editor shows you any tags that are attached to resources. It also shows you whether those tags were added in Tag Editor, by the resource's service console, or by using the API. Important Do not store personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Other ways to manage your tags This topic discusses tagging resources by using Tag Editor in the AWS Management Console. However, you can also manage the tags on your AWS resources by using the following tools: • You can type or script commands at your shell prompt by using the resourcegroupstaggingapi commands in the AWS Command Line Interface (AWS CLI). • You can create and run PowerShell scripts by using the AWS Resource Groups Tagging API in the AWS Tools for PowerShell Core. • You can create and run programs with any of the available AWS SDKs by using the Resource groups tagging APIs, such as the tagging APIs for Python or the tagging APIs for Java. When you add, remove, or edit existing tags, you're changing tags only on those resources that you select in the results of your Find resources to tag query. You can select up to 500 resources on which to manage tags. Version 1.0 22 Tagging AWS Resources and Tag Editor User Guide Add tags to selected resources You can use Tag Editor to add tags to selected resources that are in the results of your Find resources to tag query. Note This topic describes how to bulk edit the tags for multiple resources. You can also edit the tag values for an individual resource. For more information, see View and edit existing tags for a selected resource. 1. Open the Tag Editor console, and submit a query that returns multiple resources that you want to tag. 2. In the results table of your Find resources to tag query, select the check boxes next to the resources that you want to add tags to. Enter a text string in Filter resources at the top of the table to ﬁlter for part of a resource's name, ID, tag keys, or tag values. In the Tags column, note that resources in the results already have tags applied to them. 3. Select the check box for one or more resources, and then choose Manage tags of the selected resources. 4. On the Manage tags page, view the tags on the resources that you selected. Although your original query returned more resources, you're adding tags to only those resources that you selected in step 1. Choose Add tag. 5. Enter a tag key and an optional tag value. For this procedure, you'll add the tag key Team and the tag value Development. Note A resource can have a maximum of 50 user-applied tags. You might not be able to add new tags to a resource if you're approaching 50 user-applied tags. AWS generated tags don't apply to the 50-tag limit. Tag keys must also be unique within your selected resources. You can't add a new tag with a key that matches a tag key that already exists in your selected resources. 6. When you're ﬁnished adding tags, choose Review and apply changes. 7. If you accept the changes, choose Apply changes to all selected. Add tags to selected resources Version 1.0 23 Tagging AWS Resources and Tag Editor User Guide 8. Depending on the number of resources you select, applying new tags can take a few minutes. Don't leave the page or open a diﬀerent page in the same browser tab. If changes were successful, a green success banner is displayed at the top of the page. Wait for a success or failure banner to appear on the page before you continue. If tag changes to some or all resources were not successful, see Troubleshooting tag changes. After you resolve the unsuccessful tag changes (such as insuﬃcient permissions), you can retry the tag changes on resources for which tag changes failed. For more information, see the section called “Retry failed tag changes”. Edit tags of selected resources You can use Tag Editor to change existing tag values on selected resources that are in the results of your Find resources to tag query. Editing a tag changes the tag's value on all selected resources that have the same tag key. You can't rename a tag key, but you can delete a tag and create a tag with a new name to replace the original tag key. This deletes all tags with that key on selected resources. Important Do not store personally identiﬁable information (PII) or other conﬁdential
tag-editor-userguide-011	tag-editor-userguide.pdf	11	section called “Retry failed tag changes”. Edit tags of selected resources You can use Tag Editor to change existing tag values on selected resources that are in the results of your Find resources to tag query. Editing a tag changes the tag's value on all selected resources that have the same tag key. You can't rename a tag key, but you can delete a tag and create a tag with a new name to replace the original tag key. This deletes all tags with that key on selected resources. Important Do not store personally identiﬁable information (PII) or other conﬁdential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. 1. In the results of your Find resources to tag query, select the check boxes next to the resources for which you want to change existing tags. Enter a text string in Filter resources to ﬁlter for part of a resource's name or ID. In the Tags column, note that resources in the results already have tags applied to them. 2. Choose Manage tags of the selected resources. 3. On the Manage tags page, in Edit tags of selected resources, view the tags on the resource that you selected. Although your original query might have returned more resources, you are changing tags for only those resources that you selected in step 1. 4. Change, add, or delete tag values. Existing tags must have a tag key, but tag values are optional. In this procedure, we change the value of the Team tag to QA. Edit tags of selected resources Version 1.0 24 Tagging AWS Resources and Tag Editor User Guide If resources in your selection have diﬀerent values for the same key, Selected resources have diﬀerent tag values is displayed in the Tag value ﬁeld. In this case, placing your cursor in the box opens a dropdown list of all available values for this tag key in your selected resources. If resources in your selection have the tag value you want, the tag value is highlighted as you type it. For example, if resources in your selection already have the tag value QA, the value is highlighted as you type Q. The values in the dropdown list help keep tag values consistent across resources. The tag value is changed on all selected resources. In this example, the tag value is changed to QA for all selected resources that had a Team tag key. For selected resources that don't have the Team tag, the Team tag with the value QA is added. 5. When you're ﬁnished changing tags, choose Review and apply changes. 6. If you accept the changes, choose Apply changes to all selected. 7. Depending on the number of resources you selected, editing tags can take a few minutes. Don't leave the page or open a diﬀerent page in the same browser tab. If changes were successful, a green success banner is displayed at the top of the page. Wait for a success or failure banner to appear on the page before you continue. If tag changes to some or all resources were not successful, see Troubleshooting tag changes. After you resolve the root causes of unsuccessful tag changes (such as insuﬃcient permissions), you can retry tag changes on resources for which tag changes failed. For more information, see the section called “Retry failed tag changes”. Remove tags from selected resources You can use Tag Editor to remove tags from selected resources that are in the results of your Find resources to tag query. Removing a tag deletes the tag from all selected resources that have the tag. Because you can't edit tag keys, you can remove tags and replace them with new tags if you need to edit a tag key. This deletes all tags with that key on selected resources. 1. In the results of your Find resources to tag query, select the check boxes next to the resources you want to remove tags from. Enter a text string in Filter resources to ﬁlter for part of a resource's name or ID. 2. Choose Manage tags of the selected resources. Remove tags from selected resources Version 1.0 25 Tagging AWS Resources and Tag Editor User Guide 3. On the Manage tags page, in Edit tags of selected resources, view the tags on the resources that you selected. Although your original query might have returned more resources, you're changing tags for only those resources that you selected in step 1. 4. Choose Remove tag next to any tags that you want to delete. In this procedure, we remove the Team tag. Note Choosing Remove tag removes a tag from all selected resources that have the tag. 5. Choose Review and
tag-editor-userguide-012	tag-editor-userguide.pdf	12	resources. Remove tags from selected resources Version 1.0 25 Tagging AWS Resources and Tag Editor User Guide 3. On the Manage tags page, in Edit tags of selected resources, view the tags on the resources that you selected. Although your original query might have returned more resources, you're changing tags for only those resources that you selected in step 1. 4. Choose Remove tag next to any tags that you want to delete. In this procedure, we remove the Team tag. Note Choosing Remove tag removes a tag from all selected resources that have the tag. 5. Choose Review and apply changes. 6. On the conﬁrmation page, choose Apply changes to all selected. 7. Depending on the number of resources you selected, removing tags can take a few minutes. Don't leave the page or open a diﬀerent page in the same browser tab. If changes were successful, a green success banner is displayed at the top of the page. Wait for a success or failure banner to appear on the page before you continue. If tag changes to some or all resources were not successful, see Troubleshooting Tag Changes. After you resolve the root causes of unsuccessful tag changes (such as insuﬃcient permissions), you can retry tag changes on resources for which tag changes failed. For more information, see the section called “Retry failed tag changes”. Remove tags from selected resources Version 1.0 26 Tagging AWS Resources and Tag Editor User Guide Using tags in IAM permission policies AWS Identity and Access Management (IAM) is the AWS service that you use to create and manage permissions policies that determine who can access your AWS resources. Every attempt to access an AWS service or read or write an AWS resource is access controlled by an IAM policy. These policies allow you to provide granular access to your resources. One of the features you can use to ﬁne tune this access is the Condition element of the policy. This element lets you specify the conditions that must match the request to determine if the request can proceed. Among the things you can check with the Condition element are the following: • Tags that are attached to the user or role making the request. • Tags attached to the resource that is the object of the request. Tags and attribute-based access control Tags can be an important part of your AWS access control strategy. For information about using tags as the attributes in an attribute-based access control (ABAC) strategy, see Controlling access to AWS resources using tags and Controlling access to and for IAM users and roles using tags, both in the IAM User Guide. There is a comprehensive tutorial that shows how to grant access to diﬀerent projects and groups using tags at IAM tutorial: Deﬁne permissions to access AWS resources based on tags in the AWS Identity and Access Management User Guide. If you use a SAML-based identity provider (IdP) for single sign-in, you can attach tags to the assumed roles providing access to your users. For more information, see IAM tutorial: Use SAML session tags for ABAC in the AWS Identity and Access Management User Guide. Tag-related condition keys The following table describes the condition keys that you can use in an IAM permissions policy to control access based on tags. These condition keys let you do the following: • Compare the tags on the principal calling the operation. • Compare the tags provided to the operation as a parameter. • Compare the tags attached to the resource that would be accessed by the operation. Tags and attribute-based access control Version 1.0 27 Tagging AWS Resources and Tag Editor User Guide For complete details about a condition key and how to use it, see the page linked in the Condition key name column. Condition key name Description aws:PrincipalTag Compares the tag attached to the principal (IAM role or user) making the request with the tag that you specify in the policy. aws:RequestTag Compares the tag key-value pair that was passed to the request as a parameter with the tag key-value pair that you specify in the policy. aws:ResourceTag Compares the key-value pair that is attached to the resource with the tag key-value pair that you specify in the policy. aws:TagKeys Compares only the tag keys in the request with the keys that you specify in the policy. Example IAM policies that use tags Example Example 1: Force users to attach a speciﬁc tag when they create a resource The following example IAM permissions policy shows how to force the user who creates or modiﬁes an IAM policy's tags to include a tag with the key Owner. Also, the policy requires that the value of the tag is set to the same value as the Owner tag currently attached to the
tag-editor-userguide-013	tag-editor-userguide.pdf	13	tag key-value pair that you specify in the policy. aws:TagKeys Compares only the tag keys in the request with the keys that you specify in the policy. Example IAM policies that use tags Example Example 1: Force users to attach a speciﬁc tag when they create a resource The following example IAM permissions policy shows how to force the user who creates or modiﬁes an IAM policy's tags to include a tag with the key Owner. Also, the policy requires that the value of the tag is set to the same value as the Owner tag currently attached to the calling principal. For this strategy to work, all principals must have an Owner tag attached, and users must be prevented from modifying that tag. If an attempt to create or modify a policy occurs without including the Owner tag, the policy doesn't match and the operation isn't allowed. { "Version": "2012-10-17", "Statement": [ { "Sid": "TagCustomerManagedPolicies", "Effect": "Allow", "Action": [ "iam:CreatePolicy", "iam:TagPolicy" ], "Resource": "arn:aws:iam::123456789012:policy/", Example IAM policies that use tags Version 1.0 28 Tagging AWS Resources and Tag Editor "Condition": { User Guide "StringEquals": {"aws:RequestTag/Owner": "${aws:PrincipalTag/Owner}"} } } ] } Example Example 2: Use tags to limit access to a resource to its "owner" The following example IAM permissions policy lets the user stop a running Amazon EC2 instance only if the calling principal is tagged with the same project tag value as the instance. { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor1", "Effect": "Allow", "Action": [ "ec2:StopInstances" ], "Resource": [ "arn:aws:iam::123456789012:instance/" ], "Condition": { "StringEquals": {"aws:ResourceTag/project": "${aws:PrincipalTag/project}"} } } ] } This example is an example of attribute-based access control (ABAC). For more information and additional examples of using IAM policies to implement a tag-based access control strategy, see the following topics in the AWS Identity and Access Management User Guide: • Controlling access to AWS resources using tags • Controlling access to and for IAM users and roles using tags • IAM tutorial: Deﬁne permissions to access AWS resources based on tags – Shows how to grant access to diﬀerent projects and groups using multiple tags. Example IAM policies that use tags Version 1.0 29 Tagging AWS Resources and Tag Editor User Guide AWS Organizations tag policies A tag policy is a type of policy that you create in AWS Organizations. You can use tag policies to help standardize tags across the resources in your organization's accounts. To use tag policies, we recommend that you follow the workﬂows described in Getting started with tag policies in the AWS Organizations User Guide. As mentioned on that page, the recommended workﬂows include ﬁnding and correcting noncompliant tags. To accomplish these tasks, you use the Tag Editor console. Prerequisites and permissions Before you can evaluate compliance with tag policies in Tag Editor, you must meet the requirements and set the necessary permissions. Topics • Prerequisites for evaluating compliance with tag policies • Permissions for evaluating compliance for an account • Permissions for evaluating organization-wide compliance • Amazon S3 bucket policy for report storage Prerequisites for evaluating compliance with tag policies Evaluating compliance with tag policies requires the following: • You must ﬁrst enable the feature in AWS Organizations, and create and attach tag policies. For more information, see the following pages in the AWS Organizations User Guide: • Prerequisites and permissions for managing tag policies • Enabling tag policies • Getting started with tag policies • To ﬁnd noncompliant tags on an account's resources, you need sign-in credentials for that account and the permissions listed in Permissions for evaluating compliance for an account. • To evaluate organization-wide compliance, you need sign-in credentials for the organization's management account and the permissions listed in Permissions for evaluating organization- wide compliance . You can request the compliance report from only the AWS Region US East (N. Virginia) . Prerequisites and permissions Version 1.0 30 Tagging AWS Resources and Tag Editor User Guide Permissions for evaluating compliance for an account Finding noncompliant tags on an account's resources requires the following permissions: • organizations:DescribeEffectivePolicy – To get the contents of the eﬀective tag policy for the account. • tag:GetResources – To get a list of resources that don't comply with the attached tag policy. • tag:TagResources – To add or update tags. You also need service-speciﬁc permissions to create tags. For example, to tag resources in Amazon Elastic Compute Cloud (Amazon EC2), you need permissions for ec2:CreateTags. • tag:UnTagResources – To remove a tag. You also need service-speciﬁc permissions to remove tags. For example, to untag resources in Amazon EC2, you need permissions for ec2:DeleteTags. The following example AWS Identity and Access Management (IAM) policy provides permissions for evaluating tag compliance for an account. { "Version": "2012-10-17", "Statement": [ { "Sid": "EvaluateAccountCompliance", "Effect": "Allow", "Action": [ "organizations:DescribeEffectivePolicy", "tag:GetResources", "tag:TagResources", "tag:UnTagResources" ], "Resource": "*" } ]
tag-editor-userguide-014	tag-editor-userguide.pdf	14	tag:TagResources – To add or update tags. You also need service-speciﬁc permissions to create tags. For example, to tag resources in Amazon Elastic Compute Cloud (Amazon EC2), you need permissions for ec2:CreateTags. • tag:UnTagResources – To remove a tag. You also need service-speciﬁc permissions to remove tags. For example, to untag resources in Amazon EC2, you need permissions for ec2:DeleteTags. The following example AWS Identity and Access Management (IAM) policy provides permissions for evaluating tag compliance for an account. { "Version": "2012-10-17", "Statement": [ { "Sid": "EvaluateAccountCompliance", "Effect": "Allow", "Action": [ "organizations:DescribeEffectivePolicy", "tag:GetResources", "tag:TagResources", "tag:UnTagResources" ], "Resource": "" } ] } For more information about IAM policies and permissions, see the IAM User Guide. Permissions for evaluating organization-wide compliance Evaluating organization-wide compliance with tag policies requires the following permissions: Permissions for evaluating compliance for an account Version 1.0 31 Tagging AWS Resources and Tag Editor User Guide • organizations:DescribeEffectivePolicy – To get the contents of the tag policy that's attached to the organization, organizational unit (OU), or account. • tag:GetComplianceSummary – To get a summary of noncompliant resources in all accounts in the organization. • tag:StartReportCreation – To export the results of the most recent compliance evaluation to a ﬁle. Organization-wide compliance is evaluated every 48 hours. • tag:DescribeReportCreation – To check the status of report creation. • s3:ListAllMyBuckets — To assist with accessing the organization-wide compliance report. • s3:GetBucketAcl – To inspect the Access Control List (ACL) of the Amazon S3 bucket receiving the compliance report. • s3:GetObject – To retrieve the compliance report from the service-owned Amazon S3 bucket. • s3:PutObject – To place the compliance report in the speciﬁed Amazon S3 bucket. If the Amazon S3 bucket where the report is being delivered is encrypted via SSE-KMS, you must also have the kms:GenerateDataKey permission for that bucket. The following example IAM policy provides permissions for evaluating organization-wide compliance. Replace each placeholder with your own information: • bucket_name – Your Amazon S3 bucket name • organization_id – Your organization's ID { "Version": "2012-10-17", "Statement": [ { "Sid": "EvaluateAccountCompliance", "Effect": "Allow", "Action": [ "organizations:DescribeEffectivePolicy", "tag:StartReportCreation", "tag:DescribeReportCreation", "tag:GetComplianceSummary", "s3:ListAllMyBuckets" ], "Resource": "" }, Permissions for evaluating organization-wide compliance Version 1.0 32 Tagging AWS Resources and Tag Editor { "Sid": "GetBucketAclForReportDelivery", "Effect": "Allow", "Action": "s3:GetBucketAcl", "Resource": "arn:aws:s3:::bucket_name", "Condition": { "StringEquals": { "aws:CalledViaLast": "tagpolicies.tag.amazonaws.com" User Guide } } }, { "Sid": "GetObjectForReportDelivery", "Effect": "Allow", "Action": "s3:GetObject", "Resource": "arn:aws:s3:::/tag-policy-compliance-reports/", "Condition": { "StringEquals": { "aws:CalledViaLast": "tagpolicies.tag.amazonaws.com" } } }, { "Sid": "PutObjectForReportDelivery", "Effect": "Allow", "Action": "s3:PutObject", "Resource": "arn:aws:s3:::bucket_name/AwsTagPolicies/organization_id/", "Condition": { "StringEquals": { "aws:CalledViaLast": "tagpolicies.tag.amazonaws.com" }, "StringLike": { "s3:x-amz-copy-source": "/tag-policy-compliance-reports/" } } } ] } For more information about IAM policies and permissions, see the IAM User Guide. Permissions for evaluating organization-wide compliance Version 1.0 33 Tagging AWS Resources and Tag Editor User Guide Amazon S3 bucket policy for report storage To create an organization-wide compliance report, the identity that you use to call the StartReportCreation API must have access to an Amazon Simple Storage Service (Amazon S3) bucket in the US East (N. Virginia) Region to store the report. Tag Policies uses the credentials of the calling identity to deliver the compliance report to the speciﬁed bucket. If the bucket and the identity being used to call the StartReportCreation API belong to the same account, additional Amazon S3 bucket policies are not needed for this use case. If the account associated with the identity used to call the StartReportCreation API is diﬀerent from the account that owns the Amazon S3 bucket, the following bucket policy must be attached to the bucket. Replace each placeholder with your own information: • bucket_name – Your Amazon S3 bucket name • organization_id – Your organization's ID • identity_ARN – The ARN of the IAM identity used to call the StartReportCreation API { "Version": "2012-10-17", "Statement": [ { "Sid": "CrossAccountTagPolicyACL", "Effect": "Allow", "Principal": { "AWS": "identity_ARN" }, "Action": "s3:GetBucketAcl", "Resource": "arn:aws:s3:::bucket_name" }, { "Sid": "CrossAccountTagPolicyBucketDelivery", "Effect": "Allow", "Principal": { "AWS": "identity_ARN" }, "Action": "s3:PutObject", "Resource": "arn:aws:s3:::bucket_name/AwsTagPolicies/organization_id/" } ] Amazon S3 bucket policy for report storage Version 1.0 34 Tagging AWS Resources and Tag Editor User Guide } Evaluating compliance for an account You can evaluate the compliance of an account in your organization with its eﬀective tag policy. Important Untagged resources don't appear as noncompliant in results. To ﬁnd untagged resources in your account, use AWS Resource Explorer with a query that uses tag:none. For more information, see Search for untagged resources in the AWS Resource Explorer User Guide. The eﬀective tag policy speciﬁes the tagging rules that apply to an account. The eﬀective tag policy is the aggregation of any tag policies that the account inherits, plus any tag policy directly attached to the account. When you attach a tag policy to the organization root, it applies to all accounts in your organization. When you attach a tag
tag-editor-userguide-015	tag-editor-userguide.pdf	15	Untagged resources don't appear as noncompliant in results. To ﬁnd untagged resources in your account, use AWS Resource Explorer with a query that uses tag:none. For more information, see Search for untagged resources in the AWS Resource Explorer User Guide. The eﬀective tag policy speciﬁes the tagging rules that apply to an account. The eﬀective tag policy is the aggregation of any tag policies that the account inherits, plus any tag policy directly attached to the account. When you attach a tag policy to the organization root, it applies to all accounts in your organization. When you attach a tag policy to an organizational unit (OU), it applies to all accounts and OUs that belong to the OU. Note If you haven't yet created tag policies, see Getting started with tag policies in the AWS Organizations User Guide. To ﬁnd noncompliant tags, you must have the following permissions: • organizations:DescribeEffectivePolicy • tag:GetResources • tag:TagResources • tag:UntagResources To evaluate an account's compliance with its eﬀective tag policy (console) 1. While signed in to the account whose compliance you want to check, open the Tag Policies console. Evaluating compliance for an account Version 1.0 35 Tagging AWS Resources and Tag Editor User Guide 2. The Eﬀective tag policy section shows when the policy was last updated and the deﬁned tag keys. You can expand a tag key to see information about its values, case treatment, and whether the values are enforced for speciﬁc resources types. Note If you're signed in to the management account, you need to choose an account to see its eﬀective policy and view compliance information. 3. 4. 5. In the Resources with noncompliant tags section, specify which AWS Region to search for noncompliant tags. Optionally, you can also search by resource type. Then choose Search resources. Real-time results are shown in the Search results section. To change the number of results returned per page or the columns to display, choose the settings icon. In the search results, select a resource with noncompliant tags. In the dialog box that lists the resource's tags, choose the hyperlink to open the AWS service where the resource was created. From that console, correct the noncompliant tag. Tip If you're not sure which tags are noncompliant, go to the Eﬀective tag policy section for the account in the Tag Policies console. You can expand a tag key to view its tagging rules. 6. Repeat the process of ﬁnding and correcting tags until the account resources that you care about are compliant in each Region. To ﬁnd noncompliant tags (AWS CLI, AWS API) Use the following commands and operations to ﬁnd noncompliant tags: • AWS Command Line Interface (AWS CLI): • aws resourcegroupstaggingapi get-resources • aws resourcegroupstaggingapi tag-resources • aws resourcegroupstaggingapi untag-resources Evaluating compliance for an account Version 1.0 36 Tagging AWS Resources and Tag Editor User Guide For the complete procedure for using tag policies in the AWS CLI, see Using tag policies in the AWS CLI in the AWS Organizations User Guide. • AWS Resource Groups Tagging API: • GetResources • TagResources • UntagResources Next steps We recommend that you repeat the process of ﬁnding and correcting compliance issues. Continue until the account's resources that you care about are compliant with the eﬀective tag policy in each Region. Finding and correcting noncompliant tags is an iterative process for multiple reasons, including the following: • Your organization's use of tag policies can evolve over time. • It takes time to eﬀect change in your organization when creating resources. • Compliance can change anytime that a new resource is created or when new tags are assigned to a resource. • An account's eﬀective tag policy is updated whenever a tag policy is attached to or detached from it. The eﬀective tag policy is also updated whenever changes occur to tag the policies that the account inherits. If you're signed in as the management account in the organization, you can also generate a report. This report shows information about all tagged resources in your organization's accounts. For more information, see Evaluating organization-wide compliance. Evaluating organization-wide compliance You can evaluate your organization's compliance with its eﬀective tag policy. You can generate a report that lists all tagged resources in accounts across your organization and whether each resource is compliant with the eﬀective tag policy. Evaluating organization-wide compliance Version 1.0 37 Tagging AWS Resources and Tag Editor User Guide Important Untagged resources don't appear as noncompliant in results. To ﬁnd untagged resources in your account, use AWS Resource Explorer with a query that uses tag:none. For more information, see Search for untagged resources in the AWS Resource Explorer User Guide. You can generate the report from your organization's management account in the us-east-1 AWS Region only. The account generating the report must have access to an Amazon
tag-editor-userguide-016	tag-editor-userguide.pdf	16	tagged resources in accounts across your organization and whether each resource is compliant with the eﬀective tag policy. Evaluating organization-wide compliance Version 1.0 37 Tagging AWS Resources and Tag Editor User Guide Important Untagged resources don't appear as noncompliant in results. To ﬁnd untagged resources in your account, use AWS Resource Explorer with a query that uses tag:none. For more information, see Search for untagged resources in the AWS Resource Explorer User Guide. You can generate the report from your organization's management account in the us-east-1 AWS Region only. The account generating the report must have access to an Amazon S3 bucket in the US East (N. Virginia) Region. The bucket must have an attached bucket policy as shown in Amazon S3 bucket policy for storing report. To generate an organization-wide compliance report, you must have the following permissions: • organizations:DescribeEffectivePolicy • tag:GetComplianceSummary • tag:StartReportCreation • tag:DescribeReportCreation • s3:ListAllMyBuckets • s3:GetBucketAcl • s3:GetObject • s3:PutObject For an example IAM policy displaying these permissions, review Permissions for evaluating organization-wide compliance. To generate an organization-wide compliance report (console) 1. Open the Tag Policies console. 2. Choose the This organization root tab, and near the bottom of the page, choose Generate report. 3. On the Generate report screen, specify where to store the report. 4. Choose Start exporting. Evaluating organization-wide compliance Version 1.0 38 Tagging AWS Resources and Tag Editor User Guide When the report is complete, you can download it from the Noncompliance report section on the Organization root tab. Notes Organization-wide compliance is evaluated every 48 hours. This results in the following: • It can take up to 48 hours for changes to a tag policy or resources to be shown in the organization-wide compliance report. For example, assume that you have a tag policy that deﬁnes a new standardized tag for a resource type. Resources of that type that don't have this tag can show as compliant in the report for up to 48 hours. • Although you can generate the report at any time, report results aren't updated until the next evaluation is complete. • The NoncompliantKeys column lists tag keys on the resource that are noncompliant with the eﬀective tag policy. • The KeysWithNonCompliantValues column lists keys deﬁned in the eﬀective policy that are on the resource with either incorrect case treatment or noncompliant values. • If you close an AWS account that was a member of the organization, it can continue to appear in the tag compliance report for up to 90 days. To generate an organization-wide compliance report (AWS CLI, AWS API) Use the following commands and operations to generate an organization-wide compliance report, check on its status, and view the report: • AWS Command Line Interface AWS CLI): • aws resourcegroupstaggingapi start-report-creation • aws resourcegroupstaggingapi describe-report-creation • aws resourcegroupstaggingapi get-compliance-summary For the complete procedure for using tag policies in the AWS CLI, see Using tag policies in the AWS CLI in the AWS Organizations User Guide. • AWS API: • StartReportCreation • DescribeReportCreation Evaluating organization-wide compliance Version 1.0 39 Tagging AWS Resources and Tag Editor • GetComplianceSummary User Guide Evaluating organization-wide compliance Version 1.0 40 Tagging AWS Resources and Tag Editor User Guide Monitor tag changes with serverless workﬂows and Amazon EventBridge Amazon EventBridge supports tag changes on AWS resources. Using this EventBridge type, you can build EventBridge rules to match tag changes and route the events to one or more targets. For example, a target might be an AWS Lambda function to invoke automated workﬂows. This topic provides a tutorial for using Lambda to build a cost-eﬀective serverless solution to securely process tag changes on your AWS resources. Tag changes generate EventBridge events EventBridge delivers a near real-time stream of system events that describe changes in AWS resources. Many AWS resources support tags, which are custom, user-deﬁned attributes to easily organize and categorize AWS resources. Common use cases for tags are cost allocation categorization, access-control security, and automation. With EventBridge, you can monitor for changes to tags and track the tag state on AWS resources. Previously, to achieve similar functionality, you might have continuously polled APIs and orchestrated multiple calls. Now, any change to a tag including individual service APIs, Tag Editor, and the Tagging API will initiate the tag change on resource event. The following example shows a typical EventBridge event prompted by a tag change. It shows the new, updated, or deleted tag keys, and their associated values. { "version": "0", "id": "bddcf1d6-0251-35a1-aab0-adc1fb47c11c", "detail-type": "Tag Change on Resource", "source": "aws.tag", "account": "123456789012", "time": "2018-09-18T20:41:38Z", "region": "us-east-1", "resources": [ "arn:aws:ec2:us-east-1:123456789012:instance/i-0000000aaaaaaaaaa" ], "detail": { "changed-tag-keys": [ "a-new-key", "an-updated-key", Tag changes generate EventBridge events Version 1.0 41 User Guide Tagging AWS Resources and Tag Editor "a-deleted-key" ], "tags": { "a-new-key": "tag-value-on-new-key-just-added", "an-updated-key": "tag-value-was-just-changed", "an-unchanged-key": "tag-value-still-the-same" }, "service": "ec2", "resource-type": "instance", "version": 3, } } All
tag-editor-userguide-017	tag-editor-userguide.pdf	17	Tagging API will initiate the tag change on resource event. The following example shows a typical EventBridge event prompted by a tag change. It shows the new, updated, or deleted tag keys, and their associated values. { "version": "0", "id": "bddcf1d6-0251-35a1-aab0-adc1fb47c11c", "detail-type": "Tag Change on Resource", "source": "aws.tag", "account": "123456789012", "time": "2018-09-18T20:41:38Z", "region": "us-east-1", "resources": [ "arn:aws:ec2:us-east-1:123456789012:instance/i-0000000aaaaaaaaaa" ], "detail": { "changed-tag-keys": [ "a-new-key", "an-updated-key", Tag changes generate EventBridge events Version 1.0 41 User Guide Tagging AWS Resources and Tag Editor "a-deleted-key" ], "tags": { "a-new-key": "tag-value-on-new-key-just-added", "an-updated-key": "tag-value-was-just-changed", "an-unchanged-key": "tag-value-still-the-same" }, "service": "ec2", "resource-type": "instance", "version": 3, } } All EventBridge events have the same top-level ﬁelds: • version – By default, this value is set to 0 (zero) in all events. • id – A unique value is generated for every event. This can be helpful in tracing events as they move through rules to targets and are processed. • detail-type – Identiﬁes, in combination with the source ﬁeld, the ﬁelds and values that appear in the detail ﬁeld. • source – Identiﬁes the service that was the source of the event. The source for tag changes is aws.tag. • time – The timestamp of the event. • region – Identiﬁes the AWS Region where the event originated. • resources – This JSON array contains Amazon Resource Names (ARNs) that identify resources that are involved in the event. This is the resource where tags have changed. • detail – A JSON object, whose content is diﬀerent depending on event type. For tag change on resource, the following detailed ﬁelds are included: • changed-tag-keys – The tag keys that changed by this event. • service – The service that the resource belongs to. In this example, the service is ec2, which is Amazon EC2. • resource-type – The type of resource of the service. In this example, it is an Amazon EC2 instance. • version – The version of the tag set. The version starts at 1 and increments when tags are changed. You can use the version to verify the order of tag change events. • tags – The tags attached to the resource after the change. Tag changes generate EventBridge events Version 1.0 42 Tagging AWS Resources and Tag Editor User Guide For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide. By using EventBridge, you can create rules that match speciﬁc event patterns based on the diﬀerent ﬁelds. We demonstrate how to do this in the tutorial. Also, we show how an Amazon EC2 instance can be stopped automatically if a speciﬁed tag isn’t attached to the instance. We use the EventBridge ﬁelds to create a pattern to match the tag events for the instance that launches a Lambda function. Lambda and serverless AWS Lambda follows the serverless paradigm to run code in the cloud. You run code only when it’s needed, without thinking about servers. You pay only for the exact compute time you use. Even though it’s called serverless, it doesn’t mean that there are no servers. Serverless in this context means that you don’t have to provision, conﬁgure, or manage the servers that are used to run your code. AWS does all of that for you, so you can focus on your code. For more information about Lambda, see the AWS Lambda Product Overview. Tutorial: Automatically stopping Amazon EC2 instances that are missing required tags As your pool of AWS resources and AWS accounts that you manage grows, you can use tags to make it easier to categorize your resources. Tags are commonly used for critical use cases such as cost allocation and security. To eﬀectively manage AWS resources, your resources need to be consistently tagged. Often, when a resource is provisioned, it gets all the appropriate tags. However, a later process can result in a tag change that results in drift from the corporate tag policy. By monitoring changes to your tags, you can spot tag drift and immediately respond. This gives you more conﬁdence that the processes that depend on your resources being properly categorized will produce the desired results. The following example demonstrates how to monitor for tag changes on Amazon EC2 instances to verify that a speciﬁed instance continues to have the required tags. If the instance's tags change and the instance no longer has the required tags, a Lambda function is invoked to shut down the instance automatically. Why would you want to do this? It ensures that all resources are tagged according to your corporate tag policy, for eﬀective cost allocation, or to be able to trust security based on attribute-based access control (ABAC). Lambda and serverless Version 1.0 43 Tagging AWS Resources and Tag Editor User Guide Important We strongly recommend that you perform this tutorial in a non-production account where you can't
tag-editor-userguide-018	tag-editor-userguide.pdf	18	speciﬁed instance continues to have the required tags. If the instance's tags change and the instance no longer has the required tags, a Lambda function is invoked to shut down the instance automatically. Why would you want to do this? It ensures that all resources are tagged according to your corporate tag policy, for eﬀective cost allocation, or to be able to trust security based on attribute-based access control (ABAC). Lambda and serverless Version 1.0 43 Tagging AWS Resources and Tag Editor User Guide Important We strongly recommend that you perform this tutorial in a non-production account where you can't inadvertently shut down important instances. The example code in this tutorial intentionally limits the impact of this scenario to only the instances on a list of instance IDs. You must update the list with instance IDs that you are willing to shut down for the test. This helps ensure that you can't accidentally shut down every instance in a Region in your AWS account. After testing, make sure that all of your instances are tagged according to your company's tagging strategy. Then, you can remove the code that limits the function to only the instance IDs on the list. This example uses JavaScript and the 16.x version of Node.js. The example uses example AWS account ID 123456789012 and the AWS Region US East (N. Virginia) (us-east-1). Replace these with your own test account ID and Region. Note If your console uses a diﬀerent Region for its default, ensure that you switch the Region you're using in this tutorial whenever you change consoles. A common cause of this tutorial failing is having the instance and function in two diﬀerent Regions. If you use a diﬀerent Region than us-east-1, ensure that you change all references in the following code examples to your chosen Region. Topics • Step 1. Create the Lambda function • Step 2. Set up the required IAM permissions • Step 3. Do a preliminary test of your Lambda function • Step 4. Create the EventBridge rule that launches the function • Step 5. Test the complete solution • Tutorial summary Monitoring tutorial Version 1.0 44 Tagging AWS Resources and Tag Editor User Guide Step 1. Create the Lambda function To create the Lambda function 1. Open the AWS Lambda management console. 2. Choose Create function and then choose Author from scratch. 3. 4. For Function name, type AutoEC2Termination. For Runtime, choose Node.js 16.x. 5. Keep all other ﬁelds at their default values, and choose Create function. 6. On the Code tab of the AutoEC2Termination detail page, open the index.js ﬁle to view its code. • If a tab with index.js is open, you can choose the edit box in that tab to edit its code. • If a tab with index.js isn't open, secondary-click the index.js ﬁle under the AutoEC2Terminator folder in the navigation pane. Then choose Open. 7. In the index.js tab, paste the following code in the editor box, replacing anything that is already present. Replace the value RegionToMonitor with the Region that you want to run this function in. // Set the following line to specify which Region's instances you want to monitor // Only instances in this Region are succesfully stopped on a match const RegionToMonitor = "us-east-1" // Specify the instance ARNs to check. // This limits the function for safety to avoid the tutorial shutting down all instances in account // The first ARN is a "dummy" that matches the test event you create in Step 3. // Replace the second ARN with one that matches a real instance that you want to monitor and that you can // safely stop const InstanceList = [ "i-0000000aaaaaaaaaa", "i-05db4466d02744f07" ]; Step 1. Create the Lambda function Version 1.0 45 Tagging AWS Resources and Tag Editor User Guide // The tag key name and value that marks a "valid" instance. Instances in the previous list that // do NOT have the following tag key and value are stopped by this function const ValidKeyName = "valid-key"; const ValidKeyValue = "valid-value"; // Load and configure the AWS SDK const AWS = require('aws-sdk'); // Set the AWS Region AWS.config.update({region: RegionToMonitor}); // Create EC2 service object. const ec2 = new AWS.EC2({apiVersion: '2016-11-15'}); exports.handler = (event, context, callback) => { // Retrieve the details of the reported event. var detail = event.detail; var tags = detail["tags"]; var service = detail["service"]; var resourceType = detail["resource-type"]; var resource = event.resources[0]; var resourceSplit = resource.split("/"); var instanceId = resourceSplit[resourceSplit.length - 1]; // If this event is not for an EC2 resource, then do nothing. if (!(service === "ec2")) { console.log("Event not for correct service -- no action (", service, ")" ); return; } // If this event is not about an instance, then do nothing. if (!(resourceType === "instance")) { console.log("Event not for correct
tag-editor-userguide-019	tag-editor-userguide.pdf	19	AWS.EC2({apiVersion: '2016-11-15'}); exports.handler = (event, context, callback) => { // Retrieve the details of the reported event. var detail = event.detail; var tags = detail["tags"]; var service = detail["service"]; var resourceType = detail["resource-type"]; var resource = event.resources[0]; var resourceSplit = resource.split("/"); var instanceId = resourceSplit[resourceSplit.length - 1]; // If this event is not for an EC2 resource, then do nothing. if (!(service === "ec2")) { console.log("Event not for correct service -- no action (", service, ")" ); return; } // If this event is not about an instance, then do nothing. if (!(resourceType === "instance")) { console.log("Event not for correct resource type -- no action (", resourceType, ")" ); return; } // CAUTION - Removing the following 'if' statement causes the function to run against // every EC2 instance in the specified Region in the calling AWS account. // If you do this and an instance is not tagged with the approved tag key Step 1. Create the Lambda function Version 1.0 46 Tagging AWS Resources and Tag Editor User Guide // and value, this function stops that instance. // If this event is not for the ARN of an instance in our include list, then do nothing. if (InstanceList.indexOf(instanceId)<0) { console.log("Event not for one of the monitored instances -- no action (", resource, ")"); return; } console.log("Tags changed on monitored EC2 instance (",instanceId,")"); // Check attached tags for expected tag key and value pair if ( tags.hasOwnProperty(ValidKeyName) && tags[ValidKeyName] == "valid-value"){ // Required tags ARE present console.log("The instance has the required tag key and value -- no action"); callback(null, "no action"); return; } // Required tags NOT present console.log("This instance is missing the required tag key or value -- attempting to stop the instance"); var params = { InstanceIds: [instanceId], DryRun: true }; // call EC2 to stop the selected instances ec2.stopInstances(params, function(err, data) { if (err && err.code === 'DryRunOperation') { // dryrun succeeded, so proceed with "real" stop operation params.DryRun = false; ec2.stopInstances(params, function(err, data) { if (err) { console.log("Failed to stop instance"); callback(err, "fail"); } else if (data) { console.log("Successfully stopped instance", data.StoppingInstances); callback(null, "Success"); } }); } else { Step 1. Create the Lambda function Version 1.0 47 Tagging AWS Resources and Tag Editor User Guide console.log("Dryrun attempt failed"); callback(err); } }); }; 8. Choose Deploy to save your changes and make the new version of the function active. This Lambda function checks the tags of an Amazon EC2 instance, as reported by the tag change event in EventBridge. In this example, if the instance in the event is missing the required tag key valid-key or if that tag doesn't have the value valid-value, then the function tries to stop the instance. You can change this logical check or the tag requirements for your own speciﬁc use cases. Keep the Lambda console window open in your browser. Step 2. Set up the required IAM permissions Before the function can successfully run, you must grant the function the permission to stop an EC2 instance. The AWS provided role lambda_basic_execution doesn't have that permission. In this tutorial, you modify the default IAM permission policy that is attached to the function's execution role named AutoEC2Termination-role-uniqueid. The minimum additional permission required for this tutorial is ec2:StopInstances. For more information about creating Amazon EC2 speciﬁc IAM policies, see Amazon EC2: Allows starting or stopping an EC2 Instance and modifying a security group, programmatically and in the console in the IAM User Guide. To create an IAM permission policy and attach it to the Lambda function's execution role 1. 2. In a diﬀerent browser tab or window, open the Roles page of the IAM console. Start typing the role name AutoEC2Termination, and when it appears in the list, choose the role name. 3. On the role's Summary page, choose the Permissions tab and choose the name of the one policy that is already attached. 4. On the policy's Summary page, choose Edit policy. 5. On the Visual Editor tab, choose Add additional permissions. 6. For Service, choose EC2. Step 2. Set up the required IAM permissions Version 1.0 48 Tagging AWS Resources and Tag Editor User Guide 7. For Actions, choose StopInstances. You can type Stop in the search bar, and then choose StopInstances when it appears. 8. For Resources, choose All resources, choose Review policy, and then choose Save changes. This automatically creates a new version of the policy and sets that version as the default. Your ﬁnal policy should look similar to the following example. { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": "ec2:StopInstances", "Resource": "" }, { "Sid": "VisualEditor1", "Effect": "Allow", "Action": "logs:CreateLogGroup", "Resource": "arn:aws:logs:us-east-1:123456789012:" }, { "Sid": "VisualEditor2", "Effect": "Allow", "Action": [ "logs:CreateLogStream", "logs:PutLogEvents" ], "Resource": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/lambda/ AutoEC2Termination:*" } ] } Step 3. Do a preliminary test of your Lambda function In this step,
tag-editor-userguide-020	tag-editor-userguide.pdf	20	then choose StopInstances when it appears. 8. For Resources, choose All resources, choose Review policy, and then choose Save changes. This automatically creates a new version of the policy and sets that version as the default. Your ﬁnal policy should look similar to the following example. { "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": "ec2:StopInstances", "Resource": "" }, { "Sid": "VisualEditor1", "Effect": "Allow", "Action": "logs:CreateLogGroup", "Resource": "arn:aws:logs:us-east-1:123456789012:" }, { "Sid": "VisualEditor2", "Effect": "Allow", "Action": [ "logs:CreateLogStream", "logs:PutLogEvents" ], "Resource": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/lambda/ AutoEC2Termination:*" } ] } Step 3. Do a preliminary test of your Lambda function In this step, you submit a test event to your function. The Lambda test functionality works by submitting a manually provided test event. The function processes the test event just as if the event had come from EventBridge. You can deﬁne multiple test events with diﬀerent values to Step 3. Do a preliminary test of your Lambda function Version 1.0 49 Tagging AWS Resources and Tag Editor User Guide exercise all of the diﬀerent parts of your code. In this step, you submit a test event that indicates that an Amazon EC2 instance's tags changed, and the new tags don't include the required tag key and value. To test your Lambda function 1. Return to the window or tab with the Lambda console and open the Test tab for your AutoEC2Termination function. 2. Choose Create new event. 3. 4. For Event name, enter SampleBadTagChangeEvent. In the Event JSON, replace the text with the sample event shown in the following example text. You don't need to modify the accounts, Region, or instance ID for this test event to work correctly. { "version": "0", "id": "bddcf1d6-0251-35a1-aab0-adc1fb47c11c", "detail-type": "Tag Change on Resource", "source": "aws.tag", "account": "123456789012", "time": "2018-09-18T20:41:38Z", "region": "us-east-1", "resources": [ "arn:aws:ec2:us-east-1:123456789012:instance/i-0000000aaaaaaaaaa" ], "detail": { "changed-tag-keys": [ "valid-key" ], "tags": { "valid-key": "NOT-valid-value" }, "service": "ec2", "resource-type": "instance", "version": 3 } } 5. Choose Save, and then choose Test. The test appears to fail, but that's OK. Step 3. Do a preliminary test of your Lambda function Version 1.0 50 Tagging AWS Resources and Tag Editor User Guide You should see the following error in the Execution results tab under Response. { "errorType": "InvalidInstanceID.NotFound", "errorMessage": "The instance ID 'i-0000000aaaaaaaaaa' does not exist", ... } The error occurs because the instance speciﬁed in the test event doesn't exist. The information on the Execution results tab, in the Function Logs section , demonstrates that your Lambda function successfully attempted to stop an EC2 instance. However, it failed because the code initially attempts a DryRun operation to stop the instance, which indicated that the instance ID was not valid. START RequestId: 390c1f8d-0d9b-4b44-b087-8de64479ab44 Version: $LATEST 2022-11-30T20:17:30.427Z 390c1f8d-0d9b-4b44-b087-8de64479ab44 INFO Tags changed on monitored EC2 instance ( i-0000000aaaaaaaaaa ) 2022-11-30T20:17:30.427Z 390c1f8d-0d9b-4b44-b087-8de64479ab44 INFO This instance is missing the required tag key or value -- attempting to stop the instance 2022-11-30T20:17:31.206Z 390c1f8d-0d9b-4b44-b087-8de64479ab44 INFO Dryrun attempt failed 2022-11-30T20:17:31.207Z 390c1f8d-0d9b-4b44-b087-8de64479ab44 ERROR Invoke Error {"errorType":"InvalidInstanceID.NotFound","errorMessage":"The instance ID 'i-0000000aaaaaaaaaa' does not exist","code":"InvalidInstanceID.NotFound","message":"The instance ID 'i-0000000aaaaaaaaaa' does not exist","time":"2022-11-30T20:17:31.205Z","requestId":"a5192c3b-142d-4cec- bdbc-685a9b7c7abf","statusCode":400,"retryable":false,"retryDelay":36.87870631147607,"stack": ["InvalidInstanceID.NotFound: The instance ID 'i-0000000aaaaaaaaaa' does not exist"," at Request.extractError (/var/runtime/node_modules/aws-sdk/ lib/services/ec2.js:50:35)"," at Request.callListeners (/var/runtime/ node_modules/aws-sdk/lib/sequential_executor.js:106:20)"," at Request.emit (/var/runtime/node_modules/aws-sdk/lib/sequential_executor.js:78:10)"," at Request.emit (/var/runtime/node_modules/aws-sdk/lib/request.js:686:14)"," at Request.transition (/var/runtime/node_modules/aws-sdk/lib/request.js:22:10)"," at AcceptorStateMachine.runTo (/var/runtime/node_modules/aws-sdk/lib/ state_machine.js:14:12)"," at /var/runtime/node_modules/aws-sdk/lib/ state_machine.js:26:10"," at Request.<anonymous> (/var/runtime/node_modules/aws- sdk/lib/request.js:38:9)"," at Request.<anonymous> (/var/runtime/node_modules/ Step 3. Do a preliminary test of your Lambda function Version 1.0 51 Tagging AWS Resources and Tag Editor User Guide aws-sdk/lib/request.js:688:12)"," at Request.callListeners (/var/runtime/ node_modules/aws-sdk/lib/sequential_executor.js:116:18)"]} END RequestId: 390c1f8d-0d9b-4b44-b087-8de64479ab44 6. To prove that the code doesn't try to stop the instance when the correct tag is used, you can create and submit another test event. Choose the Test tab above Code source. The console displays your existing SampleBadTagChangeEvent test event. 7. Choose Create new event. 8. 9. For Event name, type SampleGoodTagChangeEvent. In line 17, delete NOT- to change the value to valid-value. 10. At the top of the Test event window, choose Save, and then choose Test. The output displays the following, which demonstrates that the function recognizes the valid tag and doesn't attempt to shut down the instance. START RequestId: 53631a49-2b54-42fe-bf61-85b9e91e86c4 Version: $LATEST 2022-12-01T23:24:12.244Z 53631a49-2b54-42fe-bf61-85b9e91e86c4 INFO Tags changed on monitored EC2 instance ( i-0000000aaaaaaaaaa ) 2022-12-01T23:24:12.244Z 53631a49-2b54-42fe-bf61-85b9e91e86c4 INFO The instance has the required tag key and value -- no action END RequestId: 53631a49-2b54-42fe-bf61-85b9e91e86c4 Keep the Lambda console open in your browser. Step 4. Create the EventBridge rule that launches the function Now you can create an EventBridge rule that matches the event and points to your Lambda function. To create the EventBridge rule 1. 2. 3. 4. In a diﬀerent browser tab or window, open the EventBridge console to the Create Rule page. For Name, enter ec2-instance-rule, and then choose Next. Scroll down to Creation method and choose Custom pattern (JSON editor). In the editing box, paste the following pattern text, and then choose Next. Step 4.
tag-editor-userguide-021	tag-editor-userguide.pdf	21	-- no action END RequestId: 53631a49-2b54-42fe-bf61-85b9e91e86c4 Keep the Lambda console open in your browser. Step 4. Create the EventBridge rule that launches the function Now you can create an EventBridge rule that matches the event and points to your Lambda function. To create the EventBridge rule 1. 2. 3. 4. In a diﬀerent browser tab or window, open the EventBridge console to the Create Rule page. For Name, enter ec2-instance-rule, and then choose Next. Scroll down to Creation method and choose Custom pattern (JSON editor). In the editing box, paste the following pattern text, and then choose Next. Step 4. Create the EventBridge rule that launches the function Version 1.0 52 Tagging AWS Resources and Tag Editor User Guide { "source": [ "aws.tag" ], "detail-type": [ "Tag Change on Resource" ], "detail": { "service": [ "ec2" ], "resource-type": [ "instance" ] } } This rule matches Tag Change on Resource events for Amazon EC2 instances and invokes whatever you specify as the Target in the next step. 5. Next, add your Lambda function as the target. In the Target 1 box, under Select a target, choose Lambda function. 6. Under Function, choose the AutoEC2Termination function that you created previously, and then choose Next. 7. On the Conﬁgure tags page, choose Next. Then on the Review and create page, choose Create rule. This also automatically grants permission for EventBridge to invoke the speciﬁed Lambda function. Step 5. Test the complete solution You can test your ﬁnal result by creating an EC2 instance and watching what happens when you change its tags. To test the monitoring solution with a real instance 1. Open the Amazon EC2 console to the Instances page. 2. Create an Amazon EC2 instance. Before you launch it, attach a tag with the key valid-key and the value valid-value. For information about how to create and launch an instance,see Step 1: Launch an instance in the Amazon EC2 User Guide. In the procedure To launch an Step 5. Test the complete solution Version 1.0 53 Tagging AWS Resources and Tag Editor User Guide instance, in step 3, where you enter the Name tag, also choose Add additional tags, choose Add tag, and then enter the Key of valid-key and Value of valid-value. You can Proceed without a key pair if this instance is solely for the purposes of this tutorial and you plan on deleting this instance after you complete it. Return to this tutorial when you reach the end of Step 1; you don't need to do Step 2: Connect to your instance. 3. Copy the InstanceId from the console. 4. Switch from the Amazon EC2 console to the Lambda console. Choose your AutoEC2Termination function, choose the Code tab, and then choose the index.js tab to edit your code. 5. Change the second entry in the InstanceList by pasting the value you copied from the Amazon EC2 console. Ensure that the RegionToMonitor value matches the Region that contains the instance you pasted. 6. Choose Deploy to make your changes active. The function is now ready to be activated by tag changes to that instance in the speciﬁed Region. 7. Switch from the Lambda console to the Amazon EC2 console. 8. Change the Tags attached to the instance by either deleting the valid-key tag or by changing that key's value. Note For information about how to change the tags on a running Amazon EC2 instance, see Add and delete tags on an individual resource in the Amazon EC2 User Guide. 9. Wait a few seconds, and then refresh the console. The instance should change its Instance state to Stopping and then to Stopped. 10. Switch from the Amazon EC2 console to the Lambda console with your function, and choose the Monitor tab. 11. Choose the Logs tab, and in the Recent invocations table, choose the most recent entry in the LogStream column. The Amazon CloudWatch console opens to the Log events page for the last invocation of your Lambda function. The last entry should look similar to the following example. 2022-11-30T12:03:57.544-08:00 START RequestId: b5befd18-2c41-43c8- a320-3a4b2317cdac Version: $LATEST Step 5. Test the complete solution Version 1.0 54 Tagging AWS Resources and Tag Editor User Guide 2022-11-30T12:03:57.548-08:00 2022-11-30T20:03:57.548Z b5befd18-2c41-43c8- a320-3a4b2317cdac INFO Tags changed on monitored EC2 instance ( arn:aws:ec2:us- west-2:123456789012:instance/i-1234567890abcdef0 ) 2022-11-30T12:03:57.548-08:00 2022-11-30T20:03:57.548Z b5befd18-2c41-43c8- a320-3a4b2317cdac INFO This instance is missing the required tag key or value -- attempting to stop the instance 2022-11-30T12:03:58.488-08:00 2022-11-30T20:03:58.488Z b5befd18-2c41-43c8- a320-3a4b2317cdac INFO Successfully stopped instance [ { CurrentState: { Code: 64, Name: 'stopping' }, InstanceId: 'i-1234567890abcdef0', PreviousState: { Code: 16, Name: 'running' } } ] 2022-11-30T12:03:58.546-08:00 END RequestId: b5befd18-2c41-43c8- a320-3a4b2317cdac Tutorial summary This tutorial demonstrated how to create an EventBridge rule to match against a tag change on a resource event for Amazon EC2 instances. The rule pointed to a Lambda function that automatically shuts down
tag-editor-userguide-022	tag-editor-userguide.pdf	22	Tags changed on monitored EC2 instance ( arn:aws:ec2:us- west-2:123456789012:instance/i-1234567890abcdef0 ) 2022-11-30T12:03:57.548-08:00 2022-11-30T20:03:57.548Z b5befd18-2c41-43c8- a320-3a4b2317cdac INFO This instance is missing the required tag key or value -- attempting to stop the instance 2022-11-30T12:03:58.488-08:00 2022-11-30T20:03:58.488Z b5befd18-2c41-43c8- a320-3a4b2317cdac INFO Successfully stopped instance [ { CurrentState: { Code: 64, Name: 'stopping' }, InstanceId: 'i-1234567890abcdef0', PreviousState: { Code: 16, Name: 'running' } } ] 2022-11-30T12:03:58.546-08:00 END RequestId: b5befd18-2c41-43c8- a320-3a4b2317cdac Tutorial summary This tutorial demonstrated how to create an EventBridge rule to match against a tag change on a resource event for Amazon EC2 instances. The rule pointed to a Lambda function that automatically shuts down the instance if it doesn't have the required tag. The Amazon EventBridge support for tag changes on AWS resources opens possibilities to build event-driven automation across many AWS services. Combining this capability with AWS Lambda provides you with tools to build serverless solutions that access AWS resources securely, scale on demand, and are cost eﬀective. Other possible use cases for the tag-change-on-resource EventBridge event include: • Launch a warning if someone accesses your resource from an unusual IP address – Use a tag to store the source IP address of each visitor that accesses your resource. Changes to the tag generates a CloudWatch event. You can use that event to compare the source IP address to a list of valid IP addresses and activate a warning email if the source IP address isn't valid. • Monitor if there are changes to your tag-based access control for a resource – If you have set up access to a resource using attribute (tag) based access control (ABAC), you can use EventBridge events generated by any changes to the tag to prompt an audit by your security team. Tutorial summary Version 1.0 55 Tagging AWS Resources and Tag Editor User Guide Troubleshooting tag changes The following checklist might be helpful if errors occur when you try to apply or change tags on selected resources in Find resources to tag query results. • The resource might already have the maximum number of tags. Generally, resources can have a maximum of 50 user-deﬁned tags. AWS generated tags don't count toward the 50-tag maximum. Other users might also be adding tags to the same resource at the same time, which could raise the resource's tags to the maximum. • Some services allow a diﬀerent character set (or restrict the character set that is allowed) for creating tags. If you added or changed tags using special characters, review the tag requirements in the resource's service documentation to verify that those characters are allowed by the service. • You might not have permissions to modify the tags for the resource. If you don't have permissions to view existing tags on a resource, you can't make changes to the resource's tags. • You might not have permissions to change the resource. Changes to the resource's metadata might be restricted by another administrator. • The resource might have been edited or deleted by another user or process. For example, assume that a resource was launched as part of the creation of an AWS CloudFormation stack. If the stack was deleted or is no longer in an active state, the resource might no longer be available. • Tag changes might not be possible if a resource is oﬄine or terminated, or if other updates (such as software upgrades) to the resource are in progress. • Tag changes can fail if you close the browser tab or change the page before the tag changes complete. Let tag changes ﬁnish, and wait for the success or failure banner to appear on the page, before you leave the page. • While there's a rate limit for the AWS Resource Groups Tagging API, the service you're tagging might impose a separate limit which you might hit before the Resource Groups Tagging API limit. Retry failed tag changes If tag changes fail on at least one of your selected resources, Tag Editor displays a red banner at the bottom of the page. The banner shows an error message for each type of failure that occurs. For each error, the banner identiﬁes the speciﬁc resources on which Tag Editor couldn't make tag changes. After you review and troubleshoot the errors, choose Retry failed tag changes on resources to retry changes on only those resources on which tag changes failed. Retry failed tag changes Version 1.0 56 Tagging AWS Resources and Tag Editor User Guide Security in Tag Editor Cloud security at AWS is the highest priority. As an AWS customer, you beneﬁt from a data center and network architecture that is built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: •
tag-editor-userguide-023	tag-editor-userguide.pdf	23	troubleshoot the errors, choose Retry failed tag changes on resources to retry changes on only those resources on which tag changes failed. Retry failed tag changes Version 1.0 56 Tagging AWS Resources and Tag Editor User Guide Security in Tag Editor Cloud security at AWS is the highest priority. As an AWS customer, you beneﬁt from a data center and network architecture that is built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The shared responsibility model describes this as security of the cloud and security in the cloud: • Security of the cloud – AWS is responsible for protecting the infrastructure that runs AWS services in the AWS Cloud. AWS also provides you with services that you can use securely. Third- party auditors regularly test and verify the eﬀectiveness of our security as part of the AWS compliance programs. For more information about the compliance programs that apply to Tag Editor, see AWS Services in Scope by Compliance Program. • Security in the cloud – Your responsibility is determined by the AWS service that you use. You are also responsible for other factors including the sensitivity of your data, your company’s requirements, and applicable laws and regulations. This documentation helps you understand how to apply the shared responsibility model when using Tag Editor. The following topics show you how to conﬁgure Tag Editor to meet your security and compliance objectives. Topics • Data protection in Tag Editor • Identity and access management for Tag Editor • Logging and monitoring in Tag Editor • Compliance validation for Tag Editor • Resilience in Tag Editor • Infrastructure security in Tag Editor Data protection in Tag Editor The AWS shared responsibility model applies to data protection in Tag Editor. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. Data protection Version 1.0 57 Tagging AWS Resources and Tag Editor User Guide You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security conﬁguration and management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulﬁll their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put conﬁdential or sensitive information, such as your customers' email addresses, into tags or free-form text ﬁelds such as a Name ﬁeld. This includes when you work with Tag Editor or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text ﬁelds used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. Data encryption Tagging information is not encrypted. Although not encrypted, tags can contain information used as part of your security strategy, so it's important to control who can access tags on resources. It's especially critical that you control who can modify tags because such access could be used to elevate one's permissions. Data encryption Version 1.0 58 Tagging AWS Resources and Tag Editor Encryption at rest User Guide There are no additional ways of isolating service or network traﬃc that are speciﬁc to Tag Editor. If applicable, use AWS speciﬁc isolation. You can use the Tag Editor API and console in a virtual private cloud (VPC) to help maximize privacy and infrastructure security. Encryption in
tag-editor-userguide-024	tag-editor-userguide.pdf	24	as part of your security strategy, so it's important to control who can access tags on resources. It's especially critical that you control who can modify tags because such access could be used to elevate one's permissions. Data encryption Version 1.0 58 Tagging AWS Resources and Tag Editor Encryption at rest User Guide There are no additional ways of isolating service or network traﬃc that are speciﬁc to Tag Editor. If applicable, use AWS speciﬁc isolation. You can use the Tag Editor API and console in a virtual private cloud (VPC) to help maximize privacy and infrastructure security. Encryption in transit Tag Editor data is encrypted in transit to the service's internal database for backup. This is not user- conﬁgurable. Key management Tag Editor is not currently integrated with AWS Key Management Service and does not support AWS KMS keys. Internetwork traﬃc privacy Tag Editor uses HTTPS for all transmissions between Tag Editor users and AWS. Tag Editor uses transport layer security (TLS) 1.3, but also supports TLS 1.2. Identity and access management for Tag Editor AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use Tag Editor resources. IAM is an AWS service that you can use with no additional charge. Topics • Audience • Authenticating with identities • Managing access using policies • How Tag Editor works with IAM • Tag Editor identity-based policy examples • Troubleshooting Tag Editor identity and access Internetwork traﬃc privacy Version 1.0 59 Tagging AWS Resources and Tag Editor User Guide Audience How you use AWS Identity and Access Management (IAM) diﬀers, depending on the work that you do in Tag Editor. Service user – If you use the Tag Editor service to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more Tag Editor features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in Tag Editor, see Troubleshooting Tag Editor identity and access. Service administrator – If you're in charge of Tag Editor resources at your company, you probably have full access to Tag Editor. It's your job to determine which Tag Editor features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with Tag Editor, see How Tag Editor works with IAM. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to Tag Editor. To view example Tag Editor identity-based policies that you can use in IAM, see Tag Editor identity-based policy examples. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If Audience Version 1.0 60 Tagging AWS Resources and Tag Editor User Guide you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an
tag-editor-userguide-025	tag-editor-userguide.pdf	25	use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Users and Groups An IAM user is an identity within your AWS account that has speciﬁc permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have speciﬁc use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that speciﬁes a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are diﬀerent from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. Authenticating with identities Version 1.0 61 Tagging AWS Resources and Tag Editor User Guide Roles An IAM role is an identity within your AWS account that has speciﬁc permissions. It is similar to an IAM user, but is not associated with a speciﬁc person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and deﬁne permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are deﬁned by the role. For information about roles for federation, see Create a role for a third-party identity provider (federation) in the IAM User Guide. If you use IAM Identity Center, you conﬁgure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on diﬀerent permissions for a speciﬁc task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a diﬀerent account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the diﬀerence between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's
tag-editor-userguide-026	tag-editor-userguide.pdf	26	to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the diﬀerence between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a diﬀerent service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. Authenticating with identities Version 1.0 62 Tagging AWS Resources and Tag Editor User Guide • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance proﬁle that is attached to the instance. An instance proﬁle contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, deﬁnes their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies deﬁne permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Managing access using policies Version 1.0 63 Tagging AWS Resources and Tag Editor Identity-based policies User Guide Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Deﬁne custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users,
tag-editor-userguide-027	tag-editor-userguide.pdf	27	Guide Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Deﬁne custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Access control lists (ACLs) Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Managing access using policies Version 1.0 64 Tagging AWS Resources and Tag Editor Other policy types User Guide AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal ﬁeld are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the eﬀective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Managing access using policies Version 1.0 65 Tagging AWS Resources and Tag Editor Multiple policy types User Guide When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide.
tag-editor-userguide-028	tag-editor-userguide.pdf	28	the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Managing access using policies Version 1.0 65 Tagging AWS Resources and Tag Editor Multiple policy types User Guide When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How Tag Editor works with IAM Before you use IAM to manage access to Tag Editor, you should understand what IAM features are available to use with Tag Editor. To get a high-level view of how Tag Editor and other AWS services work with IAM, see AWS services that work with IAM in the IAM User Guide. Topics • Tag Editor identity-based policies • Resource-based policies • Authorization based on tags • Tag Editor IAM roles Tag Editor identity-based policies With IAM identity-based policies, you can specify allowed or denied actions and resources in addition to the conditions under which actions are allowed or denied. Tag Editor supports speciﬁc actions, resources, and condition keys. To learn about all of the elements that you use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Actions Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. How Tag Editor works with IAM Version 1.0 66 Tagging AWS Resources and Tag Editor User Guide Policy actions in Tag Editor use the following preﬁx before the action: tag:. Tag Editor actions are performed entirely in the console, but have the preﬁx tag in log entries. For example, to grant someone permission to tag a resource with the tag:TagResources API operation, you include the tag:TagResources action in their policy. Policy statements must include either an Action or NotAction element. Tag Editor deﬁnes its own set of actions that describe tasks that you can perform with this service. To specify multiple tagging actions in a single statement, separate them with commas as follows. "Action": [ "tag:action1", "tag:action2", "tag:action3" You can specify multiple actions using wildcards (). For example, to specify all actions that begin with the word Get, include the following action. "Action": "tag:Get" To see a list of Tag Editor actions, see Actions, resources, and condition keys for Tag Editor in the Service Authorization Reference. Resources Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Resource JSON policy element speciﬁes the object or objects to which the action applies. Statements must include either a Resource or a NotResource element. As a best practice, specify a resource using its Amazon Resource Name (ARN). You can do this for actions that support a speciﬁc resource type, known as resource-level permissions. For actions that don't support resource-level permissions, such as listing operations, use a wildcard () to indicate that the statement applies to all resources. "Resource": "" Tag Editor does not have any resources of its own. Instead, it manipulates the metadata (tags) that are attached to resources created by other AWS services. How Tag Editor works with IAM Version 1.0 67 Tagging AWS Resources and Tag Editor Condition keys User Guide Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Condition element (or Condition block) lets you specify conditions in which a statement is in eﬀect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are
tag-editor-userguide-029	tag-editor-userguide.pdf	29	block) lets you specify conditions in which a statement is in eﬀect. The Condition element is optional. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. If you specify multiple Condition elements in a statement, or multiple keys in a single Condition element, AWS evaluates them using a logical AND operation. If you specify multiple values for a single condition key, AWS evaluates the condition using a logical OR operation. All of the conditions must be met before the statement's permissions are granted. You can also use placeholder variables when you specify conditions. For example, you can grant an IAM user permission to access a resource only if it is tagged with their IAM user name. For more information, see IAM policy elements: variables and tags in the IAM User Guide. AWS supports global condition keys and service-speciﬁc condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. Tag Editor does not deﬁne any service-speciﬁc condition keys. Examples To view examples of Tag Editor identity-based policies, see Tag Editor identity-based policy examples. Resource-based policies Tag Editor does not support resource-based policies because it doesn't deﬁne any of its own resources. Authorization based on tags Authorization based on tags is part of the security strategy called attribute-based access control (ABAC). To control access to a resource based on its tags, you provide tag information in the condition element of a policy using the aws:ResourceTag/key-name, aws:RequestTag/key-name, or How Tag Editor works with IAM Version 1.0 68 Tagging AWS Resources and Tag Editor User Guide aws:TagKeys condition keys. You can apply tags to a resource when you are creating or updating the resource. To view an example identity-based policy for limiting access to a resource based on the tags on that resource, see Viewing groups based on tags. For more information about attribute-based access control (ABAC), see What is ABAC for AWS? in the IAM User Guide. Tag Editor IAM roles An IAM role is an entity within your AWS account that has speciﬁc permissions. Tag Editor does not have or use service roles. Using temporary credentials with Tag Editor In Tag Editor, you can use temporary credentials to sign in with federation, assume an IAM role, or to assume a cross-account role. You obtain temporary security credentials by calling AWS STS API operations such as AssumeRole or GetFederationToken. Service-linked roles Service-linked roles allow AWS services to access resources in other services to complete an action on your behalf. Tag Editor does not have or use service-linked roles. Service roles This feature allows a service to assume a service role on your behalf. Tag Editor does not have or use service roles. Tag Editor identity-based policy examples By default, IAM principals, such as roles and users, don't have permission to create or modify tags. They also can't perform tasks using the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS APIs. An IAM administrator must create IAM policies that grant principals permission to perform speciﬁc API operations on the speciﬁed resources they need. The administrator must then attach those policies to the principals that require those permissions. For instructions on creating an IAM identity-based policy using these example JSON policy documents, see Creating Policies on the JSON Tab in the IAM User Guide. Topics Identity-based policy examples Version 1.0 69 Tagging AWS Resources and Tag Editor • Policy best practices • Using the Tag Editor console and Resource Groups Tagging API • Allow users to view their own permissions • Viewing groups based on tags Policy best practices User Guide Identity-based policies determine whether someone can create, access, or delete Tag Editor resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by deﬁning AWS customer managed policies that are speciﬁc to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by deﬁning the actions that can be taken on speciﬁc resources under speciﬁc conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. •
tag-editor-userguide-030	tag-editor-userguide.pdf	30	you reduce permissions further by deﬁning AWS customer managed policies that are speciﬁc to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by deﬁning the actions that can be taken on speciﬁc resources under speciﬁc conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a speciﬁc AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API Identity-based policy examples Version 1.0 70 Tagging AWS Resources and Tag Editor User Guide operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the Tag Editor console and Resource Groups Tagging API To access the Tag Editor console and the Resource Groups Tagging API, you must have a minimum set of permissions. These permissions must allow you to list and view details about the tags attached to resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console and API commands won't function as intended for the IAM principals with that policy. To ensure that those principals can still use Tag Editor, attach the following policy (or a policy that contains the permissions listed in the following policy) to the entities. For more information, see Adding permissions to a user in the IAM User Guide: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "tag:GetResources", "tag:TagResources", "tag:UntagResources", "tag:getTagKeys", "tag:getTagValues", "resource-explorer:List" ], "Resource": "" } ] } For more information about granting access to Tag Editor and Resource Groups Tagging API, see Granting permissions for using Tag Editor. Identity-based policy examples Version 1.0 71 Tagging AWS Resources and Tag Editor User Guide Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam:::user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "" } ] } Viewing groups based on tags You can use conditions in your identity-based policy to control access to Tag Editor resources based on tags. This example shows how you might create a policy that allows viewing a resource, in this Identity-based policy examples Version 1.0 72 Tagging AWS Resources and Tag Editor User Guide example, a resource group. However, permission is granted only if the group tag project has the same value as the project tag attached to the calling principal. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "resource-groups:ListGroups", "Resource": "arn:aws:resource-groups::region:account_ID:group/group_name" }, { "Effect": "Allow", "Action": "resource-groups:ListGroups", "Resource": "arn:aws:resource-groups::region:account_ID:group/group_name", "Condition": { "StringEquals": {"aws:ResourceTag/project": "${aws:PrincipalTag/ project}"} } } ] } You can attach this policy to the users in your account. If a user with the tag key project and tag value alpha attempts to view a resource group, the group must also be tagged project=alpha. Otherwise the user is denied access. The condition tag key project matches both Project and project because condition key names are not case-sensitive. For more information, see IAM JSON policy elements:
tag-editor-userguide-031	tag-editor-userguide.pdf	31	the calling principal. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "resource-groups:ListGroups", "Resource": "arn:aws:resource-groups::region:account_ID:group/group_name" }, { "Effect": "Allow", "Action": "resource-groups:ListGroups", "Resource": "arn:aws:resource-groups::region:account_ID:group/group_name", "Condition": { "StringEquals": {"aws:ResourceTag/project": "${aws:PrincipalTag/ project}"} } } ] } You can attach this policy to the users in your account. If a user with the tag key project and tag value alpha attempts to view a resource group, the group must also be tagged project=alpha. Otherwise the user is denied access. The condition tag key project matches both Project and project because condition key names are not case-sensitive. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. Troubleshooting Tag Editor identity and access Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with Tag Editor and IAM. Topics • I am not authorized to perform an action in Tag Editor • I am not authorized to perform iam:PassRole Troubleshooting Version 1.0 73 Tagging AWS Resources and Tag Editor User Guide I am not authorized to perform an action in Tag Editor If the AWS Management Console tells you that you're not authorized to perform an action, then you must contact your administrator for assistance. Your administrator is the person that provided you with your sign-in credentials. The following example error occurs when the user mateojackson tries to use the console to view tags on a resource but does not have tag:GetTagKeys permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: tag:GetTagKeys on resource: arn:aws:resource-groups::us-west-2:123456789012:resource- type/my-test-resource In this case, Mateo asks his administrator to update his policies to allow him to access the my- test-resource resource using the tag:GetTagKeys action. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to Tag Editor. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in Tag Editor. However, the action requires the service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. Logging and monitoring in Tag Editor All Tag Editor actions are logged in AWS CloudTrail. Logging and monitoring Version 1.0 74 Tagging AWS Resources and Tag Editor User Guide Logging Tag Editor API calls with CloudTrail Tag Editor is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Tag Editor. CloudTrail captures all API calls for Tag Editor as events, including calls from the Tag Editor console and from code calls to the Resource Groups Tagging API. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Tag Editor. If you don't conﬁgure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine the request that was made to Tag Editor, the IP address from which the request was made, who made the request, when it was made, and additional details. For more information about CloudTrail, see the AWS CloudTrail User Guide. Tag Editor information in CloudTrail CloudTrail is enabled on your AWS account when you create the account. When activity occurs in Tag Editor, or in the Tag Editor console, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Viewing events with CloudTrail Event history. For an ongoing record of events in your AWS account, including events for Tag Editor, create a trail. A trail enables CloudTrail to deliver log ﬁles to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition and delivers the log ﬁles to the Amazon S3 bucket that you specify. Additionally, you can conﬁgure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following resources: • Creating a trail for your AWS
tag-editor-userguide-032	tag-editor-userguide.pdf	32	in your AWS account, including events for Tag Editor, create a trail. A trail enables CloudTrail to deliver log ﬁles to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition and delivers the log ﬁles to the Amazon S3 bucket that you specify. Additionally, you can conﬁgure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following resources: • Creating a trail for your AWS account • CloudTrail supported services and integrations • Conﬁguring Amazon SNS notiﬁcations for CloudTrail • Receiving CloudTrail log ﬁles from multiple Regions and Receiving CloudTrail log ﬁles from multiple accounts All Tag Editor actions are logged by CloudTrail and are documented in the Tag Editor API Reference. Tag Editor actions in the console are logged by CloudTrail, and are shown as events with tagging.amazonaws.com as the eventSource. CloudTrail Integration Version 1.0 75 Tagging AWS Resources and Tag Editor User Guide Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root or IAM user credentials. • Whether the request was made with temporary security credentials for a role or federated user. • Whether the request was made by another AWS service. For more information, see the CloudTrail userIdentity element. Understanding Tag Editor log ﬁle entries A trail is a conﬁguration that enables delivery of events as log ﬁles to an Amazon S3 bucket that you specify. CloudTrail log ﬁles contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log ﬁles are not an ordered stack trace of the public API calls, so they do not appear in any speciﬁc order. The following example shows a CloudTrail log entry that demonstrates the action TagResources. { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AROAEXAMPLEEXAMPLE:botocore-session-1661372702", "arn": "arn:aws:sts::123456789012:assumed-role/cli-role/botocore- session-1661372702", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": { "type": "Role", "principalId": "AROAEXAMPLEEXAMPLE", "arn": "arn:aws:iam::123456789012:role/cli-role", "accountId": "123456789012", "userName": "cli-role" }, "webIdFederationData": {}, "attributes": { "creationDate": "2022-08-24T20:25:03Z", "mfaAuthenticated": "false" } CloudTrail Integration Version 1.0 76 Tagging AWS Resources and Tag Editor } }, "eventTime": "2022-08-24T20:27:14Z", "eventSource": "tagging.amazonaws.com", "eventName": "TagResources", "awsRegion": "us-east-1", "sourceIPAddress": "72.21.198.65", User Guide "userAgent": "aws-cli/2.7.14 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/ resourcegroupstaggingapi.tag-resources", "requestParameters": { "resourceARNList": [ "arn:aws:events:us-east-1:123456789012:rule/SecretsManagerMonitorRule" ], "tags": { "owner": "alice" } }, "responseElements": { "failedResourcesMap": {} }, "requestID": "8f9ea891-4125-460c-802f-26c11EXAMPLE", "eventID": "b2c9322a-aad7-424b-8f0b-423daEXAMPLE", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "123456789012", "eventCategory": "Management", "tlsDetails": { "tlsVersion": "TLSv1.2", "cipherSuite": "ECDHE-RSA-AES128-GCM-SHA256", "clientProvidedHostHeader": "tagging.us-east-1.amazonaws.com" } } Compliance validation for Tag Editor To learn whether an AWS service is within the scope of speciﬁc compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Compliance validation Version 1.0 77 Tagging AWS Resources and Tag Editor User Guide Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Conﬁg Developer Guide – The AWS Conﬁg service assesses how well your resource conﬁgurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements,
tag-editor-userguide-033	tag-editor-userguide.pdf	33	well your resource conﬁgurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Resilience in Tag Editor Tag Editor performs automated backups to internal service resources. These backups are not user- conﬁgurable. Backups are encrypted, both at rest and in transit. Tag Editor stores customer data in Amazon DynamoDB. Resilience Version 1.0 78 Tagging AWS Resources and Tag Editor User Guide The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between Availability Zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. If you delete tags accidentally, contact AWS Support Center. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. Infrastructure security in Tag Editor Tag Editor doesn't provide additional ways of isolating service or network traﬃc. If applicable, use AWS speciﬁc isolation. You can use the Tag Editor API and console in a virtual private cloud (VPC) to help maximize privacy and infrastructure security. You use AWS published API calls to access Tag Editor through the network. Clients must support the following: • Transport Layer Security (TLS). We require TSL 1.2 and recommend TSL 1.3. • Cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diﬃe-Hellman) or ECDHE (Elliptic Curve Ephemeral Diﬃe-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an AWS Identity and Access Management (IAM) principal. Or, you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Tag Editor does not support resource-based policies. You can call Tag Editor API operations from any network location, but Tag Editor does support resource-based access policies, which can include restrictions based on the source IP address. You can also use Tag Editor policies to control access from speciﬁc Amazon Virtual Private Cloud (Amazon VPC) endpoints or speciﬁc VPCs. Eﬀectively, this approach isolates network access to a given resource from only the speciﬁc VPC within the AWS network. Infrastructure security Version 1.0 79 Tagging AWS Resources and Tag Editor User Guide Service quotas The following table provides information about the service quotas for Tag Editor. These quotas are currently not adjustable using the Service Quotas console. Contact Support. Name Default Tags attached per resource Tag key name 50 user-deﬁned tags (AWS generated tags don't count against this limit.) Minimum of 1, maximum 128 Unicode characters in UTF-8. Allowed characters include letters, numbers, spaces, and the following characters: _ . : / = + - @ Key names can't begin with aws: because that preﬁx is reserved for AWS use. Note Some AWS services have some additiona l character or length restrictions. For details, see the documentation for the speciﬁc service. Tag values Minimum of 0, maximum of 256 Unicode characters in UTF-8. Version 1.0 80 Tagging AWS Resources and Tag Editor User Guide Name Default Allowed characters include letters, numbers, spaces, and the following characters: _ . : / = + - @ Note Some AWS services have some additiona l character or length restrictions. For details, see the documentation for the speciﬁc service. Rate of calling the GetResour ces API operation Maximum of 15 calls per second Rate of calling the following API operations: Maximum of 5 calls per second • TagResources • UntagResources • GetTagKeys • GetTagValues Version 1.0 81 Tagging AWS Resources and Tag Editor User Guide Tag Editor document history Change Description Date Tag management in the AWS Resource Groups Tag Editor AWS has moved Tag Editor tag management functiona console has moved to AWS lity from the AWS Resource Resource Explorer console Groups console to the AWS April 10, 2025 Resource Explorer console. To learn more about managing resource tags in
tag-editor-userguide-034	tag-editor-userguide.pdf	34	calling the GetResour ces API operation Maximum of 15 calls per second Rate of calling the following API operations: Maximum of 5 calls per second • TagResources • UntagResources • GetTagKeys • GetTagValues Version 1.0 81 Tagging AWS Resources and Tag Editor User Guide Tag Editor document history Change Description Date Tag management in the AWS Resource Groups Tag Editor AWS has moved Tag Editor tag management functiona console has moved to AWS lity from the AWS Resource Resource Explorer console Groups console to the AWS April 10, 2025 Resource Explorer console. To learn more about managing resource tags in Resource Explorer, review Managing resources in the Resource Explorer user guide. Updated permissions for evaluating organization-wide Updated the Permissions for evaluating organization- August 28, 2024 compliance Updated content Tagging content from AWS General Reference moved to this guide IAM best practices update wide compliance to include permissions that assist with accessing the compliance report. Updated topic titles and reorganized content to improve readability and discoverability. The topics about tagging your AWS resources was moved from the AWS General Reference to this guide. Updated guide to align with the IAM best practices . For more information, see Security best practices in IAM. July 25, 2024 March 24, 2023 January 3, 2023 Version 1.0 82 Tagging AWS Resources and Tag Editor User Guide Moving Tag Editor documenta tion to its own guide Tag Editor documentation is now provided in its own user December 13, 2022 guide instead of being part of the AWS Resource Groups User Guide. Check for compliance with tag policies After you create and attach tag policies to accounts using November 26, 2019 AWS Organizations, you can ﬁnd noncompliant tags on resources in your organizat ion's accounts. Tag Editor now supports ﬁnding untagged resources You can now search for resources in Tag Editor that June 18, 2019 do not have tag values applied for a speciﬁc tag key. Tag Editor console moves out of AWS Systems Manager The Tag Editor console is now independent from the June 5, 2019 console Older, legacy Tag Editor tools are no longer available Systems Manager console. Although you can still ﬁnd pointers to the Tag Editor console in the Systems Manager left navigation bar, you can open the Tag Editor console directly from the drop-down menu at the upper left of the AWS Management Console. Mentions of older, classic, or legacy Tag Editor have been removed; these tools are no longer available in AWS. Use Tag Editor instead. May 14, 2019 Version 1.0 83 Tagging AWS Resources and Tag Editor User Guide Tag Editor now supports tagging resources across multiple regions Tag Editor now supports exporting query results to a CSV May 2, 2019 April 2, 2019 Tag Editor now lets you search for and manage tags of resources across multiple regions, with your current region added to resource queries by default. You can export the results of a query on the Find Resources to tag page to a CSV-formatted ﬁle. A new Region column is shown in Tag Editor query results. Tag Editor now lets you search for resources that have empty values for a speciﬁc tag key. Tag key values auto-complete as you type a unique value among existing keys. Tag Editor now supports adding all resource types to a You can apply tags to up to 20 individual resource types March 19, 2019 query in a single operation, or you can choose All resource types to query all resource types in a region. Autocompletion has been added to the Tag key ﬁeld of a query to help enable consistent tag keys among resources. If tag changes fail on some resources, you can retry tag changes on just resources for which tag changes failed. Version 1.0 84 Tagging AWS Resources and Tag Editor User Guide Tag Editor now supports multiple resource types in a You can apply tags to up to 20 resource types in a February 26, 2019 search single operation. You can also choose the columns that are shown to you in search results, including columns for each unique tag key found in your search results or selected resources from results. Version 1.0 85
textract-dg-001	textract-dg.pdf	1	Developer Guide Amazon Textract Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon Textract Developer Guide Amazon Textract: Developer Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon Textract Table of Contents Developer Guide What is Amazon Textract? .............................................................................................................. 1 First-Time Amazon Textract Users ............................................................................................................ 3 Getting Started ................................................................................................................................ 4 Step 1: Set Up a User .................................................................................................................................. 4 Sign up for an AWS account ................................................................................................................ 4 Create a user with administrative access ........................................................................................... 5 Next Step .................................................................................................................................................. 6 Step 2: Set Up the AWS CLI and AWS SDKs ........................................................................................... 6 Download AWS CLI and SDK ................................................................................................................ 6 Granting Programmatic Access ............................................................................................................ 8 Next Step ................................................................................................................................................ 12 Step 3: Get Started Using the AWS CLI and AWS SDK API ............................................................... 12 Formatting the AWS CLI Examples ................................................................................................... 12 Identifying Your Use Case ............................................................................................................. 13 Detecting Text ............................................................................................................................................. 14 Analyzing Documents ................................................................................................................................ 15 Analyzing Invoices and Receipts ............................................................................................................. 18 Analyzing Identity Documents ................................................................................................................ 23 Analyzing Lending Documents ................................................................................................................ 25 Customizing Outputs ................................................................................................................................. 31 Interpreting Responses .................................................................................................................. 32 Locating Items on a Document Page ..................................................................................................... 32 Bounding Box ......................................................................................................................................... 34 Polygon ................................................................................................................................................... 36 Text Detection and Document Analysis Response Objects ............................................................... 37 Document Layout .................................................................................................................................. 37 Conﬁdence .............................................................................................................................................. 39 Geometry ................................................................................................................................................ 39 Pages ........................................................................................................................................................ 40 Lines and Words of Text ..................................................................................................................... 41 Form Data (Key-Value Pairs) ............................................................................................................... 43 Tables ....................................................................................................................................................... 47 Selection Elements ............................................................................................................................... 59 Queries .................................................................................................................................................... 66 iii Amazon Textract Developer Guide Layout Response Objects ......................................................................................................................... 68 Invoice and Receipt Response Objects .................................................................................................. 70 Type ......................................................................................................................................................... 71 LabelDetection ....................................................................................................................................... 72 ValueDetection ...................................................................................................................................... 73 Identity Documentation Response Objects .......................................................................................... 73 Analyze Lending Response Objects ........................................................................................................ 75 Document Types ................................................................................................................................... 84 Processing Documents Synchronously ......................................................................................... 87 Calling Amazon Textract Synchronous Operations ............................................................................. 87 Request .................................................................................................................................................... 88 Using an adapter .................................................................................................................................. 90 Response ................................................................................................................................................. 91 Detecting Document Text ...................................................................................................................... 162 Analyzing Document Text ...................................................................................................................... 178 Analyzing Invoice and Receipt Documents ......................................................................................... 197 Analyzing ID Documents ........................................................................................................................ 211 Processing Documents Asynchronously ..................................................................................... 218 Calling Asynchronous Operations ........................................................................................................ 219 Starting Text Detection ..................................................................................................................... 220 Getting the Completion Status of an Amazon Textract Analysis Request .............................. 222 Getting Amazon Textract Text Detection Results ........................................................................ 224 Using an adapter ................................................................................................................................ 233 Conﬁguring Asynchronous Operations ................................................................................................ 234 Giving Amazon Textract Access to Your Amazon SNS Topic ..................................................... 236 Permissions for Output Conﬁguration ........................................................................................... 237 Detecting or Analyzing Text in a Multipage Document ................................................................... 239 Performing Asynchronous Operations ........................................................................................... 240 Using the Analyze Lending Workﬂow ................................................................................................. 270 Performing Asynchronous Lending Analysis ................................................................................. 271 Amazon Textract Results Notiﬁcation ................................................................................................. 278 Customizing your Queries Responses ........................................................................................ 280 Creating adapters ..................................................................................................................................... 282 Create an Adapter .............................................................................................................................. 282 Get adapter .......................................................................................................................................... 283 List adapters ........................................................................................................................................ 284 iv Amazon Textract Developer Guide Update adapter ................................................................................................................................... 284 Delete an Adapter .............................................................................................................................. 285 Preparing training and testing datasets ............................................................................................. 286 Training adapter versions ....................................................................................................................... 289 Create adapter version ...................................................................................................................... 289 Evaluating and improving your adapters ........................................................................................... 290 List adapter versions .......................................................................................................................... 292 Get an Adapter version ..................................................................................................................... 292 Delete adapter version ...................................................................................................................... 293 Debugging training failures ................................................................................................................... 294 Using Adapters during Inference .......................................................................................................... 298 Custom Queries tutorial ......................................................................................................................... 298 Prerequisites ........................................................................................................................................ 299 Create an adapter ............................................................................................................................... 299 Dataset creation .................................................................................................................................. 301 Annotation and veriﬁcation ............................................................................................................. 303 Training ................................................................................................................................................. 307 Evaluating adapter performance .................................................................................................... 308 Improving an adapter ........................................................................................................................ 310 Inference ............................................................................................................................................... 310 Adapter management ........................................................................................................................ 311 Copying adapters ..................................................................................................................................... 312 Best Practices ............................................................................................................................... 314 Provide an Optimal Input Document .................................................................................................. 314 Use Conﬁdence Scores ............................................................................................................................ 316 Best Practices for Queries ...................................................................................................................... 317 Example Queries ................................................................................................................................. 317 General Best Practices for Queries ................................................................................................. 317 Extracting Cells from Tables ............................................................................................................ 317 Extracting Tables using Queries ...................................................................................................... 317 Long Answers ...................................................................................................................................... 317 Passing Only Hints ............................................................................................................................. 318 General Phrasing of Questions ........................................................................................................ 318 Setting up Pages for Queries ........................................................................................................... 319 Best Practices for Bulk Document Uploader ...................................................................................... 319 Limits ..................................................................................................................................................... 321 v Amazon Textract Developer Guide Best practices for Amazon Textract Custom Queries ....................................................................... 321 Handling Connection Errors ....................................................................................................... 323 Tutorials ....................................................................................................................................... 329 Prerequisites .............................................................................................................................................. 329 Extracting Key-Value Pairs from a Form Document ......................................................................... 330 Exporting Tables into a CSV File .......................................................................................................... 333 Detecting text with an AWS Lambda function .................................................................................. 343 Step 1: Create an AWS Lambda function (console) ..................................................................... 344 Step 2: (Optional) Create a layer (console) ................................................................................... 346 Step 3: Add Python code (console) ................................................................................................ 347 Step 4: Try your Lambda function .................................................................................................. 349 Extracting and Sending Text to AWS Comprehend for Analysis .................................................... 354 Prerequisites ........................................................................................................................................ 354 Starting
textract-dg-002	textract-dg.pdf	2	Amazon Textract Developer Guide Best practices for Amazon Textract Custom Queries ....................................................................... 321 Handling Connection Errors ....................................................................................................... 323 Tutorials ....................................................................................................................................... 329 Prerequisites .............................................................................................................................................. 329 Extracting Key-Value Pairs from a Form Document ......................................................................... 330 Exporting Tables into a CSV File .......................................................................................................... 333 Detecting text with an AWS Lambda function .................................................................................. 343 Step 1: Create an AWS Lambda function (console) ..................................................................... 344 Step 2: (Optional) Create a layer (console) ................................................................................... 346 Step 3: Add Python code (console) ................................................................................................ 347 Step 4: Try your Lambda function .................................................................................................. 349 Extracting and Sending Text to AWS Comprehend for Analysis .................................................... 354 Prerequisites ........................................................................................................................................ 354 Starting Asynchronous Document Text Detection ...................................................................... 355 Processing Your Documents and Sending the Text to Comprehend ........................................ 360 Additional Code Samples ....................................................................................................................... 367 Security ........................................................................................................................................ 368 Data Protection ........................................................................................................................................ 368 Encryption in Amazon Textract ....................................................................................................... 369 Internetwork Traﬃc Privacy ............................................................................................................. 370 Custom Queries ................................................................................................................................... 370 Identity and Access Management ........................................................................................................ 371 Audience ............................................................................................................................................... 371 Authenticating With Identities ......................................................................................................... 372 Managing Access Using Policies ...................................................................................................... 375 How Amazon Textract Works with IAM ......................................................................................... 377 Identity-Based Policy Examples ....................................................................................................... 381 Troubleshooting .................................................................................................................................. 389 Logging and Monitoring ......................................................................................................................... 391 Monitoring ............................................................................................................................................ 391 CloudWatch Metrics for Amazon Textract ..................................................................................... 396 Logging Amazon Textract API Calls with AWS CloudTrail ............................................................... 397 Amazon Textract Information in CloudTrail .................................................................................. 398 Understanding Amazon Textract Log File Entries ....................................................................... 399 Tagging resources .................................................................................................................................... 401 Tag resource ......................................................................................................................................... 402 vi Amazon Textract Developer Guide List tags for resource ......................................................................................................................... 402 Untag resource .................................................................................................................................... 403 Compliance Validation ............................................................................................................................ 403 Resilience ................................................................................................................................................... 404 Cross-service confused deputy prevention ......................................................................................... 405 Infrastructure Security ............................................................................................................................ 407 Conﬁguration and Vulnerability Analysis ........................................................................................... 407 VPC endpoints (AWS PrivateLink) ........................................................................................................ 408 Considerations for Amazon Textract VPC endpoints .................................................................. 408 Creating an interface VPC endpoint for Amazon Textract ......................................................... 408 Creating a VPC endpoint policy for Amazon Textract ................................................................ 409 API Reference ............................................................................................................................... 410 Actions ........................................................................................................................................................ 410 AnalyzeDocument ............................................................................................................................... 412 AnalyzeExpense ................................................................................................................................... 420 AnalyzeID .............................................................................................................................................. 428 CreateAdapter ...................................................................................................................................... 434 CreateAdapterVersion ........................................................................................................................ 439 DeleteAdapter ...................................................................................................................................... 445 DeleteAdapterVersion ........................................................................................................................ 448 DetectDocumentText ......................................................................................................................... 451 GetAdapter ........................................................................................................................................... 456 GetAdapterVersion ............................................................................................................................. 461 GetDocumentAnalysis ........................................................................................................................ 467 GetDocumentTextDetection ............................................................................................................. 474 GetExpenseAnalysis ............................................................................................................................ 481 GetLendingAnalysis ............................................................................................................................ 490 GetLendingAnalysisSummary ........................................................................................................... 503 ListAdapters ......................................................................................................................................... 508 ListAdapterVersions ............................................................................................................................ 512 ListTagsForResource ........................................................................................................................... 516 StartDocumentAnalysis ..................................................................................................................... 519 StartDocumentTextDetection ........................................................................................................... 526 StartExpenseAnalysis ......................................................................................................................... 532 StartLendingAnalysis ......................................................................................................................... 538 TagResource ......................................................................................................................................... 545 vii Amazon Textract Developer Guide UntagResource .................................................................................................................................... 548 UpdateAdapter .................................................................................................................................... 551 Data Types ................................................................................................................................................. 555 Adapter ................................................................................................................................................. 558 AdapterOverview ................................................................................................................................ 560 AdaptersConﬁg .................................................................................................................................... 562 AdapterVersionDatasetConﬁg .......................................................................................................... 563 AdapterVersionEvaluationMetric ..................................................................................................... 564 AdapterVersionOverview ................................................................................................................... 565 AnalyzeIDDetections .......................................................................................................................... 567 Block ...................................................................................................................................................... 568 BoundingBox ........................................................................................................................................ 575 DetectedSignature .............................................................................................................................. 577 Document ............................................................................................................................................. 578 DocumentGroup .................................................................................................................................. 580 DocumentLocation ............................................................................................................................. 582 DocumentMetadata ............................................................................................................................ 583 EvaluationMetric ................................................................................................................................. 584 ExpenseCurrency ................................................................................................................................. 585 ExpenseDetection ............................................................................................................................... 587 ExpenseDocument .............................................................................................................................. 588 ExpenseField ........................................................................................................................................ 590 ExpenseGroupProperty ...................................................................................................................... 592 ExpenseType ........................................................................................................................................ 593 Extraction ............................................................................................................................................. 594 Geometry .............................................................................................................................................. 595 HumanLoopActivationOutput .......................................................................................................... 596 HumanLoopConﬁg .............................................................................................................................. 598 HumanLoopDataAttributes ............................................................................................................... 600 IdentityDocument ............................................................................................................................... 601 IdentityDocumentField ...................................................................................................................... 603 LendingDetection ................................................................................................................................ 604 LendingDocument .............................................................................................................................. 606 LendingField ........................................................................................................................................ 607 LendingResult ...................................................................................................................................... 608 LendingSummary ................................................................................................................................ 609 viii Amazon Textract Developer Guide LineItemFields ..................................................................................................................................... 610 LineItemGroup ..................................................................................................................................... 611 NormalizedValue ................................................................................................................................. 612 NotiﬁcationChannel ............................................................................................................................ 613 OutputConﬁg ....................................................................................................................................... 614 PageClassiﬁcation ............................................................................................................................... 616 Point ...................................................................................................................................................... 617 Prediction ............................................................................................................................................. 618 QueriesConﬁg ...................................................................................................................................... 619 Query ..................................................................................................................................................... 620 Relationship ......................................................................................................................................... 622 S3Object ............................................................................................................................................... 624 SignatureDetection ............................................................................................................................. 626 SplitDocument ..................................................................................................................................... 627 UndetectedSignature ......................................................................................................................... 628 Warning ................................................................................................................................................. 629 Quotas .......................................................................................................................................... 630 Set Quotas ................................................................................................................................................. 630 Modifying Default Quotas ..................................................................................................................... 632 Types of Quotas .................................................................................................................................. 632 Calculate quota increase ................................................................................................................... 634 Best Practices for Service Quota Increase Requests .................................................................... 637 Change Default Quota ...................................................................................................................... 638 Quota Modiﬁcation Eﬀects ............................................................................................................... 638 Document History ........................................................................................................................ 640 ix Amazon Textract Developer Guide What is Amazon Textract? Amazon Textract helps you add document text detection and analysis to your applications. Using Amazon Textract, you can do the following: • Detect typed and handwritten text in a variety of documents, including ﬁnancial reports, medical records, and tax forms. • Extract text, forms, and tables from documents with structured data, using the Amazon Textract Document Analysis API. • Specify and extract information from documents using the Queries feature within the Amazon Textract Analyze Document API. • Process invoices and receipts with the AnalyzeExpense API. • Process ID documents such as drivers licenses and passports issued by U.S. government, using the AnalyzeID API. • Upload and process mortgage loan packages, through automatic routing of the the document pages to the appropriate Amazon Textract analysis operations using the Analyze Lending workﬂow. You can retrieve analysis results for each document page or you can retrieve summarized results for a set of document pages. • Use Custom Queries to customize the pretrained Queries feature using your data to support your down stream processing needs. Amazon Textract is based on the same proven, highly scalable, deep-learning technology that was developed by Amazon's computer vision scientists to analyze billions of images and videos daily. You don't need any
textract-dg-003	textract-dg.pdf	3	• Upload and process mortgage loan packages, through automatic routing of the the document pages to the appropriate Amazon Textract analysis operations using the Analyze Lending workﬂow. You can retrieve analysis results for each document page or you can retrieve summarized results for a set of document pages. • Use Custom Queries to customize the pretrained Queries feature using your data to support your down stream processing needs. Amazon Textract is based on the same proven, highly scalable, deep-learning technology that was developed by Amazon's computer vision scientists to analyze billions of images and videos daily. You don't need any machine learning expertise to use it, as Amazon Textract includes simple, easy-to-use API operations that can analyze image ﬁles and PDF ﬁles. Amazon Textract is always learning from new data, and Amazon is continually adding new features to the service. The following are common use cases for using Amazon Textract: • Creating an intelligent search index – Using Amazon Textract you can create libraries of text that is detected in image and PDF ﬁles. • Using intelligent text extraction for natural language processing (NLP) – Amazon Textract provides you with control over how text is grouped as an input for NLP applications. It can extract text as words and lines. It also groups text by table cells if Amazon Textract document table analysis is enabled. 1 Amazon Textract Developer Guide • Accelerating the capture and normalization of data from diﬀerent sources – Amazon Textract enables text and tabular data extraction from a wide variety of documents, such as ﬁnancial documents, research reports, and medical notes. With Amazon Textract Analyze Document APIs, you can easily and quickly extract unstructured and structured data from your documents. • Automating data capture from forms – Amazon Textract enables structured data to be extracted from forms. With Amazon Textract Analysis APIs, you can build extraction capabilities into existing business workﬂows so that user data submitted through forms can be extracted into a usable format. • Automating document classiﬁcation and extraction – With Amazon Textract's Analyze Lending document processing API, you can automate the classiﬁcation of lending documents into various document classes, and then automatically route the classiﬁed pages to the correct analysis operation for further processing. Some of the beneﬁts of using Amazon Textract include: • Integration of document text detection into your apps – Amazon Textract removes the complexity of building text detection capabilities into your applications by making powerful and accurate analysis available with a simple API. You don’t need computer vision or deep learning expertise to use Amazon Textract to detect document text. With Amazon Textract Text APIs, you can easily build text detection into any web, mobile, or connected device application. • Scalable document analysis – Amazon Textract enables you to analyze and extract data quickly from millions of documents, which can accelerate decision making. • Low cost – With Amazon Textract, you only pay for the documents you analyze. There are no minimum fees or upfront commitments. You can get started for free, and save more as you grow with our tiered pricing model. With synchronous processing, Amazon Textract can analyze single-page documents for applications where latency is critical. Amazon Textract also provides asynchronous operations to extend support to multipage documents. Amazon Textract's API operations have quotas that limit how quickly and how often you can use them. If the limit set for your account is frequently exceeded, you can request a limit increase. To change a limit, select the Amazon Textract option in the Service Quotas console. You can use the Quotas Calculator in the Amazon Textract console to determine your quota requirements. To learn more about default quotas that can be changed, see Information on Default Quotas in Amazon Textract. 2 Amazon Textract Developer Guide Other quotas, like ﬁle size and languages supported by Amazon Textract, cannot be changed. For more information on set quotas, see Set Quotas in Amazon Textract. First-Time Amazon Textract Users If this is your ﬁrst time using Amazon Textract, we recommend that you read the following sections in order: 1. Identifying Your Amazon Textract Use Case – This section introduces the Amazon Textract components and how they work together for an end-to-end experience. 2. Getting Started with Amazon Textract – In this section, you set up your account and test the Amazon Textract API. First-Time Amazon Textract Users 3 Amazon Textract Developer Guide Getting Started with Amazon Textract This section provides topics to get you started using Amazon Textract. It covers the prerequisites of creating and conﬁguring your AWS account and the AWS SDKs you will use to invoke the Amazon Textract APIs. If you're new to Amazon Textract, we recommend that you ﬁrst review the concepts and terminology in Identifying Your Amazon Textract Use Case. You can try the API by using
textract-dg-004	textract-dg.pdf	4	2. Getting Started with Amazon Textract – In this section, you set up your account and test the Amazon Textract API. First-Time Amazon Textract Users 3 Amazon Textract Developer Guide Getting Started with Amazon Textract This section provides topics to get you started using Amazon Textract. It covers the prerequisites of creating and conﬁguring your AWS account and the AWS SDKs you will use to invoke the Amazon Textract APIs. If you're new to Amazon Textract, we recommend that you ﬁrst review the concepts and terminology in Identifying Your Amazon Textract Use Case. You can try the API by using the demonstration in the Amazon Textract console. For more information, see https://console.aws.amazon.com/textract/. Topics • Step 1: Set Up an AWS Account and Create a User • Step 2: Set Up the AWS CLI and AWS SDKs • Step 3: Get Started Using the AWS CLI and AWS SDK API Step 1: Set Up an AWS Account and Create a User Sign up for an AWS account If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a veriﬁcation code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. AWS sends you a conﬁrmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. Step 1: Set Up a User 4 Amazon Textract Developer Guide Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. 2. Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Create a user with administrative access 1. Enable IAM Identity Center. For instructions, see Enabling AWS IAM Identity Center in the AWS IAM Identity Center User Guide. 2. In IAM Identity Center, grant administrative access to a user. For a tutorial about using the IAM Identity Center directory as your identity source, see Conﬁgure user access with the default IAM Identity Center directory in the AWS IAM Identity Center User Guide. Sign in as the user with administrative access • To sign in with your IAM Identity Center user, use the sign-in URL that was sent to your email address when you created the IAM Identity Center user. For help signing in using an IAM Identity Center user, see Signing in to the AWS access portal in the AWS Sign-In User Guide. Create a user with administrative access 5 Amazon Textract Developer Guide Assign access to additional users 1. In IAM Identity Center, create a permission set that follows the best practice of applying least- privilege permissions. For instructions, see Create a permission set in the AWS IAM Identity Center User Guide. 2. Assign users to a group, and then assign single sign-on access to the group. For instructions, see Add groups in the AWS IAM Identity Center User Guide. Next Step Step 2: Set Up the AWS CLI and AWS SDKs Step 2: Set Up the AWS CLI and AWS SDKs The following steps show you how to install the AWS Command Line Interface (AWS CLI) and AWS SDKs that the examples in this documentation use. There are a number of diﬀerent ways to authenticate AWS SDK calls. The examples in this guide assume that you're using a default credentials proﬁle for calling AWS CLI commands and AWS SDK API operations. Your default credentials will work across services, so if you have already conﬁgured your credentials you don't need to do so again. However, if you would like to create another set of credentials for this service, you can create a name proﬁle. For more information about creating proﬁles, see Named Proﬁles. For a list of available AWS Regions, see Regions and Endpoints in the Amazon Web
textract-dg-005	textract-dg.pdf	5	are a number of diﬀerent ways to authenticate AWS SDK calls. The examples in this guide assume that you're using a default credentials proﬁle for calling AWS CLI commands and AWS SDK API operations. Your default credentials will work across services, so if you have already conﬁgured your credentials you don't need to do so again. However, if you would like to create another set of credentials for this service, you can create a name proﬁle. For more information about creating proﬁles, see Named Proﬁles. For a list of available AWS Regions, see Regions and Endpoints in the Amazon Web Services General Reference. Download AWS CLI and SDK To set up the AWS CLI and the AWS SDKs 1. Download and install the AWS CLI and the AWS SDKs that you want to use. This guide provides examples for the AWS CLI, Java, and Python. For information about other AWS SDKs, see Tools for Amazon Web Services. • AWS CLI Next Step 6 Amazon Textract Developer Guide • AWS SDK for Java • AWS SDK for Python (Boto3) 2. Create an access key for the user that you created in Step 1: Set Up an AWS Account and Create a User. a. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. In the navigation pane, choose Users. Choose the name of the user that you created in Step 1: Set Up an AWS Account and b. c. Create a User. d. Choose the Security credentials tab. e. Choose Create access key. Then choose Download .csv ﬁle to save the access key ID and secret access key to a CSV ﬁle on your computer. Store the ﬁle in a secure location. You will not have access to the secret access key again after this dialog box closes. After you've downloaded the CSV ﬁle, choose Close. 3. Set credentials in the AWS credentials proﬁle ﬁle on your local system, located at: • ~/.aws/credentials on Linux, macOS, or Unix. • C:\Users\USERNAME\.aws\credentials on Windows. The .aws folder does not exist prior to your ﬁrst initial conﬁguration of your AWS instance. The ﬁrst time you conﬁgure your credentials with the CLI, this folder will be created. For more information regarding AWS credentials, see Conﬁguration and Credential File Settings. This ﬁle should contain lines in the following format: [default] aws_access_key_id = your_access_key_id aws_secret_access_key = your_secret_access_key Substitute your access key ID and secret access key for your_access_key_id and your_secret_access_key. 4. Set the default AWS Region in the AWS config ﬁle on your local system, located at: • ~/.aws/config on Linux, macOS, or Unix. • C:\Users\USERNAME\.aws\config on Windows. Download AWS CLI and SDK 7 Amazon Textract Developer Guide The .aws folder does not exist prior to your ﬁrst initial conﬁguration of your AWS instance. The ﬁrst time you conﬁgure your credentials with the CLI, this folder will be created. For more information regarding AWS credentials, see Conﬁguration and Credential File Settings. This ﬁle should contain the following lines: [default] region = your_aws_region Substitute the AWS Region you want (for example, "us-west-2") for your_aws_region. Note If you don't choose a Region, then us-east-1 is used by default. Note If you intend to call the Amazon Textract demo objects programmatically, insure that you have access to the arn:aws:s3:::textract-public-assets-region/* bucket. From here, go to the section called “Granting Programmatic Access” so you can further set up your enviroment with appropriate permissions for using Amazon Textract operations. Granting Programmatic Access You can run the AWS CLI and code examples in this guide on your local computer or other AWS enviroments, such as an Amazon Elastic Compute Cloud instance. To use the features in the Amazon Textract SDK, you'll need to grant your user access. This section will discuss what permissions a use might need for the Amazon Textract SDK, and assigning permissions to users. Setting up SDK Permissions We reccomend that you only grant permissions required to perform a task (least-privilege permissions) For example to call AnalyzeDocumentText, you need permission to perform textract:AnalyzeDocumentText. When starting out with the application you might not Granting Programmatic Access 8 Amazon Textract Developer Guide know what permissions you need, so you can start with broader permissions. You can use the AmazonTextractFullAccess managed policy to get complete access to the Amazon Textract API. Running Code on your Local Computer To run code on a local computer, we recommend that you use short-term credentials to grant a user access to AWS SDK operations. For speciﬁc information about running the AWS CLI and code examples on a local computer, see Using a proﬁle on your local computer. Users need programmatic access if they want to interact with AWS outside of the AWS Management Console. The way to grant programmatic access depends on the type of user that's accessing AWS. To grant users programmatic
textract-dg-006	textract-dg.pdf	6	AmazonTextractFullAccess managed policy to get complete access to the Amazon Textract API. Running Code on your Local Computer To run code on a local computer, we recommend that you use short-term credentials to grant a user access to AWS SDK operations. For speciﬁc information about running the AWS CLI and code examples on a local computer, see Using a proﬁle on your local computer. Users need programmatic access if they want to interact with AWS outside of the AWS Management Console. The way to grant programmatic access depends on the type of user that's accessing AWS. To grant users programmatic access, choose one of the following options. Which user needs programmatic access? To By Workforce identity (Users managed in IAM Identity Center) Use temporary credentials to sign programmatic requests Following the instructions for the interface that you want to to the AWS CLI, AWS SDKs, or use. AWS APIs. • For the AWS CLI, see Conﬁguring the AWS CLI to use AWS IAM Identity Center in the AWS Command Line Interface User Guide. • For AWS SDKs, tools, and AWS APIs, see IAM Identity Center authentication in the AWS SDKs and Tools Reference Guide. IAM Use temporary credentials to sign programmatic requests Following the instructions in Using temporary credentia Granting Programmatic Access 9 Amazon Textract Developer Guide Which user needs programmatic access? To By to the AWS CLI, AWS SDKs, or ls with AWS resources in the AWS APIs. IAM User Guide. IAM (Not recommended) Use long-term credentials to Following the instructions for the interface that you want to sign programmatic requests use. to the AWS CLI, AWS SDKs, or AWS APIs. • For the AWS CLI, see Authenticating using IAM user credentials in the AWS Command Line Interface User Guide. • For AWS SDKs and tools, see Authenticate using long-term credentials in the AWS SDKs and Tools Reference Guide. • For AWS APIs, see Managing access keys for IAM users in the IAM User Guide. Using a proﬁle on your local computer You can run the AWS CLI and code examples in this guide with the short-term credentials you create in Running code on your local computer. To get the credentials and other settings information, the examples use a proﬁle named profile-name For example: session = boto3.Session(profile_name="profile-name") client = session.client("textract") The user that the proﬁle represents must have permissions to call the Textract SDK operations and other AWS SDK operations needed by the examples. Granting Programmatic Access 10 Amazon Textract Developer Guide To create a proﬁle that works with the AWS CLI and code examples, choose one of the following. Make sure the name of the proﬁle you create is profile-name. • Users managed by IAM - Follow the instructions at Switching to an IAM role (AWS CLI). • Workforce identity (Users managed by AWS IAM Identity Center (successor to AWS Single Sign- On)) — Follow the instructions at Conﬁguring the AWS CLI to use AWS IAM Identity Center (successor to AWS Single Sign-On). For the code examples, we recommend using an Integrated Development Environment (IDE), which supports the AWS Toolkit enabling authentication through IAM Identity Center. For the Java examples, see Start building with Java. For the Python examples, see Start building with Python. For more information, see IAM Identity Center credentials. Running code in AWS enviroments You shouldn't use user credentials to sign AWS SDK calls in AWS environments, such as production code running in an AWS Lambda function. Instead, you conﬁgure a role that deﬁnes the permissions that your code needs. You then attach the role to the environment that your code runs in. How you attach the role and make temporary credentials available varies depending on the environment that your code runs in: • AWS Lambda function — Use the temporary credentials that Lambda automatically provides to your function when it assumes the Lambda function's execution role. The credentials are available in the Lambda environment variables. You don't need to specify a proﬁle. For more information, see Lambda execution role. • Amazon EC2 — Use the Amazon EC2 instance metadata endpoint credentials provider. The provider automatically generates and refreshes credentials for you using the Amazon EC2 instance proﬁle you attach to the Amazon EC2 instance. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. • Amazon Elastic Container Service — Use the Container credentials provider. Amazon ECS sends and refreshes credentials to a metadata endpoint. A task IAM role that you specify provides a strategy for managing the credentials that your application uses. For more information, see Interact with AWS services. For more information about credential providers, see Standardized credential providers. Granting Programmatic Access 11 Amazon Textract Assigning permissions Developer Guide To provide access, add permissions to your users, groups, or roles: • Users and groups
textract-dg-007	textract-dg.pdf	7	For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. • Amazon Elastic Container Service — Use the Container credentials provider. Amazon ECS sends and refreshes credentials to a metadata endpoint. A task IAM role that you specify provides a strategy for managing the credentials that your application uses. For more information, see Interact with AWS services. For more information about credential providers, see Standardized credential providers. Granting Programmatic Access 11 Amazon Textract Assigning permissions Developer Guide To provide access, add permissions to your users, groups, or roles: • Users and groups in AWS IAM Identity Center: Create a permission set. Follow the instructions in Create a permission set in the AWS IAM Identity Center User Guide. • Users managed in IAM through an identity provider: Create a role for identity federation. Follow the instructions in Create a role for a third-party identity provider (federation) in the IAM User Guide. • IAM users: • Create a role that your user can assume. Follow the instructions in Create a role for an IAM user in the IAM User Guide. • (Not recommended) Attach a policy directly to a user or add a user to a user group. Follow the instructions in Adding permissions to a user (console) in the IAM User Guide. Next Step Step 3: Get Started Using the AWS CLI and AWS SDK API Step 3: Get Started Using the AWS CLI and AWS SDK API After you've set up the AWS CLI and AWS SDKs that you want to use, you can build applications that use Amazon Textract. The following topics show you how to get started with Amazon Textract. • Analyzing Document Text with Amazon Textract Formatting the AWS CLI Examples The AWS CLI examples in this guide are formatted for the Linux operating system. To use the samples with Microsoft Windows, you need to change the JSON formatting of the --document parameter, and change the line breaks from backslashes (\) to carets (^). For more information about JSON formatting, see Specifying Parameter Values for the AWS Command Line Interface. Next Step 12 Amazon Textract Developer Guide Identifying Your Amazon Textract Use Case Amazon Textract oﬀers a variety of operations that apply to diﬀerent documents. Below is a list of the operations you can perform with Amazon Textract and links to further information on each use case. • Detecting text only. For more information, see Detecting Text. • Detecting and analyzing relationships between text. For more information, see Analyzing Documents. • Detecting and analyzing text in invoices and receipts. For more information, see Analyzing Invoices and Receipts. • Detecting and analyzing text in government identity documents. For more information, see Analyzing Identity Documents. • Detecting and analyzing text in lending documents. For more information, see Analyzing Lending Documents. Amazon Textract provides you with synchronous operations for processing single-page documents with near real-time responses. For more information, see Processing Documents Synchronously. Amazon Textract also provides asynchronous operations that you can use to process larger, multipage documents. Asynchronous responses aren't in real time. For more information, see Processing Documents Asynchronously. Amazon Textract provides you with a workﬂow to automatically classify lending document pages and route them to existing solutions. For more information see Analyzing Lending Documents. Amazon Textract lets you customize the output of its pretrained Queries feature. With Amazon Textract Custom Queries, you can use your own documents and train an adapter to customize the base model, keeping complete control over your proprietary documents. See Customizing your Queries Responses for more information. For information regarding the results returned by Analyze Lending, see Analyze Lending Response Objects . Topics • Detecting Text • Analyzing Documents 13 Amazon Textract Developer Guide • Analyzing Invoices and Receipts • Analyzing Identity Documents • Analyzing Lending Documents • Customizing Outputs Detecting Text Amazon Textract provides synchronous and asynchronous operations that return only the text detected in a document. For both sets of operations, the following information is returned in multiple the section called “Block” objects: • The lines and words of detected text • The relationships between the lines and words of detected text • The page that the detected text appears on • The location of the lines and words of text on the document page For more information, see the section called “Lines and Words of Text”. To detect text synchronously, use the DetectDocumentText API operation, and pass a document ﬁle as input. The entire set of results is returned by the operation. For more information and an example, see Processing Documents Synchronously. Note The Amazon Rekognition API operation DetectText is diﬀerent from DetectDocumentText. You use DetectText to detect text in live scenes, such as posters or road signs. To detect text asynchronously, use StartDocumentTextDetection to start processing an input document ﬁle. To
textract-dg-008	textract-dg.pdf	8	location of the lines and words of text on the document page For more information, see the section called “Lines and Words of Text”. To detect text synchronously, use the DetectDocumentText API operation, and pass a document ﬁle as input. The entire set of results is returned by the operation. For more information and an example, see Processing Documents Synchronously. Note The Amazon Rekognition API operation DetectText is diﬀerent from DetectDocumentText. You use DetectText to detect text in live scenes, such as posters or road signs. To detect text asynchronously, use StartDocumentTextDetection to start processing an input document ﬁle. To get the results, call GetDocumentTextDetection. The results are returned in one or more responses from GetDocumentTextDetection. For more information and an example, see Processing Documents Asynchronously. Detecting Text 14 Amazon Textract Developer Guide Analyzing Documents Amazon Textract analyzes documents and forms for relationships among detected text. Amazon Textract analysis operations return 5 categories of document extraction — text, forms, tables, query responses, and signatures. The analysis of invoices and receipts is handled through a diﬀerent process, for more information see Analyzing Invoices and Receipts. Text Extraction The raw text extracted from a document. For more information, see Lines and words of text. Form Extraction Form data is linked to text items extracted from a document. Amazon Textract represents form data as key-value pairs. In the following example, one of the lines of text detected by Amazon Textract is Name: Jane Doe. Amazon Textract also identiﬁes a key (Name:) and a value (Jane Doe). For more information, see Form data (Key-value pairs). Name: Jane Doe Address: 123 Any Street, Anytown, USA Birth date: 12-26-1980 Key-value pairs are also used to represent check boxes or option buttons (radio buttons) that are extracted from forms. Male: ☑ For more information, see Selection elements. Table Extraction Amazon Textract can extract tables, table cells, the items within table cells, table titles and footers, and the type of table. Amazon Textract can also be programmed to return the results in a JSON, CSV, or TXT ﬁle. Name Ana Carolina Analyzing Documents Address 123 Any Town 15 Amazon Textract Developer Guide For more information, see Tables. Selection elements can also be extracted from tables. For more information, see Selection elements. Signatures in Document Analysis Amazon Textract can detect the locations of signatures in text documents. These are returned as geometry objects with bounding boxes that provide the location of a signature on the page, alongside the conﬁdence that a signature is in that location. If the signature feature is used by itself, Amazon Textract will return both signatures and standard text detection results. Signature detection can be used in conjunction with other feature types such as forms, tables, and queries. When using it with forms and tables, signatures can be detected as part of a key-value pair or within a table cell respectively. Queries in Document Analysis When processing a document with Amazon Textract, you may add queries to your analysis to specify what information you need. This involves passing a question, such as "What is the customer's social security number?" to Amazon Textract. Amazon Textract will then ﬁnd the information in the document for that question and return it in a response structure separate from the rest of the document's information. For more information about this response structure, see Query Response Structures. For more information on best practices for query use, see Best Practices for Queries. Queries can be processed alone, or in combination with any other FeatureType, such as Tables or Forms. Example Query: What is the customer’s SSN? Example Answer: 111-xx-333 For analyzed items, Amazon Textract returns the following in multiple the section called “Block” objects: • The lines and words of detected text • The content of detected items • The relationship between detected items • The page that the item was detected on • The location of the item on the document page Custom Queries Analyzing Documents 16 Amazon Textract Developer Guide With Amazon Textract document analysis, you can customize the model output through adapters trained on your own documents. Adapters are components that plug in to the Amazon Textract pre-trained deep learning model, customizing its output for your business speciﬁc documents. You create an adapter for your speciﬁc use case by annotating/labeling your sample documents and training the adapter on the annotated samples. After you create an adapter, Amazon Textract provides you with an AdapterId. You can have multiple adapter versions within a single adapter. You can provide the AdapterId, along with an AdapterVersion, to an operation to specify that you want to use the adapter that you created. For example, you provide the two parameters to the AnalyzeDocument API for synchronous document analysis, or the StartDocumentAnalysis operation for asynchronous analysis. Providing the AdapterId as part of the request will automatically
textract-dg-009	textract-dg.pdf	9	You create an adapter for your speciﬁc use case by annotating/labeling your sample documents and training the adapter on the annotated samples. After you create an adapter, Amazon Textract provides you with an AdapterId. You can have multiple adapter versions within a single adapter. You can provide the AdapterId, along with an AdapterVersion, to an operation to specify that you want to use the adapter that you created. For example, you provide the two parameters to the AnalyzeDocument API for synchronous document analysis, or the StartDocumentAnalysis operation for asynchronous analysis. Providing the AdapterId as part of the request will automatically integrate the adapter into the analysis process and use it to enhance predictions for your documents. This way, you can leverage the capabilities of AnalyzeDocument while customizing the model to ﬁt your own use case. For more information on creating and using adapters, see Customizing your Queries Responses. For a tutorial on how to create, train, and use adapters with the AWS Management Console, see Custom Queries tutorial. Layout in Document Analysis Amazon Textract can be used to detect the layout of a document by ﬁnding the locations of diﬀerent elements and their associated lines of text. These elements are paragraphs, lists, headers, footers, page numbers, ﬁgures, tables, titles, and section headers. When analyzing the layout of a document, Amazon Textract returns a bounding box location of the layout elements as well as the text in those elements. This information is returned in the implied reading order of the document, listing elements from top to bottom, left to right. You can use synchronous or asynchronous operations to analyze text in a document. To analyze text synchronously, use the AnalyzeDocument operation, and pass a document as input. AnalyzeDocument returns the entire set of results. For more information, see Analyzing Document Text with Amazon Textract. To detect text asynchronously, use StartDocumentAnalysis to start processing. To get the results, call GetDocumentAnalysis. The results are returned in one or more responses from GetDocumentAnalysis. For more information and an example, see Detecting or Analyzing Text in a Multipage Document. To specify which type of analysis to perform, you can use the FeatureTypes list input parameter. Add TABLES to the list to return information about the tables that are detected in the input Analyzing Documents 17 Amazon Textract Developer Guide document—for example, table cells, cell text, and selection elements in cells. Add FORMS to return word relationships, such as key-value pairs and selection elements. Add QUERIES to specify information you want Amazon Textract to look for in the document and get a response back in the form of a question-answer pair. Add LAYOUT to determine the layout of the document. To perform all types of analysis, add TABLES, FORMS, QUERIES, and LAYOUT to FeatureTypes. All lines and words that are detected in the document are included in the response (including text not related to the value of FeatureTypes). Analyzing Invoices and Receipts Amazon Textract extracts relevant data such as vendor and receiver contact information, from almost any invoice or receipt without the need for any templates or conﬁguration. Invoices and receipts often use various layouts, making it diﬃcult and time-consuming to manually extract data at scale. Amazon Textract uses ML to understand the context of invoices and receipts. It automatically extracts data such as invoice or receipt date, invoice or receipt number, item prices, total amount, and payment terms. Amazon Textract also identiﬁes vendor names that are critical for your workﬂows but may not be explicitly labeled. For example, Amazon Textract can ﬁnd the vendor name on a receipt even if it's only indicated within a logo at the top of the page without an explicit key-value pair combination. Amazon Textract also makes it easy for you to consolidate input from diverse receipts and invoices that use diﬀerent words for the same concept. For example, Amazon Textract maps relationships between ﬁeld names in diﬀerent documents such as bill number, invoice number, receipt number, outputting standard taxonomy as INVOICE_RECEIPT_ID. In this case, Amazon Textract represents data consistently across diﬀerent document types. The address ﬁelds are categorized as 'receiver', 'supplier', 'vendor', 'bill to', 'ship to', and 'remit to'. When expense documents do not have unique values for each of these categories, Amazon Textract will return only the categories with unique values. Fields that do not align with the standard taxonomy are categorized as OTHER. Following is a list of standard ﬁelds supported by expense analysis operations. List of Expense Analysis Standard Fields • Invoice Receipt Date — INVOICE_RECEIPT_DATE Analyzing Invoices and Receipts 18 Amazon Textract Developer Guide • Invoice Receipt ID — INVOICE_RECEIPT_ID • Invoice Tax Payer ID — TAX_PAYER_ID • Customer Number — CUSTOMER_NUMBER • Account Number — ACCOUNT_NUMBER • Vendor Name — VENDOR_NAME • Receiver Name — RECEIVER_NAME • Vendor Address — VENDOR_ADDRESS • Receiver Address
textract-dg-010	textract-dg.pdf	10	of these categories, Amazon Textract will return only the categories with unique values. Fields that do not align with the standard taxonomy are categorized as OTHER. Following is a list of standard ﬁelds supported by expense analysis operations. List of Expense Analysis Standard Fields • Invoice Receipt Date — INVOICE_RECEIPT_DATE Analyzing Invoices and Receipts 18 Amazon Textract Developer Guide • Invoice Receipt ID — INVOICE_RECEIPT_ID • Invoice Tax Payer ID — TAX_PAYER_ID • Customer Number — CUSTOMER_NUMBER • Account Number — ACCOUNT_NUMBER • Vendor Name — VENDOR_NAME • Receiver Name — RECEIVER_NAME • Vendor Address — VENDOR_ADDRESS • Receiver Address — RECEIVER_ADDRESS • Order Date — ORDER_DATE • Due Date — DUE_DATE • Delivery Date — DELIVERY_DATE • PO Number — PO_NUMBER • Payment Terms — PAYMENT_TERMS • Total — TOTAL • Amount Due — AMOUNT_DUE • Amount Paid — AMOUNT_PAID • Subtotal — SUBTOTAL • Tax — TAX • Service Charge — SERVICE_CHARGE • Gratuity — GRATUITY • Prior Balance — PRIOR_BALANCE • Discount — DISCOUNT • Shipping and Handling Charge — SHIPPING_HANDLING_CHARGE • Vendor ABN Number — VENDOR_ABN_NUMBER • Vendor GST Number — VENDOR_GST_NUMBER • Vendor PAN Number — VENDOR_PAN_NUMBER • Vendor VAT Number — VENDOR_VAT_NUMBER • Receiver ABN Number — RECEIVER_ABN_NUMBER Analyzing Invoices and Receipts 19 Amazon Textract Developer Guide • Receiver GST Number — RECEIVER_GST_NUMBER • Receiver PAN Number — RECEIVER_PAN_NUMBER • Receiver VAT Number — RECEIVER_VAT_NUMBER • Vendor Phone — VENDOR_PHONE • Receiver Phone — RECEIVER_PHONE • Vendor URL — VENDOR_URL • Line Item/Item Description — ITEM • Line Item/Quantity — QUANTITY • Line Item/Total Price — PRICE • Line Item/Unit Price — UNIT_PRICE • Line Item/ProductCode — PRODUCT_CODE • Address (Bill To, Ship To, Remit To, Supplier) — ADDRESS • Name (Bill To, Ship To, Remit To, Supplier) — NAME • Core Address (Vendor, Receiver, Bill To, Ship To, Remit To, Supplier) — ADDRESS_BLOCK • Street Address (Vendor, Receiver, Bill To, Ship To, Remit To, Supplier) — STREET • City (Vendor, Receiver, Bill To, Ship To, Remit To, Supplier) — CITY • State (Vendor, Receiver, Bill To, Ship To, Remit To, Supplier) — STATE • Country (Vendor, Receiver, Bill To, Ship To, Remit To, Supplier) — COUNTRY • ZIP Code (Vendor, Receiver, Bill To, Ship To, Remit To, Supplier) — ZIP_CODE The AnalyzeExpense API returns the following elements for a given document page: • The number of receipts or invoices within a document represented as ExpenseIndex • The standardized name for individual ﬁelds represented as Type • The actual name of the ﬁeld as it appears on the document, represented as LabelDetection • The value of the corresponding ﬁeld represented as ValueDetection • The number of pages within the submitted document represented as Pages • The page number on which the ﬁeld, value, or line items are detected, represented as PageNumber Analyzing Invoices and Receipts 20 Amazon Textract Developer Guide • The geometry, which includes the bounding box and coordinates location of the individual ﬁeld, value, or line items on the page, represented as Geometry • The conﬁdence score associated with each piece of data detected on the document, represented as Confidence • The entire row of individual line items purchased, represented as EXPENSE_ROW The following is a portion of the API output for a receipt processed by AnalyzeExpense that shows the Total: $55.64 in the document extracted as standard ﬁeld TOTAL. Actual text on the document appears as “Total,” Conﬁdence Score as “97.1,” Page Number as “1,” and the total value as “$55.64.” This also includes the bounding box and polygon coordinates: { "Type": { "Text": "TOTAL", "Confidence": 99.94717407226562 }, "LabelDetection": { "Text": "Total:", "Geometry": { "BoundingBox": { "Width": 0.09809663146734238, "Height": 0.0234375, "Left": 0.36822840571403503, "Top": 0.8017578125 }, "Polygon": [ { "X": 0.36822840571403503, "Y": 0.8017578125 }, { "X": 0.466325044631958, "Y": 0.8017578125 }, { "X": 0.466325044631958, "Y": 0.8251953125 }, { "X": 0.36822840571403503, "Y": 0.8251953125 Analyzing Invoices and Receipts 21 Developer Guide Amazon Textract } ] }, "Confidence": 97.10792541503906 }, "ValueDetection": { "Text": "$55.64", "Currency": { "Code": USD } "Geometry": { "BoundingBox": { "Width": 0.10395314544439316, "Height": 0.0244140625, "Left": 0.66837477684021, "Top": 0.802734375 }, "Polygon": [ { "X": 0.66837477684021, "Y": 0.802734375 }, { "X": 0.7723279595375061, "Y": 0.802734375 }, { "X": 0.7723279595375061, "Y": 0.8271484375 }, { "X": 0.66837477684021, "Y": 0.8271484375 } ] }, "Confidence": 99.85165405273438 }, "PageNumber": 1 } You can use synchronous operations to analyze an invoice or receipt. To analyze these documents, you use the AnalyzeExpense operation and pass a receipt or invoice to it. AnalyzeExpense returns Analyzing Invoices and Receipts 22 Amazon Textract Developer Guide the entire set of results. For more information, see Analyzing Invoices and Receipts with Amazon Textract. To analyze invoices and receipts asynchronously, use StartExpenseAnalysis to start processing an input document ﬁle. To get the results, call GetExpenseAnalysis. The results for a given call to StartExpenseAnalysis are returned by GetExpenseAnalysis. For more
textract-dg-011	textract-dg.pdf	11	0.8271484375 } ] }, "Confidence": 99.85165405273438 }, "PageNumber": 1 } You can use synchronous operations to analyze an invoice or receipt. To analyze these documents, you use the AnalyzeExpense operation and pass a receipt or invoice to it. AnalyzeExpense returns Analyzing Invoices and Receipts 22 Amazon Textract Developer Guide the entire set of results. For more information, see Analyzing Invoices and Receipts with Amazon Textract. To analyze invoices and receipts asynchronously, use StartExpenseAnalysis to start processing an input document ﬁle. To get the results, call GetExpenseAnalysis. The results for a given call to StartExpenseAnalysis are returned by GetExpenseAnalysis. For more information and an example, see Processing Documents Asynchronously. Analyzing Identity Documents Amazon Textract can extract relevant information from passports, driver licenses, and other identity documentation issued by the US Government using the AnalyzeID API. With Analyze ID, businesses can quickly, and accurately extract information from IDs such as US driver licenses, and passports that have diﬀerent template or format. AnalyzeID API returns three categories of data types: • Key-value pairs available on ID such as Date of Birth, Date of Issue, ID #, Class, and Restrictions. • Implied ﬁelds on the document that may not have explicit keys associated with them such as Name, Address, and Issued By. • The text of the document, the same as would be returned by document text detection. Key names are standardized within the response. For example, if your driver license says LIC# (license number) and passport says Passport No, Analyze ID response will return the standardized key as “Document ID” along with the raw key (such as LIC#). This standardization lets customers combine information across many IDs that use diﬀerent terms for the same concept. Analyzing Identity Documents 23 Amazon Textract Developer Guide Analyze ID returns information in the structures called IdentityDocumentFields. These are JSON structures containing two pieces of information: the normalized Type and the Value associated with the Type. These both also have a conﬁdence score. For more information, see Identity Documentation Response Objects. For more information regarding the text detection returned by Analyze ID, see Text Detection and Document Analysis Response Objects You can use synchronous operations to analyze a driver's license or passport. To analyze these documents, you use the AnalyzeID operation and pass an identity document to it. AnalyzeID returns the entire set of results. For more information, see Analyzing Identity Documentation with Amazon Textract. Note Some identity documents, such as driver's licenses, have two sides. You can pass the front and back images of driver licenses as separate images within the same Analyze ID API request. Analyzing Identity Documents 24 Amazon Textract Developer Guide Analyzing Lending Documents Analyze Lending is a document processing API for mortgage documents. With Analyze Lending, you can automatically extract, classify, and validate information in mortgage-related documents. Analyze Lending receives a loan document and then splits it into pages, classifying them according to the type of document. The document pages are then automatically routed to Amazon Textract text processing operations for accurate data extraction and analysis. StartLendingAnalysis initiates the classiﬁcation and analysis of a packet of lending documents. StartLendingAnalysis operates on a document ﬁle located in an Amazon S3 bucket. After processing, you can retrieve the results by using GetLendingAnalysis while a summary can be retrieved with GetLendingAnalysisSummary. Note that Analyze Lending document analysis is for asynchronous processing only. For a sample of the output for the GetLendingAnalysis operation, see the following. The return includes information about the document classiﬁcation type for a page, the page number, and the ﬁelds extracted by Analyze Lending: { "DocumentMetadata": { "Pages": 1 }, "JobStatus": "SUCCEEDED", "Results": [ { "Page": 1, "PageClassification": { "PageType": [ { "Value": "1005", "Confidence": 99.99947357177734 } ], "PageNumber": [ { "Value": "undetected", "Confidence": 100.0 } ] }, Analyzing Lending Documents 25 Amazon Textract Developer Guide "Extractions": [ { "LendingDocument": { "LendingFields": [ { "Type": "OVERTIME_CONTINUANCE_LIKELY", "ValueDetections": [ { "Text": "Yes", "Geometry": { "BoundingBox": { "Width": 0.019448408856987953, "Height": 0.007367494981735945, "Left": 0.8211431503295898, "Top": 0.485835462808609 }, "Polygon": [ { "X": 0.8211431503295898, "Y": 0.485835462808609 }, { "X": 0.8405909538269043, "Y": 0.4858577847480774 }, { "X": 0.840591549873352, "Y": 0.49320295453071594 }, { "X": 0.8211436867713928, "Y": 0.4931805729866028 } ] }, "Confidence": 95.0 } ] }, { "Type": "CURRENT_GROSS_PAY_WEEKLY", "KeyDetection": { "Text": "Weekly", "Geometry": { Analyzing Lending Documents 26 Amazon Textract Developer Guide "BoundingBox": { "Width": 0.039741966873407364, "Height": 0.009058262221515179, "Left": 0.17564243078231812, "Top": 0.5004485845565796 }, "Polygon": [ { "X": 0.17564436793327332, "Y": 0.5004485845565796 }, { "X": 0.21538439393043518, "Y": 0.5004944205284119 }, { "X": 0.2153826206922531, "Y": 0.5095068216323853 }, { "X": 0.17564243078231812, "Y": 0.5094608664512634 } ] }, "Confidence": 99.98104858398438 }, "ValueDetections": [ { "SelectionStatus": "NOT_SELECTED", "Geometry": { "BoundingBox": { "Width": 0.010146399028599262, "Height": 0.00771764200180769, "Left": 0.1600940227508545, "Top": 0.5003445148468018 }, "Polygon": [ { "X": 0.16009573638439178, "Y": 0.5003445148468018 }, { "X": 0.17024043202400208, Analyzing Lending Documents 27 Amazon Textract Developer Guide "Y": 0.5003561973571777 }, { "X": 0.17023874819278717, "Y": 0.5080621242523193 }, {
textract-dg-012	textract-dg.pdf	12	"Weekly", "Geometry": { Analyzing Lending Documents 26 Amazon Textract Developer Guide "BoundingBox": { "Width": 0.039741966873407364, "Height": 0.009058262221515179, "Left": 0.17564243078231812, "Top": 0.5004485845565796 }, "Polygon": [ { "X": 0.17564436793327332, "Y": 0.5004485845565796 }, { "X": 0.21538439393043518, "Y": 0.5004944205284119 }, { "X": 0.2153826206922531, "Y": 0.5095068216323853 }, { "X": 0.17564243078231812, "Y": 0.5094608664512634 } ] }, "Confidence": 99.98104858398438 }, "ValueDetections": [ { "SelectionStatus": "NOT_SELECTED", "Geometry": { "BoundingBox": { "Width": 0.010146399028599262, "Height": 0.00771764200180769, "Left": 0.1600940227508545, "Top": 0.5003445148468018 }, "Polygon": [ { "X": 0.16009573638439178, "Y": 0.5003445148468018 }, { "X": 0.17024043202400208, Analyzing Lending Documents 27 Amazon Textract Developer Guide "Y": 0.5003561973571777 }, { "X": 0.17023874819278717, "Y": 0.5080621242523193 }, { "X": 0.1600940227508545, "Y": 0.5080504417419434 } ] }, "Confidence": 99.88064575195312 } ] } ], "SignatureDetections": [ { "Confidence": 98.95830535888672, "Geometry": { "BoundingBox": { "Width": 0.1505945473909378, "Height": 0.019163239747285843, "Left": 0.1145595833659172, "Top": 0.8886017799377441 }, "Polygon": [ { "X": 0.11456418037414551, "Y": 0.8886017799377441 }, { "X": 0.2651541233062744, "Y": 0.8887989521026611 }, { "X": 0.2651508152484894, "Y": 0.9077650308609009 }, { "X": 0.1145595833659172, "Y": 0.9075667262077332 } Analyzing Lending Documents 28 Amazon Textract Developer Guide ] } } ] } } ] } ], "AnalyzeLendingModelVersion": "1.0" } For a sample of the output for a GetLendingAnalysisSummary operation, see the following. The return includes information about all the documents grouped by the same document type, which are stored in DocumentGroups: { "DocumentMetadata": { "Pages": 1 }, "JobStatus": "SUCCEEDED", "Summary": { "DocumentGroups": [ { "Type": "1005", "SplitDocuments": [ { "Index": 1, "Pages": [ 1 ] } ], "DetectedSignatures": [ { "Page": 1 } ], "UndetectedSignatures": [] } ], Analyzing Lending Documents 29 Amazon Textract Developer Guide "UndetectedDocumentTypes": [ "1040_SCHEDULE_C", "1099_INT", "1099_SSA", "DEMOGRAPHIC_ADDENDUM", "1065", "1040", "1120_S", "IDENTITY_DOCUMENT", "SSA_89", "MORTGAGE_STATEMENT", "1099_MISC", "CHECKS", "HOA_STATEMENT", "INVESTMENT_STATEMENT", "1120", "1003", "VBA_26_0551", "1099_R", "PAYSLIPS", "1008", "W_2", "1099_NEC", "BANK_STATEMENT", "1040_SCHEDULE_E", "UTILITY_BILLS", "W_9", "UNCLASSIFIED", "HUD_92900_B", "PAYOFF_STATEMENT", "1099_G", "CREDIT_CARD_STATEMENT", "INVOICES", "RECEIPTS", "1040_SCHEDULE_D", "1099_DIV" ] }, "AnalyzeLendingModelVersion": "1.0" } For descriptions of the response objects, see Analyze Lending Response Objects . Analyzing Lending Documents 30 Amazon Textract Developer Guide Consult the ﬁle included with the assets folder for a list of all possible recognized classes. Customizing Outputs With Amazon Textract document analysis, you can customize the model output through adapters trained on your own documents. Adapters are components that plug in to the Amazon Textract pre-trained deep learning model, customizing its output for your business speciﬁc documents. You create an adapter for your speciﬁc use case by annotating/labeling your sample documents and training the adapter on the annotated samples. When using this process, the Adapter used is similar to the use of queries, and as such this feature is referred to as Custom Queries After you create an adapter, Amazon Textract provides you with an AdapterId. You can have multiple adapter versions within a single adapter. You can provide the AdapterId, along with an AdapterVersion, to an operation to specify that you want to use the adapter that you created. For example, you provide the two parameters to the AnalyzeDocument API for synchronous document analysis, or the StartDocumentAnalysis operation for asynchronous analysis. Providing the AdapterId as part of the request will automatically integrate the adapter into the analysis process and use it to enhance predictions for your documents. This way, you can leverage the capabilities of AnalyzeDocument while customizing the model to ﬁt your own use case. For more information on creating and using adapters, see Customizing your Queries Responses. For a tutorial on how to create, train, and use adapters with the AWS Management Console, see Custom Queries tutorial. Customizing Outputs 31 Amazon Textract Developer Guide Interpreting Amazon Textract Responses Amazon Textract operations return diﬀerent types of objects depending on the operations run. Response objects are structured JSON outputs, with various elements that can be searched for within a response. For more information about these response objects, see the following sections: Topics • Locating Items on a Document Page • Text Detection and Document Analysis Response Objects • Layout Response Objects • Invoice and Receipt Response Objects • Identity Documentation Response Objects • Analyze Lending Response Objects Locating Items on a Document Page Amazon Textract operations return the location and geometry of items found on a document page. DetectDocumentText and GetDocumentTextDetection return the location and geometry for lines and words, while AnalyzeDocument and GetDocumentAnalysis return the location and geometry of key-value pairs, tables, cells, and selection elements. To determine where an item is on a document page, use the bounding box (Geometry) information returned by the Amazon Textract operation in a Block object. The Geometry object contains two types of location and geometric information for detected items: • An axis-aligned BoundingBox object that contains the top-left coordinate and the width and height of the item. • A polygon object that describes the outline of the item, speciﬁed as an array of Point objects that contain X (horizontal axis) and Y (vertical axis) document page coordinates of each point. The JSON for a
textract-dg-013	textract-dg.pdf	13	tables, cells, and selection elements. To determine where an item is on a document page, use the bounding box (Geometry) information returned by the Amazon Textract operation in a Block object. The Geometry object contains two types of location and geometric information for detected items: • An axis-aligned BoundingBox object that contains the top-left coordinate and the width and height of the item. • A polygon object that describes the outline of the item, speciﬁed as an array of Point objects that contain X (horizontal axis) and Y (vertical axis) document page coordinates of each point. The JSON for a Block object looks similar to the following. Note the BoundingBox and Polygon ﬁelds. { "Geometry": { Locating Items on a Document Page 32 Amazon Textract Developer Guide "BoundingBox": { "Width": 0.053907789289951324, "Top": 0.08913730084896088, "Left": 0.11085548996925354, "Height": 0.013171200640499592 }, "Polygon": [ { "Y": 0.08985357731580734, "X": 0.11085548996925354 }, { "Y": 0.08913730084896088, "X": 0.16447919607162476 }, { "Y": 0.10159222036600113, "X": 0.16476328670978546 }, { "Y": 0.10230850428342819, "X": 0.11113958805799484 } ] }, "Text": "Name:", "TextType": "PRINTED", "BlockType": "WORD", "Confidence": 99.56285858154297, "Id": "c734fca6-c4c4-415c-b6c1-30f7510b72ee" }, You can use geometry information to draw bounding boxes around detected items. For an example that uses BoundingBox and Polygon information to draw boxes around lines and vertical lines at the start and end of each word, see Detecting Document Text with Amazon Textract. The example output is similar to the following. Locating Items on a Document Page 33 Amazon Textract Bounding Box Developer Guide A bounding box (BoundingBox) has the following properties: • Height – The height of the bounding box as a ratio of the overall document page height. • Left – The X coordinate of the top-left point of the bounding box as a ratio of the overall document page width. • Top – The Y coordinate of the top-left point of the bounding box as a ratio of the overall document page height. • Width – The width of the bounding box as a ratio of the overall document page width. Each BoundingBox property has a value between 0 and 1. The value is a ratio of the overall image width (applies to Left and Width) or height (applies to Height and Top). For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is (350,50) pixels, the API returns a Left value of 0.5 (350/700) and a Top value of 0.25 (50/200). The following diagram shows the range of a document page that each BoundingBox property covers. To display the bounding box with the correct location and size, you multiply the BoundingBox values by the document page width or height (depending on the value you want) to get the pixel values. You use the pixel values to display the bounding box. An example is using a document page of 608 pixels width x 588 pixels height, and the following bounding box values for analyzed text: BoundingBox.Left: 0.3922065 BoundingBox.Top: 0.15567766 BoundingBox.Width: 0.284666 BoundingBox.Height: 0.2930403 The location of the text bounding box in pixels is calculated as follows: Left coordinate = BoundingBox.Left (0.3922065) * document page width (608) = 238 Top coordinate = BoundingBox.Top (0.15567766) * document page height (588) = 91 Bounding Box 34 Amazon Textract Developer Guide Bounding box width = BoundingBox.Width (0.284666) * document page width (608) = 173 Bounding box height = BoundingBox.Height (0.2930403) * document page height (588) = 172 You use these values to display a bounding box around the analyzed text. The following Java and Python examples demonstrate how to display a bounding box. Java public void ShowBoundingBox(int imageHeight, int imageWidth, BoundingBox box, Graphics2D g2d) { float left = imageWidth * box.getLeft(); float top = imageHeight * box.getTop(); // Display bounding box. g2d.setColor(new Color(0, 212, 0)); g2d.drawRect(Math.round(left / scale), Math.round(top / scale), Math.round((imageWidth * box.getWidth()) / scale), Math.round((imageHeight * box.getHeight())) / scale); } Python This Python example takes in the response returned by the DetectDocumentText API operation. def process_text_detection(response): # Get the text blocks blocks = response['Blocks'] width, height = image.size draw = ImageDraw.Draw(image) print('Detected Document Text') # Create image showing bounding box/polygon the detected lines/text for block in blocks: Bounding Box 35 Amazon Textract Developer Guide draw = ImageDraw.Draw(image) if block['BlockType'] == "LINE": box=block['Geometry']['BoundingBox'] left = width * box['Left'] top = height * box['Top'] draw.rectangle([left,top, left + (width * box['Width']), top +(height * box['Height'])],outline='black') # Display the image image.show() return len(blocks) Polygon The polygon returned by AnalyzeDocument is an array of Point objects. Each Point has an X and Y coordinate for a speciﬁc location on the document page. Like the BoundingBox coordinates, the polygon coordinates are normalized to the document width and height, and are between 0 and 1. You can use points in the polygon array to display a ﬁner-grain bounding box around a Block object. You calculate the position of each
textract-dg-014	textract-dg.pdf	14	left = width * box['Left'] top = height * box['Top'] draw.rectangle([left,top, left + (width * box['Width']), top +(height * box['Height'])],outline='black') # Display the image image.show() return len(blocks) Polygon The polygon returned by AnalyzeDocument is an array of Point objects. Each Point has an X and Y coordinate for a speciﬁc location on the document page. Like the BoundingBox coordinates, the polygon coordinates are normalized to the document width and height, and are between 0 and 1. You can use points in the polygon array to display a ﬁner-grain bounding box around a Block object. You calculate the position of each polygon point on the document page by using the same technique used for BoundingBoxes. Multiply the X coordinate by the document page width, and multiply the Y coordinate by the document page height. The following example shows how to display the vertical lines of a polygon. public void ShowPolygonVerticals(int imageHeight, int imageWidth, List <Point> points, Graphics2D g2d) { g2d.setColor(new Color(0, 212, 0)); Object[] parry = points.toArray(); g2d.setStroke(new BasicStroke(2)); g2d.drawLine(Math.round(((Point) parry[0]).getX() * imageWidth), Math.round(((Point) parry[0]).getY() * imageHeight), Math.round(((Point) parry[3]).getX() * imageWidth), Math.round(((Point) parry[3]).getY() * imageHeight)); g2d.setColor(new Color(255, 0, 0)); g2d.drawLine(Math.round(((Point) parry[1]).getX() * imageWidth), Polygon 36 Amazon Textract Developer Guide Math.round(((Point) parry[1]).getY() * imageHeight), Math.round(((Point) parry[2]).getX() * imageWidth), Math.round(((Point) parry[2]).getY() * imageHeight)); } Text Detection and Document Analysis Response Objects When Amazon Textract processes a document, it creates a list of Block objects for the detected or analyzed text. Each block contains information about a detected item, where it's located, and the conﬁdence that Amazon Textract has in the accuracy of the processing. A document is made up from the following types of Block objects. • Pages • Lines and words of text • Form Data (Key-value pairs) • Tables and Cells • Selection elements • Queries • Layout The contents of a block depend on the operation you call. If you call one of the text detection operations, the pages, lines, and words of detected text are returned. For more information, see Detecting Text. If you call one of the document analysis operations, information about detected pages, key-value pairs, tables, selection elements, and text is returned. For more information, see Analyzing Documents. Some Block object ﬁelds are common to both types of processing. For example, each block has a unique identiﬁer. For examples that show how to use Block objects, see Tutorials. Document Layout Amazon Textract returns a representation of a document as a list of diﬀerent types of Block objects that are linked in a parent-to-child relationship or a key-value pair. Metadata that provides Text Detection and Document Analysis Response Objects 37 Amazon Textract Developer Guide the number of pages in a document is also returned. The following is the JSON for a typical Block object of type PAGE. { "Blocks": [ { "Geometry": { "BoundingBox": { "Width": 1.0, "Top": 0.0, "Left": 0.0, "Height": 1.0 }, "Polygon": [ { "Y": 0.0, "X": 0.0 }, { "Y": 0.0, "X": 1.0 }, { "Y": 1.0, "X": 1.0 }, { "Y": 1.0, "X": 0.0 } ] }, "Relationships": [ { "Type": "CHILD", "Ids": [ "2602b0a6-20e3-4e6e-9e46-3be57fd0844b", "82aedd57-187f-43dd-9eb1-4f312ca30042", "52be1777-53f7-42f6-a7cf-6d09bdc15a30", "7ca7caa6-00ef-4cda-b1aa-5571dfed1a7c" ] } ], Document Layout 38 Amazon Textract Developer Guide "BlockType": "PAGE", "Id": "8136b2dc-37c1-4300-a9da-6ed8b276ea97" }..... ], "DocumentMetadata": { "Pages": 1 } } A document is made from one or more PAGE blocks. Each page contains a list of child blocks for the primary items detected on the page, such as lines of text and tables. For more information, see Pages. You can determine the type of a Block object by inspecting the BlockType ﬁeld. A Block object contains a list of related Block objects in the Relationships ﬁeld, which is an array of Relationship objects. A Relationships array is either of type CHILD or of type VALUE. An array of type CHILD is used to list the items that are children of the current block. For example, if the current block is of type LINE, Relationships contains a list of IDs for the WORD blocks that make up the line of text. An array of type VALUE is used to contain key-value pairs. You can determine the type of the relationship by inspecting the Type ﬁeld of the Relationship object. Child blocks don't have information about their parent Block objects. For examples that show Block information, see Processing Documents Synchronously. Conﬁdence Amazon Textract operations return the percentage conﬁdence that Amazon Textract has in the accuracy of the detected item. To get the conﬁdence, use the Confidence ﬁeld of the Block object. A higher value indicates a higher conﬁdence. Depending on the scenario, detections with a low conﬁdence might need visual conﬁrmation by a human. Geometry Amazon Textract operations (except for identity analysis) return location information about the location of detected items on a document page. To get the location, use the Geometry ﬁeld of the
textract-dg-015	textract-dg.pdf	15	about their parent Block objects. For examples that show Block information, see Processing Documents Synchronously. Conﬁdence Amazon Textract operations return the percentage conﬁdence that Amazon Textract has in the accuracy of the detected item. To get the conﬁdence, use the Confidence ﬁeld of the Block object. A higher value indicates a higher conﬁdence. Depending on the scenario, detections with a low conﬁdence might need visual conﬁrmation by a human. Geometry Amazon Textract operations (except for identity analysis) return location information about the location of detected items on a document page. To get the location, use the Geometry ﬁeld of the Block object. For more information, see Locating Items on a Document Page. Conﬁdence 39 Amazon Textract Pages Developer Guide A document consists of one or more pages. A the section called “Block” object of type PAGE exists for each page of the document. A PAGE block object contains a list of the child IDs for the lines of text, key-value pairs, tables, Queries, and Query Results that are detected on the document page. The JSON for a PAGE block looks similar to the following. { "Geometry": .... "Relationships": [ { "Type": "CHILD", "Ids": [ "2602b0a6-20e3-4e6e-9e46-3be57fd0844b", // Line - Hello, world. "82aedd57-187f-43dd-9eb1-4f312ca30042", // Line - How are you? "52be1777-53f7-42f6-a7cf-6d09bdc15a30", "7ca7caa6-00ef-4cda-b1aa-5571dfed1a7c" ] } ], "BlockType": "PAGE", "Id": "8136b2dc-37c1-4300-a9da-6ed8b276ea97" // Page identifier }, If you're using asynchronous operations with a multipage document that's in PDF format, you can determine the page that a block is located on by inspecting the Page ﬁeld of the Block object. A scanned image (an image in JPEG, PNG, PDF, or TIFF format) is considered to be a single-page Pages 40 Amazon Textract Developer Guide document, even if there's more than one document page on the image. Asynchronous operations always return a Page value of 1 for scanned images. The total number of pages is returned in the Pages ﬁeld of DocumentMetadata. DocumentMetadata is returned with each list of Block objects returned by an Amazon Textract operation. Lines and Words of Text Detected text that's returned by Amazon Textract operations is returned in a list of the section called “Block” objects. These objects represent lines of text or textual words that are detected on a document page. The following text shows two lines of text that are made from multiple words. This is text. In two separate lines. Detected text is returned in the Text ﬁeld of a Block object. The BlockType ﬁeld determines if the text is a line of text (LINE) or a word (WORD). A WORD is one or more ISO basic Latin script characters that aren't separated by spaces. A LINE is a string of tab-delimited and contiguous words. Additionally, Amazon Textract will determine if a piece of text was handwritten or printed using the TextTypes ﬁeld. These return as HANDWRITING and PRINTED respectively. The other Block properties are common to all block types, such as the ID, conﬁdence, and geometry information. For more information, see the section called “Text Detection and Document Analysis Response Objects”. To detect only lines and words, you can use DetectDocumentText or StartDocumentTextDetection. For more information, see Detecting Text. To get the detected text (lines and words) and information about how it relates to other parts of the document, such as tables, you can use AnalyzeDocument or StartDocumentAnalysis. For more information, see Analyzing Documents. PAGE, LINE, and WORD blocks are related to each other in a parent-to-child relationship. A PAGE block is the parent for all LINE block objects on a document page. Because a LINE can have one or more words, the Relationships array for a LINE block stores the IDs for child WORD blocks that make up the line of text. The following diagram shows how the line Hello, world. in the text Hello, world. How are you? is represented by Block objects. Lines and Words of Text 41 Amazon Textract Developer Guide The following is the JSON output from DetectDocumentText when the sentence Hello, world. How are you? is detected. The ﬁrst example is the JSON for the document page. You can use the CHILD IDs to navigate through the document. { "Geometry": {...}, "Relationships": [ { "Type": "CHILD", "Ids": [ "d7fbd604-d609-4d69-857d-247a3f591238", // Line - Hello, world. "b6c19a93-6493-4d8e-958f-853c8f7ca055" // Line - How are you? ] } ], "BlockType": "PAGE", "Id": "56ec1d77-171f-4881-9852-2b5b7e761608" }, The following is the JSON for the LINE blocks that make up the line "Hello, World": { "Relationships": [ { "Type": "CHILD", "Ids": [ "7f97e2ca-063e-47a8-981c-8beee31afc01", // Word - Hello, Lines and Words of Text 42 Amazon Textract Developer Guide "4b990aa0-af96-4369-b90f-dbe02538ed21" // Word - world. ] } ], "Confidence": 99.63229370117188, "Geometry": {...}, "Text": "Hello, world.", "BlockType": "LINE", "Id": "d7fbd604-d609-4d69-857d-247a3f591238" }, The following is the JSON for the WORD block for the word Hello,: { "Geometry": {...}, "Text": "Hello,", "TextType": "PRINTED", "BlockType": "WORD", "Confidence": 99.74746704101562, "Id":
textract-dg-016	textract-dg.pdf	16	world. "b6c19a93-6493-4d8e-958f-853c8f7ca055" // Line - How are you? ] } ], "BlockType": "PAGE", "Id": "56ec1d77-171f-4881-9852-2b5b7e761608" }, The following is the JSON for the LINE blocks that make up the line "Hello, World": { "Relationships": [ { "Type": "CHILD", "Ids": [ "7f97e2ca-063e-47a8-981c-8beee31afc01", // Word - Hello, Lines and Words of Text 42 Amazon Textract Developer Guide "4b990aa0-af96-4369-b90f-dbe02538ed21" // Word - world. ] } ], "Confidence": 99.63229370117188, "Geometry": {...}, "Text": "Hello, world.", "BlockType": "LINE", "Id": "d7fbd604-d609-4d69-857d-247a3f591238" }, The following is the JSON for the WORD block for the word Hello,: { "Geometry": {...}, "Text": "Hello,", "TextType": "PRINTED", "BlockType": "WORD", "Confidence": 99.74746704101562, "Id": "7f97e2ca-063e-47a8-981c-8beee31afc01" }, The ﬁnal JSON is the WORD block for the word world.: { "Geometry": {...}, "Text": "world.", "TextType": "PRINTED", "BlockType": "WORD", "Confidence": 99.5171127319336, "Id": "4b990aa0-af96-4369-b90f-dbe02538ed21" }, Form Data (Key-Value Pairs) Amazon Textract can extract form data from documents as key-value pairs. For example, in the following text, Amazon Textract can identify a key (Name:) and a value (Ana Carolina). Name: Ana Carolina Detected key-value pairs are returned as Block objects in the responses from AnalyzeDocument and GetDocumentAnalysis. You can use the FeatureTypes input parameter to retrieve Form Data (Key-Value Pairs) 43 Amazon Textract Developer Guide information about key-value pairs, tables, or both. For key-value pairs only, use the value FORMS. For an example, see Extracting Key-Value Pairs from a Form Document. For general information about how a document is represented by Block objects, see Text Detection and Document Analysis Response Objects. Dates found through key-value pair detection are returned exactly as detected on the input document, with most date formats supported. Block objects with the type KEY_VALUE_SET are the containers for KEY or VALUE Block objects that store information about linked text items detected in a document. You can use the EntityType attribute to determine if a block is a KEY or a VALUE. • A KEY object contains information about the key for linked text. For example, Name:. A KEY block has two relationship lists. A relationship of type VALUE is a list that contains the ID of the VALUE block associated with the key. A relationship of type CHILD is a list of IDs for the WORD blocks that make up the text of the key. • A VALUE object contains information about the text associated with a key. In the preceding example, Ana Carolina is the value for the key Name:. A VALUE block has a relationship with a list of CHILD blocks that identify WORD blocks. Each WORD block contains one of the words that make up the text of the value. A VALUE object can also contain information about selected elements. For more information, see Selection Elements. Amazon Textract returns the same conﬁdence value for both KEY and VALUE in a KEY_VALUE_SET, as both KEY and VALUE are evaluated as a pair. It returns a diﬀerent conﬁdence value for a word in WORD blocks. Each instance of a KEY_VALUE_SET Block object is a child of the PAGE Block object that corresponds to the current page. The following diagram shows how the key-value pair Name: Ana Carolina is represented by Block objects. Form Data (Key-Value Pairs) 44 Amazon Textract Developer Guide The following examples show how the key-value pair Name: Ana Carolina is represented by JSON. The PAGE block has CHILD blocks of type KEY_VALUE_SET for each KEY and VALUE block detected in the document. { "Geometry": .... "Relationships": [ { "Type": "CHILD", "Ids": [ "2602b0a6-20e3-4e6e-9e46-3be57fd0844b", "82aedd57-187f-43dd-9eb1-4f312ca30042", "52be1777-53f7-42f6-a7cf-6d09bdc15a30", // Key - Name: "7ca7caa6-00ef-4cda-b1aa-5571dfed1a7c" // Value - Ana Caroline ] } ], "BlockType": "PAGE", "Id": "8136b2dc-37c1-4300-a9da-6ed8b276ea97" // Page identifier }, The following JSON shows that the KEY block (52be1777-53f7-42f6-a7cf-6d09bdc15a30) has a relationship with the VALUE block (7ca7caa6-00ef-4cda-b1aa-5571dfed1a7c). It also has a CHILD block for the WORD block (c734fca6-c4c4-415c-b6c1-30f7510b72ee) that contains the text for the key (Name:). { Form Data (Key-Value Pairs) 45 Amazon Textract Developer Guide "Relationships": [ { "Type": "VALUE", "Ids": [ "7ca7caa6-00ef-4cda-b1aa-5571dfed1a7c" // Value identifier ] }, { "Type": "CHILD", "Ids": [ "c734fca6-c4c4-415c-b6c1-30f7510b72ee" // Name: ] } ], "Confidence": 51.55965805053711, "Geometry": ...., "BlockType": "KEY_VALUE_SET", "EntityTypes": [ "KEY" ], "Id": "52be1777-53f7-42f6-a7cf-6d09bdc15a30" //Key identifier }, The following JSON shows that VALUE block 7ca7caa6-00ef-4cda-b1aa-5571dfed1a7c has a CHILD list of IDs for the WORD blocks that make up the text of the value (Ana and Carolina). { "Relationships": [ { "Type": "CHILD", "Ids": [ "db553509-64ef-4ecf-ad3c-bea62cc1cd8a", // Ana "e5d7646c-eaa2-413a-95ad-f4ae19f53ef3" // Carolina ] } ], "Confidence": 51.55965805053711, "Geometry": ...., "BlockType": "KEY_VALUE_SET", "EntityTypes": [ "VALUE" ], "Id": "7ca7caa6-00ef-4cda-b1aa-5571dfed1a7c" // Value identifier Form Data (Key-Value Pairs) 46 Amazon Textract } Developer Guide The following JSON shows the Block objects for the words Name:, Ana, and Carolina. { "Geometry": {...}, "Text": "Name:", "TextType": "PRINTED". "BlockType": "WORD", "Confidence": 99.56285858154297, "Id": "c734fca6-c4c4-415c-b6c1-30f7510b72ee" }, { "Geometry": {...}, "Text": "Ana", "TextType": "PRINTED", "BlockType": "WORD", "Confidence": 99.52057647705078, "Id": "db553509-64ef-4ecf-ad3c-bea62cc1cd8a" }, { "Geometry": {...}, "Text": "Carolina", "TextType": "PRINTED", "BlockType":
textract-dg-017	textract-dg.pdf	17	the text of the value (Ana and Carolina). { "Relationships": [ { "Type": "CHILD", "Ids": [ "db553509-64ef-4ecf-ad3c-bea62cc1cd8a", // Ana "e5d7646c-eaa2-413a-95ad-f4ae19f53ef3" // Carolina ] } ], "Confidence": 51.55965805053711, "Geometry": ...., "BlockType": "KEY_VALUE_SET", "EntityTypes": [ "VALUE" ], "Id": "7ca7caa6-00ef-4cda-b1aa-5571dfed1a7c" // Value identifier Form Data (Key-Value Pairs) 46 Amazon Textract } Developer Guide The following JSON shows the Block objects for the words Name:, Ana, and Carolina. { "Geometry": {...}, "Text": "Name:", "TextType": "PRINTED". "BlockType": "WORD", "Confidence": 99.56285858154297, "Id": "c734fca6-c4c4-415c-b6c1-30f7510b72ee" }, { "Geometry": {...}, "Text": "Ana", "TextType": "PRINTED", "BlockType": "WORD", "Confidence": 99.52057647705078, "Id": "db553509-64ef-4ecf-ad3c-bea62cc1cd8a" }, { "Geometry": {...}, "Text": "Carolina", "TextType": "PRINTED", "BlockType": "WORD", "Confidence": 99.84207916259766, "Id": "e5d7646c-eaa2-413a-95ad-f4ae19f53ef3" }, Tables Use Amazon Textract to extract tables in a document and extract cells, merged cells, column headers, titles, section titles, footers, table type (structured or semistructured), and summary cells within a table. Detected tables are returned as Block objects in the responses from AnalyzeDocument and GetDocumentAnalysis. You can use the FeatureTypes input parameter to retrieve information about key-value pairs, tables, or both. For tables only, use the value TABLES. For an example, see Exporting Tables into a CSV File. For general information about how a document is represented by Block objects, see Text Detection and Document Analysis Response Objects. The following is an example of a table that could be detected by Amazon Textract. Tables 47 Amazon Textract Developer Guide The following diagram shows how a single cell in a table is represented by Block objects. Tables 48 Amazon Textract Developer Guide Tables 49 Amazon Textract Developer Guide A cell contains WORD blocks for detected words, and where applicable, TABLE_TITLE blocks for table titles, TABLE_FOOTER blocks for table footers, and SELECTION_ELEMENT blocks for selection elements such as check boxes. The following is part of the JSON for the preceding table. The PAGE block object has a list of CHILD block IDs for the TABLE block and each LINE of text that's detected. { "BlockType": "PAGE", "Geometry": { "BoundingBox": { "Width": 1.0, "Height": 1.0, "Left": 0.0, "Top": 0.0 }, }, "Id": "8a5d3f57-97bc-4a05-b028-f72617877626", "Relationships": [ { "Type": "CHILD", "Ids": [ "7499ac64-3fa9-46fd-8e3f-581ec9c316eb", "87ed4709-66f2-4b3d-abda-52c92a111474", "27a87eb3-bd21-475e-80fe-3f8e16958dcf", "d89894ea-2f37-4667-94b6-d90def01c5c1", "9f9d6383-ed6d-4bd0-ba8c-71fc3eec704e", "cdc74e1a-c568-439b-9eef-7bd54e060f18", "1b64f24c-5e84-4c7e-851a-cb1f5258a53c", "84a84878-04b4-4608-81b6-38117ead1629", ... "8cef603b-932e-452b-adc4-15f8e02ad1fe", "a3f97508-0d6b-4ae0-aa04-76078f9fe11a", "dd1f23c6-dfad-447b-8105-29ba136bd3a4", "46138f38-5b77-41a9-b068-f8394587122f", "a5e5247c-2637-4fa8-a271-ab46399cd77c", "63d7b889-71e3-422a-8cb7-2103ba0aa276", "033e5c86-371a-46fb-bbea-eb7f6b0cd092", "559b1354-ef94-4cb9-8e03-9eca83c6dba4", "55edc4fa-052f-40f9-9edd-739b100e6f75" ] } ] Tables 50 Amazon Textract }, Developer Guide To learn more about the table, access the TABLE block object. The table block includes four types of relationships: “Child,” “Merged Cells,” "Title," and "Footer." For relationship type CHILD, each child ID represents a single cell within the table. A merged cell is broken down into all the individual cells that are combined to make one merged cell. TABLE_TITLE and TABLE_FOOTER relationship types contain the block ID for the corresponding TABLE_TITLE and TABLE_FOOTER blocks, where information about the title and footer is stored. The table block type has an EntityType of either STRUCTURED_TABLE or SEMI_STRUCTURED_TABLE that identiﬁes the type of table. The following JSON shows that the preceding table has 65 cells for 13 rows and 5 columns, which are listed in the CHILD relationship Ids array. For relationship type MERGED_CELL, each merged cell ID represents a single merged cell within the table. The following JSON shows that the table has 9 merged cells, which are listed in the MERGED_CELL relationship Ids array. The two additional relationship types, TABLE_TITLE and TABLE_FOOTER, list the IDs of the respective title and footer blocks. The following JSON also shows that the table is structured in the EntityTypes block. { "BlockType": "TABLE", "Confidence": 99.8046875, "Geometry": {...}, "Id": "55edc4fa-052f-40f9-9edd-739b100e6f75", "Relationships": [ { "Type": "CHILD", "Ids": [ "c1c03d64-d365-4906-af7a-a852f1acc040", "8b415996-6b05-4183-a959-d27d12ccef79", "48b0e972-7dba-4db7-896e-ca7066e8c761", "69948207-47d8-4825-8929-1d7abb650a88", "b9ac9f14-8899-43b3-8572-0e997180e0a4", "6f06c024-0b36-4acd-b61f-4467203234dd", "c8a88487-dbc7-4662-a69b-21103049b61d", ... "2b41c8e1-f754-4b37-91b6-a97cdc413f91", "365a1bab-0c18-4cd8-a465-6f7bc7e25e60", "f08af959-cfac-4ad6-a63f-2771c7a8ff62", "e4f6fbfd-c7d8-4f64-9102-733d4806850f", "68c0b8ff-fd35-41ce-ba76-de08c26084d7", "44e80372-aa70-4a36-9aac-3a93aaa91bb1" Tables 51 Developer Guide Amazon Textract ] }, { "Type": "MERGED_CELL", "Ids": [ "a27a3ecc-afd0-4f7c-9db2-6f8e6d31c605", "6c02cf21-40de-4480-b755-e94462ac4884", "6faad856-8d37-4751-b741-c4ad8d5dcbe3", "d777d6e2-7430-4c6e-a261-03ec5a612c8c", "f0f5a9fb-5bfa-4c80-8f41-1d4fad674b09", "83c7af02-8128-4479-89c9-962544ad4048", "b2b5126c-409f-4b67-9adf-e3e12f60bf86", "87d7f688-3d38-4198-b491-433af0da4d8b", "1c2436e2-a1fc-4b2a-9e73-cc8a1ca67568" ] }, { "Type": "TABLE_TITLE", "Ids": [ "cde34920-0131-4e68-a3ec-82922269afd4" ] }, { "Type": "TABLE_FOOTER", "Ids": [ "11dfd98c-6140-49e8-a544-e220d76bdd2f", "ad1b9c81-3b53-4fc7-a533-dabb3d29b0b1" ] } ], "EntityTypes": [ "STRUCTURED_TABLE" ] }, The block type for each table cell is CELL. The cell block type will always have row span of 1 and column span of 1. The block object for each cell includes information about the cell location compared to other cells in the table. It also includes geometry information for the location of the cell on the document. In addition, cell blocks can have diﬀerent EntityTypes that identify them as a particular type of cell, including TABLE_TITLE, TABLE_FOOTER, TABLE_SECTION_TITLE, Tables 52 Amazon Textract Developer Guide COLUMN_HEADER, and TABLE_SUMMARY. For example, in the preceding table, the cell that contains the word “Date” is a column header, as shown in the following example. { "BlockType": "CELL", "Confidence": 81.8359375, "RowIndex": 2, "ColumnIndex": 1, "RowSpan": 1, "ColumnSpan": 1, "Geometry": {...}, "Id": "6f06c024-0b36-4acd-b61f-4467203234dd", "Relationships": [ { "Type": "CHILD", "Ids": [ "c49f55d5-a7e4-41d5-9c29-d8244f56181c" ] } ], "EntityTypes": [ "COLUMN_HEADER" ] }, The cell that contains the word "Deposit" is not a title, footer,
textract-dg-018	textract-dg.pdf	18	the document. In addition, cell blocks can have diﬀerent EntityTypes that identify them as a particular type of cell, including TABLE_TITLE, TABLE_FOOTER, TABLE_SECTION_TITLE, Tables 52 Amazon Textract Developer Guide COLUMN_HEADER, and TABLE_SUMMARY. For example, in the preceding table, the cell that contains the word “Date” is a column header, as shown in the following example. { "BlockType": "CELL", "Confidence": 81.8359375, "RowIndex": 2, "ColumnIndex": 1, "RowSpan": 1, "ColumnSpan": 1, "Geometry": {...}, "Id": "6f06c024-0b36-4acd-b61f-4467203234dd", "Relationships": [ { "Type": "CHILD", "Ids": [ "c49f55d5-a7e4-41d5-9c29-d8244f56181c" ] } ], "EntityTypes": [ "COLUMN_HEADER" ] }, The cell that contains the word "Deposit" is not a title, footer, column header, section title, or summary cell. This is shown by the lack of the ﬁeld "EntityTypes". { "BlockType": "CELL", "Confidence": 86.181640625, "RowIndex": 7, "ColumnIndex": 2, "RowSpan": 1, "ColumnSpan": 1, "Geometry": {...}, "Id": "7af5160b-bd60-45f5-a12c-bf376e9d742c", "Relationships": [ { "Type": "CHILD", "Ids": [ Tables 53 Amazon Textract Developer Guide "bb9bcaed-5998-44a6-9076-aa1ecc82fbc6" ] } ] }, All the merged cells are listed under "Type": "MERGED_CELL" in the TABLE block. In the preceding example table, there are nine merged cells. { "Type": "MERGED_CELL", "Ids": [ "a27a3ecc-afd0-4f7c-9db2-6f8e6d31c605", "6c02cf21-40de-4480-b755-e94462ac4884", "6faad856-8d37-4751-b741-c4ad8d5dcbe3", "d777d6e2-7430-4c6e-a261-03ec5a612c8c", "f0f5a9fb-5bfa-4c80-8f41-1d4fad674b09", "83c7af02-8128-4479-89c9-962544ad4048", "b2b5126c-409f-4b67-9adf-e3e12f60bf86", "87d7f688-3d38-4198-b491-433af0da4d8b", "1c2436e2-a1fc-4b2a-9e73-cc8a1ca67568" ] }, To ﬁnd speciﬁc details associated with each merged cell, go to "BlockType": "MERGED_CELL". For the merged cell “Balance Sheet”, which is also a title cell, the ID associated with it is "a27a3ecc-afd0-4f7c-9db2-6f8e6d31c605". There are 5 cells that constitute this merged cell, as shown by the "ColumnSpan" of 5. To ﬁnd the text within the merged cell, go further down to the Ids array for details on "BlockType": "CELL" followed by "BlockType": "WORD". { "BlockType": "MERGED_CELL", "Confidence": 77.44140625, "RowIndex": 1, "ColumnIndex": 1, "RowSpan": 1, "ColumnSpan": 5, "Geometry": {...}, Tables 54 Amazon Textract Developer Guide "Id": "a27a3ecc-afd0-4f7c-9db2-6f8e6d31c605", "Relationships": [ { "Type": "CHILD", "Ids": [ "c1c03d64-d365-4906-af7a-a852f1acc040", "8b415996-6b05-4183-a959-d27d12ccef79", "48b0e972-7dba-4db7-896e-ca7066e8c761", "69948207-47d8-4825-8929-1d7abb650a88", "b9ac9f14-8899-43b3-8572-0e997180e0a4" ] } ], "EntityTypes": [ "TABLE_TITLE" ] }, On the cell level, there are 5 cells for the merged cell “Balance Sheet”. Each cell has an EntityType of TABLE_TITLE because the title was identiﬁed in the merged cell. The cell with an Id of 48b0e972-7dba-4db7-896e-ca7066e8c761 contains two CHILD relationship IDs that correspond to the WORD blocks that make up this merged title cell. { "BlockType": "CELL", "Confidence": 77.44140625, "RowIndex": 1, "ColumnIndex": 1, "RowSpan": 1, "ColumnSpan": 1, "Geometry": {...}, "Id": "c1c03d64-d365-4906-af7a-a852f1acc040", "EntityTypes": [ "TABLE_TITLE" ] }, { "BlockType": "CELL", "Confidence": 77.44140625, "RowIndex": 1, "ColumnIndex": 2, "RowSpan": 1, Tables 55 Amazon Textract "ColumnSpan": 1, "Geometry": {...}, "Id": "8b415996-6b05-4183-a959-d27d12ccef79", Developer Guide "EntityTypes": [ "TABLE_TITLE" ] }, { "BlockType": "CELL", "Confidence": 77.44140625, "RowIndex": 1, "ColumnIndex": 3, "RowSpan": 1, "ColumnSpan": 1, "Geometry": {...}, "Id": "48b0e972-7dba-4db7-896e-ca7066e8c761", "Relationships": [ { "Type": "CHILD", "Ids": [ "998394ef-c6cf-491b-9bac-ec470c638ecd", "1c875a06-f8e5-4df7-8f6a-583c47cbd9fe" ] } ], "EntityTypes": [ "TABLE_TITLE" ] }, { "BlockType": "CELL", "Confidence": 77.44140625, "RowIndex": 1, "ColumnIndex": 4, "RowSpan": 1, "ColumnSpan": 1, "Geometry": {...}, "Id": "69948207-47d8-4825-8929-1d7abb650a88", "EntityTypes": [ "TABLE_TITLE" ] }, { "BlockType": "CELL", Tables 56 Amazon Textract Developer Guide "Confidence": 77.44140625, "RowIndex": 1, "ColumnIndex": 5, "RowSpan": 1, "ColumnSpan": 1, "Geometry": {...}, "Id": "b9ac9f14-8899-43b3-8572-0e997180e0a4", "EntityTypes": [ "TABLE_TITLE" ] }, On the word level, there are two words, “Balance” and "Sheet." Since the ﬁrst two and last two cells on columns 1, 2, 4, and 5 are blank, there are no words associated with them. This is also shown in the previous JSON output, where only the third cell contains child IDs. { "BlockType": "WORD", "Confidence": 99.95711517333984, "Text": "Balance", "TextType": "PRINTED", "Geometry": {...}, "Id": "998394ef-c6cf-491b-9bac-ec470c638ecd" }, { "BlockType": "WORD", "Confidence": 99.87372589111328, "Text": "Sheet", "TextType": "PRINTED", "Geometry": {...}, "Id": "1c875a06-f8e5-4df7-8f6a-583c47cbd9fe" }, The TABLE_TITLE and TABLE_FOOTER block types contain information about title and footer cells, including CHILD relationships that point to the WORD blocks that make up the title or footer. This is shown in the following JSON response. In this example, the title is an in-table title, meaning it is found within the structure of the table itself, as opposed to outside of the table as a ﬂoating title. This means that the title also has a CELL block type that contains the child IDs of the word blocks that make up the title. See the Tables 57 Amazon Textract Developer Guide previous JSON output for the ﬁve cell blocks that comprise the merged title cell, which includes the title cell block with the child IDs of the word blocks. The footer cells for this table would also be represented by cell blocks for each footer. { "BlockType": "TABLE_TITLE", "Confidence": 97.802734375, "Geometry": {...}, "Id": "cde34920-0131-4e68-a3ec-82922269afd4", "Relationships": [ { "Type": "CHILD", "Ids": [ "998394ef-c6cf-491b-9bac-ec470c638ecd", "1c875a06-f8e5-4df7-8f6a-583c47cbd9fe" ] } ] }, { "BlockType": "TABLE_FOOTER", "Confidence": 88.0859375, "Geometry": {...}, "Id": "11dfd98c-6140-49e8-a544-e220d76bdd2f", "Relationships": [ { "Type": "CHILD", "Ids": [ "77a70b2d-c137-4161-8d9c-65170266e5ff", "d413ef1f-fa1b-44cb-87ed-809494fc87d8", "19616f50-1a34-431f-94bf-7e575106cd85", "35063ea4-a3c7-4e19-9d32-10eca92807b8", "48de1523-7776-49ef-96d9-fc19bcde89c5" ] } ] }, Tables 58 Amazon Textract Selection Elements Developer Guide Amazon Textract can detect selection elements such as option buttons (radio buttons), check boxes, underlined, and circled text on a document page. Selection elements can
textract-dg-019	textract-dg.pdf	19	of the word blocks. The footer cells for this table would also be represented by cell blocks for each footer. { "BlockType": "TABLE_TITLE", "Confidence": 97.802734375, "Geometry": {...}, "Id": "cde34920-0131-4e68-a3ec-82922269afd4", "Relationships": [ { "Type": "CHILD", "Ids": [ "998394ef-c6cf-491b-9bac-ec470c638ecd", "1c875a06-f8e5-4df7-8f6a-583c47cbd9fe" ] } ] }, { "BlockType": "TABLE_FOOTER", "Confidence": 88.0859375, "Geometry": {...}, "Id": "11dfd98c-6140-49e8-a544-e220d76bdd2f", "Relationships": [ { "Type": "CHILD", "Ids": [ "77a70b2d-c137-4161-8d9c-65170266e5ff", "d413ef1f-fa1b-44cb-87ed-809494fc87d8", "19616f50-1a34-431f-94bf-7e575106cd85", "35063ea4-a3c7-4e19-9d32-10eca92807b8", "48de1523-7776-49ef-96d9-fc19bcde89c5" ] } ] }, Tables 58 Amazon Textract Selection Elements Developer Guide Amazon Textract can detect selection elements such as option buttons (radio buttons), check boxes, underlined, and circled text on a document page. Selection elements can be detected in form data and in tables. For example, when the following table is detected on a form, Amazon Textract detects the check boxes in the table cells. Agree Neutral Disagree Good Service Easy to Use Fair Price ☑ ☐ ☑ ☐ ☑ ☐ ☐ ☐ ☐ Detected selection elements are returned as Block objects in the responses from AnalyzeDocument and GetDocumentAnalysis. Below is a table that provides examples of the diﬀerent selectable types supported by Amazon Textract. Selectable Type Radio Button Checkbox Underlined Words Circled Words Crossed Out Words Example Yes ○ No ● Yes ☐ No ☑ Yes No Additionally Amazon Textract can detect implicit clickables, or clickables that are structured as questions and answered by marking one of several answers. These are returned the same way clickables are. Selection Elements 59 Amazon Textract Note Developer Guide You can use the FeatureTypes input parameter to retrieve information about key- value pairs, tables, or both. For example, if you ﬁlter on tables, the response includes the selection elements that are detected in tables. Selection elements that are detected in key- value pairs aren't included in the response. Information about a selection element is contained in a Block object of type SELECTION_ELEMENT. To determine the status of a selectable element, use the SelectionStatus ﬁeld of the SELECTION_ELEMENT block. The status can be either SELECTED or NOT_SELECTED. For example, the value of SelectionStatus for the previous image is SELECTED. A SELECTION_ELEMENT Block object is associated with either a key-value pair or a table cell. A SELECTION_ELEMENT Block object contains bounding box information for a selection element in the Geometry ﬁeld. A SELECTION_ELEMENT Block object isn't a child of a PAGE Block object. Form Data (Key-Value Pairs) A key-value pair is used to represent a selection element that's detected on a form. The KEY block contains the text for the selection element. The VALUE block contains the SELECTION_ELEMENT block. The following diagram shows how selection elements are represented by the section called “Block” objects. For more information about key-value pairs, see Form Data (Key-Value Pairs). The following JSON snippet shows the key for a key-value pair that contains a selection element (male ☑). The child ID (Id bd14cfd5-9005-498b-a7f3-45ceb171f0ﬀ) is the ID of the WORD block that contains the text for the selection element (male). The value ID (Id 24aaac7f-fcce-49c7- a4f0-3688b05586d4) is the ID of the VALUE block that contains the SELECTION_ELEMENT block object. { "Relationships": [ { "Type": "VALUE", "Ids": [ "24aaac7f-fcce-49c7-a4f0-3688b05586d4" // Value containing Selection Element Selection Elements 60 Amazon Textract ] }, { "Type": "CHILD", "Ids": [ "bd14cfd5-9005-498b-a7f3-45ceb171f0ff" // WORD - male Developer Guide ] } ], "Confidence": 94.15619659423828, "Geometry": { "BoundingBox": { "Width": 0.022914813831448555, "Top": 0.08072036504745483, "Left": 0.18966935575008392, "Height": 0.014860388822853565 }, "Polygon": [ { "Y": 0.08072036504745483, "X": 0.18966935575008392 }, { "Y": 0.08072036504745483, "X": 0.21258416771888733 }, { "Y": 0.09558075666427612, "X": 0.21258416771888733 }, { "Y": 0.09558075666427612, "X": 0.18966935575008392 } ] }, "BlockType": "KEY_VALUE_SET", "EntityTypes": [ "KEY" ], "Id": "a118dc43-d5f7-49a2-a20a-5f876d9ffd79" } Selection Elements 61 Amazon Textract Developer Guide The following JSON snippet is the WORD block for the word Male. The WORD block also has a parent LINE block. { "Geometry": { "BoundingBox": { "Width": 0.022464623674750328, "Top": 0.07842985540628433, "Left": 0.18863198161125183, "Height": 0.01617223583161831 }, "Polygon": [ { "Y": 0.07842985540628433, "X": 0.18863198161125183 }, { "Y": 0.07842985540628433, "X": 0.2110965996980667 }, { "Y": 0.09460209310054779, "X": 0.2110965996980667 }, { "Y": 0.09460209310054779, "X": 0.18863198161125183 } ] }, "Text": "Male", "BlockType": "WORD", "Confidence": 54.06439208984375, "Id": "bd14cfd5-9005-498b-a7f3-45ceb171f0ff" }, The VALUE block has a child (Id f2f5e8cd-e73a-4e99-a095-053acd3b6bfb) that is the SELECTION_ELEMENT block. { "Relationships": [ { "Type": "CHILD", Selection Elements 62 Amazon Textract "Ids": [ Developer Guide "f2f5e8cd-e73a-4e99-a095-053acd3b6bfb" // Selection element ] } ], "Confidence": 94.15619659423828, "Geometry": { "BoundingBox": { "Width": 0.017281491309404373, "Top": 0.07643391191959381, "Left": 0.2271782010793686, "Height": 0.026274094358086586 }, "Polygon": [ { "Y": 0.07643391191959381, "X": 0.2271782010793686 }, { "Y": 0.07643391191959381, "X": 0.24445968866348267 }, { "Y": 0.10270800441503525, "X": 0.24445968866348267 }, { "Y": 0.10270800441503525, "X": 0.2271782010793686 } ] }, "BlockType": "KEY_VALUE_SET", "EntityTypes": [ "VALUE" ], "Id": "24aaac7f-fcce-49c7-a4f0-3688b05586d4" }, } The following JSON is the SELECTION_ELEMENT block. The value of SelectionStatus indicates that the check box is selected. Selection Elements 63 Amazon Textract Developer Guide { "Geometry": { "BoundingBox": { "Width": 0.020316146314144135, "Top": 0.07575977593660355, "Left": 0.22590067982673645, "Height": 0.027631107717752457 }, "Polygon": [ { "Y":
textract-dg-020	textract-dg.pdf	20	element ] } ], "Confidence": 94.15619659423828, "Geometry": { "BoundingBox": { "Width": 0.017281491309404373, "Top": 0.07643391191959381, "Left": 0.2271782010793686, "Height": 0.026274094358086586 }, "Polygon": [ { "Y": 0.07643391191959381, "X": 0.2271782010793686 }, { "Y": 0.07643391191959381, "X": 0.24445968866348267 }, { "Y": 0.10270800441503525, "X": 0.24445968866348267 }, { "Y": 0.10270800441503525, "X": 0.2271782010793686 } ] }, "BlockType": "KEY_VALUE_SET", "EntityTypes": [ "VALUE" ], "Id": "24aaac7f-fcce-49c7-a4f0-3688b05586d4" }, } The following JSON is the SELECTION_ELEMENT block. The value of SelectionStatus indicates that the check box is selected. Selection Elements 63 Amazon Textract Developer Guide { "Geometry": { "BoundingBox": { "Width": 0.020316146314144135, "Top": 0.07575977593660355, "Left": 0.22590067982673645, "Height": 0.027631107717752457 }, "Polygon": [ { "Y": 0.07575977593660355, "X": 0.22590067982673645 }, { "Y": 0.07575977593660355, "X": 0.2462168186903 }, { "Y": 0.1033908873796463, "X": 0.2462168186903 }, { "Y": 0.1033908873796463, "X": 0.22590067982673645 } ] }, "BlockType": "SELECTION_ELEMENT", "SelectionStatus": "SELECTED", "Confidence": 74.14942932128906, "Id": "f2f5e8cd-e73a-4e99-a095-053acd3b6bfb" } Table Cells Amazon Textract can detect selection elements inside a table cell. For example, the cells in the following table have check boxes. Agree Neutral Disagree Good Service ☑ ☐ ☐ Selection Elements 64 Amazon Textract Easy to Use Fair Price ☐ ☑ Developer Guide ☑ ☐ ☐ ☐ A CELL block can contain child SELECTION_ELEMENT objects for selection elements and child WORD blocks for detected text. For more information about tables, see Tables. The TABLE Block object for the previous table looks similar to this. { "Geometry": {.....}, "Relationships": [ { "Type": "CHILD", "Ids": [ "652c09eb-8945-473d-b1be-fa03ac055928", "37efc5cc-946d-42cd-aa04-e68e5ed4741d", "4a44940a-435a-4c5c-8a6a-7fea341fa295", "2de20014-9a3b-4e26-b453-0de755144b1a", "8ed78aeb-5c9a-4980-b669-9e08b28671d2", "1f8e1c68-2c97-47b2-847c-a19619c02ca9", "9927e1d1-6018-4960-ac17-aadb0a94f4d9", "68f0ed8b-a887-42a5-b618-f68b494a6034", "fcba16e0-6bd7-4ea5-b86e-36e8330b68ea", "2250357c-ae34-4ed9-86da-45dac5a5e903", "c63ad40d-5a14-4646-a8df-2d4304213dbc", // Cell "2b8417dc-e65f-4fcd-aa0f-61a23f1e8cb0", "26c62932-72f0-4dc2-9893-1ae27829c060", "27f291cc-abf4-4c23-aa24-676abe99cb1e", "7e5ce028-1bcd-4d9f-ad42-15ac181c5b47", "bf32e3d2-efa2-4fc1-b09b-ab9cc52ff734" ] } ], "BlockType": "TABLE", "Confidence": 99.99993896484375, "Id": "f66eac36-2e74-406e-8032-14d1c14e0b86" } Selection Elements 65 Amazon Textract Developer Guide The CELL BLOCK object (Id c63ad40d-5a14-4646-a8df-2d4304213dbc) for the cell that contains the check box Good Service looks like the following. It includes a child Block (Id = 26d122fd- c5f4-4b53-92c4-0ae92730ee1e) that is the SELECTION_ELEMENT Block object for the check box. { "Geometry": {.....}, "Relationships": [ { "Type": "CHILD", "Ids": [ "26d122fd-c5f4-4b53-92c4-0ae92730ee1e" // Selection Element ] } ], "Confidence": 79.741689682006836, "RowSpan": 1, "RowIndex": 3, "ColumnIndex": 3, "ColumnSpan": 1, "BlockType": "CELL", "Id": "c63ad40d-5a14-4646-a8df-2d4304213dbc" } The SELECTION_ELEMENT Block object for the check box is as follows. The value of SelectionStatus indicates that the check box is selected. { "Geometry": {.......}, "BlockType": "SELECTION_ELEMENT", "SelectionStatus": "SELECTED", "Confidence": 88.79517364501953, "Id": "26d122fd-c5f4-4b53-92c4-0ae92730ee1e" } Queries When provided a query, Amazon Textract provides a specialized response object. This object repeats the question back to the user along with the alias for the question. It then provides the conﬁdence Amazon Textract has with the answer, a location of the answer on the page, and the text answer to the question. If no answer is found, this response element is kept blank. Queries 66 Amazon Textract Developer Guide Detected queries are returned as Block objects in the responses from AnalyzeDocument and GetDocumentAnalysis. You can use the FeatureTypes input parameter to retrieve information about key-value pairs, tables, or Queries. For general information about how a document is represented by Block objects, see Text Detection and Document Analysis Response Objects. The following shows a diagram of how a query response is represented in Block objects. Following is an example for a query response as part of a full response of document analysis. { "BlockType": "QUERY", "Id": "77cfbd28-168a-40fc-9c8a-863ba3066bd2", "Relationships": [ { "Type": "ANSWER", "Ids": [ "21396475-27ee-4da7-965b-f7631ef60fcc" ] } ], "Query": { "Text": "What is the patient first name?", "Alias": "PATIENT_FIRST_NAME" } }, { "BlockType": "QUERY_RESULT", "Confidence": 1.0, "Text": "ALEJANDRO", Queries 67 Amazon Textract Developer Guide "Id": "21396475-27ee-4da7-965b-f7631ef60fcc" } We have compiled a list of example queries for common documents in the Example Queries document. Layout Response Objects When using Layout on a document with Amazon Textract, the diﬀerent layout elements are returned as a BlockType in the Block object. These elements correspond to the diﬀerent portions of the layout, and are: • Title — The main title of the document. Returned as LAYOUT_TITLE. • Header — Text located in the top margin of the document. Returned as LAYOUT_HEADER. • Footer — Text located in the bottom margin of the document. Returned as LAYOUT_FOOTER. • Section Title — The titles for individual document sections. Returned as LAYOUT_SECTION_HEADER. • Page Number — The page number of the documents. Returned as LAYOUT_PAGE_NUMBER. • List — Any information grouped together in list form. Returned as LAYOUT_LIST. • Figure — Indicates the location of an image in a document. Returned as LAYOUT_FIGURE. • Table — Indicates the location of a table in the document. Returned as LAYOUT_TABLE. • Key Value — Indicates the location of form key-values in a document. Returned as LAYOUT_KEY_VALUE. • Text — Text that is present typically as a part of paragraphs in documents. Returned as LAYOUT_TEXT Each element returns two key pieces of information. First is the bounding box of the layout element, which shows its location. Second, the element contains a list of IDs. These IDs point to the components
textract-dg-021	textract-dg.pdf	21	LAYOUT_LIST. • Figure — Indicates the location of an image in a document. Returned as LAYOUT_FIGURE. • Table — Indicates the location of a table in the document. Returned as LAYOUT_TABLE. • Key Value — Indicates the location of form key-values in a document. Returned as LAYOUT_KEY_VALUE. • Text — Text that is present typically as a part of paragraphs in documents. Returned as LAYOUT_TEXT Each element returns two key pieces of information. First is the bounding box of the layout element, which shows its location. Second, the element contains a list of IDs. These IDs point to the components of the layout element, often lines of text represented by LINE objects. Layout elements can also point to diﬀerent objects, such as TABLE objects, Key-Value pairs, or LAYOUT_TEXT elements in the case of LAYOUT_LIST. Elements are returned in implied reading order. This means layout elements will be returned by document analysis left to right, top to bottom. For multicolumn pages, elements are returned from Layout Response Objects 68 Amazon Textract Developer Guide the top of the leftmost column, moving left to right until the bottom of the column is reached. Then, the elements from the next leftmost column are returned in the same way. Below is an example of a LAYOUT_TITLE response element, with the bounding box geometry section removed. The three IDs point towards the three LINE objects representing the three lines of text in the title. { "BlockType": "LAYOUT_TITLE", "Confidence": 57.177734375, "Geometry": { ... }, "Id": "e02654d0-dce1-4205-bf1c-6fac1cc0a35a", "Relationships": [ { "Type": "CHILD", "Ids": [ "8afeedb5-44f2-48ec-ae97-07edc204f8d8", "fa505358-51ff-405c-b227-e51faffb28fe", "95ef9c97-5a98-4060-9100-d09222b166f6" ] } ] }, When Amazon Textract detects a list in a document's layout, instead of the IDs pointing directly to the LINE objects, it instead points to the LAYOUT_TEXT objects located within the list. Below is a shortened example response displaying this relationship. Within the LAYOUT_TEXT objects you can see the IDs corresponding to the IDs in the LAYOUT_LIST response object. These LAYOUT_TEXT objects then contain their own list of IDs, which correspond to the LINE objects for each line of text in the layout element. { "BlockType": "LAYOUT_LIST", "Relationships": [ { "Ids": [ "98d2f88c-9116-4025-bf4f-70e4345ac347", // LAYOUT_TEXT "d132fcd3-2be0-4f23-8c98-61295f5c6ac2" ], // LAYOUT_TEXT Layout Response Objects 69 Developer Guide Amazon Textract "Type": "CHILD" } ], "ID": "c685fb89-692b-4e80-8083-7b783735e287", ... }, { "BlockType": "LAYOUT_TEXT", "ID": "98d2f88c-9116-4025-bf4f-70e4345ac347", ... }, { "BlockType": "LAYOUT_TEXT", "ID": "d132fcd3-2be0-4f23-8c98-61295f5c6ac2", ... } Invoice and Receipt Response Objects When you submit an invoice or a receipt to the AnalyzeExpense API, it returns a series of ExpenseDocuments objects. Each ExpenseDocument is further separated into LineItemGroups and SummaryFields. Most invoices and receipts contain information such as the vendor name, receipt number, receipt date, or total amount. AnalyzeExpense returns this information under SummaryFields. Receipts and invoices also contain details about the items purchased. The AnalyzeExpense API returns this information under LineItemGroups. The ExpenseIndex ﬁeld uniquely identiﬁes the expense, and associates the appropriate SummaryFields and LineItemGroups detected in that expense. Finally, expense analysis will return a Block object, giving you the same information as text detection would on your document. Certain information, such as addresses and names, can be diﬃcult to discern between based on a single response. Expense Analysis uses the object ExpenseGroupProperties to help distinguish nebulous responses. This object contains a type from the following list: • VENDOR_REMIT_TO • RECEIVER_SHIP_TO • RECEIVER_SOLD_TO • RECEIVER_BILL_TO • VENDOR_SUPPLIER Invoice and Receipt Response Objects 70 Amazon Textract Developer Guide These types distinguish between the diﬀerent groups of responses. Multiple elements belonging to the same group are connected via identiﬁcation number, also returned in ExpenseGroupProperties. The most granular level of data in the AnalyzeExpense response consists of Type, ValueDetection, and LabelDetection (Optional). The individual entities are: • Type: Refers to what kind of information is detected on a high level. • LabelDetection: Refers to the label of an associated value within the text of the document. LabelDetection is optional and only returned if the label is written. • ValueDetection: Refers to the value of the label or type returned. The AnalyzeExpense API also detects ITEM, QUANTITY, and PRICE within line items as normalized ﬁelds. If there is other text in a line item on the receipt image such as SKU or detailed description, it will be included in the JSON as EXPENSE_ROW. This is shown in the following example: { "Type": { "Text": "EXPENSE_ROW", "Confidence": 99.95216369628906 }, "ValueDetection": { "Text": "Banana 5 $2.5", "Geometry": { … }, "Confidence": 98.11214447021484 } The preceding example shows how the AnalyzeExpense API operation returns the entire row on a receipt that contains line item information about 5 bananas sold for $2.5. Type Following is an example of the standard or normalized type of the key-value pair: { Type 71 Amazon Textract Developer Guide "PageNumber": 1, "Type": { "Text": "VENDOR_NAME", "Confidence": 70.0 }, "ValueDetection": { "Geometry": { ... }, "Text": "AMAZON", "Confidence": 87.89806365966797
textract-dg-022	textract-dg.pdf	22	the JSON as EXPENSE_ROW. This is shown in the following example: { "Type": { "Text": "EXPENSE_ROW", "Confidence": 99.95216369628906 }, "ValueDetection": { "Text": "Banana 5 $2.5", "Geometry": { … }, "Confidence": 98.11214447021484 } The preceding example shows how the AnalyzeExpense API operation returns the entire row on a receipt that contains line item information about 5 bananas sold for $2.5. Type Following is an example of the standard or normalized type of the key-value pair: { Type 71 Amazon Textract Developer Guide "PageNumber": 1, "Type": { "Text": "VENDOR_NAME", "Confidence": 70.0 }, "ValueDetection": { "Geometry": { ... }, "Text": "AMAZON", "Confidence": 87.89806365966797 } } The receipt did not have “Vendor Name” explicitly listed. However, the Analyze Expense API recognized the value "AMAZON" as Type VENDOR_NAME. LabelDetection Following is an example of text as it is shown on a customer document page: { "PageNumber": 1, "Type": { "Text": "OTHER", "Confidence": 70.0 }, "LabelDetection": { "Geometry": { ... }, "Text": "CASHIER", "Confidence": 88.19171142578125 }, "ValueDetection": { "Geometry": { ... }, "Text": "Mina", "Confidence": 87.89806365966797 } } The example document contained “CASHIER Mina.” The Analyze Expense API extracted the as-is value and returns it under LabelDetection. For implied values such as “Invoice Date,” LabelDetection 72 Amazon Textract Developer Guide where the “key” is not explicitly shown in the receipt, LabelDetection will not be included in the AnalyzeExpense element. In such cases, the AnalyzeExpense API operation does not return LabelDetection. ValueDetection The following is an example that shows the “value” of the key-value pair. { "PageNumber": 1, "Type": { "Text": "OTHER", "Confidence": 70.0 }, "LabelDetection": { "Geometry": { ... }, "Text": "CASHIER", "Confidence": 88.19171142578125 }, "ValueDetection": { "Geometry": { ... }, "Text": "Mina", "Confidence": 87.89806365966797 } } In the example, the document contained “CASHIER Mina”. The AnalyzeExpense API detected the Cashier value as Mina and returned it under ValueDetection. Identity Documentation Response Objects When you submit an identity document to the AnalyzeID API, it returns a series of IdentityDocumentField objects. Each of these objects contains Type, and Value. Type records the normalized ﬁeld that Amazon Textract detects, and Value records the text associated with the normalized ﬁeld. Following is an example of an IdentityDocumentField, shortened for brevity. ValueDetection 73 Developer Guide Amazon Textract { "DocumentMetadata": { "Pages": 1 }, "IdentityDocumentFields": [ { "Type": { "Text": "first name" }, "ValueDetection": { "Text": "jennifer", "Confidence": 99.99908447265625 } }, { "Type": { "Text": "last name" }, "ValueDetection": { "Text": "sample", "Confidence": 99.99758911132812 } }, These are two examples of IdentityDocumentFields cut from a longer response. There is a separation between the type detected and the value for that type. Here, it is the ﬁrst and last name respectively. This structure repeats with all contained information. If a type is not recognized as a normalized ﬁeld, it will be listed as "other." Additionally, AnalyzeID returns a Blocks object, the same as document text detection so you can have access to the full text of the document. Following is a list of normalized ﬁelds for Driver's Licenses: • First Name — FIRST_NAME • Last Name — LAST_NAME • Middle Name — MIDDLE_NAME • Suﬃx — SUFFIX • City in Address — CITY_IN_ADDRESS • Zip Code In Address — ZIP_CODE_IN_ADDRESS • State In Address — STATE_IN_ADDRESS Identity Documentation Response Objects 74 Developer Guide Amazon Textract • County — COUNTY • Document Number — DOCUMENT_NUMBER • Expiration Date — EXPIRATION_DATE • Date of Birth — DATE_OF_BIRTH • State Name — STATE_NAME • Date of Issue — DATE_OF_ISSUE • Class — CLASS • Restrictions — RESTRICTIONS • Endorsements — ENDORSEMENTS • Id Type — ID_TYPE • Veteran — VETERAN • Address — ADDRESS Following is a list of normalized ﬁelds for U.S Passports: • First Name — FIRST_NAME • Last Name — LAST_NAME • Middle Name — MIDDLE_NAME • Document Number — DOCUMENT_NUMBER • Expiration Date — EXPIRATON_DATE • Date of Birth — DATE_OF_BIRTH • Place of Birth — PLACE_OF_BIRTH • Date of Issue — DATE_OF_ISSUE • Id Type — ID_TYPE • MRZ Code — MRZ_CODE Analyze Lending Response Objects When you submit a document to the Analyze Lending workﬂow, the document is split apart into individual pages and the pages are classiﬁed. The individual pages are then sent to the appropriate Analyze Lending Response Objects 75 Amazon Textract Developer Guide Amazon Textract operation for further analysis, depending on their classiﬁcation. Amazon Textract analyzes the data and returns the relevant information extracted from the documents, such as detected signatures, identity information, forms, expense values, and queries data. After processing a document with StartLendingAnalysis, you can obtain analysis results for individual pages by using GetLendingAnalysis, or you can get a summary of the information in the document with GetLendingAnalysisSummary. The returned summary includes information about documents grouped together by a common document type. The results for the analysis of individual pages follow one general structure,
textract-dg-023	textract-dg.pdf	23	Response Objects 75 Amazon Textract Developer Guide Amazon Textract operation for further analysis, depending on their classiﬁcation. Amazon Textract analyzes the data and returns the relevant information extracted from the documents, such as detected signatures, identity information, forms, expense values, and queries data. After processing a document with StartLendingAnalysis, you can obtain analysis results for individual pages by using GetLendingAnalysis, or you can get a summary of the information in the document with GetLendingAnalysisSummary. The returned summary includes information about documents grouped together by a common document type. The results for the analysis of individual pages follow one general structure, regardless of the class of the document. The response from GetLendingAnalysis contains information regarding the page number and page classiﬁcation, along with the information extracted by one of Amazon Textract ’s analysis operations. For the general structure of the analysis results, see the following example : { "Page": number, "PageClassification": { "PageNumber": [ { "Confidence": number, "Value": "string" } ], "PageType": [ { "Confidence": number, "Value": "string" } ] }, "Extractions": [ { LendingDocument \| ExpenseDocument \| IdentityDocument } ] } GetLendingAnalysis returns a structure that contains information on the page classiﬁcation and the relevant information extracted from the given page using the appropriate operation. The Page entity refers to the physical page number, PageNumber refers to the detected page number, and PageClassification is the class detected for the page. The information extracted by an Analyze Lending Response Objects 76 Amazon Textract Developer Guide analysis operation is stored in the Extractions structure, which contains the normalized key- value pairs from the appropriate operation. In the following sample response, the document is a LendingDocument and contains extracted information and associated structures: { "DocumentMetadata": { "Pages": 1 }, "JobStatus": "SUCCEEDED", "Results": [ { "Page": 1, "PageClassification": { "PageType": [ { "Value": "1005", "Confidence": 99.99947357177734 } ], "PageNumber": [ { "Value": "undetected", "Confidence": 100.0 } ] }, "Extractions": [ { "LendingDocument": { "LendingFields": [ { "Type": "OVERTIME_CONTINUANCE_LIKELY", "ValueDetections": [ { "Text": "Yes", "Geometry": { "BoundingBox": { "Width": 0.019448408856987953, "Height": 0.007367494981735945, "Left": 0.8211431503295898, Analyze Lending Response Objects 77 Amazon Textract Developer Guide "Top": 0.485835462808609 }, "Polygon": [ { "X": 0.8211431503295898, "Y": 0.485835462808609 }, { "X": 0.8405909538269043, "Y": 0.4858577847480774 }, { "X": 0.840591549873352, "Y": 0.49320295453071594 }, { "X": 0.8211436867713928, "Y": 0.4931805729866028 } ] }, "Confidence": 95.0 } ] }, { "Type": "CURRENT_GROSS_PAY_WEEKLY", "KeyDetection": { "Text": "Weekly", "Geometry": { "BoundingBox": { "Width": 0.039741966873407364, "Height": 0.009058262221515179, "Left": 0.17564243078231812, "Top": 0.5004485845565796 }, "Polygon": [ { "X": 0.17564436793327332, "Y": 0.5004485845565796 }, { "X": 0.21538439393043518, "Y": 0.5004944205284119 Analyze Lending Response Objects 78 Amazon Textract Developer Guide }, { "X": 0.2153826206922531, "Y": 0.5095068216323853 }, { "X": 0.17564243078231812, "Y": 0.5094608664512634 } ] }, "Confidence": 99.98104858398438 }, "ValueDetections": [ { "SelectionStatus": "NOT_SELECTED", "Geometry": { "BoundingBox": { "Width": 0.010146399028599262, "Height": 0.00771764200180769, "Left": 0.1600940227508545, "Top": 0.5003445148468018 }, "Polygon": [ { "X": 0.16009573638439178, "Y": 0.5003445148468018 }, { "X": 0.17024043202400208, "Y": 0.5003561973571777 }, { "X": 0.17023874819278717, "Y": 0.5080621242523193 }, { "X": 0.1600940227508545, "Y": 0.5080504417419434 } ] }, "Confidence": 99.88064575195312 } Analyze Lending Response Objects 79 Amazon Textract Developer Guide ] } ], "SignatureDetections": [ { "Confidence": 98.95830535888672, "Geometry": { "BoundingBox": { "Width": 0.1505945473909378, "Height": 0.019163239747285843, "Left": 0.1145595833659172, "Top": 0.8886017799377441 }, "Polygon": [ { "X": 0.11456418037414551, "Y": 0.8886017799377441 }, { "X": 0.2651541233062744, "Y": 0.8887989521026611 }, { "X": 0.2651508152484894, "Y": 0.9077650308609009 }, { "X": 0.1145595833659172, "Y": 0.9075667262077332 } ] } } ] } } ] } ], "AnalyzeLendingModelVersion": "1.0" } Analyze Lending Response Objects 80 Amazon Textract Developer Guide Responses from GetLendingAnalysis may include the following attributes: • Text – The detected text. • Conﬁdence – The Conﬁdence score for the detected text. • Geometry – Location information for the detected text. • LendingDocument – Holds the structured data returned by Analyze Lending for lending documents. • LendingField – Holds the normalized key-value pairs returned by Analyze Lending, including the normalized key for the detection, detected text, and geometry. • LendingFields – An array of LendingField objects. • Type – The normalized value associated with a detection. For a list of all possible document types, click here. • ValueDetections – An array of LendingDetection objects. • LendingDetection – The results extracted for a lending document. • SelectionStatus – The selection status of a selection element, such as an option button or check box. • KeyDetection – Object containing information about the detected key. • SignatureDetections – An array of SignatureDetection objects, which contain information regarding detected signatures. • SignatureDetection – Information regarding the conﬁdence and geometry for the detected signatures. ExpenseDocument extractions contain structures deﬁned in Invoice and Receipt Response Objects. IdentityDocument extractions contain structures deﬁned in Identity Documentation Response Objects. For an example of the summary returned by the GetLendingAnalysisSummary operation, see the following: { "DocumentMetadata": { "Pages": 1 }, "JobStatus": "SUCCEEDED", Analyze Lending Response Objects 81 Amazon Textract Developer Guide "Summary": { "DocumentGroups": [ { "Type": "1005",

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.