Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
accelerate-guide-119	accelerate-guide.pdf	119	• Deployment Strategy ID: You can ﬁnd this with the ListDeploymentStrategies API call. • Conﬁguration Proﬁle ID: ID of CustomerManagedAlarms; you can ﬁnd this with the ListConﬁgurationProﬁles API call. • Conﬁguration Version: The version of the conﬁguration proﬁle to be deployed. Alarm Manager conﬁguration proﬁles Version May 08, 2025 367 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Important Alarm Manager applies the alarm deﬁnitions as speciﬁed in the conﬁguration proﬁles. Any manual modiﬁcations you make with the AWS Management Console or CloudWatch CLI/ SDK to the CloudWatch alarms is automatically reverted back, so make sure your changes are deﬁned through Alarm Manager. To understand which alarms are created by the Alarm Manager, you can look for the ams:alarm-manager:managed tag with value true. Restrict access to the StartDeployment and StopDeployment API actions to trusted users who understand the responsibilities and consequences of deploying a new conﬁguration to your targets. To learn more about how to use AWS AppConﬁg features to create and deploy a conﬁguration, see the AWS AppConﬁg documentation. Using AWS CloudFormation to deploy Accelerate conﬁguration changes If you wish to deploy your CustomerManagedAlarms conﬁguration proﬁle using AWS CloudFormation, you can use the following AWS CloudFormation templates. Put your desired JSON conﬁguration in the AMSAlarmManagerConfigurationVersion.Content ﬁeld. When you deploy the templates in a AWS CloudFormation Stack or Stack Set, the deployment of the AMSResourceTaggerDeployment resource will fail if you have not followed the required JSON format for the conﬁguration. See Accelerate Conﬁguration proﬁle: monitoring for details on the expected format. For help on deploying these templates as a CloudFormation stack or stack set, see the relevant AWS CloudFormation documentation below: • Creating a stack on the AWS CloudFormation console • Creating a stack with AWS CLI • Creating a stack set Note If you deploy a conﬁguration version using one of these templates, and then subsequently delete the CloudFormation stack/stack set, the template conﬁguration version will remain as the current deployed version, and no additional deployment will be made. If you wish to Alarm Manager conﬁguration proﬁles Version May 08, 2025 368 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures revert back to a default conﬁguration, you will need to either manually deploy an empty conﬁguration (i.e. just {}), or update your stack to an empty conﬁguration, rather than deleting the stack. JSON { "Description": "Custom configuration for the AMS Alarm Manager.", "Resources": { "AMSAlarmManagerConfigurationVersion": { "Type": "AWS::AppConfig::HostedConfigurationVersion", "Properties": { "ApplicationId": { "Fn::ImportValue": "AMS-Alarm-Manager-Configuration-ApplicationId" }, "ConfigurationProfileId": { "Fn::ImportValue": "AMS-Alarm-Manager-Configuration-CustomerManagedAlarms- ProfileID" }, "Content": "{}", "ContentType": "application/json" } }, "AMSAlarmManagerDeployment": { "Type": "AWS::AppConfig::Deployment", "Properties": { "ApplicationId": { "Fn::ImportValue": "AMS-Alarm-Manager-Configuration-ApplicationId" }, "ConfigurationProfileId": { "Fn::ImportValue": "AMS-Alarm-Manager-Configuration-CustomerManagedAlarms- ProfileID" }, "ConfigurationVersion": { "Ref": "AMSAlarmManagerConfigurationVersion" }, "DeploymentStrategyId": { "Fn::ImportValue": "AMS-Alarm-Manager-Configuration-Deployment-StrategyID" }, "EnvironmentId": { "Fn::ImportValue": "AMS-Alarm-Manager-Configuration-EnvironmentId" } Alarm Manager conﬁguration proﬁles Version May 08, 2025 369 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures } } } } YAML Description: Custom configuration for the AMS Alarm Manager. Resources: AMSAlarmManagerConfigurationVersion: Type: AWS::AppConfig::HostedConfigurationVersion Properties: ApplicationId: !ImportValue AMS-Alarm-Manager-Configuration-ApplicationId ConfigurationProfileId: !ImportValue AMS-Alarm-Manager-Configuration-CustomerManagedAlarms-ProfileID Content: \| { } ContentType: application/json AMSAlarmManagerDeployment: Type: AWS::AppConfig::Deployment Properties: ApplicationId: !ImportValue AMS-Alarm-Manager-Configuration-ApplicationId ConfigurationProfileId: !ImportValue AMS-Alarm-Manager-Configuration-CustomerManagedAlarms-ProfileID ConfigurationVersion: !Ref AMSAlarmManagerConfigurationVersion DeploymentStrategyId: !ImportValue AMS-Alarm-Manager-Configuration-Deployment-StrategyID EnvironmentId: !ImportValue AMS-Alarm-Manager-Configuration-EnvironmentId Rolling back Accelerate alarm changes You can roll back alarm deﬁnitions through the same deployment mechanism by specifying a previous conﬁguration proﬁle version and running StartDeployment. Alarm Manager conﬁguration proﬁles Version May 08, 2025 370 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Retaining Accelerate alarms When resources monitored by AMS are deleted, any alarms created by Alarm Manager for those resources are automatically deleted by Alarm Manager. If you need to retain certain alarms for auditing, compliance, or historical purposes, use the Alarm Manager retain-tagging capability. To retain an alarm even after its monitored resource is deleted, add an "ams:alarm- manager:retain" tag to the alarm's custom conﬁguration as shown in the following example. { "AWS::EC2::Instance": { "AMSCpuAlarm": { "Enabled": true, "Tag": { "Key": "ams:rt:ams-monitoring-policy", "Value": "ams-monitored" }, "AlarmDefinition": { "AlarmName": "${EC2::InstanceId}: CPU Too High", "AlarmDescription": "AMS Baseline Alarm for EC2 CPUUtilization", [...] "Tags": [ { "Key": "ams:alarm-manager:retain", "Value": "true" } ] } } } } An alarm conﬁgured with the "ams:alarm-manager:retain" tag, is not automatically deleted by Alarm Manager when the monitored resource is terminated. The retained alarm persists in CloudWatch indeﬁnitely until you manually remove it using CloudWatch. Disabling the default Accelerate alarm conﬁguration AMS Accelerate provides the default conﬁguration proﬁle in your account based on the baseline alarms. However, this default conﬁguration can be disabled by overriding any of the alarm deﬁnitions. You can disable a default conﬁguration rule by overriding the ConﬁgurationID of the Alarm Manager conﬁguration proﬁles Version May 08, 2025 371 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures rule in your customization conﬁguration proﬁle and specifying the enabled ﬁeld with a value of false. For example, if the following conﬁguration was present
accelerate-guide-120	accelerate-guide.pdf	120	in CloudWatch indeﬁnitely until you manually remove it using CloudWatch. Disabling the default Accelerate alarm conﬁguration AMS Accelerate provides the default conﬁguration proﬁle in your account based on the baseline alarms. However, this default conﬁguration can be disabled by overriding any of the alarm deﬁnitions. You can disable a default conﬁguration rule by overriding the ConﬁgurationID of the Alarm Manager conﬁguration proﬁles Version May 08, 2025 371 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures rule in your customization conﬁguration proﬁle and specifying the enabled ﬁeld with a value of false. For example, if the following conﬁguration was present in the default conﬁguration proﬁle: { "AWS::EC2::Instance": { "AMSManagedBlock1": { "Enabled": true, "Tag": { "Key": "ams:rt:ams-monitoring-policy", "Value": "ams-monitored" }, "AlarmDefinition": { ... } } } You could disable this tagging rule by including the following in your customization conﬁguration proﬁle: { "AWS::EC2::Instance": { "AMSManagedBlock1": { "Enabled": false } } } To make these changes, the CreateHostedConﬁgurationVersion API must be called with the JSON proﬁle document (see Changing the Accelerate alarm conﬁguration) and subsequently must be deployed (see Deploying Accelerate alarm conﬁguration changes). Note that when you create the new conﬁguration version, you must also include any previously created custom alarms that you want in the JSON proﬁle document. Alarm Manager conﬁguration proﬁles Version May 08, 2025 372 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Important When AMS Accelerate updates the default conﬁguration proﬁle, it's not calibrated against your conﬁgured custom alarms, so review changes to the default alarms when you're overriding them in your customization conﬁguration proﬁle. Creating additional CloudWatch alarms for Accelerate You can create additional CloudWatch alarms for AMS Accelerate using custom CloudWatch metrics and alarms for Amazon EC2 instances. Produce your application monitoring script and custom metric. For more information and access to example scripts, see Monitoring Memory and Disk Metrics for Amazon EC2 Linux Instances. The CloudWatch monitoring scripts for Linux Amazon EC2 instances demonstrate how to produce and consume custom CloudWatch metrics. These sample Perl scripts comprise a fully functional example that reports memory, swap, and disk space utilization metrics for a Linux instance. Important AMS Accelerate does not monitor CloudWatch alarms created by you. Viewing the number of resources monitored by Alarm Manager for Accelerate Alarm Manager sends metrics every hour to Amazon CloudWatch, in the AMS/AlarmManager namespace. Metrics are emitted only for resource types supported by Alarm Manager. Metric Name Dimensions Description ResourceCount Component, ResourceType Number of resources (of the speciﬁed resource type) deployed in this Region. Units: Count Creating additional CloudWatch alarms Version May 08, 2025 373 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Metric Name Dimensions Description Resources MissingMa nagedAlarms Component, ResourceType Number of resources (of the speciﬁed resource type) that require managed alarms, but Alarm Manager has not applied the alarms yet. Units: Count Unmanaged Resources Component, ResourceType Number of resources (of the speciﬁed resource type) that do not have any managed alarms applied to them by Alarm Manager. Typically, these resources did not match any Alarm Manager conﬁguration block, or are explicitly excluded from conﬁguration blocks. Units: Count MatchingR esourceCount Component, ResourceType, Number of resources (of the speciﬁed resource type) that match the Alarm Manager conﬁguration block. ConﬁgClauseName For a resource to match the conﬁguration block, the block must be enabled, and the resource must have same tags speciﬁed in the conﬁguration block. Units: Count These metrics are also viewable as graphs, in the AMS-Alarm-Manager-Reporting-Dashboard. To see the dashboard, from the AWS CloudWatch management console, select AMS-Alarm-Manager- Reporting-Dashboard. By default, the graphs in this dashboard display the data for the prior 12- hour period. AMS Accelerate deploys CloudWatch alarms to your account to detect signiﬁcant increases in the number of unmanaged resources, for example, resources excluded from management by AMS Alarm Manager. AMS Operations will investigate increases in unmanaged resources that exceed: either three resources of the same type, or a 50% increase over all resources of the same type. If the change does not appear to be deliberate, AMS Operations may contact you to review the change. Viewing the number of resources monitored by Alarm Manager Version May 08, 2025 374 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures AMS automatic remediation of alerts Some alerts are automatically remediated by AWS Managed Services (AMS). This section describes how this remediation works and the conditions that must be met for the remediation to take place. Alert name Status Check Failed Description Thresholds Action Possible hardware failures or a fault state of The system has detected a failed status at least AMS automatic remediati on ﬁrst validates if the the instance. once within the last 15 instance is accessible. If minutes. the instance is inaccessi ble, then the instance is stopped and restarted . The stop and start allows the instance to migrate to new
accelerate-guide-121	accelerate-guide.pdf	121	alerts Some alerts are automatically remediated by AWS Managed Services (AMS). This section describes how this remediation works and the conditions that must be met for the remediation to take place. Alert name Status Check Failed Description Thresholds Action Possible hardware failures or a fault state of The system has detected a failed status at least AMS automatic remediati on ﬁrst validates if the the instance. once within the last 15 instance is accessible. If minutes. the instance is inaccessi ble, then the instance is stopped and restarted . The stop and start allows the instance to migrate to new underlyin g hardware. For more information, see the following section "EC2 Status Check Failure Remediation Automatio n." AMSLinuxD iskUsage Trigger when the disk usage of 1 mount point The threshold is above the deﬁned value 6 times AMS automatic remediation ﬁrst deletes (designated space on a volume) on your EC2 instance is ﬁlling up. on the last 30 minutes. AMSWindow sDiskUsage When the disk usage of 1 mount point (designat ed space on a volume) The threshold is above the deﬁned value 6 times during the last 30 minutes. temporary ﬁles. If that does not free up enough disk space, it extends the volume to prevent downtime if the volume becomes full. AMS automatic remediation ﬁrst deletes temporary ﬁles. If that does not free up enough AMS automatic remediation of alerts Version May 08, 2025 375 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Alert name Description Thresholds Action on your EC2 instance is ﬁlling up. RDS- EVENT -0089 The DB instance has consumed more than 90% of its allocated storage. disk space, it extends the volume to prevent downtime if the volume becomes full. The storage is more than 90% allocated. AMS automatic remediati on ﬁrst validates that the RDS- EVENT -0007 Allocated storage for the DB instance has been Storage is 100% allocated. exhausted. To resolve, allocate additional storage. DB is in a modiﬁable and available or storage-full state. It then attempts to increase the allocated storage, IOPS, and storage throughput through a CloudForm ation changeset. If stack drift is already detected, it falls back to the RDS API to prevent downtime. AMS automatic remediati on ﬁrst validates that the DB is in a modiﬁable and available or storage-full state. It then attempts to increase the allocated storage, IOPS, and storage throughput through a CloudForm ation changeset. If stack drift is already detected, it falls back to the RDS API to prevent downtime. AMS automatic remediation of alerts Version May 08, 2025 376 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Alert name RDS- EVENT -0224 Description Thresholds Action The requested allocated storage reaches or The maximum storage threshold for the DB AMS automatic remediati on ﬁrst validates that exceeds the conﬁgure instance has been the requested amount d maximum storage exhausted or is greater of RDS storage will threshold. than or equal to the breach the max storage requested allocated threshold. If conﬁrmed storage. , AMS attempts to increase the max storage threshold by 30% with a CloudFormation changeset, or direct RDS API if resources are not provisioned through CloudFormation. This feature can be opted out of by adding the following tag to the RDS DB Instance: "Key: ams:rt:ams-rds- max-allocated- storage-policy, Value: ams-opt-o ut". AMS automatic remediation of alerts Version May 08, 2025 377 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Alert name Description Thresholds Action RDS-Stora ge-Capaci Less than 1GB is left at the allocated storage for ty the DB instance. Storage is 99% allocated. AMS automatic remediati on ﬁrst validates that the DB is in a modiﬁable and available or storage-full state. It then attempts to increase the allocated storage, IOPS, and storage throughput through a CloudForm ation changeset. If stack drift is already detected, it falls back to the RDS API to prevent downtime. EC2 status check failure: Remediation automation notes How AMS auto-remediation works with EC2 status check failure issues: • If your Amazon EC2 instance has become unreachable, the instance must be stopped and started again so it can be migrated to new hardware and recovered. • If the root of the problem is within the OS (missing devices in fstab, kernel corruption, and so on), the automation is not able to recover your instance. • If your instance belongs to an Auto Scaling group, the automation takes no action—the AutoScalingGroup scaling action replaces the instance. • If your instance has EC2 Auto Recovery enabled, the remediation doesn't take action. EC2 volume usage remediation automation How AWS Managed Services (AMS) auto-remediation works with EC2 volume usage issues: EC2 status check failure: Remediation automation notes Version May 08, 2025 378 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • The automation ﬁrst validates if the volume expansion is
accelerate-guide-122	accelerate-guide.pdf	122	devices in fstab, kernel corruption, and so on), the automation is not able to recover your instance. • If your instance belongs to an Auto Scaling group, the automation takes no action—the AutoScalingGroup scaling action replaces the instance. • If your instance has EC2 Auto Recovery enabled, the remediation doesn't take action. EC2 volume usage remediation automation How AWS Managed Services (AMS) auto-remediation works with EC2 volume usage issues: EC2 status check failure: Remediation automation notes Version May 08, 2025 378 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • The automation ﬁrst validates if the volume expansion is required and if it can be performed. If the expansion is deemed appropriate, the automation can increase the volume capacity. This automated process balances the need for growth with controlled, limited expansion. • Before extending a volume, the automation performs cleanup tasks (Windows: Disk Cleaner, Linux: Logrotate + Simple Service Manager Agent Log removal) on the instance to try to free up space. Note The cleanup tasks are not run on EC2 "T" family instances due to their reliance on CPU credits for continued functionality. • On Linux, the automation only supports extending ﬁle systems of type EXT2, EXT3, EXT4 and XFS. • On Windows, the automation only supports New Technology File System (NTFS) and Resilient File System (ReFS). • The automation doesn't extend volumes that are part of Logical Volume Manager (LVM) or a RAID array. • The automation doesn't extend instance store volumes. • The automation doesn't take action if the aﬀected volume is already bigger than 2 TiB. • The expansion through automation is limited to a maximum of three times per week and ﬁve times total over the system's lifetime. • The automation doesn't expand the volume if the previous expansion happened within the last six hours. When these rules prevent the automation from taking action, AMS reaches out to you through an outbound service request to determine the next actions to take. Amazon RDS low storage event remediation automation How AWS Managed Services (AMS) auto-remediation works with Amazon RDS low storage event issues: • Before trying to extend the Amazon RDS instance storage, the automation performs several checks to ensure the Amazon RDS instance is in a modiﬁable and available, or storage-full, state. • Where CloudFormation stack drift is detected, remediation occurs through the Amazon RDS API. Amazon RDS low storage event remediation automation Version May 08, 2025 379 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • The remediation action does not run in the following scenarios: • The Amazon RDS instance status is not "available" or "storage-full". • The Amazon RDS instance storage is not currently modiﬁable (such as when the storage has been modiﬁed in the last six hours). • The Amazon RDS instance has auto-scaling storage enabled. • The Amazon RDS instance is not a resource within a CloudFormation stack. • Remediation is limited to one expansion per six hours and no more than three expansions within a rolling fourteen day period. • When these scenarios occur, AMS reaches out to you with an outbound incident to determine next actions. Using Amazon EventBridge Managed Rules in AMS AMS Accelerate uses Amazon EventBridge Managed Rules. A Managed Rule is a unique type of rule that is directly linked to AMS. These rules match incoming events and send them to targets for processing. Managed Rules are predeﬁned by AMS and include event patterns that are required by the service to manage customer accounts, and unless deﬁned otherwise, only the owning service can utilize these Managed Rules. AMS Accelerate Managed Rules are linked to events.managedservices.amazonaws.com service principal. These Managed Rules are managed through the AWSServiceRoleForManagedServices_Events service-linked role. To delete these rules a special conﬁrmation by the customer is required. For more information see Deleting Managed Rules for AMS. For more information about rules, see Rules in the Amazon EventBridge User Guide. Amazon EventBridge Managed Rules deployed by AMS Amazon EventBridge Managed Rules Rule Name Description Deﬁnition AmsAccess RolesRule This rule listens for modiﬁcat ions in { "source": ["aws.iam"], "detail-type": ["AWS API Call via CloudTrail"], AMS Event Router Version May 08, 2025 380 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Rule Name Description Deﬁnition speciﬁc AMS "detail": { Accelerat e roles and policies. "eventName": [ "DeleteRole", "DeletePolicy", "CreatePolicyVersion", "AttachRolePolicy", "DetachRolePolicy" ], "requestParameters": { "$or": [ { "roleName": [ "ams-access-admin", "ams-access-admin-operations", "ams-access-operations", "ams-access-read-only", "ams-access-security-analyst", "ams-access-security-analyst- read-only" ] }, { "policyArn": [ "arn::iam:::policy/ams-ac cess-allow-pass-role", "arn::iam:::policy/ams-ac cess-deny-cloudshell-policy", "arn::iam:::policy/ams-ac cess-deny-operations-policy", "arn::iam:::policy/ams-ac cess-deny-update-iam-policy", "arn::iam:::policy/ams-ac cess-ssr-policy", "arn::iam:::policy/ams-ac cess-security-analyst-read-only-policy", "arn::iam:::policy/ams-ac cess-security-analyst-policy", "arn::iam:::policy/ams-ac cess-security-analyst-extended-policy", "arn::iam:::policy/ams-ac cess-admin-policy", Amazon EventBridge Managed Rules deployed by AMS Version May 08, 2025 381 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Rule Name Description Deﬁnition "arn::iam:::policy/ams-ac cess-admin-operations-policy" ] }, ] }, }, } { { "source": ["aws.config", "aws.cloudwatch"], "detail-type": ["Config Rules Compliance Change", "CloudWatch
accelerate-guide-123	accelerate-guide.pdf	123	Description Deﬁnition speciﬁc AMS "detail": { Accelerat e roles and policies. "eventName": [ "DeleteRole", "DeletePolicy", "CreatePolicyVersion", "AttachRolePolicy", "DetachRolePolicy" ], "requestParameters": { "$or": [ { "roleName": [ "ams-access-admin", "ams-access-admin-operations", "ams-access-operations", "ams-access-read-only", "ams-access-security-analyst", "ams-access-security-analyst- read-only" ] }, { "policyArn": [ "arn::iam:::policy/ams-ac cess-allow-pass-role", "arn::iam:::policy/ams-ac cess-deny-cloudshell-policy", "arn::iam:::policy/ams-ac cess-deny-operations-policy", "arn::iam:::policy/ams-ac cess-deny-update-iam-policy", "arn::iam:::policy/ams-ac cess-ssr-policy", "arn::iam:::policy/ams-ac cess-security-analyst-read-only-policy", "arn::iam:::policy/ams-ac cess-security-analyst-policy", "arn::iam:::policy/ams-ac cess-security-analyst-extended-policy", "arn::iam:::policy/ams-ac cess-admin-policy", Amazon EventBridge Managed Rules deployed by AMS Version May 08, 2025 381 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Rule Name Description Deﬁnition "arn::iam:::policy/ams-ac cess-admin-operations-policy" ] }, ] }, }, } { { "source": ["aws.config", "aws.cloudwatch"], "detail-type": ["Config Rules Compliance Change", "CloudWatch Alarm State Change"], } } AMSCoreRule This rule forwards AWS Conﬁg and Amazon CloudWatc h events to AMS Conﬁg remediati on and AMS monitorin g services respectfu lly. The AWS Conﬁg events create and resolve AWS Systems Manager OpsItems. The Amazon CloudWatc h events monitor CloudWatch Alarms. Amazon EventBridge Managed Rules deployed by AMS Version May 08, 2025 382 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Creating Managed Rules for AMS You don’t need to manually create Amazon EventBridge Managed Rules. When you onboard to AMS in the AWS Management Console, the AWS CLI, or the AWS API, AMS creates them for you. Editing Managed Rules for AMS AMS doesn't allow you to edit the Managed Rules. Name and event pattern for each Managed Rule are predeﬁned by AMS. Deleting Managed Rules for AMS You don’t need to manually delete the Managed Rules. When you oﬀboard from AMS in the AWS Management Console, the AWS CLI, or the AWS API, AMS cleans up the resources and deletes all Managed Rules owned by AMS for you. In the event AMS fails to remove the Managed Rules during oﬀboarding, you can also use the Amazon EventBridge console, the AWS CLI or the AWS API to manually delete the Managed Rules. To do this, you must ﬁrst oﬀboard from AMS and conduct a force delete of the Managed Rules. Trusted Remediator in AMS Trusted Remediator is an AWS Managed Services solution that automates the remediation of AWS Trusted Advisor checks. Trusted Remediator creates recommendations when Trusted Advisor checks indicate opportunities for you to reduce costs, improve system availability, optimize performance, or close security gaps for your AWS accounts. With Trusted Remediator, you can address these security, performance, cost optimization, fault tolerance, and service limit recommendations in a safe, standardized way that uses established best practices. Trusted Remediator allows you to conﬁgure a remediation solution and runs automatically on a schedule that you create, simplifying the remediation process. This streamlined approach addresses issues consistently, eﬃciently, and without manual intervention. Topics • Trusted Remediator key beneﬁts • How Trusted Remediator works • Key terms for Trusted Remediator • Get started with Trusted Remediator in AMS Creating Managed Rules for AMS Version May 08, 2025 383 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Trusted Advisor checks supported by Trusted Remediator • Conﬁgure Trusted Advisor check remediation in Trusted Remediator • Execution mode decision workﬂow • Conﬁgure remediation tutorials • Work with remediations in Trusted Remediator • Remediation logs in Trusted Remediator • Trusted Remediator integration with QuickSight • Best practices in Trusted Remediator • Trusted Remediator FAQs Trusted Remediator key beneﬁts The following are the key beneﬁts of Trusted Remediator: • Improved security, performance, and cost optimization: Trusted Remediator helps you to enhance your accounts' overall security posture, optimize resource utilization, and reduce operational costs. • Self-service setup and conﬁguration: You can conﬁgure Trusted Remediator to align with your requirements and preferences. • Automated Trusted Advisor check remediation: After conﬁguration, Trusted Remediator automatically runs the remediation actions for selected Trusted Advisor checks. This automation eliminates the need for manual intervention. • Best practice implementation: Remediation actions are based on established best practices, so issues are addressed in a standardized and eﬀective manner. • Scheduled execution: You can choose the remediation schedule that aligns with your day-to- day operational workﬂows. Trusted Remediator empowers you to proactively address identiﬁed issues in your AWS environments, helping you to adhere to best practices and maintain secure, high-performing, and cost-eﬀective cloud infrastructure. How Trusted Remediator works The following is an illustration of the Trusted Remediator workﬂow: Key beneﬁts Version May 08, 2025 384 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Trusted Remediator assesses Trusted Advisor recommendations for your AWS accounts and creates AWS Systems Manager OpsItems in OpsCenter. Then, you can use Trusted Remediator automation documents to remediate the OpsItems automatically or manually. The following are details for each type of remediation: • Automated remediation: Trusted Remediator runs the automation document and monitors the run. After the automation document completes, Trusted Remediator resolves the Opsitem. • Manual remediation: Trusted Remediator creates the OpsItem for you to review. After you review, you start the automation
accelerate-guide-124	accelerate-guide.pdf	124	Key beneﬁts Version May 08, 2025 384 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Trusted Remediator assesses Trusted Advisor recommendations for your AWS accounts and creates AWS Systems Manager OpsItems in OpsCenter. Then, you can use Trusted Remediator automation documents to remediate the OpsItems automatically or manually. The following are details for each type of remediation: • Automated remediation: Trusted Remediator runs the automation document and monitors the run. After the automation document completes, Trusted Remediator resolves the Opsitem. • Manual remediation: Trusted Remediator creates the OpsItem for you to review. After you review, you start the automation document. Remediation logs are stored in an Amazon S3 bucket. You can use the data in the S3 bucket to build custom QuickSight dashboards for reporting. AMS also provides on-request reports for Trusted Remediator. To receive these reports, contact your CSDM. For more information, see Trusted Remediator reports. Key terms for Trusted Remediator The following are terms that are useful to know when you use Trusted Remediator in AMS: • AWS Trusted Advisor: A cloud optimization service provided by AWS. Trusted Advisor inspects your AWS environment and provides recommendations based on best practices in the following six categories: • Cost optimization • Performance • Security • Fault tolerance • Operational excellence • Service limits For more information, see AWS Trusted Advisor. Key terms Version May 08, 2025 385 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Trusted Remediator: An AMS remediation solution for Trusted Advisor checks. Trusted Remediator helps you to safely remediate Trusted Advisor checks with known best practices to improve security, performance, and reduce costs. Trusted Remediator is easy to setup and conﬁgure. You conﬁgure once, and Trusted Remediator runs remediations on your preferred schedule (daily or weekly). • AWS Systems Manager SSM document: A JSON or YAML ﬁle that deﬁnes the actions that AWS Systems Manager performs on your AWS resources. The SSM document serves as a declarative speciﬁcation to automate operational tasks across multiple AWS resources and instances. • AWS Systems Manager OpsCenter OpsItem: A cloud operational issue management resource that helps you track and resolve operational issues in your AWS environment. OpsItems provide a centralized view and management system for operational data and issues across AWS services and resources. Each OpsItem represents an operational issue, such as a potential security risk, a performance problem, or an operational incident. • Conﬁguration: A conﬁguration is a set of attributes stored in AWS AppConﬁg, a capability of AWS Systems Manager. The Trusted Remediator application in AWS AppConﬁg helps to conﬁgure remediations at the account level. You can use the AWS AppConﬁg console or the API to edit conﬁgurations. • Execution mode: Execution mode is a conﬁguration attribute that determines how to run the remediation for each Trusted Advisor check result. There are four supported execution modes: Automated, Manual, Conditional, Inactive. • Resource override: This feature uses resource tags to override a conﬁguration for speciﬁc resources. • Remediation item log: A log ﬁle in the Trusted Remediator remediation S3 log bucket. The remediation item log is created when remediation OpsItems are created. This log ﬁle contains manual execution remediation OpsItems and automated execution remediation OpsItems. Use this log ﬁle to track all remediation items. • Automated remediation execution log: A log ﬁle in the Trusted Remediator remediation S3 log bucket. The automated remediation execution log is created when automated an SSM document run completes. This log contains SSM execution details for automated execution remediation OpsItems. Use this log ﬁle to track automated remediations. Get started with Trusted Remediator in AMS Trusted Remediator is available in AMS at no additional charge. Trusted Remediator supports single account and multi-account conﬁgurations. Get started with Trusted Remediator Version May 08, 2025 386 AMS Accelerate Concepts and Procedures AMS Accelerate User Guide Topics • Onboard to Trusted Remediator • Choose the Trusted Advisor checks to remediate • Track your remediations in Trusted Remediator • Run manual remediations in Trusted Remediator Onboard to Trusted Remediator To onboard your AMS accounts to Trusted Remediator, email your Cloud Architects or Cloud Service Delivery Managers (CSDMs). In the email, include the following information: • AWS accounts: The twelve-digit account identiﬁcation number. All accounts that you want to onboard to Trusted Remediator must belong to the same Accelerate customer. • Delegated administrator account: The account that is used for Trusted Advisor check conﬁguration for single or multiple accounts. • Member accounts: These are the accounts linked to the delegated administrator account. These accounts inherit the conﬁgurations from the delegated administrator account. You can have one member account or multiple member accounts. Note Member accounts inherit the conﬁgurations from the delegated administrator account. If you need diﬀerent conﬁgurations for speciﬁc accounts, then onboard multiple delegated administrator accounts with your preferred conﬁgurations. Plan the account structure and the conﬁgurations
accelerate-guide-125	accelerate-guide.pdf	125	to onboard to Trusted Remediator must belong to the same Accelerate customer. • Delegated administrator account: The account that is used for Trusted Advisor check conﬁguration for single or multiple accounts. • Member accounts: These are the accounts linked to the delegated administrator account. These accounts inherit the conﬁgurations from the delegated administrator account. You can have one member account or multiple member accounts. Note Member accounts inherit the conﬁgurations from the delegated administrator account. If you need diﬀerent conﬁgurations for speciﬁc accounts, then onboard multiple delegated administrator accounts with your preferred conﬁgurations. Plan the account structure and the conﬁgurations with your Cloud Architects before you onboard. • AWS Regions: The AWS Regions where your resources are located. For a list of AWS Regions, see AWS services by Region. • Remediation schedule and time: Your preferred remediation schedule (daily or weekly). Trusted Remediator gathers Trusted Advisor checks and initiates remediation at the scheduled time. For example, you can set the remediation schedule for 1:00 AM Sunday every week, Australian Eastern Standard Time. • Notiﬁcation email: Trusted Remediator uses the notiﬁcation email to notify you when your scheduled remediations complete. Get started with Trusted Remediator Version May 08, 2025 387 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Note Review your applications and resources after every scheduled remediation. For additional support, contact AMS. After you submit your onboard request with the required details to your CA or CSDM, AMS onboards your accounts to Trusted Remediator. Trusted Remediator uses AWS AppConﬁg, a capability of AWS Systems Manager, to deﬁne the conﬁguration for the Trusted Advisor checks. These conﬁgurations are a set of attributes that are stored in AWS AppConﬁg. To prevent unauthorized charges to your resources, all supported Trusted Advisor checks are set to Inactive when accounts are onboarded to Trusted Remediator. After you're onboarded, you can use the AWS AppConﬁg console or API to manage the conﬁgurations. These conﬁgurations help you to automatically remediate speciﬁc Trusted Advisor checks, or to assess and manually remediate the remaining checks. The conﬁgurations are highly customizable, allowing you to apply conﬁgurations for each Trusted Advisor check. For more information, see Conﬁgure Trusted Advisor check remediation in Trusted Remediator. Choose the Trusted Advisor checks to remediate By default, remediation execution mode is Inactive for all Trusted Advisor checks in your conﬁguration. This prevents unauthorized remediation and protects resources. AMS provides curated SSM automation documents for Trusted Advisor check remediation. To select the checks that you want to remediate with Trusted Remediator, complete the following steps: 1. Review the list of supported Trusted Advisor checks and the name of the associated SSM automation documents to decide which checks you want to remediate with Trusted Remediator. 2. Update your conﬁguration to turn on remediation for your selected Trusted Advisor checks. For instructions on how to select checks, see Conﬁgure Trusted Advisor check remediation in Trusted Remediator. Get started with Trusted Remediator Version May 08, 2025 388 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Track your remediations in Trusted Remediator After you update your account-level conﬁguration, Trusted Remediator creates OpsItems for each remediation. Trusted Remediator runs the SSM document for automated remediation of OpsItems according to your remediation schedule. For instructions on how to view all remediation OpsItems from the Systems Manager OpsCenter console, see Track remediations in Trusted Remediator. Run manual remediations in Trusted Remediator You can manually remediate Trusted Advisor checks. When you initiate a manual remediation, Trusted Remediator creates a manual execution OpsItem. You must review and initiate the SSM automation document to remediate the OpsItems. For more information, see Run manual remediations in Trusted Remediator. Trusted Advisor checks supported by Trusted Remediator The following table lists the supported Trusted Advisor checks, SSM automation documents, preconﬁgured parameters, and the expected outcome of the automation documents. Review the expected outcome to help you understand possible risks based on your business requirements before you enable an SSM automation document for check remediation. Make sure that the corresponding conﬁg rule for each Trusted Advisor check is present for the supported checks that you want to enable remediation for. For more information, see View AWS Trusted Advisor checks powered by AWS Conﬁg. If a check has corresponding AWS Security Hub controls, make sure that the Security Hub control is enabled. For more information, see Enabling controls in Security Hub. For information on managing preconﬁgured parameters, see Conﬁgure Trusted Advisor check remediation in Trusted Remediator. Trusted Advisor cost optimization checks supported by Trusted Remediator Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Z4AUBRNSmz Unassocia ted Elastic IP AWSManagedServices-TrustedR emediatorReleaseElasticIP No preconﬁgured parameters are allowed. Releases an elastic IP address that is No constraints Addresses not associated with any resource. Supported Trusted Advisor checks Version May 08, 2025 389 AMS Accelerate User
accelerate-guide-126	accelerate-guide.pdf	126	AWS Security Hub controls, make sure that the Security Hub control is enabled. For more information, see Enabling controls in Security Hub. For information on managing preconﬁgured parameters, see Conﬁgure Trusted Advisor check remediation in Trusted Remediator. Trusted Advisor cost optimization checks supported by Trusted Remediator Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Z4AUBRNSmz Unassocia ted Elastic IP AWSManagedServices-TrustedR emediatorReleaseElasticIP No preconﬁgured parameters are allowed. Releases an elastic IP address that is No constraints Addresses not associated with any resource. Supported Trusted Advisor checks Version May 08, 2025 389 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints c18d2gz128 Amazon ECR Repositor y Without AWSManagedServices-TrustedR emediatorPutECRLifecyclePolicy ImageAgeLimit: The maximum age limit in days (1-365) for 'any' image Creates a lifecycle policy for the speciﬁed repository if a lifecycle No constraints in the Amazon ECR repository. Lifecycle Policy policy does not already exist. AWSManagedServices-DeleteUn usedEBSVolume • CreateSnapshot: If set to true, then the automation creates a Conﬁgured DAvU99Dc4C Underutilized Amazon EBS Deletes underutilized Amazon Volumes EBS volumes if the volumes are unattached for the last 7 days. An Amazon EBS snapshot is created by default. snapshot of the Amazon EBS volume before it's deleted. The default setting is true. Valid values are true and false (case- sensitive). • MinimumUnattachedDays: Minimum unattached days of the EBS volume to delete, up to 62 days. If set to 0, then the SSM document doesn't check the unattached period and deletes the volume if the volume is currently unattached. The default is value is 7. No constraints Supported Trusted Advisor checks Version May 08, 2025 390 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints hjLMh88uM8 Idle Load Balancers AWSManagedServices-DeleteId leClassicLoadBalancer IdleLoadBalancerDays: The number of days that the Classic Load Deletes an idle Classic Load Balancer if it's unused and no instances are registered. Balancer has 0 requested connectio ns before considering it idle. The default is seven days. If auto execution is enabled, the automation deletes idle Classic Load Balancers if there are no active back- end instances. For all idle Classic Load Balancers that have active back-end instances, but don't have healthy back-end instances, auto remediation isn't used and OpsItems for manual remediation are created. Ti39halfu8 Amazon AWSManagedServices-StopIdle RDSInstance No preconﬁgured parameters are allowed. RDS Idle DB Amazon RDS DB instance that has No constraints Instances been in an idle state for the last seven days is stopped. COr6dfpM05 AWS Lambda over-provisioned functions for memory size AWSManagedServices-ResizeLa mbdaMemory AWS Lambda function's memory size is resized to the recommended memory size provided by Trusted Advisor. RecommendedMemorySize: The recommended memory allocatio n for the Lambda function. Value range is between 128 and 10240. If the Lambda function size was modiﬁed before the automation runs, then the settings might be overwritten by this automation with the value recommended by Trusted Advisor. Supported Trusted Advisor checks Version May 08, 2025 391 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Qch7DwouX1 Low Utilization Amazon EC2 Instances AWSManagedServices-StopEC2I nstance (Default SSM document for both auto and manual execution ForceStopWithInstanceStore: Set to true to force stop instances using instance store. Otherwise, set to mode.) Amazon EC2 instances with low utilization are stopped. false. The default value of false prevents instance from stopping. Valid values are true or false (case- sensitive). No constraints Supported Trusted Advisor checks Version May 08, 2025 392 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Qch7DwouX1 Low Utilization AWSManagedServices-ResizeIn stanceByOneLevel • MinimumDaysSinceLastChange: Minimum number of days since Amazon EC2 Amazon EC2 instance is resized by Instances one instance type down in the same instance family type. The instance is stopped and started during the resize operation and returned to the initial state after the SSM document run completes. This automation doesn't support resizing instances that are in an Auto Scaling Group. the last instance type change. If the instance type was modiﬁed within a speciﬁed time, then the instance type isn't changed. Use 0 to skip this validation. The default is 7. • CreateAMIBeforeResize: To create the instance AMI as a backup before resizing, choose true. To not create a backup, choose false. The default is false. Valid values are true and false (case- sensitive). • ResizeIfStopped: To proceed with the instance size change, even if the instance is in a stopped state, choose true. To not automatically resize the instance if in a stopped state, choose false. Valid values are true and false (case-sen sitive).
accelerate-guide-127	accelerate-guide.pdf	127	If the instance type was modiﬁed within a speciﬁed time, then the instance type isn't changed. Use 0 to skip this validation. The default is 7. • CreateAMIBeforeResize: To create the instance AMI as a backup before resizing, choose true. To not create a backup, choose false. The default is false. Valid values are true and false (case- sensitive). • ResizeIfStopped: To proceed with the instance size change, even if the instance is in a stopped state, choose true. To not automatically resize the instance if in a stopped state, choose false. Valid values are true and false (case-sen sitive). No constraints Supported Trusted Advisor checks Version May 08, 2025 393 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Qch7DwouX1 Low Utilization AWSManagedServices-Terminat eInstance Amazon EC2 Low utilized Amazon EC2 instances Instances are terminated if not part of an Auto Scaling Group and termination protection isn't enabled. An AMI is CreateAMIBeforeTermination: Set this option to true or false to create an instance AMI as a backup before terminating the EC2 instance. The default is true. Valid values are true and false (case-sensitive). created by default. No constraints G31sQ1E9U Underutil AWSManagedServices-PauseRed shiftCluster No preconﬁgured parameters are allowed. ized Amazon The Amazon Redshift cluster is No constraints Redshift Clusters paused. c1cj39rr6v Amazon S3 Incomplet e Multipart AWSManagedServices-TrustedR emediatorEnableS3AbortIncom DaysAfterInitiation:The number of days after which Amazon S3 stops pleteMultipartUpload an incomplete multipart upload. Amazon S3 bucket is conﬁgure Default is set to 7 days. Upload Abort d with a lifecycle rule to abort No constraints Conﬁguration multipart uploads that remain incomplete after certain days. Trusted Advisor security checks supported by Trusted Remediator Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints 12Fnkpl8Y5 Exposed Access Keys AWSManagedServices-TrustedR emediatorDeactivateIAMAccessKey No preconﬁgured parameters are allowed. The exposed IAM access key is deactivated. Supported Trusted Advisor checks Version May 08, 2025 394 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G127 - API Gateway AWSManagedServices-TrustedR emediatorEnableAPIGateWayEx ecutionLogging Execution logging is enabled on the API stage. Applications conﬁgured with an exposed IAM access key can't authenticate. LogLevel: Logging level to enable execution logging, ERROR - Logging is enabled for errors only. INFO - Logging is enabled for all events. You must grant API Gateway permission to read and write logs to CloudWatch for your account in order to enable execution log, refer to Set up CloudWatch logging for REST APIs in API Gateway for detail. AWSManagedServices-EnableAp iGateWayXRayTracing No preconﬁgured parameters are allowed. X-Ray tracing is enabled on the API No constraints stage. REST and WebSocket API execution logging should be enabled Corresponding AWS Security Hub check: APIGateway.1 Hs4Ma3G129 - API Gateway REST API stages should have AWS X-Ray tracing enabled Corresponding AWS Security Hub check: APIGateway.3 Supported Trusted Advisor checks Version May 08, 2025 395 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G202 - API Gateway REST API cache data should be encrypted at rest Corresponding AWS Security Hub check: APIGateway.5 Hs4Ma3G177 - Correspon ding AWS AWSManagedServices-EnableAP IGatewayCacheEncryption No preconﬁgured parameters are allowed. Enable encryption at rest for API No constraints Gateway REST API cache data if the API Gateway REST API stage has cache enabled. AWSManagedServices-TrustedR emediatorEnableAutoScalingG HealthCheckGracePeriod: The amount of time, in seconds, that roupELBHealthCheck Auto Scaling waits before checking Security Hub Elastic Load Balancing health checks check - Auto are enabled for the Auto Scaling scaling groups Group. associated with a load balancer should use load balancer health checks AutoScali ng.1 the health status of an Amazon Elastic Compute Cloud instance that has come into service. Turning on Elastic Load Balancing health checks might result in replacing a running instance if any of the Elastic Load Balancing load balancers attached to the Auto Scaling group report it as unhealthy. For more information, see Attach an Elastic Load Balancing load balancer to your Auto Scaling group Supported Trusted Advisor checks Version May 08, 2025 396 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G245 - AWS CloudForm AWSManagedServices-EnableCF NStackNotiﬁcation NotiﬁcationARNs: The ARNs of the Amazon SNS topics to be associate Associate a CloudFormation stack with an Amazon SNS topic for stacks. d with selected CloudFormation notiﬁcation. To enable auto remediation, The NotificationARNs preconﬁg ured parameter must be provided. ation stacks should be integrated with Amazon Simple Notiﬁcation Service Corresponding AWS Security Hub check: CloudForm ation.1 Supported Trusted Advisor checks Version May 08, 2025 397 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID
accelerate-guide-128	accelerate-guide.pdf	128	Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G245 - AWS CloudForm AWSManagedServices-EnableCF NStackNotiﬁcation NotiﬁcationARNs: The ARNs of the Amazon SNS topics to be associate Associate a CloudFormation stack with an Amazon SNS topic for stacks. d with selected CloudFormation notiﬁcation. To enable auto remediation, The NotificationARNs preconﬁg ured parameter must be provided. ation stacks should be integrated with Amazon Simple Notiﬁcation Service Corresponding AWS Security Hub check: CloudForm ation.1 Supported Trusted Advisor checks Version May 08, 2025 397 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints AWSManagedServices-EnableCl oudFrontDistributionLogging • BucketName: The name of the Amazon S3 bucket where you Logging is enabled for Amazon CloudFront distributions. want to store access logs. • S3KeyPrefix: The preﬁx for the location in the S3 bucket for theAmazon CloudFront distribut ion logs. • IncludeCookies: Indicates whether to include cookies in access logs. To enable auto remediation, the following preconﬁgured parameters must be provided: • BucketName • S3KeyPrefix • IncludeCookies For this remediations constraints, see How do I turn on logging for my CloudFront distribution? AWSManagedServices-TrustedR emediatorEnableCloudTrailLo No preconﬁgured parameters are allowed. gValidation Enables CloudTrail trail log validatio n. No constraints Hs4Ma3G21 0 - CloudFron t distributions should have logging enabled Corresponding AWS Security Hub check: CloudFront.2 Hs4Ma3G109 - CloudTrail log ﬁle validatio n should be enabled Corresponding AWS Security Hub check: CloudTrail.4 Supported Trusted Advisor checks Version May 08, 2025 398 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G10 8 - CloudTrai l trails should be integrated with Amazon CloudWatch Logs Corresponding AWS Security Hub check: CloudTrail.5 AWSManagedServices-Integrat eCloudTrailWithCloudWatch • CloudWatchLogsLogGroupArn: The Amazon Resource Name AWS CloudTrail is integrated with CloudWatch Logs. (ARN) of an Amazon CloudWatch Logs log group. • CloudWatchLogsRoleArn: The ARN of an IAM role used by AWS CloudTrail to integrate with CloudWatch. To enable auto remediation, the following preconﬁgured parameters must be provided: • CloudWatchLogsLogGroupArn • CloudWatchLogsRoleArn Hs4Ma3G21 7 - CodeBuild AWSManagedServices-TrustedR emediatorEnableCodeBuildLog No preconﬁgured parameters are allowed. No constraints project gingConﬁg Enables the logging for CodeBuild project. environments should have a logging AWS conﬁguration Corresponding AWS Security Hub check: CodeBuild.4 Supported Trusted Advisor checks Version May 08, 2025 399 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G306 - Neptune DB AWSManagedServices-TrustedR emediatorDisablePublicAcces No preconﬁgured parameters are allowed. No constraints clusters should sOnDocumentDBSnapshot Removes public access from Amazon DocumentDB manual cluster snapshot. have deletion protection enabled Corresponding AWS Security Hub check: DocumentDB.3 Hs4Ma3G30 8 - Amazon AWSManagedServices-TrustedR emediatorEnableDocumentDBCl No preconﬁgured parameters are allowed. No constraints DocumentDB usterDeletionProtection Enables deletion protection for Amazon DocumentDB cluster. clusters should have deletion protection enabled Corresponding AWS Security Hub check: DocumentDB.5 Supported Trusted Advisor checks Version May 08, 2025 400 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G323 - DynamoDB AWSManagedServices-TrustedR emediatorEnableDynamoDBTabl No preconﬁgured parameters are allowed. tables should eDeletionProtection No constraints have deletion protection enabled Corresponding AWS Security Hub check: DynamoDB.6 ePs02jT06 w - Amazon EBS Public Snapshots Enables deletion protection for non- AMS DynamoDB tables. AWSManagedServices-TrustedR emediatorDisablePublicAcces No preconﬁgured parameters are allowed. sOnEBSSnapshot Public access for Amazon EBS snapshot is disabled. No constraints Hs4Ma3G118 - VPC default AWSManagedServices-TrustedR emediatorRemoveAllRulesFrom No preconﬁgured parameters are allowed. No constraints security groups DefaultSG All ingress and egress rules in the default security group are removed. should not allow inbound or outbound traﬃc Corresponding AWS Security Hub check: EC2.2 Supported Trusted Advisor checks Version May 08, 2025 401 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G117 - Attached EBS volumes should be encrypted at- rest Corresponding AWS Security Hub check: EC2.3 AWSManagedServices-EncryptI nstanceVolume • KMSKeyId: AWS KMS key ID or ARN to encrypt the volume. The attached Amazon EBS volume on the instance is encrypted. • DeleteStaleNonEncryptedSnap shotBackups: A ﬂag that decides whether the snapshot backup of the old unencrypted volumes should be deleted. The instance is rebooted as a part of the remediation and rollback is possible if DeleteStaleNonEncr is set yptedSnapshotBackups to false which helps with restore. Hs4Ma3G120 - Stopped EC2 AWSManagedServices-Terminat eInstance CreateAMIBeforeTermination:. To create the instance AMI as a backup Amazon EC2 instances stopped for 30 days are terminated. before terminating the EC2 instance, choose true. To not create a backup before terminating, choose false. The default is true. No constraints instances should be removed after a speciﬁed time period Corresponding AWS Security Hub check: EC2.4 Supported Trusted Advisor
accelerate-guide-129	accelerate-guide.pdf	129	the snapshot backup of the old unencrypted volumes should be deleted. The instance is rebooted as a part of the remediation and rollback is possible if DeleteStaleNonEncr is set yptedSnapshotBackups to false which helps with restore. Hs4Ma3G120 - Stopped EC2 AWSManagedServices-Terminat eInstance CreateAMIBeforeTermination:. To create the instance AMI as a backup Amazon EC2 instances stopped for 30 days are terminated. before terminating the EC2 instance, choose true. To not create a backup before terminating, choose false. The default is true. No constraints instances should be removed after a speciﬁed time period Corresponding AWS Security Hub check: EC2.4 Supported Trusted Advisor checks Version May 08, 2025 402 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G121 - EBS default AWSManagedServices-EncryptE BSByDefault No preconﬁgured parameters are allowed. Amazon EBS encryption by default is Encryption by default is a Region- enabled for the speciﬁc AWS Region speciﬁc setting. If you enable it for encryption should be enabled Corresponding AWS Security Hub check: EC2.7 Hs4Ma3G124 - Amazon EC2 AWSManagedServices-TrustedR emediatorEnableEC2InstanceI instances should MDSv2 Amazon EC2 instances use Instance Metadata Service Version 2 (IMDSv2). use Instance Metadata Service Version 2 (IMDSv2) Corresponding AWS Security Hub check: EC2.8 a Region, you can't disable it for individual volumes or snapshots in that Region. • IMDSv1MetricCheckPeriod: The number of days (42-455) to analyze IMDSv1 usage metrics in CloudWatch. If the Amazon EC2 instance was created within the speciﬁed time period, then the analysis begins from the instance's creation date. • HttpPutResponseHopLimit: The maximum number of network hops allowed for the instance metadata token. This value can be conﬁgured between 1 and 2 hops. A hop limit of 1 restricts token access to processes running directly on the instance, while a hop limit of 2 allows access from containers running on the instance. No constraints Supported Trusted Advisor checks Version May 08, 2025 403 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints AWSManagedServices-UpdateAu toAssignPublicIpv4Addresses No preconﬁgured parameters are allowed. VPC subnets are conﬁgured to No constraints not automatically assign public IP addresses. Hs4Ma3G207 - EC2 subnets should not automatically assign public IP addresses Corresponding AWS Security Hub check: EC2.15 Hs4Ma3G20 9 - Unused AWSManagedServices-DeleteUn usedNACL No preconﬁgured parameters are allowed. Delete unused network ACL No constraints AWSManagedServices-DeleteSe curityGroups No preconﬁgured parameters are allowed. Delete unused security groups. No constraints Network Access Control Lists are removed Corresponding AWS Security Hub check: EC2.16 Hs4Ma3G215 - Unused Amazon EC2 security groups should be removed Corresponding AWS Security Hub check: EC2.22 Supported Trusted Advisor checks Version May 08, 2025 404 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G24 7 - Amazon EC2 Transit Gateway should AWSManagedServices-TrustedR emediatorDisableTGWAutoVPCA ttach - Disables the automatic acceptance of VPC attachment not automatic requests for the speciﬁed non-AMS ally accept VPC Amazon EC2 Transit Gateway. No preconﬁgured parameters are allowed. No constraints attachment requests Corresponding AWS Security Hub check: EC2.23 Hs4Ma3G235 - ECR private AWSManagedServices-TrustedR emediatorSetImageTagImmutab No preconﬁgured parameters are allowed. No constraints repositories ility Sets the image tag mutability settings to IMMUTABLE for the speciﬁed repository. should have tag immutability conﬁgured Corresponding AWS Security Hub check: ECR.2 Supported Trusted Advisor checks Version May 08, 2025 405 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints AWSManagedServices-PutECRRe positoryLifecyclePolicy LifecyclePolicyText: The JSON repository policy text to apply to the ECR repository has a lifecycle policy conﬁgured. repository. To enable auto remediation, the following preconﬁgured parameters must be provided: LifecyclePolicyText AWSManagedServices-TrustedR emediatorEnableEKSAuditLog No preconﬁgured parameters are allowed. Audit log is enabled for EKS cluster. No constraints AWSConﬁgRemediation-DropIn validHeadersForALB No preconﬁgured parameters are allowed. Application Load Balancer is conﬁgured to invalid header ﬁelds. No constraints Hs4Ma3G216 - ECR repositor ies should have at least one lifecycle policy conﬁgured Corresponding AWS Security Hub check: ECR.3 Hs4Ma3G325 - EKS clusters should have audit logging enabled Corresponding AWS Security Hub check: EKS.8 Hs4Ma3G183 - Application load balancer should be conﬁgured to drop HTTP headers Corresponding AWS Security Hub check: ELB.4 Supported Trusted Advisor checks Version May 08, 2025 406 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints AWSManagedServices-EnableEL BLogging Application Load Balancer and Classic Load Balancer logging is enabled. • BucketName: The bucket name (not the ARN). Make sure that the bucket policy is correctly conﬁgure d for logging. • S3KeyPrefix: The preﬁx for the location in the Amazon S3 bucket for the Elastic Load Balancing logs. To enable auto remediation, the following preconﬁgured
accelerate-guide-130	accelerate-guide.pdf	130	to drop HTTP headers Corresponding AWS Security Hub check: ELB.4 Supported Trusted Advisor checks Version May 08, 2025 406 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints AWSManagedServices-EnableEL BLogging Application Load Balancer and Classic Load Balancer logging is enabled. • BucketName: The bucket name (not the ARN). Make sure that the bucket policy is correctly conﬁgure d for logging. • S3KeyPrefix: The preﬁx for the location in the Amazon S3 bucket for the Elastic Load Balancing logs. To enable auto remediation, the following preconﬁgured parameter s must be provided: BucketName and S3KeyPrefix:. Make sure the Amazon S3 bucket has a bucket policy that grants Elastic Load Balancing permission to write the access logs to the bucket. AWSManagedServices-TrustedR emediatorEnableEMRBlockPubl No preconﬁgured parameters are allowed. icAccess Amazon EMR block public access settings is turned on for the account. No constraints Hs4Ma3G184 - Application Load Balancers and Classic Load Balancers logging should be enabled Corresponding AWS Security Hub check: ELB.5 Hs4Ma3G32 6 - Amazon EMR block public access setting should be enabled Corresponding AWS Security Hub check: EMR.2 Supported Trusted Advisor checks Version May 08, 2025 407 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints AWSManagedServices-CancelKe yDeletion No preconﬁgured parameters are allowed. AWS KMS key deletion is canceled. No constraints Hs4Ma3G13 5 - AWS KMS keys should not be deleted unintentionally Corresponding AWS Security Hub check: KMS.3 Hs4Ma3G29 9 - Amazon AWSManagedServices-TrustedR emediatorEnableNeptuneDBClu No preconﬁgured parameters are allowed. No constraints DocumentDB sterDeletionProtection Enables deletion protection for Amazon Neptune cluster. manual cluster snapshots should not be public Corresponding AWS Security Hub check: Neptune.4 Supported Trusted Advisor checks Version May 08, 2025 408 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G319 - Network Firewall ﬁrewalls should have deletion AWSManagedServices-TrustedR emediatorEnableNetworkFirew allDeletionProtection - Enables the delete protection for AWS Network No preconﬁgured parameters are allowed. No constraints protection enabled Firewall. Corresponding AWS Security Hub check: NetworkFi rewall.9 Hs4Ma3G223 - OpenSearch domains should encrypt data sent between nodes Corresponding AWS Security Hub check: OpenSearch.3 AWSManagedServices-EnableOp enSearchNodeToNodeEncryption No preconﬁgured parameters are allowed. Node to Node encryption is enabled After node-to-node encryption for the domain. is enabled, you can't disable the setting. Instead, take a manual snapshot of the encrypted domain, create another domain, migrate your data, and then delete the old domain. Supported Trusted Advisor checks Version May 08, 2025 409 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G222 - OpenSearch domain error logging to CloudWatch Logs should be enabled Corresponding AWS Security Hub check: Opensearch.4 Hs4Ma3G221 - OpenSearch domains should have audit logging enabled Corresponding AWS Security Hub check: Opensearch.5 AWSManagedServices-EnableOp enSearchLogging CloudWatchLogGroupArn: The ARN of anAmazon CloudWatch Logs log Error logging is enabled for the group. OpenSearch domain. To enable auto remediation, the following preconﬁgured parameter must be provided: CloudWatc hLogGroupArn. Amazon CloudWatch resource policy must be conﬁgured with permissions. For more informati on, see Enabling audit logs in the Amazon OpenSearch Service User Guide AWSManagedServices-EnableOp enSearchLogging CloudWatchLogGroupArn: The ARN of the CloudWatch Logs group to OpenSearch domains are conﬁgured publish logs to. with audit logging enabled. To enable auto remediation, the following preconﬁgured parameter must be provided: CloudWatc hLogGroupArn Amazon CloudWatch resource policy must be conﬁgured with permissions. For more informati on, see Enabling audit logs in the Amazon OpenSearch Service User Guide Supported Trusted Advisor checks Version May 08, 2025 410 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G220 - Connections AWSManagedServices-EnableOp enSearchEndpointEncryptionT No preconﬁgured parameters are allowed. to OpenSearch LS1.2 domains should be encrypted using TLS 1.2 TLS policy is set to `Policy-M domains are required to use TLS 1.2. in-TLS-1-2-2019-07` and only Encrypting data in transit can aﬀect encrypted connections over HTTPS performance. Test your applications Connections to OpenSearch Corresponding (TLS) are allowed. AWS Security Hub check: Opensearch.8 with this feature to understand the performance proﬁle and the impact of TLS. Hs4Ma3G194 - Amazon RDS AWSManagedServices-DisableP ublicAccessOnRDSSnapshotV2 No preconﬁgured parameters are allowed. Public access for Amazon RDS No constraints snapshot is disabled. snapshot should be private Corresponding AWS Security Hub check: RDS.1 Supported Trusted Advisor checks Version May 08, 2025 411 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G19 2 - RDS DB AWSManagedServices-TrustedR emediatorDisablePublicAcces No preconﬁgured parameters are allowed. No constraints Instances should sOnRDSInstance Disable public access on RDS DB instance.
accelerate-guide-131	accelerate-guide.pdf	131	this feature to understand the performance proﬁle and the impact of TLS. Hs4Ma3G194 - Amazon RDS AWSManagedServices-DisableP ublicAccessOnRDSSnapshotV2 No preconﬁgured parameters are allowed. Public access for Amazon RDS No constraints snapshot is disabled. snapshot should be private Corresponding AWS Security Hub check: RDS.1 Supported Trusted Advisor checks Version May 08, 2025 411 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G19 2 - RDS DB AWSManagedServices-TrustedR emediatorDisablePublicAcces No preconﬁgured parameters are allowed. No constraints Instances should sOnRDSInstance Disable public access on RDS DB instance. prohibit public access, as determined by the PubliclyA ccessible AWS Conﬁguration Corresponding AWS Security Hub check: RDS.2 Supported Trusted Advisor checks Version May 08, 2025 412 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G18 9 - Enhanced AWSManagedServices-TrustedR emediatorEnableRDSEnhancedM • MonitoringInterval: The interval, in seconds, between points when monitoring are onitoring Enable enhanced monitoring for Amazon RDS DB instances conﬁgured for Amazon RDS DB instances Corresponding AWS Security Hub check: RDS.6 Enhanced Monitoring metrics are collected for the DB instance. Valid intervals are 0, 1, 5, 10, 15, 30 and 60. To disable collectin g Enhanced Monitoring metrics, specify 0. • MonitoringRoleName: The name of the IAM role that permits Amazon RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. If a role isn't speciﬁed, then the default role rds-monitoring-role is used or created, if it doesn't exist. If enhanced monitoring is enabled before the automation execution, then the settings might be overwritt en by this automation with the MonitoringInterval and Monitorin gRoleName values conﬁgured in the preconﬁgured parameters. Supported Trusted Advisor checks Version May 08, 2025 413 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G190 - Amazon RDS AWSManagedServices-TrustedR emediatorEnableRDSDeletionP No preconﬁgured parameters are allowed. No constraints clusters should rotection Deletion protection is enabled for Amazon RDS clusters. have deletion protection enabled Corresponding AWS Security Hub check: RDS.7 Hs4Ma3G198 - Amazon RDS DB AWSManagedServices-TrustedR emediatorEnableRDSDeletionP No preconﬁgured parameters are allowed. instances should rotection No constraints Deletion protection is enabled for Amazon RDS instances. AWSManagedServices-TrustedR emediatorEnableRDSLogExports No preconﬁgured parameters are allowed. RDS log exports is enabled for the RDS DB instance or RDS DB cluster. Service-linked role AWSServic eRoleForRDS is required. have deletion protection enabled Corresponding AWS Security Hub check: RDS.8 Hs4Ma3G19 9 - RDS DB instances should publish logs to CloudWatch Logs Corresponding AWS Security Hub check: RDS.9 Supported Trusted Advisor checks Version May 08, 2025 414 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints AWSManagedServices-UpdateRD SIAMDatabaseAuthentication ApplyImmediately: Indicates if the modiﬁcations in this request AWS Identity and Access Management authentication is enabled for the RDS instance. and any pending modiﬁcations are asynchronously applied as soon as possible, To apply the change immediately, choose true. To schedule the change for the next maintenance window, choose false. No constraints AWSManagedServices-UpdateRD SIAMDatabaseAuthentication ApplyImmediately: Indicates if the modiﬁcations in this request IAM authentication is enabled for the RDS cluster. and any pending modiﬁcations are asynchronously applied as soon as possible, To apply the change immediately, choose true. To schedule the change for the next maintenance window, choose false. No constraints AWSManagedServices-UpdateRD SInstanceMinorVersionUpgrade No preconﬁgured parameters are allowed. Automatic minor version upgrade conﬁguration for Amazon RDS is enabled. The Amazon RDS instance must be in the available state for this remediation to happen. Hs4Ma3G160 - IAM authentic ation should be conﬁgured for RDS instances Corresponding AWS Security Hub check: RDS.10 Hs4Ma3G161 - IAM authentic ation should be conﬁgured for RDS clusters Corresponding AWS Security Hub check: RDS.12 Hs4Ma3G162 - RDS automatic minor version upgrades should be enabled Corresponding AWS Security Hub check: RDS.13 Supported Trusted Advisor checks Version May 08, 2025 415 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints AWSManagedServices-UpdateRD SCopyTagsToSnapshots No preconﬁgured parameters are allowed. CopyTagtosnapshot setting for Amazon RDS clusters is enabled. Amazon RDS instances must be in available state for this remediation to happen. Hs4Ma3G16 3 - RDS DB clusters should be conﬁgured to copy tags to snapshots Corresponding AWS Security Hub check: RDS.16 Hs4Ma3G16 4 - RDS DB AWSManagedServices-UpdateRD SCopyTagsToSnapshots No preconﬁgured parameters are allowed. instances should be conﬁgured to copy tags to snapshots Corresponding AWS Security Hub check: RDS.17 rSs93HQwa1 Amazon RDS Public Snapshots CopyTagsToSnapshot for Amazon RDS is enabled. setting Amazon RDS instances must be in available state for this remediation to happen. AWSManagedServices-DisableP ublicAccessOnRDSSnapshotV2 No preconﬁgured parameters are allowed. Public access for Amazon RDS snapshot is disabled. No
accelerate-guide-132	accelerate-guide.pdf	132	RDS instances must be in available state for this remediation to happen. Hs4Ma3G16 3 - RDS DB clusters should be conﬁgured to copy tags to snapshots Corresponding AWS Security Hub check: RDS.16 Hs4Ma3G16 4 - RDS DB AWSManagedServices-UpdateRD SCopyTagsToSnapshots No preconﬁgured parameters are allowed. instances should be conﬁgured to copy tags to snapshots Corresponding AWS Security Hub check: RDS.17 rSs93HQwa1 Amazon RDS Public Snapshots CopyTagsToSnapshot for Amazon RDS is enabled. setting Amazon RDS instances must be in available state for this remediation to happen. AWSManagedServices-DisableP ublicAccessOnRDSSnapshotV2 No preconﬁgured parameters are allowed. Public access for Amazon RDS snapshot is disabled. No constraints Supported Trusted Advisor checks Version May 08, 2025 416 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G10 3 - Amazon AWSManagedServices-DisableP ublicAccessOnRedshiftCluster No preconﬁgured parameters are allowed. Redshift clusters should prohibit public access Corresponding AWS Security Hub check: Redshift.1 Public access on Amazon Redshift Disabling public access blocks all cluster is disabled. clients coming from the internet. And the Amazon Redshift cluster is in the modifying state for a few minutes while the remediation disables public access on the cluster. Hs4Ma3G10 6 - Amazon AWSManagedServices-TrustedR emediatorEnableRedshiftClus No preconﬁgured parameters are allowed. Redshift clusters terAuditLogging should have audit logging enabled Corresponding AWS Security Hub check: Redshift.4 To enable auto remediation, the Audit logging is enabled to your following preconﬁgured parameters Amazon Redshift cluster during the must be provided. maintenance window. BucketName: The bucket must be in the same AWS Region. The cluster must have read bucket and put object permissions. If Redshift cluster logging is enabled before the automation execution , then the logging settings might be overwritten by this automatio n with the BucketName and S3KeyPrefix values conﬁgured in the preconﬁgured parameters. Supported Trusted Advisor checks Version May 08, 2025 417 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints No preconﬁgured parameters are allowed. No constraints Hs4Ma3G10 5 - Amazon Redshiftshould AWSManagedServices-EnableRe dshiftClusterVersionAutoUpgrade - Major version upgrades are applied have automatic automatically to the cluster during upgrades to the maintenance window. There is major versions no immediate downtime for the enabled Amazon Redshift cluster, but your Corresponding AWS Security Hub check: Redshift.6 Amazon Redshift cluster might have downtime during its maintenance window if it upgrades to a major version. Hs4Ma3G10 4 - Amazon AWSManagedServices-TrustedR emediatorEnableRedshiftClus No preconﬁgured parameters are allowed. Redshift clusters terEnhancedVPCRouting No constraints should use enhanced VPC routing Corresponding AWS Security Hub check: Redshift.7 Hs4Ma3G17 3 - S3 Block Public Access setting should be enabled at the bucket-level Corresponding AWS Security Hub check: S3.8 Enhanced VPC routing is enabled for Amazon Redshift clusters. AWSManagedServices-TrustedR emediatorBlockS3BucketPubli No preconﬁgured parameters are allowed. cAccess Bucket-level public access blocks are applied for the Amazon S3 bucket. This remediation might aﬀect S3 object availability. For information on how Amazon S3 evaluates access, see Blocking public access to your Amazon S3 storage. Supported Trusted Advisor checks Version May 08, 2025 418 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Hs4Ma3G23 0 - S3 bucket server access logging should be enabled Corresponding AWS Security Hub check: S3.9 AWSManagedServices-EnableBu cketAccessLogging • TargetBucket: The name of S3 bucket to store server access logs. Amazon S3 server access logging is enabled. • TargetObjectKeyFormat: Amazon S3 key format for log objects, to use the simple format for S3 keys for log objects, chooseSimplePre fix . To use Partitioned S3 key for log objects and use EventTime for the partitioned preﬁx, choose PartitionedPrefixE ventTime . To use Partitioned S3 key for log objects and use DeliveryTime for the partition ed preﬁx, choose Partition . edPrefixDeliveryTime Valid values are SimplePre fix , PartitionedPrefixE ventTime and Partition edPrefixDeliveryTime (case-sensitive). To enable auto remediation, the following preconﬁgured parameter must be provided: TargetBucket. The destination bucket must be in the same AWS Region and AWS account as the source bucket, with correct permissions for log delivery. For more information, see Enabling Amazon S3 server access logging. Supported Trusted Advisor checks Version May 08, 2025 419 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints AWSManagedServices-TrustedR emediatorBlockS3BucketPubli No preconﬁgured parameters are allowed. Pfx0RwqBli Amazon S3 Bucket Permissio cAccess ns Block public access This check consists of multiple alert criteria. This automation remediates public access issues. Remediation for other conﬁguration issues ﬂagged by Trusted Advisor isn't supported . This remediation does support remediating AWS service created S3 buckets (for example, cf-templa tes-000000000000). Hs4Ma3G272 - Users should not AWSManagedServices-TrustedR emediatorDisableSageMakerNo No preconﬁgured parameters are allowed. have root access tebookInstanceRootAccess Root access for
accelerate-guide-133	accelerate-guide.pdf	133	419 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints AWSManagedServices-TrustedR emediatorBlockS3BucketPubli No preconﬁgured parameters are allowed. Pfx0RwqBli Amazon S3 Bucket Permissio cAccess ns Block public access This check consists of multiple alert criteria. This automation remediates public access issues. Remediation for other conﬁguration issues ﬂagged by Trusted Advisor isn't supported . This remediation does support remediating AWS service created S3 buckets (for example, cf-templa tes-000000000000). Hs4Ma3G272 - Users should not AWSManagedServices-TrustedR emediatorDisableSageMakerNo No preconﬁgured parameters are allowed. have root access tebookInstanceRootAccess Root access for users is disabled for the SageMaker notebook instance is SageMaker notebook instance. in the InService state. This remediation causes outage if to SageMaker notebook instances Corresponding AWS Security Hub check: SageMaker.3 Supported Trusted Advisor checks Version May 08, 2025 420 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints AWSManagedServices-EnableSN SEncryptionAtRest KmsKeyId: The ID of an AWS managed customer master key SNS topic is conﬁgured with server- side encryption. Hs4Ma3G17 9 - SNS topics should be encrypted at- rest using AWS KMS Corresponding AWS Security Hub check: SNS.1 (CMK) for Amazon SNS or a custom CMK to be used for server-side encryption (SSE). Default is set to alias/aws/sns . If a custom AWS KMS key is used, it must be conﬁgured with the correct permissions. For more information, see Enabling server-side encryption (SSE) for an Amazon SNS topic No preconﬁgured parameters are allowed. No constraints Hs4Ma3G158 - SSM documents should not be public AWSManagedServices-TrustedR emediatorDisableSSMDocPubli cSharing - Disables the public sharing of SSM document. Corresponding AWS Security Hub check: SSM.4 Supported Trusted Advisor checks Version May 08, 2025 421 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints AWSManagedServices-EnableSQ SEncryptionAtRest Messages in Amazon SQS are encrypted. Hs4Ma3G136 - Amazon SQS queues should be encrypted at rest Corresponding AWS Security Hub check: SQS.1 • SqsManagedSseEnabled: Set to true to enable server-side queue encryption using Amazon SQS owned encryption keys, set to false to enable server-side queue encryption using an AWS KMS key. • KMSKeyId: The ID or alias of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK to be used for server- side encryption for the queue. If not provided, alias/aws/sqs is used. • KmsDataKeyReusePeriodSecond s: The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). This setting is ignored if SqsManagedSseEnabled is set to true. Anonymous SendMessage and ReceiveMessage requests to the encrypted queue are rejected. All requests to queues with SSE enabled must use HTTPS and Signature Version 4. Supported Trusted Advisor checks Version May 08, 2025 422 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Trusted Advisor fault tolerance checks supported by Trusted Remediator Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints c18d2gz138 Amazon AWSManagedServices-TrustedR emediatorEnableDDBPITR No preconﬁgured parameters are allowed. DynamoDB Enables point-in-time recovery for No constraints Point-in-time DynamoDB tables. Recovery R365s2Qddf Amazon S3 AWSManagedServices-TrustedR emediatorEnableBucketVersioning No preconﬁgured parameters are allowed. Bucket Versionin Amazon S3 bucket versioning is This remediation doesn't support g enabled. remediating AWS service created S3 buckets (for example cf-templa tes-000000000000). BueAdJ7NrP Amazon S3 AWSManagedServices-EnableBu cketAccessLogging • TargetBucket: The name of the S3 bucket to store server access logs. Bucket Logging Amazon S3 bucket logging is enabled. • TargetObjectKeyFormat: Amazon S3 key format for log objects, to use the simple format for S3 keys for log objects, chooseSimplePre fix . To use Partitioned S3 key for log objects and use EventTime for the partitioned preﬁx, choose PartitionedPrefixE ventTime . To use Partitioned S3 key for log objects and use DeliveryTime for the partition ed preﬁx, choose Partition edPrefixDeliveryTi me . The default is Partition edPrefixEventTime . Supported Trusted Advisor checks Version May 08, 2025 423 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints Valid values are SimplePre fix , PartitionedPrefixE ventTime and Partition edPrefixDeliveryTime (case-sensitive). To enable auto remediation, the following preconﬁgured parameters must be provided: • TargetBucket The destination bucket must be in the same AWS Region and AWS account as the source bucket, with correct permissions for log delivery. For more information, see Enabling Amazon S3 server access logging. f2iK5R6Dep Amazon RDS AWSManagedServices-TrustedR emediatorEnableRDSMultiAZ No preconﬁgured parameters are allowed. Multi-AZ Multi-Availability Zone deployment There is a possible performance is enabled. degradation during this change. H7IgTzjTYb Amazon EBS Snapshots AWSManagedServices-TrustedR emediatorCreateEBSSnapshot No preconﬁgured parameters
accelerate-guide-134	accelerate-guide.pdf	134	and expected outcome Supported preconﬁgured parameters and constraints Valid values are SimplePre fix , PartitionedPrefixE ventTime and Partition edPrefixDeliveryTime (case-sensitive). To enable auto remediation, the following preconﬁgured parameters must be provided: • TargetBucket The destination bucket must be in the same AWS Region and AWS account as the source bucket, with correct permissions for log delivery. For more information, see Enabling Amazon S3 server access logging. f2iK5R6Dep Amazon RDS AWSManagedServices-TrustedR emediatorEnableRDSMultiAZ No preconﬁgured parameters are allowed. Multi-AZ Multi-Availability Zone deployment There is a possible performance is enabled. degradation during this change. H7IgTzjTYb Amazon EBS Snapshots AWSManagedServices-TrustedR emediatorCreateEBSSnapshot No preconﬁgured parameters are allowed. Amazon EBSsnapshots are created. No constraints Supported Trusted Advisor checks Version May 08, 2025 424 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints opQPADkZvH RDS Backups AWSManagedServices-EnableRD SBackupRetention • BackupRetentionPeriod: The number of days (1-35) to retain Amazon RDS backup retention is enabled for the DB. automated backups. • ApplyImmediately: Indicates if the RDS backup retention change and any pending modiﬁcations are asynchronously applied as soon as possible. Choose true to apply the change immediately, or false to schedule the change for the next maintenance window. If the ApplyImmediately parameter is set to true, the pending changes on the db are applied along with RDSBackup retention setting. Supported Trusted Advisor checks Version May 08, 2025 425 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints c1qf5bt013 Amazon RDS DB instances have storage autoscali ng turned oﬀ AWSManagedServices-TrustedR emediatorEnableRDSInstanceS torageAutoScaling - Storage autoscaling is enabled for Amazon • MaxAllocatedStorageIncrease Percentage: The increase percentage of the current AllocatedStorage, to set the RDS DB instance. MaxAllocatedStorage. Default is set to 26. You must set the maximumst orage threshold to at least 10% more than the current allocated storage. It's a best practice to set the maximumstorage threshold to at least 26% more. For details, check Managing capacity automatically with Amazon Relational Database Service storage autoscaling. No constraints 7qGXsKIUw Classic Load Balancer Connection Draining AWSManagedServices-TrustedR emediatorEnableCLBConnectio ConnectionDrainingTimeout: The maximum time, in seconds, to nDraining Connection draining is enabled for Classic Load Balancer. keep the existing connections open before deregistering the instances. Default is set to 300 seconds. No constraints Supported Trusted Advisor checks Version May 08, 2025 426 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints c18d2gz106 Amazon EBS Not Included in AWS AWSManagedServices-TrustedR emediatorAddVolumeToBackupP Remediation tags the Amazon EBS volume with the following tag pair. lan The tag pair must match the tag- based resource selection criteria for Backup Plan Amazon EBS is included in AWS Backup Plan. AWS Backup. • TagKey • TagValue No constraints AWSManagedServices-TrustedR emediatorAddDynamoDBToBacku Remediation tags the Amazon DynamoDB with the following tag c18d2gz107 Amazon DynamoDB Table Not pPlan Amazon DynamoDB Table is Included in AWS included in AWS Backup Plan. Backup Plan pair. The tag pair must match the tag-based resource selection criteria for AWS Backup. • TagKey • TagValue No constraints c18d2gz117 Amazon EFS Not Included in AWS Backup Plan AWSManagedServices-TrustedR emediatorAddEFSToBackupPlan Remediation tags the Amazon EFS with the following tag pair. The Amazon EFS is included in AWS Backup Plan. tag pair must match the tag-based resource selection criteria for AWS Backup. • TagKey • TagValue No constraints Supported Trusted Advisor checks Version May 08, 2025 427 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints c18d2gz105 Network Load Balancers Cross AWSManagedServices-TrustedR emediatorEnableNLBCrossZone No preconﬁgured parameters are allowed. LoadBalancing No constraints Load Balancing Cross-zone load balancing is enabled on Network Load Balancer. c1qf5bt026 Amazon RDS synchrono us_commit parameter is turned oﬀ c1qf5bt030 Amazon RDS innodb_fl ush_log_a t_trx_com mit parameter is not 1 c1qf5bt031 Amazon RDS sync_binlog parameter is turned oﬀ AWSManagedServices-TrustedR emediatorRemediateRDSParame No preconﬁgured parameters are allowed. terGroupParameter Parameter synchronous_commit is turned on for Amazon RDS. No constraints AWSManagedServices-TrustedR emediatorRemediateRDSParame No preconﬁgured parameters are allowed. terGroupParameter Parameter innodb_flush_log_a t_trx_commit Amazon RDS. is set to 1 for No constraints AWSManagedServices-TrustedR emediatorRemediateRDSParame No preconﬁgured parameters are allowed. terGroupParameter Parameter sync_binlog is turned on for Amazon RDS. No constraints Supported Trusted Advisor checks Version May 08, 2025 428 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints c1qf5bt036 Amazon RDS innodb_de fault_row _format parameter setting is unsafe c18d2gz144 Amazon EC2 Detailed AWSManagedServices-TrustedR emediatorRemediateRDSParame No preconﬁgured parameters are allowed. terGroupParameter Parameter innodb_default_row _format is set to DYNAMIC for Amazon RDS. No constraints AWSManagedServices-TrustedR emediatorEnableEC2InstanceD etailedMonitoring No preconﬁgured parameters are allowed. No constraints Monitoring Not Detailed Monitoring is enabled for Enabled Amazon
accelerate-guide-135	accelerate-guide.pdf	135	parameters are allowed. terGroupParameter Parameter sync_binlog is turned on for Amazon RDS. No constraints Supported Trusted Advisor checks Version May 08, 2025 428 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints c1qf5bt036 Amazon RDS innodb_de fault_row _format parameter setting is unsafe c18d2gz144 Amazon EC2 Detailed AWSManagedServices-TrustedR emediatorRemediateRDSParame No preconﬁgured parameters are allowed. terGroupParameter Parameter innodb_default_row _format is set to DYNAMIC for Amazon RDS. No constraints AWSManagedServices-TrustedR emediatorEnableEC2InstanceD etailedMonitoring No preconﬁgured parameters are allowed. No constraints Monitoring Not Detailed Monitoring is enabled for Enabled Amazon EC2. Trusted Advisor performance checks supported by Trusted Remediator Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints COr6dfpM06 AWS Lambda under-pro visioned functions for memory size AWSManagedServices-ResizeLa mbdaMemory RecommendedMemorySize: The recommended memory allocatio Lambda functionss memory size are resized to the recommended memory size provided by Trusted Advisor. n for the Lambda function. Value range is between 128 and 10240. If Lambda function size is modiﬁed before the automation execution , then this automation might overwrite the settings with the value recommended by Trusted Advisor. ZRxQlPsb6c AWSManagedServices-ResizeIn stanceByOneLevel • MinimumDaysSinceLastChange: The minimum number of days Supported Trusted Advisor checks Version May 08, 2025 429 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints High Utilizati Amazon EC2 instances are resized since the last instance type on Amazon EC2 Instances by one instance type up in the same instance family type. The instances change. If the instance type was modiﬁed within the speciﬁed are stopped and started during the time, the instance type isn't resize operation and returned to the initial state after the execution is complete. This automation doesn't support resizing instances that are in an Auto Scaling Group. changed. Use 0 to skip this validation. The default is 7. • CreateAMIBeforeResize: To create the instance AMI as a backup before resizing, choose true. To not create a backup, choose false. The default is false. Valid values are true and false (case- sensitive). • ResizeIfStopped: To proceed with the instance size change, even if the instance is in a stopped state, choose true. To not automatically resize the instance if in a stopped state, choose false. Valid values are true and false (case-sen sitive). No constraints c1qf5bt021 Amazon RDS innodb_ch ange_buff ering parameter using less than optimum value AWSManagedServices-TrustedR emediatorRemediateRDSParame No preconﬁgured parameters are allowed. terGroupParameter The value of innodb_ch ange_buffering parameter is set to NONE for Amazon RDS. No constraints Supported Trusted Advisor checks Version May 08, 2025 430 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints c1qf5bt025 Amazon RDS autovacuum parameter is turned oﬀ c1qf5bt028 Amazon RDS enable_in dexonlysc an parameter is turned oﬀ c1qf5bt029 Amazon RDS enable_in dexscan parameter is turned oﬀ c1qf5bt032 Amazon RDS innodb_st ats_persi stent parameter is turned oﬀ AWSManagedServices-TrustedR emediatorRemediateRDSParame No preconﬁgured parameters are allowed. terGroupParameter Parameter autovacuum is turned on for Amazon RDS. No constraints AWSManagedServices-TrustedR emediatorRemediateRDSParame No preconﬁgured parameters are allowed. terGroupParameter Parameter enable_indexonlysc an is turned on for Amazon RDS. No constraints AWSManagedServices-TrustedR emediatorRemediateRDSParame No preconﬁgured parameters are allowed. terGroupParameter Parameter enable_indexscan is turned on for Amazon RDS. No constraints AWSManagedServices-TrustedR emediatorRemediateRDSParame No preconﬁgured parameters are allowed. terGroupParameter Parameter innodb_stats_persi stent is turned on for Amazon RDS. No constraints Supported Trusted Advisor checks Version May 08, 2025 431 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints c1qf5bt037 Amazon RDS general_l ogging parameter is turned on AWSManagedServices-TrustedR emediatorRemediateRDSParame No preconﬁgured parameters are allowed. terGroupParameter Parameter general_logging is turned oﬀ for Amazon RDS. No constraints Trusted Advisor service limits checks supported by Trusted Remediator Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints lN7RR0l7J9 EC2-VPC Elastic AWSManagedServices-UpdateVp cElasticIPQuota Increment: The number to increase the current quota. The default is 3. IP Address A new limit for EC2-VPC elastic IP If this automation is run multiple addresses are requested. By default, times before the Trusted Advisor the limit is be increased by 3. kM7QQ0l7J9 VPC Internet Gateways AWSManagedServices-Increase ServiceQuota - A new limit for VPC internet gateways are requested. By default, the limit is increased by three. check is updated with the OK status, then there might be a higher limit increase. Increment: The number to increase the current quota. The default is 3. If this automation is run multiple times before the Trusted Advisor check is updated with the OK status, then there might be a higher limit increase. jL7PP0l7J9 VPC AWSManagedServices-Increase ServiceQuota Increment: The number to increase the current quota. The
accelerate-guide-136	accelerate-guide.pdf	136	the Trusted Advisor the limit is be increased by 3. kM7QQ0l7J9 VPC Internet Gateways AWSManagedServices-Increase ServiceQuota - A new limit for VPC internet gateways are requested. By default, the limit is increased by three. check is updated with the OK status, then there might be a higher limit increase. Increment: The number to increase the current quota. The default is 3. If this automation is run multiple times before the Trusted Advisor check is updated with the OK status, then there might be a higher limit increase. jL7PP0l7J9 VPC AWSManagedServices-Increase ServiceQuota Increment: The number to increase the current quota. The default is 3. Supported Trusted Advisor checks Version May 08, 2025 432 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints A new limit for VPC is requested. By If this automation is run multiple default, the limit is increased by 3. times before the Trusted Advisor check is updated with the OK status, then there might be a higher limit increase. fW7HH0l7J9 Auto Scaling Groups 3Njm0DJQO9 RDS Option Groups AWSManagedServices-Increase ServiceQuota Increment: The number to increase the current quota. The default is 3. A new limit for Auto Scaling Groups If this automation is run multiple is requested. By default, the limit is times before the Trusted Advisor increased by 3. check is updated with the OK status, then there might be a higher limit increase. AWSManagedServices-Increase ServiceQuota Increment: The number to increase the current quota. The default is 3. A new limit for Amazon RDS option If this automation is run multiple groups is requested. By default, the times before the Trusted Advisor limit is increased by 3. check is updated with the OK status, then there might be a higher limit increase. EM8b3yLRTr ELB Application Load Balancers AWSManagedServices-Increase ServiceQuota Increment: The number to increase the current quota. The default is 3. A new limit for ELB Application Load Balancers is requested. By default, the limit is increased by 3. If this automation is run multiple times before the Trusted Advisor check is updated with the OK status, then there might be a higher limit increase. Supported Trusted Advisor checks Version May 08, 2025 433 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints 8wIqYSt25K ELB Network AWSManagedServices-Increase ServiceQuota Increment: The number to increase the current quota. The default is 3. Load Balancers A new limit for ELB Network Load If this automation is run multiple Balancers is requested. By default, times before the Trusted Advisor the limit is increased by 3. check is updated with the OK status, then there might be a higher limit increase. Trusted Advisor operational excellence checks supported by Trusted Remediator Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints c18d2gz125 Amazon API Gateway AWSManagedServices-TrustedR emediatorEnableAPIGateWayEx No preconﬁgured parameters are allowed. ecutionLogging You must grant API Gateway Not Logging Execution logging is enabled on the permission to read and write logs Execution Logs API stage. AWSManagedServices-TrustedR emediatorEnableELBDeletionP rotection - Deletion protection is turned on for the Elastic Load Balancer. c18d2gz168 Elastic Load Balancing Deletion Protection Not Enabled for Load Balancers to CloudWatch for your account in order to enable execution log, refer to Set up CloudWatch logging for REST APIs in API Gateway for detail. No preconﬁgured parameters are allowed. No constraints Supported Trusted Advisor checks Version May 08, 2025 434 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconﬁgured parameters and constraints c1qf5bt012 Amazon RDS Performan AWSManagedServices-TrustedR emediatorEnableRDSPerforman ceInsights • PerformanceInsightsRetentio nPeriod: The number of days to retain Performance Insights ce Insights is Performance Insights is turned on turned oﬀ for Amazon RDS. data. Valid Values: 7 or month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31) or 731. • PerformanceInsightsKMSKeyId: The AWS KMS key id for encryptio n of Performance Insights data. If you don’t specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default AWS KMS key. No constraints Conﬁgure Trusted Advisor check remediation in Trusted Remediator Conﬁgurations are stored in AWS AppConﬁg as part of the Trusted Remediator application. Each Trusted Advisor check category has a separate conﬁguration proﬁle. For more information on Trusted Advisor categories, see View check categories. You can conﬁgure remediations on a per-resource basis or per Trusted Advisor check basis. You can apply exceptions using resource tags. Note The remediation of Trusted Advisor ﬁndings is currently conﬁgured using AWS AppConﬁg, and this feature is fully supported today. AMS anticipates that this will change in the future.
accelerate-guide-137	accelerate-guide.pdf	137	uses your default AWS KMS key. No constraints Conﬁgure Trusted Advisor check remediation in Trusted Remediator Conﬁgurations are stored in AWS AppConﬁg as part of the Trusted Remediator application. Each Trusted Advisor check category has a separate conﬁguration proﬁle. For more information on Trusted Advisor categories, see View check categories. You can conﬁgure remediations on a per-resource basis or per Trusted Advisor check basis. You can apply exceptions using resource tags. Note The remediation of Trusted Advisor ﬁndings is currently conﬁgured using AWS AppConﬁg, and this feature is fully supported today. AMS anticipates that this will change in the future. It's a best practice to avoid building automations that depend on AWS AppConﬁg, as this method is subject to change. Be aware that you might need to update or modify Conﬁgure check remediation Version May 08, 2025 435 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures automations built around the current AWS AppConﬁg implementation in the future for compatibility. Default remediation conﬁgurations The conﬁgurations for individual Trusted Advisor checks are stored as AWS AppConﬁg ﬂags. The ﬂag name matches the check name. Each check conﬁguration contains the following attributes: • execution-mode: Determines how Trusted Remediator performs default remediation: • Automated: Trusted Remediator automatically remediates resources by creating an OpsItem, running the SSM document, and then resolving the OpsItem after successful execution. • Manual: An OpsItem is created, but the SSM document isn't executed automatically. You review and manually run the SSM document from the OpsItem in the AWS Systems Manager OpsCenter console. • Conditional: Remediation is disabled by default. You can enable it for speciﬁc resources using tags. For more information, see the following sections Customize remediation with resource tags and Customize remediation with resource override tags. • Inactive: Remediation doesn't occur and no OpsItem are created. You can't override the execution mode for the Trusted Advisor check that's set to inactive. • preconﬁgured-parameters: Enter values for SSM document parameters that are required for automated remediation. • alternative-automation-document: This attribute helps override the existing automation document with another supported document (if available for the speciﬁc check). By default, this attribute isn't selected. For information on supported checks and the automation documents, see Trusted Advisor checks supported by Trusted Remediator Note The alternative-automation-document attribute doesn't support custom automation documents. You can use existing supported Trusted Remediator automation documents. Conﬁgure check remediation Version May 08, 2025 436 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Tip Before you apply the default conﬁgurations for your Trusted Advisor checks, it's a best practice to consider using the Resource tagging and Resource override features described in the following sections. The default conﬁgurations apply to all resources within the account, which might not be desirable in all cases. The following is an example console screenshot with the execution-mode set to Manual. Customize remediation with resource tags The automated-for-tagged-only and manual-for-tagged-only attributes in the check conﬁguration allow you to specify resource tags for how you want to remediate individual checks. Conﬁgure check remediation Version May 08, 2025 437 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures It's a best practice to use this method when you need to apply a consistent remediation behavior to a group of resources that share the same tag or tags. The following are descriptions for these tags: • automated-for-tagged-only: Specify resource tags for checks to remediate automatically, regardless of the default execution mode. • manual-for-tagged-only: Specify resource tags for remediations that should be executed manually, regardless of the default execution mode. For example, if you want to enable automated remediation for all non-production resources and enforce manual remediation for production resources, you might set your conﬁguration as follows: "execution-mode": "Conditional", "automated-for-tagged-only": "Environment=Non-Production", "manual-for-tagged-only": "Environment=Production", With the preceding conﬁgurations set on your resources, check remediation behavior is as follows: • Resources tagged with `Environment=Non-Production` are remediated automatically. • Resources tagged with `Environment=Production` require manual intervention for remediation. • Resources without the `Environment` tag follow the default execution mode (`Conditional`, in this case. So, no actions is taken on the remaining resources). For additional support with your conﬁgurations, contact your Cloud Architect. Customize remediation with resource override tags Resource override tags allow you to customize the remediation behavior for individual resources, regardless of their tags. By adding a speciﬁc tag to a resource, you override the default execution mode for that resource and the Trusted Advisor check. The resource override tag takes precedence over the default conﬁguration and the resource tagging settings. So, if you set the default execution mode to Automated, Manual, or Conditional for a resource using the resource override tag, it overrides the default execution mode and any resource tagging conﬁgurations. To override the execution mode for a resource, complete the following steps: 1. Identify the resources for which you want to override the remediation conﬁguration. Conﬁgure check
accelerate-guide-138	accelerate-guide.pdf	138	regardless of their tags. By adding a speciﬁc tag to a resource, you override the default execution mode for that resource and the Trusted Advisor check. The resource override tag takes precedence over the default conﬁguration and the resource tagging settings. So, if you set the default execution mode to Automated, Manual, or Conditional for a resource using the resource override tag, it overrides the default execution mode and any resource tagging conﬁgurations. To override the execution mode for a resource, complete the following steps: 1. Identify the resources for which you want to override the remediation conﬁguration. Conﬁgure check remediation Version May 08, 2025 438 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 2. Determine the Trusted Advisor check ID for the check that you want to override. You can ﬁnd the check IDs for supported Trusted Advisor checks in Trusted Advisor checks supported by Trusted Remediator. 3. Add a tag to the resources with the following key and value: • Tag key: TR-Trusted Advisor check ID-Execution-Mode (case-sensitive) In the preceding tag key example, replace Trusted Advisor check ID with the unique identiﬁed of the Trusted Advisor check that you want to override. • Tag value: Use one of the following values for the tag value: • Automated: Trusted Remediator automatically remediates the resource for this Trusted Advisor check. • Manual: An OpsItem is created for the resource, but remediation isn't performed automatically. You review and run the remediation manually from the OpsItem. • Inactive: Remediation and OpsItem creation isn't performed for this resource and the speciﬁed Trusted Advisor check. For example, to automatically remediate an Amazon EBS volume with the Trusted Advisor check ID DAvU99Dc4C add a tag to the EBS volume. The tag key is TR-DAvU99Dc4C-Execution-Mode and the tag value is Automated. The following is an example of the console showing the Tags section: Execution mode decision workﬂow There are multiple levels to conﬁgure execution mode for your resources and each Trusted Advisor check. The following diagram shows how Trusted Remediator decides which execution mode to use based on your conﬁgurations: Execution mode decision workﬂow Version May 08, 2025 439 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Execution mode decision workﬂow Version May 08, 2025 440 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Conﬁgure remediation tutorials The following tutorials provide examples of creating common remediations in Trusted Remediator Topics • Remediate all resources manually • Remediate all resources automatically, except for selected resources • Remediate tagged resources automatically Remediate all resources manually This example conﬁgures manual remediation for all Amazon EBS volumes with the Trusted Advisor check ID DAvU99Dc4C (Underutilized Amazon EBS Volumes). Conﬁgure manual remediation for Amazon EBS volumes with check ID DAvU99Dc4C 1. Open the AWS AppConﬁg console at https://console.aws.amazon.com/systems-manager/ appconﬁg. Make sure that you sign in as the Delegated Administrator account. 2. Select Trusted Remediator from the list of applications. 3. Choose the Cost Optimization conﬁguration proﬁle. 4. 5. Select the Underutilized Amazon EBS Volumes ﬂag. For execution-mode, select Manual. 6. Make sure that the automated-for-tagged-only and manual-for-tagged-only attributes are blank. These attributes are used to override the default execution-mode for resources with matching tags. The following is an example of the Attributes section with blank values for automated-for- tagged-only and manual-for-tagged-only and Manual for execution-mode: Conﬁgure remediation tutorials Version May 08, 2025 441 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 7. Choose Save to update the value, and then choose Save new version to apply the changes. You must choose Save new version for Trusted Remediator to recognize the change. 8. Make sure that your Amazon EBS volumes don't have a tag with the keyTR-DAvU99Dc4C- Execution-Mode. This tag key overrides the default execution-mode for that EBS Volume. Remediate all resources automatically, except for selected resources This example conﬁgures automatic remediation for all Amazon EBS volumes with the Trusted Advisor check ID DAvU99Dc4C (Underutilized Amazon EBS Volumes), with the exception of speciﬁed volumes that won't be remediated (designated Inactive. Conﬁgure automatic remediation for Amazon EBS volumes with check ID DAvU99Dc4C, with the exception of selected inactive resources 1. Open the AWS AppConﬁg console at https://console.aws.amazon.com/systems-manager/ appconﬁg. Make sure that you sign in as the Delegated Administrator account. 2. Select Trusted Remediator from the list of applications. 3. Choose the Cost Optimization conﬁguration proﬁle. 4. 5. Select the Underutilized Amazon EBS Volumes ﬂag. For execution-mode, select Automated. Conﬁgure remediation tutorials Version May 08, 2025 442 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 6. Make sure that the automated-for-tagged-only and manual-for-tagged-only attributes are blank. These attributes are used to override the default execution-mode for resources with matching tags. The following is an example of the Attributes section with blank values for automated-for- tagged-only and manual-for-tagged-only and Automated for execution-mode: 7. Choose Save to update the value, and
accelerate-guide-139	accelerate-guide.pdf	139	2. Select Trusted Remediator from the list of applications. 3. Choose the Cost Optimization conﬁguration proﬁle. 4. 5. Select the Underutilized Amazon EBS Volumes ﬂag. For execution-mode, select Automated. Conﬁgure remediation tutorials Version May 08, 2025 442 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 6. Make sure that the automated-for-tagged-only and manual-for-tagged-only attributes are blank. These attributes are used to override the default execution-mode for resources with matching tags. The following is an example of the Attributes section with blank values for automated-for- tagged-only and manual-for-tagged-only and Automated for execution-mode: 7. Choose Save to update the value, and then choose Save new version to apply the changes. You must choose Save new version for Trusted Remediator to recognize the change. At this point, all Amazon EBS volumes are set for automatic remediation. 8. Override automatic remediation for selected Amazon EBS volumes: a. Open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. b. Choose Elastic Block Store, Volumes. c. Choose Tags. d. Choose Manage tags. e. Add the following tag: • Key: TR-DAvU99Dc4C-Execution-Mode • Value: Inactive The following is an example of the Tags section showing the Key and Value ﬁelds: Conﬁgure remediation tutorials Version May 08, 2025 443 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures f. Repeat steps 2 through 5 for all Amazon EBS volumes that you want to exclude from remediation. Remediate tagged resources automatically This example conﬁgures automatic remediation for all Amazon EBS volumes with the tag Stage=NonProd with the Trusted Advisor check ID DAvU99Dc4C (Underutilized Amazon EBS Volumes). All other resources without this tag aren't remediated. Conﬁgure automatic remediation for Amazon EBS volumes with the tag Stage=NonProd for check ID DAvU99Dc4C 1. Open the AWS AppConﬁg console at https://console.aws.amazon.com/systems-manager/ appconﬁg. Make sure that you sign in as the Delegated Administrator account. 2. Select Trusted Remediator from the list of applications. 3. Choose the Cost Optimization conﬁguration proﬁle. 4. 5. 6. Select the Underutilized Amazon EBS Volumes ﬂag. For execution-mode, select Conditional. Set the automated-for-tagged-only to Stage=NonProd. This attribute overrides the default execution-mode for resources with matching tags. Make sure that the manual-for-tagged- only attributes is blank. The following is an example of the Attributes section with automated-for-tagged-only set to Stage=NonProd and Conditional for execution-mode: Conﬁgure remediation tutorials Version May 08, 2025 444 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 7. Choose Save to update the value, and then choose Save new version to apply the changes. You must choose Save new version f or Trusted Remediator to recognize the change. 8. Make sure that your Amazon EBS volumes don't have a tag with the keyTR-DAvU99Dc4C- Execution-Mode. This tag key overrides the default execution-mode for that EBS Volume. Work with remediations in Trusted Remediator Topics • Track remediations in Trusted Remediator • Run manual remediations in Trusted Remediator • Troubleshoot remediations in Trusted Remediator Track remediations in Trusted Remediator To track OpsItems remediations, complete the following steps: 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. Choose Operations Management, OpsCenter. 3. (Optional) Filter the list by Source=Trusted Remediator to include only Trusted Remediator OpsItems in the list. Work with remediations Version May 08, 2025 445 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures The following is an example of the OpsCenter screen ﬁltered by Source=Trusted Remediator: Note In addition to viewing OpsItems from the OpsCenter, you can view remediation logs in the AMS S3 bucket. For more information, see Remediation logs in Trusted Remediator. Run manual remediations in Trusted Remediator Trusted Remediator creates OpsItems for checks conﬁgured for manual remediation. You must review these checks and begin the remediation process manually. To manually remediate the OpsItem, complete the following steps: 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. Choose Operations Management, OpsCenter. 3. (Optional) Filter the list by Source=Trusted Remediator to include only Trusted Remediator OpsItems in the list. 4. Choose the OpsItem that you want to review. 5. Review the operational data of the OpsItem. The operational data includes the following items: • trustedAdvisorCheckCategory: The category of the Trusted Advisor check ID. For example, Fault tolerance Work with remediations Version May 08, 2025 446 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • trustedAdvisorCheckId: The unique Trusted Advisor check ID. • trustedAdvisorCheckMetadata: The resource metadata, including the resource ID. • trustedAdvisorCheckName: The name of the Trusted Advisor check. • trustedAdvisorCheckStatus: The status of the Trusted Advisor check detected for the resource. 6. To manually remediate the OpsItem, complete the following steps: a. From Runbooks, choose one of associated runbooks (SSM documents). b. Choose Execute. c. For AutomationAssumeRole , choose arn:aws:iam::AWS accountID:role/ ams_ssm_automation_role. Replace AWS accountID with the account ID where the remediation runs. For other parameter values, see the Operation data. To manually remediate resources, the role or user used to authenticate to the AWS
accelerate-guide-140	accelerate-guide.pdf	140	unique Trusted Advisor check ID. • trustedAdvisorCheckMetadata: The resource metadata, including the resource ID. • trustedAdvisorCheckName: The name of the Trusted Advisor check. • trustedAdvisorCheckStatus: The status of the Trusted Advisor check detected for the resource. 6. To manually remediate the OpsItem, complete the following steps: a. From Runbooks, choose one of associated runbooks (SSM documents). b. Choose Execute. c. For AutomationAssumeRole , choose arn:aws:iam::AWS accountID:role/ ams_ssm_automation_role. Replace AWS accountID with the account ID where the remediation runs. For other parameter values, see the Operation data. To manually remediate resources, the role or user used to authenticate to the AWS account must have the iam:PassRole permissions for the IAM role ams-ssm- automation-role. For more information, see Granting a user permissions to pass a role to an AWS service or contact your Cloud Architect. d. Choose Execute. e. Monitor the SSM document execution's progress in the Latest status and results column. f. After the document completes, choose Set Status, Resolved to manually resolve the OpsItem. If the document failed, then review the details and re-run the SSMdocument. For additional troubleshooting support, create a service request. To resolve an OpsItem without remediation, select Set Status to Resolved. 7. Repeat steps 3 and 4 for all remaining manual remediation OpsItems. Troubleshoot remediations in Trusted Remediator For assistance with manual remediations and remediation failures, contact AMS. To view remediation status and results, complete the following steps: 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/. 2. Choose Operations Management, OpsCenter. Work with remediations Version May 08, 2025 447 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 3. (Optional) Filter the list by Source=Trusted Remediator to include only Trusted Remediator OpsItems in the list. 4. Choose the OpsItem that you want to review. 5. In the Automation Executions section review the Document Name and Status and results. 6. Review the following common automation failures. If your issues isn't listed here, then contact your CSDM for assistance. Common remediation errors No executions are listed in Automation Executions No executions associated with the OpsItem might indicate that the execution failed to start due to incorrect parameter values. Troubleshooting steps 1. In the Operational data, review the trustedAdvisorCheckAutoRemediation property value. 2. Verify that the DocumentName and Parameters values are correct. For the correct values, review Conﬁgure Trusted Advisor check remediation in Trusted Remediator for details on how to conﬁgure SSM parameters. To review supported check parameters, see Trusted Advisor checks supported by Trusted Remediator 3. Verify that values in the SSM document match allowed patterns. To view parameters details in the document content, select the document name in the Runbooks section. 4. After you review and correct the parameters, manually run the SSM document again. 5. To prevent this error from reoccurring, make sure that you conﬁgure the remediation with the correct parameter values in your conﬁguration. For more information, see Conﬁgure Trusted Advisor check remediation in Trusted Remediator Failed executions in Automation Executions Remediation documents contain multiple steps that interact with AWS services performing various actions through APIs. To identify a speciﬁc cause for the failure, complete the following steps: Work with remediations Version May 08, 2025 448 AMS Accelerate User Guide Troubleshooting steps AMS Accelerate Concepts and Procedures 1. To view the individual execution steps, choose the Execution ID, link in the Automation Executions section. The following is an example of the Systems Manager console showing the Exection steps for a selected automation: 2. Choose the step with the Failed status. The following are example error messages: • NoSuchBucket - An error occurred (NoSuchBucket) when calling the GetPublicAccessBlock operation: The specified bucket does not exist This error indicates that the incorrect bucket name was speciﬁed in the remediation conﬁguration's preconﬁgured-parameters. To resolve this error, manually run the automation using the correct bucket name. To prevent this issue from reoccurring, update the remediation conﬁguration with the correct bucket name. Work with remediations Version May 08, 2025 449 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • DB instance my-db-instance-1 is not in available status for modification. This error indicates that the automation couldn't make the expected changes because the DB instance was in an invalid state. To resolve this error, manually run the automation. Remediation logs in Trusted Remediator Trusted Remediator creates logs in JSON format and uploads them to Amazon Simple Storage Service The log ﬁles are uploaded to an S3 bucket created by AMS and named ams-trusted- remediator-{your-account-id}-logs. AMS creates the S3 bucket in the Delegated Administrator account. You can import the log ﬁles into QuickSight to generate customized remediation reports. For more information, see Trusted Remediator integration with QuickSight. Topics • Remediation item log • Automated remediation execution log • Member accounts log Remediation item log Trusted Remediator creates the Remediation item log when a remediation OpsItem is created. This log
accelerate-guide-141	accelerate-guide.pdf	141	Remediation logs in Trusted Remediator Trusted Remediator creates logs in JSON format and uploads them to Amazon Simple Storage Service The log ﬁles are uploaded to an S3 bucket created by AMS and named ams-trusted- remediator-{your-account-id}-logs. AMS creates the S3 bucket in the Delegated Administrator account. You can import the log ﬁles into QuickSight to generate customized remediation reports. For more information, see Trusted Remediator integration with QuickSight. Topics • Remediation item log • Automated remediation execution log • Member accounts log Remediation item log Trusted Remediator creates the Remediation item log when a remediation OpsItem is created. This log contains manual remediation OpsItem and automated remediation OpsItem. You can use the Remediation item log to track the overview of all remediations. Remediation item log location s3://ams-trusted-remediator-delegated-administrator-account-id-logs/ remediation_items/remediation creation time in yyyy-mm-dd format/10 digits epoch time or unix timestamp-Trusted Advisor check ID-Resource ID.json Remediation item log sample ﬁle URL Remediation logs Version May 08, 2025 450 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures s3:///ams-trusted-remediator-111122223333-logs/ remediation_items/2023-02-06/1675660464-DAvU99Dc4C- vol-00bd8965660b4c16d.json Remediation item log format { "TrustedAdvisorCheckID": Trusted Advisor check ID, "TrustedAdvisorCheckName": Trusted Advisor check name, "TrustedAdvisorCheckResultTime": 10 digits epoch time or unix timestamp, "ResourceID": Resource ID, "RemediationTime": Remediation creation time, "ExecutionMode": Automated or Manual, "OpsItemID": OpsItem ID, } Remediation item log format sample content { "TrustedAdvisorCheckID": "DAvU99Dc4C", "TrustedAdvisorCheckName": "Underutilized Amazon EBS Volumes", "TrustedAdvisorCheckResultTime": 1675614749, "ResourceID": "vol-00bd8965660b4c16d", "RemediationTime": 1675660464, "OpsItemID": "oi-cca5df7af718" } Automated remediation execution log Trusted Remediator creates the Automated remediation execution log when an automated SSM document run is completed. This log contains SSM run details for automated remediation OpsItem only. You can use this log ﬁle to track automated remediations. Automated remediation log location s3://ams-trusted-remediator-delegated-administrator-account-id-logs// remediation_executions/remediation creation time in yyyy-mm-dd format/10 digits epoch time or unix timestamp-Trusted Advisor check ID-Resource ID.json Remediation logs Version May 08, 2025 451 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Automated remediation log location example s3://ams-trusted-remediator-111122223333-logs/ remediation_executions/2023-02-06/1675660573-DAvU99Dc4C- vol-00bd8965660b4c16d.json Automated remediation log format { "OpsItemID": OpsItem ID, "SSMExecutionID": SSM Execution ID, "SSMExecutionStatus": Success/Failed, } Automated remediation log format sample content { "OpsItemID": "oi-767c77e05301", "SSMExecutionID": "93d091b2-778a-4cbc-b672-006954d76b86", "SSMExecutionStatus": "Success" } Member accounts log Trusted Remediator creates the Member accounts log when your account is onboarded or oﬀboarded. You can use the Member accounts log to ﬁnd the account ID, onboarded AWS Regions, and execution time of each member account. Member accounts log location s3://ams-trusted-remediator-delegated-administrator-account-id-logs/ configuration_logs/member_accounts.json Member accounts log sample ﬁle URL s3://ams-trusted-remediator-111122223333-logs/configuration_logs/ member_accounts.json Member accounts log format Remediation logs Version May 08, 2025 452 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures { "delegated_administrator_account_id": Delegated Administrator account id, "appconfig_configuration_region": Trusted Remediator AppConfig Region, "member_accounts": [ { "account_id": Member account id "account_partition": Member account partition (for example, aws), "regions": [ { "execution_time": Remediation execution time in cron schedule expression, "execution_timezone": Timezone for the remediation execution time, "region_name": AWS Region name } ... ] } ... ], "updated_at": Log update time, } Member accounts log format sample content { "delegated_administrator_account_id": "111122223333", "appconfig_configuration_region": "ap-southeast-2", "member_accounts": [ { "account_id": "222233334444", "account_partition": "aws", "regions": [ { "execution_time": "0 9 * * 6", "execution_timezone": "Australia/Sydney", "region_name": "ap-southeast-2" }, { "execution_time": "0 5 * * 7", "execution_timezone": "UTC", "region_name": "us-east-1" } ] Remediation logs Version May 08, 2025 453 AMS Accelerate Concepts and Procedures AMS Accelerate User Guide }, { "account_id": "333344445555", "account_partition": "aws", "regions": [ { "execution_time": "0 1 * * 5", "execution_timezone": "Asia/Seoul", "region_name": "ap-northeast-2" } ] } ], "updated_at": "1730869607" } Trusted Remediator integration with QuickSight You can integrate the Trusted Remediator logs stored in Amazon S3 with QuickSight to build customized remediation report. QuickSight integration is optional. This feature allows you to use the logs to build custom reporting dashboards. To obtain on-request reports for Trusted Remediator, contact your CSDM. For more information on available Trusted Remediator reports, see Trusted Remediator reports. For more information on visualizing data in QuickSight, see Visualizing data in QuickSight. Topics • Add a dataset to QuickSight for the Remediation item log • Add a dataset to QuickSight for the Automated remediation execution log Add a dataset to QuickSight for the Remediation item log 1. Log in to QuickSight console. You can create the QuickSight report in any AWS Region that QuickSight supports. However, for better performance and lower costs, it's a best practice to create the report in the Region where the Trusted Remediator logging bucket is located. 2. Choose Datasets. 3. Choose S3. 4. In the New S3 data source, enter the following values: Integration with QuickSight Version May 08, 2025 454 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Data source name: trusted- remediator-delegated_administrator_account_id-account_region- remediation-items. • Upload a manifest ﬁle: Create a JSON ﬁle with the following content, and use it. When creating the ﬁle, replace logging_bucket_name in the URIPreﬁxes key. { "fileLocations": [ { "URIPrefixes": [ "s3://{logging_bucket_name}/remediation_items/" ] } ], "globalUploadSettings": { "format": "JSON", "delimiter": ",", "textqualifier":
accelerate-guide-142	accelerate-guide.pdf	142	practice to create the report in the Region where the Trusted Remediator logging bucket is located. 2. Choose Datasets. 3. Choose S3. 4. In the New S3 data source, enter the following values: Integration with QuickSight Version May 08, 2025 454 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Data source name: trusted- remediator-delegated_administrator_account_id-account_region- remediation-items. • Upload a manifest ﬁle: Create a JSON ﬁle with the following content, and use it. When creating the ﬁle, replace logging_bucket_name in the URIPreﬁxes key. { "fileLocations": [ { "URIPrefixes": [ "s3://{logging_bucket_name}/remediation_items/" ] } ], "globalUploadSettings": { "format": "JSON", "delimiter": ",", "textqualifier": "'", "containsHeader": "true" } } • Choose Connect. • From the Finish dataset creation window, choose Visualize. • QuickSight opens the new analysis sheet page. You are now ready to create a new analysis using the Remediation item log. The following is a sample analysis: Integration with QuickSight Version May 08, 2025 455 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Add a dataset to QuickSight for the Automated remediation execution log 1. Log in to QuickSight console. You can create the QuickSight report in any AWS Region that QuickSight supports. However, for better performance and lower costs, it's a best practice to create the report in the Region where the Trusted Remediator logging bucket is located. 2. Choose Datasets. 3. Choose S3. 4. In the New S3 data source, enter the following values: • Data source name: trusted- remediator-delegated_administrator_account_id-account_region- remediation-executions. • Upload a manifest ﬁle: Create a JSON ﬁle with the following content, and then use this ﬁle. When creating the ﬁle, replace logging_bucket_name in the URIPreﬁxes key. { "fileLocations": [ { "URIPrefixes": [ "s3://{logging_bucket_name}/remediation_executions/" ] } Integration with QuickSight Version May 08, 2025 456 AMS Accelerate Concepts and Procedures AMS Accelerate User Guide ], "globalUploadSettings": { "format": "JSON", "delimiter": ",", "textqualifier": "'", "containsHeader": "true" } } • Choose Connect. • From the Finish dataset creation window, choose Visualize. • QuickSight opens the new analysis sheet page. You are now ready to create a new analysis using the Remediation item log. The following is a sample analysis: Best practices in Trusted Remediator The following are best practices to help you use Trusted Remediator: • If you're unsure about the remedation results, start with manual execution mode. Sometimes, applying automated execution for remediations from the start might cause unexpected results. Best practices Version May 08, 2025 457 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Conduct a weekly review of the remediations and OpsItems to gain insights in the Trusted Remediator results. • Member accounts inherit the conﬁgurations from the delegated administrator account. So, it’s important to structure the accounts in a way that helps you manage multiple accounts with the same conﬁgurations. You can exempt resources from the default conﬁguration using tags. Trusted Remediator FAQs The following are frequently asked questions about Trusted Remediator: What is Trusted Remediator and how does it beneﬁt me? When a non-compliance is identiﬁed by Trusted Advisor, Trusted Remediator responds according to your speciﬁed preferences, either by applying remediation, seeking approval through manual remediations, or reporting the remediations during your upcoming Monthly Business Review (MBR). The remediation happen at your preferred remediation time or schedule. Trusted Remediator provides you with the ability to self-service and act on Trusted Advisor checks with the ﬂexibility to conﬁgure and remediate checks individually or in bulk. With a library of tested remediation documents, AMS constantly bar raises your accounts by applying safety checks and following AWS best practices. You are only notiﬁed if you specify to do so in your conﬁguration. AMS users can opt-in to Trusted Remediator at no additional charge. How does Trusted Remediator relate to and work with other AWS services? You have access to Trusted Advisor checks as part of your existing Enterprise Support plan. Trusted Remediator integrates with Trusted Advisor leverage existing AMS automation capabilities. Speciﬁcally, AMS uses AWS Systems Manager automation documents (runbooks) for automated remediations. AWS AppConﬁg is used to conﬁgure the remediation workﬂows. You can view all the current and past remediations through the Systems Manager OpsCenter. The remediation logs are stored in an Amazon S3 bucket. You can use the logs to import and build custom reporting dashboards in QuickSight. Who conﬁgures the remediations? You own the conﬁgurations in your account. Managing your conﬁgurations is your responsibility. You can reach out to your CA or CDSM for help managing your conﬁgurations. You can also reach out to AMS through a service request for conﬁguration support, manual remediations, and troubleshooting remediation failures. FAQs Version May 08, 2025 458 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures How do I install SSM automation documents? SSM automation documents are automatically shared to onboarded AMS accounts. Will AMS owned resources be remediated too? AMS owned resources aren't ﬂagged by
accelerate-guide-143	accelerate-guide.pdf	143	reporting dashboards in QuickSight. Who conﬁgures the remediations? You own the conﬁgurations in your account. Managing your conﬁgurations is your responsibility. You can reach out to your CA or CDSM for help managing your conﬁgurations. You can also reach out to AMS through a service request for conﬁguration support, manual remediations, and troubleshooting remediation failures. FAQs Version May 08, 2025 458 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures How do I install SSM automation documents? SSM automation documents are automatically shared to onboarded AMS accounts. Will AMS owned resources be remediated too? AMS owned resources aren't ﬂagged by Trusted Remediator. Trusted Remediator focuses only on your resources. What AWS Regions is Trusted Remediator available in and who can use it? Trusted Remediator is available for AMS Accelerate customers. For a current list of support Regions, see AWS services by Region. Will Trusted Remediator cause resource drift? Since SSM automation documents directly update resources through the AWS API, resource drift might occur. You can use tags to segregate resources created through your existing CI/ CD packages. You can conﬁgure Trusted Remediator to ignore the tagged resources while still remediating your other resources. How do I pause or stop Trusted Remediator? You can turn oﬀ Trusted Remediator through the AWS AppConﬁg application. To pause or stop Trusted Remediator, complete the following steps: 1. Open the AWS AppConﬁg console at https://console.aws.amazon.com/systems-manager/ appconﬁg. 2. Select Trusted Remediator. 3. Choose Settings on the conﬁguration proﬁle. 4. 5. FAQs Select the Suspend Trusted Remediator ﬂag. Set the valueof the suspended attribute to true. Note Be cautious when using this procedure as this stops Trusted Remediator for all accounts linked to the delegated administrator account. Version May 08, 2025 459 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures How can I remediate checks that aren't supported by Trusted Remediator? You can continue to reach out to AMS through Operations On Demand (OOD) for unsupported checks. AMS assists you with remediating these checks. For more information, see Operations On Demand. How is Trusted Remediator diﬀerent from AWS Conﬁg remediation? AWS Conﬁg Remediation is another solution that helps you optimize cloud resources and maintain compliance with best practices. The following are some of the operational diﬀerences between the two solutions: • Trusted Remediator uses Trusted Advisor as the detection mechanism. AWS Conﬁg Remediation uses AWS Conﬁg rules as the detection mechanism. • For Trusted Remediator, remediation happens at your predeﬁned remediation schedule. In AWS Conﬁg, remediation happens in real time. • The parameters for each remediation in Trusted Remediator is easily customizable based on your use case and remediation can be automated or made manual by adding tags on resources. • Trusted Remediator provides reporting functionality. • Trusted Remediator sends an email notiﬁcation to you with the list of remediation and the remediation status. Some Trusted Advisor checks might have the same rule in AWS Conﬁg. It's a best practice to enable only one remediation if there is a matching AWS Conﬁg rule and Trusted Advisor check. For information on AWS Conﬁg r ules for each Trusted Advisor check, see Trusted Advisor checks supported by Trusted Remediator. What resources does Trusted Remediator deploy to your accounts? Trusted Remediator deploys the following resources in the Trusted Remediator delegated administrator account: • An Amazon S3 bucket named ams-trusted-remediator-{your-account-id}-logs. Trusted Remediator creates the Remediation item log in JSON format when a remediation OpsItem is created, and uploads the log ﬁles to this bucket. • An AWS AppConﬁg application to hold the remediation conﬁgurations for supported Trusted Advisor checks. FAQs Version May 08, 2025 460 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Trusted Remediator doesn't deploy resources in the Trusted Remediator member account. FAQs Version May 08, 2025 461 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Monitoring and incident management for Amazon EKS in AMS Accelerate Monitoring and Incident Management for Amazon EKS monitors your Amazon EKS resources for failures, performance degradation, and security issues. AMS Accelerate conﬁgures and deploys Amazon Managed Service for Prometheus alert manager rules, monitors the alerts, and then performs incident management when these alerts are triggered. Monitoring and incident management for Amazon EKS relies on AMS Alarm Manager and leverages native AWS services, such as Amazon Managed Service for Prometheus, Amazon Managed Grafana, Amazon GuardDuty, AWS Lambda, and AWS Conﬁg. Note Monitoring and incident management for Amazon EKS doesn't support AWS GovCloud (US), Windows nodes, or Windows containers. What is monitoring and incident management for Amazon EKS in AMS Accelerate? Monitoring and incident management for Amazon EKS provides the following: • A default conﬁguration that creates, manages, and deploys monitors and policies across your managed account for Amazon EKS clusters that you select. • A monitoring baseline to allow your Amazon EKS workloads to have increased availability, even if you don't
accelerate-guide-144	accelerate-guide.pdf	144	AWS services, such as Amazon Managed Service for Prometheus, Amazon Managed Grafana, Amazon GuardDuty, AWS Lambda, and AWS Conﬁg. Note Monitoring and incident management for Amazon EKS doesn't support AWS GovCloud (US), Windows nodes, or Windows containers. What is monitoring and incident management for Amazon EKS in AMS Accelerate? Monitoring and incident management for Amazon EKS provides the following: • A default conﬁguration that creates, manages, and deploys monitors and policies across your managed account for Amazon EKS clusters that you select. • A monitoring baseline to allow your Amazon EKS workloads to have increased availability, even if you don't conﬁgure any other monitoring for your Amazon EKS clusters. For more information, see Baseline alerts in monitoring and incident management for Amazon EKS in AMS Accelerate. • Notiﬁcations that are generated by the baseline monitoring conﬁgured for your Amazon EKS cluster. These notiﬁcations are known as alerts. Alerts are generated when there are imminent, on-going, receding, or potential failures, performance degradation, or security issues. Examples of alerts include a Prometheus alert, an event, or a ﬁnding from an AWS service, such as Amazon GuardDuty. • Alert investigation with guidance on appropriate remediation actions that you can take. For more information, see Incident reports and service requests in AMS Accelerate. What is monitoring and incident management for Amazon EKS? Version May 08, 2025 462 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Remediation of alerts and incidents by AMS operations, when possible and with your approval, to prevent or reduce the impact to your applications. For more information, see Incident reports and service requests in AMS Accelerate. • Optional predeﬁned Amazon Managed Grafana dashboards that provide visibility into resource utilization, performance, health of CoreDNS, active alerts, and previously resolved alerts. If you conﬁgure Amazon Managed Grafana using the AMS-provided template, then you can open the Amazon Managed Grafana console to view metrics and alerts for your Amazon EKS cluster. How monitoring and incident management for Amazon EKS works in AMS Accelerate Generation: As part of onboarding monitoring and incident management for EKS, AMS conﬁgures baseline monitoring for the Amazon EKS clusters that you selected in your managed account. AMS uses a combination of Amazon Managed Service for Prometheus alert manager rules and Amazon CloudWatch event rules to conﬁgure baseline monitoring. An AMS-conﬁgured Prometheus server in your cluster scrapes and remote-writes your Prometheus metrics to an Amazon Managed Service for Prometheus endpoint in the same Region. The baseline monitoring conﬁguration generates an alert when a Prometheus alert manager rule is triggered or a CloudWatch event is generated. Aggregation: AMS sends all alerts that your resources generate to the AMS monitoring system by directing them to an Amazon Simple Notiﬁcation Service topic that's managed by AMS. Processing and impact analysis: AMS analyzes the alerts and then processes them based on their potential for impact. AMS classiﬁes t he alerts as follows: • Alerts with known customer impact: For these alerts, AMS creates a new incident report using the incident management process. • Alerts with uncertain customer impact: For these alerts, AMS sends an incident report. In many cases, these alerts ask you to verify the impact before AMS can take action. For such alerts, AMS sends an alert notiﬁcation with the details and checks whether the alert needs a mitigating action. AMS provides options for mitigating actions in the notiﬁcation. If your reply conﬁrms that the alert is an incident, AMS then triggers the creation of a new incident report and initiates the incident management process. Any service notiﬁcation that receives a response of "no customer impact" or no response at all for three days is marked as resolved. Also, the corresponding alert is marked as resolved. How monitoring and incident management for Amazon EKS works Version May 08, 2025 463 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Alerts with no customer impact: If, after evaluation, AMS determines that the alert doesn't have any customer impact, the alert is closed. AMS responsibility matrix (RACI) The AMS responsible, accountable, consulted, and informed, or RACI matrix assigns the primary responsibility to either the customer or AMS for a variety of activities. The f ollowing table provides an overview of the responsibilities of customer and AMS for activities in an application that uses Monitoring and Incident Management for Amazon EKS. • R stands for the responsible party that does the work to achieve the task. • A stands for the accountable party. • C stands for consulted; the party whose opinions are sought, typically as subject matter experts; and with whom there is bilateral communication. • I stands for informed; the party which is informed on progress, often only on completion of the task or deliverable. Activity Customer AMS I R R C Discovery for AMS requireme nts Enable AMS permissions
accelerate-guide-145	accelerate-guide.pdf	145	responsibilities of customer and AMS for activities in an application that uses Monitoring and Incident Management for Amazon EKS. • R stands for the responsible party that does the work to achieve the task. • A stands for the accountable party. • C stands for consulted; the party whose opinions are sought, typically as subject matter experts; and with whom there is bilateral communication. • I stands for informed; the party which is informed on progress, often only on completion of the task or deliverable. Activity Customer AMS I R R C Discovery for AMS requireme nts Enable AMS permissions (RBAC) for cluster access Install Amazon EC2 Systems Manager Agent on worker nodes if it isn't already present Deploy AMS on-cluste r components, such as Prometheus, Prometheus Node Exporter, and kube- state-metrics in an AMS namespace, as needed. R C C R AMS responsibility matrix (RACI) Version May 08, 2025 464 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Activity Customer AMS Provision Amazon Managed Service for Prometheus in the AMS control plane Conﬁgure Prometheus alert manager in the AMS control plane Provide Amazon Managed Grafana template and assist with conﬁguration Enable GuardDuty EKS Audit Log Monitoring Enable Amazon EKS control plane logging Monitor the health and performance of the Amazon EKS control plane Monitor the health and performance of your Amazon EKS cluster (cluster, node, workload, pod, API Server and CoreDNS) Triage alerts and provide incident response for Amazon EKS Run diagnostic commands during incidents Analyze logs during incidents (control plane and pod logs) I I C C I I I I I I R R R R R R R R R R AMS responsibility matrix (RACI) Version May 08, 2025 465 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Activity Customer AMS Incident response for AWS network issues Respond to GuardDuty EKS Audit Log Monitoring ﬁndings Provide customer guidance on actions to remediate incidents when possible I I I R R R Baseline alerts in monitoring and incident management for Amazon EKS in AMS Accelerate After verifying the alerts, AMS enables the following alerts for Amazon EKS and then engages in monitoring and incident management for your selected Amazon EKS clusters. The response time Service Level Agreements (SLAs) and Service Level Objectives (SLOs) are dependent on your selected account Service Tier (Plus, Premium). For more information, see Incident reports and service requests in AMS Accelerate. Alerts and actions The following table lists the Amazon EKS alerts and respective actions that AMS takes: Alert Thresholds Action Container OOM killed The total number of container restarts within the last 10 minutes is at least 1 and a Kubernetes container in a pod has been terminated with the reason “OOMKilled” within the last 10 minutes. AMS investigates whether the OOM kill is caused because of reaching container limit or memory limit overcommi t, and then advises you on corrective actions. Pod Job Failed A Kubernetes job fails to complete. Failure is indicated AMS investigates why the Kubernetes job or correspon Baseline alerts Version May 08, 2025 466 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Alert Thresholds Action StatefulSet Down HPA Scaling Ability HPA Metric Availability Pod Not Ready by the presence of at least ding cron job is failing, and one failed job status. then advises you on corrective actions. The number of replicas ready to serve traﬃc doesn't AMS determines why pods aren't ready by reviewing match the current number of error messages in pod events existing replicas per StatefulS and error log snippets in pod et for at least 1 minute. logs, and then advises you on corrective actions. The Horizontal Pod Autoscale r (HPA) can't scale due to the AMS determines which Kubernetes Horizontal Pod status condition “AbleToSc Autoscaler (HPA) is unable to ale” being false for at least 2 scale pods for its subsequent minutes. workload resource, such as a Deployment or StatefulSet. The Horizontal Pod Autoscale r (HPA) can't collect metrics AMS determines why HPA can't collect metrics, such due to the status condition as metrics related to server “ScalingActive” being false for conﬁguration issues or RBAC at least 2 minutes. authorization issues. A Kubernetes pod remains in a non-running state (such as AMS investigates aﬀected pod(s) for details, reviews pod Pending, Unknown, or Failed) for longer than 15 minutes. logs for related errors and events, and then advises you on corrective actions. Alerts and actions Version May 08, 2025 467 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Alert Thresholds Action Pod Crash Looping A pod container restarts at least once every 15 minutes AMS investigates the reasons for the pod not starting, for a 1-hour period. such as insuﬃcient resources , a ﬁle locked by another container, database locked by another container, service dependencies failing, DNS issues for
accelerate-guide-146	accelerate-guide.pdf	146	(such as AMS investigates aﬀected pod(s) for details, reviews pod Pending, Unknown, or Failed) for longer than 15 minutes. logs for related errors and events, and then advises you on corrective actions. Alerts and actions Version May 08, 2025 467 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Alert Thresholds Action Pod Crash Looping A pod container restarts at least once every 15 minutes AMS investigates the reasons for the pod not starting, for a 1-hour period. such as insuﬃcient resources , a ﬁle locked by another container, database locked by another container, service dependencies failing, DNS issues for external services, and misconﬁgurations. Daemonset Mis-scheduled There is at least one Kubernetes Daemonset pod misscheduled over a 10- minute period. AMS determines why a Daemonset is scheduled on a node where they aren't supposed to run. This might happen when the wrong pod nodeSelector/taints/ aﬃnities were applied to the Daemonset pods or when node (node pools) were tainted and existing pods weren't scheduled for eviction. Kubernetes API Errors The Kubernetes API server error rate exceeds 3% over a AMS analyzes control plane logs to determine the volume 2-minute period. and types of errors that are causing this alert, and identiﬁes any resource contention issues for master node or etcd autoscaling groups. If the API server doesn't recover, AMS engages the Amazon EKS service team. Alerts and actions Version May 08, 2025 468 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Alert Thresholds Action Kubernetes API Latency The 99th percentile latency of requests to the Kubernete AMS analyzes control plane logs to determine the volume s API server exceeds 1 second and types of errors that are over a 2-minute period. causing latency and identiﬁe s any resource contention issues for master node or etcd auto-scaling groups. If the API server doesn't recover, AMS engages the Amazon EKS service team. Kubernetes Client Cert Expiring The client certiﬁcate used to authenticate to the Kubernete AMS sends this notiﬁcation to inform you that your cluster s API server is expiring in less certiﬁcate will expire in 24 than 24 hours. hours. Node Not Ready The Node “Ready” condition status is false for at least 10 AMS investigates the node conditions and events, such as minutes. network issues, that prevent kubelet access to the API server. Node High CPU The CPU load exceeds 80% over 5-minute period. AMS determines whether one or more pods are consuming an unusually high amount of CPU. Then, AMS veriﬁes with you that your requests, limits, and pod activity are as expected. Alerts and actions Version May 08, 2025 469 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Alert Thresholds Action Node OOM Kill Detected There is at least one host OOM kill reported by the AMS determines if the OOM kill is caused because of node in a 4-minute window. reaching the container limit or node overcommit. If the application activity is normal, AMS advises you on requests and limits for overcommits and revising pod limits. Node Conntrack Limit The ratio of the current number of connection AMS advises you on the recommended conntrack tracking entries to the maximum limit exceeds 80% value per core. Kubernete s nodes set the conntrack over a 5-minute period. max value proportional to the total memory capacity of the node. High load applicati ons, especially on smaller nodes, can easily exceed the conntrack max value, resulting in connection resets and timeouts. Node Clock Not in Sync Pod High CPU The minimum synchroni zation status over a 2-minute AMS determines whether Network Time Protocol (NTP) period is 0, and the maximum is installed and functioning error in seconds is 16 or higher. properly. CPU usage of a container exceeds 80% over 3-minute rate for a minimum of 2- minute period. AMS investigates pod logs to determine the pod tasks that consume a high amount of CPU. Alerts and actions Version May 08, 2025 470 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Alert Thresholds Action Pod High Memory CoreDNS Down Memory usage of a container exceeds 80% of its speciﬁed AMS investigates pod logs to determine the pod tasks that memory limit over 2-minute consume a high amount of period. memory. CoreDNS has disappeared from Prometheus target This is a critical alert that indicates that the domain discovery for more than 15- name resolution for internal minutes. or external cluster services stopped. AMS checks the status of the CoreDNS pods, veriﬁes CoreDNS conﬁgura tion, veriﬁes DNS endpoints that point to CoreDNS pods, veriﬁes CoreDNS limits, and with your approval, enables CoreDNS debug logging. CoreDNS Errors CoreDNS returns SERVFAIL errors for more than 3% This alert might signal an issue with an applicati of DNS requests over a 10- on or a misconﬁguration. minute period. AMS checks the status of the
accelerate-guide-147	accelerate-guide.pdf	147	memory. CoreDNS has disappeared from Prometheus target This is a critical alert that indicates that the domain discovery for more than 15- name resolution for internal minutes. or external cluster services stopped. AMS checks the status of the CoreDNS pods, veriﬁes CoreDNS conﬁgura tion, veriﬁes DNS endpoints that point to CoreDNS pods, veriﬁes CoreDNS limits, and with your approval, enables CoreDNS debug logging. CoreDNS Errors CoreDNS returns SERVFAIL errors for more than 3% This alert might signal an issue with an applicati of DNS requests over a 10- on or a misconﬁguration. minute period. AMS checks the status of the CoreDNS pods, veriﬁes CoreDNS conﬁguration, veriﬁes DNS endpoints that point to CoreDNS pods, veriﬁes CoreDNS limits, and with your approval, enables CoreDNS debug logging. Alerts and actions Version May 08, 2025 471 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Alert Thresholds Action CoreDNS Latency The 99th percentile of DNS request durations exceed 4 This alert Signals that CoreDNS might be overloade seconds for 10 minutes. d. AMS checks the status of CoreDNS pods, veriﬁes CoreDNS conﬁguration, veriﬁes DNS endpoints that point to the CoreDNS pods, veriﬁes CoreDNS limits, and with your approval, enables CoreDNS debug logging. CoreDNS Forwarding Latency The 99th percentile of the response time for CoreDNS When CoreDNS isn't the authoritative server or doesn't forward requests to kube-dns have a cache entry for a exceeds 4 seconds over a 10- domanin name, CoreDNS minute period. forwards the DNS request to an upstream DNS server. This alert signals that CoreDNS might be overloaded or there might be an issue with an upstream DNS server. AMS checks the status of CoreDNS pods, veriﬁes CoreDNS conﬁguration, veriﬁes DNS endpoints that point to CoreDNS pods, veriﬁes CoreDNS limits, and with your approval, enables CoreDNS debug logging. Alerts and actions Version May 08, 2025 472 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Alert Thresholds Action CoreDNS Forwarding Error More than 3% of DNS queries are failing over a 5-minute When CoreDNS isn't the authoritative server or doesn't period. have a cache entry for a domanin name, CoreDNS forwards the DNS request to an upstream DNS server. This alert signals a possible misconﬁguration or an issue with an upstream DNS server. AMS checks the status of CoreDNS pods, veriﬁes CoreDNS conﬁgura tion, veriﬁes DNS endpoints that point to CoreDNS pods, veriﬁes CoreDNS limits, and with your approval, enables CoreDNS debug logging. Requirements for monitoring and incident management for Amazon EKS in AMS Accelerate These are the supported and/or required resources for monitoring and incident management for Amazon EKS for AMS Accelerate • Supported Kubernetes versions: See Amazon EKS Kubernetes versions in the Amazon EKS User Guide. • Node types: Amazon EKS managed nodes are supported. Windows nodes and containers aren't supported. • Kubernetes cluster access: AMS requires system:masters RBAC cluster role and cluster user. • SSM Agent on Amazon EC2 nodes: Both Bottle Rocket and Amazon EKS AMIs have SSM Agent pre-installed. Be sure that SSM Agent is installed on your custom AMIs and Amazon EC2 nodes. • Service Quotas For more information, see the service quotas for Amazon Managed Service for Prometheus and Amazon Managed Grafana. Requirements Version May 08, 2025 473 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Amazon EKS clusters: Amazon EKS clusters must reside in a single Amazon VPC per AWS Region. • Supported AWS Regions: Region name US East (Ohio) Region us-east-2 US East (N. Virginia) us-east-1 US West (Oregon) us-west-2 Metrics storage region us-east-2 us-east-1 us-west-2 Asia Paciﬁc (Tokyo) ap-northeast-1 ap-northeast-1 Asia Paciﬁc (Seoul) ap-northeast-2 ap-northeast-2 Asia Paciﬁc (Singapore) ap-southeast-1 ap-southeast-1 Asia Paciﬁc (Sydney) ap-southeast-2 ap-southeast-2 Europe (Frankfurt) eu-central-1 eu-central-1 Europe (Ireland) Europe (London) eu-west-1 eu-west-2 Africa (Cape Town) af-south-1 Asia Paciﬁc (Hong Kong) ap-east-1 eu-west-1 eu-west-2 eu-west-1 eu-west-2 ap-northeast-1 ap-northeast-2 Note Metrics for Amazon EKS clusters in af-south-1, Africa (Cape Town) and ap-east-1, Asia Paciﬁc (Hong Kong) are exported to the AMS monitoring service in the same AWS Region, respectively. Metrics for these AWS Regions are then transported within the AMS Requirements Version May 08, 2025 474 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures monitoring service to diﬀerent Regions where they are processed and stored. See the preceding table for Regions that the AMS monitoring service uses to store metrics. Onboard to Monitoring and Incident Management for Amazon EKS in AMS Accelerate Perform the following steps to onboard to Monitoring and Incident Management for Amazon EKS. 1. Enable Amazon EKS cost optimization tags: See Tagging your resources for billing in the Amazon EKS User Guide. 2. Initiate onboarding of Monitoring and Incident Management for EKS: Contact your Cloud Service Delivery Manager (CSDM) with account IDs and cluster names to onboard. 3. Validate requirements: Your Cloud Architect (CA) validates that all requirements are met before onboarding begins. 4. Update
accelerate-guide-148	accelerate-guide.pdf	148	table for Regions that the AMS monitoring service uses to store metrics. Onboard to Monitoring and Incident Management for Amazon EKS in AMS Accelerate Perform the following steps to onboard to Monitoring and Incident Management for Amazon EKS. 1. Enable Amazon EKS cost optimization tags: See Tagging your resources for billing in the Amazon EKS User Guide. 2. Initiate onboarding of Monitoring and Incident Management for EKS: Contact your Cloud Service Delivery Manager (CSDM) with account IDs and cluster names to onboard. 3. Validate requirements: Your Cloud Architect (CA) validates that all requirements are met before onboarding begins. 4. Update Kubernetes role-based access control (RBAC): AMS shares the eksctl commands to implement these changes. You can review these changes and then deploy. You must deploy RBAC updates so that AMS has permissions to run commands on your behalf. These updates include mapping the AMS IAM role to a Kubernetes user, creating a new Kubernetes cluster role for AMS, and binding the AMS Kubernetes cluster role to the user. 5. Deploy cluster components: AMS deploys the following components in an AMS-managed namespace on your cluster: • Prometheus server • Prometheus node exporter (not applicable for AWS Fargate) • kube-state-metrics 6. Perform Prometheus conﬁguration updates: AMS conﬁgures Prometheus to enable remote- write for metrics. 7. (Optional) Conﬁgure dashboards: Your CA helps you conﬁgure Amazon Managed Grafana dashboards in your account. Note After your Amazon EKS cluster is onboarded, AMS analyzes alert signals and performs a baseline assessment to identify existing issues in your cluster. After the baseline Onboard Version May 08, 2025 475 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures assessment is complete, AMS shares ﬁndings and remediation recommendations through Trusted Advisor and a service request that you can use to address issues in your cluster. From the assessment, AMS creates an Amazon EKS monitoring baseline speciﬁc to your EKS clusters by adjusting our account-level alarm thresholds. To eliminate duplicate AMS responses against these ﬁndings, we adjust our monitoring to exclude those alert signals. We readjust our monitoring to include the signals when your CSDM informs us that the underlying issues have been remediated. Oﬀboard from Monitoring and Incident Management for Amazon EKS in AMS Accelerate Notify your cloud service delivery manager (CSDM) with account IDs and cluster names to start the oﬀboarding process. After you oﬀboard, alert processing, metric storage, and metric querying are suspended and metrics are deleted in accordance with the default Amazon Managed Service for Prometheus data retention policies. AMS performs the following oﬀboarding steps: 1. AMS disables alerts that are sent to you and AMS Operations. 2. AMS removes the Prometheus instance from your Amazon EKS cluster. 3. AMS removes other AWS resources that are installed in your account, such as IAM roles and AWS Conﬁg rules. After these steps are completed, you must complete the following oﬀboarding steps: 1. Use eksctl to remove the Kubernetes RBAC permissions from the aws-auth ConfigMap. 2. If you previously installed it, remove the Amazon Managed Grafana instance that you conﬁgured to connect to AMS. Oﬀboard Version May 08, 2025 476 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Continuity management in AMS Accelerate AMS leverages AWS Backup to centralize and automate the backing up of your data across AWS services. AMS backup plans provide best practices for various use cases; however, you are welcome to continue to use your existing backup plans. After you onboard to AMS backup management, AMS provides backup reports, and AMS experts continuously monitor your backup tasks to ensure you have a reliable backup solution. To learn more, see AWS Backup: How It Works and Supported AWS resources and third-party applications. AMS Accelerate provides a range of operational services to help you achieve operational excellence on AWS. To gain a quick understanding of how AMS helps your teams achieve overall operational excellence in AWS Cloud with some of our key operational capabilities including 24x7 helpdesk, proactive monitoring, security, patching, logging and backup, see AMS Reference Architecture Diagrams. Watch Carl’s video to learn more (9:29) Topics • How continuity management works in AMS • Select an AMS backup plan • Tag your resources to apply AMS backup plans • View backups in AMS vaults • AMS backup monitoring and reporting How continuity management works in AMS AMS backup plans deﬁne how frequently your data is backed up and the retention policy for your backups. AMS backup vaults keep your backup data organized. Once a resource is associated with a backup plan, compatible resources are incrementally backed up. The ﬁrst backup is a full copy and subsequent backups capture incremental changes. Depending on the resource and AMS backup plan selected, Point-in-time restore (PITR) allows you to rewind your resources by selecting a time for your recovery. To get started with AMS Backup Management, simply select
accelerate-guide-149	accelerate-guide.pdf	149	• AMS backup monitoring and reporting How continuity management works in AMS AMS backup plans deﬁne how frequently your data is backed up and the retention policy for your backups. AMS backup vaults keep your backup data organized. Once a resource is associated with a backup plan, compatible resources are incrementally backed up. The ﬁrst backup is a full copy and subsequent backups capture incremental changes. Depending on the resource and AMS backup plan selected, Point-in-time restore (PITR) allows you to rewind your resources by selecting a time for your recovery. To get started with AMS Backup Management, simply select an AMS backup plan and tag your resources. How continuity management works Version May 08, 2025 477 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Note Ensure that AWS Backup is enabled for each account, AWS Region, and resource type by following the steps here: Getting Started 1: Service Opt-in. You do not need to continue to Getting started 2: Create on on-demand backup. Related Topics from AWS Backup • Working with backups (Create, Edit, Copy, Restore, Delete) • Create an on-demand backup • Creating backup copies across AWS Regions • AWS Backup Supported Services • Point-in-time restore • AWS Backup Features Select an AMS backup plan AMS provides three diﬀerent backup plans with a fourth backup plan to minimize cost during onboarding. To select an AMS backup plan for each supported resource, tag the resource with the plan’s associated tag. As you onboard to Accelerate, AMS will work with you to identify the backup plan that best ﬁts your needs. Important Do not edit your AMS default backup plans as your changes might be lost. Instead, create new plans for your custom conﬁgurations. For more information, see Creating a backup plan. Default AMS backup plan AWS Backup continuous backup is not enabled for this backup plan; for details, see Restoring to a speciﬁed time using point-in-time restore (PITR). TAG key: ams:rt:backup-orchestrator Select an AMS backup plan Version May 08, 2025 478 AMS Accelerate User Guide TAG value: true AMS Accelerate Concepts and Procedures Default AMS backup plan Start Time Retention hourly backup N/A daily backup daily 4:00 UTC N/A 7 days weekly backup Saturday, 2:00 UTC 4 weeks monthly backup 1st of the month, 2:00 UTC 26 weeks yearly backup Jan 1st, 2:00 UTC 2 years Enhanced backup plan AWS Backup continuous backup is enabled with maximum retention (31 days) on supported resources; for details, see Restoring to a speciﬁed time using point-in-time restore (PITR) and Supported services and applications for point-in-time restore (PITR). TAG key: ams:rt:backup-orchestrator-enhanced TAG value: true Enhanced backup plan Start Time Retention hourly backup N/A daily backup daily 4:00 UTC weekly backup Saturday, 2:00 UTC N/A 31 days 6 weeks monthly backup 1st of the month, 2:00 UTC 26 weeks yearly backup Jan 1st, 2:00 UTC 2 years Enhanced backup plan Version May 08, 2025 479 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Data Sensitive backup plan AWS Backup continuous backup is enabled with maximum retention (31 days) on supported resources; for details, see Restoring to a speciﬁed time using point-in-time restore (PITR) and Supported services and applications for point-in-time restore (PITR). TAG key: ams:rt:backup-orchestrator-data-sensitive TAG value: true Data Sensitive backup plan Start Time Retention hourly backup every hour daily backup daily 4:00 UTC weekly backup Saturday, 2:00 UTC 7 days 31 days 6 weeks monthly backup 1st of the month, 2:00 UTC 26 weeks yearly backup Jan 1st, 2:00 UTC 2 years AMS Accelerate onboarding backup plan AWS Backup continuous backup is not enabled for this backup plan; for details, see Restoring to a speciﬁed time using point-in-time restore (PITR). TAG key: ams:rt:backup-orchestrator-onboarding TAG value: true AMS Accelerate onboarding backup plan Start Time Retention hourly backup every hour 2 weeks daily backup weekly backup N/A N/A N/A N/A Data Sensitive backup plan Version May 08, 2025 480 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures AMS Accelerate onboarding backup plan Start Time Retention monthly backup yearly backup N/A N/A N/A N/A Related AWS Backup Topics • Creating a backup plan • Point-in-time restore (PITR) enables continuous backups of supported resources and allows you to select a speciﬁc time for your recovery. For a list of supported resources, see Feature availability by resource. Tag your resources to apply AMS backup plans To assign resources to an AMS backup plan, tag the resource with the plan’s tag key-value pair. You can use AMS Resource Tagger to apply the AMS backup plans to a subset of your resources or for all supported resources in your account. If you want to use an alternate method to apply tags to your resources, such as AWS CloudFormation or Terraform, then turn oﬀ Resource Tagger so that it doesn’t compete with your chosen tagging method. For more
accelerate-guide-150	accelerate-guide.pdf	150	recovery. For a list of supported resources, see Feature availability by resource. Tag your resources to apply AMS backup plans To assign resources to an AMS backup plan, tag the resource with the plan’s tag key-value pair. You can use AMS Resource Tagger to apply the AMS backup plans to a subset of your resources or for all supported resources in your account. If you want to use an alternate method to apply tags to your resources, such as AWS CloudFormation or Terraform, then turn oﬀ Resource Tagger so that it doesn’t compete with your chosen tagging method. For more information, see Preventing Resource Tagger from modifying resources. The following example demonstrates how you can use Resource Tagger to apply the default AMS backup plan on Amazon Elastic Compute Cloud instances in your account. For this backup plan, apply the tag key ams:rt:backup-orchestrator and value true. To use a diﬀerent backup plan, change the key to match your desired backup plan's tag key. To learn about AMS Resource Tagger and understand how to integrate the following referenced proﬁle with the current (already conﬁgured) proﬁle in your Accelerate account, see Accelerate Resource Tagger. 1. Open the AWS AppConﬁg console at https://console.aws.amazon.com/systems-manager/ appconﬁg. 2. Choose the ResourceTagger application. 3. Choose the Conﬁguration proﬁles tab, then choose CustomerManagedTags 4. Choose Create to create a new version. 5. Choose JSON, and then copy and paste the following JSON object: Tag your resources for backup Version May 08, 2025 481 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures { "AWS::EC2::Instance": { "AccelerateBackupPlan": { "Enabled": true, "Filter": { "Fn::AND": [ { "Platform": "*" } ] }, "Tags": [ { "Key": "ams:rt:backup-orchestrator", "Value": "true" } ] } } } 6. Choose Create hosted conﬁguration version. 7. Choose Start deployment. 8. Deﬁne the following deployment details: Environment: AMSInfrastructure Hosted configuration version: Select the version that you have just created. Deployment Strategy: AMSNoBakeDeployment 9. Choose Start deployment. Resource Tagger tags your instances ams:rt:backup- orchestrator: true, ensuring that your instances are backed up in accordance with the default AMS backup plan. View backups in AMS vaults To view a list of your AMS backups, open the AWS Backup console. In the navigation pane, choose Backup vaults and select the one of the AMS backup vaults from the following tables. In the Backups section, view the list of all the backups in the backup vault. Select a backup to edit, delete, or restore. View backups in AMS vaults Version May 08, 2025 482 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Vaults for AMS Backup Plans AMS Vault Name AMS Backup Plan Tag Key ams-automated-backups ams:rt:backup-orchestrator ams-automated-enhanced-backups ams:rt:backup-orchestrator-enhanced ams-automated-data-sensitive-backups ams:rt:backup-orchestrator-data-sensitive ams-onboarding-backups ams:rt:backup-orchestrator-onboarding Other AMS Vaults AMS Vault Name Description This vault contains manually started backups created by the AWSManagedServices SSM Automation -StartBackupJob document and pre-patch backups created by AMS patch automations before patching. This is the recommended vault for backups created outside of AMS backup plans. ams-manual-backups ams-custom-backups Related AWS Backup Topics • View Backups by Resource • Working with backups AMS backup monitoring and reporting Important AMS backup monitoring and reporting are only available in AMS-supported regions. Those are US East (Virginia), US West (N. California), US West (Oregon), US East (Ohio), Canada (Central), South America (São Paulo), EU (Ireland), EU (Frankfurt), EU (London), EU (Paris), Monitoring and reporting for backups Version May 08, 2025 483 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Asia Paciﬁc (Mumbai), Asia Paciﬁc (Seoul), Asia Paciﬁc (Singapore), Asia Paciﬁc (Sydney), Asia Paciﬁc (Tokyo). AMS generates daily self-service reports as well as monthly reports on resource coverage and backup job status. The monthly reports are shared in Monthly Business Reviews (MBRs). To learn more about daily backup reports, see Daily backup report. AMS experts monitor all your backup tasks that are conﬁgured using AWS Backup. In case of backup failures, AMS investigates the failure and notiﬁes you with the root cause and remediation options, if available. To avoid alert noise, during events that cause a high number of backup failures in your accounts, AMS makes a collective recommendation, through your CSDM, instead of notifying you for each individual failure. Note that AMS does not monitor any backups conﬁgured using an AWS service’s standalone backup feature. Monitoring and reporting for backups Version May 08, 2025 484 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Understand patch management in AMS Accelerate Important Accelerate Patch reporting periodically deploys an AWS Glue resource-based policy. Be advised that AMS updates to the patching system overwrite existing AWS Glue resource- based policies. You can use the AMS Accelerate patching system, Patch Add-On, to patch your instances with security-related and other types of updates. Accelerate Patch Add-On is a feature that provides tag-based patching for AMS instances. It leverages AWS Systems Manager (SSM) functionality so you can tag
accelerate-guide-151	accelerate-guide.pdf	151	standalone backup feature. Monitoring and reporting for backups Version May 08, 2025 484 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Understand patch management in AMS Accelerate Important Accelerate Patch reporting periodically deploys an AWS Glue resource-based policy. Be advised that AMS updates to the patching system overwrite existing AWS Glue resource- based policies. You can use the AMS Accelerate patching system, Patch Add-On, to patch your instances with security-related and other types of updates. Accelerate Patch Add-On is a feature that provides tag-based patching for AMS instances. It leverages AWS Systems Manager (SSM) functionality so you can tag instances and have those instances patched using a baseline and a window that you conﬁgure. The AMS Accelerate Patch Add-On is an onboarding option, if you did not obtain it during onboarding your Accelerate account, contact your cloud service delivery manager (CSDM) to get it. AMS Accelerate patch management uses the Systems Manager patch baseline functionality to control the deﬁnition of the patches that are applied on an instance. The patch baseline contains the list of patches that are pre-approved; for example, all security patches. The compliance of the instance is measured against the patch baseline associated to it. AMS Accelerate, by default, installs all patches available to keep the instance up to date. Note AMS Accelerate applies only operating system (OS) patches. For example, for Windows, only Windows updates are applied, not Microsoft updates. For information on reports, see AMS host management reports. AMS Accelerate provides a range of operational services to help you achieve operational excellence on AWS. To gain a quick understanding of how AMS helps your teams achieve overall operational excellence in AWS Cloud with some of our key operational capabilities including 24x7 helpdesk, proactive monitoring, security, patching, logging and backup, see AMS Reference Architecture Diagrams. Topics Version May 08, 2025 485 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Patching recommendations • Create a patch maintenance window in AMS • Patch with hooks • AMS Accelerate patch baseline • Creating an IAM role for on-demand patching of AMS Accelerate • Understand patch notiﬁcations and patch failures in AMS Accelerate Patching recommendations If you are involved in application or infrastructure operations, you understand the importance of an operating system (OS) patching solution that is ﬂexible and scalable enough to meet the varied requirements from your application teams. In a typical organization, some application teams use an architecture that involves immutable instances whereas others deploy their applications on mutable instances. For more information on AWS Prescriptive Guidance for patching, see Automated patching for mutable instances in the hybrid cloud using AWS Systems Manager. Note Accelerate Patch Add-On is a feature that provides tag-based patching for AMS instances. It leverages AWS Systems Manager (SSM) functionality so you can tag instances and have those instances patched using a baseline and a window that you conﬁgure. The AMS Accelerate Patch Add-On is an onboarding option, if you did not obtain it during onboarding your Accelerate account, contact your cloud service delivery manager (CSDM) to get it. Patch responsibility recommendations The patching process for persistent instances should involve the following teams and actions: • The application (DevOps) teams deﬁne the patch groups for their servers based on application environment, OS type, or other criteria. They also deﬁne the maintenance windows speciﬁc to each patch group. This information should be stored on tags attached to the instances. Recommended tag names are 'Patch Group' and 'Maintenance Window'. During each patch cycle, Patching recommendations Version May 08, 2025 486 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures the application teams prepare for patching, test the application after patching, and troubleshoot any issues with their applications and OS during patching. • The security operations team deﬁnes the patch baselines for various OS types that are used by the application teams, and make the patches available through Systems Manager Patch Manager. • The automated patching solution runs on a regular basis and deploys the patches deﬁned in the patch baselines, based on the user-deﬁned patch groups and maintenance windows. • The governance and compliance teams deﬁne patching guidelines and exception processes & mechanisms. For more information, see Patching solution design for mutable EC2 instances. Guidance for application teams • Review and become familiar with creating and managing maintenance windows; see AWS Systems Manager Maintenance Windows and Create an SSM Maintenance window for patching to learn more. Understanding the general structure and use of maintenance windows helps you understand what information to provide if you are not the person creating them. • For High Availability (HA) setups, plan to have one maintenance window per availability zone and per environment (Dev/Test/Prod). This will ensure continued availability during patching. • Recommended Maintenance Window duration is 4 hours with a 1-hour cutoﬀ, plus 1 additional hour per
accelerate-guide-152	accelerate-guide.pdf	152	instances. Guidance for application teams • Review and become familiar with creating and managing maintenance windows; see AWS Systems Manager Maintenance Windows and Create an SSM Maintenance window for patching to learn more. Understanding the general structure and use of maintenance windows helps you understand what information to provide if you are not the person creating them. • For High Availability (HA) setups, plan to have one maintenance window per availability zone and per environment (Dev/Test/Prod). This will ensure continued availability during patching. • Recommended Maintenance Window duration is 4 hours with a 1-hour cutoﬀ, plus 1 additional hour per 50 instances • Patch Dev and Test versions with enough time between each to allow you to identify any potential issues prior to Production patching. • Automate common pre- and post-patching tasks via SSM automation and run them as maintenance window tasks. Note that for post-patching tasks you must ensure that there is suﬃcient time allotted, as tasks will not launch once the cutoﬀ is reached. • Become familiar with Patch Baselines and their features—particularly around auto-approval delays for patch severity types that can be used to ensure that only the patches that were applied in Dev/Test get applied in Production at a later date. See About patch baselines for details. Guidance for security operations teams • Review and become familiar with patch baselines. Patch approval is handled in an automated fashion and has diﬀerent rule options. See About patch baselines for more information. Guidance for application teams Version May 08, 2025 487 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Discuss needs around patching Dev/Test/Prod with application teams and develop multiple baselines to accommodate these needs. Guidance for governance and compliance teams • Patching should be an "Opt Out" function. A default maintenance window and automated tagging should exist to ensure nothing goes unpatched. AMS Resource Tagger can help with this; discuss this option with your cloud architect (CA) or cloud service delivery manager (CSDM) for guidance on implementation. • Requests for exemption from patching should require documentation justifying the exemption. A Chief Information Security Oﬃcer (CISO) or other approval oﬃcer should approve or deny the request. • Patching compliance should be reviewed on a regular schedule via the Patch Manager console, Security Hub, or a vulnerability scanner. Example design for high availability Windows application Overview: • One Maintenance Window per AZ. • One Set of Maintenance Windows per Environment. Guidance for governance and compliance teams Version May 08, 2025 488 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • One Patch Baseline per Environment: • Dev: Approve all severity and classiﬁcation after 0 days. • Test: Approve critical security update patches after 0 days and all other severity and classiﬁcations after 7 days. • Prod: Approve critical security update patches after 0 days and all other severity and classiﬁcations after 14 days. CloudFormation Scripts: These scripts are setup to build out the maintenance windows, baselines, and patching tasks for a two availability zone Windows HA EC2 application using the baseline approval settings described above. • Windows Dev CFN Stack Example: HA-Patching-Dev-Stack.json • Windows Test CFN Stack Example: HA-Patching-Test-Stack.json • Windows Prod CFN Stack Example: HA-Patching-Prod-Stack.json Patch recommendations FAQs Q: How do I handle unscheduled patching for "0" day exploits? A: SSM supports a Patch Now feature that uses the current default baseline for the instance's OS. AMS deploys a default set of Patch Baselines that approves all patches after 0 days. However, when using the Patch Now feature, a pre-patch snapshot is not taken, as this command runs the AWS-RunPatchBaseline SSM document. We recommend that you take a manual backup prior to patching. Q: Does AMS support patching for instances in Auto-Scaling Groups (ASGs)? A: No. At this time, ASG patching is not supported for Accelerate customers. Q: Are there any limitations for Maintenance Windows to keep in mind? A: Yes, there are a few limitations you should be aware of. • Maintenance Windows per Account: 50 • Tasks per Maintenance Window: 20 • Maximum number of concurrent automations per Maintenance Window: 20 Patch recommendations FAQs Version May 08, 2025 489 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Maximum number of concurrent Maintenance Windows: 5 For a full list of default SSM limits, see AWS Systems Manager endpoints and quotas. Create a patch maintenance window in AMS A patch maintenance window runs AMS patch automations on a set schedule for targeted Amazon EC2 instances. Targets are deﬁned by a tag or tags for a group of instances. You can set schedules based on days and times around Patch Tuesday, or you can deﬁne a schedule using a cron expression. For more information, see Reference: Cron and rate expressions for Systems Manager in the AWS Systems Manager User Guide. Before patching, AMS creates
accelerate-guide-153	accelerate-guide.pdf	153	Maintenance Windows: 5 For a full list of default SSM limits, see AWS Systems Manager endpoints and quotas. Create a patch maintenance window in AMS A patch maintenance window runs AMS patch automations on a set schedule for targeted Amazon EC2 instances. Targets are deﬁned by a tag or tags for a group of instances. You can set schedules based on days and times around Patch Tuesday, or you can deﬁne a schedule using a cron expression. For more information, see Reference: Cron and rate expressions for Systems Manager in the AWS Systems Manager User Guide. Before patching, AMS creates a snapshot of each instance's root volume. If AMS detects that patching impacts the instance's health, or if you notify AMS of application impact from patching, then AMS uses this snapshot to restore the root volume to a pre-patch state. AMS Accelerate patch maintenance window limits AMS patching uses AWS Systems Manager (Systems Manager). In addition to Systems Manager service limits, AMS patching has a limit of 300 target instances per patch maintenance window. Given a general patch completion time of 30 mins per instance, the following table provides examples for numbers of maintenance windows and durations. Instances to patch Maintenance windows duration (hrs) Concurrent maintenance windows needed 100 200 300 600 800 1200 1500 1 1 2 3 4 6 8 1 1 1 2 3 4 5 Create patch window Version May 08, 2025 490 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Important These examples assume no other Systems Manager maintenance windows are active and no other automations are running. For more information on limits, see AWS Systems Manager endpoints and quotas. Topics • Create a recurring "Patch Tuesday" maintenance window from the AMS console (recommended) • Create a patch maintenance window using AWS CloudFormation for AMS Accelerate • Create a maintenance window from the Systems Manager console for AMS Accelerate • Create a maintenance window with the Systems Manager command line interface (CLI) for AMS Accelerate Create a recurring "Patch Tuesday" maintenance window from the AMS console (recommended) Microsoft releases patches for its operating systems on the second Tuesday of each month, also know as Patch Tuesday. It is common to schedule patching for both Windows and Linux instances relative to Patch Tuesday. To schedule recurring patch maintenance windows on the ﬁrst or second weekends after Patch Tuesday, visit the AMS console and follow these steps: 1. Provide a name for your patch maintenance window. 2. 3. 4. [optional] Provide a description for the patch maintenance window. Select a day relative to Patch Tuesday. Enter a time for the patch maintenance window to start in hh:mm. For example, midnight is 00:00 and 11pm is 23:00. Then select a timezone. 5. [optional] Change the duration to suit your needs. AMS recommends a four hour minimum duration. 6. 7. Enter a patch tag key and value for the target. For information, see What are tags?. [optional] Expand the optional parameters to adjust concurrency, error rate, and maintenance window cut-oﬀ. Create Patch Tuesday patch window: AMS console Version May 08, 2025 491 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 1. Concurrency controls how many target instances are patching at the same time. For example, a 50% concurrency for 10 target instances will patch no more that 5 instances at a time, while 100% concurrency will patch all 10 at once. 2. Error rate controls the tolerance for errors before patching is suspended. For example, an error rate of 100% for 10 target instances will patch all instances regardless of how many fail, while a 50% error rate will suspend patching once 5 instances have failed to patch. AMS recommends a 100% error rate. 3. Patch maintenance window cutoﬀ prevents breach of the patch maintenance window by suspending the start of new patching activities the speciﬁed hours before the end of the patch maintenance window. For example a cutoﬀ of 1 hour (recommended), ceases new patch activities 1 hour before the end of the patch maintenance window. Important Verify the next execution time. Visit the SSM Maintenance Window console , search for your newly created patch maintenance window, and verify the next execution time. If you have any questions or need to edit your patch maintenance window, create a service request to talk with an AMS patch expert To schedule a CRON-based patch maintenance window using CloudFormation, see Create a patch maintenance window using AWS CloudFormation for AMS Accelerate. Create a patch maintenance window using AWS CloudFormation for AMS Accelerate To create an AMS Accelerate patch maintenance window using AWS CloudFormation, ﬁrst log into your Accelerate account and select the AWS Region where your target instances reside. Then follow these steps on the https://console.aws.amazon.com/cloudformation: 1. Select one of two custom Accelerate patching CloudFormation templates. • Patch Tuesday
accelerate-guide-154	accelerate-guide.pdf	154	any questions or need to edit your patch maintenance window, create a service request to talk with an AMS patch expert To schedule a CRON-based patch maintenance window using CloudFormation, see Create a patch maintenance window using AWS CloudFormation for AMS Accelerate. Create a patch maintenance window using AWS CloudFormation for AMS Accelerate To create an AMS Accelerate patch maintenance window using AWS CloudFormation, ﬁrst log into your Accelerate account and select the AWS Region where your target instances reside. Then follow these steps on the https://console.aws.amazon.com/cloudformation: 1. Select one of two custom Accelerate patching CloudFormation templates. • Patch Tuesday Scheduling: Microsoft releases patches for its operating systems on the second Tuesday of each month, also know as Patch Tuesday, to schedule patch maintenance Create patch window: AWS CloudFormation Version May 08, 2025 492 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures windows on the ﬁrst or second weekends after Patch Tuesday: Once logged into the Accelerate console, use this link PatchTuesdayScheduling CloudFormation template . • CRON Scheduling: To create patch maintenance windows using CRON to deﬁne the start day, use this link CRONScheduling CloudFormation template. Remember that Systems Manager CRON numbers days 1-7 (for details on Systems Manager CRON, see Reference: Cron and rate expressions for Systems Manager). Choosing one of these links causes the template to load automatically on the CloudFormation console. Then click Next. 2. On the Specify stack details page (step 2 of the Create Stack pages), enter a stack name and template parameters (default parameters shown are AMS recommended defaults, select day and times for your use case). When ﬁnished, click Next. 3. Conﬁgure Stack Options (Optional). For information on the options, see Setting AWS CloudFormation stack options. When ﬁnished, click Next. 4. Review your stack values (Optional). For information on reviewing stack details to estimate costs, see Reviewing your stack and estimating stack cost. When ready, click Create stack. The stack may take up to a minute to create. Once the stack is created successfully, your patch maintenance window runs at the speciﬁed time. You can make changes to your patch maintenance window by creating and executing a CloudFormation change set (recommended) (for details on doing this, see Creating stacks using changesets), or by updating the patch maintenance window on the Systems Manager Maintenance window console (https:// console.aws.amazon.com/systems-manager/maintenance-windows). Watch Namrata’s video to learn more (5:41) Create a maintenance window from the Systems Manager console for AMS Accelerate To create an AMS Accelerate maintenance window from the Systems Manager console, follow these steps: 1. In the left navigation bar in the Change management area, click Maintenance Windows, and then click Create Maintenance Window at the top right of the screen. Fill in the form. For details on any of the options, see Create a maintenance window (console). When ﬁnished, click Create maintenance window. Create patch window: Systems Manager console Version May 08, 2025 493 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures The maintenance windows list page opens. 2. Select the newly created maintenance window. The maintenance window details page opens. 3. Go to the Targets tab and choose Register target. The Register target page opens. 4. Add your Accelerate target. For information on targets, see Assign targets to a maintenance window (console). When ﬁnished, click Register target. Make note of the target as you need it later. The maintenance windows details page reopens on the Targets tab with a list including the new target. 5. On the Tasks tab of the maintenance window details page, choose Register Task, and then pick Register Automation task from the drop-down list. Fill in the form. Accelerate notes: • Provide a meaningful task name. For example: AcceleratePatch. • In the Automation document area click in the search box, choose Owner, then Shared documents. • Select the automation document by clicking in the search box and choosing Document name preﬁx --> Equals and then typing: AWSManagedServices-PatchInstance. Then select the AWSManagedServices-PatchInstance document by selecting its radio button. • Under document version, choose Default version at runtime. • In the Targets section: • Set Target by: to Selecting registered target groups. • In the list of targets, select the target you registered in the Targets tab. • In the Input parameters section, ﬁll in the form. • InstanceId: {{TARGET_ID}} • StartInactiveInstances: True to start the instances if they are stopped during the patch maintenance window. Note The InstanceId parameter value is case sensitive and the StartInactiveInstances parameter value can be either True or False. Create patch window: Systems Manager console Version May 08, 2025 494 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Stopped instances cannot be started when targeted by tags. For more information, see No Invocations to Execute. • In the Rate control section, choose percentages. AMS Accelerate recommends 100% for Concurrency and 100% for Error
accelerate-guide-155	accelerate-guide.pdf	155	Input parameters section, ﬁll in the form. • InstanceId: {{TARGET_ID}} • StartInactiveInstances: True to start the instances if they are stopped during the patch maintenance window. Note The InstanceId parameter value is case sensitive and the StartInactiveInstances parameter value can be either True or False. Create patch window: Systems Manager console Version May 08, 2025 494 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Stopped instances cannot be started when targeted by tags. For more information, see No Invocations to Execute. • In the Rate control section, choose percentages. AMS Accelerate recommends 100% for Concurrency and 100% for Error threshold to attempt to patch all instances simultaneously, regardless of automation errors. If you wish to patch half your targets at a time, for example, to keep a half of the target instances behind a load balance running, set Concurrency to 50%. • In the IAM service role section,choose Use a custom service role, then choose the ams_ssm_automation_role. Click Register Automation task. The patching maintenance window is created. Under the Description tab, you can see the Next execution time. Create a maintenance window with the Systems Manager command line interface (CLI) for AMS Accelerate To create an AMS Accelerate maintenance window with the command line interface: 1. Follow the SSM Tutorial: Create and conﬁgure a maintenance window (AWS CLI) . For each step of the tutorial, here are sample CLI commands for patching. Note These examples are speciﬁc to Linux or macOS. The commands can also be run from AWS CloudShell which may be simpler than conﬁguring awscli on a local machine. For details, see Working with AWS CloudShell. a. In step 1 of the tutorial, to create a maintenance window: aws ssm create-maintenance-window \ --name Sample-Maintenance-Window \ --schedule "cron(0 30 23 ? * TUE#2 *)" \ --duration 4 \ Create patch window: Systems Manager CLI Version May 08, 2025 495 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures --cutoff 1 \ --allow-unassociated-targets \ --tags "Key=Environment,Value=Production" On successful completion, window-id is returned. b. In step 2 of the tutorial, to register a target node: aws ssm register-target-with-maintenance-window \ --window-id "mw-xxxxxxxxx" \ --resource-type "INSTANCE" \ --target "Key=tag:Environment,Values=Prod" On successful completion, WindowTargetIDs are returned. c. In step 3 of the tutorial, to register a task: aws ssm register-task-with-maintenance-window \ --window-id "mw-xxxxxx" \ --targets "Key=WindowTargetIds,Values=63d4f63c-xxxxxx-9b1d-xxxxxfff" \ --task-arn "AWSManagedServices-PatchInstance" \ --service-role-arn "arn:aws:iam::AWS-Account-ID:role/ams_ssm_automation_role" \ --task-invocation-parameters "{\"Automation\":{\"DocumentVersion\":\"\$DEFAULT \",\"Parameters\":{\"InstanceId\":[\"{{TARGET_ID}}\"],\"StartInactiveInstances\": [\"True\"]}}}" \ --max-concurrency 50 \ --max-errors 50 \ --name "AutomationExample" \ --description "Sample Description" \ --task-type=AUTOMATION Patch with hooks You can conﬁgure AMS patching to run operating-system (OS) level commands before and after patching, using AMS patch hooks. Use AMS patch hooks to run SSM Command documents to stop a service before patching and then start the service after patching, or to run commands to conﬁrm that your application is healthy after patching. To use AMS patch hooks, you need to do the following: Patch with hooks Version May 08, 2025 496 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 1. Create SSM Command documents to use as patch hooks. 2. Create an AMS patch maintenance window, or use an existing AMS patch maintenance window. For details, see AMS patch maintenance window. 3. Conﬁgure an AMS patch maintenance window to use your SSM Command documents for AMS patch hooks. AMS patch hooks RACI The responsible, accountable, consulted, and informed, or RACI, matrix assigns the primary responsibility to either the customer or AMS for a variety of activities. The following table provides an overview of the responsibilities of customer and AMS for activities in an application that uses AMS patch hooks. • R stands for the responsible party that does the work to achieve the task • A stands for the accountable party • C stands for consulted; the party whose opinions are sought, typically as subject matter experts; and with whom there is bilateral communication • I stands for informed; the party that is informed on progress, often only on completion of the task or deliverable Activity Customer AMS Create pre/post patch SSM Command document and document content Conﬁgure patch hook parameters for AMS patching Execute pre/post patch SSM Command document Triage and respond to patch hook failures R R I I C C R R AMS patch hooks RACI Version May 08, 2025 497 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Activity Customer AMS Notify customer of patch hook failure Rollback to a pre-patch state if requested by customer I C R R Create SSM documents for patch hooks AMS patch hooks use Amazon EC2 Systems Manager (SSM) documents during patching. Create an SSM Command document, or share an existing SSM Command document, with the account where patching occurs. For information about SSM documents, including limitations, see Sharing SSM documents. To create an SSM Command document, follow these steps: 1. Create an SSM
accelerate-guide-156	accelerate-guide.pdf	156	AMS patch hooks RACI Version May 08, 2025 497 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Activity Customer AMS Notify customer of patch hook failure Rollback to a pre-patch state if requested by customer I C R R Create SSM documents for patch hooks AMS patch hooks use Amazon EC2 Systems Manager (SSM) documents during patching. Create an SSM Command document, or share an existing SSM Command document, with the account where patching occurs. For information about SSM documents, including limitations, see Sharing SSM documents. To create an SSM Command document, follow these steps: 1. Create an SSM document with Document Type = "Command". 2. Enter your command(s) in the Content section. For more information, see Creating SSM document content. Note SSM documents for AMS patch hooks can also be created with AWS CLI or AWS CloudFormation. If you need assistance creating SSM documents for your AMS patch hooks, contact your Cloud Architect. Conﬁgure AMS patch maintenance window to use your SSM Command documents as AMS patch hooks An AMS patch maintenance window is a Systems Manager maintenance window that executes your conﬁgured AMS patch automation. To edit an AMS patch maintenance window to use patch hooks, follow these steps: Create SSM documents for patch hooks Version May 08, 2025 498 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 1. On the https://console.aws.amazon.com/systems-manager/, under Change Management Tools in the left navigation pane, select Maintenance Windows. A page listing existing maintenance windows opens. 2. Select a Window ID that starts with mw-. The details page for that maintenance window opens. 3. Select the Tasks tab and the Window Task ID with the Task ARN of AMS-PatchInstance and click Edit. 4. Scroll down to the Parameters section and update the following parameters. AMS patch hook parameters: • PrePatchHook: The name of the SSM document with type "Command" that you want to run before patching. Leave this blank or type "AWS-Noop" (case-sensitive) if you aren’t running a command before patching. • PostPatchHook: The name of the SSM document with type "Command" that you want to run after patching. Leave this blank or type "AWS-Noop" (case-sensitive) if you aren’t running a command after patching. • ExecutePatchBasedOnPreHookStatus: Run patching based on the success or failure of the PrePatchHook run, choose one: • OnPreHookSuccess: Only run AMS patch automation when the PrePatchHook is successful. • Always: Run AMS patch automation when the PrePatchHook is successful and when it fails. • OnPreHookFailure - Run AMS patch automation only when the PrePatchHook fails. Conﬁgure AMS patch maintenance window to use your SSM Command documents as AMS patch hooks Version May 08, 2025 499 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Never: Do not run AMS patch automation. This may be useful when testing your PrePatchHook. • ExecutePostHookBasedOnPatchStatus: Run the post-patch hook based on success or failure of the AMS patch automation, choose one: • OnPatchSuccess: Only run the PostPatchHook when AMS patch automation runs successfully. • Always: Run the PostPatchHook when AMS patch automation is successful and when it fails. • OnPatchFailure - Run the PostPatchHook only when AMS patch automation fails. Note If any of these variables are missing their text box, remedy this by scrolling up to the Automation document section on the same page and selecting a diﬀerent document and then re-selecting the original document. This refreshes input parameters so you can edit them. AMS Accelerate patch baseline A patch baseline deﬁnes which patches are approved for installation on your instances. You can specify approved or rejected patches one by one. You can also create auto-approval rules to specify that certain types of updates (for example, critical updates) should be automatically approved. The rejected list overrides both the rules and the approve list. Default patch baseline When you onboard to AMS Accelerate patching, the default patch baselines are overridden by the AMS Accelerate default patch baselines for the following operating systems. • Windows • Amazon Linux 1 • Amazon Linux 2 • CentOS • Suse • Rhel AMS Accelerate patch baseline Version May 08, 2025 500 AMS Accelerate User Guide • Ubuntu Important AMS Accelerate Concepts and Procedures Default patch baselines are managed by AMS. Do not edit default patch baselines as your changes may be lost. Instead, create a custom patch baseline. See Custom patch baseline with AMS Accelerate Note The AMS Accelerate patch baselines deﬁned as product = * mean that all patches are applied to the instance of all security and classiﬁcations. Custom patch baseline with AMS Accelerate To use a custom patch baseline with AMS Accelerate, ﬁrst make sure that you have a patch group, and then create the custom baseline. For more information, see the following resources: • Working with patch groups • Creating a custom patch baseline (Windows) • Creating a custom patch
accelerate-guide-157	accelerate-guide.pdf	157	patch baselines as your changes may be lost. Instead, create a custom patch baseline. See Custom patch baseline with AMS Accelerate Note The AMS Accelerate patch baselines deﬁned as product = * mean that all patches are applied to the instance of all security and classiﬁcations. Custom patch baseline with AMS Accelerate To use a custom patch baseline with AMS Accelerate, ﬁrst make sure that you have a patch group, and then create the custom baseline. For more information, see the following resources: • Working with patch groups • Creating a custom patch baseline (Windows) • Creating a custom patch baseline (Linux) • Updating or deleting a custom patch baseline (console) Creating an IAM role for on-demand patching of AMS Accelerate After your account is onboarded to AMS Accelerate patching, AMS Accelerate deploys a managed policy, amspatchmanagedpolicy. This policy contains the required permissions for on-demand patching using the AMS automation document AWSManagedServices-PatchInstance. To use this automation document, the account administrator creates a IAM role for users. Follow these steps: Custom patch baseline Version May 08, 2025 501 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Create a role using the AWS Management Console: 1. Sign in to the AWS Management Console and open the IAM console. 2. In the navigation pane of the console, choose Roles, then Create role. 3. Choose the Another AWS account role type. 4. For Account ID, enter the AWS account ID that you want to grant access to your resources. The administrator of the speciﬁed account can grant permission to assume this role to any IAM user in that account. To do this, the administrator attaches a policy to the user, or a group, that grants permission for the sts:AssumeRole action. That policy must specify the role's Amazon Resource Name (ARN) as the resource. Note the following: • If you are granting permissions to users from an account that you do not control, and the users will assume this role programmatically, then choose Require external ID. The external ID can be any word or number that is agreed upon between you and the administrator of the third-party account. This option automatically adds a condition to the trust policy that enables the user to assume the role only if the request includes the correct sts:ExternalID. For more information, see How to use an external ID when granting access to your AWS resources to a third party. • If you want to restrict the role to users who sign in with multi-factor authentication (MFA), choose Require MFA. This adds a condition to the role's trust policy that checks for an MFA sign-in. A user who wants to assume the role must sign in with a temporary one-time password from a conﬁgured MFA device. Users without MFA authentication can't assume the role. For more information about MFA, see Using multi-factor authentication (MFA) in AWS. 5. Choose Next: Permissions. IAM includes a list of policies in the account. Under Add Permissions, enter amspatchmanagedpolicy in the ﬁlter box and select the checkbox for this permissions policy. Click Next. 6. Under Role details, enter a Role name such as PatchRole, add a description for the role (recommended), also add tags to help you identify this role. Role names aren't case sensitive, but must be unique within the AWS account. When ﬁnished, click Create Role. Note Role names can't be edited after they've been created. On-demand patching permissions Version May 08, 2025 502 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Understand patch notiﬁcations and patch failures in AMS Accelerate Important Beginning February 1, 2025, AMS customers will no longer receive notiﬁcations for empty Patch Maintenance Windows in their managed accounts. Patch service requests and email notiﬁcations AMS creates a new service request four days before the next Patch Maintenance Window. For example, four days before a Patch Maintenance Window named App1 PROD runs, AMS creates a service request titled April Patch Maintenance Window for App1 Prod for Account [account id]. Use the patch service request to communicate with AMS if you need adjustments to your scheduled patch, or to skip an upcoming patch. When a service request is created, an email is sent to your patch notiﬁcation address with a link to the service request. You receive an additional email each time that AMS updates the service request. Note AMS creates a new service request, even if the Patch Maintenance Window is created less than four days before it's scheduled to run. The Patch Maintenance window must be in an “enabled” state to receive Service Request notiﬁcations. One hour before patching begins, AMS notiﬁes you through the patch service request. After patching completes, AMS updates the patch service request with a link to the Patch Manager console. Use the link to view patch compliance for the instances targeted by
accelerate-guide-158	accelerate-guide.pdf	158	a link to the service request. You receive an additional email each time that AMS updates the service request. Note AMS creates a new service request, even if the Patch Maintenance Window is created less than four days before it's scheduled to run. The Patch Maintenance window must be in an “enabled” state to receive Service Request notiﬁcations. One hour before patching begins, AMS notiﬁes you through the patch service request. After patching completes, AMS updates the patch service request with a link to the Patch Manager console. Use the link to view patch compliance for the instances targeted by the Patch Maintenance Window. Note The links in the Patch Manager console show the current compliance of the instances. Patch Manager shows an instance as non-compliant if new patches are released between the time that AMS completes patching and you access the link. Understand patch notiﬁcations and patch failures Version May 08, 2025 503 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Patch notiﬁcations through CloudWatch Events AMS sends CloudWatch Events three times during the patch process including the following: • Four days before the Patch Maintenance Window runs. • One hour before the Patch Maintenance Window runs. • When the Patch Maintenance Window completes. The following is the Patch Maintenance Window advanced notice event schema: { "version": "0", "id": "37004d81-458d-2cef-fe1c-8afa8af30406", "detail-type": "AMS Patch Window Execution State Change", "source": "aws.managedservices", "account": "145917996532", "time": "2021-05-20T02:00:00Z", "region": "us-east-1", "resources": [ "arn:aws:ssm:us-east-1:123456789012:maintenancewindow/mw-00000001235", "arn:aws:ec2:us-east-1:123456789012:instance/i-0000000aaaaaaaaaa", "arn:aws:ec2:us-east-1:123456789012:instance/i-0000000aaaaaaaaab" ], "detail": { "State": "PREEMPTIVE", "StartTime": "2021-05-24T02:00:00.000000", "WindowArn": "arn:aws:ssm:us-east-1:123456789012:maintenancewindow/ mw-00000001235", "Results": "[{\"instanceId\": \"i-0000000aaaaaaaaaa\"}, {\"instanceId\": \"i-0000000aaaaaaaaab\"}]" } } The following table describes the Patch Maintenance Window advance notice event schema: Patch notiﬁcations through CloudWatch Events Version May 08, 2025 504 AMS Accelerate User Guide Patch notiﬁcation details AMS Accelerate Concepts and Procedures Property name Description Sample values State Status StartTime WindowArn Results The state of the patching maintenance window PREEMPTIVE - The patching window scheduled to begin soon The status of the patching maintenance window SUCCESS - All instances were patch without failure FAILED – At least one instance has failed to patch The start time, in ISO format, of the patching maintenance 2021-02-03T22:14:0 5.814308 window The unique identiﬁer of the Patching Maintenance Window arn:aws:ssm:us-east-1: 123456789012:maint enancewindow/mw-00 000001235 The list of instances that are targeted by the patch window InstanceId – the instance ID of the targeted instance The following is the Patch Maintenance Window end event schema: {"version": "0", "id": "0f25add5-44a9-0702-d2bc-bd2102affefe", "detail-type": "AMS Patch Window Execution State Change", "source": "aws.managedservices", "account": "123456789012", "time": "2021-02-03T22:14:06Z", "region": "us-east-1", "resources": [ "arn:aws:ssm:us-east-1:123456789012:maintenancewindow/mw-00000001235", "arn:aws:ec2:us-east-1:123456789012:instance/i-0000000aaaaaaaaaa", "arn:aws:ec2:us-east-1:123456789012:instance/i-0000000aaaaaaaaab" ], Patch notiﬁcations through CloudWatch Events Version May 08, 2025 505 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures "detail": {"State": "[COMPLETED]", "Status": "SUCCESS", "StartTime": "2021-02-03T22:12:00.814308", "EndTime": "2021-02-03T22:14:05.814309", "WindowArn": "arn:aws:ssm:us-east-1:123456789012:maintenancewindow/ mw-00000001235", "WindowExecutionId": "e32088eb-c05f-4c63-b766-6866e163c818", "Results": "[{\"instanceId\": \"i-0000000aaaaaaaaaa\", \"status\": \"Success\", \"missing_critical_patch_count\": 0, \"missing_total_patch_count \": 0} }, {\"instanceId\": \"i-0000000aaaaaaaaab\", \"status\": Success}, \"missing_critical_patch_count\": 0, \"missing_total_patch_count\": 0}]" } } The following table describes the Patch Maintenance Window end event schema: Patch window end details Property name Description Sample values State Status StartTime EndTime WindowArn The state of the patching maintenance window COMPLETED – The patching window is ﬁnished The status of the patching maintenance window SUCCESS – All instances were patch without failure FAILED – At least one instance has failed to patch The start time, in ISO format, of the patching maintenance window 2021-02-03T22:14:0 5.814308 The end time, in ISO format, of the patching maintenance window 2021-02-03T23:14:0 5.814308 The unique identiﬁer of the patching maintenance window. arn:aws:ssm:us-east-1: 123456789012:maint enancewindow/mw-00 000001235 Patch notiﬁcations through CloudWatch Events Version May 08, 2025 506 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Property name Description Sample values WindowExecutionId The window execution ID, which can be seen from the e32088eb-c05f-4c63- b766-6866e163c818 SSM Maintenance Window Console Results The list of instances that will be targeted by the patch InstanceId – the instance ID targeted window status – the instance patch status missing_critical_patch_count - the count of critical patches missing on the instance missing_total_patch_count - the count of total patches missing on the instance You can use the CloudWatch Events event to trigger a CloudWatch rule that notiﬁes you when a Patching Maintenance Window advance notice is sent. To do this, conﬁgure the CloudWatch rule with the following conﬁguration: { "source": [ "aws.managedservices" ], "detail-type": [ "AMS Patch Window Execution State Change" ], "detail": { "State": ["PREEMPTIVE"] } } Patch notiﬁcations through CloudWatch Events Version May 08, 2025 507 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Note Patch failure alerts aren't created for instances that have unsupported operating systems, or that are stopped during the maintenance window. Patch failure investigation in AMS AWS Managed Services (AMS) manages patching and includes patch failure remediation. When patching fails, AMS Operations is alerted and attempts remediation by following AWS and AMS best practices to address the issue.
accelerate-guide-159	accelerate-guide.pdf	159	the following conﬁguration: { "source": [ "aws.managedservices" ], "detail-type": [ "AMS Patch Window Execution State Change" ], "detail": { "State": ["PREEMPTIVE"] } } Patch notiﬁcations through CloudWatch Events Version May 08, 2025 507 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Note Patch failure alerts aren't created for instances that have unsupported operating systems, or that are stopped during the maintenance window. Patch failure investigation in AMS AWS Managed Services (AMS) manages patching and includes patch failure remediation. When patching fails, AMS Operations is alerted and attempts remediation by following AWS and AMS best practices to address the issue. If a patch fails, then AMS creates an SSM OpsItem in the account with the following title: AWS Managed Services – Patch Instance failure for instance <instance-id>. AMS then investigates the OpsItem. If AMS can correct the failure without your intervention, then AMS resolves the OpsItem. If your intervention is required, then AMS notiﬁes you through a service request that contains the investigation results and the recommended remediation steps. If you don't take action to resolve the issue, then AMS attempts to patch the instance during the next scheduled Patch Maintenance Window. Note Patch failure OpsItems aren't created for instances that have unsupported operating systems, or that are in the Stopped state during the Patch Maintenance Window. Patch failure investigation Version May 08, 2025 508 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Cost optimization with AMS Resource Scheduler The AMS Resource Scheduler on AWS solution helps you reduce your AWS and AMS costs by stopping resources that are not in use and starting resources when capacity is needed. For example, you can use AMS Resource Scheduler on AWS in a development environment to automatically stop instances outside of business hours every day. If you leave all of your instances running at full utilization, this solution can result in reducing the instance utilization, which reduces overall cost based on the schedules you conﬁgure. Use AWS Managed Services (AMS) Resource Scheduler to schedule the automatic start and stop of Auto Scaling groups, Amazon EC2 instances, and Amazon RDS instances in your account. This helps reduce infrastructure costs where the resources are not meant to be running 24/7. The solution is built on top of AWS Instance Scheduler but contains additional features and customizations speciﬁc to AMS customer needs. The customization includes support for scheduling Auto Scaling groups, CloudWatch alarm suppressor for Elastic Load Balancing alarms, support for multiple AWS Systems Manager maintenance windows for Amazon EC2, a cost savings estimator, and operational support from AMS. AMS Resource Scheduler uses periods and schedules. Periods deﬁne the times the resource should run, such as start time, end time, and days of the month. Schedules contain your deﬁned periods, along with additional conﬁgurations—SSM maintenance window, timezone, hibernate, etc—and specify when resources should run. You can conﬁgure these periods and schedules using AMS- provided AWS Systems Manager automation runbooks. Each schedule must contain at least one period that deﬁnes the time(s) the instance should run. A schedule can contain more than one period. When more than one period is used in a schedule, the Instance Scheduler applies the appropriate start action when at least one of the period rules is true. For more details on schedule and periods, see Solutions Components of AWS Instance Scheduler. AMS Resource Scheduler uses AWS resource tags to associate a schedule to one or more resources in order to target them for scheduled start and stop actions. You tag your resources with the tag key (default is Schedule) conﬁgured in the Scheduler with the schedule name as the value. You conﬁgure the same tag key as the cost allocation tag in AWS Cost Explorer for the cost estimator feature of Scheduler to track and report on cost savings. AMS Resource Scheduler is an opt in feature that you can enable per account. Version May 08, 2025 509 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Using resources with AMS Resource Scheduler Amazon EC2 • Amazon EC2 instances that are part of an Auto Scaling group aren't processed individually and skipped by AMS Resource Scheduler, even if they are tagged. • If the target instance root volume is encrypted with a AWS KMS customer master key (CMK), an additional kms:CreateGrant permission needs to be added to your Resource Scheduler IAM role, for the scheduler to be able to start such instances. This permission is not added to the role by default for improved security. If you require this permission, you can add the permission by updating the CloudFormation stack, ams-resource-scheduler, with a list of CMK as value to the UseCMK parameter (use one or more CMK Key ARNs in the format arn:partition:kms:region:account-id:key/key-id instead of a KMS alias). • If your Amazon EC2 instances are conﬁgured with speciﬁc software, or
accelerate-guide-160	accelerate-guide.pdf	160	with a AWS KMS customer master key (CMK), an additional kms:CreateGrant permission needs to be added to your Resource Scheduler IAM role, for the scheduler to be able to start such instances. This permission is not added to the role by default for improved security. If you require this permission, you can add the permission by updating the CloudFormation stack, ams-resource-scheduler, with a list of CMK as value to the UseCMK parameter (use one or more CMK Key ARNs in the format arn:partition:kms:region:account-id:key/key-id instead of a KMS alias). • If your Amazon EC2 instances are conﬁgured with speciﬁc software, or vendor licences managed by AWS License Manager, Resource Scheduler needs permissions to the speciﬁc AWS License Manager licences to be able to start the instance. You can grant Resource Scheduler the necessary permissions by adding the list of ARN(s) of the AWS License Manager licences to the License manager license for EC2 instance parameter of the CloudFormation stack (ams- resource-scheduler). Amazon EC2 Auto Scaling • AMS Resource Scheduler starts or stops the auto scaling of Auto Scaling groups, not individual instances in the group. That is, the scheduler restores the size of the Auto Scaling group (start) or sets the size to 0 (stop). • Tag Auto Scaling group with the speciﬁed tag and not the instances within the group. • During stop, AMS Resource Scheduler stores the Auto Scaling group's Minimum, Desired, and Maximum capacity values and sets the Minimum and Desired Capacity to 0. During start, the scheduler restores the Auto Scaling group size as it was during the stop. Therefore, Auto Scaling group instances must use an appropriate capacity conﬁguration so that the instances' termination and relaunch don't aﬀect any application running in the Auto Scaling group. • If the Auto Scaling group is modiﬁed (the minimum or maximum capacity) during a running period, the scheduler stores the new Auto Scaling group size and uses it when restoring the group at the end of a stop schedule. Using resources with Resource Scheduler Version May 08, 2025 510 AMS Accelerate User Guide Amazon RDS AMS Accelerate Concepts and Procedures • The scheduler can take a snapshot before stopping the RDS instances (does not apply to Aurora DB cluster). This feature is turned on by default with the Create RDS Instance Snapshot AWS CloudFormation template parameter set to true. The snapshot is kept until the next time the Amazon RDS instance is stopped and a new snapshot is created. • Scheduler can start/stop Amazon RDS instance that are part of a cluster or Amazon RDS Aurora database or in a multi availability zone (Multi-AZ) conﬁguration. However, check Amazon RDS limitation when the scheduler won't be able to stop the Amazon RDS instance, especially Multi- AZ instances. • To schedule Aurora Cluster for start or stop use the Schedule Aurora Clusters template parameter (default is true). The Aurora cluster (not the individual instances within the cluster) must be tagged with the tag key deﬁned during initial conﬁguration and the schedule name as the tag value to schedule that cluster. Note The Resource Scheduler doesn't validate that a resource is started or stopped. It makes the API call for the relevant service and moves on. If the API call fails, it logs the error for investigation. AMS Resource Scheduler does not support AWS Backup window. If you map an AWS Backup-enabled RDS instance with Resource Scheduler schedule, for the backup to work as expected, the backup window must lie within the running window of the schedule. Onboarding AMS Resource Scheduler Your account is not automatically onboarded to AMS Resource Scheduler when your account is onboarded to the AMS Accelerate operations plan. However, as part of account onboarding to the AMS Accelerate operation plan, or anytime after, you can request your Cloud Service Delivery Manager (CSDM) to onboard the account to AMS Resource Scheduler. Once your CSDM onboards the account, a CloudFormation stack containing AMS Resource Scheduler resources with default conﬁguration, is automatically provisioned into your account. After the AMS Resource Scheduler is provisioned in your account, we recommend you review the default conﬁguration and, if required, customize conﬁgurations such as tag key, timezone, Onboarding Resource Scheduler Version May 08, 2025 511 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures scheduled services, and so forth, based on your preferences. For details on the recommended customizations, see Customizing AMS Resource Scheduler, next. Customizing AMS Resource Scheduler When onboarded, AMS Resource Scheduler is deployed as a CloudFormation stack, with name ams-resource-scheduler, in the primary AWS region for your AMS Accelerate account. You can conﬁgure the properties of AMS Resource Scheduler based on your preferences through CloudFormation stack parameters and performing a stack update. For information on updating CloudFormation stacks, see Updating stacks directly. We recommend you customize the following properties and leave the
accelerate-guide-161	accelerate-guide.pdf	161	AMS Accelerate User Guide AMS Accelerate Concepts and Procedures scheduled services, and so forth, based on your preferences. For details on the recommended customizations, see Customizing AMS Resource Scheduler, next. Customizing AMS Resource Scheduler When onboarded, AMS Resource Scheduler is deployed as a CloudFormation stack, with name ams-resource-scheduler, in the primary AWS region for your AMS Accelerate account. You can conﬁgure the properties of AMS Resource Scheduler based on your preferences through CloudFormation stack parameters and performing a stack update. For information on updating CloudFormation stacks, see Updating stacks directly. We recommend you customize the following properties and leave the rest at default for optimal functionality. • Tag name: The name of the tag that Resource Scheduler will use to associate instance schedules with resources. The default value is Schedule. • Service(s) to schedule: A comma-separated list of services that Resource Scheduler can manage. The default value is "ec2,rds,autoscaling". Valid values are "ec2", "rds" and "autoscaling". • Default time zone:Specify the default time zone for the Resource Scheduler to use. The default value is UTC. • CMK for encrypted EBS volumes: A comma-separated list of Amazon KMS Customer Managed Key (CMK) ARNs that Resource Scheduler can be granted permissions to. • License manager license for EC2 instance: A comma-separated list of AWS Licence Manager ARNs to that Resource Scheduler can be granted permissions to. Note AMS occasionally releases features and ﬁxes to keep AMS Resource Scheduler up to date in your account. When this happens, any customization that you make to the AMS Resource Scheduler stack via stack parameters are preserved. We strongly recommend against making any customization directly to any of the component resource of AMS Resource Scheduler. Doing so impacts Resource Scheduler functionality and AMS’s ability to keep it up to date. Customizing Resource Scheduler Version May 08, 2025 512 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Using AMS Resource Scheduler How to use AMS Resource Scheduler periods in AMS Accelerate accounts. Use the following set of AWS Systems Manager automation runbooks to administer the required schedule and period in AMS Resource Scheduler. Note These SSM automation runbooks are available in the primary AWS Region of your account. • AWSManagedServices-AddOrUpdatePeriod • AWSManagedServices-AddOrUpdateSchedule • AWSManagedServices-DeleteScheduleOrPeriod • AWSManagedServices-DescribeScheduleOrPeriods • AWSManagedServices-EnableOrDisableAMSResourceScheduler Additionally, AMS provisions an AWS Identity and Access Management role, ams_resource_scheduler_ssm_automation_role, that AWS Systems Manager requires and assumes in order to use the runbooks. The IAM role is scoped down with a least privilege inline policy granting SSM permissions required for the functionality of the runbooks. Prerequisites Perform the following steps before you begin using the SSM automation runbook and AMS Resource Scheduler. Attach the following policy to the appropriate IAM entity (user, group or role) that you want to allow to use the automation runbooks to administer the schedule and period in AMS Resource Scheduler. The policy is not required if your IAM entity has Administrator or PowerUser permission in your account. { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowPassingResourceSchedulerRole", "Effect": "Allow", Using Resource Scheduler Version May 08, 2025 513 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures "Action": "iam:PassRole", "Resource": "arn:aws:iam::ACCOUNT_ID:role/ ams_resource_scheduler_ssm_automation_role", "Condition": { "StringEquals": { "iam:PassedToService": "ssm.amazonaws.com" } } }, { "Sid": "ListAndDescribeAutomationExecutions", "Effect": "Allow", "Action": [ "ssm:GetAutomationExecution", "ssm:DescribeAutomationStepExecutions" ], "Resource": "arn:aws:ssm::ACCOUNT_ID:automation-execution/" }, { "Sid": "ListAndDescribeResourceSchedulerSSMDocuments", "Effect": "Allow", "Action": [ "ssm:ListDocumentVersions", "ssm:DescribeDocument", "ssm:ListDocumentMetadataHistory", "ssm:DescribeDocumentParameters", "ssm:GetDocument", "ssm:DescribeDocumentPermission" ], "Resource": [ "arn:aws:ssm:::document/AWSManagedServices-AddOrUpdatePeriod", "arn:aws:ssm:::document/AWSManagedServices-AddOrUpdateSchedule", "arn:aws:ssm:::document/AWSManagedServices-DeleteScheduleOrPeriod", "arn:aws:ssm:::document/AWSManagedServices-DescribeScheduleOrPeriods", "arn:aws:ssm:::document/AWSManagedServices- EnableOrDisableAMSResourceScheduler" ] }, { "Sid": "AllowExecutionOfResourceSchedulerSSMDocuments", "Effect": "Allow", "Action": [ "ssm:StartAutomationExecution" ], Using Resource Scheduler Version May 08, 2025 514 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures "Resource": [ "arn:aws:ssm:::automation-definition/AWSManagedServices- AddOrUpdatePeriod:", "arn:aws:ssm:::automation-definition/AWSManagedServices- AddOrUpdateSchedule:", "arn:aws:ssm:::automation-definition/AWSManagedServices- DeleteScheduleOrPeriod:", "arn:aws:ssm:::automation-definition/AWSManagedServices- DescribeScheduleOrPeriods:", "arn:aws:ssm:::automation-definition/AWSManagedServices- EnableOrDisableAMSResourceScheduler:" ] }, { "Sid": "AllowListingAllDocuments", "Effect": "Allow", "Action": "ssm:ListDocuments", "Resource": "" }, { "Sid": "AllowListingAllSSMExecutions", "Effect": "Allow", "Action": "ssm:DescribeAutomationExecutions", "Resource": "" }, { "Sid": "AllowListingIAMRolesForStartingExecutionViaConsole", "Effect": "Allow", "Action": "iam:ListRoles", "Resource": "" } ] } You can run the automation either from AWS Systems Manager console or using the AWS CLI. If using the AWS CLI, you might need to install and conﬁgure it or the AWS tools for PowerShell, if you haven't already. For information, see Install or upgrade AWS command line tools. Watch Navish's video to learn more (4:52) Using Resource Scheduler Version May 08, 2025 515 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Working with periods and schedules in AWS Managed Services Resource Scheduler You can use AMS Resource Scheduler to add, update, or delete schedules or periods in AMS Accelerate accounts. Adding or updating periods in AMS Resource Scheduler Add or update a Resource Scheduler period in your AMS accounts. Data you'll need: • Action: The type of operation to perform. Use "add" if you want to add a period or "update" if you want to update an existing period. • Name: The name of the period. You must specify a unique value if
accelerate-guide-162	accelerate-guide.pdf	162	Accelerate User Guide AMS Accelerate Concepts and Procedures Working with periods and schedules in AWS Managed Services Resource Scheduler You can use AMS Resource Scheduler to add, update, or delete schedules or periods in AMS Accelerate accounts. Adding or updating periods in AMS Resource Scheduler Add or update a Resource Scheduler period in your AMS accounts. Data you'll need: • Action: The type of operation to perform. Use "add" if you want to add a period or "update" if you want to update an existing period. • Name: The name of the period. You must specify a unique value if you are adding a new period. • AutomationAssumeRole: The ARN of the AWS Identity and Access Management (IAM) role that allows the runbook to add or update the period on your behalf. Specify the role as ams_resource_scheduler_ssm_automation_role. • Description (Optional): A meaningful description for the period. • BeginTime (Optional): The time in HH:MM format when you want to start the resources. • EndTime (Optional): The time in HH:MM format when you want to stop the resources. • Months (Optional): A comma-delimited list of months or a hyphenated range of months during which the resources should run. • MonthDays (Optional): A comma-delimited list of days of the month or a hyphenated range of days during which the resources should run. • WeekDays (Optional): A comma-delimited list of the days of the week or a range of days of the week during which the resources should run. How to do it: • View the document at AWSManagedServices-AddOrUpdatePeriod (you might have to choose your onboarded Region). Specify requirements in the Input parameters section, then choose Execute. After the operation completes, view results in the Output tab. • AWS CLI: Working with periods and schedules Version May 08, 2025 516 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Run the following command to start an automation. Replace placeholders with your own information. aws ssm start-automation-execution --document-name "AWSManagedServices- AddOrUpdatePeriod" --document-version "\$DEFAULT" --parameters '{"Action":["add" or "update"], "Name":["NAME"], "Description":["DESCRIPTION"],"BeginTime":["TIME"], "EndTime":["TIME"], "Months":["MONTH"],"MonthDays":["DAY"], "WeekDays":["DAY"], "AutomationAssumeRole" : ["arn:aws:iam::ACCOUNTID:role/ ams_resource_scheduler_ssm_automation_role"] }' --region ONBOARDED_REGION Example: The following example shows how you can add a new period using the AWS Systems Manager console. We have named the period Period-Name and conﬁgured it to cover 9AM-6PM from Mon- Fri for ﬁrst 15 days of every month. 1. View the AWS Systems Manager automation document at AWSManagedServices- AddOrUpdatePeriod (you might have to choose your onboarded Region). 2. Provide values for the parameters. Working with periods and schedules Version May 08, 2025 517 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 3. Click Execute and wait for automation to complete. Adding or updating schedules in AMS Resource Scheduler Add or update a Resource Scheduler schedule in AMS Accelerate accounts. Data you'll need: • Action: The type of operation to perform. Use "add" if you want to add a schedule or "update" if you want to update an existing schedule. • Name: The name of the schedule. You must specify a unique value if you are adding a new schedule. • AutomationAssumeRole: The ARN of the AWS Identity and Access Management (IAM) role that allows the runbook to add or update the schedule on your behalf. Specify the role ams_resource_scheduler_ssm_automation_role. • Description (Optional): A meaningful description for the schedule. • Schedules (Optional): Specify a comma-delimited list of periods that are to be used with this schedule. Each period must have already been created. • RetainRunning (Optional): Specify "true" to prevent Resource Scheduler from stopping a running resource at the end of a running period if the resource was manually started before the beginning of the running perod. By default, Resource Scheduler stops the resource. Working with periods and schedules Version May 08, 2025 518 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • StopNewInstances (Optional): Specify "false" to prevent Resource Scheduler from stopping a resource the ﬁrst time it is tagged if it is running outside of the running period. By default, Resource Scheduler stops the resource. • SSMMaintenanceWindow (Optional): Specify a comma-delimited list of AWS Systems Manager (SSM) maintenance windows that you want to add as running periods for the schedule. You must also specify the "UseMaintenanceWindow" property to "true." • TimeZone (Optional): Specify the time zone that you want Resource Scheduler to use. By default, Resource Scheduler uses UTC. • UseMaintenanceWindow (Optional): Specify "true" if you want to Resource Scheduler to consider Amazon Relational Database Service (RDS) maintenance window as a running period to an Amazon RDS instance schedule, or to add AWS Systems Manager (SSM) maintenance windows as a running period to an Amazon EC2 instance schedule. • UseMetrics (Optional): Specify "true" to enable CloudWatch metrics at the schedule level and "false" to disable CloudWatch metrics. Specifying this property overrides the CloudWatch metrics setting set at the stack level. How to
accelerate-guide-163	accelerate-guide.pdf	163	Specify the time zone that you want Resource Scheduler to use. By default, Resource Scheduler uses UTC. • UseMaintenanceWindow (Optional): Specify "true" if you want to Resource Scheduler to consider Amazon Relational Database Service (RDS) maintenance window as a running period to an Amazon RDS instance schedule, or to add AWS Systems Manager (SSM) maintenance windows as a running period to an Amazon EC2 instance schedule. • UseMetrics (Optional): Specify "true" to enable CloudWatch metrics at the schedule level and "false" to disable CloudWatch metrics. Specifying this property overrides the CloudWatch metrics setting set at the stack level. How to do it: • View the document at AWSManagedServices-AddOrUpdateSchedule (you might have to choose your onboarded Region). Specify requirements in the Input parameters section, and then choose Execute. After the operation completes, view results in the Output tab. • AWS CLI: Run the following command to start an automation. Replace placeholders with your own information. aws ssm start-automation-execution --document-name "AWSManagedServices- AddOrUpdateSchedule" --document-version "\$DEFAULT" --parameters '{"Action":["add" or "update"], "Name":["NAME"], "Description": ["DESCRIPTION"], "Hibernate":["true or false"],"Enforced":["true or false"], "OverrideStatus":["running or stopped"],"Periods":["PERIOD-A, PERIOD-B"], "RetainRunning":["true or false"],"StopNewInstances":["true or false"], "SSMMaintenanceWindow":["WINDOW-NAME"],"TimeZone":["TIMEZONE"], "UseMaintenanceWindow":["true or false"],"UseMetrics":["true or false"], Working with periods and schedules Version May 08, 2025 519 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures "AutomationAssumeRole" : ["arn:aws:iam::ACCOUNTID:role/ ams_resource_scheduler_ssm_automation_role"] }' --region ONBOARDED_REGION Example: The following example shows how to add a schedule for AMS Resource Scheduler. In this example you add a schedule nameed CustomSchedule using CustomPeriod. 1. View the AWS Systems Manager automation document at AWSManagedServices- AddOrUpdateSchedule (you might have to choose your onboarded Region). 2. Provide values for the parameters. Working with periods and schedules Version May 08, 2025 520 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 3. Click Execute and wait for automation to complete. Deleting periods or schedules in AMS Resource Scheduler In order to delete Resource Scheduler periods or schedules in AMS Accelerate accounts, you need the following data: • ConﬁgurationType: The type of conﬁguration you want to delete. Use "period" if you want to delete periods or "schedule" if you want to delete schedules. • Name: The name of the schedule or period that you want to delete. • AutomationAssumeRole: The ARN of the AWS Identity and Access Management (IAM) role that allows the runbook to delete schedules or periods on your behalf. Specify the role ams_resource_scheduler_ssm_automation_role. How to do it: • View the document at AWSManagedServices-DeleteScheduleOrPeriod (you might3have to choose your onboarded Region). Specify requirements in the Input parameters section, then choose Execute. After the operation completes, view results in the Output tab. • AWS CLI: Run the following command to start an automation. Replace placeholders with your own information. aws ssm start-automation-execution --document-name "AWSManagedServices- DeleteScheduleOrPeriod" --document-version "\$DEFAULT" --parameters '{"ConfigurationType":["period" or "schedule"],"Name":["NAME"], "AutomationAssumeRole":["arn:aws:iam::ACCOUNTID:role/ ams_resource_scheduler_ssm_automation_role"]}' --region ONBOARDED_REGION Example: The following example shows how you can delete a period using the AWS Systems Manager console. Working with periods and schedules Version May 08, 2025 521 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 1. View the AWS Systems Manager automation document at AWSManagedServices- DeleteScheduleOrPeriod (you might have to choose your onboarded Region). 2. Provide values for the parameters. 3. Click Execute and wait for automation to complete. Describing periods or schedules in AMS Resource Scheduler In order to describe (view a details on) a Resource Scheduler period or schedule in AMS Accelerate accounts, you need the following data: • ConﬁgurationType: The type of conﬁguration that you want to describe. Use "periods" if you want to describe all periods or "schedules" if you want to describe all schedules. • AutomationAssumeRole: The ARN of the AWS Identity and Access Management (IAM) role that allows the runbook to describe schedules or periods on your behalf. Specify the role ams_resource_scheduler_ssm_automation_role. How to do it: Working with periods and schedules Version May 08, 2025 522 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • View the document at AWSManagedServices-DescribeScheduleOrPeriods (you might have to choose your onboarded Region): 1. Specify requirements in the Input parameters section and then choose Execute. 2. After the operation completes, view results in the Output tab. • AWS CLI: 1. Run the following command to start an automation. Replace placeholders with your own information. aws ssm start-automation-execution --document-name "AWSManagedServices- DescribeScheduleOrPeriods" --document-version "\$DEFAULT" --parameters '{"ConfigurationType":["period" or "schedule"],"AutomationAssumeRole":["arn:aws:iam::ACCOUNTID:role/ ams_resource_scheduler_ssm_automation_role"]}' --region ONBOARDED_REGION Example: The following example shows how you can describe a period using the AWS Systems Manager console. 1. View the AWS Systems Manager automation document at AWSManagedServices- DescribeScheduleOrPeriods (you might have to choose your onboarded Region). 2. Provide values for the parameters. Working with periods and schedules Version May 08, 2025 523 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 3. Click Execute and wait for automation to complete. Tagging resources for AMS Resource Scheduler Tagging resources for AMS Resource Scheduler. Once you add schedules and periods to AMS
accelerate-guide-164	accelerate-guide.pdf	164	DescribeScheduleOrPeriods" --document-version "\$DEFAULT" --parameters '{"ConfigurationType":["period" or "schedule"],"AutomationAssumeRole":["arn:aws:iam::ACCOUNTID:role/ ams_resource_scheduler_ssm_automation_role"]}' --region ONBOARDED_REGION Example: The following example shows how you can describe a period using the AWS Systems Manager console. 1. View the AWS Systems Manager automation document at AWSManagedServices- DescribeScheduleOrPeriods (you might have to choose your onboarded Region). 2. Provide values for the parameters. Working with periods and schedules Version May 08, 2025 523 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures 3. Click Execute and wait for automation to complete. Tagging resources for AMS Resource Scheduler Tagging resources for AMS Resource Scheduler. Once you add schedules and periods to AMS Resource Schedule, you need to tag your resources with the Resource Scheduler tag name as the tag key, or the your customized one, and the schedule name as the tag value. For details on how to tag your resources in your AMS Accelerate account, see Tagging in AMS Accelerate. Note If Resource Tagger is used to tag the resources, the default Tag key for Resource Scheduler must be customized to have the preﬁx 'ams:rt:' as all tags applied by the resource tagger have the key preﬁx 'ams:rt:'. Otherwise, the resources tagged with resource tagger will not be managed by Resource Scheduler. To know more about customizing the default Tag key for Resource Scheduler, see Customizing AMS Resource Scheduler. Cost estimator in AMS Resource Scheduler In order to track cost savings, AMS Resource Scheduler features a component that hourly calculates the estimated cost savings for Amazon EC2 and Amazon RDS resources that are managed by scheduler. This cost savings data is then published as a CloudWatch metric (AMS/ ResourceScheduler) to help you track it. The cost savings estimator only estimates savings on instance running hours. It does not account any other cost, such as data transfer costs associated with a resource. The cost savings estimator is enabled with Resource Scheduler. It runs hourly and retrieves cost and usage data from AWS Cost Explorer. From that data it calculates the average cost per hour for each instance type and then projects the cost for a full day if it was running without being scheduled. Tagging resources Version May 08, 2025 524 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures The cost savings is the diﬀerence between the projected cost and the actual reported cost from Cost Explorer for a given day. For example, if instance A is conﬁgured with Resource Scheduler to run from 9 a.m. to 5 p.m., that is eight hours on a given day. Cost Explorer reports the cost as $1 and usage as 8. The average cost per hour is therefore $0.125. If the instance was not scheduled with Resource Scheduler, then the instance would run 24 hours on that day. In that case, the cost would have been 24x0.125 = $3. Resource Scheduler helped you achieve a cost savings of $2. In order for the cost savings estimator to retrieve cost and usage only for resources managed by Resource Scheduler from Cost Explorer, the tag key that Resource Scheduler uses to target resources needs to be activated as the Cost allocation tag in the Billing Dashboard. If the account belongs to an organization, the tag key needs to be activated in the management account of the organization. For information on doing this, see Activating User-Deﬁned Cost Allocation Tags and User-Deﬁned Cost Allocation Tags After the tag key is activated as Cost Allocation Tag, AWS billing starts tracking cost and usage for resources managed by Resource Scheduler, and after that data is available, the cost savings estimator starts to calculate the cost savings and publish the data under the AMS/ ResourceScheduler metric namespace in CloudWatch. If the cost allocation tag is not activated, the estimator is not able to calculate the savings and publish the metric, even if it is enabled. Note Cost Savings Estimator do not accept discounts such as reserved instances, savings plans, and so forth, into consideration in its calculation. The Estimator takes usage costs from Cost Explorer and calculates the average cost per hour for the resources. For more details, see Understanding your AWS Cost Datasets: A Cheat Sheet. Alarm suppressor in AMS Resource Scheduler AMS Resource Scheduler comes with a CloudWatch Alarm suppressor, that is deployed as separate Lambda function named AMSAlarmSuppressor that suppresses alarms for instances that are behind an Elastic Load Balancing, Application Load Balancer, or Network Load Balancer. The function runs every 5 minutes, retrieves all alarms present in the account and groups them based on namespace; for example, AWS/ELB, AWS/ApplicationELB, AWS/NetworkELB. For each Alarm suppressor Version May 08, 2025 525 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures group of alarms the suppressor ﬁnds the load balancer name and/or target group (for ALB/NLB) from alarm dimensions, ﬁnds the instances that are registered with the load balancer and/or
accelerate-guide-165	accelerate-guide.pdf	165	suppressor, that is deployed as separate Lambda function named AMSAlarmSuppressor that suppresses alarms for instances that are behind an Elastic Load Balancing, Application Load Balancer, or Network Load Balancer. The function runs every 5 minutes, retrieves all alarms present in the account and groups them based on namespace; for example, AWS/ELB, AWS/ApplicationELB, AWS/NetworkELB. For each Alarm suppressor Version May 08, 2025 525 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures group of alarms the suppressor ﬁnds the load balancer name and/or target group (for ALB/NLB) from alarm dimensions, ﬁnds the instances that are registered with the load balancer and/or target group, and checks the instance state to discover if the instances are scheduled by AMS Resource Scheduler. If instances are scheduled by Resource Scheduler, and are stopped by Resource Scheduler, the suppressor then marks the alarms to disable them. If at least one instance in the registered instance list is running, suppressor marks corresponding alarms to enable the alarms that are marked for enabling, and disable alarms that are marked for disabling. Logs for this are stored in the /aws/lambda/AMSAlarmSuppressor log group. Alarm suppressor Version May 08, 2025 526 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Log management in AMS Accelerate AMS Accelerate conﬁgures supported AWS services to collect logs. These logs are used by AMS Accelerate to ensure compliance and auditing of resources within your account. AMS Accelerate provides a range of operational services to help you achieve operational excellence on AWS. To gain a quick understanding of how AMS helps your teams achieve overall operational excellence in AWS Cloud with some of our key operational capabilities including 24x7 helpdesk, proactive monitoring, security, patching, logging and backup, see AMS Reference Architecture Diagrams. Topics • Log management — AWS CloudTrail • Log management — Amazon EC2 • Log management — Amazon VPC Flow Logs Log management — AWS CloudTrail AWS CloudTrail is a service that is used for account governance: compliance, operational auditing, and risk auditing. With CloudTrail, you can log, continuously monitor, and retain account activity related to actions across your AWS infrastructure. AMS Accelerate relies on AWS CloudTrail logging in order to manage audits and compliance for all resources in your account. During onboarding, you choose whether Accelerate deploys a CloudTrail multi-region trail in your primary AWS Region or uses events generated by your account or Organization trail. If your account does not have a trail conﬁgured, then Accelerate will deploy a CloudTrail multi-region trail during onboarding. If you choose to integrate Accelerate with your CloudTrail trail, work with your Cloud Architect (CA) to review and conﬁgure your trail resources to Accelerate required conﬁgurations, and enable Accelerate to use Athena to query and analyze events. AMS Accelerate creates an Amazon S3 bucket for an Accelerate deployed CloudTrail trail as the events delivery destination and uses AWS Key Management Service (AWS KMS) encryption. Your trail events are accessed by AMS Accelerate operators for investigation and diagnosis purposes. If the account already has an existing CloudTrail trail enabled, this trail is in addition to that, if you chose to have Accelerate deploy an Accelerate managed trail during onboarding. Log management — AWS CloudTrail Version May 08, 2025 527 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures AMS Accelerate deploys AWS Conﬁg rules to ensure that your CloudTrail account trails, including an Accelerate deployed CloudTrail trail are correctly set up and encrypted. To learn more, see AWS Conﬁg. These are the rules used, presented as links to the AWS documentation describing them: • multi-region-cloudtrail-enabled. Checks that AMS Accelerate CloudTrail is properly set up with the correct conﬁgurations. • cloud-trail-encryption-enabled. Checks that AWS CloudTrail is conﬁgured to use the server-side encryption (SSE) with AWS KMS customer master key (CMK) encryption. • cloud-trail-log-ﬁle-validation-enabled. When enabled, checks that AWS CloudTrail creates a signed digest ﬁle with logs. We strongly recommend that you enable ﬁle validation on all trails. • s3-bucket-default-lock-enabled. When enabled, checks that the Amazon S3 bucket has lock enabled. • s3-bucket-logging-enabled. When enabled, checks whether logging is enabled for Amazon S3 buckets. AMS Accelerate uses AWS KMS to encrypt the logged events for an Accelerate deployed CloudTrail trail in your account. This key is controlled by, and is accessible to, the account administrators, AMS Accelerate operators, and CloudTrail. For more information about AWS KMS, see AWS Key Management Service features product documentation. Accessing and auditing CloudTrail logs CloudTrail logs for an AMS Accelerate deployed CloudTrail trail are stored in an Amazon S3 bucket within your account. Trail data stored in the Amazon S3 bucket is encrypted using a AWS KMS key created when CloudTrail resources are provisioned. Amazon S3 buckets leverage a naming pattern of ams-aaws account id-cloudtrail-AWS Region, (example: ams-a123456789-cloudtrail-us-east-1a) and all the events are stored with the AWS/CloudTrail preﬁx. All access to the primary bucket is
accelerate-guide-166	accelerate-guide.pdf	166	accessible to, the account administrators, AMS Accelerate operators, and CloudTrail. For more information about AWS KMS, see AWS Key Management Service features product documentation. Accessing and auditing CloudTrail logs CloudTrail logs for an AMS Accelerate deployed CloudTrail trail are stored in an Amazon S3 bucket within your account. Trail data stored in the Amazon S3 bucket is encrypted using a AWS KMS key created when CloudTrail resources are provisioned. Amazon S3 buckets leverage a naming pattern of ams-aaws account id-cloudtrail-AWS Region, (example: ams-a123456789-cloudtrail-us-east-1a) and all the events are stored with the AWS/CloudTrail preﬁx. All access to the primary bucket is logged and the log objects are encrypted and versioned for auditing purposes. For more information about tracking changes and querying the logs, see Tracking changes in your AMS Accelerate accounts. Accessing and auditing CloudTrail logs Version May 08, 2025 528 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Protecting and retaining CloudTrail logs AMS Accelerate enables Amazon S3 object locking with Governance Mode for an Accelerate deployed CloudTrail trail to ensure that users can't overwrite or delete an object version or alter its lock settings without special permissions. For more information, see Amazon S3 object locking. By default, all logs in this bucket are kept indeﬁnitely. If you want to change the retention period, you can submit a service request through the AWS Support Center to set up a diﬀerent retention policy. Accessing Amazon EC2 logs You can access Amazon EC2 instance logs by using the AWS Management Console. Logs produced by instances and AWS services are available in CloudWatch Logs, which is available in each account managed by AMS Accelerate. For information about accessing your logs, see the CloudWatch Logs documentation. Retaining Amazon EC2 logs Amazon EC2 instance logs are kept indeﬁnitely, by default. If you want to change the retention period, you can submit a service request through the AWS Support Center to set up a diﬀerent retention policy. Log management — Amazon EC2 AMS Accelerate installs the CloudWatch agent on all Amazon EC2 instances that you have identiﬁed as AMS Accelerate-managed. This agent sends system-level logs to Amazon CloudWatch Logs. For information, see What are Amazon CloudWatch Logs? The following log ﬁles are sent to CloudWatch Logs, into a log group of the same name as the log. Within each log group, a log stream is created for each Amazon EC2 instance, named according to the Amazon EC2 instance ID. Linux /var/log/amazon/ssm/amazon-ssm-agent.log /var/log/amazon/ssm/errors.log /var/log/audit/audit.log /var/log/auth.log Protecting and retaining CloudTrail logs Version May 08, 2025 529 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures /var/log/cloud-init-output.log /var/log/cron /var/log/dnf.log /var/log/dpkg.log /var/log/maillog /var/log/messages /var/log/secure /var/log/spooler /var/log/syslog /var/log/yum.log /var/log/zypper.log For more information, see Manually Create or Edit the CloudWatch Agent Conﬁguration File. Windows C:\\ProgramData\\Amazon\\SSM\\Logs\\amazon-ssm-agent.log C:\\ProgramData\\Amazon\\SSM\\Logs\\amazon-cloudwatch-agent.log C:\\ProgramData\\Amazon\\SSM\\Logs\\errors.log C:\\cfn\\log\\cfn-init.log For more information, see Quick Start: Enable Your Amazon EC2 Instances Running Windows Server 2016 to Send Logs to CloudWatch Logs Using the CloudWatch Logs Agent. Log management — Amazon VPC Flow Logs VPC Flow Logs is a feature that captures information about the IP traﬃc going to and from network interfaces in your VPC. Flow log data can be published to Amazon CloudWatch logs or Amazon S3. Flow log data collection does not aﬀect network throughput or latency. You can create or delete ﬂow logs without any impact to network performance. Flow logs can help you with a number of tasks, such as: • Diagnosing overly restrictive Security Group rules • Monitoring traﬃc that reaches your instance • Determining the direction of the traﬃc to and from the network interfaces You do not have to enable VPC ﬂow logs for each newly created VPC in Accelerate accounts. AMS will automatically detect whether a VPC has a ﬂow log using the ams-nist-cis-vpc-ﬂow-logs- Log management — Amazon VPC Flow Logs Version May 08, 2025 530 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures enabled Conﬁg rule. If VPC ﬂow logs are not enabled, AMS will automatically remediate it by creating a VPC ﬂow log with custom ﬁelds. Having these additional ﬁelds will enable AMS and customers to better monitor VPC traﬃc, understand network dependencies, troubleshoot network connectivity issues, and identify network threats. For information on viewing and searching ﬂow logs, see Work with ﬂow logs. Log management — Amazon VPC Flow Logs Version May 08, 2025 531 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Tracking changes in your AMS Accelerate accounts Topics • Viewing your change records • Default queries • Change record permissions AWS Managed Services helps you track changes made by the AMS Accelerate Operations team and AMS Accelerate automation by providing a queryable interface using the Amazon Athena (Athena) console and AMS Accelerate log management. Athena is an interactive query service you can use to analyze data in Amazon S3 by using standard Structured Query Language (SQL) (see
accelerate-guide-167	accelerate-guide.pdf	167	ﬂow logs. Log management — Amazon VPC Flow Logs Version May 08, 2025 531 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Tracking changes in your AMS Accelerate accounts Topics • Viewing your change records • Default queries • Change record permissions AWS Managed Services helps you track changes made by the AMS Accelerate Operations team and AMS Accelerate automation by providing a queryable interface using the Amazon Athena (Athena) console and AMS Accelerate log management. Athena is an interactive query service you can use to analyze data in Amazon S3 by using standard Structured Query Language (SQL) (see SQL Reference for Amazon Athena). Athena is serverless, so there is no infrastructure to manage, and you pay only for the queries that you run. AMS Accelerate creates Athena tables with daily partitions over CloudTrail logs, and provides queries on your primary AWS Region and within the ams-change-record workgroup. You can choose any of the default queries and run them as needed. To learn more about Athena workgroups, see How Workgroups Work. Note Only Accelerate can query CloudTrail events for your Accelerate account using Athena when Accelerate is integrated with your CloudTrail Organization trail, unless your Organization administrator deployed an IAM Role for using Athena to query and analyze CloudTrail events in your account, during onboarding. Using change record, you can easily answer questions like: • Who (AMS Accelerate Systems or AMS Accelerate Operators) has accessed your account • What changes have been made by AMS Accelerate in your account • When did AMS Accelerate perform changes in your account • Where to go to view changes made in your account • Why AMS Accelerate needed to make the changes in your account • How to modify queries to get answers to all those questions for any non-AMS changes too Version May 08, 2025 532 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Viewing your change records To use Athena queries, sign in to the AWS Management console and navigate to the Athena console in your primary AWS Region. Note If you see the Amazon Athena Get Started page while performing any of the steps, click Get Started. This might appear for you even if your Change Record infrastructure is already in place. 1. Choose Workgroup from the upper navigation panel in the Athena console. 2. Choose the ams-change-record workgroup, and then click Switch Workgroup. 3. Choose ams-change-record-database from the Database Combo box. The ams-change-record- database includes the ams-change-record-table table. 4. Choose Saved Queries from the upper navigation panel. 5. The Saved Queries window shows a list of queries that AMS Accelerate provides, which you can run. Choose the query you want to run from the Saved Queries list. For example, ams_session_accesses_v1 query. For the full list of preset AMS Accelerate queries, see Default queries. 6. Adjust the datetime ﬁlter in the query editor box as needed; by default, the query only checks changes from the last day. 7. Choose Run query. Default queries AMS Accelerate provides several default queries you can use within the Athena console; they are listed in the following table. Note • All queries accept datetime range as an optional ﬁlter; all the queries run over the last 24 hours, by default. For expected input, see the following subsection, Modifying the datetime ﬁlter in queries. Viewing your change records Version May 08, 2025 533 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • Parameter inputs that you can or need to change are shown in the query as <PARAMETER_NAME> with angular braces. Replace the placeholder and the angular braces with your parameter value. • All ﬁlters are optional. In the queries, some optional ﬁlters are commented out with a double dash (--) at the start of the line. All queries will run without them, with default parameters. If you want to specify parameter values for these optional ﬁlters, remove the double dash (--) at the start of the line and replace the parameter as you want. • All queries return IAM PincipalId and IAM SessionId in the outputs • The calculated cost for running a query depends on how many CloudTrail logs are generated for the account. To calculate the cost, use the AWS Athena Pricing Calculator. Canned queries Purpose/Description Inputs Outputs Query name: ams_access_session_query_v1 (Optional) IAM PrincipalId : The IAM Principal identiﬁe r of the resource that is trying to access. The format is UNIQUE_ID ENTIFIER :RESOURCE_ NAME . For details see unique identiﬁers. You can run the query without this ﬁlter to determine the exact IAM PrincipalId the you want to ﬁlter with. Tracking AMS Accelerate access sessions Provides information about a speciﬁc AMS Accelerate access session. The query accepts the IAM Principal ID as an optional ﬁlter and returns event time, business need for accessing the account, requester, and so on.
accelerate-guide-168	accelerate-guide.pdf	168	Athena Pricing Calculator. Canned queries Purpose/Description Inputs Outputs Query name: ams_access_session_query_v1 (Optional) IAM PrincipalId : The IAM Principal identiﬁe r of the resource that is trying to access. The format is UNIQUE_ID ENTIFIER :RESOURCE_ NAME . For details see unique identiﬁers. You can run the query without this ﬁlter to determine the exact IAM PrincipalId the you want to ﬁlter with. Tracking AMS Accelerate access sessions Provides information about a speciﬁc AMS Accelerate access session. The query accepts the IAM Principal ID as an optional ﬁlter and returns event time, business need for accessing the account, requester, and so on. You can ﬁlter on a speciﬁc IAM Principal ID by uncommenting the line and replacing the placeholder IAM • EventTime: Time of gaining the access • EventName: AWS Event name (AssumeRole) • EventRegion: AWS Region that gets the request • EventId: CloudTrail Event ID • BusinessNeed Type: Business reason type to access the account. Allowed values are: SupportCase, OpsItem, Issue, Text. • BusinessNeed: Business need to access the account. For example, Support Case ID, Ops Item ID, and so forth. • Requester: Operator ID that accesses the account, or Automation system that access the account. Default queries Version May 08, 2025 534 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Purpose/Description Inputs Outputs • RequestAccessType: Requester type (System, OpsConsole, OpsAPI, Unset) PrincipalId with a speciﬁc ID in the query editor. You can also list non- AMS access sessions by removing the useragent ﬁlter line in the WHERE clause of the query. Query name: ams_events_query_v1 Track all mutating actions done by AMS Accelerate (Optional) • AccountId: AWS Account ID Only datetime range. See Modifying the • RoleArn: RoleArn for the requester • EventTime: Time of gaining the Returns all write actions datetime ﬁlter in queries. access done on the account using that AMS Accelerat e role ﬁlter. You can also track mutating actions done by non-AMS roles by removing the userident ity.arn ﬁlter lines from the WHERE clause of the query. • EventName: AWS Event name (AssumeRole) • EventRegion: AWS Region that gets the request • EventId: CloudTrail Event ID • RequestParameters : Request parameters for the request • ResponseElements: Response elements for the response. • UserAgent: AWS CloudTrail User Agent Query name: ams_instance_access_sessions_query_v1 Default queries Version May 08, 2025 535 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Purpose/Description Inputs Outputs • InstanceId: Instance ID • SSMSession Id: SSM Session ID • RoleArn: RoleArn for the requester • EventTime: Time of gaining the access • EventName: AWS Event name (AssumeRole) • EventRegion: AWS Region that gets the request • EventId: CloudTrail Event ID Track instance accesses by AMS Accelerate Only datetime range. See Modifying the datetime ﬁlter in queries. Returns a list of AMS Accelerate instance accesses; every record includes event time, event Region, instance ID, IAM Principal ID, IAM Session ID, SSM Session ID. You can use the IAM Principal ID to get more details on the business need for accessing the instance by using the ams_access_session Athena s_query_v1 query. You can use the SSM Session ID to get more details on the instance access session, including the start and end time of the session, log details, and using the AWS Session Manager console in the instance's AWS Region. Users can also list non- AMS instance accesses by removing the userident ity ﬁlter line in the WHERE clause of the query. Default queries Version May 08, 2025 536 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Purpose/Description Inputs Outputs Query name: ams_privilege_escalation_events_query_v1 Default queries Version May 08, 2025 537 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Purpose/Description Inputs Outputs Track permission (escalati on) events for AMS and non-AMS users Provides a list of events that can directly or potentially lead to a privilege escalation. The query accepts ActionedB y as an optional ﬁlter and returns EventName (Optional) ACTIONEDB : Y_PUT_USER_NAME Username for the actionedBy user. This can be an IAM user or role. For example, ams-access- admin. (Optional) datetime range. See Modifying the datetime ﬁlter in , EventId, EventTime, queries. • AccountId: Account Id • ActionedBy: ActionedBy Username • EventTime: Time of gaining the access • EventName: AWS Event name (AssumeRole). • EventRegion: AWS Region that gets the request • EventId: CloudTrail Event ID and so forth. All ﬁelds associated with the event are also returned. Fields are blank if not applicable for that event. The ActionedBy ﬁlter is disabled, by default; to enable it, remove "-- " from that line. By default, the ActionedB y ﬁlter is disabled (it will show privilege escalatio n events from all users). To show events for a particular user or role, remove the double dash (--) from the userident ity ﬁlter line in the WHERE clause and replace the placeholder ACTIONEDBY_PUT_USE R_NAME_HERE with an Default queries Version
accelerate-guide-169	accelerate-guide.pdf	169	Region that gets the request • EventId: CloudTrail Event ID and so forth. All ﬁelds associated with the event are also returned. Fields are blank if not applicable for that event. The ActionedBy ﬁlter is disabled, by default; to enable it, remove "-- " from that line. By default, the ActionedB y ﬁlter is disabled (it will show privilege escalatio n events from all users). To show events for a particular user or role, remove the double dash (--) from the userident ity ﬁlter line in the WHERE clause and replace the placeholder ACTIONEDBY_PUT_USE R_NAME_HERE with an Default queries Version May 08, 2025 538 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Purpose/Description Inputs Outputs IAM user or role name. You can run the query without the ﬁlter to determine the exact user you want to ﬁlter with. Query name: ams_resource_events_query_v1 Track write events for speciﬁc resources AMS or non-AMS Provides a list of events done on a speciﬁc resource. The query accepts resource ID as part of the ﬁlters (replace placeholder RESOURCE_INFO in the WHERE clause of the query), and returns all write actions done on that resource. (Required) RESOURCE_ INFO : The resource identiﬁer, can be an ID for any AWS resource in the account. Do not confuse this with resource ARNs. For example, an instance ID for an EC2 instance, table • AccountId: Account Id • ActionedBy: ActionedBy Username • EventTime: Time of gaining the access • EventName: AWS Event name (AssumeRole). • EventRegion: AWS Region that gets the request name for a DynamoDB • EventId: CloudTrail Event ID table, logGroupName for a CloudWatch Log, etc. (Optional) datetime range. See Modifying the datetime ﬁlter in queries. Query name: ams_session_events_query_v1 Default queries Version May 08, 2025 539 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Purpose/Description Inputs Outputs Track write actions performed by AMS Accelerate during speciﬁc session Provides a list of events done on a speciﬁc session. The query accepts IAM Principal ID as part of the ﬁlters (replace the placehold er PRINCIPAL_ID in the WHERE clause of the query), and returns all write actions done on that resource. (Required) PRINCIPAL _ID : Principal ID for the session. The format is UNIQUE_ID ENTIFIER :RESOURCE_ NAME . For details see unique identiﬁers. You can run the query "ams_session_ids_b • AccountId: Account Id • ActionedBy: ActionedBy Username • EventTime: Time of gaining the access • EventName: AWS Event name (AssumeRole) • EventRegion: AWS Region that gets the request y_requester_v1" to get • EventId: CloudTrail Event ID list of IAM Principal IDs for a requester. You can also run the query without this ﬁlter to determine the exact IAM PrincipalId you want to ﬁlter with. (Optional) datetime range. See Modifying the datetime ﬁlter in queries. Query name: ams_session_ids_by_requester_v1 Default queries Version May 08, 2025 540 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Purpose/Description Inputs Outputs Track IAM Principal/ Session IDs for a speciﬁc (Required) Requester : Operator ID that accesses • IAM PrincipalId - IAM Principal Id of the session. The format is requester. the account (for example: The query accepts "requester" (replace the placeholder Requester in the WHERE clause of the query), and returns all IAM Principal Ids by that requester during the speciﬁed time range. alias of an operator), or Automation system UNIQUE_IDENTIFIER :RESOURCE_ NAME . For details see unique identiﬁers. You can run the query that access the account without this ﬁlter to determine the (for example: OsConﬁgu ration, AlarmManager, etc.). (Optional) datetime range. See Modifying the datetime ﬁlter in queries. exact IAM PrincipalId you want to ﬁlter with. • IAM SessionId - IAM Session Id for the access session • EventTime: Time of gaining the access Modifying the datetime ﬁlter in queries All queries accept datetime range as an optional ﬁlter. All the queries run over the last one day by default. The format used for the datetime ﬁeld is yyyy/MM/dd (for example: 2021/01/01). Remember that it only stores the date and not the entire timestamp. For the entire timestamp, use the ﬁeld eventime, which stores the timestamp in the ISO 8601 format yyyy-MM-ddTHH:mm:ssZ (for example: 2021-01-01T23:59:59Z). However, since the table is partitioned on the datetime ﬁeld, you’ll need to pass in both the datetime and eventtime ﬁlter to the query. See the following examples. Note To see all the accepted ways you can modify the range, see the latest Presto function documentation based on the Athena engine version currently used for the Date and Time Functions and Operators to see all the accepted ways you can modify the range. Modifying the datetime ﬁlter in queries Version May 08, 2025 541 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Date Level: Last 1 day or last 24 hours (Default) example: If the CURRENT_DATE='2021/01/01' , the ﬁlter will subtract one day from
accelerate-guide-170	accelerate-guide.pdf	170	both the datetime and eventtime ﬁlter to the query. See the following examples. Note To see all the accepted ways you can modify the range, see the latest Presto function documentation based on the Athena engine version currently used for the Date and Time Functions and Operators to see all the accepted ways you can modify the range. Modifying the datetime ﬁlter in queries Version May 08, 2025 541 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Date Level: Last 1 day or last 24 hours (Default) example: If the CURRENT_DATE='2021/01/01' , the ﬁlter will subtract one day from the current date and format it as datetime > '2020/12/31' datetime > date_format(date_add('day', - 1, CURRENT_DATE), '%Y/%m/%d') Date Level: Last 2 months example: datetime > date_format(date_add('month', - 2, CURRENT_DATE), '%Y/%m/%d') Date Level: Between 2 dates example: datetime > '2021/01/01' AND datetime < '2021/01/10' Timestamp Level: Last 12 hours example: Partition data scanned to last 1 day and then ﬁlter all events within the last 12 hours datetime > date_format(date_add('day', - 1, CURRENT_DATE), '%Y/%m/%d') AND eventtime > date_format(date_add('hour', - 12, CURRENT_TIMESTAMP), '%Y-%m-%dT%H: %i:%sZ') Timestamp Level: Between 2 timestamps example: Get events between Jan 1, 2021 12:00PM and Jan 10, 2021 3:00PM. datetime > '2021/01/01' AND datetime < '2021/01/10' AND eventtime > '2021-01-01T12:00:00Z' AND eventtime < '2021-01-10T15:00:00Z' Change record permissions The following permissions are needed to run change record queries: • Athena • athena:GetWorkGroup Change record permissions Version May 08, 2025 542 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • athena:StartQueryExecution • athena:ListDataCatalogs • athena:GetQueryExecution • athena:GetQueryResults • athena:BatchGetNamedQuery • athena:ListWorkGroups • athena:UpdateWorkGroup • athena:GetNamedQuery • athena:ListQueryExecutions • athena:ListNamedQueries • AWS KMS • kms:Decrypt • AWS KMS key ID of AMSCloudTrailLogManagement, or your AWS KMS key ID(s), if Accelerate is using your CloudTrail trail events Amazon S3 bucket data store using SSE-KMS encryption. • AWS Glue • glue:GetDatabase • glue:GetTables • glue:GetDatabases • glue:GetTable • Amazon S3 read access • Amazon S3 bucket CloudTrail datastore: ams-aAccountId-cloudtrail-primary region, or your Amazon S3 bucket name, CloudTrail trail events Amazon S3 bucket data store. • Amazon S3 write access • Athena events query results Amazon S3 bucket: ams-aAccountIdathena-results-primary region Change record permissions Version May 08, 2025 543 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures AWS Systems Manager in Accelerate An AWS Systems Manager document (SSM document) deﬁnes the actions that Systems Manager performs on your AWS resources. Systems Manager includes more than a dozen pre-conﬁgured documents that you can use by specifying parameters at runtime. Documents use JavaScript Object Notation (JSON) or YAML, and they include steps and parameters that you specify. AWS Managed Services (AMS) is a trusted publisher for SSM documents. SSM documents owned by AMS are shared only with onboarded AMS accounts, always begin with a reserved preﬁx (AWSManagedServices-*), and show up in the Systems Manager console, as owned by Amazon. The AMS process for SSM document development and publishing follows AWS best practices and requires multiple peer reviews throughout the document life cycle. For more information on AWS best practices for sharing SSM Documents, please visit Best practices for shared SSM documents. Available AMS Accelerate SSM documents AMS Accelerate SSM documents are available exclusively to AMS Accelerate customers, and are used to automate operational workﬂow to operate your account. To see the available AMS Accelerate SSM documents from the AWS Management Console: 1. Open the Systems Managerconsole at AWS Systems Manager console. 2. Choose Shared with me. 3. In the search bar, ﬁlter by Document name preﬁx, then Equals, and set the value to AWSManagedServices-. For AWS CLI instructions, see Using shared SSM documents. AMS Accelerate SSM document versions SSM documents support versioning. AMS Accelerate SSM documents can't be modiﬁed from the customer’s account and can't be re-shared. They're centrally managed and maintained by AMS Accelerate in order to operate the account. Version numbers are incremented with each document update in a speciﬁc AWS Region. As new Regions become available, the same document content in two Regions can have diﬀerent version Available AMS Accelerate SSM documents Version May 08, 2025 544 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures numbers; this is typical and doesn't mean their behavior will be diﬀerent. If you want to compare two AMS Accelerate SSM documents, we recommend comparing their hashes with the AWS CLI: aws ssm describe-document \ --name AWSManagedServices-DOCUMENTNAME \ --output text --query "Document.Hash" Two SSM documents are identical if their hashes match. Systems Manager pricing There is no cost associated with AMS Accelerate SSM document access. Runtime cost varies based on the type of SSM document, its steps, and runtime duration. For more information, refer to AWS Systems Manager pricing. Systems Manager pricing Version May 08, 2025 545 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Document history for AMS Accelerate User Guide The following table describes
accelerate-guide-171	accelerate-guide.pdf	171	two AMS Accelerate SSM documents, we recommend comparing their hashes with the AWS CLI: aws ssm describe-document \ --name AWSManagedServices-DOCUMENTNAME \ --output text --query "Document.Hash" Two SSM documents are identical if their hashes match. Systems Manager pricing There is no cost associated with AMS Accelerate SSM document access. Runtime cost varies based on the type of SSM document, its steps, and runtime duration. For more information, refer to AWS Systems Manager pricing. Systems Manager pricing Version May 08, 2025 545 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Document history for AMS Accelerate User Guide The following table describes the important changes in each release of the AMS Accelerate User Guide. For notiﬁcation about updates to this documentation, you can subscribe to an RSS feed. Change Description Date AMS Accelerate Trusted Remediator FAQ and updates. Several updates to supported Trusted Advisor checks, May 8, 2025 Trusted Remediator FAQ (added "What resources does Trusted Remediator deploy to your accounts?"), and more. See also Trusted Advisor checks supported by Trusted Remediator. AMS Accelerate Standard security controls update. Added "Security group sharing" controls. May 8, 2025 Accelerate monitoring alerts update. Additional alerts added, plus alert name added to Notes April 28, 2025 column. Accelerate resource inventory. The resource inventory spreadsheet ﬁle (compressed) April 24, 2025 is updated. Accelerate log locations. Additional log locations added. April 24, 2025 Accelerate New roles and responsibilities (RACI) for Security Incident Response. RACI for Security Incident Response. March 27, 2025 Accelerate New Amazon RDS auto-remediation alert. Alert ID:- 0224, triggers when the requested allocated March 27, 2025 storage reaches or exceeds Version May 08, 2025 546 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures the conﬁgured maximum storage threshold. Accelerate Onboarding role template update. The AMS Accelerate onboarding role template has March 25, 2025 Accelerate New auto-reme diations RDS alert. Accelerate New feature: Incident notiﬁcations. been updated to support AWS GovCloud regions. RDS-EVENT-0224 added. March 17, 2025 March 13, 2025 You can use AppRegistry to create applications and customize the incident notiﬁcations for those applications. Accelerate Update to RDS alarm monitoring threshold. The RDS Average CPU Utilizati on alarm threshold has been February 20, 2025 changed from 75% to 90%. Accelerate Update to AMS automatic remediation of The alert remediation table has been expanded with new February 20, 2025 alerts table. content. Accelerate New feature: Retain Alarms. You can conﬁgure Alarm Manager to retain alarms in CloudWatch instead of automatic deletion. February 20, 2025 Version May 08, 2025 547 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Updated Self-service reports with new data options for aggregated report viewing January 28, 2025 Added data options to include new Field Name: Admin Account ID, Dataset Field Name: aws_admin _account_id , and Deﬁnition: Trusted AWS Organization account enabled by the customer for the following Self-service reports: • Patch report (daily) • Backup report (daily) • Incident report (weekly) • Resource Tagger dashboard • Security Conﬁg Rules dashboard Version May 08, 2025 548 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Added additional AWS Trusted Advisor checks The following Trusted Advisor checks are now supported by January 28, 2025 supported by Trusted Trusted Remediator: Remediator • Cost Optimization • c1cj39rr6v - Amazon S3 Incomplete Multipart Upload Abort Conﬁgura tion • Security • Hs4Ma3G199 - RDS DB instances should publish logs to CloudWatch Logs • Hs4Ma3G326 - Amazon EMR block public access setting should be enabled • Hs4Ma3G272 - Users should not have root access to SageMaker AI notebook instances • Hs4Ma3G325 - EKS clusters should have audit logging enabled • HHs4Ma3G118 - VPC default security groups should not allow inbound or outbound traﬃc • Hs4Ma3G127 - API Gateway REST and WebSocket API execution logging should be enabled • Hs4Ma3G124 - Amazon EC2 instances should Version May 08, 2025 549 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures use Instance Metadata Service Version 2 (IMDSv2) • Fault tolerance • c1qf5bt013 - Amazon RDS DB instances have storage auto scaling turned oﬀ • 7qGXsKIUw - Classic Load Balancer Connection Draining • c18d2gz106 - Amazon EBS Not Included in AWS Backup Plan • c18d2gz107 - Amazon DynamoDB Table Not Included in AWS BackupPlan • cc18d2gz117 - Amazon EFS Not Included in AWS BackupPlan • c18d2gz105 - Network Load Balancer Cross Load Balancing • c1qf5bt026 - Amazon RDS synchrono us_commit parameter is turned oﬀ • c1qf5bt030 - Amazon RDS innodb_ﬂush_log_a t_trx_commit parameter is not 1 Version May 08, 2025 550 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • c1qf5bt031 - Amazon RDS sync_binlog parameter is turned oﬀ • c1qf5bt036 - Amazon RDS innodb_default_row _format parameter setting is unsafe • c18d2gz144 - Amazon EC2 Detailed Monitoring Not Enabled • Operational Excellence • c18d2gz125 - Amazon API Gateway Not Logging Execution Logs • c18d2gz168 - Elastic Load BalancingDeletion Protection Not Enabled
accelerate-guide-172	accelerate-guide.pdf	172	in AWS BackupPlan • c18d2gz105 - Network Load Balancer Cross Load Balancing • c1qf5bt026 - Amazon RDS synchrono us_commit parameter is turned oﬀ • c1qf5bt030 - Amazon RDS innodb_ﬂush_log_a t_trx_commit parameter is not 1 Version May 08, 2025 550 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • c1qf5bt031 - Amazon RDS sync_binlog parameter is turned oﬀ • c1qf5bt036 - Amazon RDS innodb_default_row _format parameter setting is unsafe • c18d2gz144 - Amazon EC2 Detailed Monitoring Not Enabled • Operational Excellence • c18d2gz125 - Amazon API Gateway Not Logging Execution Logs • c18d2gz168 - Elastic Load BalancingDeletion Protection Not Enabled for Load Balancers • c1qf5bt012 - Amazon RDS Performance Insights is turned oﬀ • Performance • c1qf5bt021 - Amazon RDS innodb_change_buﬀ ering parameter using less than optimum value • c1qf5bt025 - Amazon RDS autovacuum parameter is turned oﬀ • c1qf5bt028 - Amazon RDS enable_indexonlysc an parameter is turned oﬀ Version May 08, 2025 551 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • c1qf5bt029 - Amazon RDS enable_indexscan parameter is turned oﬀ • c1qf5bt032 - Amazon RDS innodb_stats_persi stent parameter is turned oﬀ • c1qf5bt037 - Amazon RDSgeneral_logging parameter is turned on Updated resource inventory spreadsheet Updated resource inventory spreadsheet. January 23, 2025 New AMS feature: Aggregated Self Service Reports Aggregated self-service reporting (SSR) provides you January 21, 2025 New Accelerate patching feature: Patch Hooks Update to How monitoring works section a view of existing self-serv ice reports aggregated at the organization level, cross-acc ount. Use this feature to conﬁgure "hooks" with SSM Command documents to run operating system level commands before or after patching. Added information on a new feature, conﬁguring alert notiﬁcations by resource, or instance ID, rather than by incident. January 16, 2025 January 8, 2025 Update to Onboarding section of EKS Monitoring and Incident Management Updated the onboarding procedure note to clarify when alert signals are suspended and resumed. December 19, 2024 Version May 08, 2025 552 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Member account log added to Trusted Remediator You can use the Member accounts log to ﬁnd the December 19, 2024 account ID, onboarded AWS Regions, and execution time of each member account. Prerequisites for SSM Agent use Content on blocking outbound traﬃc is updated. December 4, 2024 Accelerate Monitoring and Incident Management for Asia Paciﬁc (Hong Kong) is now a supported by Accelerat November 21, 2024 EKS is now supported in the e Monitoring and Incident Asia Paciﬁc (Hong Kong) AWS Management for EKS Region Updated Operations On Demand oﬀerings table The following operating systems are supported for in- November 11, 2024 place upgrades: • Microsoft Windows 2016 to Microsoft Windows 2022 and above Accelerate Monitoring and Incident Management for EKS Africa (Cape Town) is now a supported by Accelerat is now supported in the Africa e Monitoring and Incident (Cape Town) AWS Region. Management for EKS November 4, 2024 Version May 08, 2025 553 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Updated Operations On Demand oﬀerings table The following operating systems are supported for in- November 1, 2024 place upgrades: • Microsoft Windows 2012 R2 to Microsoft Windows 2016 and above • Red Hat Enterprise Linux 7 to Red Hat Enterprise Linux 8 • Red Hat Enterprise Linux 8 to Red Hat Enterprise Linux 9 • Oracle Linux 7 to Oracle Linux 8 Updated diagram, template parameters, and yaml template ﬁle. October 28, 2024 Updated Quick Start Template Version May 08, 2025 554 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Trusted Advisor checks added to Trusted Remediator in AMS The following Trusted Advisor checks are now available in October 25, 2024 Trusted Remediator: • Z4AUBRNSmz - Unassocia ted Elastic IP Addresses • c18d2gz128 - Amazon ECR Repository Without Lifecycle Policy Conﬁgured • c18d2gz138 - DynamoDB Point-in-time Recovery • Hs4Ma3G323 - DynamoDBt ables should have deletion protection enabled • Hs4Ma3G247 - Amazon EC2 Transit Gateway should not automatically accept VPC attachment requests • Hs4Ma3G308 - Amazon DocumentDB clusters should have deletion protection enabled • Hs4Ma3G299 - Neptune DB clusters should have deletion protection enabled • Hs4Ma3G306 - Amazon DocumentDB manual cluster snapshots should not be public • Hs4Ma3G109 - CloudTrail log ﬁle validation should be enabled • Hs4Ma3G217 - CodeBuild project environments Version May 08, 2025 555 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures should have a logging AWS Conﬁguration4 • Hs4Ma3G158 - SSM documents should not be public • Hs4Ma3G319 - Network Firewall ﬁrewalls should have deletion protection enabled Updated Supported conﬁgura tions Updated supported Oracle Linux operating systems to October 24, 2024 9.0-9.3, 8.0-8.9, 7.5-7.9. New section added to Oﬀboard from AMS Accelerat Instructions on how to oﬀboard with Alarm October 24, 2024 e Resource Tagger dashboard is now available. Manager and Resource Tagger dependencies added to Oﬀboard from AMS Accelerate.
accelerate-guide-173	accelerate-guide.pdf	173	enabled • Hs4Ma3G217 - CodeBuild project environments Version May 08, 2025 555 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures should have a logging AWS Conﬁguration4 • Hs4Ma3G158 - SSM documents should not be public • Hs4Ma3G319 - Network Firewall ﬁrewalls should have deletion protection enabled Updated Supported conﬁgura tions Updated supported Oracle Linux operating systems to October 24, 2024 9.0-9.3, 8.0-8.9, 7.5-7.9. New section added to Oﬀboard from AMS Accelerat Instructions on how to oﬀboard with Alarm October 24, 2024 e Resource Tagger dashboard is now available. Manager and Resource Tagger dependencies added to Oﬀboard from AMS Accelerate. The Resource Tagger dashboard is now available in Self-service reporting. September 26, 2024 You can now include multiple email addresses in tag-based Multiple email addresses are now supported in tag-based September 20, 2024 alerts. alerts. AMS Accelerate limits are now included in AMS patch management. AMS Accelerate Account Discovery update AMS Accelerate limits are included in Patch management - Create a patch maintenance window. A new section in Account Discovery has been added for Amazon EC2 Instance Evaluation. August 30, 2024 August 29, 2024 Version May 08, 2025 556 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures AMS Accelerate default patch baseline is now available for AMS Accelerate default patch baseline is now available for August 22, 2024 Ubuntu operating systems. Ubuntu operating systems. AMS Accelerate Account Discovery update Four new AWS API calls have been added to the AWS CloudTrail Evaluation section in the operational check table. August 2, 2024 Trusted Remediator now supports an additional check Trusted Remediator now supports the security check July 30, 2024 Hs4Ma3G192 - RDS DB Instances should prohibit public access. AMS now supports Amazon Route 53 Resolver DNS AMS now supports Amazon Route 53 Resolver DNS July 30, 2024 Firewall Firewall AMS Accelerate onboardin g_role_minimal.zip now AMS Accelerate onboardin g_role_minimal.zip now contains Terraform code contains Terraform code. July 30, 2024 Security Conﬁg Rules Dashboard The Security Conﬁg Rules Dashboard is now available in Self-Service reporting. July 24, 2024 AMS Accelerate now supports Oracle Linux 8.9, RHEL 8.10, and RHEL 9.4. AMS Accelerate now supports Oracle Linux 8.9, RHEL 8.10, and RHEL 9.4. July 5, 2024 AMS Accelerate account discovery process updated. The account discovery process used when onboarding AWS accounts to AMS Accelerate is updated. July 1, 2024 Version May 08, 2025 557 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Trusted Remediator is now available. Trusted Remediator, an AWS Managed Services solution June 24, 2024 that automates the remediati on of AWS Trusted Advisor checks, is now available. Amazon Route 53 Resolver DNS ﬁrewall events in AMS now monitors Amazon Route 53 Resolver DNS Security Incident Response. ﬁrewall events in Security June 21, 2024 Incident Response Updated supported operating systems AMS Accelerate now supports AlmaLinux 8.3-8.9, 9.0-9.2 June 19, 2024 (AlmaLinux is only supported with x86 architecture) Automatic instance proﬁle limit now increases if the AMS now increases the default instance proﬁle limit June 18, 2024 default is met. to 20 if the default limit of 10 is reached. AMS SSM Agent automatic installation feature now The AMS SSM Agent automatic installation feature June 7, 2024 enabled by default. is enabled by default for Security FAQ added to Security management. June 3, 2024 accounts onboarded after 6/03/2024. A Security FAQ is now available that covers common questions about the security best practices, controls, access models, and audit mechanisms used when an AMS operations engineer or automation accesses your accounts. Version May 08, 2025 558 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Additional AWS Regions now supported by Monitoring and Three additional AWS Regions are now supported by May 23, 2024 Incident Management for Monitoring and Incident Amazon EKS. Management for Amazon EKS. Service request patch notiﬁcations are now sent in AMS Accelerate patching creates a new service request May 3, 2024 advance of Patch Maintenan 4 days in advance of a Patch ce windows. Maintenance window. You can use the service request to communicate with AMS for adjustments to the patch or to skip a patch. Alert thresholds added to the AMS Accelerate EKS Detailed alert thresholds are now available in the Baseline May 3, 2024 monitoring baseline alerts alerts table for Amazon EKS table. monitoring. Updated: Alarm Manager Conﬁguration Proﬁles. Added notes about creating Anomaly Detection alarms April 25, 2024 with Alarm Manager. Additions to Resource Tagger conﬁguration proﬁles. DynamoDB tables and Amazon S3 buckets are now April 25, 2024 Added Planned Event Management (PEM) informati on section. available in Resource Tagger Detailed information about the PEM service oﬀering is now available in the AMS Accelerate User Guide. April 25, 2024 AMS supports Red Hat Enterpise Linux (RHEL) 9.x. AMS supports Red Hat Enterprise Linux (RHEL) 9.x. April 25, 2024 Version May 08, 2025 559 AMS Accelerate
accelerate-guide-174	accelerate-guide.pdf	174	alerts alerts table for Amazon EKS table. monitoring. Updated: Alarm Manager Conﬁguration Proﬁles. Added notes about creating Anomaly Detection alarms April 25, 2024 with Alarm Manager. Additions to Resource Tagger conﬁguration proﬁles. DynamoDB tables and Amazon S3 buckets are now April 25, 2024 Added Planned Event Management (PEM) informati on section. available in Resource Tagger Detailed information about the PEM service oﬀering is now available in the AMS Accelerate User Guide. April 25, 2024 AMS supports Red Hat Enterpise Linux (RHEL) 9.x. AMS supports Red Hat Enterprise Linux (RHEL) 9.x. April 25, 2024 Version May 08, 2025 559 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures AMS Accelerate supports reporting for all AWS Region AMS Accelerate supports SSM Inventory Reporting for all April 25, 2024 conﬁgurations. AWS Region conﬁgurations. Updated: AWS managed policies. Updated the AWSManage dServicesDeploymentToolkitP olicy with new ECR permissio ns. April 4, 2024 Updated: Resource Tagger Conﬁguration Proﬁles section Added AWS::EFS: :FileSystem to the ResourceType list. March 21, 2024 Updated: Incident reports and service requests in Accelerate Changed the topic title to Incident reports, service March 21, 2024 section. requests, and billing questions in Accelerate. Added a new section, Billing questions. Updated: How service request management works section. Added clariﬁcation on how AMS handles service requests March 21, 2024 that contain a feature request or a bug. Updated: Create aws_manag edservices_onboarding_role Added commands to create the role from AWS CloudShel March 21, 2024 role with AWS CloudForm ation section l. Updated: (Optional) Quick Start template Added commands to download the template from AWS CloudShell. March 21, 2024 Version May 08, 2025 560 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures New resource types available for Alarm Manager conﬁgura Added resource types for Amazon FSx, Amazon EFS, March 21, 2024 tion proﬁles. and Elasticsearch to Alarm Manager conﬁguration proﬁles. Additional pseudoparameter substitutions available for Added Amazon EFS and Amazon FSx pseudopar conﬁguration proﬁle. ameter substitutions. March 21, 2024 Added new section to Features in the Service description topic. Added a new section, Service request management under AMS Accelerate features. March 21, 2024 New columns added to the self-service reporting Weekly New columns were added to the Weekly Incident report March 11, 2024 Incident report so that you can ﬁlter for incidents based on quarter, month, week, or day that the incident was created or resolved. Earlier updates The following table describes the important changes to the documentation of the AMS Accelerate guide prior to March 2024. Change Description Date Improvements for AMS Accelerate CloudTrail trail onboarding Improvements for AMS Accelerate CloudTrail trail onboarding: February 23, 2024 • Collect all bucket policies in a single block • Remove the second AWS Organization ID in the policy statements • Clarify customer environment requirements Earlier updates Version May 08, 2025 561 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date For more information, see Review and update your conﬁgurations to enable AMS Accelerate to use your CloudTrail trail. Updated: Account onboarding process. Restructured the Account onboarding process section to make the steps more clear. Also February 22, 2024 aded an optional Quick Start template for onboarding features. See (Optional) Quick Start template in Accelerate. Updated: Oﬀboarding AMS Accelerate. Updated the AMS Accelerate oﬀboarding considerations section to indicate that the February 22, 2024 ams-access-management ation stack and ams-access-management IAM role aren't deleted by the oﬀboarding CloudForm process. See AMS Accelerate oﬀboarding eﬀects. Updated: Conﬁguration compliance in Accelerate. Changed "Incident Report" to "Service Request" where applicable to avoid confusion February 22, 2024 on these terms. See Conﬁguration compliance in Accelerate. Updated: Account discovery in Accelerate. Reorganized Account discovery in Accelerate to better group prerequisites with the relevant section. February 22, 2024 See Step 1. Account discovery in Accelerate. Renamed: AMS Patch reporting to AMS host management. Renamed AMS Patch reporting to AMS host management and renamed the report, Patch Details report, to SSM Agent Coverage report. February 22, 2024 See AMS host management reports. Earlier updates Version May 08, 2025 562 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated Operations on Demand Catalog Updated the Operations on Demand catalog of oﬀerings table to remove reference February 22, 2024 s to "health" in Amazon EKS cluster maintenance . See Requesting AMS Operations On Demand. Updated AMS Event Router Updated the AMSCoreRule in the AMS Event Router section. February 22, 2024 See Using Amazon EventBridge Managed Rules in AMS. Updated Supported Operating Systems. Updated Supported Operating Systems to include SUSE Linux Enterprise Server 15 SP5. February 22, 2024 See Supported conﬁgurations. Updated EC2 volume usage remediation automation Updated the EC2 volume usage remdiatio n automation section with correct capacity February 22, 2024 expansion schedule. See EC2 volume usage remediation automatio n. Updated: Review and update your conﬁgurations to enable Accelerate to use your CloudTrail trail
accelerate-guide-175	accelerate-guide.pdf	175	EKS cluster maintenance . See Requesting AMS Operations On Demand. Updated AMS Event Router Updated the AMSCoreRule in the AMS Event Router section. February 22, 2024 See Using Amazon EventBridge Managed Rules in AMS. Updated Supported Operating Systems. Updated Supported Operating Systems to include SUSE Linux Enterprise Server 15 SP5. February 22, 2024 See Supported conﬁgurations. Updated EC2 volume usage remediation automation Updated the EC2 volume usage remdiatio n automation section with correct capacity February 22, 2024 expansion schedule. See EC2 volume usage remediation automatio n. Updated: Review and update your conﬁgurations to enable Accelerate to use your CloudTrail trail Updated the AMS Accelerate Organization CloudTrail S3 bucket policy section. See Review and update your conﬁgurations to enable AMS Accelerate to use your CloudTrail trail February 15, 2024 Added new feature: SSM Agent auto installation Added a new section for SSM Agent auto installation January 26, 2024 See SSM Agent automatic installation. Earlier updates Version May 08, 2025 563 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated: Supported conﬁgurations Added information regarding the supported versions of AWS Control Tower January 26, 2024 See Supported conﬁgurations. Updated: AMS Patch reporting. Removed three sections from AMS Patch reporting: December 22, 2023 • Patch Instance Details Summary report • Patch Details report • Instances that Missed Patches report See AMS host management reports. Updated: Accelerate onboarding prerequisites. Updated the support plans required to onboard AMS Accelerate. December 15, 2023 See Accelerate onboarding prerequisites. Updated: Create a patch maintenace window. Removed Default patch cycle sectio as this feature is deprecated. December 13, 2023 Updated: Notiﬁcation settings in Accelerate. See Create a patch maintenance window in AMS. Clariﬁed what email is used for notiﬁcations. See Notiﬁcation settings in Accelerate for more information. Updated: AMSAccele Updated the AMSAccelerateCusto rateCustomerAccess Policies template. merAccessPolicies syntax error. template to correct a See Permissions to use AMS features for more information. December 12, 2023 December 12, 2023 Earlier updates Version May 08, 2025 564 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Added: Change request security reviews Added a new section Change request security reviews under Security Management. December 11, 2023 See Change request security reviews for more information. Updated: resource_inventory .xlsx Updated the resource_inventory.xlsx to include Security Analyst roles. November 17, 2023 See Resource inventory for Accelerate for more information. Updated: ams-access-admin-o perations role description Updated ams-access-admin-operations description. November 17, 2023 See Why and when AMS accesses your account and Authenticating with identities in AMS Accelerate for more information. Updated: AMS Accelerate oﬀboarding considerations Updated Security section to clarify what is available from Amazon GuardDuty and AWS November 17, 2023 Conﬁg rules after oﬀboarding. See AMS Accelerate oﬀboarding eﬀects for more information. Added: Monitoring and Incident Management for Amazon EKS Monitoring and Incident Management for Amazon EKS monitors your Amazon EKS resources for failures, performance degradati on, and security issues. November 14, 2023 See Monitoring and incident management for Amazon EKS in AMS Accelerate for more information. Earlier updates Version May 08, 2025 565 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated: Tagging Added information on customer-provided tagging. November 7, 2023 See Customer-provided tags in Accelerate for more information. Updated: Resource Tagger Conﬁguration Proﬁles Added AWS::AutoScaling::AutoScalingGroup, AWS::EKS::Cluster, AWS::Elasticsearch::Domain, October 27, 2023 and AWS::FSx::FileSystem to the Filter section. See Resource Tagger Conﬁguration Proﬁles in AMS Accelerate for more information. Updated: Service Description Added Ubuntu 22.04 to Supported Operating Systems. See Service description September 29, 2023 Updated: AMS Accelerate Onboarding Prerequisites Added a note to AMS Accelerate VPC endpoints to include CloudFormation September 29, 2023 template. See Accelerate onboarding prerequis ites. Updated: Detect Removed endpoint protection type from the AMS Accelerate security response. See Detect. September 29, 2023 Updated: Alerts from Baseline Monitoring in AMS Added AWS Outposts to the Alerts from Baseline Monitoring table. See Detect September 29, 2023 monitoring-default-metrics. Updated: Create aws_manag edservices_onboarding_role role with AWS CloudForm ation Updated screenshot for Specify Stack Details. See Create aws_managedservice September 29, 2023 s_onboarding_role CloudFormation for Accelerate. with AWS Earlier updates Version May 08, 2025 566 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated: Amazon EventBrid ge Managed Rules deployed Added new AMS Accelerate Amazon EventBrid ge Managed Rule AMSCoreRule. September 19, 2023 by AMS Accelerate Updated AMS Accelerate Amazon EventBridge Managed Rule AMSAccessRolesRule to add a new role. See Amazon EventBridge Managed Rules deployed by AMS for more information. Updated: Alarm Manager Conﬁguration Proﬁles Added AWS Outposts pseudoparameter substitution identiﬁers. See Monitoring and September 11, 2023 event management in AMS Accelerate. Updated: Resource Tagger Conﬁguration Proﬁles Added AWS Outposts resource type. See Accelerate Conﬁguration proﬁle: pseudopar September 11, 2023 ameter substitution. Updated: Supported services Added Amazon Elastic File System to the Services monitored by CloudWatch alarms section. See Service description for more
accelerate-guide-176	accelerate-guide.pdf	176	Accelerate Amazon EventBrid ge Managed Rule AMSCoreRule. September 19, 2023 by AMS Accelerate Updated AMS Accelerate Amazon EventBridge Managed Rule AMSAccessRolesRule to add a new role. See Amazon EventBridge Managed Rules deployed by AMS for more information. Updated: Alarm Manager Conﬁguration Proﬁles Added AWS Outposts pseudoparameter substitution identiﬁers. See Monitoring and September 11, 2023 event management in AMS Accelerate. Updated: Resource Tagger Conﬁguration Proﬁles Added AWS Outposts resource type. See Accelerate Conﬁguration proﬁle: pseudopar September 11, 2023 ameter substitution. Updated: Supported services Added Amazon Elastic File System to the Services monitored by CloudWatch alarms section. See Service description for more information. September 6, 2023 Updated: Patch monitoring and failure remediation Added the following note to Using Patch Orchestrator section: September 6, 2023 "Patch failure alerts aren't created for instances that have unsupported operating systems, or that are stopped during the maintenance window" See Understand patch management in AMS Accelerate for more information. Earlier updates Version May 08, 2025 567 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated: Clariﬁed Response to malware events runbook Clariﬁed Response to malware events runbook for Security Incident response. See Security September 6, 2023 Incident Response in AMS for more informati on. Updated: Connecting your Accelerate account with Clariﬁed steps for Connecting a new Accelerat e account VPC to the AMS Multi-Account September 5, 2023 Transit Gateway Landing Zone network (creating a TGW VPC attachment): See Connecting your Accelerat e account withTransit Gateway for more information. Updated: Alerts from baseline monitoring in AMS Removed reference to two deprecated alarms AMSReadLatencyAlarm and AMSWriteL September 5, 2023 atencyAlarm. See Alerts from baseline monitoring in AMS for more information. Added: AMS Event Router Added documentation for AMS Event Router See Using Amazon EventBridge Managed September 5, 2023 Rules in AMS for more information. Updated: List of Alarm Manager pseudoparameters. Updated the list of Alarm Manager pseudopar ameters. EC2 instance name parameter was August 29, 2023 added to EC2 instance and EC2 disk alarm conﬁgurations. See Accelerate Conﬁguration proﬁle: pseudoparameter substitution for more information. Added: AMS Access Oﬀboardi ng Added consideration when oﬀboarding AMS Access. See AMS Accelerate oﬀboarding eﬀects. August 24, 2023 Added: AMS Security Incident Response Added documentation for using AMS Security Incident Response. See Security Incident Response in AMS . August 18, 2023 Earlier updates Version May 08, 2025 568 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated: AMS Accelerate access roles Corrected a typo in the role names. See AWS Identity and Access Management in AMS August 10, 2023 Accelerate. Updated: Policy statements Replaced hardcoded role names with wildcards . See Review and update your conﬁgura August 10, 2023 tions to enable AMS Accelerate to use your CloudTrail trail. Updated: List of monitored services with EFS alerts. Updated the list of monitoring services with new EFS alerts for AMS baseline monitoring. August 03, 2023 4 new EFS alert types were added. See Alerts from baseline monitoring in AMS for more information. Updated: Accelerate resource inventory table Removed ams-backup-conﬁg-rule-stack and related resources. See Resource inventory for July 18, 2023 Accelerate. Updated: AMS Accelerate access roles Removed roles ams-backup-conﬁg-rule-st- amsBackupAlertConﬁgRule-<8-digit hash> July 18, 2023 and ams-backup-conﬁg-rule-st-amsBackupP lanConﬁgRuleH-<8-digit hash>. See AWS Identity and Access Management in AMS Accelerate. Updated the list of RDS alerts for AMS baseline monitoring. 9 new RDS alert types were added and 3 existing RDS alert types were removed. See Alerts from baseline monitoring in AMS for more information. Added new access roles for AMS Security. June 19, 2023 June 16, 2023 Updated: List of monitored RDS alerts. New: AMS Accelerate access roles Earlier updates Version May 08, 2025 569 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description New: AMS Accelerate CloudTrail log managemen Updated Accelerate supported options for CloudTrail log management, including t can now use customer Accelerate deployed trail or integration with CloudTrail trails. customer managed CloudTrail account or Date June 09, 2023 Updated: AMS Accelerat e Conﬁg Rules Response Conﬁguration Report. Organization trail. See Review and update your conﬁgurations to enable AMS Accelerate to use your CloudTrail trail for more informati on. Updated on-request reporting for AWS Conﬁg Rules Response Conﬁguration Report. See Accelerate updates to on-request reporting. See AMS Conﬁg Rules Response Conﬁguration report. May 26, 2023 Updated: Service Billing Start Date policy. Updated deﬁnitions of Billing Start Date in AMS key terms. May 15, 2023 Updated: AWS managed policies. Updated the AWSManagedServicesDeploymen tToolkitPolicy with new CFN and ECR May 09, 2023 permissions, and scoped down existing actions with wildcards. See Accelerate updates to service-linked roles. See Accelerate updates to service-linked roles. Updated: Access role policy links. The access roles can now be downloaded directly from Accelerate S3 bucket locations. See Why and when AMS accesses your account and AWS Identity and Access Management in AMS Accelerate. Earlier
accelerate-guide-177	accelerate-guide.pdf	177	AMS Conﬁg Rules Response Conﬁguration report. May 26, 2023 Updated: Service Billing Start Date policy. Updated deﬁnitions of Billing Start Date in AMS key terms. May 15, 2023 Updated: AWS managed policies. Updated the AWSManagedServicesDeploymen tToolkitPolicy with new CFN and ECR May 09, 2023 permissions, and scoped down existing actions with wildcards. See Accelerate updates to service-linked roles. See Accelerate updates to service-linked roles. Updated: Access role policy links. The access roles can now be downloaded directly from Accelerate S3 bucket locations. See Why and when AMS accesses your account and AWS Identity and Access Management in AMS Accelerate. Earlier updates Version May 08, 2025 570 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated: Monthly Billing Self-Service Report. Added note: The Monthly Billing reports are only available in a Management Payer account April 13, 2023 (AMS Advanced multi-account landing zone), but are available for all linked AMS Accelerate- managed accounts. See Billing report (monthly). Updated: List of Alerts. Removed CloudTrail references. See Log management in AMS Accelerate. Updated: List of Alerts. Added three new SSM agent alerts. See Alerts from baseline monitoring in AMS. April 13, 2023 April 13, 2023 Updated: Accelerate Prerequis ites. Clariﬁed that Accelerate requires one of four AWS Support plans be in place and excludes April 13, 2023 the Developer plan. See Accelerate onboarding prerequisites. Updated: Accelerate service-l inked role policy. The Contacts Service policy zip ﬁle has been updated. April 13, 2023 Updated: AMS Resource Scheduler. See AWS managed policies for AMS Accelerat e. Incorrect role name, AWSManagedServices -DescribeScheduleOrPeriod, corrected to AWSManagedServices-DescribeScheduleO rPeriods. See Cost optimization with AMS Resource Scheduler. April 13, 2023 Updated: AWS managed policies. Updated Customized ﬁndings responses with instructions for updating custom reponses in single or multiple accounts. April 13, 2023 Earlier updates Version May 08, 2025 571 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated: Resource Tagger Added warnings about "specifying the name for your new conﬁguration (SampleConﬁgurati March 16, 2023 onBlock in the provided example) as you may inadvertently override the AMS-manag ed conﬁguration with the same name". See Resource Tagger use cases in AMS Accelerate. Updated: Patch RACI Several updates and clarﬁcations to the RACI for patching. See Service description. March 16, 2023 Updated: Actions in deployment toolkit SLR JSON Updated policy and actions. See: Using service-linked roles for AMS Accelerate. March 16, 2023 Updated: Auto remediation Removed LVM support for EC2 volume automation. See: AMS automatic remediation March 16, 2023 of alerts. Updated: Accelerate Onboarding. Clariﬁed use of roles, espcially the minimal role The template to create AMS roles. March 16, 2023 Updated: Self-service reporting. Daily backup reports now support primary and secondary regions. Both are reported in the March 16, 2023 Resource Region ﬁeld of Backup report (daily). Updated: Patching guidance Added a warning not to customize the default patching baselines, which are managed by March 16, 2023 Updated Service Termination policy. AMS. Instead, create a new custom patching baseline. See: Default patch baseline and Custom patch baseline with AMS Accelerate. Updated deﬁnitions of Service Termination and Service Termination Date in AMS key terms. Termination notcies must be issued by the 20th day of the month prior to your last full month. March 16, 2023 Earlier updates Version May 08, 2025 572 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Updated: AWS managed policies. Clariﬁed policy name: Contacts service-linked role for AMS Accelerate. Date Feb 16, 2023 New: AWS managed policies. Added policy: Contacts service-linked role for AMS Accelerate. Feb 16, 2023 Updated: Conﬁguration compliance. Fixed a misspelled word in: Conﬁguration compliance in Accelerate. Feb 16, 2023 New Content: Unsupported OSes Added information on what services AMS provides for unsupported operating systems Feb 16, 2023 (OSes), see Capabilities for unsupported operating systems in Accelerate. Updated: Create patch windows Added a link for using CloudShell to Create a maintenance window with the Systems Feb 16, 2023 Manager command line interface (CLI) for AMS Accelerate. Updated Content: Onboardin g management resources Updated the zipped JSON templates in The template to create AMS roles. Feb 16, 2023 New Content: Conﬁguration Compliance Added a new topic: Customized ﬁndings responses. New: AWS managed policies. Added policy: Amazon EventBridge rule service-linked role for AMS Accelerate. Feb 16, 2023 Feb 07, 2023 Updated: AWS managed policies. New opt-in region: CPT. Updated the AWSManagedServices Jan 30, 2023 DeploymentToolkitPolicy S3 permissions. See Accelerate updates to service-linked roles. with new AMS Accelerate is now available in the Capetown (CPT) opt-in region. To opt in, see Managing AWS Regions. Jan 12, 2023 Earlier updates Version May 08, 2025 573 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated: Service Description. Added FSx services monitored by CloudWatch alarms to Service description. Jan 12, 2023 Updated: Monitoring default metrics. Added 6 FSx
accelerate-guide-178	accelerate-guide.pdf	178	rule service-linked role for AMS Accelerate. Feb 16, 2023 Feb 07, 2023 Updated: AWS managed policies. New opt-in region: CPT. Updated the AWSManagedServices Jan 30, 2023 DeploymentToolkitPolicy S3 permissions. See Accelerate updates to service-linked roles. with new AMS Accelerate is now available in the Capetown (CPT) opt-in region. To opt in, see Managing AWS Regions. Jan 12, 2023 Earlier updates Version May 08, 2025 573 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated: Service Description. Added FSx services monitored by CloudWatch alarms to Service description. Jan 12, 2023 Updated: Monitoring default metrics. Added 6 FSx alarms to Alerts from baseline monitoring in AMS. Jan 12, 2023 Updated: AMS patterns. Added Customize Cloudwatch Alarm Notiﬁcat ions to AMS patterns. Jan 12, 2023 Updated: Onboarding management resources. Updated: Conﬁguration compliance. Updated the table of templates, adding a row Jan 12, 2023 for ams-onboarding-ssm-execution- role in The template to create AMS roles. Additional details for requesting custom remediations (in the Important box) on Conﬁguration compliance in Accelerate. Jan 12, 2023 Updated: Service-linked-role permissions. Removed older or duplicated permissions. See Using service-linked roles for AMS Accelerate. Dec 15, 2022 Updated: Patch management, maintenance windows. Added guidance to console instructions, step 5, for creating a maintenance window. Dec 15, 2022 New: Patch management section. See Create a maintenance window from the Systems Manager console for AMS Accelerate. Added a section for Patch Tuesday maintenan ce windows. See Create a recurring "Patch Tuesday" maintenance window from the AMS console (recommended). Dec 15, 2022 Updated: AMS Resource Scheduler. Updated the AWS CloudFormation stack name. See Using resources with AMS Resource Scheduler. Dec 15, 2022 Updated: Tag your resources for backup. Added guidance for using AMS Resource Tagger. See Tag your resources to apply AMS Dec 15, 2022 backup plans. Earlier updates Version May 08, 2025 574 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Updated: Select a backup plan. Indicated which plans oﬀer continuous backup. See Select an AMS backup plan. Date Dec 15, 2022 Updated: AMS Resource Scheduler. Updated the AWS CLI example for deleting a period or schedule. See Working with periods Dec 15, 2022 and schedules in AWS Managed Services Resource Scheduler. Updated: AWS managed policies. Added the AWSManagedServices Dec 15, 2022 DeploymentToolkitPolicy managed policies for AMS Accelerate. . See AWS New: Added section describin g the AMS new service-linked Added GovCloud regions and permissions. See Detective controls service-linked role for AMS Dec 15, 2022 role, AWSServiceRoleForM Accelerate. anagedServices_DetectiveCon trolsConfig. New: AWS-managed policy Dec 15, 2022 Added section describing how the AWS- managed policy, AWSManagedServices _AlarmManagerPermissionsBoundary, is used in the service-linked role policy, AWSManage dServices_AlarmManager_ServiceRolePolicy, to restrict permissions of IAM roles created by the service-linked role AWSServiceRoleForM anagedServices_AlarmManager. See AWS managed policies for AMS Accelerate. Updated: Operations on Demand. Added oﬀerings: SQL Server on EC2 Operations and AMI Building and Vending. See Operations On Demand. Nov 10, 2022 Updated: Monitoring and event management. Updated explanation of service notiﬁcations and incident reports. See How monitoring works. Nov 10, 2022 Earlier updates Version May 08, 2025 575 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated: Service-linked role regions Added GovCloud regions and permissions. See Using service-linked roles for AMS Accelerate. Nov 10, 2022 New: Service-linked role. Added new role: AWSServiceRoleForA Nov 10, 2022 MSDetectiveControls . See Detective controls service-linked role for AMS Accelerate. Updated: Access managemen t. Updated subsections with improved instructi ons. See Access management in AMS Accelerat Nov 10, 2022 e. Updated: Service description. Updated AMS Patterns in the RACI matrix. See Service description. Nov 10, 2022 Updated: AMS patterns. Customers are responsible for pattern deployments. See AMS patterns. Updated: Oﬀboarding. Added details of what happens to speciﬁc Backup and Monitoring resources during oﬀboarding. See Oﬀboard from AMS Accelerat e. Nov 10, 2022 Nov 10, 2022 Updated: Patch managemen t.. Updated and shortened guidance regarding IAM policies. See Creating an IAM role for on- Nov 10, 2022 New: links to architecture diagrams. demand patching of AMS Accelerate. Added links to AMS Reference Architecture Diagrams to various topics. For example, see Monitoring and event management in AMS Accelerate. Nov 10, 2022 New: Operations on Demand oﬀering Added "Landing Zone Accelerator Operations". See Operations On Demand. Oct 13, 2022 Earlier updates Version May 08, 2025 576 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Update: Monitoring management. Alerts generate incident reports, not service requests How monitoring works. Oct 13, 2022 New: Creating a patch maintenance window with AWS CloudFormation patch window conﬁgura tion templates. See Create a patch maintenan Sept 15, 2022 an Accelerate-custom CFN ce window in AMS. template Updated: Oﬀboarding Emphasized that backup plans in Accelerat e no longer work after oﬀboarding. See Oﬀboard from AMS Accelerate. Sept 15, 2022 Updated: CloudWatch conﬁguration change details Corrected a
accelerate-guide-179	accelerate-guide.pdf	179	Operations On Demand. Oct 13, 2022 Earlier updates Version May 08, 2025 576 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Update: Monitoring management. Alerts generate incident reports, not service requests How monitoring works. Oct 13, 2022 New: Creating a patch maintenance window with AWS CloudFormation patch window conﬁgura tion templates. See Create a patch maintenan Sept 15, 2022 an Accelerate-custom CFN ce window in AMS. template Updated: Oﬀboarding Emphasized that backup plans in Accelerat e no longer work after oﬀboarding. See Oﬀboard from AMS Accelerate. Sept 15, 2022 Updated: CloudWatch conﬁguration change details Corrected a mistake in the Windows and Linux examples. See CloudWatch conﬁguration Sept 15, 2022 change details. Updated: Using AMS Resource Scheduler Added guidance about Cost Allocation Tags. See Cost estimator in AMS Resource Scheduler September 15, 2022 . Updated: AMS Conﬁg Rule Library Added two ams-eks- conﬁg rules to the Table of Rules. See AMS Conﬁg Rule library. September 15, 2022 Updated: Backup Managemen t Removed the misleading label PITR (point-in -time-recovery) from backup plan titles and descriptions. See Select an AMS backup plan. Updated: Accelerate Service Description Updated descriptions of conﬁg rules and canaries. See Service description. Updated: Service Description, Supported Conﬁgurations Removed end-of-service date for Windows 2008 R2. Accelerate does not support Windows 2008. See Supported conﬁgurations. September 15, 2022 September 15, 2022 August 11, 2022 Earlier updates Version May 08, 2025 577 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated: Service Description, Roles and Responsibilities Updated the RACI table. Removed ELB access logs from the last row of the Networking August 11, 2022 section. We do not enable ELB access logs for Accelerate customers. See Roles and responsib ilities. Updated: Conﬁguration Compliance Corrected a typo in the Table of Rules, Frameworks column. NIST-CSF was incorrect August 11, 2022 ly listed as NIST-CIS. See Conﬁguration compliance in Accelerate. New: Accelerate Oﬀboarding Considerations and process for oﬀboarding. See Oﬀboarding AMS Accelerate. August 11, 2022 Updated: List of pre-insta lled SSM agents' operating Added "Ubuntu Linux 18.04 and 20.04" to the list. See Onboarding EC2 instances to August 11, 2022 systems Accelerate. New: Resource Scheduler Use AMS Resource Scheduler to cost optimize by stopping and starting resources only as needed. See Cost optimization with AMS Resource Scheduler. July 14, 2022 Updated: Service Description for Resource Scheduler Several sections of the service description were updated for the new Resource Scheduler July 14, 2022 oﬀering. See Service description. New: AMS Patterns New: Cost optimization note AMS oﬀers pattern templates, a generalized solution that solves for a family of use cases in the AMS managed environment. First pattern on oﬀer: AMS patterns. July 14, 2022 Added a note explaining how costs can increase with resource usage. See Resource inventory for Accelerate. July 14, 2022 Earlier updates Version May 08, 2025 578 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated: AMS Conﬁg Rules Reorganized the tables in the AMS Conﬁg Rule library. The HTML table has fewer columns, July 14, 2022 to make it easier to read at a glance. The downloadable spreadsheet has additional columns to allow sorting and ﬁltering. Updated: Access Management Updated the sample CloudFormation template July 14, 2022 in Permissions to use AMS features. The AMSAccelerateAdminAccess policy now includes the AmsResourceSchedul and IAMReadOn erPassRolePolicy lyPolicy policies. Updated: Self-Service Reporting Added instructions for encrypting AWS Glue metadata with KMS keys. See box labeled July 14, 2022 Important on Self-service reports. Updated: AMS baseline monitoring Added DeleteRecoveryPoint backup alert. Alerts from baseline monitoring in AMS July 14, 2022 Updated: Supported operating systems Added End of Support date for Amazon Linux 2. Service description July 14, 2022 Updated: AMS Reporting Added note about Opt-in Regions. Reports and options July 14, 2022 Resource Scheduler June 30, 2022 Added information about onboarding and using AMS Resource Scheduler to assist in cost optimization by scheduling resource stop and start times. Also, updated the Accelerat e service description to include mention of Resource Scheduler. Additionally, updated the Amazon Linux 2 supported end of support date to 2024. See Cost optimization with AMS Resource Scheduler and Service description Earlier updates Version May 08, 2025 579 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change New alarm New content Description Added a AWS Backup alarm. Alerts from baseline monitoring in AMS Date June 21, 2022 Added the service-linked role content. Using service-linked roles for AMS Accelerate June 16, 2022 AWS Network Firewall Operations added to Operations on Demand (OOD) catalog of June 16, 2022 oﬀerings. Operations On Demand Added problem management feature descripti on. Service description June 16, 2022 Added note about the set of conﬁg rules that does not support in particular opt-in regions. June 16, 2022 Conﬁguration compliance in Accelerate Conﬁguration compliance. "AMS Conﬁg Rule library" ->
accelerate-guide-180	accelerate-guide.pdf	180	AMS Accelerate Concepts and Procedures Change New alarm New content Description Added a AWS Backup alarm. Alerts from baseline monitoring in AMS Date June 21, 2022 Added the service-linked role content. Using service-linked roles for AMS Accelerate June 16, 2022 AWS Network Firewall Operations added to Operations on Demand (OOD) catalog of June 16, 2022 oﬀerings. Operations On Demand Added problem management feature descripti on. Service description June 16, 2022 Added note about the set of conﬁg rules that does not support in particular opt-in regions. June 16, 2022 Conﬁguration compliance in Accelerate Conﬁguration compliance. "AMS Conﬁg Rule library" -> "Table of rules", was updated and June 16, 2022 removed to ZIP only. Conﬁguration complianc e in Accelerate Updated content Removed escalation emails. Escalation path June 16, 2022 Moved topic list to below opening paragraphs. What is AMS Accelerate? June 16, 2022 Updated the auto remeditation content. AMS automatic remediation of alerts June 16, 2022 Updated content: Service Description Added EKS to the list of services monitored by AMS Conﬁg Rules in Supported services. May 12, 2022 Updated monitoring description in RACI table in Roles and responsibilities. Earlier updates Version May 08, 2025 580 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated content: Conﬁgura tion Compliance Added EKS-related conﬁg rules. See Conﬁgura tion compliance in Accelerate. May 12, 2022 Updated content: Getting Started, Account Discovery Added a newer version of the AwsAccoun tDiscoveryCli script (in the Account Discovery May 12, 2022 Changelog zip ﬁle) in Step 1. Account discovery in Accelerate. Updated content: Monitoring, default metrics Updated trigger conditions for ALB-related metrics. See Alerts from baseline monitoring May 12, 2022 in AMS. Updated content: Patching onboarding Added an explicit patching prerequisite: you need to opt-in to EBS. See Onboarding May 12, 2022 patching in Accelerate. Updated content: Accelerate resource inventory table Changed ams-detective-controls-config-rules- cdk rules, added rules for ams-detective-cont April 14, 2022 rols-recorder-cdk and ams-detective-controls- infrastructure-cdk. See Resource inventory for Accelerate. Updated content: Conﬁgura tion Compliance Introduction to industry standards, conﬁg rules, and types of responses. Emphasizes that April 14, 2022 customers do not choose individual conﬁg rules or responses. Conﬁguration compliance in Accelerate. Updated content: Service Description Moved the existing Scope of Changes section under Roles and Responsibilities. See Roles and responsibilities. April 14, 2022 Earlier updates Version May 08, 2025 581 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated content: Tagging and Monitoring Added AWS::Synthetics:Canary to lists of allowed Resource Types for tagging and April 14, 2022 monitoring. See Resource Tagger Conﬁgura tion Proﬁles in AMS Accelerate and Accelerat e Conﬁguration proﬁle: pseudoparameter substitution. Updated content: Accelerate Prerequisites Added SSM-required bucket permissions to Amazon EC2 Systems Manager in Accelerate. April 14, 2022 New content: Patching and Monitoring Added sample code to use Cloudformation to deploy tagging and monitoring conﬁgurations. See Deploying a conﬁguration proﬁle with AWS CloudFormation for Accelerate and Using AWS CloudFormation to deploy Accelerate conﬁguration changes. March 10, 2022 Updated content: Patch maintenance console Reordered steps in Create a maintenance window from the Systems Manager console March 10, 2022 for AMS Accelerate to match the console interface. Updated content: Patch maintenance CLI Updated CLI parameters (schedule, duration, and cutoﬀ) for Create a maintenance window March 10, 2022 with the Systems Manager command line interface (CLI) for AMS Accelerate New content: Auto Instance Conﬁg Added deﬁnition of AMSInstanceProfile BasePolicy details to IAM permissions change March 10, 2022 New content: Onboarding Added a sample Linux command to Outbound internet connectivity in Accelerate March 10, 2022 New content: Onboarding Added a least-privilege option to The template to create AMS roles. March 10, 2022 Earlier updates Version May 08, 2025 582 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date Updated content: Accelerate escalation instructions Added guidance, links, and email contacts to Escalation path March 10, 2022 Updated content: Supported Conﬁgurations AMS expects to end support for RHEL 6 and CentOs on March 14, 2023. See Supported March 10, 2022 conﬁgurations Updated content: Resources table Added AMS access IAM roles to Resource inventory for Accelerate resources table Updated content: Onboarding and Backup Added instructions for opting in to AWS Backup to Onboarding AWS Backup in Accelerate and Continuity management in AMS Accelerate March 10, 2022 March 10, 2022 Updated content: Access Management Removed Advanced-speciﬁc instructions from Accelerate guidance How and when to use the March 10, 2022 root user account in AMS. Updated content: Supported Conﬁgurations AMS now supports Oracle Linux 8.3 and Ubuntu 18.04 and 20.04. See Supported February 28, 2022 conﬁgurations. Updated content: Service Level Agreement Updated the downloadable Service Level Agreement in Supported services. Updated content: Access Management Updated How AMS accesses your account with FAQs for AMS operator console roles and a warning not to modify or delete them. Updated content: Alarm Manager
accelerate-guide-181	accelerate-guide.pdf	181	Continuity management in AMS Accelerate March 10, 2022 March 10, 2022 Updated content: Access Management Removed Advanced-speciﬁc instructions from Accelerate guidance How and when to use the March 10, 2022 root user account in AMS. Updated content: Supported Conﬁgurations AMS now supports Oracle Linux 8.3 and Ubuntu 18.04 and 20.04. See Supported February 28, 2022 conﬁgurations. Updated content: Service Level Agreement Updated the downloadable Service Level Agreement in Supported services. Updated content: Access Management Updated How AMS accesses your account with FAQs for AMS operator console roles and a warning not to modify or delete them. Updated content: Alarm Manager Updated Accelerate Conﬁguration proﬁle: monitoring. Alarm Manager is no longer limited to single-metric alarms. February 28, 2022 February 28, 2022 February 28, 2022 Updated content: Getting Started Updated Step 2. Onboarding management resources in Accelerate. Added an IAM role February 28, 2022 with minimal access for onboarding resources. Earlier updates Version May 08, 2025 583 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date New content: Scope of Changes in Service Descripti Added a new section,Scope of changes performed by AMS Accelerate that emphasize February 10, 2022 on s boundaries and actions that AMS Accelerate does not perform. Updated content: Getting Started New onboarding process starts with setting up default features and conﬁgurations before February 10, 2022 customizing. Subsections contain feature-s peciﬁc goals and related links. See Getting Started with AMS Accelerate. Updated content: AMS Backup Management. Shortened and reorganized the Continuity management in AMS Accelerate chapter for February 10, 2022 readability. Updated content: Tagging Added a Tagging Tools section to accommoda te code samples for CloudFormation and other February 10, 2022 tools. See Tagging in AMS Accelerate. Updated content: Baseline Monitoring Improved trigger condition for RedShift cluster alarm reduces false alarms during February 10, 2022 Updated content: Patching Updated content: AWS Conﬁg Rules Inventory. maintenance. See Alerts from baseline monitoring in AMS. Updated sample CLI command to register a maintenance window. See Create a maintenan ce window with the Systems Manager command line interface (CLI) for AMS Accelerate. February 10, 2022 Removed deprecated conﬁg rule ams-nist- cis-ec2-security-group-atta ched-to-eni from the AWS Conﬁg Rules Inventory table. See Table of Rules. January 27, 2022 Earlier updates Version May 08, 2025 584 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Change Description Date New content: Creating patch maintenance windows. Added a link to the SSM tutorial and sample commands for creating patch maintenance January 27, 2022 windows from the command line. See Create a maintenance window with the Systems Manager command line interface (CLI) for AMS Accelerate. New content: Resource Tagger recognizes new Auto Added Auto Scaling Groups to the resource types ﬁlterable with Resource Tagger January 13, 2022 Scaling Groups (ASG) resource conﬁguration proﬁles. See Syntax and type. structure. New content: Additional backup plans and vaults. Added new backup plans and vaults to mitigate high-risk scenarios including January 13, 2022 ransomware attacks. See View backups in AMS vaults and View backups in AMS vaults. Earlier updates Version May 08, 2025 585 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures AWS Glossary For the latest AWS terminology, see the AWS glossary in the AWS Glossary Reference. Version May 08, 2025 586
access-analyzer-api-001	access-analyzer-api.pdf	1	API Reference IAM Access Analyzer API Version 2019-11-01 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. IAM Access Analyzer API Reference IAM Access Analyzer: 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. IAM Access Analyzer Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 ApplyArchiveRule .......................................................................................................................................... 4 Request Syntax ........................................................................................................................................ 4 URI Request Parameters ........................................................................................................................ 4 Request Body ........................................................................................................................................... 4 Response Syntax ...................................................................................................................................... 5 Response Elements ................................................................................................................................. 5 Errors .......................................................................................................................................................... 5 See Also ..................................................................................................................................................... 6 CancelPolicyGeneration ............................................................................................................................... 7 Request Syntax ........................................................................................................................................ 7 URI Request Parameters ........................................................................................................................ 7 Request Body ........................................................................................................................................... 7 Response Syntax ...................................................................................................................................... 7 Response Elements ................................................................................................................................. 7 Errors .......................................................................................................................................................... 7 See Also ..................................................................................................................................................... 8 CheckAccessNotGranted .............................................................................................................................. 9 Request Syntax ........................................................................................................................................ 9 URI Request Parameters ........................................................................................................................ 9 Request Body ........................................................................................................................................... 9 Response Syntax ................................................................................................................................... 10 Response Elements ............................................................................................................................... 10 Errors ....................................................................................................................................................... 11 See Also .................................................................................................................................................. 12 CheckNoNewAccess .................................................................................................................................... 13 Request Syntax ...................................................................................................................................... 13 URI Request Parameters ...................................................................................................................... 13 Request Body ......................................................................................................................................... 13 Response Syntax ................................................................................................................................... 14 Response Elements ............................................................................................................................... 14 Errors ....................................................................................................................................................... 15 See Also .................................................................................................................................................. 16 API Version 2019-11-01 iii IAM Access Analyzer API Reference CheckNoPublicAccess ................................................................................................................................. 17 Request Syntax ...................................................................................................................................... 17 URI Request Parameters ...................................................................................................................... 17 Request Body ......................................................................................................................................... 17 Response Syntax ................................................................................................................................... 18 Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 19 See Also .................................................................................................................................................. 20 CreateAccessPreview .................................................................................................................................. 21 Request Syntax ...................................................................................................................................... 21 URI Request Parameters ...................................................................................................................... 21 Request Body ......................................................................................................................................... 21 Response Syntax ................................................................................................................................... 22 Response Elements ............................................................................................................................... 22 Errors ....................................................................................................................................................... 22 See Also .................................................................................................................................................. 23 CreateAnalyzer ............................................................................................................................................ 25 Request Syntax ...................................................................................................................................... 25 URI Request Parameters ...................................................................................................................... 25 Request Body ......................................................................................................................................... 25 Response Syntax ................................................................................................................................... 27 Response Elements ............................................................................................................................... 27 Errors ....................................................................................................................................................... 28 See Also .................................................................................................................................................. 28 CreateArchiveRule ...................................................................................................................................... 30 Request Syntax ...................................................................................................................................... 30 URI Request Parameters ...................................................................................................................... 30 Request Body ......................................................................................................................................... 31 Response Syntax ................................................................................................................................... 31 Response Elements ............................................................................................................................... 31 Errors ....................................................................................................................................................... 31 See Also .................................................................................................................................................. 32 DeleteAnalyzer ............................................................................................................................................ 34 Request Syntax ...................................................................................................................................... 34 URI Request Parameters ...................................................................................................................... 34 Request Body ......................................................................................................................................... 34 API Version 2019-11-01 iv IAM Access Analyzer API Reference Response Syntax ................................................................................................................................... 34 Response Elements ............................................................................................................................... 34 Errors ....................................................................................................................................................... 35 See Also .................................................................................................................................................. 35 DeleteArchiveRule ...................................................................................................................................... 37 Request Syntax ...................................................................................................................................... 37 URI Request Parameters ...................................................................................................................... 37 Request Body ......................................................................................................................................... 37 Response Syntax ................................................................................................................................... 37 Response Elements ............................................................................................................................... 38 Errors ....................................................................................................................................................... 38 See Also .................................................................................................................................................. 38 GenerateFindingRecommendation ......................................................................................................... 40 Request Syntax ...................................................................................................................................... 40 URI Request Parameters ...................................................................................................................... 40 Request Body ......................................................................................................................................... 40 Response Syntax ................................................................................................................................... 40 Response Elements ............................................................................................................................... 40 Errors ....................................................................................................................................................... 41 See Also .................................................................................................................................................. 41 GetAccessPreview ....................................................................................................................................... 43 Request Syntax ...................................................................................................................................... 43 URI Request Parameters ...................................................................................................................... 43 Request Body ......................................................................................................................................... 43 Response Syntax ................................................................................................................................... 43 Response Elements ............................................................................................................................... 44 Errors ....................................................................................................................................................... 44 See Also .................................................................................................................................................. 45 GetAnalyzedResource ................................................................................................................................ 46 Request Syntax ...................................................................................................................................... 46 URI Request Parameters ...................................................................................................................... 46 Request Body ......................................................................................................................................... 46 Response Syntax ................................................................................................................................... 46 Response Elements ............................................................................................................................... 47 Errors ....................................................................................................................................................... 47 See Also .................................................................................................................................................. 48 API Version 2019-11-01 v IAM Access Analyzer API Reference GetAnalyzer ................................................................................................................................................. 49 Request Syntax ...................................................................................................................................... 49 URI Request Parameters ...................................................................................................................... 49 Request Body ......................................................................................................................................... 49 Response Syntax ................................................................................................................................... 49 Response Elements ............................................................................................................................... 50 Errors ....................................................................................................................................................... 50 See Also .................................................................................................................................................. 51 GetArchiveRule ............................................................................................................................................ 52 Request Syntax ...................................................................................................................................... 52 URI Request Parameters ...................................................................................................................... 52 Request Body ......................................................................................................................................... 52 Response Syntax ................................................................................................................................... 52 Response Elements ............................................................................................................................... 53 Errors ....................................................................................................................................................... 53 See Also .................................................................................................................................................. 54 GetFinding .................................................................................................................................................... 55 Request Syntax ...................................................................................................................................... 55 URI Request Parameters ...................................................................................................................... 55 Request Body ......................................................................................................................................... 55 Response Syntax ................................................................................................................................... 55 Response Elements ............................................................................................................................... 56 Errors ....................................................................................................................................................... 56 See Also .................................................................................................................................................. 57 GetFindingRecommendation .................................................................................................................... 59 Request Syntax ...................................................................................................................................... 59 URI Request Parameters ...................................................................................................................... 59 Request Body ......................................................................................................................................... 59 Response Syntax ................................................................................................................................... 60 Response Elements ............................................................................................................................... 60 Errors ....................................................................................................................................................... 61 See Also .................................................................................................................................................. 62 GetFindingsStatistics ................................................................................................................................. 64 Request Syntax ...................................................................................................................................... 64 URI Request Parameters ...................................................................................................................... 64 Request Body ......................................................................................................................................... 64 API Version 2019-11-01 vi IAM Access Analyzer API Reference Response Syntax ................................................................................................................................... 64 Response Elements ............................................................................................................................... 65 Errors ....................................................................................................................................................... 65 See Also .................................................................................................................................................. 66 GetFindingV2 ............................................................................................................................................... 67 Request Syntax ...................................................................................................................................... 67 URI Request Parameters ...................................................................................................................... 67 Request Body ......................................................................................................................................... 67 Response Syntax ................................................................................................................................... 68 Response Elements ............................................................................................................................... 68 Errors ....................................................................................................................................................... 70 See Also .................................................................................................................................................. 71 GetGeneratedPolicy ................................................................................................................................... 72 Request Syntax ...................................................................................................................................... 72 URI Request Parameters ...................................................................................................................... 72 Request Body ......................................................................................................................................... 72 Response Syntax ................................................................................................................................... 73 Response Elements ............................................................................................................................... 73 Errors ....................................................................................................................................................... 74 See Also .................................................................................................................................................. 75 ListAccessPreviewFindings ........................................................................................................................ 76 Request Syntax ...................................................................................................................................... 76 URI Request Parameters ...................................................................................................................... 76 Request Body ......................................................................................................................................... 76 Response Syntax
access-analyzer-api-002	access-analyzer-api.pdf	2	IAM Access Analyzer API Reference Response Syntax ................................................................................................................................... 64 Response Elements ............................................................................................................................... 65 Errors ....................................................................................................................................................... 65 See Also .................................................................................................................................................. 66 GetFindingV2 ............................................................................................................................................... 67 Request Syntax ...................................................................................................................................... 67 URI Request Parameters ...................................................................................................................... 67 Request Body ......................................................................................................................................... 67 Response Syntax ................................................................................................................................... 68 Response Elements ............................................................................................................................... 68 Errors ....................................................................................................................................................... 70 See Also .................................................................................................................................................. 71 GetGeneratedPolicy ................................................................................................................................... 72 Request Syntax ...................................................................................................................................... 72 URI Request Parameters ...................................................................................................................... 72 Request Body ......................................................................................................................................... 72 Response Syntax ................................................................................................................................... 73 Response Elements ............................................................................................................................... 73 Errors ....................................................................................................................................................... 74 See Also .................................................................................................................................................. 75 ListAccessPreviewFindings ........................................................................................................................ 76 Request Syntax ...................................................................................................................................... 76 URI Request Parameters ...................................................................................................................... 76 Request Body ......................................................................................................................................... 76 Response Syntax ................................................................................................................................... 77 Response Elements ............................................................................................................................... 78 Errors ....................................................................................................................................................... 79 See Also .................................................................................................................................................. 79 ListAccessPreviews ..................................................................................................................................... 81 Request Syntax ...................................................................................................................................... 81 URI Request Parameters ...................................................................................................................... 81 Request Body ......................................................................................................................................... 81 Response Syntax ................................................................................................................................... 81 Response Elements ............................................................................................................................... 82 Errors ....................................................................................................................................................... 82 See Also .................................................................................................................................................. 83 API Version 2019-11-01 vii IAM Access Analyzer API Reference ListAnalyzedResources ............................................................................................................................... 84 Request Syntax ...................................................................................................................................... 84 URI Request Parameters ...................................................................................................................... 84 Request Body ......................................................................................................................................... 84 Response Syntax ................................................................................................................................... 85 Response Elements ............................................................................................................................... 85 Errors ....................................................................................................................................................... 86 See Also .................................................................................................................................................. 87 ListAnalyzers ................................................................................................................................................ 88 Request Syntax ...................................................................................................................................... 88 URI Request Parameters ...................................................................................................................... 88 Request Body ......................................................................................................................................... 88 Response Syntax ................................................................................................................................... 88 Response Elements ............................................................................................................................... 89 Errors ....................................................................................................................................................... 89 See Also .................................................................................................................................................. 90 ListArchiveRules .......................................................................................................................................... 91 Request Syntax ...................................................................................................................................... 91 URI Request Parameters ...................................................................................................................... 91 Request Body ......................................................................................................................................... 91 Response Syntax ................................................................................................................................... 91 Response Elements ............................................................................................................................... 92 Errors ....................................................................................................................................................... 92 See Also .................................................................................................................................................. 93 ListFindings .................................................................................................................................................. 94 Request Syntax ...................................................................................................................................... 94 URI Request Parameters ...................................................................................................................... 94 Request Body ......................................................................................................................................... 94 Response Syntax ................................................................................................................................... 95 Response Elements ............................................................................................................................... 96 Errors ....................................................................................................................................................... 97 See Also .................................................................................................................................................. 97 ListFindingsV2 ............................................................................................................................................. 99 Request Syntax ...................................................................................................................................... 99 URI Request Parameters ...................................................................................................................... 99 Request Body ......................................................................................................................................... 99 API Version 2019-11-01 viii IAM Access Analyzer API Reference Response Syntax ................................................................................................................................. 100 Response Elements ............................................................................................................................ 101 Errors ..................................................................................................................................................... 101 See Also ................................................................................................................................................ 102 ListPolicyGenerations .............................................................................................................................. 104 Request Syntax .................................................................................................................................... 104 URI Request Parameters ................................................................................................................... 104 Request Body ....................................................................................................................................... 104 Response Syntax ................................................................................................................................. 104 Response Elements ............................................................................................................................ 105 Errors ..................................................................................................................................................... 105 See Also ................................................................................................................................................ 106 ListTagsForResource ................................................................................................................................ 107 Request Syntax .................................................................................................................................... 107 URI Request Parameters ................................................................................................................... 107 Request Body ....................................................................................................................................... 107 Response Syntax ................................................................................................................................. 107 Response Elements ............................................................................................................................ 107 Errors ..................................................................................................................................................... 108 See Also ................................................................................................................................................ 108 StartPolicyGeneration ............................................................................................................................. 110 Request Syntax .................................................................................................................................... 110 URI Request Parameters ................................................................................................................... 110 Request Body ....................................................................................................................................... 110 Response Syntax ................................................................................................................................. 111 Response Elements ............................................................................................................................ 111 Errors ..................................................................................................................................................... 112 See Also ................................................................................................................................................ 112 StartResourceScan ................................................................................................................................... 114 Request Syntax .................................................................................................................................... 114 URI Request Parameters ................................................................................................................... 114 Request Body ....................................................................................................................................... 114 Response Syntax ................................................................................................................................. 115 Response Elements ............................................................................................................................ 115 Errors ..................................................................................................................................................... 115 See Also ................................................................................................................................................ 116 API Version 2019-11-01 ix IAM Access Analyzer API Reference TagResource .............................................................................................................................................. 117 Request Syntax .................................................................................................................................... 117 URI Request Parameters ................................................................................................................... 117 Request Body ....................................................................................................................................... 117 Response Syntax ................................................................................................................................. 117 Response Elements ............................................................................................................................ 118 Errors ..................................................................................................................................................... 118 See Also ................................................................................................................................................ 118 UntagResource .......................................................................................................................................... 120 Request Syntax .................................................................................................................................... 120 URI Request Parameters ................................................................................................................... 120 Request Body ....................................................................................................................................... 120 Response Syntax ................................................................................................................................. 120 Response Elements ............................................................................................................................ 120 Errors ..................................................................................................................................................... 120 See Also ................................................................................................................................................ 121 UpdateAnalyzer ........................................................................................................................................ 123 Request Syntax .................................................................................................................................... 123 URI Request Parameters ................................................................................................................... 123 Request Body ....................................................................................................................................... 123 Response Syntax ................................................................................................................................. 124 Response Elements ............................................................................................................................ 124 Errors ..................................................................................................................................................... 124 See Also ................................................................................................................................................ 125 UpdateArchiveRule .................................................................................................................................. 126 Request Syntax .................................................................................................................................... 126 URI Request Parameters ................................................................................................................... 126 Request Body ....................................................................................................................................... 127 Response Syntax ................................................................................................................................. 127 Response Elements ............................................................................................................................ 127 Errors ..................................................................................................................................................... 127 See Also ................................................................................................................................................ 128 UpdateFindings ......................................................................................................................................... 129 Request Syntax .................................................................................................................................... 129 URI Request Parameters ................................................................................................................... 129 Request Body ....................................................................................................................................... 129 API Version 2019-11-01 x IAM Access Analyzer API Reference Response Syntax ................................................................................................................................. 130 Response Elements ............................................................................................................................ 130 Errors ..................................................................................................................................................... 130 See Also ................................................................................................................................................ 131 ValidatePolicy ............................................................................................................................................ 133 Request Syntax .................................................................................................................................... 133 URI Request Parameters ................................................................................................................... 133 Request Body ....................................................................................................................................... 133 Response Syntax ................................................................................................................................. 135 Response Elements ............................................................................................................................ 136 Errors ..................................................................................................................................................... 136 See Also ................................................................................................................................................ 137 Data Types ................................................................................................................................... 138 Access ......................................................................................................................................................... 142 Contents ............................................................................................................................................... 142 See Also ................................................................................................................................................ 142 AccessPreview ........................................................................................................................................... 143 Contents ............................................................................................................................................... 143 See Also ................................................................................................................................................ 144 AccessPreviewFinding .............................................................................................................................. 145 Contents ............................................................................................................................................... 145 See Also ................................................................................................................................................ 148 AccessPreviewStatusReason ................................................................................................................... 149 Contents ............................................................................................................................................... 149 See Also ................................................................................................................................................ 149 AccessPreviewSummary .......................................................................................................................... 150 Contents ............................................................................................................................................... 150 See Also ................................................................................................................................................ 151 AclGrantee ................................................................................................................................................. 152 Contents ............................................................................................................................................... 152 See Also ................................................................................................................................................ 152 AnalysisRule .............................................................................................................................................. 153 Contents ............................................................................................................................................... 153 See Also ................................................................................................................................................ 153 AnalysisRuleCriteria ................................................................................................................................. 154 Contents ............................................................................................................................................... 154 API Version 2019-11-01 xi IAM Access Analyzer API Reference See Also ................................................................................................................................................ 154 AnalyzedResource .................................................................................................................................... 156 Contents ............................................................................................................................................... 156 See Also ................................................................................................................................................ 158 AnalyzedResourceSummary ................................................................................................................... 159 Contents ............................................................................................................................................... 159 See Also ................................................................................................................................................ 160 AnalyzerConﬁguration ............................................................................................................................ 161 Contents ............................................................................................................................................... 161 See Also ................................................................................................................................................ 161 AnalyzerSummary .................................................................................................................................... 162 Contents ............................................................................................................................................... 162 See Also ................................................................................................................................................ 164 ArchiveRuleSummary .............................................................................................................................. 165 Contents ............................................................................................................................................... 165 See Also ................................................................................................................................................ 166 CloudTrailDetails ...................................................................................................................................... 167 Contents ............................................................................................................................................... 167 See Also ................................................................................................................................................ 168 CloudTrailProperties ................................................................................................................................
access-analyzer-api-003	access-analyzer-api.pdf	3	................................................................................................................................................. 152 Contents ............................................................................................................................................... 152 See Also ................................................................................................................................................ 152 AnalysisRule .............................................................................................................................................. 153 Contents ............................................................................................................................................... 153 See Also ................................................................................................................................................ 153 AnalysisRuleCriteria ................................................................................................................................. 154 Contents ............................................................................................................................................... 154 API Version 2019-11-01 xi IAM Access Analyzer API Reference See Also ................................................................................................................................................ 154 AnalyzedResource .................................................................................................................................... 156 Contents ............................................................................................................................................... 156 See Also ................................................................................................................................................ 158 AnalyzedResourceSummary ................................................................................................................... 159 Contents ............................................................................................................................................... 159 See Also ................................................................................................................................................ 160 AnalyzerConﬁguration ............................................................................................................................ 161 Contents ............................................................................................................................................... 161 See Also ................................................................................................................................................ 161 AnalyzerSummary .................................................................................................................................... 162 Contents ............................................................................................................................................... 162 See Also ................................................................................................................................................ 164 ArchiveRuleSummary .............................................................................................................................. 165 Contents ............................................................................................................................................... 165 See Also ................................................................................................................................................ 166 CloudTrailDetails ...................................................................................................................................... 167 Contents ............................................................................................................................................... 167 See Also ................................................................................................................................................ 168 CloudTrailProperties ................................................................................................................................ 169 Contents ............................................................................................................................................... 169 See Also ................................................................................................................................................ 169 Conﬁguration ............................................................................................................................................ 171 Contents ............................................................................................................................................... 171 See Also ................................................................................................................................................ 173 Criterion ..................................................................................................................................................... 174 Contents ............................................................................................................................................... 174 See Also ................................................................................................................................................ 175 DynamodbStreamConﬁguration ........................................................................................................... 176 Contents ............................................................................................................................................... 176 See Also ................................................................................................................................................ 176 DynamodbTableConﬁguration .............................................................................................................. 177 Contents ............................................................................................................................................... 177 See Also ................................................................................................................................................ 177 EbsSnapshotConﬁguration ..................................................................................................................... 178 Contents ............................................................................................................................................... 178 API Version 2019-11-01 xii IAM Access Analyzer API Reference See Also ................................................................................................................................................ 179 EcrRepositoryConﬁguration ................................................................................................................... 180 Contents ............................................................................................................................................... 180 See Also ................................................................................................................................................ 180 EfsFileSystemConﬁguration ................................................................................................................... 181 Contents ............................................................................................................................................... 181 See Also ................................................................................................................................................ 181 ExternalAccessDetails .............................................................................................................................. 182 Contents ............................................................................................................................................... 182 See Also ................................................................................................................................................ 183 ExternalAccessFindingsStatistics ........................................................................................................... 184 Contents ............................................................................................................................................... 184 See Also ................................................................................................................................................ 185 Finding ........................................................................................................................................................ 186 Contents ............................................................................................................................................... 186 See Also ................................................................................................................................................ 189 FindingAggregationAccountDetails ...................................................................................................... 190 Contents ............................................................................................................................................... 190 See Also ................................................................................................................................................ 190 FindingDetails ........................................................................................................................................... 191 Contents ............................................................................................................................................... 191 See Also ................................................................................................................................................ 192 FindingSource ........................................................................................................................................... 193 Contents ............................................................................................................................................... 193 See Also ................................................................................................................................................ 193 FindingSourceDetail ................................................................................................................................. 194 Contents ............................................................................................................................................... 194 See Also ................................................................................................................................................ 194 FindingsStatistics ...................................................................................................................................... 195 Contents ............................................................................................................................................... 195 See Also ................................................................................................................................................ 195 FindingSummary ...................................................................................................................................... 196 Contents ............................................................................................................................................... 196 See Also ................................................................................................................................................ 199 FindingSummaryV2 ................................................................................................................................. 200 Contents ............................................................................................................................................... 200 API Version 2019-11-01 xiii IAM Access Analyzer API Reference See Also ................................................................................................................................................ 202 GeneratedPolicy ....................................................................................................................................... 203 Contents ............................................................................................................................................... 203 See Also ................................................................................................................................................ 203 GeneratedPolicyProperties ..................................................................................................................... 204 Contents ............................................................................................................................................... 204 See Also ................................................................................................................................................ 204 GeneratedPolicyResult ............................................................................................................................ 206 Contents ............................................................................................................................................... 206 See Also ................................................................................................................................................ 206 IamRoleConﬁguration ............................................................................................................................. 207 Contents ............................................................................................................................................... 207 See Also ................................................................................................................................................ 207 InlineArchiveRule ...................................................................................................................................... 208 Contents ............................................................................................................................................... 208 See Also ................................................................................................................................................ 208 InternetConﬁguration .............................................................................................................................. 209 Contents ............................................................................................................................................... 209 See Also ................................................................................................................................................ 209 JobDetails .................................................................................................................................................. 210 Contents ............................................................................................................................................... 210 See Also ................................................................................................................................................ 211 JobError ...................................................................................................................................................... 212 Contents ............................................................................................................................................... 212 See Also ................................................................................................................................................ 212 KmsGrantConﬁguration .......................................................................................................................... 213 Contents ............................................................................................................................................... 213 See Also ................................................................................................................................................ 214 KmsGrantConstraints ............................................................................................................................... 215 Contents ............................................................................................................................................... 215 See Also ................................................................................................................................................ 215 KmsKeyConﬁguration .............................................................................................................................. 216 Contents ............................................................................................................................................... 216 See Also ................................................................................................................................................ 216 Location ...................................................................................................................................................... 218 Contents ............................................................................................................................................... 218 API Version 2019-11-01 xiv IAM Access Analyzer API Reference See Also ................................................................................................................................................ 218 NetworkOriginConﬁguration ................................................................................................................. 219 Contents ............................................................................................................................................... 219 See Also ................................................................................................................................................ 219 PathElement .............................................................................................................................................. 221 Contents ............................................................................................................................................... 221 See Also ................................................................................................................................................ 222 PolicyGeneration ...................................................................................................................................... 223 Contents ............................................................................................................................................... 223 See Also ................................................................................................................................................ 224 PolicyGenerationDetails .......................................................................................................................... 225 Contents ............................................................................................................................................... 225 See Also ................................................................................................................................................ 225 Position ...................................................................................................................................................... 226 Contents ............................................................................................................................................... 226 See Also ................................................................................................................................................ 226 RdsDbClusterSnapshotAttributeValue ................................................................................................. 227 Contents ............................................................................................................................................... 227 See Also ................................................................................................................................................ 227 RdsDbClusterSnapshotConﬁguration ................................................................................................... 229 Contents ............................................................................................................................................... 229 See Also ................................................................................................................................................ 229 RdsDbSnapshotAttributeValue .............................................................................................................. 231 Contents ............................................................................................................................................... 231 See Also ................................................................................................................................................ 231 RdsDbSnapshotConﬁguration ............................................................................................................... 233 Contents ............................................................................................................................................... 233 See Also ................................................................................................................................................ 233 ReasonSummary ....................................................................................................................................... 235 Contents ............................................................................................................................................... 235 See Also ................................................................................................................................................ 235 RecommendationError ............................................................................................................................ 236 Contents ............................................................................................................................................... 236 See Also ................................................................................................................................................ 236 RecommendedStep .................................................................................................................................. 237 Contents ............................................................................................................................................... 237 API Version 2019-11-01 xv IAM Access Analyzer API Reference See Also ................................................................................................................................................ 237 ResourceTypeDetails ................................................................................................................................ 238 Contents ............................................................................................................................................... 238 See Also ................................................................................................................................................ 238 S3AccessPointConﬁguration .................................................................................................................. 239 Contents ............................................................................................................................................... 239 See Also ................................................................................................................................................ 240 S3BucketAclGrantConﬁguration ........................................................................................................... 241 Contents ............................................................................................................................................... 241 See Also ................................................................................................................................................ 241 S3BucketConﬁguration ........................................................................................................................... 242 Contents ............................................................................................................................................... 242 See Also ................................................................................................................................................ 243 S3ExpressDirectoryAccessPointConﬁguration .................................................................................... 244 Contents ............................................................................................................................................... 244 See Also ................................................................................................................................................ 244 S3ExpressDirectoryBucketConﬁguration ............................................................................................. 246 Contents ............................................................................................................................................... 246 See Also ................................................................................................................................................ 246 S3PublicAccessBlockConﬁguration ....................................................................................................... 248 Contents ............................................................................................................................................... 248 See Also ................................................................................................................................................ 248 SecretsManagerSecretConﬁguration .................................................................................................... 249 Contents ............................................................................................................................................... 249 See Also ................................................................................................................................................ 249 SnsTopicConﬁguration ............................................................................................................................ 251 Contents ............................................................................................................................................... 251 See Also ................................................................................................................................................ 251 SortCriteria ................................................................................................................................................ 252 Contents ............................................................................................................................................... 252 See Also ................................................................................................................................................ 252 Span ............................................................................................................................................................ 253 Contents ............................................................................................................................................... 253 See Also ................................................................................................................................................ 253 SqsQueueConﬁguration .......................................................................................................................... 254 Contents ............................................................................................................................................... 254 API Version 2019-11-01 xvi IAM Access Analyzer API Reference See Also ................................................................................................................................................ 254 StatusReason ............................................................................................................................................. 255 Contents ............................................................................................................................................... 255 See Also ................................................................................................................................................ 255 Substring .................................................................................................................................................... 256 Contents ............................................................................................................................................... 256 See Also ................................................................................................................................................ 256 Trail ............................................................................................................................................................. 257 Contents ............................................................................................................................................... 257 See Also ................................................................................................................................................ 257 TrailProperties ........................................................................................................................................... 259 Contents ............................................................................................................................................... 259 See Also ................................................................................................................................................ 259 UnusedAccessConﬁguration ................................................................................................................... 261 Contents ............................................................................................................................................... 261 See Also ................................................................................................................................................ 261 UnusedAccessFindingsStatistics ............................................................................................................ 262 Contents ............................................................................................................................................... 262 See Also ................................................................................................................................................ 263 UnusedAccessTypeStatistics ................................................................................................................... 264 Contents ............................................................................................................................................... 264 See Also ................................................................................................................................................ 264 UnusedAction ............................................................................................................................................ 265 Contents ............................................................................................................................................... 265 See Also ................................................................................................................................................ 265 UnusedIamRoleDetails ............................................................................................................................ 266 Contents ............................................................................................................................................... 266 See Also ................................................................................................................................................ 266 UnusedIamUserAccessKeyDetails .......................................................................................................... 267 Contents ............................................................................................................................................... 267 See Also ................................................................................................................................................ 267 UnusedIamUserPasswordDetails ........................................................................................................... 268 Contents ............................................................................................................................................... 268 See Also ................................................................................................................................................ 268 UnusedPermissionDetails ....................................................................................................................... 269 Contents ............................................................................................................................................... 269 API
access-analyzer-api-004	access-analyzer-api.pdf	4	Also ................................................................................................................................................ 256 Trail ............................................................................................................................................................. 257 Contents ............................................................................................................................................... 257 See Also ................................................................................................................................................ 257 TrailProperties ........................................................................................................................................... 259 Contents ............................................................................................................................................... 259 See Also ................................................................................................................................................ 259 UnusedAccessConﬁguration ................................................................................................................... 261 Contents ............................................................................................................................................... 261 See Also ................................................................................................................................................ 261 UnusedAccessFindingsStatistics ............................................................................................................ 262 Contents ............................................................................................................................................... 262 See Also ................................................................................................................................................ 263 UnusedAccessTypeStatistics ................................................................................................................... 264 Contents ............................................................................................................................................... 264 See Also ................................................................................................................................................ 264 UnusedAction ............................................................................................................................................ 265 Contents ............................................................................................................................................... 265 See Also ................................................................................................................................................ 265 UnusedIamRoleDetails ............................................................................................................................ 266 Contents ............................................................................................................................................... 266 See Also ................................................................................................................................................ 266 UnusedIamUserAccessKeyDetails .......................................................................................................... 267 Contents ............................................................................................................................................... 267 See Also ................................................................................................................................................ 267 UnusedIamUserPasswordDetails ........................................................................................................... 268 Contents ............................................................................................................................................... 268 See Also ................................................................................................................................................ 268 UnusedPermissionDetails ....................................................................................................................... 269 Contents ............................................................................................................................................... 269 API Version 2019-11-01 xvii IAM Access Analyzer API Reference See Also ................................................................................................................................................ 269 UnusedPermissionsRecommendedStep ............................................................................................... 270 Contents ............................................................................................................................................... 270 See Also ................................................................................................................................................ 271 ValidatePolicyFinding .............................................................................................................................. 272 Contents ............................................................................................................................................... 272 See Also ................................................................................................................................................ 273 ValidationExceptionField ........................................................................................................................ 274 Contents ............................................................................................................................................... 274 See Also ................................................................................................................................................ 274 VpcConﬁguration ..................................................................................................................................... 275 Contents ............................................................................................................................................... 275 See Also ................................................................................................................................................ 275 Common Parameters ................................................................................................................... 276 Common Errors ............................................................................................................................ 279 API Version 2019-11-01 xviii IAM Access Analyzer Welcome API Reference AWS Identity and Access Management Access Analyzer helps you to set, verify, and reﬁne your IAM policies by providing a suite of capabilities. Its features include ﬁndings for external and unused access, basic and custom policy checks for validating policies, and policy generation to generate ﬁne-grained policies. To start using IAM Access Analyzer to identify external or unused access, you ﬁrst need to create an analyzer. External access analyzers help identify potential risks of accessing resources by enabling you to identify any resource policies that grant access to an external principal. It does this by using logic- based reasoning to analyze resource-based policies in your AWS environment. An external principal can be another AWS account, a root user, an IAM user or role, a federated user, an AWS service, or an anonymous user. You can also use IAM Access Analyzer to preview public and cross-account access to your resources before deploying permissions changes. Unused access analyzers help identify potential identity access risks by enabling you to identify unused IAM roles, unused access keys, unused console passwords, and IAM principals with unused service and action-level permissions. Beyond ﬁndings, IAM Access Analyzer provides basic and custom policy checks to validate IAM policies before deploying permissions changes. You can use policy generation to reﬁne permissions by attaching a policy generated using access activity logged in CloudTrail logs. This guide describes the IAM Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see AWS Identity and Access Management Access Analyzer in the IAM User Guide. This document was last published on May 14, 2025. API Version 2019-11-01 1 IAM Access Analyzer Actions The following actions are supported: • ApplyArchiveRule • CancelPolicyGeneration • CheckAccessNotGranted • CheckNoNewAccess • CheckNoPublicAccess • CreateAccessPreview • CreateAnalyzer • CreateArchiveRule • DeleteAnalyzer • DeleteArchiveRule • GenerateFindingRecommendation • GetAccessPreview • GetAnalyzedResource • GetAnalyzer • GetArchiveRule • GetFinding • GetFindingRecommendation • GetFindingsStatistics • GetFindingV2 • GetGeneratedPolicy • ListAccessPreviewFindings • ListAccessPreviews • ListAnalyzedResources • ListAnalyzers • ListArchiveRules • ListFindings • ListFindingsV2 API Reference API Version 2019-11-01 2 IAM Access Analyzer • ListPolicyGenerations • ListTagsForResource • StartPolicyGeneration • StartResourceScan • TagResource • UntagResource • UpdateAnalyzer • UpdateArchiveRule • UpdateFindings • ValidatePolicy API Reference API Version 2019-11-01 3 IAM Access Analyzer ApplyArchiveRule API Reference Retroactively applies the archive rule to existing ﬁndings that meet the archive rule criteria. Request Syntax PUT /archive-rule HTTP/1.1 Content-type: application/json { "analyzerArn": "string", "clientToken": "string", "ruleName": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. analyzerArn The Amazon resource name (ARN) of the analyzer. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes clientToken A client token. Type: String Required: No ruleName The name of the rule to apply. ApplyArchiveRule API Version 2019-11-01 4 IAM Access Analyzer Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-] Required: Yes 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 You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 Response Syntax API Version 2019-11-01 5 IAM Access Analyzer ValidationException Validation exception error. HTTP Status Code: 400 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
access-analyzer-api-005	access-analyzer-api.pdf	5	this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 Response Syntax API Version 2019-11-01 5 IAM Access Analyzer ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 6 IAM Access Analyzer API Reference CancelPolicyGeneration Cancels the requested policy generation. Request Syntax PUT /policy/generation/jobId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. jobId The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request. Required: Yes Request Body The request does not have a request body. 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 You do not have suﬃcient access to perform this action. CancelPolicyGeneration API Version 2019-11-01 7 API Reference IAM Access Analyzer HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 8 IAM Access Analyzer API Reference CheckAccessNotGranted Checks whether the speciﬁed access isn't allowed by a policy. Request Syntax POST /policy/check-access-not-granted HTTP/1.1 Content-type: application/json { "access": [ { "actions": [ "string" ], "resources": [ "string" ] } ], "policyDocument": "string", "policyType": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. access An access object containing the permissions that shouldn't be granted by the speciﬁed policy. If only actions are speciﬁed, IAM Access Analyzer checks for access to peform at least one of the actions on any resource in the policy. If only resources are speciﬁed, then IAM Access Analyzer checks for access to perform any action on at least one of the resources. If both actions and resources are speciﬁed, IAM Access Analyzer checks for access to perform at least one of the speciﬁed actions on at least one of the speciﬁed resources. Type: Array of Access objects Array Members: Minimum number of 0 items. Maximum number of 1 item. Required: Yes CheckAccessNotGranted API Version 2019-11-01 9 IAM Access Analyzer policyDocument API Reference The JSON policy document to use as the content for the policy. Type: String Required: Yes policyType The type of policy. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups. Resource policies grant permissions on AWS resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. Type: String Valid Values: IDENTITY_POLICY \| RESOURCE_POLICY Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "message": "string", "reasons": [ { "description": "string", "statementId": "string", "statementIndex": number } ], "result": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2019-11-01 10 IAM Access Analyzer API Reference The following data is returned in JSON format by the service. message The message indicating whether the speciﬁed access is allowed. Type: String reasons A description of the reasoning of the result. Type: Array of ReasonSummary objects result The result of the check for whether the access is allowed. If the result is PASS, the speciﬁed policy doesn't allow any of the speciﬁed permissions in the access object. If the result is FAIL, the speciﬁed policy might allow some or all of the permissions in the access object. Type: String Valid Values: PASS \| FAIL Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform
access-analyzer-api-006	access-analyzer-api.pdf	6	is allowed. Type: String reasons A description of the reasoning of the result. Type: Array of ReasonSummary objects result The result of the check for whether the access is allowed. If the result is PASS, the speciﬁed policy doesn't allow any of the speciﬁed permissions in the access object. If the result is FAIL, the speciﬁed policy might allow some or all of the permissions in the access object. Type: String Valid Values: PASS \| FAIL Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 InvalidParameterException The speciﬁed parameter is invalid. HTTP Status Code: 400 Errors API Version 2019-11-01 11 API Reference IAM Access Analyzer ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 UnprocessableEntityException The speciﬁed entity could not be processed. HTTP Status Code: 422 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 12 IAM Access Analyzer CheckNoNewAccess API Reference Checks whether new access is allowed for an updated policy when compared to the existing policy. You can ﬁnd examples for reference policies and learn how to set up and run a custom policy check for new access in the IAM Access Analyzer custom policy checks samples repository on GitHub. The reference policies in this repository are meant to be passed to the existingPolicyDocument request parameter. Request Syntax POST /policy/check-no-new-access HTTP/1.1 Content-type: application/json { "existingPolicyDocument": "string", "newPolicyDocument": "string", "policyType": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. existingPolicyDocument The JSON policy document to use as the content for the existing policy. Type: String Required: Yes newPolicyDocument The JSON policy document to use as the content for the updated policy. Type: String Required: Yes CheckNoNewAccess API Version 2019-11-01 13 IAM Access Analyzer policyType API Reference The type of policy to compare. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups. Resource policies grant permissions on AWS resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a speciﬁc input such as managed policy or Amazon S3 bucket policy. Type: String Valid Values: IDENTITY_POLICY \| RESOURCE_POLICY Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "message": "string", "reasons": [ { "description": "string", "statementId": "string", "statementIndex": number } ], "result": "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. message The message indicating whether the updated policy allows new access. Response Syntax API Version 2019-11-01 14 IAM Access Analyzer Type: String reasons A description of the reasoning of the result. Type: Array of ReasonSummary objects result API Reference The result of the check for new access. If the result is PASS, no new access is allowed by the updated policy. If the result is FAIL, the updated policy might allow new access. Type: String Valid Values: PASS \| FAIL Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 InvalidParameterException The speciﬁed parameter is invalid. HTTP Status Code: 400 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 Errors API Version 2019-11-01 15 IAM Access Analyzer UnprocessableEntityException The speciﬁed entity could not be processed. API Reference HTTP Status Code: 422 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 16 IAM Access Analyzer API Reference CheckNoPublicAccess Checks whether a resource policy can grant public access to the speciﬁed resource type. Request Syntax
access-analyzer-api-007	access-analyzer-api.pdf	7	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 2019-11-01 16 IAM Access Analyzer API Reference CheckNoPublicAccess Checks whether a resource policy can grant public access to the speciﬁed resource type. Request Syntax POST /policy/check-no-public-access HTTP/1.1 Content-type: application/json { "policyDocument": "string", "resourceType": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. policyDocument The JSON policy document to evaluate for public access. Type: String Required: Yes resourceType The type of resource to evaluate for public access. For example, to check for public access to Amazon S3 buckets, you can choose AWS::S3::Bucket for the resource type. For resource types not supported as valid values, IAM Access Analyzer will return an error. Type: String Valid Values: AWS::DynamoDB::Table \| AWS::DynamoDB::Stream \| AWS::EFS::FileSystem \| AWS::OpenSearchService::Domain \| AWS::Kinesis::Stream \| AWS::Kinesis::StreamConsumer \| AWS::KMS::Key CheckNoPublicAccess API Version 2019-11-01 17 IAM Access Analyzer API Reference \| AWS::Lambda::Function \| AWS::S3::Bucket \| AWS::S3::AccessPoint \| AWS::S3Express::DirectoryBucket \| AWS::S3::Glacier \| AWS::S3Outposts::Bucket \| AWS::S3Outposts::AccessPoint \| AWS::SecretsManager::Secret \| AWS::SNS::Topic \| AWS::SQS::Queue \| AWS::IAM::AssumeRolePolicyDocument \| AWS::S3Tables::TableBucket \| AWS::ApiGateway::RestApi \| AWS::CodeArtifact::Domain \| AWS::Backup::BackupVault \| AWS::CloudTrail::Dashboard \| AWS::CloudTrail::EventDataStore \| AWS::S3Tables::Table \| AWS::S3Express::AccessPoint Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "message": "string", "reasons": [ { "description": "string", "statementId": "string", "statementIndex": number } ], "result": "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. message The message indicating whether the speciﬁed policy allows public access to resources. Type: String Response Syntax API Version 2019-11-01 18 IAM Access Analyzer reasons API Reference A list of reasons why the speciﬁed resource policy grants public access for the resource type. Type: Array of ReasonSummary objects result The result of the check for public access to the speciﬁed resource type. If the result is PASS, the policy doesn't allow public access to the speciﬁed resource type. If the result is FAIL, the policy might allow public access to the speciﬁed resource type. Type: String Valid Values: PASS \| FAIL Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 InvalidParameterException The speciﬁed parameter is invalid. HTTP Status Code: 400 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 Errors API Version 2019-11-01 19 IAM Access Analyzer UnprocessableEntityException The speciﬁed entity could not be processed. API Reference HTTP Status Code: 422 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 20 IAM Access Analyzer API Reference CreateAccessPreview Creates an access preview that allows you to preview IAM Access Analyzer ﬁndings for your resource before deploying resource permissions. Request Syntax PUT /access-preview HTTP/1.1 Content-type: application/json { "analyzerArn": "string", "clientToken": "string", "configurations": { "string" : { ... } } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. analyzerArn The ARN of the account analyzer used to generate the access preview. You can only create an access preview for analyzers with an Account type and Active status. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]*:analyzer/.{1,255} Required: Yes clientToken A client token. Type: String CreateAccessPreview API Version 2019-11-01 21 IAM Access Analyzer Required: No conﬁgurations API Reference Access control conﬁguration for your resource that is used to generate the access preview. The access preview includes ﬁndings for external access allowed to the resource with the proposed access control conﬁguration. The conﬁguration must contain exactly one element. Type: String to Conﬁguration object map Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "id": "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. id The unique ID for the access preview. Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Errors For information about the errors that
access-analyzer-api-008	access-analyzer-api.pdf	8	conﬁguration for your resource that is used to generate the access preview. The access preview includes ﬁndings for external access allowed to the resource with the proposed access control conﬁguration. The conﬁguration must contain exactly one element. Type: String to Conﬁguration object map Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "id": "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. id The unique ID for the access preview. Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. Response Syntax API Version 2019-11-01 22 API Reference IAM Access Analyzer HTTP Status Code: 403 ConﬂictException A conﬂict exception error. HTTP Status Code: 409 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ServiceQuotaExceededException Service quote met error. HTTP Status Code: 402 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 23 API Reference IAM Access Analyzer • 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 2019-11-01 24 API Reference IAM Access Analyzer CreateAnalyzer Creates an analyzer for your account. Request Syntax PUT /analyzer HTTP/1.1 Content-type: application/json { "analyzerName": "string", "archiveRules": [ { "filter": { "string" : { "contains": [ "string" ], "eq": [ "string" ], "exists": boolean, "neq": [ "string" ] } }, "ruleName": "string" } ], "clientToken": "string", "configuration": { ... }, "tags": { "string" : "string" }, "type": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. CreateAnalyzer API Version 2019-11-01 25 API Reference IAM Access Analyzer analyzerName The name of the analyzer to create. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes archiveRules Speciﬁes the archive rules to add for the analyzer. Archive rules automatically archive ﬁndings that meet the criteria you deﬁne for the rule. Type: Array of InlineArchiveRule objects Required: No clientToken A client token. Type: String Required: No conﬁguration Speciﬁes the conﬁguration of the analyzer. If the analyzer is an unused access analyzer, the speciﬁed scope of unused access is used for the conﬁguration. Type: AnalyzerConﬁguration object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No tags An array of key-value pairs to apply to the analyzer. You can use the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be preﬁxed with aws:. Request Body API Version 2019-11-01 26 IAM Access Analyzer API Reference For the tag value, you can specify a value that is 0 to 256 characters in length. Type: String to string map Required: No type The type of analyzer to create. Only ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS, and ORGANIZATION_UNUSED_ACCESS analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region. Type: String Valid Values: ACCOUNT \| ORGANIZATION \| ACCOUNT_UNUSED_ACCESS \| ORGANIZATION_UNUSED_ACCESS Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "arn": "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. arn The ARN of the analyzer that was created by the request. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]*:analyzer/.{1,255} Response Syntax API Version 2019-11-01 27 IAM Access Analyzer Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ConﬂictException A conﬂict exception error. HTTP Status Code: 409 InternalServerException Internal server error. HTTP Status Code: 500 ServiceQuotaExceededException Service quote met error. HTTP Status Code: 402 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 Errors API Version 2019-11-01 28 API Reference IAM Access Analyzer • AWS SDK for .NET •
access-analyzer-api-009	access-analyzer-api.pdf	9	Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ConﬂictException A conﬂict exception error. HTTP Status Code: 409 InternalServerException Internal server error. HTTP Status Code: 500 ServiceQuotaExceededException Service quote met error. HTTP Status Code: 402 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 Errors API Version 2019-11-01 28 API Reference IAM Access Analyzer • 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 2019-11-01 29 IAM Access Analyzer CreateArchiveRule API Reference Creates an archive rule for the speciﬁed analyzer. Archive rules automatically archive new ﬁndings that meet the criteria you deﬁne when you create the rule. To learn about ﬁlter keys that you can use to create an archive rule, see IAM Access Analyzer ﬁlter keys in the IAM User Guide. Request Syntax PUT /analyzer/analyzerName/archive-rule HTTP/1.1 Content-type: application/json { "clientToken": "string", "filter": { "string" : { "contains": [ "string" ], "eq": [ "string" ], "exists": boolean, "neq": [ "string" ] } }, "ruleName": "string" } URI Request Parameters The request uses the following URI parameters. analyzerName The name of the created analyzer. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes CreateArchiveRule API Version 2019-11-01 30 IAM Access Analyzer Request Body The request accepts the following data in JSON format. API Reference clientToken A client token. Type: String Required: No ﬁlter The criteria for the rule. Type: String to Criterion object map Required: Yes ruleName The name of the rule to create. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes 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. Request Body API Version 2019-11-01 31 IAM Access Analyzer AccessDeniedException You do not have suﬃcient access to perform this action. API Reference HTTP Status Code: 403 ConﬂictException A conﬂict exception error. HTTP Status Code: 409 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ServiceQuotaExceededException Service quote met error. HTTP Status Code: 402 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2019-11-01 32 API Reference IAM Access Analyzer • 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 2019-11-01 33 IAM Access Analyzer DeleteAnalyzer API Reference Deletes the speciﬁed analyzer. When you delete an analyzer, IAM Access Analyzer is disabled for the account or organization in the current or speciﬁc Region. All ﬁndings that were generated by the analyzer are deleted. You cannot undo this action. Request Syntax DELETE /analyzer/analyzerName?clientToken=clientToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. analyzerName The name of the analyzer to delete. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes clientToken A client token. Request Body The request does not have a request body. 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. DeleteAnalyzer API Version 2019-11-01 34 IAM Access Analyzer Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 Errors API Version 2019-11-01 35 IAM Access Analyzer • AWS SDK for Java
access-analyzer-api-010	access-analyzer-api.pdf	10	suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 Errors API Version 2019-11-01 35 IAM Access Analyzer • 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 API Reference See Also API Version 2019-11-01 36 IAM Access Analyzer DeleteArchiveRule Deletes the speciﬁed archive rule. Request Syntax API Reference DELETE /analyzer/analyzerName/archive-rule/ruleName?clientToken=clientToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. analyzerName The name of the analyzer that associated with the archive rule to delete. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes clientToken A client token. ruleName The name of the rule to delete. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 DeleteArchiveRule API Version 2019-11-01 37 IAM Access Analyzer Response Elements API Reference 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 You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 Response Elements API Version 2019-11-01 38 API Reference IAM Access Analyzer • 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 2019-11-01 39 IAM Access Analyzer API Reference GenerateFindingRecommendation Creates a recommendation for an unused permissions ﬁnding. Request Syntax POST /recommendation/id?analyzerArn=analyzerArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. analyzerArn The ARN of the analyzer used to generate the ﬁnding recommendation. Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes id The unique ID for the ﬁnding recommendation. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes Request Body The request does not have a request body. 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. GenerateFindingRecommendation API Version 2019-11-01 40 IAM Access Analyzer Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 Errors API Version 2019-11-01 41 IAM Access Analyzer • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2019-11-01 42 IAM Access Analyzer GetAccessPreview API Reference Retrieves information about an access preview for the speciﬁed analyzer. Request Syntax GET /access-preview/accessPreviewId?analyzerArn=analyzerArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. accessPreviewId The unique ID for the access preview. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes analyzerArn The ARN of the analyzer used to generate the access preview. Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "accessPreview": { "analyzerArn": "string", GetAccessPreview API Version 2019-11-01 43 IAM Access Analyzer API Reference "configurations": { "string" : { ... } }, "createdAt": "string", "id": "string", "status": "string", "statusReason": { "code": "string" } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The
access-analyzer-api-011	access-analyzer-api.pdf	11	the following URI parameters. accessPreviewId The unique ID for the access preview. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes analyzerArn The ARN of the analyzer used to generate the access preview. Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "accessPreview": { "analyzerArn": "string", GetAccessPreview API Version 2019-11-01 43 IAM Access Analyzer API Reference "configurations": { "string" : { ... } }, "createdAt": "string", "id": "string", "status": "string", "statusReason": { "code": "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. accessPreview An object that contains information about the access preview. Type: AccessPreview object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. Response Elements API Version 2019-11-01 44 API Reference IAM Access Analyzer HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 45 IAM Access Analyzer API Reference GetAnalyzedResource Retrieves information about a resource that was analyzed. Request Syntax GET /analyzed-resource?analyzerArn=analyzerArn&resourceArn=resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. analyzerArn The ARN of the analyzer to retrieve information from. Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes resourceArn The ARN of the resource to retrieve information about. Pattern: arn:[^:]:[^:]:[^:]:[^:]:.* Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "resource": { "actions": [ "string" ], "analyzedAt": "string", GetAnalyzedResource API Version 2019-11-01 46 IAM Access Analyzer API Reference "createdAt": "string", "error": "string", "isPublic": boolean, "resourceArn": "string", "resourceOwnerAccount": "string", "resourceType": "string", "sharedVia": [ "string" ], "status": "string", "updatedAt": "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. resource An AnalyzedResource object that contains information that IAM Access Analyzer found when it analyzed the resource. Type: AnalyzedResource object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. Response Elements API Version 2019-11-01 47 API Reference IAM Access Analyzer HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 48 API Reference IAM Access Analyzer GetAnalyzer Retrieves information about the speciﬁed analyzer. Request Syntax GET /analyzer/analyzerName HTTP/1.1 URI Request Parameters The request uses the following URI parameters. analyzerName The name of the analyzer retrieved. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "analyzer": { "arn": "string", "configuration": { ... }, "createdAt": "string", "lastResourceAnalyzed": "string", "lastResourceAnalyzedAt": "string", "name": "string", "status": "string", GetAnalyzer API Version 2019-11-01 49 IAM Access Analyzer API Reference "statusReason": { "code": "string" }, "tags": { "string" : "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. analyzer An AnalyzerSummary object that contains information about the analyzer. Type: AnalyzerSummary object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 Response Elements API Version
access-analyzer-api-012	access-analyzer-api.pdf	12	: "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. analyzer An AnalyzerSummary object that contains information about the analyzer. Type: AnalyzerSummary object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 Response Elements API Version 2019-11-01 50 API Reference IAM Access Analyzer ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 51 IAM Access Analyzer GetArchiveRule Retrieves information about an archive rule. API Reference To learn about ﬁlter keys that you can use to create an archive rule, see IAM Access Analyzer ﬁlter keys in the IAM User Guide. Request Syntax GET /analyzer/analyzerName/archive-rule/ruleName HTTP/1.1 URI Request Parameters The request uses the following URI parameters. analyzerName The name of the analyzer to retrieve rules from. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes ruleName The name of the rule to retrieve. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json GetArchiveRule API Version 2019-11-01 52 IAM Access Analyzer API Reference { "archiveRule": { "createdAt": "string", "filter": { "string" : { "contains": [ "string" ], "eq": [ "string" ], "exists": boolean, "neq": [ "string" ] } }, "ruleName": "string", "updatedAt": "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. archiveRule Contains information about an archive rule. Archive rules automatically archive new ﬁndings that meet the criteria you deﬁne when you create the rule. Type: ArchiveRuleSummary object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. Response Elements API Version 2019-11-01 53 API Reference IAM Access Analyzer HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 54 IAM Access Analyzer GetFinding API Reference Retrieves information about the speciﬁed ﬁnding. GetFinding and GetFindingV2 both use access- analyzer:GetFinding in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:GetFinding action. Request Syntax GET /finding/id?analyzerArn=analyzerArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. analyzerArn The ARN of the analyzer that generated the ﬁnding. Pattern: [^:]:[^:]:[^:]:[^:]:[^:]*:analyzer/.{1,255} Required: Yes id The ID of the ﬁnding to retrieve. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "finding": { "action": [ "string" ], "analyzedAt": "string", GetFinding API Version 2019-11-01 55 IAM Access Analyzer API Reference "condition": { "string" : "string" }, "createdAt": "string", "error": "string", "id": "string", "isPublic": boolean, "principal": { "string" : "string" }, "resource": "string", "resourceControlPolicyRestriction": "string", "resourceOwnerAccount": "string", "resourceType": "string", "sources": [ { "detail": { "accessPointAccount": "string", "accessPointArn": "string" }, "type": "string" } ], "status": "string", "updatedAt": "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. ﬁnding A finding object that contains ﬁnding details. Type: Finding object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2019-11-01 56 IAM Access Analyzer AccessDeniedException You do not have suﬃcient access to perform
access-analyzer-api-013	access-analyzer-api.pdf	13	"string" }, "resource": "string", "resourceControlPolicyRestriction": "string", "resourceOwnerAccount": "string", "resourceType": "string", "sources": [ { "detail": { "accessPointAccount": "string", "accessPointArn": "string" }, "type": "string" } ], "status": "string", "updatedAt": "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. ﬁnding A finding object that contains ﬁnding details. Type: Finding object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2019-11-01 56 IAM Access Analyzer AccessDeniedException You do not have suﬃcient access to perform this action. API Reference HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 See Also API Version 2019-11-01 57 IAM Access Analyzer • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2019-11-01 58 IAM Access Analyzer API Reference GetFindingRecommendation Retrieves information about a ﬁnding recommendation for the speciﬁed analyzer. Request Syntax GET /recommendation/id? analyzerArn=analyzerArn&maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. analyzerArn The ARN of the analyzer used to generate the ﬁnding recommendation. Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes id The unique ID for the ﬁnding recommendation. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes maxResults The maximum number of results to return in the response. Valid Range: Minimum value of 1. Maximum value of 1000. nextToken A token used for pagination of results returned. Request Body The request does not have a request body. GetFindingRecommendation API Version 2019-11-01 59 API Reference IAM Access Analyzer Response Syntax HTTP/1.1 200 Content-type: application/json { "completedAt": "string", "error": { "code": "string", "message": "string" }, "nextToken": "string", "recommendationType": "string", "recommendedSteps": [ { ... } ], "resourceArn": "string", "startedAt": "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. completedAt The time at which the retrieval of the ﬁnding recommendation was completed. Type: Timestamp error Detailed information about the reason that the retrieval of a recommendation for the ﬁnding failed. Type: RecommendationError object nextToken A token used for pagination of results returned. Response Syntax API Version 2019-11-01 60 API Reference IAM Access Analyzer Type: String recommendationType The type of recommendation for the ﬁnding. Type: String Valid Values: UnusedPermissionRecommendation recommendedSteps A group of recommended steps for the ﬁnding. Type: Array of RecommendedStep objects resourceArn The ARN of the resource of the ﬁnding. Type: String Pattern: arn:[^:]:[^:]:[^:]:[^:]:. startedAt The time at which the retrieval of the ﬁnding recommendation was started. Type: Timestamp status The status of the retrieval of the ﬁnding recommendation. Type: String Valid Values: SUCCEEDED \| FAILED \| IN_PROGRESS Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. Errors API Version 2019-11-01 61 API Reference IAM Access Analyzer HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 62 IAM Access Analyzer API Reference See Also API Version 2019-11-01 63 IAM Access Analyzer API Reference GetFindingsStatistics Retrieves a list of aggregated ﬁnding statistics for an external access or unused access analyzer. Request Syntax POST /analyzer/findings/statistics HTTP/1.1 Content-type: application/json { "analyzerArn": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. analyzerArn The ARN of the analyzer used to generate the statistics. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]*:analyzer/.{1,255} Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "findingsStatistics": [ { ... } ], GetFindingsStatistics API Version 2019-11-01 64
access-analyzer-api-014	access-analyzer-api.pdf	14	IAM Access Analyzer API Reference See Also API Version 2019-11-01 63 IAM Access Analyzer API Reference GetFindingsStatistics Retrieves a list of aggregated ﬁnding statistics for an external access or unused access analyzer. Request Syntax POST /analyzer/findings/statistics HTTP/1.1 Content-type: application/json { "analyzerArn": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. analyzerArn The ARN of the analyzer used to generate the statistics. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "findingsStatistics": [ { ... } ], GetFindingsStatistics API Version 2019-11-01 64 API Reference IAM Access Analyzer "lastUpdatedAt": "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. ﬁndingsStatistics A group of external access or unused access ﬁndings statistics. Type: Array of FindingsStatistics objects lastUpdatedAt The time at which the retrieval of the ﬁndings statistics was last updated. If the ﬁndings statistics have not been previously retrieved for the speciﬁed analyzer, this ﬁeld will not be populated. Type: Timestamp Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 Response Elements API Version 2019-11-01 65 API Reference IAM Access Analyzer ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 66 IAM Access Analyzer GetFindingV2 API Reference Retrieves information about the speciﬁed ﬁnding. GetFinding and GetFindingV2 both use access- analyzer:GetFinding in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:GetFinding action. Request Syntax GET /findingv2/id?analyzerArn=analyzerArn&maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. analyzerArn The ARN of the analyzer that generated the ﬁnding. Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes id The ID of the ﬁnding to retrieve. Required: Yes maxResults The maximum number of results to return in the response. nextToken A token used for pagination of results returned. Request Body The request does not have a request body. GetFindingV2 API Version 2019-11-01 67 API Reference IAM Access Analyzer Response Syntax HTTP/1.1 200 Content-type: application/json { "analyzedAt": "string", "createdAt": "string", "error": "string", "findingDetails": [ { ... } ], "findingType": "string", "id": "string", "nextToken": "string", "resource": "string", "resourceOwnerAccount": "string", "resourceType": "string", "status": "string", "updatedAt": "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. analyzedAt The time at which the resource-based policy or IAM entity that generated the ﬁnding was analyzed. Type: Timestamp createdAt The time at which the ﬁnding was created. Type: Timestamp error An error. Response Syntax API Version 2019-11-01 68 IAM Access Analyzer Type: String ﬁndingDetails API Reference A localized message that explains the ﬁnding and provides guidance on how to address it. Type: Array of FindingDetails objects ﬁndingType The type of the ﬁnding. For external access analyzers, the type is ExternalAccess. For unused access analyzers, the type can be UnusedIAMRole, UnusedIAMUserAccessKey, UnusedIAMUserPassword, or UnusedPermission. Type: String Valid Values: ExternalAccess \| UnusedIAMRole \| UnusedIAMUserAccessKey \| UnusedIAMUserPassword \| UnusedPermission id The ID of the ﬁnding to retrieve. Type: String nextToken A token used for pagination of results returned. Type: String resource The resource that generated the ﬁnding. Type: String resourceOwnerAccount Tye AWS account ID that owns the resource. Type: String resourceType The type of the resource identiﬁed in the ﬁnding. Type: String Response Elements API Version 2019-11-01 69 IAM Access Analyzer API Reference Valid Values: AWS::S3::Bucket \| AWS::IAM::Role \| AWS::SQS::Queue \| AWS::Lambda::Function \| AWS::Lambda::LayerVersion \| AWS::KMS::Key \| AWS::SecretsManager::Secret \| AWS::EFS::FileSystem \| AWS::EC2::Snapshot \| AWS::ECR::Repository \| AWS::RDS::DBSnapshot \| AWS::RDS::DBClusterSnapshot \| AWS::SNS::Topic \| AWS::S3Express::DirectoryBucket \| AWS::DynamoDB::Table \| AWS::DynamoDB::Stream \| AWS::IAM::User status The status of the ﬁnding. Type: String Valid Values: ACTIVE \| ARCHIVED \| RESOLVED updatedAt The time at which the ﬁnding was updated. Type: Timestamp Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP
access-analyzer-api-015	access-analyzer-api.pdf	15	AWS::Lambda::Function \| AWS::Lambda::LayerVersion \| AWS::KMS::Key \| AWS::SecretsManager::Secret \| AWS::EFS::FileSystem \| AWS::EC2::Snapshot \| AWS::ECR::Repository \| AWS::RDS::DBSnapshot \| AWS::RDS::DBClusterSnapshot \| AWS::SNS::Topic \| AWS::S3Express::DirectoryBucket \| AWS::DynamoDB::Table \| AWS::DynamoDB::Stream \| AWS::IAM::User status The status of the ﬁnding. Type: String Valid Values: ACTIVE \| ARCHIVED \| RESOLVED updatedAt The time at which the ﬁnding was updated. Type: Timestamp Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 Errors API Version 2019-11-01 70 API Reference IAM Access Analyzer ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 71 IAM Access Analyzer API Reference GetGeneratedPolicy Retrieves the policy that was generated using StartPolicyGeneration. Request Syntax GET /policy/generation/jobId? includeResourcePlaceholders=includeResourcePlaceholders&includeServiceLevelTemplate=includeServiceLevelTemplate HTTP/1.1 URI Request Parameters The request uses the following URI parameters. includeResourcePlaceholders The level of detail that you want to generate. You can specify whether to generate policies with placeholders for resource ARNs for actions that support resource level granularity in policies. For example, in the resource section of a policy, you can receive a placeholder such as "Resource":"arn:aws:s3:::${BucketName}" instead of "". includeServiceLevelTemplate The level of detail that you want to generate. You can specify whether to generate service-level policies. IAM Access Analyzer uses iam:servicelastaccessed to identify services that have been used recently to create this service-level template. jobId The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request. Required: Yes Request Body The request does not have a request body. GetGeneratedPolicy API Version 2019-11-01 72 API Reference IAM Access Analyzer Response Syntax HTTP/1.1 200 Content-type: application/json { "generatedPolicyResult": { "generatedPolicies": [ { "policy": "string" } ], "properties": { "cloudTrailProperties": { "endTime": "string", "startTime": "string", "trailProperties": [ { "allRegions": boolean, "cloudTrailArn": "string", "regions": [ "string" ] } ] }, "isComplete": boolean, "principalArn": "string" } }, "jobDetails": { "completedOn": "string", "jobError": { "code": "string", "message": "string" }, "jobId": "string", "startedOn": "string", "status": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2019-11-01 73 IAM Access Analyzer API Reference The following data is returned in JSON format by the service. generatedPolicyResult A GeneratedPolicyResult object that contains the generated policies and associated details. Type: GeneratedPolicyResult object jobDetails A GeneratedPolicyDetails object that contains details about the generated policy. Type: JobDetails object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 Errors API Version 2019-11-01 74 IAM Access Analyzer 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 2019-11-01 75 IAM Access Analyzer API Reference ListAccessPreviewFindings Retrieves a list of access preview ﬁndings generated by the speciﬁed access preview. Request Syntax POST /access-preview/accessPreviewId HTTP/1.1 Content-type: application/json { "analyzerArn": "string", "filter": { "string" : { "contains": [ "string" ], "eq": [ "string" ], "exists": boolean, "neq": [ "string" ] } }, "maxResults": number, "nextToken": "string" } URI Request Parameters The request uses the following URI parameters. accessPreviewId The unique ID for the access preview. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes Request Body The request accepts the following data in JSON format. analyzerArn The ARN of the analyzer used to generate the access. ListAccessPreviewFindings API Version 2019-11-01 76 IAM Access Analyzer Type: String API Reference Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes ﬁlter Criteria to ﬁlter the returned ﬁndings. Type: String to Criterion object map Required: No maxResults The maximum number of results to return in the response. Type: Integer Required: No
access-analyzer-api-016	access-analyzer-api.pdf	16	[ "string" ] } }, "maxResults": number, "nextToken": "string" } URI Request Parameters The request uses the following URI parameters. accessPreviewId The unique ID for the access preview. Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes Request Body The request accepts the following data in JSON format. analyzerArn The ARN of the analyzer used to generate the access. ListAccessPreviewFindings API Version 2019-11-01 76 IAM Access Analyzer Type: String API Reference Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes ﬁlter Criteria to ﬁlter the returned ﬁndings. Type: String to Criterion object map Required: No maxResults The maximum number of results to return in the response. Type: Integer Required: No nextToken A token used for pagination of results returned. Type: String Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "findings": [ { "action": [ "string" ], "changeType": "string", "condition": { "string" : "string" }, "createdAt": "string", Response Syntax API Version 2019-11-01 77 IAM Access Analyzer API Reference "error": "string", "existingFindingId": "string", "existingFindingStatus": "string", "id": "string", "isPublic": boolean, "principal": { "string" : "string" }, "resource": "string", "resourceControlPolicyRestriction": "string", "resourceOwnerAccount": "string", "resourceType": "string", "sources": [ { "detail": { "accessPointAccount": "string", "accessPointArn": "string" }, "type": "string" } ], "status": "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. ﬁndings A list of access preview ﬁndings that match the speciﬁed ﬁlter criteria. Type: Array of AccessPreviewFinding objects nextToken A token used for pagination of results returned. Type: String Response Elements API Version 2019-11-01 78 IAM Access Analyzer Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ConﬂictException A conﬂict exception error. HTTP Status Code: 409 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 Errors API Version 2019-11-01 79 API Reference IAM Access Analyzer • 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 2019-11-01 80 IAM Access Analyzer ListAccessPreviews Retrieves a list of access previews for the speciﬁed analyzer. Request Syntax API Reference GET /access-preview?analyzerArn=analyzerArn&maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. analyzerArn The ARN of the analyzer used to generate the access preview. Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes maxResults The maximum number of results to return in the response. nextToken A token used for pagination of results returned. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "accessPreviews": [ { ListAccessPreviews API Version 2019-11-01 81 IAM Access Analyzer API Reference "analyzerArn": "string", "createdAt": "string", "id": "string", "status": "string", "statusReason": { "code": "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. accessPreviews A list of access previews retrieved for the analyzer. Type: Array of AccessPreviewSummary objects nextToken A token used for pagination of results returned. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. Response Elements API Version 2019-11-01 82 API Reference IAM Access Analyzer HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 83 IAM Access Analyzer API Reference ListAnalyzedResources Retrieves a list of resources of the speciﬁed type that have been analyzed by the speciﬁed analyzer. Request Syntax POST /analyzed-resource HTTP/1.1 Content-type: application/json { "analyzerArn": "string", "maxResults": number, "nextToken": "string", "resourceType": "string" } URI Request Parameters The request does not use any URI
access-analyzer-api-017	access-analyzer-api.pdf	17	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 2019-11-01 83 IAM Access Analyzer API Reference ListAnalyzedResources Retrieves a list of resources of the speciﬁed type that have been analyzed by the speciﬁed analyzer. Request Syntax POST /analyzed-resource HTTP/1.1 Content-type: application/json { "analyzerArn": "string", "maxResults": number, "nextToken": "string", "resourceType": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. analyzerArn The ARN of the analyzer to retrieve a list of analyzed resources from. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]*:analyzer/.{1,255} Required: Yes maxResults The maximum number of results to return in the response. Type: Integer Required: No nextToken A token used for pagination of results returned. ListAnalyzedResources API Version 2019-11-01 84 IAM Access Analyzer Type: String Required: No resourceType The type of resource. Type: String API Reference Valid Values: AWS::S3::Bucket \| AWS::IAM::Role \| AWS::SQS::Queue \| AWS::Lambda::Function \| AWS::Lambda::LayerVersion \| AWS::KMS::Key \| AWS::SecretsManager::Secret \| AWS::EFS::FileSystem \| AWS::EC2::Snapshot \| AWS::ECR::Repository \| AWS::RDS::DBSnapshot \| AWS::RDS::DBClusterSnapshot \| AWS::SNS::Topic \| AWS::S3Express::DirectoryBucket \| AWS::DynamoDB::Table \| AWS::DynamoDB::Stream \| AWS::IAM::User Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "analyzedResources": [ { "resourceArn": "string", "resourceOwnerAccount": "string", "resourceType": "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. Response Syntax API Version 2019-11-01 85 API Reference IAM Access Analyzer analyzedResources A list of resources that were analyzed. Type: Array of AnalyzedResourceSummary objects nextToken A token used for pagination of results returned. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 Errors API Version 2019-11-01 86 IAM Access Analyzer 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 2019-11-01 87 IAM Access Analyzer ListAnalyzers Retrieves a list of analyzers. Request Syntax API Reference GET /analyzer?maxResults=maxResults&nextToken=nextToken&type=type HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to return in the response. nextToken A token used for pagination of results returned. type The type of analyzer. Valid Values: ACCOUNT \| ORGANIZATION \| ACCOUNT_UNUSED_ACCESS \| ORGANIZATION_UNUSED_ACCESS Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "analyzers": [ { "arn": "string", "configuration": { ... }, ListAnalyzers API Version 2019-11-01 88 IAM Access Analyzer API Reference "createdAt": "string", "lastResourceAnalyzed": "string", "lastResourceAnalyzedAt": "string", "name": "string", "status": "string", "statusReason": { "code": "string" }, "tags": { "string" : "string" }, "type": "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. analyzers The analyzers retrieved. Type: Array of AnalyzerSummary objects nextToken A token used for pagination of results returned. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. Response Elements API Version 2019-11-01 89 API Reference IAM Access Analyzer HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 90 IAM Access Analyzer ListArchiveRules Retrieves a list of archive rules created for the speciﬁed analyzer. Request Syntax API Reference GET /analyzer/analyzerName/archive-rule?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI
access-analyzer-api-018	access-analyzer-api.pdf	18	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 2019-11-01 90 IAM Access Analyzer ListArchiveRules Retrieves a list of archive rules created for the speciﬁed analyzer. Request Syntax API Reference GET /analyzer/analyzerName/archive-rule?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. analyzerName The name of the analyzer to retrieve rules from. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes maxResults The maximum number of results to return in the request. nextToken A token used for pagination of results returned. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { ListArchiveRules API Version 2019-11-01 91 IAM Access Analyzer API Reference "archiveRules": [ { "createdAt": "string", "filter": { "string" : { "contains": [ "string" ], "eq": [ "string" ], "exists": boolean, "neq": [ "string" ] } }, "ruleName": "string", "updatedAt": "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. archiveRules A list of archive rules created for the speciﬁed analyzer. Type: Array of ArchiveRuleSummary objects nextToken A token used for pagination of results returned. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. Response Elements API Version 2019-11-01 92 API Reference IAM Access Analyzer HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 93 IAM Access Analyzer ListFindings API Reference Retrieves a list of ﬁndings generated by the speciﬁed analyzer. ListFindings and ListFindingsV2 both use access-analyzer:ListFindings in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:ListFindings action. To learn about ﬁlter keys that you can use to retrieve a list of ﬁndings, see IAM Access Analyzer ﬁlter keys in the IAM User Guide. Request Syntax POST /finding HTTP/1.1 Content-type: application/json { "analyzerArn": "string", "filter": { "string" : { "contains": [ "string" ], "eq": [ "string" ], "exists": boolean, "neq": [ "string" ] } }, "maxResults": number, "nextToken": "string", "sort": { "attributeName": "string", "orderBy": "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ListFindings API Version 2019-11-01 94 IAM Access Analyzer analyzerArn API Reference The ARN of the analyzer to retrieve ﬁndings from. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]*:analyzer/.{1,255} Required: Yes ﬁlter A ﬁlter to match for the ﬁndings to return. Type: String to Criterion object map Required: No maxResults The maximum number of results to return in the response. Type: Integer Required: No nextToken A token used for pagination of results returned. Type: String Required: No sort The sort order for the ﬁndings returned. Type: SortCriteria object Required: No Response Syntax HTTP/1.1 200 Content-type: application/json Response Syntax API Version 2019-11-01 95 API Reference IAM Access Analyzer { "findings": [ { "action": [ "string" ], "analyzedAt": "string", "condition": { "string" : "string" }, "createdAt": "string", "error": "string", "id": "string", "isPublic": boolean, "principal": { "string" : "string" }, "resource": "string", "resourceControlPolicyRestriction": "string", "resourceOwnerAccount": "string", "resourceType": "string", "sources": [ { "detail": { "accessPointAccount": "string", "accessPointArn": "string" }, "type": "string" } ], "status": "string", "updatedAt": "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. ﬁndings A list of ﬁndings retrieved from the analyzer that match the ﬁlter criteria speciﬁed, if any. Response Elements API Version 2019-11-01 96 IAM Access Analyzer API Reference Type: Array of FindingSummary objects nextToken A token used for pagination of results returned. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403
access-analyzer-api-019	access-analyzer-api.pdf	19	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. ﬁndings A list of ﬁndings retrieved from the analyzer that match the ﬁlter criteria speciﬁed, if any. Response Elements API Version 2019-11-01 96 IAM Access Analyzer API Reference Type: Array of FindingSummary objects nextToken A token used for pagination of results returned. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2019-11-01 97 API Reference IAM Access Analyzer • 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 2019-11-01 98 IAM Access Analyzer ListFindingsV2 API Reference Retrieves a list of ﬁndings generated by the speciﬁed analyzer. ListFindings and ListFindingsV2 both use access-analyzer:ListFindings in the Action element of an IAM policy statement. You must have permission to perform the access-analyzer:ListFindings action. To learn about ﬁlter keys that you can use to retrieve a list of ﬁndings, see IAM Access Analyzer ﬁlter keys in the IAM User Guide. Request Syntax POST /findingv2 HTTP/1.1 Content-type: application/json { "analyzerArn": "string", "filter": { "string" : { "contains": [ "string" ], "eq": [ "string" ], "exists": boolean, "neq": [ "string" ] } }, "maxResults": number, "nextToken": "string", "sort": { "attributeName": "string", "orderBy": "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ListFindingsV2 API Version 2019-11-01 99 IAM Access Analyzer analyzerArn API Reference The ARN of the analyzer to retrieve ﬁndings from. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]*:analyzer/.{1,255} Required: Yes ﬁlter A ﬁlter to match for the ﬁndings to return. Type: String to Criterion object map Required: No maxResults The maximum number of results to return in the response. Type: Integer Required: No nextToken A token used for pagination of results returned. Type: String Required: No sort The criteria used to sort. Type: SortCriteria object Required: No Response Syntax HTTP/1.1 200 Content-type: application/json Response Syntax API Version 2019-11-01 100 API Reference IAM Access Analyzer { "findings": [ { "analyzedAt": "string", "createdAt": "string", "error": "string", "findingType": "string", "id": "string", "resource": "string", "resourceOwnerAccount": "string", "resourceType": "string", "status": "string", "updatedAt": "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. ﬁndings A list of ﬁndings retrieved from the analyzer that match the ﬁlter criteria speciﬁed, if any. Type: Array of FindingSummaryV2 objects nextToken A token used for pagination of results returned. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. Response Elements API Version 2019-11-01 101 API Reference IAM Access Analyzer HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 102 IAM Access Analyzer API Reference See Also API Version 2019-11-01 103 IAM Access Analyzer API Reference ListPolicyGenerations Lists all of the policy generations requested in the last seven days. Request Syntax GET /policy/generation? maxResults=maxResults&nextToken=nextToken&principalArn=principalArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to return in the response. Valid Range: Minimum value of 1. nextToken A token used for pagination of results returned. principalArn The ARN of the IAM entity (user or role) for which you are generating a policy. Use this with ListGeneratedPolicies to ﬁlter the results
access-analyzer-api-020	access-analyzer-api.pdf	20	API Version 2019-11-01 102 IAM Access Analyzer API Reference See Also API Version 2019-11-01 103 IAM Access Analyzer API Reference ListPolicyGenerations Lists all of the policy generations requested in the last seven days. Request Syntax GET /policy/generation? maxResults=maxResults&nextToken=nextToken&principalArn=principalArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to return in the response. Valid Range: Minimum value of 1. nextToken A token used for pagination of results returned. principalArn The ARN of the IAM entity (user or role) for which you are generating a policy. Use this with ListGeneratedPolicies to ﬁlter the results to only include results for a speciﬁc principal. Pattern: arn:[^:]:iam::[^:]:(role\|user)/.{1,576} Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", ListPolicyGenerations API Version 2019-11-01 104 IAM Access Analyzer API Reference "policyGenerations": [ { "completedOn": "string", "jobId": "string", "principalArn": "string", "startedOn": "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. nextToken A token used for pagination of results returned. Type: String policyGenerations A PolicyGeneration object that contains details about the generated policy. Type: Array of PolicyGeneration objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 Response Elements API Version 2019-11-01 105 API Reference IAM Access Analyzer ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 106 IAM Access Analyzer API Reference ListTagsForResource Retrieves a list of tags applied to the speciﬁed resource. Request Syntax GET /tags/resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the resource to retrieve tags from. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "tags": { "string" : "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. ListTagsForResource API Version 2019-11-01 107 API Reference IAM Access Analyzer tags The tags that are applied to the speciﬁed resource. Type: String to string map Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2019-11-01 108 API Reference IAM Access Analyzer • 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 2019-11-01 109 IAM Access Analyzer API Reference StartPolicyGeneration Starts the policy generation request. Request Syntax PUT /policy/generation HTTP/1.1 Content-type: application/json { "clientToken": "string", "cloudTrailDetails": { "accessRole": "string", "endTime": "string", "startTime": "string", "trails": [ { "allRegions": boolean, "cloudTrailArn": "string", "regions": [ "string" ] } ] }, "policyGenerationDetails": { "principalArn": "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. clientToken A unique, case-sensitive identiﬁer that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional eﬀect. StartPolicyGeneration API Version 2019-11-01 110 IAM Access Analyzer API Reference If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Required: No cloudTrailDetails A CloudTrailDetails object that contains details about a Trail that you want to
access-analyzer-api-021	access-analyzer-api.pdf	21	clientToken A unique, case-sensitive identiﬁer that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional eﬀect. StartPolicyGeneration API Version 2019-11-01 110 IAM Access Analyzer API Reference If you do not specify a client token, one is automatically generated by the AWS SDK. Type: String Required: No cloudTrailDetails A CloudTrailDetails object that contains details about a Trail that you want to analyze to generate policies. Type: CloudTrailDetails object Required: No policyGenerationDetails Contains the ARN of the IAM entity (user or role) for which you are generating a policy. Type: PolicyGenerationDetails object Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "jobId": "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. jobId The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request. Response Syntax API Version 2019-11-01 111 IAM Access Analyzer Type: String Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ConﬂictException A conﬂict exception error. HTTP Status Code: 409 InternalServerException Internal server error. HTTP Status Code: 500 ServiceQuotaExceededException Service quote met error. HTTP Status Code: 402 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2019-11-01 112 API Reference IAM Access Analyzer • 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 2019-11-01 113 IAM Access Analyzer StartResourceScan API Reference Immediately starts a scan of the policies applied to the speciﬁed resource. Request Syntax POST /resource/scan HTTP/1.1 Content-type: application/json { "analyzerArn": "string", "resourceArn": "string", "resourceOwnerAccount": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. analyzerArn The ARN of the analyzer to use to scan the policies applied to the speciﬁed resource. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes resourceArn The ARN of the resource to scan. Type: String Pattern: arn:[^:]:[^:]:[^:]:[^:]:. Required: Yes StartResourceScan API Version 2019-11-01 114 IAM Access Analyzer resourceOwnerAccount API Reference The AWS account ID that owns the resource. For most AWS resources, the owning account is the account in which the resource was created. Type: String 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 You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. Response Syntax API Version 2019-11-01 115 IAM Access Analyzer HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 116 IAM Access Analyzer TagResource Adds a tag to the speciﬁed resource. Request Syntax POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the resource to add the tag to. Required: Yes Request Body The request accepts the following data in JSON format. tags The tags to add to the resource. Type: String to string map Required: Yes Response Syntax HTTP/1.1 200 TagResource API Reference API Version 2019-11-01 117 IAM Access Analyzer Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
access-analyzer-api-022	access-analyzer-api.pdf	22	Request Syntax POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the resource to add the tag to. Required: Yes Request Body The request accepts the following data in JSON format. tags The tags to add to the resource. Type: String to string map Required: Yes Response Syntax HTTP/1.1 200 TagResource API Reference API Version 2019-11-01 117 IAM Access Analyzer Response Elements API Reference 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 You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 Response Elements API Version 2019-11-01 118 API Reference IAM Access Analyzer • 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 2019-11-01 119 API Reference IAM Access Analyzer UntagResource Removes a tag from the speciﬁed resource. Request Syntax DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The ARN of the resource to remove the tag from. Required: Yes tagKeys The key for the tag to add. Required: Yes Request Body The request does not have a request body. 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. UntagResource API Version 2019-11-01 120 IAM Access Analyzer AccessDeniedException You do not have suﬃcient access to perform this action. API Reference HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 See Also API Version 2019-11-01 121 IAM Access Analyzer • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2019-11-01 122 API Reference IAM Access Analyzer UpdateAnalyzer Modiﬁes the conﬁguration of an existing analyzer. Request Syntax PUT /analyzer/analyzerName HTTP/1.1 Content-type: application/json { "configuration": { ... } } URI Request Parameters The request uses the following URI parameters. analyzerName The name of the analyzer to modify. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes Request Body The request accepts the following data in JSON format. conﬁguration Contains information about the conﬁguration of an analyzer for an AWS organization or account. Type: AnalyzerConﬁguration object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No UpdateAnalyzer API Version 2019-11-01 123 API Reference IAM Access Analyzer Response Syntax HTTP/1.1 200 Content-type: application/json { "configuration": { ... } } 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. conﬁguration Contains information about the conﬁguration of an analyzer for an AWS organization or account. Type: AnalyzerConﬁguration object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ConﬂictException A conﬂict exception error. HTTP Status Code: 409 InternalServerException Internal server error. Response Syntax API Version 2019-11-01 124 API Reference IAM Access Analyzer HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 See Also For more information about using this API in one of the
access-analyzer-api-023	access-analyzer-api.pdf	23	Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ConﬂictException A conﬂict exception error. HTTP Status Code: 409 InternalServerException Internal server error. Response Syntax API Version 2019-11-01 124 API Reference IAM Access Analyzer HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 125 IAM Access Analyzer UpdateArchiveRule Updates the criteria and values for the speciﬁed archive rule. Request Syntax PUT /analyzer/analyzerName/archive-rule/ruleName HTTP/1.1 Content-type: application/json API Reference { "clientToken": "string", "filter": { "string" : { "contains": [ "string" ], "eq": [ "string" ], "exists": boolean, "neq": [ "string" ] } } } URI Request Parameters The request uses the following URI parameters. analyzerName The name of the analyzer to update the archive rules for. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes ruleName The name of the rule to update. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* UpdateArchiveRule API Version 2019-11-01 126 IAM Access Analyzer Required: Yes Request Body The request accepts the following data in JSON format. API Reference clientToken A client token. Type: String Required: No ﬁlter A ﬁlter to match for the rules to update. Only rules that match the ﬁlter are updated. Type: String to Criterion object map Required: Yes 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 You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. Request Body API Version 2019-11-01 127 API Reference IAM Access Analyzer HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 2019-11-01 128 API Reference IAM Access Analyzer UpdateFindings Updates the status for the speciﬁed ﬁndings. Request Syntax PUT /finding HTTP/1.1 Content-type: application/json { "analyzerArn": "string", "clientToken": "string", "ids": [ "string" ], "resourceArn": "string", "status": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. analyzerArn The ARN of the analyzer that generated the ﬁndings to update. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes clientToken A client token. Type: String Required: No UpdateFindings API Version 2019-11-01 129 API Reference IAM Access Analyzer ids The IDs of the ﬁndings to update. Type: Array of strings Required: No resourceArn The ARN of the resource identiﬁed in the ﬁnding. Type: String Pattern: arn:[^:]:[^:]:[^:]:[^:]:. Required: No status The state represents the action to take to update the ﬁnding Status. Use ARCHIVE to change an Active ﬁnding to an Archived ﬁnding. Use ACTIVE to change an Archived ﬁnding to an Active ﬁnding. Type: String Valid Values: ACTIVE \| ARCHIVED Required: Yes 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. Response Syntax API Version 2019-11-01 130 IAM Access Analyzer AccessDeniedException You do not have suﬃcient access to perform this action. API Reference HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command
access-analyzer-api-024	access-analyzer-api.pdf	24	Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2019-11-01 130 IAM Access Analyzer AccessDeniedException You do not have suﬃcient access to perform this action. API Reference HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. HTTP Status Code: 400 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 See Also API Version 2019-11-01 131 IAM Access Analyzer • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2019-11-01 132 IAM Access Analyzer ValidatePolicy API Reference Requests the validation of a policy and returns a list of ﬁndings. The ﬁndings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices. Request Syntax POST /policy/validation?maxResults=maxResults&nextToken=nextToken HTTP/1.1 Content-type: application/json { "locale": "string", "policyDocument": "string", "policyType": "string", "validatePolicyResourceType": "string" } URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of results to return in the response. nextToken A token used for pagination of results returned. Request Body The request accepts the following data in JSON format. locale The locale to use for localizing the ﬁndings. Type: String Valid Values: DE \| EN \| ES \| FR \| IT \| JA \| KO \| PT_BR \| ZH_CN \| ZH_TW ValidatePolicy API Version 2019-11-01 133 IAM Access Analyzer Required: No policyDocument The JSON policy document to use as the content for the policy. API Reference Type: String Required: Yes policyType The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups. Resource policies grant permissions on AWS resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a speciﬁc input such as managed policy or Amazon S3 bucket policy. Service control policies (SCPs) are a type of organization policy attached to an AWS organization, organizational unit (OU), or an account. Type: String Valid Values: IDENTITY_POLICY \| RESOURCE_POLICY \| SERVICE_CONTROL_POLICY \| RESOURCE_CONTROL_POLICY Required: Yes validatePolicyResourceType The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type. For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies. Type: String Request Body API Version 2019-11-01 134 IAM Access Analyzer API Reference Valid Values: AWS::S3::Bucket \| AWS::S3::AccessPoint \| AWS::S3::MultiRegionAccessPoint \| AWS::S3ObjectLambda::AccessPoint \| AWS::IAM::AssumeRolePolicyDocument \| AWS::DynamoDB::Table Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "findings": [ { "findingDetails": "string", "findingType": "string", "issueCode": "string", "learnMoreLink": "string", "locations": [ { "path": [ { ... } ], "span": { "end": { "column": number, "line": number, "offset": number }, "start": { "column": number, "line": number, "offset": number } } } ] } ], "nextToken": "string" } Response Syntax API Version 2019-11-01 135 IAM Access Analyzer 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. ﬁndings The list of ﬁndings in a policy returned by IAM Access Analyzer based on its suite of policy checks. Type: Array of ValidatePolicyFinding objects nextToken A token used for pagination of results returned. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. Response Elements API Version 2019-11-01 136 IAM Access Analyzer HTTP Status Code: 400 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
access-analyzer-api-025	access-analyzer-api.pdf	25	pagination of results returned. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Validation exception error. Response Elements API Version 2019-11-01 136 IAM Access Analyzer HTTP Status Code: 400 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 2019-11-01 137 IAM Access Analyzer Data Types API Reference The IAM Access Analyzer 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: • Access • AccessPreview • AccessPreviewFinding • AccessPreviewStatusReason • AccessPreviewSummary • AclGrantee • AnalysisRule • AnalysisRuleCriteria • AnalyzedResource • AnalyzedResourceSummary • AnalyzerConﬁguration • AnalyzerSummary • ArchiveRuleSummary • CloudTrailDetails • CloudTrailProperties • Conﬁguration • Criterion • DynamodbStreamConﬁguration • DynamodbTableConﬁguration • EbsSnapshotConﬁguration API Version 2019-11-01 138 IAM Access Analyzer • EcrRepositoryConﬁguration • EfsFileSystemConﬁguration • ExternalAccessDetails • ExternalAccessFindingsStatistics • Finding • FindingAggregationAccountDetails • FindingDetails • FindingSource • FindingSourceDetail • FindingsStatistics • FindingSummary • FindingSummaryV2 • GeneratedPolicy • GeneratedPolicyProperties • GeneratedPolicyResult • IamRoleConﬁguration • InlineArchiveRule • InternetConﬁguration • JobDetails • JobError • KmsGrantConﬁguration • KmsGrantConstraints • KmsKeyConﬁguration • Location • NetworkOriginConﬁguration • PathElement • PolicyGeneration • PolicyGenerationDetails • Position • RdsDbClusterSnapshotAttributeValue API Reference API Version 2019-11-01 139 IAM Access Analyzer API Reference • RdsDbClusterSnapshotConﬁguration • RdsDbSnapshotAttributeValue • RdsDbSnapshotConﬁguration • ReasonSummary • RecommendationError • RecommendedStep • ResourceTypeDetails • S3AccessPointConﬁguration • S3BucketAclGrantConﬁguration • S3BucketConﬁguration • S3ExpressDirectoryAccessPointConﬁguration • S3ExpressDirectoryBucketConﬁguration • S3PublicAccessBlockConﬁguration • SecretsManagerSecretConﬁguration • SnsTopicConﬁguration • SortCriteria • Span • SqsQueueConﬁguration • StatusReason • Substring • Trail • TrailProperties • UnusedAccessConﬁguration • UnusedAccessFindingsStatistics • UnusedAccessTypeStatistics • UnusedAction • UnusedIamRoleDetails • UnusedIamUserAccessKeyDetails • UnusedIamUserPasswordDetails • UnusedPermissionDetails API Version 2019-11-01 140 IAM Access Analyzer API Reference • UnusedPermissionsRecommendedStep • ValidatePolicyFinding • ValidationExceptionField • VpcConﬁguration API Version 2019-11-01 141 IAM Access Analyzer Access API Reference Contains information about actions and resources that deﬁne permissions to check against a policy. Contents actions A list of actions for the access permissions. Any strings that can be used as an action in an IAM policy can be used in the list of actions to check. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Required: No resources A list of resources for the access permissions. Any strings that can be used as an Amazon Resource Name (ARN) in an IAM policy can be used in the list of resources to check. You can only use a wildcard in the portion of the ARN that speciﬁes the resource ID. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 0. Maximum length of 2048. 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 Access API Version 2019-11-01 142 API Reference IAM Access Analyzer AccessPreview Contains information about an access preview. Contents analyzerArn The ARN of the analyzer used to generate the access preview. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]*:analyzer/.{1,255} Required: Yes conﬁgurations A map of resource ARNs for the proposed resource conﬁguration. Type: String to Conﬁguration object map Required: Yes createdAt The time at which the access preview was created. Type: Timestamp Required: Yes id The unique ID for the access preview. Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes status The status of the access preview. AccessPreview API Version 2019-11-01 143 IAM Access Analyzer API Reference • Creating - The access preview creation is in progress. • Completed - The access preview is complete. You can preview ﬁndings for external access to the resource. • Failed - The access preview creation has failed. Type: String Valid Values: COMPLETED \| CREATING \| FAILED Required: Yes statusReason Provides more details about the current status of the access preview. For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource conﬁguration. Type: AccessPreviewStatusReason object Required: No See Also For more information about using this
access-analyzer-api-026	access-analyzer-api.pdf	26	is in progress. • Completed - The access preview is complete. You can preview ﬁndings for external access to the resource. • Failed - The access preview creation has failed. Type: String Valid Values: COMPLETED \| CREATING \| FAILED Required: Yes statusReason Provides more details about the current status of the access preview. For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource conﬁguration. Type: AccessPreviewStatusReason 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 See Also API Version 2019-11-01 144 IAM Access Analyzer API Reference AccessPreviewFinding An access preview ﬁnding generated by the access preview. Contents changeType Provides context on how the access preview ﬁnding compares to existing access identiﬁed in IAM Access Analyzer. • New - The ﬁnding is for newly-introduced access. • Unchanged - The preview ﬁnding is an existing ﬁnding that would remain unchanged. • Changed - The preview ﬁnding is an existing ﬁnding with a change in status. For example, a Changed ﬁnding with preview status Resolved and existing status Active indicates the existing Active ﬁnding would become Resolved as a result of the proposed permissions change. Type: String Valid Values: CHANGED \| NEW \| UNCHANGED Required: Yes createdAt The time at which the access preview ﬁnding was created. Type: Timestamp Required: Yes id The ID of the access preview ﬁnding. This ID uniquely identiﬁes the element in the list of access preview ﬁndings and is not related to the ﬁnding ID in Access Analyzer. Type: String Required: Yes AccessPreviewFinding API Version 2019-11-01 145 IAM Access Analyzer resourceOwnerAccount API Reference The AWS account ID that owns the resource. For most AWS resources, the owning account is the account in which the resource was created. Type: String Required: Yes resourceType The type of the resource that can be accessed in the ﬁnding. Type: String Valid Values: AWS::S3::Bucket \| AWS::IAM::Role \| AWS::SQS::Queue \| AWS::Lambda::Function \| AWS::Lambda::LayerVersion \| AWS::KMS::Key \| AWS::SecretsManager::Secret \| AWS::EFS::FileSystem \| AWS::EC2::Snapshot \| AWS::ECR::Repository \| AWS::RDS::DBSnapshot \| AWS::RDS::DBClusterSnapshot \| AWS::SNS::Topic \| AWS::S3Express::DirectoryBucket \| AWS::DynamoDB::Table \| AWS::DynamoDB::Stream \| AWS::IAM::User Required: Yes status The preview status of the ﬁnding. This is what the status of the ﬁnding would be after permissions deployment. For example, a Changed ﬁnding with preview status Resolved and existing status Active indicates the existing Active ﬁnding would become Resolved as a result of the proposed permissions change. Type: String Valid Values: ACTIVE \| ARCHIVED \| RESOLVED Required: Yes action The action in the analyzed policy statement that an external principal has permission to perform. Type: Array of strings Contents API Version 2019-11-01 146 IAM Access Analyzer Required: No condition API Reference The condition in the analyzed policy statement that resulted in a ﬁnding. Type: String to string map Required: No error An error. Type: String Required: No existingFindingId The existing ID of the ﬁnding in IAM Access Analyzer, provided only for existing ﬁndings. Type: String Required: No existingFindingStatus The existing status of the ﬁnding, provided only for existing ﬁndings. Type: String Valid Values: ACTIVE \| ARCHIVED \| RESOLVED Required: No isPublic Indicates whether the policy that generated the ﬁnding allows public access to the resource. Type: Boolean Required: No principal The external principal that has access to a resource within the zone of trust. Contents API Version 2019-11-01 147 IAM Access Analyzer Type: String to string map Required: No resource API Reference The resource that an external principal has access to. This is the resource associated with the access preview. Type: String Required: No resourceControlPolicyRestriction The type of restriction applied to the ﬁnding by the resource owner with an Organizations resource control policy (RCP). Type: String Valid Values: APPLICABLE \| FAILED_TO_EVALUATE_RCP \| NOT_APPLICABLE Required: No sources The sources of the ﬁnding. This indicates how the access that generated the ﬁnding is granted. It is populated for Amazon S3 bucket ﬁndings. Type: Array of FindingSource objects 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 2019-11-01 148 IAM Access Analyzer API Reference AccessPreviewStatusReason Provides more details about the current status of the access preview. For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid proposed resource conﬁguration. Contents code The reason code for the current status of the access preview. Type: String Valid Values: INTERNAL_ERROR \|
access-analyzer-api-027	access-analyzer-api.pdf	27	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 2019-11-01 148 IAM Access Analyzer API Reference AccessPreviewStatusReason Provides more details about the current status of the access preview. For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid proposed resource conﬁguration. Contents code The reason code for the current status of the access preview. Type: String Valid Values: INTERNAL_ERROR \| INVALID_CONFIGURATION 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 AccessPreviewStatusReason API Version 2019-11-01 149 IAM Access Analyzer API Reference AccessPreviewSummary Contains a summary of information about an access preview. Contents analyzerArn The ARN of the analyzer used to generate the access preview. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]*:analyzer/.{1,255} Required: Yes createdAt The time at which the access preview was created. Type: Timestamp Required: Yes id The unique ID for the access preview. Type: String Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12} Required: Yes status The status of the access preview. • Creating - The access preview creation is in progress. • Completed - The access preview is complete and previews the ﬁndings for external access to the resource. • Failed - The access preview creation has failed. Type: String AccessPreviewSummary API Version 2019-11-01 150 IAM Access Analyzer API Reference Valid Values: COMPLETED \| CREATING \| FAILED Required: Yes statusReason Provides more details about the current status of the access preview. For example, if the creation of the access preview fails, a Failed status is returned. This failure can be due to an internal issue with the analysis or due to an invalid proposed resource conﬁguration. Type: AccessPreviewStatusReason 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 See Also API Version 2019-11-01 151 IAM Access Analyzer AclGrantee API Reference You specify each grantee as a type-value pair using one of these types. You can specify only one type of grantee. For more information, see PutBucketAcl. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. id uri The value speciﬁed is the canonical user ID of an AWS account. Type: String Required: No Used for granting permissions to a predeﬁned group. 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++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AclGrantee API Version 2019-11-01 152 IAM Access Analyzer AnalysisRule API Reference Contains information about analysis rules for the analyzer. Analysis rules determine which entities will generate ﬁndings based on the criteria you deﬁne when you create the rule. Contents exclusions A list of rules for the analyzer containing criteria to exclude from analysis. Entities that meet the rule criteria will not generate ﬁndings. Type: Array of AnalysisRuleCriteria objects 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 AnalysisRule API Version 2019-11-01 153 IAM Access Analyzer API Reference AnalysisRuleCriteria The criteria for an analysis rule for an analyzer. The criteria determine which entities will generate ﬁndings. Contents accountIds A list of AWS account IDs to apply to the analysis rule criteria. The accounts cannot include the organization analyzer owner account. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers. The list cannot include more than 2,000 account IDs. Type: Array of strings Required: No resourceTags An array of key-value pairs to match for your resources. You can use the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be preﬁxed with aws:. For the tag value, you can specify a value that is 0 to 256 characters in length. If the speciﬁed tag value is 0 characters, the rule is applied to all principals with the speciﬁed tag key. Type: Array of string to string maps 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 •
access-analyzer-api-028	access-analyzer-api.pdf	28	For the tag key, you can specify a value that is 1 to 128 characters in length and cannot be preﬁxed with aws:. For the tag value, you can specify a value that is 0 to 256 characters in length. If the speciﬁed tag value is 0 characters, the rule is applied to all principals with the speciﬁed tag key. Type: Array of string to string maps 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 AnalysisRuleCriteria API Version 2019-11-01 154 IAM Access Analyzer API Reference See Also API Version 2019-11-01 155 API Reference IAM Access Analyzer AnalyzedResource Contains details about the analyzed resource. Contents analyzedAt The time at which the resource was analyzed. Type: Timestamp Required: Yes createdAt The time at which the ﬁnding was created. Type: Timestamp Required: Yes isPublic Indicates whether the policy that generated the ﬁnding grants public access to the resource. Type: Boolean Required: Yes resourceArn The ARN of the resource that was analyzed. Type: String Pattern: arn:[^:]:[^:]:[^:]:[^:]:.* Required: Yes resourceOwnerAccount The AWS account ID that owns the resource. Type: String Required: Yes AnalyzedResource API Version 2019-11-01 156 IAM Access Analyzer resourceType The type of the resource that was analyzed. Type: String API Reference Valid Values: AWS::S3::Bucket \| AWS::IAM::Role \| AWS::SQS::Queue \| AWS::Lambda::Function \| AWS::Lambda::LayerVersion \| AWS::KMS::Key \| AWS::SecretsManager::Secret \| AWS::EFS::FileSystem \| AWS::EC2::Snapshot \| AWS::ECR::Repository \| AWS::RDS::DBSnapshot \| AWS::RDS::DBClusterSnapshot \| AWS::SNS::Topic \| AWS::S3Express::DirectoryBucket \| AWS::DynamoDB::Table \| AWS::DynamoDB::Stream \| AWS::IAM::User Required: Yes updatedAt The time at which the ﬁnding was updated. Type: Timestamp Required: Yes actions The actions that an external principal is granted permission to use by the policy that generated the ﬁnding. Type: Array of strings Required: No error An error message. Type: String Required: No sharedVia Indicates how the access that generated the ﬁnding is granted. This is populated for Amazon S3 bucket ﬁndings. Contents API Version 2019-11-01 157 IAM Access Analyzer Type: Array of strings Required: No status API Reference The current status of the ﬁnding generated from the analyzed resource. Type: String Valid Values: ACTIVE \| ARCHIVED \| RESOLVED 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 2019-11-01 158 IAM Access Analyzer API Reference AnalyzedResourceSummary Contains the ARN of the analyzed resource. Contents resourceArn The ARN of the analyzed resource. Type: String Pattern: arn:[^:]:[^:]:[^:]:[^:]:.* Required: Yes resourceOwnerAccount The AWS account ID that owns the resource. Type: String Required: Yes resourceType The type of resource that was analyzed. Type: String Valid Values: AWS::S3::Bucket \| AWS::IAM::Role \| AWS::SQS::Queue \| AWS::Lambda::Function \| AWS::Lambda::LayerVersion \| AWS::KMS::Key \| AWS::SecretsManager::Secret \| AWS::EFS::FileSystem \| AWS::EC2::Snapshot \| AWS::ECR::Repository \| AWS::RDS::DBSnapshot \| AWS::RDS::DBClusterSnapshot \| AWS::SNS::Topic \| AWS::S3Express::DirectoryBucket \| AWS::DynamoDB::Table \| AWS::DynamoDB::Stream \| AWS::IAM::User Required: Yes AnalyzedResourceSummary API Version 2019-11-01 159 IAM Access Analyzer 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 2019-11-01 160 IAM Access Analyzer API Reference AnalyzerConﬁguration Contains information about the conﬁguration of an analyzer for an AWS organization or account. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. unusedAccess Speciﬁes the conﬁguration of an unused access analyzer for an AWS organization or account. Type: UnusedAccessConﬁguration 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 AnalyzerConﬁguration API Version 2019-11-01 161 API Reference IAM Access Analyzer AnalyzerSummary Contains information about the analyzer. Contents arn The ARN of the analyzer. Type: String Pattern: [^:]:[^:]:[^:]:[^:]:[^:]:analyzer/.{1,255} Required: Yes createdAt A timestamp for the time at which the analyzer was created. Type: Timestamp Required: Yes name The name of the analyzer. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-] Required: Yes status The status of the analyzer. An Active analyzer successfully monitors supported resources and generates new ﬁndings. The analyzer is Disabled when a user action, such as removing trusted access for AWS Identity and Access Management Access Analyzer from AWS Organizations, causes the analyzer to stop generating new ﬁndings. The status is Creating when the analyzer creation is in progress and Failed when the analyzer creation has failed. AnalyzerSummary API Version 2019-11-01 162 IAM Access Analyzer Type: String API Reference Valid Values: ACTIVE \| CREATING
access-analyzer-api-029	access-analyzer-api.pdf	29	String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes status The status of the analyzer. An Active analyzer successfully monitors supported resources and generates new ﬁndings. The analyzer is Disabled when a user action, such as removing trusted access for AWS Identity and Access Management Access Analyzer from AWS Organizations, causes the analyzer to stop generating new ﬁndings. The status is Creating when the analyzer creation is in progress and Failed when the analyzer creation has failed. AnalyzerSummary API Version 2019-11-01 162 IAM Access Analyzer Type: String API Reference Valid Values: ACTIVE \| CREATING \| DISABLED \| FAILED Required: Yes type The type of analyzer, which corresponds to the zone of trust chosen for the analyzer. Type: String Valid Values: ACCOUNT \| ORGANIZATION \| ACCOUNT_UNUSED_ACCESS \| ORGANIZATION_UNUSED_ACCESS Required: Yes conﬁguration Speciﬁes whether the analyzer is an external access or unused access analyzer. Type: AnalyzerConﬁguration object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: No lastResourceAnalyzed The resource that was most recently analyzed by the analyzer. Type: String Required: No lastResourceAnalyzedAt The time at which the most recently analyzed resource was analyzed. Type: Timestamp Required: No statusReason The statusReason provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a Failed status is returned. For an analyzer with Contents API Version 2019-11-01 163 IAM Access Analyzer API Reference organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the AWS organization. Type: StatusReason object Required: No tags The tags added to the analyzer. Type: String to string map 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 2019-11-01 164 IAM Access Analyzer API Reference ArchiveRuleSummary Contains information about an archive rule. Archive rules automatically archive new ﬁndings that meet the criteria you deﬁne when you create the rule. Contents createdAt The time at which the archive rule was created. Type: Timestamp Required: Yes ﬁlter A ﬁlter used to deﬁne the archive rule. Type: String to Criterion object map Required: Yes ruleName The name of the archive rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* Required: Yes updatedAt The time at which the archive rule was last updated. Type: Timestamp Required: Yes ArchiveRuleSummary API Version 2019-11-01 165 IAM Access Analyzer 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 2019-11-01 166 IAM Access Analyzer CloudTrailDetails Contains information about CloudTrail access. Contents accessRole API Reference The ARN of the service role that IAM Access Analyzer uses to access your CloudTrail trail and service last accessed information. Type: String Pattern: arn:[^:]:iam::[^:]:role/.{1,576} Required: Yes startTime The start of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp before this time are not considered to generate a policy. Type: Timestamp Required: Yes trails A Trail object that contains settings for a trail. Type: Array of Trail objects Required: Yes endTime The end of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp after this time are not considered to generate a policy. If this is not included in the request, the default value is the current time. Type: Timestamp Required: No CloudTrailDetails API Version 2019-11-01 167 IAM Access Analyzer 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 2019-11-01 168 IAM Access Analyzer API Reference CloudTrailProperties Contains information about CloudTrail access. Contents endTime The end of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp after this time are not considered to generate a policy. If this is not included in the request, the default value is the current time. Type: Timestamp Required: Yes startTime The start of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp before this time are not considered to generate a policy. Type: Timestamp Required: Yes trailProperties A TrailProperties object that contains settings for trail properties. Type: Array of TrailProperties objects Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs,
access-analyzer-api-030	access-analyzer-api.pdf	30	Events with a timestamp after this time are not considered to generate a policy. If this is not included in the request, the default value is the current time. Type: Timestamp Required: Yes startTime The start of the time range for which IAM Access Analyzer reviews your CloudTrail events. Events with a timestamp before this time are not considered to generate a policy. Type: Timestamp Required: Yes trailProperties A TrailProperties object that contains settings for trail properties. Type: Array of TrailProperties objects 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 CloudTrailProperties API Version 2019-11-01 169 IAM Access Analyzer API Reference See Also API Version 2019-11-01 170 IAM Access Analyzer Conﬁguration API Reference Access control conﬁguration structures for your resource. You specify the conﬁguration as a type- value pair. You can specify only one type of access control conﬁguration. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. dynamodbStream The access control conﬁguration is for a DynamoDB stream. Type: DynamodbStreamConﬁguration object Required: No dynamodbTable The access control conﬁguration is for a DynamoDB table or index. Type: DynamodbTableConﬁguration object Required: No ebsSnapshot The access control conﬁguration is for an Amazon EBS volume snapshot. Type: EbsSnapshotConﬁguration object Required: No ecrRepository The access control conﬁguration is for an Amazon ECR repository. Type: EcrRepositoryConﬁguration object Required: No Conﬁguration API Version 2019-11-01 171 IAM Access Analyzer efsFileSystem API Reference The access control conﬁguration is for an Amazon EFS ﬁle system. Type: EfsFileSystemConﬁguration object Required: No iamRole The access control conﬁguration is for an IAM role. Type: IamRoleConﬁguration object Required: No kmsKey The access control conﬁguration is for a KMS key. Type: KmsKeyConﬁguration object Required: No rdsDbClusterSnapshot The access control conﬁguration is for an Amazon RDS DB cluster snapshot. Type: RdsDbClusterSnapshotConﬁguration object Required: No rdsDbSnapshot The access control conﬁguration is for an Amazon RDS DB snapshot. Type: RdsDbSnapshotConﬁguration object Required: No s3Bucket The access control conﬁguration is for an Amazon S3 bucket. Type: S3BucketConﬁguration object Required: No Contents API Version 2019-11-01 172 IAM Access Analyzer s3ExpressDirectoryBucket API Reference The access control conﬁguration is for an Amazon S3 directory bucket. Type: S3ExpressDirectoryBucketConﬁguration object Required: No secretsManagerSecret The access control conﬁguration is for a Secrets Manager secret. Type: SecretsManagerSecretConﬁguration object Required: No snsTopic The access control conﬁguration is for an Amazon SNS topic Type: SnsTopicConﬁguration object Required: No sqsQueue The access control conﬁguration is for an Amazon SQS queue. Type: SqsQueueConﬁguration 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 See Also API Version 2019-11-01 173 IAM Access Analyzer Criterion API Reference The criteria to use in the ﬁlter that deﬁnes the archive rule. For more information on available ﬁlter keys, see IAM Access Analyzer ﬁlter keys. Contents contains A "contains" operator to match for the ﬁlter used to create the rule. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Required: No eq An "equals" operator to match for the ﬁlter used to create the rule. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Required: No exists An "exists" operator to match for the ﬁlter used to create the rule. Type: Boolean Required: No neq A "not equals" operator to match for the ﬁlter used to create the rule. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Required: No Criterion API Version 2019-11-01 174 IAM Access Analyzer 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 2019-11-01 175 IAM Access Analyzer API Reference DynamodbStreamConﬁguration The proposed access control conﬁguration for a DynamoDB stream. You can propose a conﬁguration for a new DynamoDB stream or an existing DynamoDB stream that you own by specifying the policy for the DynamoDB stream. For more information, see PutResourcePolicy. • If the conﬁguration is for an existing DynamoDB stream and you do not specify the DynamoDB policy, then the access preview uses the existing DynamoDB policy for the stream. • If the access preview is for a new resource and you do not specify the policy, then the access preview assumes a DynamoDB stream without a policy. • To propose deletion of an existing DynamoDB stream policy, you can specify an empty string for
access-analyzer-api-031	access-analyzer-api.pdf	31	a new DynamoDB stream or an existing DynamoDB stream that you own by specifying the policy for the DynamoDB stream. For more information, see PutResourcePolicy. • If the conﬁguration is for an existing DynamoDB stream and you do not specify the DynamoDB policy, then the access preview uses the existing DynamoDB policy for the stream. • If the access preview is for a new resource and you do not specify the policy, then the access preview assumes a DynamoDB stream without a policy. • To propose deletion of an existing DynamoDB stream policy, you can specify an empty string for the DynamoDB policy. Contents streamPolicy The proposed resource policy deﬁning who can access or manage the DynamoDB stream. 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++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DynamodbStreamConﬁguration API Version 2019-11-01 176 IAM Access Analyzer API Reference DynamodbTableConﬁguration The proposed access control conﬁguration for a DynamoDB table or index. You can propose a conﬁguration for a new DynamoDB table or index or an existing DynamoDB table or index that you own by specifying the policy for the DynamoDB table or index. For more information, see PutResourcePolicy. • If the conﬁguration is for an existing DynamoDB table or index and you do not specify the DynamoDB policy, then the access preview uses the existing DynamoDB policy for the table or index. • If the access preview is for a new resource and you do not specify the policy, then the access preview assumes a DynamoDB table without a policy. • To propose deletion of an existing DynamoDB table or index policy, you can specify an empty string for the DynamoDB policy. Contents tablePolicy The proposed resource policy deﬁning who can access or manage the DynamoDB table. 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++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DynamodbTableConﬁguration API Version 2019-11-01 177 IAM Access Analyzer API Reference EbsSnapshotConﬁguration The proposed access control conﬁguration for an Amazon EBS volume snapshot. You can propose a conﬁguration for a new Amazon EBS volume snapshot or an Amazon EBS volume snapshot that you own by specifying the user IDs, groups, and optional AWS KMS encryption key. For more information, see ModifySnapshotAttribute. Contents groups The groups that have access to the Amazon EBS volume snapshot. If the value all is speciﬁed, then the Amazon EBS volume snapshot is public. • If the conﬁguration is for an existing Amazon EBS volume snapshot and you do not specify the groups, then the access preview uses the existing shared groups for the snapshot. • If the access preview is for a new resource and you do not specify the groups, then the access preview considers the snapshot without any groups. • To propose deletion of existing shared groups, you can specify an empty list for groups. Type: Array of strings Required: No kmsKeyId The KMS key identiﬁer for an encrypted Amazon EBS volume snapshot. The KMS key identiﬁer is the key ARN, key ID, alias ARN, or alias name for the KMS key. • If the conﬁguration is for an existing Amazon EBS volume snapshot and you do not specify the kmsKeyId, or you specify an empty string, then the access preview uses the existing kmsKeyId of the snapshot. • If the access preview is for a new resource and you do not specify the kmsKeyId, the access preview considers the snapshot as unencrypted. Type: String Required: No userIds The IDs of the AWS accounts that have access to the Amazon EBS volume snapshot. EbsSnapshotConﬁguration API Version 2019-11-01 178 IAM Access Analyzer API Reference • If the conﬁguration is for an existing Amazon EBS volume snapshot and you do not specify the userIds, then the access preview uses the existing shared userIds for the snapshot. • If the access preview is for a new resource and you do not specify the userIds, then the access preview considers the snapshot without any userIds. • To propose deletion of existing shared accountIds, you can specify an empty list for userIds. Type: Array of strings 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 2019-11-01 179 IAM Access Analyzer API Reference EcrRepositoryConﬁguration The proposed access control conﬁguration for an Amazon ECR repository. You can propose a conﬁguration for a new Amazon ECR repository or an existing Amazon ECR repository
access-analyzer-api-032	access-analyzer-api.pdf	32	without any userIds. • To propose deletion of existing shared accountIds, you can specify an empty list for userIds. Type: Array of strings 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 2019-11-01 179 IAM Access Analyzer API Reference EcrRepositoryConﬁguration The proposed access control conﬁguration for an Amazon ECR repository. You can propose a conﬁguration for a new Amazon ECR repository or an existing Amazon ECR repository that you own by specifying the Amazon ECR policy. For more information, see Repository. • If the conﬁguration is for an existing Amazon ECR repository and you do not specify the Amazon ECR policy, then the access preview uses the existing Amazon ECR policy for the repository. • If the access preview is for a new resource and you do not specify the policy, then the access preview assumes an Amazon ECR repository without a policy. • To propose deletion of an existing Amazon ECR repository policy, you can specify an empty string for the Amazon ECR policy. Contents repositoryPolicy The JSON repository policy text to apply to the Amazon ECR repository. For more information, see Private repository policy examples in the Amazon ECR User Guide. 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++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 EcrRepositoryConﬁguration API Version 2019-11-01 180 IAM Access Analyzer API Reference EfsFileSystemConﬁguration The proposed access control conﬁguration for an Amazon EFS ﬁle system. You can propose a conﬁguration for a new Amazon EFS ﬁle system or an existing Amazon EFS ﬁle system that you own by specifying the Amazon EFS policy. For more information, see Using ﬁle systems in Amazon EFS. • If the conﬁguration is for an existing Amazon EFS ﬁle system and you do not specify the Amazon EFS policy, then the access preview uses the existing Amazon EFS policy for the ﬁle system. • If the access preview is for a new resource and you do not specify the policy, then the access preview assumes an Amazon EFS ﬁle system without a policy. • To propose deletion of an existing Amazon EFS ﬁle system policy, you can specify an empty string for the Amazon EFS policy. Contents ﬁleSystemPolicy The JSON policy deﬁnition to apply to the Amazon EFS ﬁle system. For more information on the elements that make up a ﬁle system policy, see Amazon EFS Resource-based policies. 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++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 EfsFileSystemConﬁguration API Version 2019-11-01 181 IAM Access Analyzer API Reference ExternalAccessDetails Contains information about an external access ﬁnding. Contents condition The condition in the analyzed policy statement that resulted in an external access ﬁnding. Type: String to string map Required: Yes action The action in the analyzed policy statement that an external principal has permission to use. Type: Array of strings Required: No isPublic Speciﬁes whether the external access ﬁnding is public. Type: Boolean Required: No principal The external principal that has access to a resource within the zone of trust. Type: String to string map Required: No resourceControlPolicyRestriction The type of restriction applied to the ﬁnding by the resource owner with an Organizations resource control policy (RCP). Type: String Valid Values: APPLICABLE \| FAILED_TO_EVALUATE_RCP \| NOT_APPLICABLE ExternalAccessDetails API Version 2019-11-01 182 IAM Access Analyzer Required: No sources API Reference The sources of the external access ﬁnding. This indicates how the access that generated the ﬁnding is granted. It is populated for Amazon S3 bucket ﬁndings. Type: Array of FindingSource objects 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 2019-11-01 183 IAM Access Analyzer API Reference ExternalAccessFindingsStatistics Provides aggregate statistics about the ﬁndings for the speciﬁed external access analyzer. Contents resourceTypeStatistics The total number of active cross-account and public ﬁndings for each resource type of the speciﬁed external access analyzer. Type: String to ResourceTypeDetails object map Valid Keys: AWS::S3::Bucket \| AWS::IAM::Role \| AWS::SQS::Queue \| AWS::Lambda::Function \| AWS::Lambda::LayerVersion \| AWS::KMS::Key \| AWS::SecretsManager::Secret \| AWS::EFS::FileSystem \| AWS::EC2::Snapshot \| AWS::ECR::Repository \| AWS::RDS::DBSnapshot \| AWS::RDS::DBClusterSnapshot \| AWS::SNS::Topic \| AWS::S3Express::DirectoryBucket \| AWS::DynamoDB::Table \| AWS::DynamoDB::Stream \| AWS::IAM::User Required: No totalActiveFindings The number of active ﬁndings for the speciﬁed external access analyzer. Type: Integer Required: No totalArchivedFindings
access-analyzer-api-033	access-analyzer-api.pdf	33	183 IAM Access Analyzer API Reference ExternalAccessFindingsStatistics Provides aggregate statistics about the ﬁndings for the speciﬁed external access analyzer. Contents resourceTypeStatistics The total number of active cross-account and public ﬁndings for each resource type of the speciﬁed external access analyzer. Type: String to ResourceTypeDetails object map Valid Keys: AWS::S3::Bucket \| AWS::IAM::Role \| AWS::SQS::Queue \| AWS::Lambda::Function \| AWS::Lambda::LayerVersion \| AWS::KMS::Key \| AWS::SecretsManager::Secret \| AWS::EFS::FileSystem \| AWS::EC2::Snapshot \| AWS::ECR::Repository \| AWS::RDS::DBSnapshot \| AWS::RDS::DBClusterSnapshot \| AWS::SNS::Topic \| AWS::S3Express::DirectoryBucket \| AWS::DynamoDB::Table \| AWS::DynamoDB::Stream \| AWS::IAM::User Required: No totalActiveFindings The number of active ﬁndings for the speciﬁed external access analyzer. Type: Integer Required: No totalArchivedFindings The number of archived ﬁndings for the speciﬁed external access analyzer. Type: Integer Required: No totalResolvedFindings The number of resolved ﬁndings for the speciﬁed external access analyzer. Type: Integer ExternalAccessFindingsStatistics API Version 2019-11-01 184 IAM Access Analyzer 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 2019-11-01 185 API Reference IAM Access Analyzer Finding Contains information about a ﬁnding. Contents analyzedAt The time at which the resource was analyzed. Type: Timestamp Required: Yes condition The condition in the analyzed policy statement that resulted in a ﬁnding. Type: String to string map Required: Yes createdAt The time at which the ﬁnding was generated. Type: Timestamp Required: Yes id The ID of the ﬁnding. Type: String Required: Yes resourceOwnerAccount The AWS account ID that owns the resource. Type: String Required: Yes Finding API Version 2019-11-01 186 IAM Access Analyzer resourceType The type of the resource identiﬁed in the ﬁnding. Type: String API Reference Valid Values: AWS::S3::Bucket \| AWS::IAM::Role \| AWS::SQS::Queue \| AWS::Lambda::Function \| AWS::Lambda::LayerVersion \| AWS::KMS::Key \| AWS::SecretsManager::Secret \| AWS::EFS::FileSystem \| AWS::EC2::Snapshot \| AWS::ECR::Repository \| AWS::RDS::DBSnapshot \| AWS::RDS::DBClusterSnapshot \| AWS::SNS::Topic \| AWS::S3Express::DirectoryBucket \| AWS::DynamoDB::Table \| AWS::DynamoDB::Stream \| AWS::IAM::User Required: Yes status The current status of the ﬁnding. Type: String Valid Values: ACTIVE \| ARCHIVED \| RESOLVED Required: Yes updatedAt The time at which the ﬁnding was updated. Type: Timestamp Required: Yes action The action in the analyzed policy statement that an external principal has permission to use. Type: Array of strings Required: No error An error. Contents API Version 2019-11-01 187 IAM Access Analyzer Type: String Required: No isPublic API Reference Indicates whether the policy that generated the ﬁnding allows public access to the resource. Type: Boolean Required: No principal The external principal that has access to a resource within the zone of trust. Type: String to string map Required: No resource The resource that an external principal has access to. Type: String Required: No resourceControlPolicyRestriction The type of restriction applied to the ﬁnding by the resource owner with an Organizations resource control policy (RCP). Type: String Valid Values: APPLICABLE \| FAILED_TO_EVALUATE_RCP \| NOT_APPLICABLE Required: No sources The sources of the ﬁnding. This indicates how the access that generated the ﬁnding is granted. It is populated for Amazon S3 bucket ﬁndings. Type: Array of FindingSource objects Required: No Contents API Version 2019-11-01 188 IAM Access Analyzer 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 2019-11-01 189 IAM Access Analyzer API Reference FindingAggregationAccountDetails Contains information about the ﬁndings for an AWS account in an organization unused access analyzer. Contents account The ID of the AWS account for which unused access ﬁnding details are provided. Type: String Required: No details Provides the number of active ﬁndings for each type of unused access for the speciﬁed AWS account. Type: String to integer map Required: No numberOfActiveFindings The number of active unused access ﬁndings for the speciﬁed AWS account. Type: Integer 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 FindingAggregationAccountDetails API Version 2019-11-01 190 IAM Access Analyzer FindingDetails API Reference Contains information about an external access or unused access ﬁnding. Only one parameter can be used in a FindingDetails object. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. externalAccessDetails The details for an external access analyzer ﬁnding. Type: ExternalAccessDetails object Required: No unusedIamRoleDetails The details for an unused access analyzer ﬁnding with an unused IAM role ﬁnding type. Type: UnusedIamRoleDetails object Required: No unusedIamUserAccessKeyDetails The details for an unused access analyzer ﬁnding with an unused IAM user access key ﬁnding type. Type: UnusedIamUserAccessKeyDetails object Required: No unusedIamUserPasswordDetails The details for an unused access
access-analyzer-api-034	access-analyzer-api.pdf	34	unused access ﬁnding. Only one parameter can be used in a FindingDetails object. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. externalAccessDetails The details for an external access analyzer ﬁnding. Type: ExternalAccessDetails object Required: No unusedIamRoleDetails The details for an unused access analyzer ﬁnding with an unused IAM role ﬁnding type. Type: UnusedIamRoleDetails object Required: No unusedIamUserAccessKeyDetails The details for an unused access analyzer ﬁnding with an unused IAM user access key ﬁnding type. Type: UnusedIamUserAccessKeyDetails object Required: No unusedIamUserPasswordDetails The details for an unused access analyzer ﬁnding with an unused IAM user password ﬁnding type. FindingDetails API Version 2019-11-01 191 IAM Access Analyzer API Reference Type: UnusedIamUserPasswordDetails object Required: No unusedPermissionDetails The details for an unused access analyzer ﬁnding with an unused permission ﬁnding type. Type: UnusedPermissionDetails 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 See Also API Version 2019-11-01 192 IAM Access Analyzer FindingSource API Reference The source of the ﬁnding. This indicates how the access that generated the ﬁnding is granted. It is populated for Amazon S3 bucket ﬁndings. Contents type Indicates the type of access that generated the ﬁnding. Type: String Valid Values: POLICY \| BUCKET_ACL \| S3_ACCESS_POINT \| S3_ACCESS_POINT_ACCOUNT Required: Yes detail Includes details about how the access that generated the ﬁnding is granted. This is populated for Amazon S3 bucket ﬁndings. Type: FindingSourceDetail 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 FindingSource API Version 2019-11-01 193 IAM Access Analyzer API Reference FindingSourceDetail Includes details about how the access that generated the ﬁnding is granted. This is populated for Amazon S3 bucket ﬁndings. Contents accessPointAccount The account of the cross-account access point that generated the ﬁnding. Type: String Required: No accessPointArn The ARN of the access point that generated the ﬁnding. The ARN format depends on whether the ARN represents an access point or a multi-region access point. 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++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FindingSourceDetail API Version 2019-11-01 194 IAM Access Analyzer FindingsStatistics API Reference Contains information about the aggregate statistics for an external or unused access analyzer. Only one parameter can be used in a FindingsStatistics object. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. externalAccessFindingsStatistics The aggregate statistics for an external access analyzer. Type: ExternalAccessFindingsStatistics object Required: No unusedAccessFindingsStatistics The aggregate statistics for an unused access analyzer. Type: UnusedAccessFindingsStatistics 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 FindingsStatistics API Version 2019-11-01 195 IAM Access Analyzer FindingSummary Contains information about a ﬁnding. Contents analyzedAt API Reference The time at which the resource-based policy that generated the ﬁnding was analyzed. Type: Timestamp Required: Yes condition The condition in the analyzed policy statement that resulted in a ﬁnding. Type: String to string map Required: Yes createdAt The time at which the ﬁnding was created. Type: Timestamp Required: Yes id The ID of the ﬁnding. Type: String Required: Yes resourceOwnerAccount The AWS account ID that owns the resource. Type: String Required: Yes FindingSummary API Version 2019-11-01 196 IAM Access Analyzer resourceType API Reference The type of the resource that the external principal has access to. Type: String Valid Values: AWS::S3::Bucket \| AWS::IAM::Role \| AWS::SQS::Queue \| AWS::Lambda::Function \| AWS::Lambda::LayerVersion \| AWS::KMS::Key \| AWS::SecretsManager::Secret \| AWS::EFS::FileSystem \| AWS::EC2::Snapshot \| AWS::ECR::Repository \| AWS::RDS::DBSnapshot \| AWS::RDS::DBClusterSnapshot \| AWS::SNS::Topic \| AWS::S3Express::DirectoryBucket \| AWS::DynamoDB::Table \| AWS::DynamoDB::Stream \| AWS::IAM::User Required: Yes status The status of the ﬁnding. Type: String Valid Values: ACTIVE \| ARCHIVED \| RESOLVED Required: Yes updatedAt The time at which the ﬁnding was most recently updated. Type: Timestamp Required: Yes action The action in the analyzed policy statement that an external principal has permission to use. Type: Array of strings Required: No error The error that resulted in an Error ﬁnding. Contents API Version 2019-11-01 197 IAM Access Analyzer Type: String Required: No isPublic API Reference Indicates whether the ﬁnding reports a resource that has a policy that allows public access. Type: Boolean Required: No principal The external principal that has access to a resource within
access-analyzer-api-035	access-analyzer-api.pdf	35	Valid Values: ACTIVE \| ARCHIVED \| RESOLVED Required: Yes updatedAt The time at which the ﬁnding was most recently updated. Type: Timestamp Required: Yes action The action in the analyzed policy statement that an external principal has permission to use. Type: Array of strings Required: No error The error that resulted in an Error ﬁnding. Contents API Version 2019-11-01 197 IAM Access Analyzer Type: String Required: No isPublic API Reference Indicates whether the ﬁnding reports a resource that has a policy that allows public access. Type: Boolean Required: No principal The external principal that has access to a resource within the zone of trust. Type: String to string map Required: No resource The resource that the external principal has access to. Type: String Required: No resourceControlPolicyRestriction The type of restriction applied to the ﬁnding by the resource owner with an Organizations resource control policy (RCP). Type: String Valid Values: APPLICABLE \| FAILED_TO_EVALUATE_RCP \| NOT_APPLICABLE Required: No sources The sources of the ﬁnding. This indicates how the access that generated the ﬁnding is granted. It is populated for Amazon S3 bucket ﬁndings. Type: Array of FindingSource objects Required: No Contents API Version 2019-11-01 198 IAM Access Analyzer 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 2019-11-01 199 IAM Access Analyzer FindingSummaryV2 Contains information about a ﬁnding. Contents analyzedAt API Reference The time at which the resource-based policy or IAM entity that generated the ﬁnding was analyzed. Type: Timestamp Required: Yes createdAt The time at which the ﬁnding was created. Type: Timestamp Required: Yes id The ID of the ﬁnding. Type: String Required: Yes resourceOwnerAccount The AWS account ID that owns the resource. Type: String Required: Yes resourceType The type of the resource that the external principal has access to. Type: String FindingSummaryV2 API Version 2019-11-01 200 IAM Access Analyzer API Reference Valid Values: AWS::S3::Bucket \| AWS::IAM::Role \| AWS::SQS::Queue \| AWS::Lambda::Function \| AWS::Lambda::LayerVersion \| AWS::KMS::Key \| AWS::SecretsManager::Secret \| AWS::EFS::FileSystem \| AWS::EC2::Snapshot \| AWS::ECR::Repository \| AWS::RDS::DBSnapshot \| AWS::RDS::DBClusterSnapshot \| AWS::SNS::Topic \| AWS::S3Express::DirectoryBucket \| AWS::DynamoDB::Table \| AWS::DynamoDB::Stream \| AWS::IAM::User Required: Yes status The status of the ﬁnding. Type: String Valid Values: ACTIVE \| ARCHIVED \| RESOLVED Required: Yes updatedAt The time at which the ﬁnding was most recently updated. Type: Timestamp Required: Yes error The error that resulted in an Error ﬁnding. Type: String Required: No ﬁndingType The type of the external access or unused access ﬁnding. Type: String Valid Values: ExternalAccess \| UnusedIAMRole \| UnusedIAMUserAccessKey \| UnusedIAMUserPassword \| UnusedPermission Contents API Version 2019-11-01 201 IAM Access Analyzer Required: No resource The resource that the external principal has access to. API Reference 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++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2019-11-01 202 IAM Access Analyzer GeneratedPolicy Contains the text for the generated policy. Contents policy API Reference The text to use as the content for the new policy. The policy is created using the CreatePolicy action. Type: String 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 GeneratedPolicy API Version 2019-11-01 203 IAM Access Analyzer API Reference GeneratedPolicyProperties Contains the generated policy details. Contents principalArn The ARN of the IAM entity (user or role) for which you are generating a policy. Type: String Pattern: arn:[^:]:iam::[^:]:(role\|user)/.{1,576} Required: Yes cloudTrailProperties Lists details about the Trail used to generated policy. Type: CloudTrailProperties object Required: No isComplete This value is set to true if the generated policy contains all possible actions for a service that IAM Access Analyzer identiﬁed from the CloudTrail trail that you speciﬁed, and false otherwise. Type: Boolean 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 GeneratedPolicyProperties API Version 2019-11-01 204 IAM Access Analyzer API Reference See Also API Version 2019-11-01 205 IAM Access Analyzer API Reference GeneratedPolicyResult Contains the text for the generated policy and its details. Contents properties A GeneratedPolicyProperties object that contains properties of the generated policy. Type: GeneratedPolicyProperties object Required: Yes generatedPolicies The text to use as the content for the new policy. The policy is created using the CreatePolicy action. Type: Array of GeneratedPolicy objects Required: No See Also For more information about using this API in one of the language-speciﬁc
access-analyzer-api-036	access-analyzer-api.pdf	36	SDK for Java V2 • AWS SDK for Ruby V3 GeneratedPolicyProperties API Version 2019-11-01 204 IAM Access Analyzer API Reference See Also API Version 2019-11-01 205 IAM Access Analyzer API Reference GeneratedPolicyResult Contains the text for the generated policy and its details. Contents properties A GeneratedPolicyProperties object that contains properties of the generated policy. Type: GeneratedPolicyProperties object Required: Yes generatedPolicies The text to use as the content for the new policy. The policy is created using the CreatePolicy action. Type: Array of GeneratedPolicy objects 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 GeneratedPolicyResult API Version 2019-11-01 206 IAM Access Analyzer API Reference IamRoleConﬁguration The proposed access control conﬁguration for an IAM role. You can propose a conﬁguration for a new IAM role or an existing IAM role that you own by specifying the trust policy. If the conﬁguration is for a new IAM role, you must specify the trust policy. If the conﬁguration is for an existing IAM role that you own and you do not propose the trust policy, the access preview uses the existing trust policy for the role. The proposed trust policy cannot be an empty string. For more information about role trust policy limits, see IAM and AWS STS quotas. Contents trustPolicy The proposed trust policy for the IAM role. 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++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IamRoleConﬁguration API Version 2019-11-01 207 IAM Access Analyzer InlineArchiveRule API Reference An criterion statement in an archive rule. Each archive rule may have multiple criteria. Contents ﬁlter The condition and values for a criterion. Type: String to Criterion object map Required: Yes ruleName The name of the rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [A-Za-z][A-Za-z0-9_.-]* 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 InlineArchiveRule API Version 2019-11-01 208 IAM Access Analyzer API Reference InternetConﬁguration This conﬁguration sets the network origin for the Amazon S3 access point or multi-region access point to Internet. Contents The members of this exception structure are context-dependent. 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 InternetConﬁguration API Version 2019-11-01 209 IAM Access Analyzer JobDetails Contains details about the policy generation request. Contents jobId API Reference The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request. Type: String Required: Yes startedOn A timestamp of when the job was started. Type: Timestamp Required: Yes status The status of the job request. Type: String Valid Values: IN_PROGRESS \| SUCCEEDED \| FAILED \| CANCELED Required: Yes completedOn A timestamp of when the job was completed. Type: Timestamp Required: No jobError The job error for the policy generation request. JobDetails API Version 2019-11-01 210 IAM Access Analyzer Type: JobError object 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 2019-11-01 211 IAM Access Analyzer JobError Contains the details about the policy generation error. API Reference Contents code The job error code. Type: String Valid Values: AUTHORIZATION_ERROR \| RESOURCE_NOT_FOUND_ERROR \| SERVICE_QUOTA_EXCEEDED_ERROR \| SERVICE_ERROR Required: Yes message Speciﬁc information about the error. For example, which service quota was exceeded or which resource was not found. Type: String 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 JobError API Version 2019-11-01 212 IAM Access Analyzer API Reference KmsGrantConﬁguration A proposed grant conﬁguration for a KMS key. For more information, see CreateGrant. Contents granteePrincipal The principal that is given permission to perform the operations that the grant permits. Type: String Required: Yes issuingAccount The AWS account under which the grant was issued. The account is used to propose AWS KMS grants issued by accounts other than the owner of the key. Type: String Required: Yes operations A list of operations that
access-analyzer-api-037	access-analyzer-api.pdf	37	• AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JobError API Version 2019-11-01 212 IAM Access Analyzer API Reference KmsGrantConﬁguration A proposed grant conﬁguration for a KMS key. For more information, see CreateGrant. Contents granteePrincipal The principal that is given permission to perform the operations that the grant permits. Type: String Required: Yes issuingAccount The AWS account under which the grant was issued. The account is used to propose AWS KMS grants issued by accounts other than the owner of the key. Type: String Required: Yes operations A list of operations that the grant permits. Type: Array of strings Valid Values: CreateGrant \| Decrypt \| DescribeKey \| Encrypt \| GenerateDataKey \| GenerateDataKeyPair \| GenerateDataKeyPairWithoutPlaintext \| GenerateDataKeyWithoutPlaintext \| GetPublicKey \| ReEncryptFrom \| ReEncryptTo \| RetireGrant \| Sign \| Verify Required: Yes constraints Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the speciﬁed encryption context. Type: KmsGrantConstraints object Required: No KmsGrantConﬁguration API Version 2019-11-01 213 IAM Access Analyzer retiringPrincipal API Reference The principal that is given permission to retire the grant by using RetireGrant operation. 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++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2019-11-01 214 IAM Access Analyzer API Reference KmsGrantConstraints Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the speciﬁed encryption context. You can specify only one type of encryption context. An empty map is treated as not speciﬁed. For more information, see GrantConstraints. Contents encryptionContextEquals A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context speciﬁed in this constraint. Type: String to string map Required: No encryptionContextSubset A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs speciﬁed in this constraint, although it can include additional key-value pairs. Type: String to string map 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 KmsGrantConstraints API Version 2019-11-01 215 IAM Access Analyzer API Reference KmsKeyConﬁguration Proposed access control conﬁguration for a KMS key. You can propose a conﬁguration for a new KMS key or an existing KMS key that you own by specifying the key policy and AWS KMS grant conﬁguration. If the conﬁguration is for an existing key and you do not specify the key policy, the access preview uses the existing policy for the key. If the access preview is for a new resource and you do not specify the key policy, then the access preview uses the default key policy. The proposed key policy cannot be an empty string. For more information, see Default key policy. For more information about key policy limits, see Resource quotas. Contents grants A list of proposed grant conﬁgurations for the KMS key. If the proposed grant conﬁguration is for an existing key, the access preview uses the proposed list of grant conﬁgurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key. Type: Array of KmsGrantConﬁguration objects Required: No keyPolicies Resource policy conﬁguration for the KMS key. The only valid value for the name of the key policy is default. For more information, see Default key policy. Type: String to string map 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 KmsKeyConﬁguration API Version 2019-11-01 216 IAM Access Analyzer API Reference See Also API Version 2019-11-01 217 IAM Access Analyzer Location API Reference A location in a policy that is represented as a path through the JSON representation and a corresponding span. Contents path A path in a policy, represented as a sequence of path elements. Type: Array of PathElement objects Required: Yes span A span in a policy. Type: Span object 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 Location API Version 2019-11-01 218 IAM Access Analyzer API Reference NetworkOriginConﬁguration The proposed InternetConfiguration

Subsets and Splits

No community queries yet

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