AccessAnalyzer / Client / list_access_preview_findings

list_access_preview_findings

AccessAnalyzer.Client.list_access_preview_findings(**kwargs)

Retrieves a list of access preview findings generated by the specified access preview.

See also: AWS API Documentation

Request Syntax

response = client.list_access_preview_findings(
    accessPreviewId='string',
    analyzerArn='string',
    filter={
        'string': {
            'eq': [
                'string',
            ],
            'neq': [
                'string',
            ],
            'contains': [
                'string',
            ],
            'exists': True|False
        }
    },
    nextToken='string',
    maxResults=123
)

Parameters:

• accessPreviewId (string) –

  [REQUIRED]

  The unique ID for the access preview.

• analyzerArn (string) –

  [REQUIRED]

  The ARN of the analyzer used to generate the access.

• filter (dict) –

  Criteria to filter the returned findings.

  • (string) –

    • (dict) –

      The criteria to use in the filter that defines the archive rule. For more information on available filter keys, see IAM Access Analyzer filter keys.

      • eq (list) –

        An “equals” operator to match for the filter used to create the rule.

        • (string) –

      • neq (list) –

        A “not equals” operator to match for the filter used to create the rule.

        • (string) –

      • contains (list) –

        A “contains” operator to match for the filter used to create the rule.

        • (string) –

      • exists (boolean) –

        An “exists” operator to match for the filter used to create the rule.

• nextToken (string) – A token used for pagination of results returned.

• maxResults (integer) – The maximum number of results to return in the response.

Return type:

dict

Returns:

Response Syntax

{
    'findings': [
        {
            'id': 'string',
            'existingFindingId': 'string',
            'existingFindingStatus': 'ACTIVE'|'ARCHIVED'|'RESOLVED',
            'principal': {
                'string': 'string'
            },
            'action': [
                'string',
            ],
            'condition': {
                'string': 'string'
            },
            'resource': 'string',
            'isPublic': True|False,
            'resourceType': 'AWS::S3::Bucket'|'AWS::IAM::Role'|'AWS::SQS::Queue'|'AWS::Lambda::Function'|'AWS::Lambda::LayerVersion'|'AWS::KMS::Key'|'AWS::SecretsManager::Secret'|'AWS::EFS::FileSystem'|'AWS::EC2::Snapshot'|'AWS::ECR::Repository'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBClusterSnapshot'|'AWS::SNS::Topic'|'AWS::S3Express::DirectoryBucket'|'AWS::DynamoDB::Table'|'AWS::DynamoDB::Stream'|'AWS::IAM::User',
            'createdAt': datetime(2015, 1, 1),
            'changeType': 'CHANGED'|'NEW'|'UNCHANGED',
            'status': 'ACTIVE'|'ARCHIVED'|'RESOLVED',
            'resourceOwnerAccount': 'string',
            'error': 'string',
            'sources': [
                {
                    'type': 'POLICY'|'BUCKET_ACL'|'S3_ACCESS_POINT'|'S3_ACCESS_POINT_ACCOUNT',
                    'detail': {
                        'accessPointArn': 'string',
                        'accessPointAccount': 'string'
                    }
                },
            ],
            'resourceControlPolicyRestriction': 'APPLICABLE'|'FAILED_TO_EVALUATE_RCP'|'NOT_APPLICABLE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • findings (list) –

    A list of access preview findings that match the specified filter criteria.

    • (dict) –

      An access preview finding generated by the access preview.

      • id (string) –

        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.

      • existingFindingId (string) –

        The existing ID of the finding in IAM Access Analyzer, provided only for existing findings.

      • existingFindingStatus (string) –

        The existing status of the finding, provided only for existing findings.

      • principal (dict) –

        The external principal that has access to a resource within the zone of trust.

        • (string) –

          • (string) –

      • action (list) –

        The action in the analyzed policy statement that an external principal has permission to perform.

        • (string) –

      • condition (dict) –

        The condition in the analyzed policy statement that resulted in a finding.

        • (string) –

          • (string) –

      • resource (string) –

        The resource that an external principal has access to. This is the resource associated with the access preview.

      • isPublic (boolean) –

        Indicates whether the policy that generated the finding allows public access to the resource.

      • resourceType (string) –

        The type of the resource that can be accessed in the finding.

      • createdAt (datetime) –

        The time at which the access preview finding was created.

      • changeType (string) –

        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.

      • status (string) –

        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.

      • resourceOwnerAccount (string) –

        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.

      • error (string) –

        An error.

      • sources (list) –

        The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

        • (dict) –

          The source of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

          • type (string) –

            Indicates the type of access that generated the finding.

          • detail (dict) –

            Includes details about how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.

            • accessPointArn (string) –

              The ARN of the access point that generated the finding. The ARN format depends on whether the ARN represents an access point or a multi-region access point.

            • accessPointAccount (string) –

              The account of the cross-account access point that generated the finding.

      • resourceControlPolicyRestriction (string) –

        The type of restriction applied to the finding by the resource owner with an Organizations resource control policy (RCP).

  • nextToken (string) –

    A token used for pagination of results returned.

Exceptions

• AccessAnalyzer.Client.exceptions.ResourceNotFoundException

• AccessAnalyzer.Client.exceptions.ConflictException

• AccessAnalyzer.Client.exceptions.ValidationException

• AccessAnalyzer.Client.exceptions.InternalServerException

• AccessAnalyzer.Client.exceptions.ThrottlingException

• AccessAnalyzer.Client.exceptions.AccessDeniedException