rdb ¶

Table of Contents

rdb

Client ¶

class rdb.Client¶

A low-level client representing NIFCLOUD RDB

client = session.create_client('rdb')

These are the available methods:

add_source_identifier_to_subscription()
authorize_db_security_group_ingress()
can_paginate()
copy_db_snapshot()
create_db_instance()
create_db_instance_read_replica()
create_db_parameter_group()
create_db_security_group()
create_db_snapshot()
create_event_subscription()
delete_db_instance()
delete_db_parameter_group()
delete_db_security_group()
delete_db_snapshot()
delete_event_subscription()
describe_certificates()
describe_db_engine_versions()
describe_db_instances()
describe_db_log_files()
describe_db_parameter_groups()
describe_db_parameters()
describe_db_security_groups()
describe_db_snapshots()
describe_engine_default_parameters()
describe_event_categories()
describe_event_subscriptions()
describe_events()
describe_orderable_db_instance_options()
download_db_log_file_portion()
generate_presigned_url()
get_paginator()
get_waiter()
modify_db_instance()
modify_db_instance_network()
modify_db_parameter_group()
modify_event_subscription()
nifty_failover_db_instance()
nifty_get_metric_statistics()
reboot_db_instance()
remove_source_identifier_from_subscription()
reset_db_parameter_group()
reset_external_master()
restore_db_instance_from_db_snapshot()
restore_db_instance_to_point_in_time()
revoke_db_security_group_ingress()
set_external_master()
start_replication()
stop_replication()
upgrade_db_engine_version()

