Describe Recommendation Export Jobs

computeoptimizer_describe_recommendation_export_jobs

R Documentation

Describes recommendation export jobs created in the last seven days

Description

Describes recommendation export jobs created in the last seven days.

Use the export_auto_scaling_group_recommendations or export_ec2_instance_recommendations actions to request an export of your recommendations. Then use the describe_recommendation_export_jobs action to view your export jobs.

Usage

computeoptimizer_describe_recommendation_export_jobs(jobIds, filters,
  nextToken, maxResults)

Arguments

jobIds

The identification numbers of the export jobs to return.

An export job ID is returned when you create an export using the export_auto_scaling_group_recommendations or export_ec2_instance_recommendations actions.

All export jobs created in the last seven days are returned if this parameter is omitted.

filters

An array of objects to specify a filter that returns a more specific list of export jobs.

nextToken

The token to advance to the next page of export jobs.

maxResults

The maximum number of export jobs to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

Value

A list with the following syntax:

list(
  recommendationExportJobs = list(
    list(
      jobId = "string",
      destination = list(
        s3 = list(
          bucket = "string",
          key = "string",
          metadataKey = "string"
        )
      ),
      resourceType = "Ec2Instance"|"AutoScalingGroup"|"EbsVolume"|"LambdaFunction"|"NotApplicable"|"EcsService"|"License"|"RdsDBInstance",
      status = "Queued"|"InProgress"|"Complete"|"Failed",
      creationTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      lastUpdatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      failureReason = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_recommendation_export_jobs(
  jobIds = list(
    "string"
  ),
  filters = list(
    list(
      name = "ResourceType"|"JobStatus",
      values = list(
        "string"
      )
    )
  ),
  nextToken = "string",
  maxResults = 123
)