Describe Image Usage Reports

ec2_describe_image_usage_reports

R Documentation

Describes the configuration and status of image usage reports, filtered by report IDs or image IDs

Description

Describes the configuration and status of image usage reports, filtered by report IDs or image IDs.

For more information, see View your AMI usage in the Amazon EC2 User Guide.

Usage

ec2_describe_image_usage_reports(ImageIds, ReportIds, NextToken,
  Filters, DryRun, MaxResults)

Arguments

ImageIds	The IDs of the images for filtering the reports. If specified, only reports containing these images are returned.
ReportIds	The IDs of the image usage reports.
NextToken	The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Filters	The filters. creation-time - The time when the report was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, ⁠2025-11-29T11:04:43.305Z⁠. You can use a wildcard (*), for example, ⁠2025-11-29T*⁠, which matches an entire day. state - The state of the report (available | pending | error). ⁠tag:<key>⁠ - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
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.
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.

Value

A list with the following syntax:

list(
  NextToken = "string",
  ImageUsageReports = list(
    list(
      ImageId = "string",
      ReportId = "string",
      ResourceTypes = list(
        list(
          ResourceType = "string",
          ResourceTypeOptions = list(
            list(
              OptionName = "string",
              OptionValues = list(
                "string"
              )
            )
          )
        )
      ),
      AccountIds = list(
        "string"
      ),
      State = "string",
      StateReason = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      ExpirationTime = as.POSIXct(
        "2015-01-01"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  )
)

Request syntax

svc$describe_image_usage_reports(
  ImageIds = list(
    "string"
  ),
  ReportIds = list(
    "string"
  ),
  NextToken = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE,
  MaxResults = 123
)