AccessAnalyzer / Client / get_findings_statistics

get_findings_statistics#

AccessAnalyzer.Client.get_findings_statistics(**kwargs)#

Retrieves a list of aggregated finding statistics for an external access or unused access analyzer.

See also: AWS API Documentation

Request Syntax

response = client.get_findings_statistics(
    analyzerArn='string'
)
Parameters:

analyzerArn (string) –

[REQUIRED]

The ARN of the analyzer used to generate the statistics.

Return type:

dict

Returns:

Response Syntax

{
    'findingsStatistics': [
        {
            'externalAccessFindingsStatistics': {
                'resourceTypeStatistics': {
                    'string': {
                        'totalActivePublic': 123,
                        'totalActiveCrossAccount': 123
                    }
                },
                'totalActiveFindings': 123,
                'totalArchivedFindings': 123,
                'totalResolvedFindings': 123
            },
            'unusedAccessFindingsStatistics': {
                'unusedAccessTypeStatistics': [
                    {
                        'unusedAccessType': 'string',
                        'total': 123
                    },
                ],
                'topAccounts': [
                    {
                        'account': 'string',
                        'numberOfActiveFindings': 123,
                        'details': {
                            'string': 123
                        }
                    },
                ],
                'totalActiveFindings': 123,
                'totalArchivedFindings': 123,
                'totalResolvedFindings': 123
            }
        },
    ],
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • findingsStatistics (list) –

      A group of external access or unused access findings statistics.

      • (dict) –

        Contains information about the aggregate statistics for an external or unused access analyzer. Only one parameter can be used in a FindingsStatistics object.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: externalAccessFindingsStatistics, unusedAccessFindingsStatistics. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

        • externalAccessFindingsStatistics (dict) –

          The aggregate statistics for an external access analyzer.

          • resourceTypeStatistics (dict) –

            The total number of active cross-account and public findings for each resource type of the specified external access analyzer.

            • (string) –

              • (dict) –

                Contains information about the total number of active cross-account and public findings for a resource type of an external access analyzer.

                • totalActivePublic (integer) –

                  The total number of active public findings for the resource type.

                • totalActiveCrossAccount (integer) –

                  The total number of active cross-account findings for the resource type.

          • totalActiveFindings (integer) –

            The number of active findings for the specified external access analyzer.

          • totalArchivedFindings (integer) –

            The number of archived findings for the specified external access analyzer.

          • totalResolvedFindings (integer) –

            The number of resolved findings for the specified external access analyzer.

        • unusedAccessFindingsStatistics (dict) –

          The aggregate statistics for an unused access analyzer.

          • unusedAccessTypeStatistics (list) –

            A list of details about the total number of findings for each type of unused access for the analyzer.

            • (dict) –

              Contains information about the total number of findings for a type of unused access.

              • unusedAccessType (string) –

                The type of unused access.

              • total (integer) –

                The total number of findings for the specified unused access type.

          • topAccounts (list) –

            A list of one to ten Amazon Web Services accounts that have the most active findings for the unused access analyzer.

            • (dict) –

              Contains information about the findings for an Amazon Web Services account in an organization unused access analyzer.

              • account (string) –

                The ID of the Amazon Web Services account for which unused access finding details are provided.

              • numberOfActiveFindings (integer) –

                The number of active unused access findings for the specified Amazon Web Services account.

              • details (dict) –

                Provides the number of active findings for each type of unused access for the specified Amazon Web Services account.

                • (string) –

                  • (integer) –

          • totalActiveFindings (integer) –

            The total number of active findings for the unused access analyzer.

          • totalArchivedFindings (integer) –

            The total number of archived findings for the unused access analyzer.

          • totalResolvedFindings (integer) –

            The total number of resolved findings for the unused access analyzer.

    • lastUpdatedAt (datetime) –

      The time at which the retrieval of the findings statistics was last updated. If the findings statistics have not been previously retrieved for the specified analyzer, this field will not be populated.

Exceptions