Describe Reserved Db Instances

rds_describe_reserved_db_instances

R Documentation

Returns information about reserved DB instances for this account, or about a specified reserved DB instance

Description

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

Usage

rds_describe_reserved_db_instances(ReservedDBInstanceId,
  ReservedDBInstancesOfferingId, DBInstanceClass, Duration,
  ProductDescription, OfferingType, MultiAZ, LeaseId, Filters, MaxRecords,
  Marker)

Arguments

ReservedDBInstanceId	The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
ReservedDBInstancesOfferingId	The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.
DBInstanceClass	The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
Duration	The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
ProductDescription	The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
OfferingType	The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
MultiAZ	Specifies whether to show only those reservations that support Multi-AZ.
LeaseId	The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID. Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
Filters	This parameter isn't currently supported.
MaxRecords	The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
Marker	An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Value

A list with the following syntax:

list(
  Marker = "string",
  ReservedDBInstances = list(
    list(
      ReservedDBInstanceId = "string",
      ReservedDBInstancesOfferingId = "string",
      DBInstanceClass = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      Duration = 123,
      FixedPrice = 123.0,
      UsagePrice = 123.0,
      CurrencyCode = "string",
      DBInstanceCount = 123,
      ProductDescription = "string",
      OfferingType = "string",
      MultiAZ = TRUE|FALSE,
      State = "string",
      RecurringCharges = list(
        list(
          RecurringChargeAmount = 123.0,
          RecurringChargeFrequency = "string"
        )
      ),
      ReservedDBInstanceArn = "string",
      LeaseId = "string"
    )
  )
)

Request syntax

svc$describe_reserved_db_instances(
  ReservedDBInstanceId = "string",
  ReservedDBInstancesOfferingId = "string",
  DBInstanceClass = "string",
  Duration = "string",
  ProductDescription = "string",
  OfferingType = "string",
  MultiAZ = TRUE|FALSE,
  LeaseId = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)

Examples

## Not run: 
# This example lists information for all reserved DB instances for the
# specified DB instance class, duration, product, offering type, and
# availability zone settings.
svc$describe_reserved_db_instances(
  DBInstanceClass = "db.t2.micro",
  Duration = "1y",
  MultiAZ = FALSE,
  OfferingType = "No Upfront",
  ProductDescription = "mysql"
)

## End(Not run)