AccessAnalyzer / Client / get_analyzer

get_analyzer#

AccessAnalyzer.Client.get_analyzer(**kwargs)#

Retrieves information about the specified analyzer.

Request Syntax

response = client.get_analyzer(
    analyzerName='string'
)

Parameters:

analyzerName (string) –

[REQUIRED]

The name of the analyzer retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'analyzer': {
        'arn': 'string',
        'name': 'string',
        'type': 'ACCOUNT'|'ORGANIZATION'|'ACCOUNT_UNUSED_ACCESS'|'ORGANIZATION_UNUSED_ACCESS',
        'createdAt': datetime(2015, 1, 1),
        'lastResourceAnalyzed': 'string',
        'lastResourceAnalyzedAt': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        },
        'status': 'ACTIVE'|'CREATING'|'DISABLED'|'FAILED',
        'statusReason': {
            'code': 'AWS_SERVICE_ACCESS_DISABLED'|'DELEGATED_ADMINISTRATOR_DEREGISTERED'|'ORGANIZATION_DELETED'|'SERVICE_LINKED_ROLE_CREATION_FAILED'
        },
        'configuration': {
            'unusedAccess': {
                'unusedAccessAge': 123,
                'analysisRule': {
                    'exclusions': [
                        {
                            'accountIds': [
                                'string',
                            ],
                            'resourceTags': [
                                {
                                    'string': 'string'
                                },
                            ]
                        },
                    ]
                }
            }
        }
    }
}

Response Structure

(dict) –

The response to the request.
- analyzer (dict) –
  
  An AnalyzerSummary object that contains information about the analyzer.
  - arn (string) –
    
    The ARN of the analyzer.
  - name (string) –
    
    The name of the analyzer.
  - type (string) –
    
    The type of analyzer, which corresponds to the zone of trust chosen for the analyzer.
  - createdAt (datetime) –
    
    A timestamp for the time at which the analyzer was created.
  - lastResourceAnalyzed (string) –
    
    The resource that was most recently analyzed by the analyzer.
  - lastResourceAnalyzedAt (datetime) –
    
    The time at which the most recently analyzed resource was analyzed.
  - tags (dict) –
    
    The tags added to the analyzer.
    - (string) –
      - (string) –
  - status (string) –
    
    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.
  - statusReason (dict) –
    
    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.
    - code (string) –
      
      The reason code for the current status of the analyzer.
  - configuration (dict) –
    
    Specifies whether the analyzer is an external access or unused access analyzer.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: unusedAccess. 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'}
    - unusedAccess (dict) –
      
      Specifies the configuration of an unused access analyzer for an Amazon Web Services organization or account.
      - unusedAccessAge (integer) –
        
        The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn’t been used in 90 or more days since the analyzer’s last scan. You can choose a value between 1 and 365 days.
      - analysisRule (dict) –
        
        Contains information about analysis rules for the analyzer. Analysis rules determine which entities will generate findings based on the criteria you define when you create the rule.
        
        exclusions (list) –
        
        A list of rules for the analyzer containing criteria to exclude from analysis. Entities that meet the rule criteria will not generate findings.
        
        (dict) –
        
        The criteria for an analysis rule for an analyzer. The criteria determine which entities will generate findings.
        
        accountIds (list) –
        
        A list of Amazon Web Services account IDs to apply to the analysis rule criteria. The accounts cannot include the organization analyzer owner account. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers. The list cannot include more than 2,000 account IDs.
        
        (string) –
        
        resourceTags (list) –
        
        An array of key-value pairs to match for your resources. You can use the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
        
        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.
        
        (dict) –
        
        (string) –
        
        (string) –

Exceptions

AccessAnalyzer.Client.exceptions.ResourceNotFoundException
AccessAnalyzer.Client.exceptions.ValidationException
AccessAnalyzer.Client.exceptions.InternalServerException
AccessAnalyzer.Client.exceptions.ThrottlingException
AccessAnalyzer.Client.exceptions.AccessDeniedException