AWS API Changes

2019/10/17 - Amazon Relational Database Service - 6 new api methods

Changes Update rds client to latest version

ImportInstallationMedia (new)

Link ¶

Imports the installation media for an on-premises, bring your own media (BYOM) DB engine, such as SQL Server.

Request Syntax

client.import_installation_media(
    CustomAvailabilityZoneId='string',
    Engine='string',
    EngineVersion='string',
    EngineInstallationMediaPath='string',
    OSInstallationMediaPath='string'
)

type CustomAvailabilityZoneId:

string

param CustomAvailabilityZoneId:

[REQUIRED]

The identifier of the custom Availability Zone (AZ) to import the installation media to.

type Engine:

string

param Engine:

[REQUIRED]

The name of the database engine to be used for this instance.

The list only includes supported on-premises, bring your own media (BYOM) DB engines.

Valid Values:

sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web

type EngineVersion:

string

param EngineVersion:

[REQUIRED]

The version number of the database engine to use.

For a list of valid engine versions, call DescribeDBEngineVersions.

The following are the database engines and links to information about the major and minor versions. The list only includes supported on-premises, bring your own media (BYOM) DB engines.

Microsoft SQL Server

See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

type EngineInstallationMediaPath:

string

param EngineInstallationMediaPath:

[REQUIRED]

The path to the installation media for the specified DB engine.

Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso

type OSInstallationMediaPath:

string

param OSInstallationMediaPath:

[REQUIRED]

The path to the installation media for the operating system associated with the specified DB engine.

Example: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso

rtype:

dict

returns:

Response Syntax

{
    'InstallationMediaId': 'string',
    'CustomAvailabilityZoneId': 'string',
    'Engine': 'string',
    'EngineVersion': 'string',
    'EngineInstallationMediaPath': 'string',
    'OSInstallationMediaPath': 'string',
    'Status': 'string',
    'FailureCause': {
        'Message': 'string'
    }
}

Response Structure

(dict) --

Contains the installation media for on-premises, bring your own media (BYOM) DB engines, such as Microsoft SQL Server.
- InstallationMediaId (string) --
  
  The installation media ID.
- CustomAvailabilityZoneId (string) --
  
  The custom Availability Zone (AZ) that contains the installation media.
- Engine (string) --
  
  The DB engine.
- EngineVersion (string) --
  
  The engine version of the DB engine.
- EngineInstallationMediaPath (string) --
  
  The path to the installation media for the DB engine.
- OSInstallationMediaPath (string) --
  
  The path to the installation media for the operating system associated with the DB engine.
- Status (string) --
  
  The status of the installation media.
- FailureCause (dict) --
  
  If an installation media failure occurred, the cause of the failure.
  - Message (string) --
    
    The reason that an installation media import failed.

DescribeCustomAvailabilityZones (new)

Link ¶

Returns information about custom Availability Zones (AZs).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the RDS on VMware User Guide.

See also: AWS API Documentation

Request Syntax

