Skip to content

Describe Capacity Manager Data Exports

ec2_describe_capacity_manager_data_exports R Documentation

Describes one or more Capacity Manager data export configurations

Description

Describes one or more Capacity Manager data export configurations. Returns information about export settings, delivery status, and recent export activity.

Usage

ec2_describe_capacity_manager_data_exports(CapacityManagerDataExportIds,
  MaxResults, NextToken, DryRun, Filters)

Arguments

CapacityManagerDataExportIds

The IDs of the data export configurations to describe. If not specified, all export configurations are returned.

MaxResults

The maximum number of results to return in a single call. If not specified, up to 1000 results are returned.

NextToken

The token for the next page of results. Use this value in a subsequent call to retrieve additional results.

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.

Filters

One or more filters to narrow the results. Supported filters include export status, creation date, and S3 bucket name.

Value

A list with the following syntax:

list(
  CapacityManagerDataExports = list(
    list(
      CapacityManagerDataExportId = "string",
      S3BucketName = "string",
      S3BucketPrefix = "string",
      Schedule = "hourly",
      OutputFormat = "csv"|"parquet",
      CreateTime = as.POSIXct(
        "2015-01-01"
      ),
      LatestDeliveryStatus = "pending"|"in-progress"|"delivered"|"failed",
      LatestDeliveryStatusMessage = "string",
      LatestDeliveryS3LocationUri = "string",
      LatestDeliveryTime = as.POSIXct(
        "2015-01-01"
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_capacity_manager_data_exports(
  CapacityManagerDataExportIds = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string",
  DryRun = TRUE|FALSE,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  )
)