AWS API Changes

2019/09/20 - Amazon Relational Database Service - 2 updated api methods

Changes Add a new LeaseID output field to DescribeReservedDBInstances, which shows the unique identifier for the lease associated with the reserved DB instance. AWS Support might request the lease ID for an issue related to a reserved DB instance.

DescribeReservedDBInstances (updated)

Link ¶
Changes (request, response)
Request

{'LeaseId': 'string'}

Response

{'ReservedDBInstances': {'LeaseId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.describe_reserved_db_instances(
    ReservedDBInstanceId='string',
    ReservedDBInstancesOfferingId='string',
    DBInstanceClass='string',
    Duration='string',
    ProductDescription='string',
    OfferingType='string',
    MultiAZ=True|False,
    LeaseId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

type ReservedDBInstanceId

string

param ReservedDBInstanceId

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

type ReservedDBInstancesOfferingId

string

param ReservedDBInstancesOfferingId

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

type DBInstanceClass

string

param DBInstanceClass

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

type Duration

string

param 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

type ProductDescription

string

param ProductDescription

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

type OfferingType

string

param 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"

type MultiAZ

boolean

param MultiAZ

A value that indicates whether to show only those reservations that support Multi-AZ.

type LeaseId

string

param LeaseId

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

Note

AWS Support might request the lease ID for an issue related to a reserved DB instance.

type Filters

list

param Filters

This parameter is not currently supported.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:
- DescribeDBClusterBacktracks
- DescribeDBClusterEndpoints
- DescribeDBClusters
- DescribeDBInstances
- DescribePendingMaintenanceActions
- Name (string) -- [REQUIRED]
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) -- [REQUIRED]
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type MaxRecords

integer

param 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 that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker

string

param 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 .

rtype

dict

returns

Response Syntax

{
    'Marker': 'string',
    'ReservedDBInstances': [
        {
            'ReservedDBInstanceId': 'string',
            'ReservedDBInstancesOfferingId': 'string',
            'DBInstanceClass': 'string',
            'StartTime': datetime(2015, 1, 1),
            'Duration': 123,
            'FixedPrice': 123.0,
            'UsagePrice': 123.0,
            'CurrencyCode': 'string',
            'DBInstanceCount': 123,
            'ProductDescription': 'string',
            'OfferingType': 'string',
            'MultiAZ': True|False,
            'State': 'string',
            'RecurringCharges': [
                {
                    'RecurringChargeAmount': 123.0,
                    'RecurringChargeFrequency': 'string'
                },
            ],
            'ReservedDBInstanceArn': 'string',
            'LeaseId': 'string'
        },
    ]
}

Response Structure

(dict) --

Contains the result of a successful invocation of the DescribeReservedDBInstances action.
- Marker (string) --
  
  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 .
- ReservedDBInstances (list) --
  
  A list of reserved DB instances.
  - (dict) --
    
    This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
    - ReservedDBInstanceId (string) --
      
      The unique identifier for the reservation.
    - ReservedDBInstancesOfferingId (string) --
      
      The offering identifier.
    - DBInstanceClass (string) --
      
      The DB instance class for the reserved DB instance.
    - StartTime (datetime) --
      
      The time the reservation started.
    - Duration (integer) --
      
      The duration of the reservation in seconds.
    - FixedPrice (float) --
      
      The fixed price charged for this reserved DB instance.
    - UsagePrice (float) --
      
      The hourly price charged for this reserved DB instance.
    - CurrencyCode (string) --
      
      The currency code for the reserved DB instance.
    - DBInstanceCount (integer) --
      
      The number of reserved DB instances.
    - ProductDescription (string) --
      
      The description of the reserved DB instance.
    - OfferingType (string) --
      
      The offering type of this reserved DB instance.
    - MultiAZ (boolean) --
      
      Indicates if the reservation applies to Multi-AZ deployments.
    - State (string) --
      
      The state of the reserved DB instance.
    - RecurringCharges (list) --
      
      The recurring price charged to run this reserved DB instance.
      - (dict) --
        
        This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
        
        RecurringChargeAmount (float) --
        
        The amount of the recurring charge.
        
        RecurringChargeFrequency (string) --
        
        The frequency of the recurring charge.
    - ReservedDBInstanceArn (string) --
      
      The Amazon Resource Name (ARN) for the reserved DB instance.
    - LeaseId (string) --
      
      The unique identifier for the lease associated with the reserved DB instance.
      
      Note
      
      AWS Support might request the lease ID for an issue related to a reserved DB instance.

PurchaseReservedDBInstancesOffering (updated)

Link ¶
Changes (response)

{'ReservedDBInstance': {'LeaseId': 'string'}}

Purchases a reserved DB instance offering.

See also: AWS API Documentation

Request Syntax

client.purchase_reserved_db_instances_offering(
    ReservedDBInstancesOfferingId='string',
    ReservedDBInstanceId='string',
    DBInstanceCount=123,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ReservedDBInstancesOfferingId

string

param ReservedDBInstancesOfferingId

[REQUIRED]

The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

type ReservedDBInstanceId

string

param ReservedDBInstanceId

Customer-specified identifier to track this reservation.

Example: myreservationID

type DBInstanceCount

integer

param DBInstanceCount

The number of instances to reserve.

Default: 1

type Tags

list

param Tags

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

(dict) --

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
- Key (string) --
  
  A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
- Value (string) --
  
  A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

rtype

dict

returns

Response Syntax

{
    'ReservedDBInstance': {
        'ReservedDBInstanceId': 'string',
        'ReservedDBInstancesOfferingId': 'string',
        'DBInstanceClass': 'string',
        'StartTime': datetime(2015, 1, 1),
        'Duration': 123,
        'FixedPrice': 123.0,
        'UsagePrice': 123.0,
        'CurrencyCode': 'string',
        'DBInstanceCount': 123,
        'ProductDescription': 'string',
        'OfferingType': 'string',
        'MultiAZ': True|False,
        'State': 'string',
        'RecurringCharges': [
            {
                'RecurringChargeAmount': 123.0,
                'RecurringChargeFrequency': 'string'
            },
        ],
        'ReservedDBInstanceArn': 'string',
        'LeaseId': 'string'
    }
}

Response Structure

(dict) --
- ReservedDBInstance (dict) --
  
  This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
  - ReservedDBInstanceId (string) --
    
    The unique identifier for the reservation.
  - ReservedDBInstancesOfferingId (string) --
    
    The offering identifier.
  - DBInstanceClass (string) --
    
    The DB instance class for the reserved DB instance.
  - StartTime (datetime) --
    
    The time the reservation started.
  - Duration (integer) --
    
    The duration of the reservation in seconds.
  - FixedPrice (float) --
    
    The fixed price charged for this reserved DB instance.
  - UsagePrice (float) --
    
    The hourly price charged for this reserved DB instance.
  - CurrencyCode (string) --
    
    The currency code for the reserved DB instance.
  - DBInstanceCount (integer) --
    
    The number of reserved DB instances.
  - ProductDescription (string) --
    
    The description of the reserved DB instance.
  - OfferingType (string) --
    
    The offering type of this reserved DB instance.
  - MultiAZ (boolean) --
    
    Indicates if the reservation applies to Multi-AZ deployments.
  - State (string) --
    
    The state of the reserved DB instance.
  - RecurringCharges (list) --
    
    The recurring price charged to run this reserved DB instance.
    - (dict) --
      
      This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
      - RecurringChargeAmount (float) --
        
        The amount of the recurring charge.
      - RecurringChargeFrequency (string) --
        
        The frequency of the recurring charge.
  - ReservedDBInstanceArn (string) --
    
    The Amazon Resource Name (ARN) for the reserved DB instance.
  - LeaseId (string) --
    
    The unique identifier for the lease associated with the reserved DB instance.
    
    Note
    
    AWS Support might request the lease ID for an issue related to a reserved DB instance.