EC2 / Client / describe_declarative_policies_reports

describe_declarative_policies_reports#

EC2.Client.describe_declarative_policies_reports(**kwargs)#

Describes the metadata of an account status report, including the status of the 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.describe_declarative_policies_reports(
    DryRun=True|False,
    NextToken='string',
    MaxResults=123,
    ReportIds=[
        '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.
NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults (integer) – The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
ReportIds (list) –
One or more report IDs.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Reports': [
        {
            'ReportId': 'string',
            'S3Bucket': 'string',
            'S3Prefix': 'string',
            'TargetId': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'Status': 'running'|'cancelled'|'complete'|'error',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  The token to include in another request to get the next page of items. This value is null when there are no more items to return.
- Reports (list) –
  
  The report metadata.
  - (dict) –
    
    Describes the metadata of the account status report.
    - 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.
    - Status (string) –
      
      The current status of the report.
    - Tags (list) –
      
      Any tags assigned to the report.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.