Get Declarative Policies Report Summary

ec2_get_declarative_policies_report_summary

R Documentation

Retrieves a summary of the account status report¶

Description¶

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.

Usage¶

ec2_get_declarative_policies_report_summary(DryRun, ReportId)

Arguments¶

DryRun: 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: [required] The ID of the report.

Value¶

A list with the following syntax:

list(
  ReportId = "string",
  S3Bucket = "string",
  S3Prefix = "string",
  TargetId = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  NumberOfAccounts = 123,
  NumberOfFailedAccounts = 123,
  AttributeSummaries = list(
    list(
      AttributeName = "string",
      MostFrequentValue = "string",
      NumberOfMatchedAccounts = 123,
      NumberOfUnmatchedAccounts = 123,
      RegionalSummaries = list(
        list(
          RegionName = "string",
          NumberOfMatchedAccounts = 123,
          NumberOfUnmatchedAccounts = 123
        )
      )
    )
  )
)

Request syntax¶

svc$get_declarative_policies_report_summary(
  DryRun = TRUE|FALSE,
  ReportId = "string"
)