Skip to content

Get Capacity Reservation

athena_get_capacity_reservation R Documentation

Returns information about the capacity reservation with the specified name

Description

Returns information about the capacity reservation with the specified name.

Usage

athena_get_capacity_reservation(Name)

Arguments

Name

[required] The name of the capacity reservation.

Value

A list with the following syntax:

list(
  CapacityReservation = list(
    Name = "string",
    Status = "PENDING"|"ACTIVE"|"CANCELLING"|"CANCELLED"|"FAILED"|"UPDATE_PENDING",
    TargetDpus = 123,
    AllocatedDpus = 123,
    LastAllocation = list(
      Status = "PENDING"|"SUCCEEDED"|"FAILED",
      StatusMessage = "string",
      RequestTime = as.POSIXct(
        "2015-01-01"
      ),
      RequestCompletionTime = as.POSIXct(
        "2015-01-01"
      )
    ),
    LastSuccessfulAllocationTime = as.POSIXct(
      "2015-01-01"
    ),
    CreationTime = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$get_capacity_reservation(
  Name = "string"
)