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 find this with the ListDeploymentStrategies API call. • Configuration Profile ID: ID of CustomerManagedAlarms; you can find this with the ListConfigurationProfiles API call. • Configuration Version: The version of the configuration profile to be deployed. Alarm Manager configuration profiles Vers...
accelerate-guide-120
accelerate-guide.pdf
120
in CloudWatch indefinitely until you manually remove it using CloudWatch. Disabling the default Accelerate alarm configuration AMS Accelerate provides the default configuration profile in your account based on the baseline alarms. However, this default configuration can be disabled by overriding any of the alarm definitions....
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 h...
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 t...
accelerate-guide-123
accelerate-guide.pdf
123
Description Definition specific 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-acc...
accelerate-guide-124
accelerate-guide.pdf
124
Key benefits 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 OpsIte...
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 configuration for single or multiple accounts. • Member accounts: These are the accounts linked to the delegated administrator account. These accounts inheri...
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 preconfigured parameters, see Configure Trusted Advisor check remediation in Trusted Remediator. Trusted Advisor cost optimization checks supported by Tru...
accelerate-guide-127
accelerate-guide.pdf
127
If the instance type was modified within a specified 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 ...
accelerate-guide-128
accelerate-guide.pdf
128
Concepts and Procedures Check ID and name SSM document name and expected outcome Supported preconfigured parameters and constraints Hs4Ma3G245 - AWS CloudForm AWSManagedServices-EnableCF NStackNotification NotificationARNs: The ARNs of the Amazon SNS topics to be associate Associate a CloudFormation stack with an Amazon S...
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 CreateAMIBeforeTerminat...
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 preconfigured parameters and constraints AWSManagedServices-Enable...
accelerate-guide-131
accelerate-guide.pdf
131
this feature to understand the performance profile and the impact of TLS. Hs4Ma3G194 - Amazon RDS AWSManagedServices-DisableP ublicAccessOnRDSSnapshotV2 No preconfigured parameters are allowed. Public access for Amazon RDS No constraints snapshot is disabled. snapshot should be private Corresponding AWS Security Hub chec...
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 configured to copy tags to snapshots Corresponding AWS Security Hub check: RDS.16 Hs4Ma3G16 4 - RDS DB AWSManagedServices-UpdateRD SCopyTagsToSnapshots No preconfigured parameters are allowed. instances should...
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 preconfigured parameters and constraints AWSManagedServices-TrustedR emediatorBlockS3BucketPubli No preconfigured parameters are allowed. Pfx0RwqBli Amazon S3 Bucket Permissio cAccess ns...
accelerate-guide-134
accelerate-guide.pdf
134
and expected outcome Supported preconfigured parameters and constraints Valid values are SimplePre fix , PartitionedPrefixE ventTime and Partition edPrefixDeliveryTime (case-sensitive). To enable auto remediation, the following preconfigured parameters must be provided: • TargetBucket The destination bucket must be in th...
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 preconfigured parameter...
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: T...
accelerate-guide-137
accelerate-guide.pdf
137
uses your default AWS KMS key. No constraints Configure Trusted Advisor check remediation in Trusted Remediator Configurations are stored in AWS AppConfig as part of the Trusted Remediator application. Each Trusted Advisor check category has a separate configuration profile. For more information on Trusted Advisor categorie...
accelerate-guide-138
accelerate-guide.pdf
138
regardless of their tags. By adding a specific 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 configuration and the resource tagging settings. So, if you set the default execution mode to Automated, Ma...
accelerate-guide-139
accelerate-guide.pdf
139
2. Select Trusted Remediator from the list of applications. 3. Choose the Cost Optimization configuration profile. 4. 5. Select the Underutilized Amazon EBS Volumes flag. For execution-mode, select Automated. Configure remediation tutorials Version May 08, 2025 442 AMS Accelerate User Guide AMS Accelerate Concepts and Proc...
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, comple...
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 files 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...
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 sou...
accelerate-guide-143
accelerate-guide.pdf
143
reporting dashboards in QuickSight. Who configures the remediations? You own the configurations in your account. Managing your configurations is your responsibility. You can reach out to your CA or CDSM for help managing your configurations. You can also reach out to AMS through a service request for configuration support, ...
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 Config. 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 A...
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 a...
accelerate-guide-146
accelerate-guide.pdf
146
(such as AMS investigates affected 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 Th...
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, verifies CoreDNS configura tion, verifies DNS endpoints that poin...
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...
accelerate-guide-149
accelerate-guide.pdf
149
• AMS backup monitoring and reporting How continuity management works in AMS AMS backup plans define 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...
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 f...
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...
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...
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 defined by a tag or tags for a group of instances. Yo...
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 Cl...
accelerate-guide-155
accelerate-guide.pdf
155
Input parameters section, fill 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 p...
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 (S...
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 defined as product = * mean that all patches are applied to the instance of all security and classifications. Custom patch baseline with AMS Accelerat...
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 S...
accelerate-guide-159
accelerate-guide.pdf
159
the following configuration: { "source": [ "aws.managedservices" ], "detail-type": [ "AMS Patch Window Execution State Change" ], "detail": { "State": ["PREEMPTIVE"] } } Patch notifications through CloudWatch Events Version May 08, 2025 507 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures Note Patch failu...
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 permi...
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 CloudForma...
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 Re...
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 t...
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 th...
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 n...
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...
accelerate-guide-167
accelerate-guide.pdf
167
flow 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 ...
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 identifie r of the resource that is trying to access. The format is UNIQUE_ID ENTIFIER :RESOURCE_ NAME . For details see unique identifiers. You can run the q...
accelerate-guide-169
accelerate-guide.pdf
169
Region that gets the request • EventId: CloudTrail Event ID and so forth. All fields associated with the event are also returned. Fields are blank if not applicable for that event. The ActionedBy filter is disabled, by default; to enable it, remove "-- " from that line. By default, the ActionedB y filter is disabled (it w...
accelerate-guide-170
accelerate-guide.pdf
170
both the datetime and eventtime filter 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 mo...
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 Accelerat...
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 off • c1qf5bt030 - Amazon RDS innodb_flush_log_a t_trx_commit parameter is not 1 Version May 08, 2025 550 AMS Accelerate User Guide AMS Accelerate Concepts and Procedures • c1qf5bt...
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 Configuration4 • Hs4Ma3G158 - SSM documents should not be public • Hs4Ma3G319 - Network Firewall firewalls should have deletion protection enabled Updat...
accelerate-guide-174
accelerate-guide.pdf
174
alerts alerts table for Amazon EKS table. monitoring. Updated: Alarm Manager Configuration Profiles. Added notes about creating Anomaly Detection alarms April 25, 2024 with Alarm Manager. Additions to Resource Tagger configuration profiles. DynamoDB tables and Amazon S3 buckets are now April 25, 2024 Added Planned Event Ma...
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 Enterpr...
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 Configuration Profiles Added AWS Outp...
accelerate-guide-177
accelerate-guide.pdf
177
AMS Config Rules Response Configuration report. May 26, 2023 Updated: Service Billing Start Date policy. Updated definitions 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 d...
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)...
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 ...
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 De...
accelerate-guide-181
accelerate-guide.pdf
181
Continuity management in AMS Accelerate March 10, 2022 March 10, 2022 Updated content: Access Management Removed Advanced-specific instructions from Accelerate guidance How and when to use the March 10, 2022 root user account in AMS. Updated content: Supported Configurations AMS now supports Oracle Linux 8.3 and Ubuntu 1...
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 affiliates. All rights reserved. IAM Access Analyzer API Reference IAM Access Analyzer: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and ...
access-analyzer-api-002
access-analyzer-api.pdf
2
IAM Access Analyzer API Reference Response Syntax ................................................................................................................................... 64 Response Elements ........................................................................................................................
access-analyzer-api-003
access-analyzer-api.pdf
3
................................................................................................................................................. 152 Contents ............................................................................................................................................... 152 See Also .......
access-analyzer-api-004
access-analyzer-api.pdf
4
Also ................................................................................................................................................ 256 Trail ............................................................................................................................................................. 25...
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 specified 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...
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 specified policy doesn't allow any of the specified permissions in the access object. If the result is FAIL, the ...
access-analyzer-api-007
access-analyzer-api.pdf
7
For more information about using this API in one of the language-specific 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 ...
access-analyzer-api-008
access-analyzer-api.pdf
8
configuration for your resource that is used to generate the access preview. The access preview includes findings for external access allowed to the resource with the proposed access control configuration. The configuration must contain exactly one element. Type: String to Configuration object map Required: Yes Response Syn...
access-analyzer-api-009
access-analyzer-api.pdf
9
Common Errors. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException A conflict exception error. HTTP Status Code: 409 InternalServerException Internal server error. HTTP Status Code: 500 ServiceQuotaExceededException Service quote met error. HTTP Status Cod...
access-analyzer-api-010
access-analyzer-api.pdf
10
sufficient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ResourceNotFoundException The specified resource could not be found. HTTP Status Code: 404 ThrottlingException Throttling limit exceeded error. HTTP Status Code: 429 ValidationException Vali...
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 ...
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 informatio...
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 th...
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 finding statistics for an external access or unused access analyzer. Request Syntax POST /analyzer/findings/statistics HTTP/1.1 Content-type: application/json { "ana...
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...
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 d...
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 specified type that ha...
access-analyzer-api-018
access-analyzer-api.pdf
18
of the language-specific 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 ...
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. findings A list of findings retrieved from the analyzer that match the filter criteria specified, if any. Response Elements API Version 2019-11-01 96 IAM Access Analyzer ...
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=pri...
access-analyzer-api-021
access-analyzer-api.pdf
21
clientToken A unique, case-sensitive identifier 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 ...
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....
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 sufficient access to perform this action. HTTP Status Code: 403 ConflictException A conflict exception error. HTTP Status Code: 409 InternalServerException Internal server error. Response Syntax ...
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 sufficient access to perform this action. API Reference HTTP Status Code: 403 InternalServerException Internal server error. HTTP ...
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 sufficient access to perform this action. HTTP Status Code: 403 InternalServerException Internal server error. HTTP Status Code: 500 ThrottlingExcep...
access-analyzer-api-026
access-analyzer-api.pdf
26
is in progress. • Completed - The access preview is complete. You can preview findings 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 p...
access-analyzer-api-027
access-analyzer-api.pdf
27
language-specific 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 pre...
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 prefixed with aws:. For the tag value, you can specify a value that is 0 to 256 characters in length. If the specified tag value is 0 characters, the rule is applied to all principals with the specified tag key. Type: Array of str...
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 findings. The analyzer is Disabled when a user action, such as removing trusted access fo...
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...
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 configuration is for an existing DynamoDB stream and you do not specify the DynamoDB policy, then the access preview uses the existing DynamoDB policy ...
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-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ru...
access-analyzer-api-033
access-analyzer-api.pdf
33
183 IAM Access Analyzer API Reference ExternalAccessFindingsStatistics Provides aggregate statistics about the findings for the specified external access analyzer. Contents resourceTypeStatistics The total number of active cross-account and public findings for each resource type of the specified external access analyzer. T...
access-analyzer-api-034
access-analyzer-api.pdf
34
unused access finding. 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 specified when used or returned. externalAccessDetails The details for an external access analyzer finding. Type: ExternalAccessDetails object Required...
access-analyzer-api-035
access-analyzer-api.pdf
35
Valid Values: ACTIVE | ARCHIVED | RESOLVED Required: Yes updatedAt The time at which the finding 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 ...
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 GeneratedPolicyProper...
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 KmsGrantConfiguration A proposed grant configuration for a KMS key. For more information, see CreateGrant. Contents granteePrincipal The principal that is given permission to perform the ope...