aws-sdk
Version:
AWS SDK for JavaScript
924 lines • 103 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class AccessAnalyzer extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: AccessAnalyzer.Types.ClientConfiguration)
config: Config & AccessAnalyzer.Types.ClientConfiguration;
/**
* Retroactively applies the archive rule to existing findings that meet the archive rule criteria.
*/
applyArchiveRule(params: AccessAnalyzer.Types.ApplyArchiveRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Retroactively applies the archive rule to existing findings that meet the archive rule criteria.
*/
applyArchiveRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Cancels the requested policy generation.
*/
cancelPolicyGeneration(params: AccessAnalyzer.Types.CancelPolicyGenerationRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.CancelPolicyGenerationResponse) => void): Request<AccessAnalyzer.Types.CancelPolicyGenerationResponse, AWSError>;
/**
* Cancels the requested policy generation.
*/
cancelPolicyGeneration(callback?: (err: AWSError, data: AccessAnalyzer.Types.CancelPolicyGenerationResponse) => void): Request<AccessAnalyzer.Types.CancelPolicyGenerationResponse, AWSError>;
/**
* Checks whether the specified access isn't allowed by a policy.
*/
checkAccessNotGranted(params: AccessAnalyzer.Types.CheckAccessNotGrantedRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.CheckAccessNotGrantedResponse) => void): Request<AccessAnalyzer.Types.CheckAccessNotGrantedResponse, AWSError>;
/**
* Checks whether the specified access isn't allowed by a policy.
*/
checkAccessNotGranted(callback?: (err: AWSError, data: AccessAnalyzer.Types.CheckAccessNotGrantedResponse) => void): Request<AccessAnalyzer.Types.CheckAccessNotGrantedResponse, AWSError>;
/**
* Checks whether new access is allowed for an updated policy when compared to the existing policy. You can find 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.
*/
checkNoNewAccess(params: AccessAnalyzer.Types.CheckNoNewAccessRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.CheckNoNewAccessResponse) => void): Request<AccessAnalyzer.Types.CheckNoNewAccessResponse, AWSError>;
/**
* Checks whether new access is allowed for an updated policy when compared to the existing policy. You can find 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.
*/
checkNoNewAccess(callback?: (err: AWSError, data: AccessAnalyzer.Types.CheckNoNewAccessResponse) => void): Request<AccessAnalyzer.Types.CheckNoNewAccessResponse, AWSError>;
/**
* Checks whether a resource policy can grant public access to the specified resource type.
*/
checkNoPublicAccess(params: AccessAnalyzer.Types.CheckNoPublicAccessRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.CheckNoPublicAccessResponse) => void): Request<AccessAnalyzer.Types.CheckNoPublicAccessResponse, AWSError>;
/**
* Checks whether a resource policy can grant public access to the specified resource type.
*/
checkNoPublicAccess(callback?: (err: AWSError, data: AccessAnalyzer.Types.CheckNoPublicAccessResponse) => void): Request<AccessAnalyzer.Types.CheckNoPublicAccessResponse, AWSError>;
/**
* Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.
*/
createAccessPreview(params: AccessAnalyzer.Types.CreateAccessPreviewRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.CreateAccessPreviewResponse) => void): Request<AccessAnalyzer.Types.CreateAccessPreviewResponse, AWSError>;
/**
* Creates an access preview that allows you to preview IAM Access Analyzer findings for your resource before deploying resource permissions.
*/
createAccessPreview(callback?: (err: AWSError, data: AccessAnalyzer.Types.CreateAccessPreviewResponse) => void): Request<AccessAnalyzer.Types.CreateAccessPreviewResponse, AWSError>;
/**
* Creates an analyzer for your account.
*/
createAnalyzer(params: AccessAnalyzer.Types.CreateAnalyzerRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.CreateAnalyzerResponse) => void): Request<AccessAnalyzer.Types.CreateAnalyzerResponse, AWSError>;
/**
* Creates an analyzer for your account.
*/
createAnalyzer(callback?: (err: AWSError, data: AccessAnalyzer.Types.CreateAnalyzerResponse) => void): Request<AccessAnalyzer.Types.CreateAnalyzerResponse, AWSError>;
/**
* Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.
*/
createArchiveRule(params: AccessAnalyzer.Types.CreateArchiveRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.
*/
createArchiveRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified analyzer. When you delete an analyzer, IAM Access Analyzer is disabled for the account or organization in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action.
*/
deleteAnalyzer(params: AccessAnalyzer.Types.DeleteAnalyzerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified analyzer. When you delete an analyzer, IAM Access Analyzer is disabled for the account or organization in the current or specific Region. All findings that were generated by the analyzer are deleted. You cannot undo this action.
*/
deleteAnalyzer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified archive rule.
*/
deleteArchiveRule(params: AccessAnalyzer.Types.DeleteArchiveRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified archive rule.
*/
deleteArchiveRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a recommendation for an unused permissions finding.
*/
generateFindingRecommendation(params: AccessAnalyzer.Types.GenerateFindingRecommendationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a recommendation for an unused permissions finding.
*/
generateFindingRecommendation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Retrieves information about an access preview for the specified analyzer.
*/
getAccessPreview(params: AccessAnalyzer.Types.GetAccessPreviewRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.GetAccessPreviewResponse) => void): Request<AccessAnalyzer.Types.GetAccessPreviewResponse, AWSError>;
/**
* Retrieves information about an access preview for the specified analyzer.
*/
getAccessPreview(callback?: (err: AWSError, data: AccessAnalyzer.Types.GetAccessPreviewResponse) => void): Request<AccessAnalyzer.Types.GetAccessPreviewResponse, AWSError>;
/**
* Retrieves information about a resource that was analyzed.
*/
getAnalyzedResource(params: AccessAnalyzer.Types.GetAnalyzedResourceRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.GetAnalyzedResourceResponse) => void): Request<AccessAnalyzer.Types.GetAnalyzedResourceResponse, AWSError>;
/**
* Retrieves information about a resource that was analyzed.
*/
getAnalyzedResource(callback?: (err: AWSError, data: AccessAnalyzer.Types.GetAnalyzedResourceResponse) => void): Request<AccessAnalyzer.Types.GetAnalyzedResourceResponse, AWSError>;
/**
* Retrieves information about the specified analyzer.
*/
getAnalyzer(params: AccessAnalyzer.Types.GetAnalyzerRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.GetAnalyzerResponse) => void): Request<AccessAnalyzer.Types.GetAnalyzerResponse, AWSError>;
/**
* Retrieves information about the specified analyzer.
*/
getAnalyzer(callback?: (err: AWSError, data: AccessAnalyzer.Types.GetAnalyzerResponse) => void): Request<AccessAnalyzer.Types.GetAnalyzerResponse, AWSError>;
/**
* Retrieves information about an archive rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.
*/
getArchiveRule(params: AccessAnalyzer.Types.GetArchiveRuleRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.GetArchiveRuleResponse) => void): Request<AccessAnalyzer.Types.GetArchiveRuleResponse, AWSError>;
/**
* Retrieves information about an archive rule. To learn about filter keys that you can use to create an archive rule, see IAM Access Analyzer filter keys in the IAM User Guide.
*/
getArchiveRule(callback?: (err: AWSError, data: AccessAnalyzer.Types.GetArchiveRuleResponse) => void): Request<AccessAnalyzer.Types.GetArchiveRuleResponse, AWSError>;
/**
* Retrieves information about the specified finding. 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.
*/
getFinding(params: AccessAnalyzer.Types.GetFindingRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.GetFindingResponse) => void): Request<AccessAnalyzer.Types.GetFindingResponse, AWSError>;
/**
* Retrieves information about the specified finding. 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.
*/
getFinding(callback?: (err: AWSError, data: AccessAnalyzer.Types.GetFindingResponse) => void): Request<AccessAnalyzer.Types.GetFindingResponse, AWSError>;
/**
* Retrieves information about a finding recommendation for the specified analyzer.
*/
getFindingRecommendation(params: AccessAnalyzer.Types.GetFindingRecommendationRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.GetFindingRecommendationResponse) => void): Request<AccessAnalyzer.Types.GetFindingRecommendationResponse, AWSError>;
/**
* Retrieves information about a finding recommendation for the specified analyzer.
*/
getFindingRecommendation(callback?: (err: AWSError, data: AccessAnalyzer.Types.GetFindingRecommendationResponse) => void): Request<AccessAnalyzer.Types.GetFindingRecommendationResponse, AWSError>;
/**
* Retrieves information about the specified finding. 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.
*/
getFindingV2(params: AccessAnalyzer.Types.GetFindingV2Request, callback?: (err: AWSError, data: AccessAnalyzer.Types.GetFindingV2Response) => void): Request<AccessAnalyzer.Types.GetFindingV2Response, AWSError>;
/**
* Retrieves information about the specified finding. 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.
*/
getFindingV2(callback?: (err: AWSError, data: AccessAnalyzer.Types.GetFindingV2Response) => void): Request<AccessAnalyzer.Types.GetFindingV2Response, AWSError>;
/**
* Retrieves the policy that was generated using StartPolicyGeneration.
*/
getGeneratedPolicy(params: AccessAnalyzer.Types.GetGeneratedPolicyRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.GetGeneratedPolicyResponse) => void): Request<AccessAnalyzer.Types.GetGeneratedPolicyResponse, AWSError>;
/**
* Retrieves the policy that was generated using StartPolicyGeneration.
*/
getGeneratedPolicy(callback?: (err: AWSError, data: AccessAnalyzer.Types.GetGeneratedPolicyResponse) => void): Request<AccessAnalyzer.Types.GetGeneratedPolicyResponse, AWSError>;
/**
* Retrieves a list of access preview findings generated by the specified access preview.
*/
listAccessPreviewFindings(params: AccessAnalyzer.Types.ListAccessPreviewFindingsRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.ListAccessPreviewFindingsResponse) => void): Request<AccessAnalyzer.Types.ListAccessPreviewFindingsResponse, AWSError>;
/**
* Retrieves a list of access preview findings generated by the specified access preview.
*/
listAccessPreviewFindings(callback?: (err: AWSError, data: AccessAnalyzer.Types.ListAccessPreviewFindingsResponse) => void): Request<AccessAnalyzer.Types.ListAccessPreviewFindingsResponse, AWSError>;
/**
* Retrieves a list of access previews for the specified analyzer.
*/
listAccessPreviews(params: AccessAnalyzer.Types.ListAccessPreviewsRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.ListAccessPreviewsResponse) => void): Request<AccessAnalyzer.Types.ListAccessPreviewsResponse, AWSError>;
/**
* Retrieves a list of access previews for the specified analyzer.
*/
listAccessPreviews(callback?: (err: AWSError, data: AccessAnalyzer.Types.ListAccessPreviewsResponse) => void): Request<AccessAnalyzer.Types.ListAccessPreviewsResponse, AWSError>;
/**
* Retrieves a list of resources of the specified type that have been analyzed by the specified external access analyzer. This action is not supported for unused access analyzers.
*/
listAnalyzedResources(params: AccessAnalyzer.Types.ListAnalyzedResourcesRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.ListAnalyzedResourcesResponse) => void): Request<AccessAnalyzer.Types.ListAnalyzedResourcesResponse, AWSError>;
/**
* Retrieves a list of resources of the specified type that have been analyzed by the specified external access analyzer. This action is not supported for unused access analyzers.
*/
listAnalyzedResources(callback?: (err: AWSError, data: AccessAnalyzer.Types.ListAnalyzedResourcesResponse) => void): Request<AccessAnalyzer.Types.ListAnalyzedResourcesResponse, AWSError>;
/**
* Retrieves a list of analyzers.
*/
listAnalyzers(params: AccessAnalyzer.Types.ListAnalyzersRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.ListAnalyzersResponse) => void): Request<AccessAnalyzer.Types.ListAnalyzersResponse, AWSError>;
/**
* Retrieves a list of analyzers.
*/
listAnalyzers(callback?: (err: AWSError, data: AccessAnalyzer.Types.ListAnalyzersResponse) => void): Request<AccessAnalyzer.Types.ListAnalyzersResponse, AWSError>;
/**
* Retrieves a list of archive rules created for the specified analyzer.
*/
listArchiveRules(params: AccessAnalyzer.Types.ListArchiveRulesRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.ListArchiveRulesResponse) => void): Request<AccessAnalyzer.Types.ListArchiveRulesResponse, AWSError>;
/**
* Retrieves a list of archive rules created for the specified analyzer.
*/
listArchiveRules(callback?: (err: AWSError, data: AccessAnalyzer.Types.ListArchiveRulesResponse) => void): Request<AccessAnalyzer.Types.ListArchiveRulesResponse, AWSError>;
/**
* Retrieves a list of findings generated by the specified 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 filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
*/
listFindings(params: AccessAnalyzer.Types.ListFindingsRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.ListFindingsResponse) => void): Request<AccessAnalyzer.Types.ListFindingsResponse, AWSError>;
/**
* Retrieves a list of findings generated by the specified 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 filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
*/
listFindings(callback?: (err: AWSError, data: AccessAnalyzer.Types.ListFindingsResponse) => void): Request<AccessAnalyzer.Types.ListFindingsResponse, AWSError>;
/**
* Retrieves a list of findings generated by the specified 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 filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
*/
listFindingsV2(params: AccessAnalyzer.Types.ListFindingsV2Request, callback?: (err: AWSError, data: AccessAnalyzer.Types.ListFindingsV2Response) => void): Request<AccessAnalyzer.Types.ListFindingsV2Response, AWSError>;
/**
* Retrieves a list of findings generated by the specified 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 filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide.
*/
listFindingsV2(callback?: (err: AWSError, data: AccessAnalyzer.Types.ListFindingsV2Response) => void): Request<AccessAnalyzer.Types.ListFindingsV2Response, AWSError>;
/**
* Lists all of the policy generations requested in the last seven days.
*/
listPolicyGenerations(params: AccessAnalyzer.Types.ListPolicyGenerationsRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.ListPolicyGenerationsResponse) => void): Request<AccessAnalyzer.Types.ListPolicyGenerationsResponse, AWSError>;
/**
* Lists all of the policy generations requested in the last seven days.
*/
listPolicyGenerations(callback?: (err: AWSError, data: AccessAnalyzer.Types.ListPolicyGenerationsResponse) => void): Request<AccessAnalyzer.Types.ListPolicyGenerationsResponse, AWSError>;
/**
* Retrieves a list of tags applied to the specified resource.
*/
listTagsForResource(params: AccessAnalyzer.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.ListTagsForResourceResponse) => void): Request<AccessAnalyzer.Types.ListTagsForResourceResponse, AWSError>;
/**
* Retrieves a list of tags applied to the specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: AccessAnalyzer.Types.ListTagsForResourceResponse) => void): Request<AccessAnalyzer.Types.ListTagsForResourceResponse, AWSError>;
/**
* Starts the policy generation request.
*/
startPolicyGeneration(params: AccessAnalyzer.Types.StartPolicyGenerationRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.StartPolicyGenerationResponse) => void): Request<AccessAnalyzer.Types.StartPolicyGenerationResponse, AWSError>;
/**
* Starts the policy generation request.
*/
startPolicyGeneration(callback?: (err: AWSError, data: AccessAnalyzer.Types.StartPolicyGenerationResponse) => void): Request<AccessAnalyzer.Types.StartPolicyGenerationResponse, AWSError>;
/**
* Immediately starts a scan of the policies applied to the specified resource.
*/
startResourceScan(params: AccessAnalyzer.Types.StartResourceScanRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Immediately starts a scan of the policies applied to the specified resource.
*/
startResourceScan(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds a tag to the specified resource.
*/
tagResource(params: AccessAnalyzer.Types.TagResourceRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.TagResourceResponse) => void): Request<AccessAnalyzer.Types.TagResourceResponse, AWSError>;
/**
* Adds a tag to the specified resource.
*/
tagResource(callback?: (err: AWSError, data: AccessAnalyzer.Types.TagResourceResponse) => void): Request<AccessAnalyzer.Types.TagResourceResponse, AWSError>;
/**
* Removes a tag from the specified resource.
*/
untagResource(params: AccessAnalyzer.Types.UntagResourceRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.UntagResourceResponse) => void): Request<AccessAnalyzer.Types.UntagResourceResponse, AWSError>;
/**
* Removes a tag from the specified resource.
*/
untagResource(callback?: (err: AWSError, data: AccessAnalyzer.Types.UntagResourceResponse) => void): Request<AccessAnalyzer.Types.UntagResourceResponse, AWSError>;
/**
* Updates the criteria and values for the specified archive rule.
*/
updateArchiveRule(params: AccessAnalyzer.Types.UpdateArchiveRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the criteria and values for the specified archive rule.
*/
updateArchiveRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the status for the specified findings.
*/
updateFindings(params: AccessAnalyzer.Types.UpdateFindingsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the status for the specified findings.
*/
updateFindings(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices.
*/
validatePolicy(params: AccessAnalyzer.Types.ValidatePolicyRequest, callback?: (err: AWSError, data: AccessAnalyzer.Types.ValidatePolicyResponse) => void): Request<AccessAnalyzer.Types.ValidatePolicyResponse, AWSError>;
/**
* Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices.
*/
validatePolicy(callback?: (err: AWSError, data: AccessAnalyzer.Types.ValidatePolicyResponse) => void): Request<AccessAnalyzer.Types.ValidatePolicyResponse, AWSError>;
}
declare namespace AccessAnalyzer {
export interface Access {
/**
* 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.
*/
actions?: AccessActionsList;
/**
* A list of resources for the access permissions. Any strings that can be used as a resource in an IAM policy can be used in the list of resources to check.
*/
resources?: AccessResourcesList;
}
export type AccessActionsList = Action[];
export type AccessCheckPolicyDocument = string;
export type AccessCheckPolicyType = "IDENTITY_POLICY"|"RESOURCE_POLICY"|string;
export type AccessCheckResourceType = "AWS::DynamoDB::Table"|"AWS::DynamoDB::Stream"|"AWS::EFS::FileSystem"|"AWS::OpenSearchService::Domain"|"AWS::Kinesis::Stream"|"AWS::Kinesis::StreamConsumer"|"AWS::KMS::Key"|"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"|string;
export type AccessPointArn = string;
export type AccessPointPolicy = string;
export interface AccessPreview {
/**
* The unique ID for the access preview.
*/
id: AccessPreviewId;
/**
* The ARN of the analyzer used to generate the access preview.
*/
analyzerArn: AnalyzerArn;
/**
* A map of resource ARNs for the proposed resource configuration.
*/
configurations: ConfigurationsMap;
/**
* The time at which the access preview was created.
*/
createdAt: Timestamp;
/**
* 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.
*/
status: AccessPreviewStatus;
/**
* 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.
*/
statusReason?: AccessPreviewStatusReason;
}
export interface AccessPreviewFinding {
/**
* 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.
*/
id: AccessPreviewFindingId;
/**
* The existing ID of the finding in IAM Access Analyzer, provided only for existing findings.
*/
existingFindingId?: FindingId;
/**
* The existing status of the finding, provided only for existing findings.
*/
existingFindingStatus?: FindingStatus;
/**
* The external principal that has access to a resource within the zone of trust.
*/
principal?: PrincipalMap;
/**
* The action in the analyzed policy statement that an external principal has permission to perform.
*/
action?: ActionList;
/**
* The condition in the analyzed policy statement that resulted in a finding.
*/
condition?: ConditionKeyMap;
/**
* The resource that an external principal has access to. This is the resource associated with the access preview.
*/
resource?: String;
/**
* Indicates whether the policy that generated the finding allows public access to the resource.
*/
isPublic?: Boolean;
/**
* The type of the resource that can be accessed in the finding.
*/
resourceType: ResourceType;
/**
* The time at which the access preview finding was created.
*/
createdAt: Timestamp;
/**
* Provides context on how the access preview finding compares to existing access identified in IAM 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.
*/
changeType: FindingChangeType;
/**
* 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.
*/
status: FindingStatus;
/**
* The Amazon Web Services account ID that owns the resource. For most Amazon Web Services resources, the owning account is the account in which the resource was created.
*/
resourceOwnerAccount: String;
/**
* An error.
*/
error?: String;
/**
* The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.
*/
sources?: FindingSourceList;
}
export type AccessPreviewFindingId = string;
export type AccessPreviewFindingsList = AccessPreviewFinding[];
export type AccessPreviewId = string;
export type AccessPreviewStatus = "COMPLETED"|"CREATING"|"FAILED"|string;
export interface AccessPreviewStatusReason {
/**
* The reason code for the current status of the access preview.
*/
code: AccessPreviewStatusReasonCode;
}
export type AccessPreviewStatusReasonCode = "INTERNAL_ERROR"|"INVALID_CONFIGURATION"|string;
export interface AccessPreviewSummary {
/**
* The unique ID for the access preview.
*/
id: AccessPreviewId;
/**
* The ARN of the analyzer used to generate the access preview.
*/
analyzerArn: AnalyzerArn;
/**
* The time at which the access preview was created.
*/
createdAt: Timestamp;
/**
* 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.
*/
status: AccessPreviewStatus;
statusReason?: AccessPreviewStatusReason;
}
export type AccessPreviewsList = AccessPreviewSummary[];
export type AccessResourcesList = Resource[];
export type AclCanonicalId = string;
export interface AclGrantee {
/**
* The value specified is the canonical user ID of an Amazon Web Services account.
*/
id?: AclCanonicalId;
/**
* Used for granting permissions to a predefined group.
*/
uri?: AclUri;
}
export type AclPermission = "READ"|"WRITE"|"READ_ACP"|"WRITE_ACP"|"FULL_CONTROL"|string;
export type AclUri = string;
export type Action = string;
export type ActionList = String[];
export interface AnalyzedResource {
/**
* The ARN of the resource that was analyzed.
*/
resourceArn: ResourceArn;
/**
* The type of the resource that was analyzed.
*/
resourceType: ResourceType;
/**
* The time at which the finding was created.
*/
createdAt: Timestamp;
/**
* The time at which the resource was analyzed.
*/
analyzedAt: Timestamp;
/**
* The time at which the finding was updated.
*/
updatedAt: Timestamp;
/**
* Indicates whether the policy that generated the finding grants public access to the resource.
*/
isPublic: Boolean;
/**
* The actions that an external principal is granted permission to use by the policy that generated the finding.
*/
actions?: ActionList;
/**
* Indicates how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.
*/
sharedVia?: SharedViaList;
/**
* The current status of the finding generated from the analyzed resource.
*/
status?: FindingStatus;
/**
* The Amazon Web Services account ID that owns the resource.
*/
resourceOwnerAccount: String;
/**
* An error message.
*/
error?: String;
}
export interface AnalyzedResourceSummary {
/**
* The ARN of the analyzed resource.
*/
resourceArn: ResourceArn;
/**
* The Amazon Web Services account ID that owns the resource.
*/
resourceOwnerAccount: String;
/**
* The type of resource that was analyzed.
*/
resourceType: ResourceType;
}
export type AnalyzedResourcesList = AnalyzedResourceSummary[];
export type AnalyzerArn = string;
export interface AnalyzerConfiguration {
/**
* Specifies the configuration of an unused access analyzer for an Amazon Web Services organization or account. External access analyzers do not support any configuration.
*/
unusedAccess?: UnusedAccessConfiguration;
}
export type AnalyzerStatus = "ACTIVE"|"CREATING"|"DISABLED"|"FAILED"|string;
export interface AnalyzerSummary {
/**
* The ARN of the analyzer.
*/
arn: AnalyzerArn;
/**
* The name of the analyzer.
*/
name: Name;
/**
* The type of analyzer, which corresponds to the zone of trust chosen for the analyzer.
*/
type: Type;
/**
* A timestamp for the time at which the analyzer was created.
*/
createdAt: Timestamp;
/**
* The resource that was most recently analyzed by the analyzer.
*/
lastResourceAnalyzed?: String;
/**
* The time at which the most recently analyzed resource was analyzed.
*/
lastResourceAnalyzedAt?: Timestamp;
/**
* The tags added to the analyzer.
*/
tags?: TagsMap;
/**
* 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 Identity and Access Management Access Analyzer from 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.
*/
status: AnalyzerStatus;
/**
* 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 Amazon Web Services organization.
*/
statusReason?: StatusReason;
/**
* Specifies whether the analyzer is an external access or unused access analyzer.
*/
configuration?: AnalyzerConfiguration;
}
export type AnalyzersList = AnalyzerSummary[];
export interface ApplyArchiveRuleRequest {
/**
* The Amazon resource name (ARN) of the analyzer.
*/
analyzerArn: AnalyzerArn;
/**
* The name of the rule to apply.
*/
ruleName: Name;
/**
* A client token.
*/
clientToken?: String;
}
export interface ArchiveRuleSummary {
/**
* The name of the archive rule.
*/
ruleName: Name;
/**
* A filter used to define the archive rule.
*/
filter: FilterCriteriaMap;
/**
* The time at which the archive rule was created.
*/
createdAt: Timestamp;
/**
* The time at which the archive rule was last updated.
*/
updatedAt: Timestamp;
}
export type ArchiveRulesList = ArchiveRuleSummary[];
export type Boolean = boolean;
export interface CancelPolicyGenerationRequest {
/**
* 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.
*/
jobId: JobId;
}
export interface CancelPolicyGenerationResponse {
}
export interface CheckAccessNotGrantedRequest {
/**
* The JSON policy document to use as the content for the policy.
*/
policyDocument: AccessCheckPolicyDocument;
/**
* An access object containing the permissions that shouldn't be granted by the specified policy. If only actions are specified, IAM Access Analyzer checks for access of the actions on all resources in the policy. If only resources are specified, then IAM Access Analyzer checks which actions have access to the specified resources. If both actions and resources are specified, then IAM Access Analyzer checks which of the specified actions have access to the specified resources.
*/
access: CheckAccessNotGrantedRequestAccessList;
/**
* 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 Amazon Web Services 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 specific input such as managed policy or Amazon S3 bucket policy.
*/
policyType: AccessCheckPolicyType;
}
export type CheckAccessNotGrantedRequestAccessList = Access[];
export interface CheckAccessNotGrantedResponse {
/**
* 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 specified policy might allow some or all of the permissions in the access object.
*/
result?: CheckAccessNotGrantedResult;
/**
* The message indicating whether the specified access is allowed.
*/
message?: String;
/**
* A description of the reasoning of the result.
*/
reasons?: ReasonSummaryList;
}
export type CheckAccessNotGrantedResult = "PASS"|"FAIL"|string;
export interface CheckNoNewAccessRequest {
/**
* The JSON policy document to use as the content for the updated policy.
*/
newPolicyDocument: AccessCheckPolicyDocument;
/**
* The JSON policy document to use as the content for the existing policy.
*/
existingPolicyDocument: AccessCheckPolicyDocument;
/**
* 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 Amazon Web Services 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 specific input such as managed policy or Amazon S3 bucket policy.
*/
policyType: AccessCheckPolicyType;
}
export interface CheckNoNewAccessResponse {
/**
* 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.
*/
result?: CheckNoNewAccessResult;
/**
* The message indicating whether the updated policy allows new access.
*/
message?: String;
/**
* A description of the reasoning of the result.
*/
reasons?: ReasonSummaryList;
}
export type CheckNoNewAccessResult = "PASS"|"FAIL"|string;
export interface CheckNoPublicAccessRequest {
/**
* The JSON policy document to evaluate for public access.
*/
policyDocument: AccessCheckPolicyDocument;
/**
* 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.
*/
resourceType: AccessCheckResourceType;
}
export interface CheckNoPublicAccessResponse {
/**
* The result of the check for public access to the specified resource type. If the result is PASS, the policy doesn't allow public access to the specified resource type. If the result is FAIL, the policy might allow public access to the specified resource type.
*/
result?: CheckNoPublicAccessResult;
/**
* The message indicating whether the specified policy allows public access to resources.
*/
message?: String;
/**
* A list of reasons why the specified resource policy grants public access for the resource type.
*/
reasons?: ReasonSummaryList;
}
export type CheckNoPublicAccessResult = "PASS"|"FAIL"|string;
export type CloudTrailArn = string;
export interface CloudTrailDetails {
/**
* A Trail object that contains settings for a trail.
*/
trails: TrailList;
/**
* The ARN of the service role that IAM Access Analyzer uses to access your CloudTrail trail and service last accessed information.
*/
accessRole: RoleArn;
/**
* 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.
*/
startTime: Timestamp;
/**
* 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.
*/
endTime?: Timestamp;
}
export interface CloudTrailProperties {
/**
* A TrailProperties object that contains settings for trail properties.
*/
trailProperties: TrailPropertiesList;
/**
* 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.
*/
startTime: Timestamp;
/**
* 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.
*/
endTime: Timestamp;
}
export type ConditionKeyMap = {[key: string]: String};
export interface Configuration {
/**
* The access control configuration is for an Amazon EBS volume snapshot.
*/
ebsSnapshot?: EbsSnapshotConfiguration;
/**
* The access control configuration is for an Amazon ECR repository.
*/
ecrRepository?: EcrRepositoryConfiguration;
/**
* The access control configuration is for an IAM role.
*/
iamRole?: IamRoleConfiguration;
/**
* The access control configuration is for an Amazon EFS file system.
*/
efsFileSystem?: EfsFileSystemConfiguration;
/**
* The access control configuration is for a KMS key.
*/
kmsKey?: KmsKeyConfiguration;
/**
* The access control configuration is for an Amazon RDS DB cluster snapshot.
*/
rdsDbClusterSnapshot?: RdsDbClusterSnapshotConfiguration;
/**
* The access control configuration is for an Amazon RDS DB snapshot.
*/
rdsDbSnapshot?: RdsDbSnapshotConfiguration;
/**
* The access control configuration is for a Secrets Manager secret.
*/
secretsManagerSecret?: SecretsManagerSecretConfiguration;
/**
* The access control configuration is for an Amazon S3 bucket.
*/
s3Bucket?: S3BucketConfiguration;
/**
* The access control configuration is for an Amazon SNS topic
*/
snsTopic?: SnsTopicConfiguration;
/**
* The access control configuration is for an Amazon SQS queue.
*/
sqsQueue?: SqsQueueConfiguration;
/**
* The access control configuration is for an Amazon S3 directory bucket.
*/
s3ExpressDirectoryBucket?: S3ExpressDirectoryBucketConfiguration;
/**
* The access control configuration is for a DynamoDB stream.
*/
dynamodbStream?: DynamodbStreamConfiguration;
/**
* The access control configuration is for a DynamoDB table or index.
*/
dynamodbTable?: DynamodbTableConfiguration;
}
export type ConfigurationsMap = {[key: string]: Configuration};
export type ConfigurationsMapKey = string;
export interface CreateAccessPreviewRequest {
/**
* 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.
*/
analyzerArn: AnalyzerArn;
/**
* 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.
*/
configurations: ConfigurationsMap;
/**
* A client token.
*/
clientToken?: String;
}
export interface CreateAccessPreviewResponse {
/**
* The unique ID for the access preview.
*/
id: AccessPreviewId;
}
export interface CreateAnalyzerRequest {
/**
* The name of the analyzer to create.
*/
analyzerName: Name;
/**
* 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: Type;
/**
* Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.
*/
archiveRules?: InlineArchiveRulesList;
/**
* An array of key-value pairs to apply to the analyzer.
*/
tags?: TagsMap;
/**
* A client token.
*/
clientToken?: String;
/**
* Specifies the configuration of the analyzer. If the analyzer is an unused access analyzer, the specified scope of unused access is used for the configuration. If the analyzer is an external access analyzer, this field is not used.
*/
configuration?: AnalyzerConfiguration;
}
export interface CreateAnalyzerResponse {
/**
* The ARN of the analyzer that was created by the request.
*/
arn?: AnalyzerArn;
}
export interface CreateArchiveRuleRequest {
/**
* The name of the created analyzer.
*/
analyzerName: Name;
/**
* The name of the rule to create.
*/
ruleName: Name;
/**
* The criteria for the rule.
*/
filter: FilterCriteriaMap;
/**
* A client token.
*/
clientToken?: String;
}
export interface Criterion {
/**
* An "equals" operator to match for the filter used to create the rule.
*/
eq?: ValueList;
/**
* A "not equals" operator to match for the filter used to create the rule.
*/
neq?: ValueList;
/**
* A "contains" operator to match for the filter used to create the rule.
*/
contains?: ValueList;
/**
* An "exists" operator to match for the filter used to create the rule.
*/
exists?: Boolean;
}
export interface DeleteAnalyzerRequest {
/**
* The name of the analyzer to delete.
*/
analyzerName: Name;
/**
* A client token.
*/
clientToken?: String;
}
export interface DeleteArchiveRuleRequest {
/**
* The name of the analyzer that associated with the archive rule to delete.
*/
analyzerName: Name;
/**
* The name of the rule to delete.
*/
ruleName: Name;
/**
* A client token.
*/
clientToken?: String;
}
export interface DynamodbStreamConfiguration {
/**
* The proposed resource policy defining who can access or manage the DynamoDB stream.
*/
streamPolicy?: DynamodbStreamPolicy;
}
export type DynamodbStreamPolicy = string;
export interface DynamodbTableConfiguration {
/**
* The proposed resource policy defining who can access or manage the DynamoDB table.
*/
tablePolicy?: DynamodbTablePolicy;
}
export type DynamodbTablePolicy = string;
export type EbsGroup = string;
export type EbsGroupList = EbsGroup[];
export interface EbsSnapshotConfiguration {
/**
* The IDs of the Amazon Web Services accounts that have access to the Amazon EBS volume snapshot. If the configuration 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.
*/
userIds?: EbsUserIdList;
/**
* The groups that have access to the Amazon EBS volume snapshot. If the value all is specified, then the Amazon EBS volume snapshot is public. If the configuration 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.
*/
groups?: EbsGroupList;
/**
* The KMS key identifier for an encrypted Amazon EBS volume snapshot. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If the configuration 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.
*/
kmsKeyId?: EbsSnapshotDataEncryptionKeyId;
}
export type EbsSnapshotDataEncryptionKeyId = string;
export type EbsUserId = string;
export type EbsUserIdList = EbsUserId[];
export interface EcrReposit