Skip to content

Describe Declarative Policies Reports

ec2_describe_declarative_policies_reports R Documentation

Describes the metadata of an account status report, including the status of the report

Description

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.

Usage

ec2_describe_declarative_policies_reports(DryRun, NextToken, MaxResults,
  ReportIds)

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.

NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

MaxResults

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

One or more report IDs.

Value

A list with the following syntax: 

list(
  NextToken = "string",
  Reports = list(
    list(
      ReportId = "string",
      S3Bucket = "string",
      S3Prefix = "string",
      TargetId = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      Status = "running"|"cancelled"|"complete"|"error",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  )
)

Request syntax

svc$describe_declarative_policies_reports(
  DryRun = TRUE|FALSE,
  NextToken = "string",
  MaxResults = 123,
  ReportIds = list(
    "string"
  )
)