String analyzerArn
The ARN of the analyzer used to generate the access preview.
Map<K,V> configurations
A map of resource ARNs for the proposed resource configuration.
Date createdAt
The time at which the access preview was created.
String id
The unique ID for the access preview.
String status
The status of the access preview.
Creating - The access preview creation 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.
AccessPreviewStatusReason 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 configuration.
List<E> action
The action in the analyzed policy statement that an external principal has permission to perform.
String changeType
Provides context on how the access preview finding compares to existing access identified in Access Analyzer.
New - The finding is for newly-introduced access.
Unchanged - The preview finding is an existing finding that would remain unchanged.
Changed - The preview finding is an existing finding with a change in status.
For example, a Changed finding with preview status Resolved and existing status
Active indicates the existing Active finding would become Resolved as a
result of the proposed permissions change.
Map<K,V> condition
The condition in the analyzed policy statement that resulted in a finding.
Date createdAt
The time at which the access preview finding was created.
String error
An error.
String existingFindingId
The existing ID of the finding in Access Analyzer, provided only for existing findings.
String existingFindingStatus
The existing status of the finding, provided only for existing findings.
String id
The ID of the access preview finding. This ID uniquely identifies the element in the list of access preview findings and is not related to the finding ID in Access Analyzer.
Boolean isPublic
Indicates whether the policy that generated the finding allows public access to the resource.
Map<K,V> principal
The external principal that has access to a resource within the zone of trust.
String resource
The resource that an external principal has access to. This is the resource associated with the access preview.
String resourceOwnerAccount
The AWS account ID that owns the resource. For most AWS resources, the owning account is the account in which the resource was created.
String resourceType
The type of the resource that can be accessed in the finding.
List<E> sources
The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.
String status
The preview status of the finding. This is what the status of the finding would be after permissions deployment.
For example, a Changed finding with preview status Resolved and existing status
Active indicates the existing Active finding would become Resolved as a
result of the proposed permissions change.
String code
The reason code for the current status of the access preview.
String analyzerArn
The ARN of the analyzer used to generate the access preview.
Date createdAt
The time at which the access preview was created.
String id
The unique ID for the access preview.
String status
The status of the access preview.
Creating - The access preview creation is in progress.
Completed - The access preview is complete and previews the findings for external access to the
resource.
Failed - The access preview creation has failed.
AccessPreviewStatusReason statusReason
List<E> actions
The actions that an external principal is granted permission to use by the policy that generated the finding.
Date analyzedAt
The time at which the resource was analyzed.
Date createdAt
The time at which the finding was created.
String error
An error message.
Boolean isPublic
Indicates whether the policy that generated the finding grants public access to the resource.
String resourceArn
The ARN of the resource that was analyzed.
String resourceOwnerAccount
The AWS account ID that owns the resource.
String resourceType
The type of the resource that was analyzed.
List<E> sharedVia
Indicates how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.
String status
The current status of the finding generated from the analyzed resource.
Date updatedAt
The time at which the finding was updated.
String arn
The ARN of the analyzer.
Date createdAt
A timestamp for the time at which the analyzer was created.
String lastResourceAnalyzed
The resource that was most recently analyzed by the analyzer.
Date lastResourceAnalyzedAt
The time at which the most recently analyzed resource was analyzed.
String name
The name of the analyzer.
String 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
for AWS IAM Access Analyzer from AWS Organizations, causes the analyzer to stop generating new findings. The
status is Creating when the analyzer creation is in progress and Failed when the
analyzer creation has failed.
StatusReason 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 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.
Map<K,V> tags
The tags added to the analyzer.
String type
The type of analyzer, which corresponds to the zone of trust chosen for the analyzer.
String 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.
String accessRole
The ARN of the service role that Access Analyzer uses to access your CloudTrail trail and service last accessed information.
Date endTime
The end of the time range for which 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.
Date startTime
The start of the time range for which Access Analyzer reviews your CloudTrail events. Events with a timestamp before this time are not considered to generate a policy.
List<E> trails
A Trail object that contains settings for a trail.
Date endTime
The end of the time range for which 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.
Date startTime
The start of the time range for which Access Analyzer reviews your CloudTrail events. Events with a timestamp before this time are not considered to generate a policy.
List<E> trailProperties
A TrailProperties object that contains settings for trail properties.
IamRoleConfiguration iamRole
The access control configuration is for an IAM role.
KmsKeyConfiguration kmsKey
The access control configuration is for a KMS key.
S3BucketConfiguration s3Bucket
The access control configuration is for an Amazon S3 Bucket.
SecretsManagerSecretConfiguration secretsManagerSecret
The access control configuration is for a Secrets Manager secret.
SqsQueueConfiguration sqsQueue
The access control configuration is for an SQS queue.
String 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.
String clientToken
A client token.
Map<K,V> configurations
Access control 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.
String id
The unique ID for the access preview.
String analyzerName
The name of the analyzer to create.
List<E> archiveRules
Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.
String clientToken
A client token.
Map<K,V> tags
The tags to apply to the analyzer.
String type
The type of analyzer to create. Only ACCOUNT and ORGANIZATION analyzers are supported. You can create only one analyzer per account per Region. You can create up to 5 analyzers per organization per Region.
String arn
The ARN of the analyzer that was created by the request.
List<E> contains
A "contains" operator to match for the filter used to create the rule.
List<E> eq
An "equals" operator to match for the filter used to create the rule.
Boolean exists
An "exists" operator to match for the filter used to create the rule.
List<E> neq
A "not equals" operator to match for the filter used to create the rule.
List<E> action
The action in the analyzed policy statement that an external principal has permission to use.
Date analyzedAt
The time at which the resource was analyzed.
Map<K,V> condition
The condition in the analyzed policy statement that resulted in a finding.
Date createdAt
The time at which the finding was generated.
String error
An error.
String id
The ID of the finding.
Boolean isPublic
Indicates whether the policy that generated the finding allows public access to the resource.
Map<K,V> principal
The external principal that access to a resource within the zone of trust.
String resource
The resource that an external principal has access to.
String resourceOwnerAccount
The AWS account ID that owns the resource.
String resourceType
The type of the resource identified in the finding.
List<E> sources
The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.
String status
The current status of the finding.
Date updatedAt
The time at which the finding was updated.
FindingSourceDetail detail
Includes details about how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.
String type
Indicates the type of access that generated the finding.
String accessPointArn
The ARN of the access point that generated the finding.
List<E> action
The action in the analyzed policy statement that an external principal has permission to use.
Date analyzedAt
The time at which the resource-based policy that generated the finding was analyzed.
Map<K,V> condition
The condition in the analyzed policy statement that resulted in a finding.
Date createdAt
The time at which the finding was created.
String error
The error that resulted in an Error finding.
String id
The ID of the finding.
Boolean isPublic
Indicates whether the finding reports a resource that has a policy that allows public access.
Map<K,V> principal
The external principal that has access to a resource within the zone of trust.
String resource
The resource that the external principal has access to.
String resourceOwnerAccount
The AWS account ID that owns the resource.
String resourceType
The type of the resource that the external principal has access to.
List<E> sources
The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.
String status
The status of the finding.
Date updatedAt
The time at which the finding was most recently updated.
String policy
The text to use as the content for the new policy. The policy is created using the CreatePolicy action.
CloudTrailProperties cloudTrailProperties
Lists details about the Trail used to generated policy.
Boolean isComplete
This value is set to true if the generated policy contains all possible actions for a service that
Access Analyzer identified from the CloudTrail trail that you specified, and false otherwise.
String principalArn
The ARN of the IAM entity (user or role) for which you are generating a policy.
List<E> generatedPolicies
The text to use as the content for the new policy. The policy is created using the CreatePolicy action.
GeneratedPolicyProperties properties
A GeneratedPolicyProperties object that contains properties of the generated policy.
String accessPreviewId
The unique ID for the access preview.
String analyzerArn
The ARN of the analyzer used to generate the access preview.
AccessPreview accessPreview
An object that contains information about the access preview.
String analyzerArn
The ARN of the analyzer to retrieve information from.
String resourceArn
The ARN of the resource to retrieve information about.
AnalyzedResource resource
An AnalyzedResource object that contains information that Access Analyzer found when it analyzed the
resource.
String analyzerName
The name of the analyzer retrieved.
AnalyzerSummary analyzer
An AnalyzerSummary object that contains information about the analyzer.
ArchiveRuleSummary archiveRule
String analyzerArn
The ARN of the analyzer that generated the finding.
String id
The ID of the finding to retrieve.
Finding finding
A finding object that contains finding details.
Boolean 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 "*".
Boolean includeServiceLevelTemplate
The level of detail that you want to generate. You can specify whether to generate service-level policies.
Access Analyzer uses iam:servicelastaccessed to identify services that have been used recently to
create this service-level template.
String 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.
GeneratedPolicyResult generatedPolicyResult
A GeneratedPolicyResult object that contains the generated policies and associated details.
JobDetails jobDetails
A GeneratedPolicyDetails object that contains details about the generated policy.
String trustPolicy
The proposed trust policy for the IAM role.
Integer retryAfterSeconds
The seconds to wait to retry.
Date completedOn
A timestamp of when the job was completed.
JobError jobError
String 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.
Date startedOn
A timestamp of when the job was started.
String status
The status of the job request.
KmsGrantConstraints constraints
Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption context.
String granteePrincipal
The principal that is given permission to perform the operations that the grant permits.
String issuingAccount
The AWS account under which the grant was issued. The account is used to propose KMS grants issued by accounts other than the owner of the key.
List<E> operations
A list of operations that the grant permits.
String retiringPrincipal
The principal that is given permission to retire the grant by using RetireGrant operation.
Map<K,V> 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 specified in this constraint.
Map<K,V> 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 specified in this constraint, although it can include additional key-value pairs.
List<E> grants
A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.
Map<K,V> keyPolicies
Resource policy configuration for the KMS key. The only valid value for the name of the key policy is
default. For more information, see Default key
policy.
String accessPreviewId
The unique ID for the access preview.
String analyzerArn
The ARN of the analyzer used to generate the access.
Map<K,V> filter
Criteria to filter the returned findings.
Integer maxResults
The maximum number of results to return in the response.
String nextToken
A token used for pagination of results returned.
String analyzerArn
The ARN of the analyzer used to generate the access preview.
Integer maxResults
The maximum number of results to return in the response.
String nextToken
A token used for pagination of results returned.
String analyzerArn
The ARN of the analyzer to retrieve a list of analyzed resources from.
Integer maxResults
The maximum number of results to return in the response.
String nextToken
A token used for pagination of results returned.
String resourceType
The type of resource.
String analyzerArn
The ARN of the analyzer to retrieve findings from.
Map<K,V> filter
A filter to match for the findings to return.
Integer maxResults
The maximum number of results to return in the response.
String nextToken
A token used for pagination of results returned.
SortCriteria sort
The sort order for the findings returned.
Integer maxResults
The maximum number of results to return in the response.
String nextToken
A token used for pagination of results returned.
String principalArn
The ARN of the IAM entity (user or role) for which you are generating a policy. Use this with
ListGeneratedPolicies to filter the results to only include results for a specific principal.
String resourceArn
The ARN of the resource to retrieve tags from.
InternetConfiguration internetConfiguration
The configuration for the Amazon S3 access point with an Internet origin.
VpcConfiguration vpcConfiguration
Date completedOn
A timestamp of when the policy generation was completed.
String 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.
String principalArn
The ARN of the IAM entity (user or role) for which you are generating a policy.
Date startedOn
A timestamp of when the policy generation started.
String status
The status of the policy generation request.
String principalArn
The ARN of the IAM entity (user or role) for which you are generating a policy.
String accessPointPolicy
The access point policy.
NetworkOriginConfiguration networkOrigin
The proposed Internet and VpcConfiguration to apply to this Amazon S3 access point. If
the access preview is for a new resource and neither is specified, the access preview uses Internet
for the network origin. If the access preview is for an existing resource and neither is specified, the access
preview uses the exiting network origin.
S3PublicAccessBlockConfiguration publicAccessBlock
The proposed S3PublicAccessBlock configuration to apply to this Amazon S3 Access Point.
AclGrantee grantee
The grantee to whom you’re assigning access rights.
String permission
The permissions being granted.
Map<K,V> accessPoints
The configuration of Amazon S3 access points for the bucket.
List<E> bucketAclGrants
The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL grants per bucket. If the proposed grant configuration is for an existing bucket, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the bucket.
String bucketPolicy
The proposed bucket policy for the Amazon S3 bucket.
S3PublicAccessBlockConfiguration bucketPublicAccessBlock
The proposed block public access configuration for the Amazon S3 bucket.
String queuePolicy
The proposed resource policy for the SQS queue.
String 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 original successful request and they have no additional effect.
If you do not specify a client token, one is automatically generated by the AWS SDK.
CloudTrailDetails cloudTrailDetails
A CloudTrailDetails object that contains details about a Trail that you want to analyze
to generate policies.
PolicyGenerationDetails policyGenerationDetails
Contains the ARN of the IAM entity (user or role) for which you are generating a policy.
String 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.
String analyzerArn
The ARN of the analyzer to use to scan the policies applied to the specified resource.
String resourceArn
The ARN of the resource to scan.
String code
The reason code for the current status of the analyzer.
Integer retryAfterSeconds
The seconds to wait to retry.
Boolean allRegions
Possible values are true or false. If set to true, Access Analyzer
retrieves CloudTrail data from all regions to analyze and generate a policy.
String cloudTrailArn
Specifies the ARN of the trail. The format of a trail ARN is
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.
List<E> regions
A list of regions to get CloudTrail data from and analyze to generate a policy.
Boolean allRegions
Possible values are true or false. If set to true, Access Analyzer
retrieves CloudTrail data from all regions to analyze and generate a policy.
String cloudTrailArn
Specifies the ARN of the trail. The format of a trail ARN is
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.
List<E> regions
A list of regions to get CloudTrail data from and analyze to generate a policy.
String analyzerName
The name of the analyzer to update the archive rules for.
String clientToken
A client token.
Map<K,V> filter
A filter to match for the rules to update. Only rules that match the filter are updated.
String ruleName
The name of the rule to update.
String analyzerArn
The ARN of the analyzer that generated the findings to update.
String clientToken
A client token.
List<E> ids
The IDs of the findings to update.
String resourceArn
The ARN of the resource identified in the finding.
String status
The state represents the action to take to update the finding Status. Use ARCHIVE to change an
Active finding to an Archived finding. Use ACTIVE to change an Archived finding to an Active
finding.
String findingDetails
A localized message that explains the finding and provides guidance on how to address it.
String findingType
The impact of the finding.
Security warnings report when the policy allows access that we consider overly permissive.
Errors report when a part of the policy is not functional.
Warnings report non-security issues when a policy does not conform to policy writing best practices.
Suggestions recommend stylistic improvements in the policy that do not impact access.
String issueCode
The issue code provides an identifier of the issue associated with this finding.
String learnMoreLink
A link to additional documentation about the type of finding.
List<E> locations
The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.
String locale
The locale to use for localizing the findings.
Integer maxResults
The maximum number of results to return in the response.
String nextToken
A token used for pagination of results returned.
String policyDocument
The JSON policy document to use as the content for the policy.
String 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. They also include service-control policies (SCPs) that are attached to an AWS organization, organizational unit (OU), or an account.
Resource policies grant permissions on AWS resources. Resource policies include trust policies for IAM roles and bucket policies for S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or S3 bucket policy.
String vpcId
If this field is specified, this access point will only allow connections from the specified VPC ID.
Copyright © 2021. All rights reserved.