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',
        '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'
        }
    }
}

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.

Exceptions

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