add_source_identifier_to_subscription(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.add_source_identifier_to_subscription(
    SourceIdentifier='string',
    SubscriptionName='string'
)

Parameters:

SourceIdentifier (string) – [REQUIRED]
SubscriptionName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'EventSubscription': {
        'CustSubscriptionId': 'string',
        'Enabled': True|False,
        'EventCategoriesList': [
            'string',
        ],
        'NiftyDescription': 'string',
        'NiftyEmailAddressesList': [
            'string',
        ],
        'SourceIdsList': [
            'string',
        ],
        'SourceType': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- EventSubscription (dict) –
  - CustSubscriptionId (string) –
  - Enabled (boolean) –
  - EventCategoriesList (list) –
    - (string) –
  - NiftyDescription (string) –
  - NiftyEmailAddressesList (list) –
    - (string) –
  - SourceIdsList (list) –
    - (string) –
  - SourceType (string) –
  - Status (string) –
  - SubscriptionCreationTime (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

authorize_db_security_group_ingress(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.authorize_db_security_group_ingress(
    CIDRIP='string',
    DBSecurityGroupName='string',
    EC2SecurityGroupId='string',
    EC2SecurityGroupName='string',
    EC2SecurityGroupOwnerId='string'
)

Parameters:

CIDRIP (string) –
DBSecurityGroupName (string) – [REQUIRED]
EC2SecurityGroupId (string) –
EC2SecurityGroupName (string) –
EC2SecurityGroupOwnerId (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBSecurityGroup': {
        'DBSecurityGroupDescription': 'string',
        'DBSecurityGroupName': 'string',
        'EC2SecurityGroups': [
            {
                'EC2SecurityGroupName': 'string',
                'EC2SecurityGroupOwnerId': 'string',
                'Status': 'string'
            },
        ],
        'IPRanges': [
            {
                'CIDRIP': 'string',
                'Status': 'string'
            },
        ],
        'NiftyAvailabilityZone': 'string',
        'OwnerId': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBSecurityGroup (dict) –
  - DBSecurityGroupDescription (string) –
  - DBSecurityGroupName (string) –
  - EC2SecurityGroups (list) –
    - (dict) –
      - EC2SecurityGroupName (string) –
      - EC2SecurityGroupOwnerId (string) –
      - Status (string) –
  - IPRanges (list) –
    - (dict) –
      - CIDRIP (string) –
      - Status (string) –
  - NiftyAvailabilityZone (string) –
  - OwnerId (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters:	operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is `create_foo`, and you’d normally invoke the operation as `client.create_foo(**kwargs)`, if the `create_foo` operation can be paginated, you can use the call `client.get_paginator("create_foo")`.
Returns:	`True` if the operation can be paginated, `False` otherwise.

copy_db_snapshot(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.copy_db_snapshot(
    SourceDBSnapshotIdentifier='string',
    TargetDBSnapshotIdentifier='string'
)

Parameters:

SourceDBSnapshotIdentifier (string) – [REQUIRED]
TargetDBSnapshotIdentifier (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'DBSnapshot': {
        'AllocatedStorage': 123,
        'AvailabilityZone': 'string',
        'DBInstanceIdentifier': 'string',
        'DBSnapshotIdentifier': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'OptionGroupName': 'string',
        'Port': 123,
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'SnapshotType': 'string',
        'Status': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBSnapshot (dict) –
  - AllocatedStorage (integer) –
  - AvailabilityZone (string) –
  - DBInstanceIdentifier (string) –
  - DBSnapshotIdentifier (string) –
  - Engine (string) –
  - EngineVersion (string) –
  - InstanceCreateTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - OptionGroupName (string) –
  - Port (integer) –
  - SnapshotCreateTime (datetime) –
  - SnapshotType (string) –
  - Status (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

create_db_instance(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_db_instance(
    AccountingType='1'|'2',
    AllocatedStorage=123,
    AutoMinorVersionUpgrade=True|False,
    AvailabilityZone='string',
    BackupRetentionPeriod=123,
    CharacterSetName='string',
    DBInstanceClass='db.mini'|'db.e-small'|'db.small'|'db.e-small2'|'db.small2'|'db.e-small4'|'db.small4'|'db.e-small8'|'db.small8'|'db.e-small16'|'db.small16'|'db.e-medium'|'db.medium'|'db.e-medium4'|'db.medium4'|'db.e-medium8'|'db.medium8'|'db.e-medium16'|'db.medium16'|'db.e-medium24'|'db.medium24'|'db.e-large'|'db.large'|'db.e-large8'|'db.large8'|'db.e-large16'|'db.large16'|'db.e-large24'|'db.large24'|'db.e-large32'|'db.large32'|'db.e-extra-large8'|'db.extra-large8'|'db.e-extra-large16'|'db.extra-large16'|'db.e-extra-large24'|'db.extra-large24'|'db.e-extra-large32'|'db.extra-large32'|'db.e-extra-large48'|'db.extra-large48'|'db.e-double-large16'|'db.double-large16'|'db.e-double-large24'|'db.double-large24'|'db.e-double-large32'|'db.double-large32'|'db.e-double-large48'|'db.double-large48'|'db.e-double-large64'|'db.double-large64'|'db.e-double-large96'|'db.double-large96'|'db.triple-large32'|'db.triple-large48'|'db.triple-large64'|'db.triple-large96'|'db.triple-large128'|'db.quad-large64'|'db.quad-large96'|'db.quad-large128'|'db.septa-large128',
    DBInstanceIdentifier='string',
    DBName='string',
    DBParameterGroupName='string',
    DBSecurityGroups=[
        'string',
    ],
    DBSubnetGroupName='string',
    Engine='MySQL'|'postgres'|'MariaDB',
    EngineVersion='string',
    Iops=123,
    LicenseModel='string',
    MasterUserPassword='string',
    MasterUsername='string',
    MultiAZ=True|False,
    NiftyMasterPrivateAddress='string',
    NiftyMultiAZType=123,
    NiftyNetworkId='string',
    NiftyReadReplicaDBInstanceIdentifier='string',
    NiftyReadReplicaPrivateAddress='string',
    NiftySlavePrivateAddress='string',
    NiftyStorageType=123,
    NiftyVirtualPrivateAddress='string',
    OptionGroupName='string',
    Port=123,
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string',
    PubliclyAccessible=True|False,
    ReadReplicaAccountingType='1'|'2',
    VpcSecurityGroupIds=[
        'string',
    ]
)

Parameters:

AccountingType (string) –
AllocatedStorage (integer) – [REQUIRED]
AutoMinorVersionUpgrade (boolean) –
AvailabilityZone (string) –
BackupRetentionPeriod (integer) –
CharacterSetName (string) –
DBInstanceClass (string) – [REQUIRED]
DBInstanceIdentifier (string) – [REQUIRED]
DBName (string) –
DBParameterGroupName (string) –
DBSecurityGroups (list) –
- (string) –
DBSubnetGroupName (string) –
Engine (string) – [REQUIRED]
EngineVersion (string) –
Iops (integer) –
LicenseModel (string) –
MasterUserPassword (string) – [REQUIRED]
MasterUsername (string) – [REQUIRED]
MultiAZ (boolean) –
NiftyMasterPrivateAddress (string) –
NiftyMultiAZType (integer) –
NiftyNetworkId (string) –
NiftyReadReplicaDBInstanceIdentifier (string) –
NiftyReadReplicaPrivateAddress (string) –
NiftySlavePrivateAddress (string) –
NiftyStorageType (integer) –
NiftyVirtualPrivateAddress (string) –
OptionGroupName (string) –
Port (integer) –
PreferredBackupWindow (string) –
PreferredMaintenanceWindow (string) –
PubliclyAccessible (boolean) –
ReadReplicaAccountingType (string) –
VpcSecurityGroupIds (list) –
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

create_db_instance_read_replica(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_db_instance_read_replica(
    AccountingType='1'|'2',
    AutoMinorVersionUpgrade=True|False,
    AvailabilityZone='string',
    DBInstanceClass='db.mini'|'db.e-small'|'db.small'|'db.e-small2'|'db.small2'|'db.e-small4'|'db.small4'|'db.e-small8'|'db.small8'|'db.e-small16'|'db.small16'|'db.e-medium'|'db.medium'|'db.e-medium4'|'db.medium4'|'db.e-medium8'|'db.medium8'|'db.e-medium16'|'db.medium16'|'db.e-medium24'|'db.medium24'|'db.e-large'|'db.large'|'db.e-large8'|'db.large8'|'db.e-large16'|'db.large16'|'db.e-large24'|'db.large24'|'db.e-large32'|'db.large32'|'db.e-extra-large8'|'db.extra-large8'|'db.e-extra-large16'|'db.extra-large16'|'db.e-extra-large24'|'db.extra-large24'|'db.e-extra-large32'|'db.extra-large32'|'db.e-extra-large48'|'db.extra-large48'|'db.e-double-large16'|'db.double-large16'|'db.e-double-large24'|'db.double-large24'|'db.e-double-large32'|'db.double-large32'|'db.e-double-large48'|'db.double-large48'|'db.e-double-large64'|'db.double-large64'|'db.e-double-large96'|'db.double-large96'|'db.triple-large32'|'db.triple-large48'|'db.triple-large64'|'db.triple-large96'|'db.triple-large128'|'db.quad-large64'|'db.quad-large96'|'db.quad-large128'|'db.septa-large128',
    DBInstanceIdentifier='string',
    Iops=123,
    NiftyReadReplicaPrivateAddress='string',
    NiftyStorageType=123,
    OptionGroupName='string',
    Port=123,
    PubliclyAccessible=True|False,
    SourceDBInstanceIdentifier='string'
)

Parameters:

AccountingType (string) –
AutoMinorVersionUpgrade (boolean) –
AvailabilityZone (string) –
DBInstanceClass (string) –
DBInstanceIdentifier (string) – [REQUIRED]
Iops (integer) –
NiftyReadReplicaPrivateAddress (string) –
NiftyStorageType (integer) –
OptionGroupName (string) –
Port (integer) –
PubliclyAccessible (boolean) –
SourceDBInstanceIdentifier (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

create_db_parameter_group(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_db_parameter_group(
    DBParameterGroupFamily='string',
    DBParameterGroupName='string',
    Description='string'
)

Parameters:

DBParameterGroupFamily (string) – [REQUIRED]
DBParameterGroupName (string) – [REQUIRED]
Description (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'DBParameterGroup': {
        'DBParameterGroupFamily': 'string',
        'DBParameterGroupName': 'string',
        'Description': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBParameterGroup (dict) –
  - DBParameterGroupFamily (string) –
  - DBParameterGroupName (string) –
  - Description (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

create_db_security_group(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_db_security_group(
    DBSecurityGroupDescription='string',
    DBSecurityGroupName='string',
    NiftyAvailabilityZone='string'
)

Parameters:

DBSecurityGroupDescription (string) – [REQUIRED]
DBSecurityGroupName (string) – [REQUIRED]
NiftyAvailabilityZone (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'DBSecurityGroup': {
        'DBSecurityGroupDescription': 'string',
        'DBSecurityGroupName': 'string',
        'EC2SecurityGroups': [
            {
                'EC2SecurityGroupName': 'string',
                'EC2SecurityGroupOwnerId': 'string',
                'Status': 'string'
            },
        ],
        'IPRanges': [
            {
                'CIDRIP': 'string',
                'Status': 'string'
            },
        ],
        'NiftyAvailabilityZone': 'string',
        'OwnerId': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBSecurityGroup (dict) –
  - DBSecurityGroupDescription (string) –
  - DBSecurityGroupName (string) –
  - EC2SecurityGroups (list) –
    - (dict) –
      - EC2SecurityGroupName (string) –
      - EC2SecurityGroupOwnerId (string) –
      - Status (string) –
  - IPRanges (list) –
    - (dict) –
      - CIDRIP (string) –
      - Status (string) –
  - NiftyAvailabilityZone (string) –
  - OwnerId (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

create_db_snapshot(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_db_snapshot(
    DBInstanceIdentifier='string',
    DBSnapshotIdentifier='string'
)

Parameters:

DBInstanceIdentifier (string) – [REQUIRED]
DBSnapshotIdentifier (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'DBSnapshot': {
        'AllocatedStorage': 123,
        'AvailabilityZone': 'string',
        'DBInstanceIdentifier': 'string',
        'DBSnapshotIdentifier': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'OptionGroupName': 'string',
        'Port': 123,
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'SnapshotType': 'string',
        'Status': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBSnapshot (dict) –
  - AllocatedStorage (integer) –
  - AvailabilityZone (string) –
  - DBInstanceIdentifier (string) –
  - DBSnapshotIdentifier (string) –
  - Engine (string) –
  - EngineVersion (string) –
  - InstanceCreateTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - OptionGroupName (string) –
  - Port (integer) –
  - SnapshotCreateTime (datetime) –
  - SnapshotType (string) –
  - Status (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

create_event_subscription(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_event_subscription(
    Enabled=True|False,
    EventCategories=[
        'string',
    ],
    NiftyDescription='string',
    NiftyEmailAddresses=[
        'string',
    ],
    SourceIds=[
        'string',
    ],
    SourceType='db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot',
    SubscriptionName='string'
)

Parameters:

Enabled (boolean) –
EventCategories (list) –
- (string) –
NiftyDescription (string) –
NiftyEmailAddresses (list) –
[REQUIRED]
- (string) –
SourceIds (list) –
- (string) –
SourceType (string) –
SubscriptionName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'EventSubscription': {
        'CustSubscriptionId': 'string',
        'Enabled': True|False,
        'EventCategoriesList': [
            'string',
        ],
        'NiftyDescription': 'string',
        'NiftyEmailAddressesList': [
            'string',
        ],
        'SourceIdsList': [
            'string',
        ],
        'SourceType': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- EventSubscription (dict) –
  - CustSubscriptionId (string) –
  - Enabled (boolean) –
  - EventCategoriesList (list) –
    - (string) –
  - NiftyDescription (string) –
  - NiftyEmailAddressesList (list) –
    - (string) –
  - SourceIdsList (list) –
    - (string) –
  - SourceType (string) –
  - Status (string) –
  - SubscriptionCreationTime (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

delete_db_instance(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_db_instance(
    DBInstanceIdentifier='string',
    FinalDBSnapshotIdentifier='string',
    SkipFinalSnapshot=True|False
)

Parameters:

DBInstanceIdentifier (string) – [REQUIRED]
FinalDBSnapshotIdentifier (string) –
SkipFinalSnapshot (boolean) –

Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

delete_db_parameter_group(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_db_parameter_group(
    DBParameterGroupName='string'
)

Parameters: DBParameterGroupName (string) – [REQUIRED]

Return type: dict

Returns:

Response Syntax

{
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- ResponseMetadata (dict) –
  - RequestId (string) –

delete_db_security_group(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_db_security_group(
    DBSecurityGroupName='string'
)

Parameters: DBSecurityGroupName (string) – [REQUIRED]

Return type: dict

Returns:

Response Syntax

{
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- ResponseMetadata (dict) –
  - RequestId (string) –

delete_db_snapshot(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_db_snapshot(
    DBSnapshotIdentifier='string'
)

Parameters: DBSnapshotIdentifier (string) – [REQUIRED]

Return type: dict

Returns:

Response Syntax

{
    'DBSnapshot': {
        'AllocatedStorage': 123,
        'AvailabilityZone': 'string',
        'DBInstanceIdentifier': 'string',
        'DBSnapshotIdentifier': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'OptionGroupName': 'string',
        'Port': 123,
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'SnapshotType': 'string',
        'Status': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBSnapshot (dict) –
  - AllocatedStorage (integer) –
  - AvailabilityZone (string) –
  - DBInstanceIdentifier (string) –
  - DBSnapshotIdentifier (string) –
  - Engine (string) –
  - EngineVersion (string) –
  - InstanceCreateTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - OptionGroupName (string) –
  - Port (integer) –
  - SnapshotCreateTime (datetime) –
  - SnapshotType (string) –
  - Status (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

delete_event_subscription(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_event_subscription(
    SubscriptionName='string'
)

Parameters: SubscriptionName (string) – [REQUIRED]

Return type: dict

Returns:

Response Syntax

{
    'EventSubscription': {
        'CustSubscriptionId': 'string',
        'Enabled': True|False,
        'EventCategoriesList': [
            'string',
        ],
        'NiftyDescription': 'string',
        'NiftyEmailAddressesList': [
            'string',
        ],
        'SourceIdsList': [
            'string',
        ],
        'SourceType': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- EventSubscription (dict) –
  - CustSubscriptionId (string) –
  - Enabled (boolean) –
  - EventCategoriesList (list) –
    - (string) –
  - NiftyDescription (string) –
  - NiftyEmailAddressesList (list) –
    - (string) –
  - SourceIdsList (list) –
    - (string) –
  - SourceType (string) –
  - Status (string) –
  - SubscriptionCreationTime (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_certificates(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_certificates(
    CertificateIdentifier='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123
)

Parameters:

CertificateIdentifier (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –

Return type:

dict

Returns:

Response Syntax

{
    'Certificates': [
        {
            'CertificateIdentifier': 'string',
            'CertificateType': 'string',
            'Thumbprint': 'string',
            'ValidFrom': datetime(2015, 1, 1),
            'ValidTill': datetime(2015, 1, 1)
        },
    ],
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- Certificates (list) –
  - (dict) –
    - CertificateIdentifier (string) –
    - CertificateType (string) –
    - Thumbprint (string) –
    - ValidFrom (datetime) –
    - ValidTill (datetime) –
- Marker (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_db_engine_versions(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_engine_versions(
    DBParameterGroupFamily='mysql5.6'|'mysql5.7'|'postgres9.3'|'postgres9.6'|'postgres11'|'mariadb10.1',
    DefaultOnly=True|False,
    Engine='MySQL'|'postgres'|'MariaDB',
    EngineVersion='string',
    IncludeAll=True|False,
    ListSupportedCharacterSets=True|False,
    Marker='string',
    MaxRecords=123
)

Parameters:

DBParameterGroupFamily (string) –
DefaultOnly (boolean) –
Engine (string) –
EngineVersion (string) –
IncludeAll (boolean) –
ListSupportedCharacterSets (boolean) –
Marker (string) –
MaxRecords (integer) –

Return type:

dict

Returns:

Response Syntax

{
    'DBEngineVersions': [
        {
            'DBEngineDescription': 'string',
            'DBEngineVersionDescription': 'string',
            'DBParameterGroupFamily': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'Status': 'string',
            'ValidUpgradeTarget': [
                {
                    'AutoUpgrade': True|False,
                    'DBParameterGroupFamily': 'string',
                    'Description': 'string',
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'IsMajorVersionUpgrade': True|False
                },
            ]
        },
    ],
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBEngineVersions (list) –
  - (dict) –
    - DBEngineDescription (string) –
    - DBEngineVersionDescription (string) –
    - DBParameterGroupFamily (string) –
    - Engine (string) –
    - EngineVersion (string) –
    - Status (string) –
    - ValidUpgradeTarget (list) –
      - (dict) –
        
        AutoUpgrade (boolean) –
        
        DBParameterGroupFamily (string) –
        
        Description (string) –
        
        Engine (string) –
        
        EngineVersion (string) –
        
        IsMajorVersionUpgrade (boolean) –
- Marker (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_db_instances(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_instances(
    DBInstanceIdentifier='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123
)

Parameters:

DBInstanceIdentifier (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –

Return type:

dict

Returns:

Response Syntax

{
    'DBInstances': [
        {
            'AccountingType': 'string',
            'AllocatedStorage': 123,
            'AutoMinorVersionUpgrade': True|False,
            'AvailabilityZone': 'string',
            'BackupRetentionPeriod': 123,
            'BinlogRetentionPeriod': 123,
            'CACertificateIdentifier': 'string',
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'DBInstanceStatus': 'string',
            'DBName': 'string',
            'DBParameterGroups': [
                {
                    'DBParameterGroupName': 'string',
                    'ParameterApplyStatus': 'string'
                },
            ],
            'DBSecurityGroups': [
                {
                    'DBSecurityGroupName': 'string',
                    'Status': 'string'
                },
            ],
            'Endpoint': {
                'Address': 'string',
                'NiftyPrivateAddress': 'string',
                'Port': 123
            },
            'Engine': 'string',
            'EngineVersion': 'string',
            'ExternalReplicationInfo': {
                'ExternalMasterAddress': 'string',
                'ExternalReplicationMessage': 'string',
                'ExternalReplicationStatus': 'string',
                'ReplicationAddresses': [
                    'string',
                ],
                'ReplicationPrivateAddresses': [
                    'string',
                ]
            },
            'InstanceCreateTime': datetime(2015, 1, 1),
            'LatestRestorableTime': datetime(2015, 1, 1),
            'LicenseModel': 'string',
            'MasterUsername': 'string',
            'MultiAZ': True|False,
            'NextMonthAccountingType': 'string',
            'NiftyMasterPrivateAddress': 'string',
            'NiftyMultiAZType': 'string',
            'NiftyNetworkId': 'string',
            'NiftySlavePrivateAddress': 'string',
            'NiftyStorageType': 123,
            'OptionGroupMemberships': [
                {
                    'OptionGroupName': 'string',
                    'Status': 'string'
                },
            ],
            'PendingModifiedValues': {
                'AllocatedStorage': 123,
                'BackupRetentionPeriod': 123,
                'DBInstanceClass': 'string',
                'DBInstanceIdentifier': 'string',
                'EngineVersion': 'string',
                'MasterUserPassword': 'string',
                'MultiAZ': True|False,
                'Port': 123
            },
            'PreferredBackupWindow': 'string',
            'PreferredMaintenanceWindow': 'string',
            'PubliclyAccessible': True|False,
            'ReadReplicaDBInstanceIdentifiers': [
                'string',
            ],
            'ReadReplicaSourceDBInstanceIdentifier': 'string',
            'SecondaryAvailabilityZone': 'string',
            'StatusInfos': [
                {
                    'Message': 'string',
                    'Normal': True|False,
                    'Status': 'string',
                    'StatusType': 'string'
                },
            ],
            'VpcSecurityGroups': 'string'
        },
    ],
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstances (list) –
  - (dict) –
    - AccountingType (string) –
    - AllocatedStorage (integer) –
    - AutoMinorVersionUpgrade (boolean) –
    - AvailabilityZone (string) –
    - BackupRetentionPeriod (integer) –
    - BinlogRetentionPeriod (integer) –
    - CACertificateIdentifier (string) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - DBInstanceStatus (string) –
    - DBName (string) –
    - DBParameterGroups (list) –
      - (dict) –
        
        DBParameterGroupName (string) –
        
        ParameterApplyStatus (string) –
    - DBSecurityGroups (list) –
      - (dict) –
        
        DBSecurityGroupName (string) –
        
        Status (string) –
    - Endpoint (dict) –
      - Address (string) –
      - NiftyPrivateAddress (string) –
      - Port (integer) –
    - Engine (string) –
    - EngineVersion (string) –
    - ExternalReplicationInfo (dict) –
      - ExternalMasterAddress (string) –
      - ExternalReplicationMessage (string) –
      - ExternalReplicationStatus (string) –
      - ReplicationAddresses (list) –
        
        (string) –
      - ReplicationPrivateAddresses (list) –
        
        (string) –
    - InstanceCreateTime (datetime) –
    - LatestRestorableTime (datetime) –
    - LicenseModel (string) –
    - MasterUsername (string) –
    - MultiAZ (boolean) –
    - NextMonthAccountingType (string) –
    - NiftyMasterPrivateAddress (string) –
    - NiftyMultiAZType (string) –
    - NiftyNetworkId (string) –
    - NiftySlavePrivateAddress (string) –
    - NiftyStorageType (integer) –
    - OptionGroupMemberships (list) –
      - (dict) –
        
        OptionGroupName (string) –
        
        Status (string) –
    - PendingModifiedValues (dict) –
      - AllocatedStorage (integer) –
      - BackupRetentionPeriod (integer) –
      - DBInstanceClass (string) –
      - DBInstanceIdentifier (string) –
      - EngineVersion (string) –
      - MasterUserPassword (string) –
      - MultiAZ (boolean) –
      - Port (integer) –
    - PreferredBackupWindow (string) –
    - PreferredMaintenanceWindow (string) –
    - PubliclyAccessible (boolean) –
    - ReadReplicaDBInstanceIdentifiers (list) –
      - (string) –
    - ReadReplicaSourceDBInstanceIdentifier (string) –
    - SecondaryAvailabilityZone (string) –
    - StatusInfos (list) –
      - (dict) –
        
        Message (string) –
        
        Normal (boolean) –
        
        Status (string) –
        
        StatusType (string) –
    - VpcSecurityGroups (string) –
- Marker (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_db_log_files(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_log_files(
    DBInstanceIdentifier='string',
    FileLastWritten=123,
    FileSize=123,
    FilenameContains='string',
    Marker='string',
    MaxRecords=123
)

Parameters:

DBInstanceIdentifier (string) – [REQUIRED]
FileLastWritten (integer) –
FileSize (integer) –
FilenameContains (string) –
Marker (string) –
MaxRecords (integer) –

Return type:

dict

Returns:

Response Syntax

{
    'DescribeDBLogFiles': [
        {
            'LastWritten': 123,
            'LogFileName': 'string',
            'Size': 123
        },
    ],
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DescribeDBLogFiles (list) –
  - (dict) –
    - LastWritten (integer) –
    - LogFileName (string) –
    - Size (integer) –
- Marker (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_db_parameter_groups(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_parameter_groups(
    DBParameterGroupName='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123
)

Parameters:

DBParameterGroupName (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –

Return type:

dict

Returns:

Response Syntax

{
    'DBParameterGroups': [
        {
            'DBParameterGroupFamily': 'string',
            'DBParameterGroupName': 'string',
            'Description': 'string'
        },
    ],
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBParameterGroups (list) –
  - (dict) –
    - DBParameterGroupFamily (string) –
    - DBParameterGroupName (string) –
    - Description (string) –
- Marker (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_db_parameters(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_parameters(
    DBParameterGroupName='string',
    Marker='string',
    MaxRecords=123,
    Source='user'|'system'|'engine-default'
)

Parameters:

DBParameterGroupName (string) – [REQUIRED]
Marker (string) –
MaxRecords (integer) –
Source (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'Parameters': [
        {
            'AllowedValues': 'string',
            'ApplyMethod': 'string',
            'ApplyType': 'string',
            'DataType': 'string',
            'Description': 'string',
            'IsModifiable': True|False,
            'MinimumEngineVersion': 'string',
            'ParameterName': 'string',
            'ParameterValue': 'string',
            'Source': 'string'
        },
    ],
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- Marker (string) –
- Parameters (list) –
  - (dict) –
    - AllowedValues (string) –
    - ApplyMethod (string) –
    - ApplyType (string) –
    - DataType (string) –
    - Description (string) –
    - IsModifiable (boolean) –
    - MinimumEngineVersion (string) –
    - ParameterName (string) –
    - ParameterValue (string) –
    - Source (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_db_security_groups(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_security_groups(
    DBSecurityGroupName='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123
)

Parameters:

DBSecurityGroupName (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –

Return type:

dict

Returns:

Response Syntax

{
    'DBSecurityGroups': [
        {
            'DBSecurityGroupDescription': 'string',
            'DBSecurityGroupName': 'string',
            'EC2SecurityGroups': [
                {
                    'EC2SecurityGroupName': 'string',
                    'EC2SecurityGroupOwnerId': 'string',
                    'Status': 'string'
                },
            ],
            'IPRanges': [
                {
                    'CIDRIP': 'string',
                    'Status': 'string'
                },
            ],
            'NiftyAvailabilityZone': 'string',
            'OwnerId': 'string'
        },
    ],
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBSecurityGroups (list) –
  - (dict) –
    - DBSecurityGroupDescription (string) –
    - DBSecurityGroupName (string) –
    - EC2SecurityGroups (list) –
      - (dict) –
        
        EC2SecurityGroupName (string) –
        
        EC2SecurityGroupOwnerId (string) –
        
        Status (string) –
    - IPRanges (list) –
      - (dict) –
        
        CIDRIP (string) –
        
        Status (string) –
    - NiftyAvailabilityZone (string) –
    - OwnerId (string) –
- Marker (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_db_snapshots(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_snapshots(
    DBInstanceIdentifier='string',
    DBSnapshotIdentifier='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    SnapshotType='automated'|'manual'
)

Parameters:

DBInstanceIdentifier (string) –
DBSnapshotIdentifier (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
SnapshotType (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBSnapshots': [
        {
            'AllocatedStorage': 123,
            'AvailabilityZone': 'string',
            'DBInstanceIdentifier': 'string',
            'DBSnapshotIdentifier': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'InstanceCreateTime': datetime(2015, 1, 1),
            'LicenseModel': 'string',
            'MasterUsername': 'string',
            'OptionGroupName': 'string',
            'Port': 123,
            'SnapshotCreateTime': datetime(2015, 1, 1),
            'SnapshotType': 'string',
            'Status': 'string'
        },
    ],
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBSnapshots (list) –
  - (dict) –
    - AllocatedStorage (integer) –
    - AvailabilityZone (string) –
    - DBInstanceIdentifier (string) –
    - DBSnapshotIdentifier (string) –
    - Engine (string) –
    - EngineVersion (string) –
    - InstanceCreateTime (datetime) –
    - LicenseModel (string) –
    - MasterUsername (string) –
    - OptionGroupName (string) –
    - Port (integer) –
    - SnapshotCreateTime (datetime) –
    - SnapshotType (string) –
    - Status (string) –
- Marker (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_engine_default_parameters(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_engine_default_parameters(
    DBParameterGroupFamily='string',
    Marker='string',
    MaxRecords=123
)

Parameters:

DBParameterGroupFamily (string) – [REQUIRED]
Marker (string) –
MaxRecords (integer) –

Return type:

dict

Returns:

Response Syntax

{
    'EngineDefaults': {
        'DBParameterGroupFamily': 'string',
        'Marker': 'string',
        'Parameters': [
            {
                'AllowedValues': 'string',
                'ApplyMethod': 'string',
                'ApplyType': 'string',
                'DataType': 'string',
                'Description': 'string',
                'IsModifiable': True|False,
                'MinimumEngineVersion': 'string',
                'ParameterName': 'string',
                'ParameterValue': 'string',
                'Source': 'string'
            },
        ]
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- EngineDefaults (dict) –
  - DBParameterGroupFamily (string) –
  - Marker (string) –
  - Parameters (list) –
    - (dict) –
      - AllowedValues (string) –
      - ApplyMethod (string) –
      - ApplyType (string) –
      - DataType (string) –
      - Description (string) –
      - IsModifiable (boolean) –
      - MinimumEngineVersion (string) –
      - ParameterName (string) –
      - ParameterValue (string) –
      - Source (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_event_categories(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_event_categories(
    SourceType='db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'
)

Parameters: SourceType (string) –

Return type: dict

Returns:

Response Syntax

{
    'EventCategoriesMapList': [
        {
            'EventCategories': [
                'string',
            ],
            'SourceType': 'string'
        },
    ],
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- EventCategoriesMapList (list) –
  - (dict) –
    - EventCategories (list) –
      - (string) –
    - SourceType (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_event_subscriptions(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_event_subscriptions(
    Marker='string',
    MaxRecords=123,
    NIftySortKey='SubscriptionName'|'SourceType'|'Enabled'|'SubscriptionCreationTime',
    NiftyFilters={
        'ListOfRequestFilter': [
            {
                'FilterName': 'SubscriptionName'|'SourceType'|'Enabled'|'NiftyDescription',
                'FilterValue': 'string'
            },
        ]
    },
    NiftySortDesc=123,
    SubscriptionName='string'
)

Parameters:

Marker (string) –
MaxRecords (integer) –
NIftySortKey (string) –
NiftyFilters (dict) –
- ListOfRequestFilter (list) –
  - (dict) –
    - FilterName (string) –
    - FilterValue (string) –
NiftySortDesc (integer) –
SubscriptionName (string) –

Return type:

dict

Returns:

Response Syntax

{
    'EventSubscriptionsList': [
        {
            'CustSubscriptionId': 'string',
            'Enabled': True|False,
            'EventCategoriesList': [
                'string',
            ],
            'NiftyDescription': 'string',
            'NiftyEmailAddressesList': [
                'string',
            ],
            'SourceIdsList': [
                'string',
            ],
            'SourceType': 'string',
            'Status': 'string',
            'SubscriptionCreationTime': 'string'
        },
    ],
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- EventSubscriptionsList (list) –
  - (dict) –
    - CustSubscriptionId (string) –
    - Enabled (boolean) –
    - EventCategoriesList (list) –
      - (string) –
    - NiftyDescription (string) –
    - NiftyEmailAddressesList (list) –
      - (string) –
    - SourceIdsList (list) –
      - (string) –
    - SourceType (string) –
    - Status (string) –
    - SubscriptionCreationTime (string) –
- Marker (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_events(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_events(
    Duration=123,
    EndTime=datetime(2015, 1, 1),
    EventCategories=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    SourceIdentifier='string',
    SourceType='db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot',
    StartTime=datetime(2015, 1, 1)
)

Parameters:

Duration (integer) –
EndTime (datetime) –
EventCategories (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
SourceIdentifier (string) –
SourceType (string) –
StartTime (datetime) –

Return type:

dict

Returns:

Response Syntax

{
    'Events': [
        {
            'Date': datetime(2015, 1, 1),
            'EventCategories': [
                'string',
            ],
            'Message': 'string',
            'SourceIdentifier': 'string',
            'SourceType': 'string'
        },
    ],
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- Events (list) –
  - (dict) –
    - Date (datetime) –
    - EventCategories (list) –
      - (string) –
    - Message (string) –
    - SourceIdentifier (string) –
    - SourceType (string) –
- Marker (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

describe_orderable_db_instance_options(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_orderable_db_instance_options(
    DBInstanceClass='db.mini'|'db.e-small'|'db.small'|'db.e-small2'|'db.small2'|'db.e-small4'|'db.small4'|'db.e-small8'|'db.small8'|'db.e-small16'|'db.small16'|'db.e-medium'|'db.medium'|'db.e-medium4'|'db.medium4'|'db.e-medium8'|'db.medium8'|'db.e-medium16'|'db.medium16'|'db.e-medium24'|'db.medium24'|'db.e-large'|'db.large'|'db.e-large8'|'db.large8'|'db.e-large16'|'db.large16'|'db.e-large24'|'db.large24'|'db.e-large32'|'db.large32'|'db.e-extra-large8'|'db.extra-large8'|'db.e-extra-large16'|'db.extra-large16'|'db.e-extra-large24'|'db.extra-large24'|'db.e-extra-large32'|'db.extra-large32'|'db.e-extra-large48'|'db.extra-large48'|'db.e-double-large16'|'db.double-large16'|'db.e-double-large24'|'db.double-large24'|'db.e-double-large32'|'db.double-large32'|'db.e-double-large48'|'db.double-large48'|'db.e-double-large64'|'db.double-large64'|'db.e-double-large96'|'db.double-large96'|'db.triple-large32'|'db.triple-large48'|'db.triple-large64'|'db.triple-large96'|'db.triple-large128'|'db.quad-large64'|'db.quad-large96'|'db.quad-large128'|'db.septa-large128',
    Engine='MySQL'|'postgres'|'MariaDB',
    EngineVersion='string',
    LicenseModel='string',
    Marker='string',
    MaxRecords=123,
    Vpc=True|False
)

Parameters:

DBInstanceClass (string) –
Engine (string) –
EngineVersion (string) –
LicenseModel (string) –
Marker (string) –
MaxRecords (integer) –
Vpc (boolean) –

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'OrderableDBInstanceOptions': [
        {
            'AvailabilityZones': [
                {
                    'Name': 'string',
                    'NiftyStorageTypes': [
                        123,
                    ],
                    'ProvisionedIopsCapable': True|False
                },
            ],
            'DBInstanceClass': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'LicenseModel': 'string',
            'MultiAZCapable': True|False,
            'ReadReplicaCapable': True|False,
            'Vpc': True|False
        },
    ],
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- Marker (string) –
- OrderableDBInstanceOptions (list) –
  - (dict) –
    - AvailabilityZones (list) –
      - (dict) –
        
        Name (string) –
        
        NiftyStorageTypes (list) –
        
        (integer) –
        
        ProvisionedIopsCapable (boolean) –
    - DBInstanceClass (string) –
    - Engine (string) –
    - EngineVersion (string) –
    - LicenseModel (string) –
    - MultiAZCapable (boolean) –
    - ReadReplicaCapable (boolean) –
    - Vpc (boolean) –
- ResponseMetadata (dict) –
  - RequestId (string) –

download_db_log_file_portion(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.download_db_log_file_portion(
    DBInstanceIdentifier='string',
    LogFileName='string',
    Marker='string',
    NumberOfLines=123
)

Parameters:

DBInstanceIdentifier (string) – [REQUIRED]
LogFileName (string) –
Marker (string) –
NumberOfLines (integer) –

Return type:

dict

Returns:

Response Syntax

{
    'AdditionalDataPending': True|False,
    'LogFileData': 'string',
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- AdditionalDataPending (boolean) –
- LogFileData (string) –
- Marker (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters:

ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to ClientMethod.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.

Returns:

The presigned url

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters:	operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is `create_foo`, and you’d normally invoke the operation as `client.create_foo(**kwargs)`, if the `create_foo` operation can be paginated, you can use the call `client.get_paginator("create_foo")`.
Raises:	OperationNotPageableError – Raised if the operation is not pageable. You can use the `client.can_paginate` method to check if an operation is pageable.
Return type:	L{botocore.paginate.Paginator}
Returns:	A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters:	waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns:	The specified waiter object.
Return type:	botocore.waiter.Waiter

modify_db_instance(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.modify_db_instance(
    AccountingType='1'|'2',
    AllocatedStorage=123,
    AllowMajorVersionUpgrade=True|False,
    ApplyImmediately=True|False,
    AutoMinorVersionUpgrade=True|False,
    BackupRetentionPeriod=123,
    BinlogRetentionPeriod=123,
    CACertificateIdentifier='string',
    CustomBinlogRetentionPeriod=True|False,
    DBInstanceClass='db.mini'|'db.e-small'|'db.small'|'db.e-small2'|'db.small2'|'db.e-small4'|'db.small4'|'db.e-small8'|'db.small8'|'db.e-small16'|'db.small16'|'db.e-medium'|'db.medium'|'db.e-medium4'|'db.medium4'|'db.e-medium8'|'db.medium8'|'db.e-medium16'|'db.medium16'|'db.e-medium24'|'db.medium24'|'db.e-large'|'db.large'|'db.e-large8'|'db.large8'|'db.e-large16'|'db.large16'|'db.e-large24'|'db.large24'|'db.e-large32'|'db.large32'|'db.e-extra-large8'|'db.extra-large8'|'db.e-extra-large16'|'db.extra-large16'|'db.e-extra-large24'|'db.extra-large24'|'db.e-extra-large32'|'db.extra-large32'|'db.e-extra-large48'|'db.extra-large48'|'db.e-double-large16'|'db.double-large16'|'db.e-double-large24'|'db.double-large24'|'db.e-double-large32'|'db.double-large32'|'db.e-double-large48'|'db.double-large48'|'db.e-double-large64'|'db.double-large64'|'db.e-double-large96'|'db.double-large96'|'db.triple-large32'|'db.triple-large48'|'db.triple-large64'|'db.triple-large96'|'db.triple-large128'|'db.quad-large64'|'db.quad-large96'|'db.quad-large128'|'db.septa-large128',
    DBInstanceIdentifier='string',
    DBParameterGroupName='string',
    DBSecurityGroups=[
        'string',
    ],
    EngineVersion='string',
    Iops=123,
    MasterUserPassword='string',
    MultiAZ=True|False,
    NewDBInstanceIdentifier='string',
    NiftyMultiAZType=123,
    NiftyReadReplicaDBInstanceIdentifier='string',
    NiftyReadReplicaPrivateAddress='string',
    NiftySlavePrivateAddress='string',
    OptionGroupName='string',
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string',
    ReadReplicaAccountingType='1'|'2',
    VpcSecurityGroupIds=[
        'string',
    ]
)

Parameters:

AccountingType (string) –
AllocatedStorage (integer) –
AllowMajorVersionUpgrade (boolean) –
ApplyImmediately (boolean) –
AutoMinorVersionUpgrade (boolean) –
BackupRetentionPeriod (integer) –
BinlogRetentionPeriod (integer) –
CACertificateIdentifier (string) –
CustomBinlogRetentionPeriod (boolean) –
DBInstanceClass (string) –
DBInstanceIdentifier (string) – [REQUIRED]
DBParameterGroupName (string) –
DBSecurityGroups (list) –
- (string) –
EngineVersion (string) –
Iops (integer) –
MasterUserPassword (string) –
MultiAZ (boolean) –
NewDBInstanceIdentifier (string) –
NiftyMultiAZType (integer) –
NiftyReadReplicaDBInstanceIdentifier (string) –
NiftyReadReplicaPrivateAddress (string) –
NiftySlavePrivateAddress (string) –
OptionGroupName (string) –
PreferredBackupWindow (string) –
PreferredMaintenanceWindow (string) –
ReadReplicaAccountingType (string) –
VpcSecurityGroupIds (list) –
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

modify_db_instance_network(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.modify_db_instance_network(
    DBInstanceIdentifier='string',
    NiftyMasterPrivateAddress='string',
    NiftyNetworkId='string',
    NiftySlavePrivateAddress='string',
    NiftyVirtualPrivateAddress='string'
)

Parameters:

DBInstanceIdentifier (string) – [REQUIRED]
NiftyMasterPrivateAddress (string) –
NiftyNetworkId (string) –
NiftySlavePrivateAddress (string) –
NiftyVirtualPrivateAddress (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

modify_db_parameter_group(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.modify_db_parameter_group(
    DBParameterGroupName='string',
    Parameters=[
        {
            'ApplyMethod': 'immediate'|'pending-reboot',
            'ParameterName': 'string',
            'ParameterValue': 'string'
        },
    ]
)

Parameters:

DBParameterGroupName (string) – [REQUIRED]
Parameters (list) –
[REQUIRED]
- (dict) –
  - ApplyMethod (string) – [REQUIRED]
  - ParameterName (string) – [REQUIRED]
  - ParameterValue (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'DBParameterGroupName': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBParameterGroupName (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

modify_event_subscription(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.modify_event_subscription(
    Enabled=True|False,
    EventCategories=[
        'string',
    ],
    NiftyDescription='string',
    NiftyEmailAddresses=[
        'string',
    ],
    NiftySourceIds=[
        'string',
    ],
    SourceType='string',
    SubscriptionName='string'
)

Parameters:

Enabled (boolean) –
EventCategories (list) –
- (string) –
NiftyDescription (string) –
NiftyEmailAddresses (list) –
- (string) –
NiftySourceIds (list) –
- (string) –
SourceType (string) –
SubscriptionName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'EventSubscription': {
        'CustSubscriptionId': 'string',
        'Enabled': True|False,
        'EventCategoriesList': [
            'string',
        ],
        'NiftyDescription': 'string',
        'NiftyEmailAddressesList': [
            'string',
        ],
        'SourceIdsList': [
            'string',
        ],
        'SourceType': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- EventSubscription (dict) –
  - CustSubscriptionId (string) –
  - Enabled (boolean) –
  - EventCategoriesList (list) –
    - (string) –
  - NiftyDescription (string) –
  - NiftyEmailAddressesList (list) –
    - (string) –
  - SourceIdsList (list) –
    - (string) –
  - SourceType (string) –
  - Status (string) –
  - SubscriptionCreationTime (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

nifty_failover_db_instance(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_failover_db_instance(
    DBInstanceIdentifier='string'
)

Parameters: DBInstanceIdentifier (string) – [REQUIRED]

Return type: dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

nifty_get_metric_statistics(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_get_metric_statistics(
    Dimensions=[
        {
            'Name': 'string',
            'Value': 'string'
        },
    ],
    EndTime=datetime(2015, 1, 1),
    MetricName='BinLogDiskUsage'|'CPUUtilization'|'DatabaseConnections'|'DiskQueueDepth'|'FreeableMemory'|'FreeStorageSpace'|'ReplicaLag'|'SwapUsage'|'ReadIOPS'|'WriteIOPS'|'ReadThroughput'|'WriteThroughput',
    StartTime=datetime(2015, 1, 1)
)

Parameters:

Dimensions (list) –
[REQUIRED]
- (dict) –
  - Name (string) – [REQUIRED]
  - Value (string) – [REQUIRED]
EndTime (datetime) –
MetricName (string) – [REQUIRED]
StartTime (datetime) –

Return type:

dict

Returns:

Response Syntax

{
    'Datapoints': [
        {
            'NiftyTargetName': 'string',
            'SampleCount': 123,
            'Sum': 123.0,
            'Timestamp': datetime(2015, 1, 1)
        },
    ],
    'Label': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- Datapoints (list) –
  - (dict) –
    - NiftyTargetName (string) –
    - SampleCount (integer) –
    - Sum (float) –
    - Timestamp (datetime) –
- Label (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

reboot_db_instance(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.reboot_db_instance(
    DBInstanceIdentifier='string',
    ForceFailover=True|False,
    NiftyRebootType='0'|'1'|'2'|'3'
)

Parameters:

DBInstanceIdentifier (string) – [REQUIRED]
ForceFailover (boolean) –
NiftyRebootType (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

remove_source_identifier_from_subscription(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.remove_source_identifier_from_subscription(
    SourceIdentifier='string',
    SubscriptionName='string'
)

Parameters:

SourceIdentifier (string) – [REQUIRED]
SubscriptionName (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'EventSubscription': {
        'CustSubscriptionId': 'string',
        'Enabled': True|False,
        'EventCategoriesList': [
            'string',
        ],
        'NiftyDescription': 'string',
        'NiftyEmailAddressesList': [
            'string',
        ],
        'SourceIdsList': [
            'string',
        ],
        'SourceType': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- EventSubscription (dict) –
  - CustSubscriptionId (string) –
  - Enabled (boolean) –
  - EventCategoriesList (list) –
    - (string) –
  - NiftyDescription (string) –
  - NiftyEmailAddressesList (list) –
    - (string) –
  - SourceIdsList (list) –
    - (string) –
  - SourceType (string) –
  - Status (string) –
  - SubscriptionCreationTime (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

reset_db_parameter_group(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.reset_db_parameter_group(
    DBParameterGroupName='string',
    Parameters=[
        {
            'ApplyMethod': 'immediate'|'pending-reboot',
            'ParameterName': 'string'
        },
    ],
    ResetAllParameters=True|False
)

Parameters:

DBParameterGroupName (string) – [REQUIRED]
Parameters (list) –
- (dict) –
  - ApplyMethod (string) –
  - ParameterName (string) –
ResetAllParameters (boolean) –

Return type:

dict

Returns:

Response Syntax

{
    'DBParameterGroupName': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBParameterGroupName (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

reset_external_master(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.reset_external_master(
    DBInstanceIdentifier='string'
)

Parameters: DBInstanceIdentifier (string) – [REQUIRED]

Return type: dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

restore_db_instance_from_db_snapshot(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.restore_db_instance_from_db_snapshot(
    AccountingType='1'|'2',
    AutoMinorVersionUpgrade=True|False,
    AvailabilityZone='string',
    DBInstanceClass='db.mini'|'db.e-small'|'db.small'|'db.e-small2'|'db.small2'|'db.e-small4'|'db.small4'|'db.e-small8'|'db.small8'|'db.e-small16'|'db.small16'|'db.e-medium'|'db.medium'|'db.e-medium4'|'db.medium4'|'db.e-medium8'|'db.medium8'|'db.e-medium16'|'db.medium16'|'db.e-medium24'|'db.medium24'|'db.e-large'|'db.large'|'db.e-large8'|'db.large8'|'db.e-large16'|'db.large16'|'db.e-large24'|'db.large24'|'db.e-large32'|'db.large32'|'db.e-extra-large8'|'db.extra-large8'|'db.e-extra-large16'|'db.extra-large16'|'db.e-extra-large24'|'db.extra-large24'|'db.e-extra-large32'|'db.extra-large32'|'db.e-extra-large48'|'db.extra-large48'|'db.e-double-large16'|'db.double-large16'|'db.e-double-large24'|'db.double-large24'|'db.e-double-large32'|'db.double-large32'|'db.e-double-large48'|'db.double-large48'|'db.e-double-large64'|'db.double-large64'|'db.e-double-large96'|'db.double-large96'|'db.triple-large32'|'db.triple-large48'|'db.triple-large64'|'db.triple-large96'|'db.triple-large128'|'db.quad-large64'|'db.quad-large96'|'db.quad-large128'|'db.septa-large128',
    DBInstanceIdentifier='string',
    DBName='string',
    DBSnapshotIdentifier='string',
    DBSubnetGroupName='string',
    Engine='string',
    Iops=123,
    LicenseModel='string',
    MultiAZ=True|False,
    NiftyDBParameterGroupName='string',
    NiftyDBSecurityGroups=[
        'string',
    ],
    NiftyMasterPrivateAddress='string',
    NiftyMultiAZType=123,
    NiftyNetworkId='string',
    NiftyReadReplicaDBInstanceIdentifier='string',
    NiftyReadReplicaPrivateAddress='string',
    NiftySlavePrivateAddress='string',
    NiftyStorageType=123,
    NiftyVirtualPrivateAddress='string',
    OptionGroupName='string',
    Port=123,
    PubliclyAccessible=True|False,
    ReadReplicaAccountingType='1'|'2'
)

Parameters:

AccountingType (string) –
AutoMinorVersionUpgrade (boolean) –
AvailabilityZone (string) –
DBInstanceClass (string) – [REQUIRED]
DBInstanceIdentifier (string) – [REQUIRED]
DBName (string) –
DBSnapshotIdentifier (string) – [REQUIRED]
DBSubnetGroupName (string) –
Engine (string) –
Iops (integer) –
LicenseModel (string) –
MultiAZ (boolean) –
NiftyDBParameterGroupName (string) –
NiftyDBSecurityGroups (list) –
- (string) –
NiftyMasterPrivateAddress (string) –
NiftyMultiAZType (integer) –
NiftyNetworkId (string) –
NiftyReadReplicaDBInstanceIdentifier (string) –
NiftyReadReplicaPrivateAddress (string) –
NiftySlavePrivateAddress (string) –
NiftyStorageType (integer) –
NiftyVirtualPrivateAddress (string) –
OptionGroupName (string) –
Port (integer) –
PubliclyAccessible (boolean) –
ReadReplicaAccountingType (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

restore_db_instance_to_point_in_time(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.restore_db_instance_to_point_in_time(
    AccountingType='1'|'2',
    AutoMinorVersionUpgrade=True|False,
    AvailabilityZone='string',
    DBInstanceClass='db.mini'|'db.e-small'|'db.small'|'db.e-small2'|'db.small2'|'db.e-small4'|'db.small4'|'db.e-small8'|'db.small8'|'db.e-small16'|'db.small16'|'db.e-medium'|'db.medium'|'db.e-medium4'|'db.medium4'|'db.e-medium8'|'db.medium8'|'db.e-medium16'|'db.medium16'|'db.e-medium24'|'db.medium24'|'db.e-large'|'db.large'|'db.e-large8'|'db.large8'|'db.e-large16'|'db.large16'|'db.e-large24'|'db.large24'|'db.e-large32'|'db.large32'|'db.e-extra-large8'|'db.extra-large8'|'db.e-extra-large16'|'db.extra-large16'|'db.e-extra-large24'|'db.extra-large24'|'db.e-extra-large32'|'db.extra-large32'|'db.e-extra-large48'|'db.extra-large48'|'db.e-double-large16'|'db.double-large16'|'db.e-double-large24'|'db.double-large24'|'db.e-double-large32'|'db.double-large32'|'db.e-double-large48'|'db.double-large48'|'db.e-double-large64'|'db.double-large64'|'db.e-double-large96'|'db.double-large96'|'db.triple-large32'|'db.triple-large48'|'db.triple-large64'|'db.triple-large96'|'db.triple-large128'|'db.quad-large64'|'db.quad-large96'|'db.quad-large128'|'db.septa-large128',
    DBName='string',
    DBSubnetGroupName='string',
    Engine='string',
    Iops=123,
    LicenseModel='string',
    MultiAZ=True|False,
    NiftyDBParameterGroupName='string',
    NiftyDBSecurityGroups=[
        'string',
    ],
    NiftyMasterPrivateAddress='string',
    NiftyMultiAZType=123,
    NiftyNetworkId='string',
    NiftyReadReplicaDBInstanceIdentifier='string',
    NiftyReadReplicaPrivateAddress='string',
    NiftySlavePrivateAddress='string',
    NiftyStorageType=123,
    NiftyVirtualPrivateAddress='string',
    OptionGroupName='string',
    Port=123,
    PubliclyAccessible=True|False,
    ReadReplicaAccountingType='1'|'2',
    RestoreTime=datetime(2015, 1, 1),
    SourceDBInstanceIdentifier='string',
    TargetDBInstanceIdentifier='string',
    UseLatestRestorableTime=True|False
)

Parameters:

AccountingType (string) –
AutoMinorVersionUpgrade (boolean) –
AvailabilityZone (string) –
DBInstanceClass (string) –
DBName (string) –
DBSubnetGroupName (string) –
Engine (string) –
Iops (integer) –
LicenseModel (string) –
MultiAZ (boolean) –
NiftyDBParameterGroupName (string) –
NiftyDBSecurityGroups (list) –
- (string) –
NiftyMasterPrivateAddress (string) –
NiftyMultiAZType (integer) –
NiftyNetworkId (string) –
NiftyReadReplicaDBInstanceIdentifier (string) –
NiftyReadReplicaPrivateAddress (string) –
NiftySlavePrivateAddress (string) –
NiftyStorageType (integer) –
NiftyVirtualPrivateAddress (string) –
OptionGroupName (string) –
Port (integer) –
PubliclyAccessible (boolean) –
ReadReplicaAccountingType (string) –
RestoreTime (datetime) –
SourceDBInstanceIdentifier (string) – [REQUIRED]
TargetDBInstanceIdentifier (string) – [REQUIRED]
UseLatestRestorableTime (boolean) –

Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

revoke_db_security_group_ingress(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.revoke_db_security_group_ingress(
    CIDRIP='string',
    DBSecurityGroupName='string',
    EC2SecurityGroupId='string',
    EC2SecurityGroupName='string',
    EC2SecurityGroupOwnerId='string'
)

Parameters:

CIDRIP (string) –
DBSecurityGroupName (string) – [REQUIRED]
EC2SecurityGroupId (string) –
EC2SecurityGroupName (string) –
EC2SecurityGroupOwnerId (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBSecurityGroup': {
        'DBSecurityGroupDescription': 'string',
        'DBSecurityGroupName': 'string',
        'EC2SecurityGroups': [
            {
                'EC2SecurityGroupName': 'string',
                'EC2SecurityGroupOwnerId': 'string',
                'Status': 'string'
            },
        ],
        'IPRanges': [
            {
                'CIDRIP': 'string',
                'Status': 'string'
            },
        ],
        'NiftyAvailabilityZone': 'string',
        'OwnerId': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBSecurityGroup (dict) –
  - DBSecurityGroupDescription (string) –
  - DBSecurityGroupName (string) –
  - EC2SecurityGroups (list) –
    - (dict) –
      - EC2SecurityGroupName (string) –
      - EC2SecurityGroupOwnerId (string) –
      - Status (string) –
  - IPRanges (list) –
    - (dict) –
      - CIDRIP (string) –
      - Status (string) –
  - NiftyAvailabilityZone (string) –
  - OwnerId (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

set_external_master(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.set_external_master(
    BinlogFileName='string',
    BinlogPosition=123,
    DBInstanceIdentifier='string',
    MasterHost='string',
    MasterPort=123,
    ReplicationUserName='string',
    ReplicationUserPassword='string'
)

Parameters:

BinlogFileName (string) – [REQUIRED]
BinlogPosition (integer) – [REQUIRED]
DBInstanceIdentifier (string) – [REQUIRED]
MasterHost (string) – [REQUIRED]
MasterPort (integer) –
ReplicationUserName (string) – [REQUIRED]
ReplicationUserPassword (string) – [REQUIRED]

Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

start_replication(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.start_replication(
    DBInstanceIdentifier='string'
)

Parameters: DBInstanceIdentifier (string) – [REQUIRED]

Return type: dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

stop_replication(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.stop_replication(
    DBInstanceIdentifier='string'
)

Parameters: DBInstanceIdentifier (string) – [REQUIRED]

Return type: dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

upgrade_db_engine_version(**kwargs)¶

See also: NIFCLOUD API Documentation

Request Syntax

response = client.upgrade_db_engine_version(
    AllowMajorVersionUpgrade=True|False,
    DBInstanceIdentifier='string',
    DBParameterGroupName='string',
    EngineVersion='string',
    PreUpgradeDBSnapshotIdentifier='string',
    SkipPreUpgradeSnapshot=True|False
)

Parameters:

AllowMajorVersionUpgrade (boolean) –
DBInstanceIdentifier (string) – [REQUIRED]
DBParameterGroupName (string) –
EngineVersion (string) – [REQUIRED]
PreUpgradeDBSnapshotIdentifier (string) –
SkipPreUpgradeSnapshot (boolean) –

Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AccountingType': 'string',
        'AllocatedStorage': 123,
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 123,
        'BinlogRetentionPeriod': 123,
        'CACertificateIdentifier': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupName': 'string',
                'ParameterApplyStatus': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 123
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'ExternalReplicationInfo': {
            'ExternalMasterAddress': 'string',
            'ExternalReplicationMessage': 'string',
            'ExternalReplicationStatus': 'string',
            'ReplicationAddresses': [
                'string',
            ],
            'ReplicationPrivateAddresses': [
                'string',
            ]
        },
        'InstanceCreateTime': datetime(2015, 1, 1),
        'LatestRestorableTime': datetime(2015, 1, 1),
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': True|False,
        'NextMonthAccountingType': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 123,
            'BackupRetentionPeriod': 123,
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': True|False,
            'Port': 123
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            'string',
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': 'string'
    },
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

(dict) –
- DBInstance (dict) –
  - AccountingType (string) –
  - AllocatedStorage (integer) –
  - AutoMinorVersionUpgrade (boolean) –
  - AvailabilityZone (string) –
  - BackupRetentionPeriod (integer) –
  - BinlogRetentionPeriod (integer) –
  - CACertificateIdentifier (string) –
  - DBInstanceClass (string) –
  - DBInstanceIdentifier (string) –
  - DBInstanceStatus (string) –
  - DBName (string) –
  - DBParameterGroups (list) –
    - (dict) –
      - DBParameterGroupName (string) –
      - ParameterApplyStatus (string) –
  - DBSecurityGroups (list) –
    - (dict) –
      - DBSecurityGroupName (string) –
      - Status (string) –
  - Endpoint (dict) –
    - Address (string) –
    - NiftyPrivateAddress (string) –
    - Port (integer) –
  - Engine (string) –
  - EngineVersion (string) –
  - ExternalReplicationInfo (dict) –
    - ExternalMasterAddress (string) –
    - ExternalReplicationMessage (string) –
    - ExternalReplicationStatus (string) –
    - ReplicationAddresses (list) –
      - (string) –
    - ReplicationPrivateAddresses (list) –
      - (string) –
  - InstanceCreateTime (datetime) –
  - LatestRestorableTime (datetime) –
  - LicenseModel (string) –
  - MasterUsername (string) –
  - MultiAZ (boolean) –
  - NextMonthAccountingType (string) –
  - NiftyMasterPrivateAddress (string) –
  - NiftyMultiAZType (string) –
  - NiftyNetworkId (string) –
  - NiftySlavePrivateAddress (string) –
  - NiftyStorageType (integer) –
  - OptionGroupMemberships (list) –
    - (dict) –
      - OptionGroupName (string) –
      - Status (string) –
  - PendingModifiedValues (dict) –
    - AllocatedStorage (integer) –
    - BackupRetentionPeriod (integer) –
    - DBInstanceClass (string) –
    - DBInstanceIdentifier (string) –
    - EngineVersion (string) –
    - MasterUserPassword (string) –
    - MultiAZ (boolean) –
    - Port (integer) –
  - PreferredBackupWindow (string) –
  - PreferredMaintenanceWindow (string) –
  - PubliclyAccessible (boolean) –
  - ReadReplicaDBInstanceIdentifiers (list) –
    - (string) –
  - ReadReplicaSourceDBInstanceIdentifier (string) –
  - SecondaryAvailabilityZone (string) –
  - StatusInfos (list) –
    - (dict) –
      - Message (string) –
      - Normal (boolean) –
      - Status (string) –
      - StatusType (string) –
  - VpcSecurityGroups (string) –
- Marker (string) –
- ResponseMetadata (dict) –
  - RequestId (string) –

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

This client has no modeled exception classes.

Waiters ¶

The available waiters are:

rdb.Waiter.DBInstanceAvailable
rdb.Waiter.DBInstanceDeleted
rdb.Waiter.DBInstanceExists
rdb.Waiter.DBInstanceFailed
rdb.Waiter.DBInstanceStorageFull
rdb.Waiter.DBSecurityGroupDeleted
rdb.Waiter.DBSecurityGroupEC2SecurityGroupsAuthFailed
rdb.Waiter.DBSecurityGroupEC2SecurityGroupsAuthorized
rdb.Waiter.DBSecurityGroupEC2SecurityGroupsEmptied
rdb.Waiter.DBSecurityGroupEC2SecurityGroupsRevokeFailed
rdb.Waiter.DBSecurityGroupExists
rdb.Waiter.DBSecurityGroupIPRangesAuthFailed
rdb.Waiter.DBSecurityGroupIPRangesAuthorized
rdb.Waiter.DBSecurityGroupIPRangesEmptied
rdb.Waiter.DBSecurityGroupIPRangesRevokeFailed

class rdb.Waiter.DBInstanceAvailable¶

waiter = client.get_waiter('db_instance_available')

wait(**kwargs)¶

Polls rdb.Client.describe_db_instances() every 40 seconds until a successful state is reached. An error is returned after 80 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBInstanceIdentifier='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBInstanceIdentifier (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 40
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 80

Returns:

None

class rdb.Waiter.DBInstanceDeleted¶

waiter = client.get_waiter('db_instance_deleted')

wait(**kwargs)¶

Polls rdb.Client.describe_db_instances() every 40 seconds until a successful state is reached. An error is returned after 80 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBInstanceIdentifier='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBInstanceIdentifier (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 40
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 80

Returns:

None

class rdb.Waiter.DBInstanceExists¶

waiter = client.get_waiter('db_instance_exists')

wait(**kwargs)¶

Polls rdb.Client.describe_db_instances() every 40 seconds until a successful state is reached. An error is returned after 80 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBInstanceIdentifier='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBInstanceIdentifier (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 40
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 80

Returns:

None

class rdb.Waiter.DBInstanceFailed¶

waiter = client.get_waiter('db_instance_failed')

wait(**kwargs)¶

Polls rdb.Client.describe_db_instances() every 40 seconds until a successful state is reached. An error is returned after 80 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBInstanceIdentifier='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBInstanceIdentifier (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 40
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 80

Returns:

None

class rdb.Waiter.DBInstanceStorageFull¶

waiter = client.get_waiter('db_instance_storage_full')

wait(**kwargs)¶

Polls rdb.Client.describe_db_instances() every 40 seconds until a successful state is reached. An error is returned after 80 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBInstanceIdentifier='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBInstanceIdentifier (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 40
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 80

Returns:

None

class rdb.Waiter.DBSecurityGroupDeleted¶

waiter = client.get_waiter('db_security_group_deleted')

wait(**kwargs)¶

Polls rdb.Client.describe_db_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBSecurityGroupName='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBSecurityGroupName (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 20
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 40

Returns:

None

class rdb.Waiter.DBSecurityGroupEC2SecurityGroupsAuthFailed¶

waiter = client.get_waiter('db_security_group_ec2_security_groups_auth_failed')

wait(**kwargs)¶

Polls rdb.Client.describe_db_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBSecurityGroupName='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBSecurityGroupName (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 20
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 40

Returns:

None

class rdb.Waiter.DBSecurityGroupEC2SecurityGroupsAuthorized¶

waiter = client.get_waiter('db_security_group_ec2_security_groups_authorized')

wait(**kwargs)¶

Polls rdb.Client.describe_db_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBSecurityGroupName='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBSecurityGroupName (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 20
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 40

Returns:

None

class rdb.Waiter.DBSecurityGroupEC2SecurityGroupsEmptied¶

waiter = client.get_waiter('db_security_group_ec2_security_groups_emptied')

wait(**kwargs)¶

Polls rdb.Client.describe_db_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBSecurityGroupName='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBSecurityGroupName (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 20
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 40

Returns:

None

class rdb.Waiter.DBSecurityGroupEC2SecurityGroupsRevokeFailed¶

waiter = client.get_waiter('db_security_group_ec2_security_groups_revoke_failed')

wait(**kwargs)¶

Polls rdb.Client.describe_db_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBSecurityGroupName='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBSecurityGroupName (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 20
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 40

Returns:

None

class rdb.Waiter.DBSecurityGroupExists¶

waiter = client.get_waiter('db_security_group_exists')

wait(**kwargs)¶

Polls rdb.Client.describe_db_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBSecurityGroupName='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBSecurityGroupName (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 20
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 40

Returns:

None

class rdb.Waiter.DBSecurityGroupIPRangesAuthFailed¶

waiter = client.get_waiter('db_security_group_ip_ranges_auth_failed')

wait(**kwargs)¶

Polls rdb.Client.describe_db_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBSecurityGroupName='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBSecurityGroupName (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 20
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 40

Returns:

None

class rdb.Waiter.DBSecurityGroupIPRangesAuthorized¶

waiter = client.get_waiter('db_security_group_ip_ranges_authorized')

wait(**kwargs)¶

Polls rdb.Client.describe_db_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBSecurityGroupName='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBSecurityGroupName (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 20
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 40

Returns:

None

class rdb.Waiter.DBSecurityGroupIPRangesEmptied¶

waiter = client.get_waiter('db_security_group_ip_ranges_emptied')

wait(**kwargs)¶

Polls rdb.Client.describe_db_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBSecurityGroupName='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBSecurityGroupName (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 20
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 40

Returns:

None

class rdb.Waiter.DBSecurityGroupIPRangesRevokeFailed¶

waiter = client.get_waiter('db_security_group_ip_ranges_revoke_failed')

wait(**kwargs)¶

Polls rdb.Client.describe_db_security_groups() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    DBSecurityGroupName='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

DBSecurityGroupName (string) –
Filter (string) –
FilterName (string) –
FilterValue (string) –
Filters (list) –
- (string) –
Marker (string) –
MaxRecords (integer) –
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
- Delay (integer) –
  The amount of time in seconds to wait between attempts. Default: 20
- MaxAttempts (integer) –
  The maximum number of attempts to be made. Default: 40

Returns:

None

rdb¶

Client¶

Client Exceptions¶

Waiters¶

rdb ¶

Client ¶

Client Exceptions ¶

Waiters ¶