AWS API Changes

2015/10/01 - Amazon Relational Database Service - 2 updated api methods

DescribeDBEngineVersions (updated)

Link ¶
Changes (response)

{'DBEngineVersions': {'ValidUpgradeTarget': [{'AutoUpgrade': 'boolean',
                                              'Description': 'string',
                                              'Engine': 'string',
                                              'EngineVersion': 'string',
                                              'IsMajorVersionUpgrade': 'boolean'}]}}

Returns a list of the available DB engines.

Request Syntax

client.describe_db_engine_versions(
    Engine='string',
    EngineVersion='string',
    DBParameterGroupFamily='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    DefaultOnly=True|False,
    ListSupportedCharacterSets=True|False
)

type Engine

string

param Engine

The database engine to return.

type EngineVersion

string

param EngineVersion

The database engine version to return.

Example: 5.1.49

type DBParameterGroupFamily

string

param DBParameterGroupFamily

The name of a specific DB parameter group family to return details for.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

type Filters

list

param Filters

Not currently supported.

(dict) --
- Name (string) -- [REQUIRED]
  
  This parameter is not currently supported.
- Values (list) -- [REQUIRED]
  
  This parameter is not currently supported.
  - (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 .

type DefaultOnly

boolean

param DefaultOnly

Indicates that only the default version of the specified engine or engine and major version combination is returned.

type ListSupportedCharacterSets

boolean

param ListSupportedCharacterSets

If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

rtype

dict

returns

Response Syntax

{
    'Marker': 'string',
    'DBEngineVersions': [
        {
            'Engine': 'string',
            'EngineVersion': 'string',
            'DBParameterGroupFamily': 'string',
            'DBEngineDescription': 'string',
            'DBEngineVersionDescription': 'string',
            'DefaultCharacterSet': {
                'CharacterSetName': 'string',
                'CharacterSetDescription': 'string'
            },
            'SupportedCharacterSets': [
                {
                    'CharacterSetName': 'string',
                    'CharacterSetDescription': 'string'
                },
            ],
            'ValidUpgradeTarget': [
                {
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'Description': 'string',
                    'AutoUpgrade': True|False,
                    'IsMajorVersionUpgrade': True|False
                },
            ]
        },
    ]
}

Response Structure

(dict) --

Contains the result of a successful invocation of the DescribeDBEngineVersions 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 .
- DBEngineVersions (list) --
  
  A list of DBEngineVersion elements.
  - (dict) --
    
    This data type is used as a response element in the action DescribeDBEngineVersions.
    - Engine (string) --
      
      The name of the database engine.
    - EngineVersion (string) --
      
      The version number of the database engine.
    - DBParameterGroupFamily (string) --
      
      The name of the DB parameter group family for the database engine.
    - DBEngineDescription (string) --
      
      The description of the database engine.
    - DBEngineVersionDescription (string) --
      
      The description of the database engine version.
    - DefaultCharacterSet (dict) --
      
      The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.
      - CharacterSetName (string) --
        
        The name of the character set.
      - CharacterSetDescription (string) --
        
        The description of the character set.
    - SupportedCharacterSets (list) --
      
      A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.
      - (dict) --
        
        This data type is used as a response element in the action DescribeDBEngineVersions.
        
        CharacterSetName (string) --
        
        The name of the character set.
        
        CharacterSetDescription (string) --
        
        The description of the character set.
    - ValidUpgradeTarget (list) --
      
      A list of engine versions that this database engine version can be upgraded to.
      - (dict) --
        
        The version of the database engine that a DB instance can be upgraded to.
        
        Engine (string) --
        
        The name of the upgrade target database engine.
        
        EngineVersion (string) --
        
        The version number of the upgrade target database engine.
        
        Description (string) --
        
        The version of the database engine that a DB instance can be upgraded to.
        
        AutoUpgrade (boolean) --
        
        A value that indicates whether the target version will be applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
        
        IsMajorVersionUpgrade (boolean) --
        
        A value that indicates whether a database engine will be upgraded to a major version.

DescribeEvents (updated)

Link ¶
Changes (request, response)
Request

{'SourceType': {'db-cluster-snapshot', 'db-cluster'}}

Response

{'Events': {'SourceType': {'db-cluster-snapshot', 'db-cluster'}}}

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Request Syntax

client.describe_events(
    SourceIdentifier='string',
    SourceType='db-instance'|'db-parameter-group'|'db-security-group'|'db-cluster'|'db-cluster-snapshot',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Duration=123,
    EventCategories=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

type SourceIdentifier

string

param SourceIdentifier

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType must also be provided.
If the source type is DBInstance , then a DBInstanceIdentifier must be supplied.
If the source type is DBSecurityGroup , a DBSecurityGroupName must be supplied.
If the source type is DBParameterGroup , a DBParameterGroupName must be supplied.
If the source type is DBSnapshot , a DBSnapshotIdentifier must be supplied.
Cannot end with a hyphen or contain two consecutive hyphens.

type SourceType

string

param SourceType

The event source to retrieve events for. If no value is specified, all events are returned.

type StartTime

datetime

param StartTime

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

type EndTime

datetime

param EndTime

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

type Duration

integer

param Duration

The number of minutes to retrieve events for.

Default: 60

type EventCategories

list

param EventCategories

A list of event categories that trigger notifications for a event notification subscription.

(string) --

type Filters

list

param Filters

This parameter is not currently supported.

(dict) --
- Name (string) -- [REQUIRED]
  
  This parameter is not currently supported.
- Values (list) -- [REQUIRED]
  
  This parameter is not currently supported.
  - (string) --

type MaxRecords

integer

param MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker

string

param Marker

An optional pagination token provided by a previous DescribeEvents 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',
    'Events': [
        {
            'SourceIdentifier': 'string',
            'SourceType': 'db-instance'|'db-parameter-group'|'db-security-group'|'db-cluster'|'db-cluster-snapshot',
            'Message': 'string',
            'EventCategories': [
                'string',
            ],
            'Date': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) --

Contains the result of a successful invocation of the DescribeEvents action.
- Marker (string) --
  
  An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
- Events (list) --
  
  A list of Event instances.
  - (dict) --
    
    This data type is used as a response element in the DescribeEvents action.
    - SourceIdentifier (string) --
      
      Provides the identifier for the source of the event.
    - SourceType (string) --
      
      Specifies the source type for this event.
    - Message (string) --
      
      Provides the text of this event.
    - EventCategories (list) --
      
      Specifies the category for the event.
      - (string) --
    - Date (datetime) --
      
      Specifies the date and time of the event.