EC2 / Client / get_declarative_policies_report_summary

get_declarative_policies_report_summary#

EC2.Client.get_declarative_policies_report_summary(**kwargs)#

Retrieves a summary of the account status report.

To view the full report, download it from the Amazon S3 bucket where it was saved. Reports are accessible only when they have the complete status. Reports with other statuses ( running, cancelled, or error) are not available in the S3 bucket. For more information about downloading objects from an S3 bucket, see Downloading objects in the Amazon Simple Storage Service User Guide.

For more information, see Generating the account status report for declarative policies in the Amazon Web Services Organizations User Guide.

Request Syntax

response = client.get_declarative_policies_report_summary(
    DryRun=True|False,
    ReportId='string'
)

Parameters:

DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
ReportId (string) –
[REQUIRED]

The ID of the report.

Return type:

dict

Returns:

Response Syntax

{
    'ReportId': 'string',
    'S3Bucket': 'string',
    'S3Prefix': 'string',
    'TargetId': 'string',
    'StartTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1),
    'NumberOfAccounts': 123,
    'NumberOfFailedAccounts': 123,
    'AttributeSummaries': [
        {
            'AttributeName': 'string',
            'MostFrequentValue': 'string',
            'NumberOfMatchedAccounts': 123,
            'NumberOfUnmatchedAccounts': 123,
            'RegionalSummaries': [
                {
                    'RegionName': 'string',
                    'NumberOfMatchedAccounts': 123,
                    'NumberOfUnmatchedAccounts': 123
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- ReportId (string) –
  
  The ID of the report.
- S3Bucket (string) –
  
  The name of the Amazon S3 bucket where the report is located.
- S3Prefix (string) –
  
  The prefix for your S3 object.
- TargetId (string) –
  
  The root ID, organizational unit ID, or account ID.
  
  Format:
  - For root: r-ab12
  - For OU: ou-ab12-cdef1234
  - For account: 123456789012
- StartTime (datetime) –
  
  The time when the report generation started.
- EndTime (datetime) –
  
  The time when the report generation ended.
- NumberOfAccounts (integer) –
  
  The total number of accounts associated with the specified targetId.
- NumberOfFailedAccounts (integer) –
  
  The number of accounts where attributes could not be retrieved in any Region.
- AttributeSummaries (list) –
  
  The attributes described in the report.
  - (dict) –
    
    A summary report for the attribute across all Regions.
    - AttributeName (string) –
      
      The name of the attribute.
    - MostFrequentValue (string) –
      
      The configuration value that is most frequently observed for the attribute.
    - NumberOfMatchedAccounts (integer) –
      
      The number of accounts with the same configuration value for the attribute that is most frequently observed.
    - NumberOfUnmatchedAccounts (integer) –
      
      The number of accounts with a configuration value different from the most frequently observed value for the attribute.
    - RegionalSummaries (list) –
      
      The summary report for each Region for the attribute.
      - (dict) –
        
        A summary report for the attribute for a Region.
        
        RegionName (string) –
        
        The Amazon Web Services Region.
        
        NumberOfMatchedAccounts (integer) –
        
        The number of accounts in the Region with the same configuration value for the attribute that is most frequently observed.
        
        NumberOfUnmatchedAccounts (integer) –
        
        The number of accounts in the Region with a configuration value different from the most frequently observed value for the attribute.