client.describe_custom_availability_zones(
    CustomAvailabilityZoneId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

type CustomAvailabilityZoneId:

string

param CustomAvailabilityZoneId:

The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.

type Filters:

list

param Filters:

A filter that specifies one or more custom AZs to describe.

(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 records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker:

string

param Marker:

An optional pagination token provided by a previous DescribeCustomAvailabilityZones 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',
    'CustomAvailabilityZones': [
        {
            'CustomAvailabilityZoneId': 'string',
            'CustomAvailabilityZoneName': 'string',
            'CustomAvailabilityZoneStatus': 'string',
            'VpnDetails': {
                'VpnId': 'string',
                'VpnTunnelOriginatorIP': 'string',
                'VpnGatewayIp': 'string',
                'VpnPSK': 'string',
                'VpnName': 'string',
                'VpnState': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- Marker (string) --
  
  An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- CustomAvailabilityZones (list) --
  
  The list of CustomAvailabilityZone objects for the AWS account.
  - (dict) --
    
    A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.
    
    For more information about RDS on VMware, see the RDS on VMware User Guide.
    - CustomAvailabilityZoneId (string) --
      
      The identifier of the custom AZ.
      
      Amazon RDS generates a unique identifier when a custom AZ is created.
    - CustomAvailabilityZoneName (string) --
      
      The name of the custom AZ.
    - CustomAvailabilityZoneStatus (string) --
      
      The status of the custom AZ.
    - VpnDetails (dict) --
      
      Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.
      - VpnId (string) --
        
        The ID of the VPN.
      - VpnTunnelOriginatorIP (string) --
        
        The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.
      - VpnGatewayIp (string) --
        
        The IP address of network traffic from AWS to your on-premises data center.
      - VpnPSK (string) --
        
        The preshared key (PSK) for the VPN.
      - VpnName (string) --
        
        The name of the VPN.
      - VpnState (string) --
        
        The state of the VPN.

DeleteCustomAvailabilityZone (new)

Link ¶

Deletes a custom Availability Zone (AZ).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the RDS on VMware User Guide.

See also: AWS API Documentation

Request Syntax

client.delete_custom_availability_zone(
    CustomAvailabilityZoneId='string'
)

type CustomAvailabilityZoneId:

string

param CustomAvailabilityZoneId:

[REQUIRED]

The custom AZ identifier.

rtype:

dict

returns:

Response Syntax

{
    'CustomAvailabilityZone': {
        'CustomAvailabilityZoneId': 'string',
        'CustomAvailabilityZoneName': 'string',
        'CustomAvailabilityZoneStatus': 'string',
        'VpnDetails': {
            'VpnId': 'string',
            'VpnTunnelOriginatorIP': 'string',
            'VpnGatewayIp': 'string',
            'VpnPSK': 'string',
            'VpnName': 'string',
            'VpnState': 'string'
        }
    }
}

Response Structure

(dict) --
- CustomAvailabilityZone (dict) --
  
  A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.
  
  For more information about RDS on VMware, see the RDS on VMware User Guide.
  - CustomAvailabilityZoneId (string) --
    
    The identifier of the custom AZ.
    
    Amazon RDS generates a unique identifier when a custom AZ is created.
  - CustomAvailabilityZoneName (string) --
    
    The name of the custom AZ.
  - CustomAvailabilityZoneStatus (string) --
    
    The status of the custom AZ.
  - VpnDetails (dict) --
    
    Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.
    - VpnId (string) --
      
      The ID of the VPN.
    - VpnTunnelOriginatorIP (string) --
      
      The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.
    - VpnGatewayIp (string) --
      
      The IP address of network traffic from AWS to your on-premises data center.
    - VpnPSK (string) --
      
      The preshared key (PSK) for the VPN.
    - VpnName (string) --
      
      The name of the VPN.
    - VpnState (string) --
      
      The state of the VPN.

DeleteInstallationMedia (new)

Link ¶

Deletes the installation media for an on-premises, bring your own media (BYOM) DB engine, such as Microsoft SQL Server.

See also: AWS API Documentation

Request Syntax

client.delete_installation_media(
    InstallationMediaId='string'
)

type InstallationMediaId:

string

param InstallationMediaId:

[REQUIRED]

The installation media ID.

rtype:

dict

returns:

Response Syntax

{
    'InstallationMediaId': 'string',
    'CustomAvailabilityZoneId': 'string',
    'Engine': 'string',
    'EngineVersion': 'string',
    'EngineInstallationMediaPath': 'string',
    'OSInstallationMediaPath': 'string',
    'Status': 'string',
    'FailureCause': {
        'Message': 'string'
    }
}

Response Structure

(dict) --

Contains the installation media for on-premises, bring your own media (BYOM) DB engines, such as Microsoft SQL Server.
- InstallationMediaId (string) --
  
  The installation media ID.
- CustomAvailabilityZoneId (string) --
  
  The custom Availability Zone (AZ) that contains the installation media.
- Engine (string) --
  
  The DB engine.
- EngineVersion (string) --
  
  The engine version of the DB engine.
- EngineInstallationMediaPath (string) --
  
  The path to the installation media for the DB engine.
- OSInstallationMediaPath (string) --
  
  The path to the installation media for the operating system associated with the DB engine.
- Status (string) --
  
  The status of the installation media.
- FailureCause (dict) --
  
  If an installation media failure occurred, the cause of the failure.
  - Message (string) --
    
    The reason that an installation media import failed.

DescribeInstallationMedia (new)

Link ¶

Describes the available installation media for on-premises, bring your own media (BYOM) DB engines, such as Microsoft SQL Server.

See also: AWS API Documentation

Request Syntax

client.describe_installation_media(
    InstallationMediaId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

type InstallationMediaId:

string

param InstallationMediaId:

The installation media ID.

type Filters:

list

param Filters:

A filter that specifies one or more installation media to describe. Supported filters include the following:

custom-availability-zone-id - Accepts custom Availability Zone (AZ) identifiers. The results list includes information about only the custom AZs identified by these identifiers.
engine - Accepts database engines. The results list includes information about only the database engines identified by these identifiers. For more information about the valid engines for installation media, see ImportInstallationMedia.

(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:

An optional pagination token provided by a previous DescribeInstallationMedia request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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',
    'InstallationMedia': [
        {
            'InstallationMediaId': 'string',
            'CustomAvailabilityZoneId': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'EngineInstallationMediaPath': 'string',
            'OSInstallationMediaPath': 'string',
            'Status': 'string',
            'FailureCause': {
                'Message': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- Marker (string) --
  
  An optional pagination token provided by a previous DescribeInstallationMedia request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- InstallationMedia (list) --
  
  The list of InstallationMedia objects for the AWS account.
  - (dict) --
    
    Contains the installation media for on-premises, bring your own media (BYOM) DB engines, such as Microsoft SQL Server.
    - InstallationMediaId (string) --
      
      The installation media ID.
    - CustomAvailabilityZoneId (string) --
      
      The custom Availability Zone (AZ) that contains the installation media.
    - Engine (string) --
      
      The DB engine.
    - EngineVersion (string) --
      
      The engine version of the DB engine.
    - EngineInstallationMediaPath (string) --
      
      The path to the installation media for the DB engine.
    - OSInstallationMediaPath (string) --
      
      The path to the installation media for the operating system associated with the DB engine.
    - Status (string) --
      
      The status of the installation media.
    - FailureCause (dict) --
      
      If an installation media failure occurred, the cause of the failure.
      - Message (string) --
        
        The reason that an installation media import failed.

CreateCustomAvailabilityZone (new)

Link ¶

Creates a custom Availability Zone (AZ).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the RDS on VMware User Guide.

See also: AWS API Documentation

Request Syntax

client.create_custom_availability_zone(
    CustomAvailabilityZoneName='string',
    ExistingVpnId='string',
    NewVpnTunnelName='string',
    VpnTunnelOriginatorIP='string'
)

type CustomAvailabilityZoneName:

string

param CustomAvailabilityZoneName:

[REQUIRED]

The name of the custom Availability Zone (AZ).

type ExistingVpnId:

string

param ExistingVpnId:

The ID of an existing virtual private network (VPN) between the Amazon RDS website and the VMware vSphere cluster.

type NewVpnTunnelName:

string

param NewVpnTunnelName:

The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster.

Specify this parameter only if ExistingVpnId is not specified.

type VpnTunnelOriginatorIP:

string

param VpnTunnelOriginatorIP:

The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

Specify this parameter only if ExistingVpnId is not specified.

rtype:

dict

returns:

Response Syntax

{
    'CustomAvailabilityZone': {
        'CustomAvailabilityZoneId': 'string',
        'CustomAvailabilityZoneName': 'string',
        'CustomAvailabilityZoneStatus': 'string',
        'VpnDetails': {
            'VpnId': 'string',
            'VpnTunnelOriginatorIP': 'string',
            'VpnGatewayIp': 'string',
            'VpnPSK': 'string',
            'VpnName': 'string',
            'VpnState': 'string'
        }
    }
}

Response Structure

(dict) --
- CustomAvailabilityZone (dict) --
  
  A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.
  
  For more information about RDS on VMware, see the RDS on VMware User Guide.
  - CustomAvailabilityZoneId (string) --
    
    The identifier of the custom AZ.
    
    Amazon RDS generates a unique identifier when a custom AZ is created.
  - CustomAvailabilityZoneName (string) --
    
    The name of the custom AZ.
  - CustomAvailabilityZoneStatus (string) --
    
    The status of the custom AZ.
  - VpnDetails (dict) --
    
    Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.
    - VpnId (string) --
      
      The ID of the VPN.
    - VpnTunnelOriginatorIP (string) --
      
      The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.
    - VpnGatewayIp (string) --
      
      The IP address of network traffic from AWS to your on-premises data center.
    - VpnPSK (string) --
      
      The preshared key (PSK) for the VPN.
    - VpnName (string) --
      
      The name of the VPN.
    - VpnState (string) --
      
      The state of the VPN.