rdb

Table of Contents

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(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.add_source_identifier_to_subscription(
    SourceIdentifier='string',
    SubscriptionName='string'
)
Parameters:
  • SourceIdentifier (string) –
  • SubscriptionName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'EventSubscription': {
        'CustSubscriptionId': 'string',
        'Enabled': 'string',
        'EventCategoriesList': [
            'string',
        ],
        'NiftyDescription': 'string',
        'NiftyEmailAddressesList': [
            'string',
        ],
        'SourceIdsList': [
            'string',
        ],
        'SourceType': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string'
    }
}

Response Structure

  • (dict) –
    • EventSubscription (dict) –
      • CustSubscriptionId (string) –
      • Enabled (string) –
      • EventCategoriesList (list) –
        • (string) –
      • NiftyDescription (string) –
      • NiftyEmailAddressesList (list) –
        • (string) –
      • SourceIdsList (list) –
        • (string) –
      • SourceType (string) –
      • Status (string) –
      • SubscriptionCreationTime (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',
    EC2SecurityGroupName='string'
)
Parameters:
  • CIDRIP (string) –
  • DBSecurityGroupName (string) –
  • EC2SecurityGroupName (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'
    }
}

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) –

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) –
  • TargetDBSnapshotIdentifier (string) –
Return type:

dict

Returns:

Response Syntax

{
    'DBSnapshot': {
        'AllocatedStorage': 'string',
        'AvailabilityZone': 'string',
        'DBInstanceIdentifier': 'string',
        'DBSnapshotIdentifier': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': 'string',
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'OptionGroupName': 'string',
        'Port': 'string',
        'SnapshotCreateTime': 'string',
        'SnapshotType': 'string',
        'Status': 'string'
    }
}

Response Structure

  • (dict) –
    • DBSnapshot (dict) –
      • AllocatedStorage (string) –
      • AvailabilityZone (string) –
      • DBInstanceIdentifier (string) –
      • DBSnapshotIdentifier (string) –
      • Engine (string) –
      • EngineVersion (string) –
      • InstanceCreateTime (string) –
      • LicenseModel (string) –
      • MasterUsername (string) –
      • OptionGroupName (string) –
      • Port (string) –
      • SnapshotCreateTime (string) –
      • SnapshotType (string) –
      • Status (string) –

create_db_instance(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_db_instance(
    AllocatedStorage=123,
    AvailabilityZone='string',
    BackupRetentionPeriod=123,
    DBInstanceClass='string',
    DBInstanceIdentifier='string',
    DBName='string',
    DBParameterGroupName='string',
    DBSecurityGroups=[
        'string',
    ],
    Engine='string',
    EngineVersion='string',
    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',
    Port=123,
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string',
    PubliclyAccessible=True|False
)
Parameters:
  • AllocatedStorage (integer) –
  • AvailabilityZone (string) –
  • BackupRetentionPeriod (integer) –
  • DBInstanceClass (string) –
  • DBInstanceIdentifier (string) –
  • DBName (string) –
  • DBParameterGroupName (string) –
  • DBSecurityGroups (list) –
    • (string) –
  • Engine (string) –
  • EngineVersion (string) –
  • LicenseModel (string) –
  • MasterUserPassword (string) –
  • MasterUsername (string) –
  • MultiAZ (boolean) –
  • NiftyMasterPrivateAddress (string) –
  • NiftyMultiAZType (integer) –
  • NiftyNetworkId (string) –
  • NiftyReadReplicaDBInstanceIdentifier (string) –
  • NiftyReadReplicaPrivateAddress (string) –
  • NiftySlavePrivateAddress (string) –
  • NiftyStorageType (integer) –
  • NiftyVirtualPrivateAddress (string) –
  • Port (integer) –
  • PreferredBackupWindow (string) –
  • PreferredMaintenanceWindow (string) –
  • PubliclyAccessible (boolean) –
Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AllocatedStorage': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupFamily': 'string',
                'DBParameterGroupName': 'string',
                'Description': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupDescription': 'string',
                'DBSecurityGroupName': 'string',
                'EC2SecurityGroups': [
                    {
                        'EC2SecurityGroupName': 'string',
                        'EC2SecurityGroupOwnerId': 'string',
                        'Status': 'string'
                    },
                ],
                'IPRanges': [
                    {
                        'CIDRIP': 'string',
                        'Status': 'string'
                    },
                ],
                'NiftyAvailabilityZone': 'string',
                'OwnerId': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 'string'
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': 'string',
        'LatestRestorableTime': 'string',
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 'string',
            'BackupRetentionPeriod': 'string',
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': 'string',
            'NiftyMultiAZType': 'string',
            'Port': 'string'
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            {
                'ReadReplicaDBInstanceIdentifier': 'string'
            },
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {}
            ,
        ]
    }
}

Response Structure

  • (dict) –
    • DBInstance (dict) –
      • AllocatedStorage (string) –
      • AutoMinorVersionUpgrade (boolean) –
      • AvailabilityZone (string) –
      • BackupRetentionPeriod (string) –
      • DBInstanceClass (string) –
      • DBInstanceIdentifier (string) –
      • DBInstanceStatus (string) –
      • DBName (string) –
      • DBParameterGroups (list) –
        • (dict) –
          • DBParameterGroupFamily (string) –
          • DBParameterGroupName (string) –
          • Description (string) –
      • 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) –
      • Endpoint (dict) –
        • Address (string) –
        • NiftyPrivateAddress (string) –
        • Port (string) –
      • Engine (string) –
      • EngineVersion (string) –
      • InstanceCreateTime (string) –
      • LatestRestorableTime (string) –
      • LicenseModel (string) –
      • MasterUsername (string) –
      • MultiAZ (string) –
      • NiftyMasterPrivateAddress (string) –
      • NiftyMultiAZType (string) –
      • NiftyNetworkId (string) –
      • NiftySlavePrivateAddress (string) –
      • NiftyStorageType (integer) –
      • OptionGroupMemberships (list) –
        • (dict) –
          • OptionGroupName (string) –
          • Status (string) –
      • PendingModifiedValues (dict) –
        • AllocatedStorage (string) –
        • BackupRetentionPeriod (string) –
        • DBInstanceClass (string) –
        • DBInstanceIdentifier (string) –
        • EngineVersion (string) –
        • MasterUserPassword (string) –
        • MultiAZ (string) –
        • NiftyMultiAZType (string) –
        • Port (string) –
      • PreferredBackupWindow (string) –
      • PreferredMaintenanceWindow (string) –
      • PubliclyAccessible (boolean) –
      • ReadReplicaDBInstanceIdentifiers (list) –
        • (dict) –
          • ReadReplicaDBInstanceIdentifier (string) –
      • ReadReplicaSourceDBInstanceIdentifier (string) –
      • SecondaryAvailabilityZone (string) –
      • StatusInfos (list) –
        • (dict) –
          • Message (string) –
          • Normal (boolean) –
          • Status (string) –
          • StatusType (string) –
      • VpcSecurityGroups (list) –
        • (dict) –

create_db_instance_read_replica(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_db_instance_read_replica(
    DBInstanceClass='string',
    DBInstanceIdentifier='string',
    NiftyReadReplicaPrivateAddress='string',
    NiftyStorageType=123,
    SourceDBInstanceIdentifier='string'
)
Parameters:
  • DBInstanceClass (string) –
  • DBInstanceIdentifier (string) –
  • NiftyReadReplicaPrivateAddress (string) –
  • NiftyStorageType (integer) –
  • SourceDBInstanceIdentifier (string) –
Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AllocatedStorage': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupFamily': 'string',
                'DBParameterGroupName': 'string',
                'Description': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupDescription': 'string',
                'DBSecurityGroupName': 'string',
                'EC2SecurityGroups': [
                    {
                        'EC2SecurityGroupName': 'string',
                        'EC2SecurityGroupOwnerId': 'string',
                        'Status': 'string'
                    },
                ],
                'IPRanges': [
                    {
                        'CIDRIP': 'string',
                        'Status': 'string'
                    },
                ],
                'NiftyAvailabilityZone': 'string',
                'OwnerId': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 'string'
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': 'string',
        'LatestRestorableTime': 'string',
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 'string',
            'BackupRetentionPeriod': 'string',
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': 'string',
            'NiftyMultiAZType': 'string',
            'Port': 'string'
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            {
                'ReadReplicaDBInstanceIdentifier': 'string'
            },
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {}
            ,
        ]
    }
}

Response Structure

  • (dict) –
    • DBInstance (dict) –
      • AllocatedStorage (string) –
      • AutoMinorVersionUpgrade (boolean) –
      • AvailabilityZone (string) –
      • BackupRetentionPeriod (string) –
      • DBInstanceClass (string) –
      • DBInstanceIdentifier (string) –
      • DBInstanceStatus (string) –
      • DBName (string) –
      • DBParameterGroups (list) –
        • (dict) –
          • DBParameterGroupFamily (string) –
          • DBParameterGroupName (string) –
          • Description (string) –
      • 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) –
      • Endpoint (dict) –
        • Address (string) –
        • NiftyPrivateAddress (string) –
        • Port (string) –
      • Engine (string) –
      • EngineVersion (string) –
      • InstanceCreateTime (string) –
      • LatestRestorableTime (string) –
      • LicenseModel (string) –
      • MasterUsername (string) –
      • MultiAZ (string) –
      • NiftyMasterPrivateAddress (string) –
      • NiftyMultiAZType (string) –
      • NiftyNetworkId (string) –
      • NiftySlavePrivateAddress (string) –
      • NiftyStorageType (integer) –
      • OptionGroupMemberships (list) –
        • (dict) –
          • OptionGroupName (string) –
          • Status (string) –
      • PendingModifiedValues (dict) –
        • AllocatedStorage (string) –
        • BackupRetentionPeriod (string) –
        • DBInstanceClass (string) –
        • DBInstanceIdentifier (string) –
        • EngineVersion (string) –
        • MasterUserPassword (string) –
        • MultiAZ (string) –
        • NiftyMultiAZType (string) –
        • Port (string) –
      • PreferredBackupWindow (string) –
      • PreferredMaintenanceWindow (string) –
      • PubliclyAccessible (boolean) –
      • ReadReplicaDBInstanceIdentifiers (list) –
        • (dict) –
          • ReadReplicaDBInstanceIdentifier (string) –
      • ReadReplicaSourceDBInstanceIdentifier (string) –
      • SecondaryAvailabilityZone (string) –
      • StatusInfos (list) –
        • (dict) –
          • Message (string) –
          • Normal (boolean) –
          • Status (string) –
          • StatusType (string) –
      • VpcSecurityGroups (list) –
        • (dict) –

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) –
  • DBParameterGroupName (string) –
  • Description (string) –
Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –
    • DBParameterGroup (dict) –
      • DBParameterGroupFamily (string) –
      • DBParameterGroupName (string) –
      • Description (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) –
  • DBSecurityGroupName (string) –
  • NiftyAvailabilityZone (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'
    }
}

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) –

create_db_snapshot(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_db_snapshot(
    DBInstanceIdentifier='string',
    DBSnapshotIdentifier='string'
)
Parameters:
  • DBInstanceIdentifier (string) –
  • DBSnapshotIdentifier (string) –
Return type:

dict

Returns:

Response Syntax

{
    'DBSnapshot': {
        'AllocatedStorage': 'string',
        'AvailabilityZone': 'string',
        'DBInstanceIdentifier': 'string',
        'DBSnapshotIdentifier': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': 'string',
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'OptionGroupName': 'string',
        'Port': 'string',
        'SnapshotCreateTime': 'string',
        'SnapshotType': 'string',
        'Status': 'string'
    }
}

Response Structure

  • (dict) –
    • DBSnapshot (dict) –
      • AllocatedStorage (string) –
      • AvailabilityZone (string) –
      • DBInstanceIdentifier (string) –
      • DBSnapshotIdentifier (string) –
      • Engine (string) –
      • EngineVersion (string) –
      • InstanceCreateTime (string) –
      • LicenseModel (string) –
      • MasterUsername (string) –
      • OptionGroupName (string) –
      • Port (string) –
      • SnapshotCreateTime (string) –
      • SnapshotType (string) –
      • Status (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='string',
    SubscriptionName='string'
)
Parameters:
  • Enabled (boolean) –
  • EventCategories (list) –
    • (string) –
  • NiftyDescription (string) –
  • NiftyEmailAddresses (list) –
    • (string) –
  • SourceIds (list) –
    • (string) –
  • SourceType (string) –
  • SubscriptionName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'EventSubscription': {
        'CustSubscriptionId': 'string',
        'Enabled': 'string',
        'EventCategoriesList': [
            'string',
        ],
        'NiftyDescription': 'string',
        'NiftyEmailAddressesList': [
            'string',
        ],
        'SourceIdsList': [
            'string',
        ],
        'SourceType': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string'
    }
}

Response Structure

  • (dict) –
    • EventSubscription (dict) –
      • CustSubscriptionId (string) –
      • Enabled (string) –
      • EventCategoriesList (list) –
        • (string) –
      • NiftyDescription (string) –
      • NiftyEmailAddressesList (list) –
        • (string) –
      • SourceIdsList (list) –
        • (string) –
      • SourceType (string) –
      • Status (string) –
      • SubscriptionCreationTime (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) –
  • FinalDBSnapshotIdentifier (string) –
  • SkipFinalSnapshot (boolean) –
Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AllocatedStorage': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupFamily': 'string',
                'DBParameterGroupName': 'string',
                'Description': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupDescription': 'string',
                'DBSecurityGroupName': 'string',
                'EC2SecurityGroups': [
                    {
                        'EC2SecurityGroupName': 'string',
                        'EC2SecurityGroupOwnerId': 'string',
                        'Status': 'string'
                    },
                ],
                'IPRanges': [
                    {
                        'CIDRIP': 'string',
                        'Status': 'string'
                    },
                ],
                'NiftyAvailabilityZone': 'string',
                'OwnerId': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 'string'
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': 'string',
        'LatestRestorableTime': 'string',
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 'string',
            'BackupRetentionPeriod': 'string',
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': 'string',
            'NiftyMultiAZType': 'string',
            'Port': 'string'
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            {
                'ReadReplicaDBInstanceIdentifier': 'string'
            },
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {}
            ,
        ]
    }
}

Response Structure

  • (dict) –
    • DBInstance (dict) –
      • AllocatedStorage (string) –
      • AutoMinorVersionUpgrade (boolean) –
      • AvailabilityZone (string) –
      • BackupRetentionPeriod (string) –
      • DBInstanceClass (string) –
      • DBInstanceIdentifier (string) –
      • DBInstanceStatus (string) –
      • DBName (string) –
      • DBParameterGroups (list) –
        • (dict) –
          • DBParameterGroupFamily (string) –
          • DBParameterGroupName (string) –
          • Description (string) –
      • 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) –
      • Endpoint (dict) –
        • Address (string) –
        • NiftyPrivateAddress (string) –
        • Port (string) –
      • Engine (string) –
      • EngineVersion (string) –
      • InstanceCreateTime (string) –
      • LatestRestorableTime (string) –
      • LicenseModel (string) –
      • MasterUsername (string) –
      • MultiAZ (string) –
      • NiftyMasterPrivateAddress (string) –
      • NiftyMultiAZType (string) –
      • NiftyNetworkId (string) –
      • NiftySlavePrivateAddress (string) –
      • NiftyStorageType (integer) –
      • OptionGroupMemberships (list) –
        • (dict) –
          • OptionGroupName (string) –
          • Status (string) –
      • PendingModifiedValues (dict) –
        • AllocatedStorage (string) –
        • BackupRetentionPeriod (string) –
        • DBInstanceClass (string) –
        • DBInstanceIdentifier (string) –
        • EngineVersion (string) –
        • MasterUserPassword (string) –
        • MultiAZ (string) –
        • NiftyMultiAZType (string) –
        • Port (string) –
      • PreferredBackupWindow (string) –
      • PreferredMaintenanceWindow (string) –
      • PubliclyAccessible (boolean) –
      • ReadReplicaDBInstanceIdentifiers (list) –
        • (dict) –
          • ReadReplicaDBInstanceIdentifier (string) –
      • ReadReplicaSourceDBInstanceIdentifier (string) –
      • SecondaryAvailabilityZone (string) –
      • StatusInfos (list) –
        • (dict) –
          • Message (string) –
          • Normal (boolean) –
          • Status (string) –
          • StatusType (string) –
      • VpcSecurityGroups (list) –
        • (dict) –

delete_db_parameter_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_db_parameter_group(
    DBParameterGroupName='string'
)
Parameters:DBParameterGroupName (string) –
Returns:None
delete_db_security_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_db_security_group(
    DBSecurityGroupName='string'
)
Parameters:DBSecurityGroupName (string) –
Returns:None
delete_db_snapshot(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_db_snapshot(
    DBSnapshotIdentifier='string'
)
Parameters:DBSnapshotIdentifier (string) –
Return type:dict
Returns:Response Syntax
{
    'DBSnapshot': {
        'AllocatedStorage': 'string',
        'AvailabilityZone': 'string',
        'DBInstanceIdentifier': 'string',
        'DBSnapshotIdentifier': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': 'string',
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'OptionGroupName': 'string',
        'Port': 'string',
        'SnapshotCreateTime': 'string',
        'SnapshotType': 'string',
        'Status': 'string'
    }
}

Response Structure

  • (dict) –
    • DBSnapshot (dict) –
      • AllocatedStorage (string) –
      • AvailabilityZone (string) –
      • DBInstanceIdentifier (string) –
      • DBSnapshotIdentifier (string) –
      • Engine (string) –
      • EngineVersion (string) –
      • InstanceCreateTime (string) –
      • LicenseModel (string) –
      • MasterUsername (string) –
      • OptionGroupName (string) –
      • Port (string) –
      • SnapshotCreateTime (string) –
      • SnapshotType (string) –
      • Status (string) –
delete_event_subscription(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_event_subscription(
    SubscriptionName='string'
)
Parameters:SubscriptionName (string) –
Return type:dict
Returns:Response Syntax
{
    'EventSubscription': {
        'CustSubscriptionId': 'string',
        'Enabled': 'string',
        'EventCategoriesList': [
            'string',
        ],
        'NiftyDescription': 'string',
        'NiftyEmailAddressesList': [
            'string',
        ],
        'SourceIdsList': [
            'string',
        ],
        'SourceType': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string'
    }
}

Response Structure

  • (dict) –
    • EventSubscription (dict) –
      • CustSubscriptionId (string) –
      • Enabled (string) –
      • EventCategoriesList (list) –
        • (string) –
      • NiftyDescription (string) –
      • NiftyEmailAddressesList (list) –
        • (string) –
      • SourceIdsList (list) –
        • (string) –
      • SourceType (string) –
      • Status (string) –
      • SubscriptionCreationTime (string) –
describe_db_engine_versions(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_engine_versions(
    DBParameterGroupFamily='string',
    DefaultOnly=True|False,
    Engine='string',
    EngineVersion='string',
    Marker='string',
    MaxRecords=123
)
Parameters:
  • DBParameterGroupFamily (string) –
  • DefaultOnly (boolean) –
  • Engine (string) –
  • EngineVersion (string) –
  • Marker (string) –
  • MaxRecords (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'DBEngineVersions': [
        {
            'DBEngineDescription': 'string',
            'DBEngineVersionDescription': 'string',
            'DBParameterGroupFamily': 'string',
            'Engine': 'string',
            'EngineVersion': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) –
    • DBEngineVersions (list) –
      • (dict) –
        • DBEngineDescription (string) –
        • DBEngineVersionDescription (string) –
        • DBParameterGroupFamily (string) –
        • Engine (string) –
        • EngineVersion (string) –
    • Marker (string) –

describe_db_instances(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_instances(
    DBInstanceIdentifier='string',
    Marker='string',
    MaxRecords=123
)
Parameters:
  • DBInstanceIdentifier (string) –
  • Marker (string) –
  • MaxRecords (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'DBInstances': [
        {
            'AllocatedStorage': 'string',
            'AutoMinorVersionUpgrade': True|False,
            'AvailabilityZone': 'string',
            'BackupRetentionPeriod': 'string',
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'DBInstanceStatus': 'string',
            'DBName': 'string',
            'DBParameterGroups': [
                {
                    'DBParameterGroupFamily': 'string',
                    'DBParameterGroupName': 'string',
                    'Description': 'string'
                },
            ],
            'DBSecurityGroups': [
                {
                    'DBSecurityGroupDescription': 'string',
                    'DBSecurityGroupName': 'string',
                    'EC2SecurityGroups': [
                        {
                            'EC2SecurityGroupName': 'string',
                            'EC2SecurityGroupOwnerId': 'string',
                            'Status': 'string'
                        },
                    ],
                    'IPRanges': [
                        {
                            'CIDRIP': 'string',
                            'Status': 'string'
                        },
                    ],
                    'NiftyAvailabilityZone': 'string',
                    'OwnerId': 'string'
                },
            ],
            'Endpoint': {
                'Address': 'string',
                'NiftyPrivateAddress': 'string',
                'Port': 'string'
            },
            'Engine': 'string',
            'EngineVersion': 'string',
            'InstanceCreateTime': 'string',
            'LatestRestorableTime': 'string',
            'LicenseModel': 'string',
            'MasterUsername': 'string',
            'MultiAZ': 'string',
            'NiftyMasterPrivateAddress': 'string',
            'NiftyMultiAZType': 'string',
            'NiftyNetworkId': 'string',
            'NiftySlavePrivateAddress': 'string',
            'NiftyStorageType': 123,
            'OptionGroupMemberships': [
                {
                    'OptionGroupName': 'string',
                    'Status': 'string'
                },
            ],
            'PendingModifiedValues': {
                'AllocatedStorage': 'string',
                'BackupRetentionPeriod': 'string',
                'DBInstanceClass': 'string',
                'DBInstanceIdentifier': 'string',
                'EngineVersion': 'string',
                'MasterUserPassword': 'string',
                'MultiAZ': 'string',
                'NiftyMultiAZType': 'string',
                'Port': 'string'
            },
            'PreferredBackupWindow': 'string',
            'PreferredMaintenanceWindow': 'string',
            'PubliclyAccessible': True|False,
            'ReadReplicaDBInstanceIdentifiers': [
                {
                    'ReadReplicaDBInstanceIdentifier': 'string'
                },
            ],
            'ReadReplicaSourceDBInstanceIdentifier': 'string',
            'SecondaryAvailabilityZone': 'string',
            'StatusInfos': [
                {
                    'Message': 'string',
                    'Normal': True|False,
                    'Status': 'string',
                    'StatusType': 'string'
                },
            ],
            'VpcSecurityGroups': [
                {}
                ,
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) –
    • DBInstances (list) –
      • (dict) –
        • AllocatedStorage (string) –
        • AutoMinorVersionUpgrade (boolean) –
        • AvailabilityZone (string) –
        • BackupRetentionPeriod (string) –
        • DBInstanceClass (string) –
        • DBInstanceIdentifier (string) –
        • DBInstanceStatus (string) –
        • DBName (string) –
        • DBParameterGroups (list) –
          • (dict) –
            • DBParameterGroupFamily (string) –
            • DBParameterGroupName (string) –
            • Description (string) –
        • 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) –
        • Endpoint (dict) –
          • Address (string) –
          • NiftyPrivateAddress (string) –
          • Port (string) –
        • Engine (string) –
        • EngineVersion (string) –
        • InstanceCreateTime (string) –
        • LatestRestorableTime (string) –
        • LicenseModel (string) –
        • MasterUsername (string) –
        • MultiAZ (string) –
        • NiftyMasterPrivateAddress (string) –
        • NiftyMultiAZType (string) –
        • NiftyNetworkId (string) –
        • NiftySlavePrivateAddress (string) –
        • NiftyStorageType (integer) –
        • OptionGroupMemberships (list) –
          • (dict) –
            • OptionGroupName (string) –
            • Status (string) –
        • PendingModifiedValues (dict) –
          • AllocatedStorage (string) –
          • BackupRetentionPeriod (string) –
          • DBInstanceClass (string) –
          • DBInstanceIdentifier (string) –
          • EngineVersion (string) –
          • MasterUserPassword (string) –
          • MultiAZ (string) –
          • NiftyMultiAZType (string) –
          • Port (string) –
        • PreferredBackupWindow (string) –
        • PreferredMaintenanceWindow (string) –
        • PubliclyAccessible (boolean) –
        • ReadReplicaDBInstanceIdentifiers (list) –
          • (dict) –
            • ReadReplicaDBInstanceIdentifier (string) –
        • ReadReplicaSourceDBInstanceIdentifier (string) –
        • SecondaryAvailabilityZone (string) –
        • StatusInfos (list) –
          • (dict) –
            • Message (string) –
            • Normal (boolean) –
            • Status (string) –
            • StatusType (string) –
        • VpcSecurityGroups (list) –
          • (dict) –
    • Marker (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) –
  • FileLastWritten (integer) –
  • FileSize (integer) –
  • FilenameContains (string) –
  • Marker (string) –
  • MaxRecords (integer) –
Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –
    • DescribeDBLogFiles (list) –
      • (dict) –
        • LastWritten (string) –
        • LogFileName (string) –
        • Size (string) –
    • Marker (string) –

describe_db_parameter_groups(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_parameter_groups(
    DBParameterGroupName='string',
    Marker='string',
    MaxRecords=123
)
Parameters:
  • DBParameterGroupName (string) –
  • Marker (string) –
  • MaxRecords (integer) –
Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –
    • DBParameterGroups (list) –
      • (dict) –
        • DBParameterGroupFamily (string) –
        • DBParameterGroupName (string) –
        • Description (string) –
    • Marker (string) –

describe_db_parameters(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_parameters(
    DBParameterGroupName='string',
    Marker='string',
    MaxRecords=123,
    Source='string'
)
Parameters:
  • DBParameterGroupName (string) –
  • 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': 'string',
            'MinimumEngineVersion': 'string',
            'ParameterName': 'string',
            'ParameterValue': 'string',
            'Source': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • Marker (string) –
    • Parameters (list) –
      • (dict) –
        • AllowedValues (string) –
        • ApplyMethod (string) –
        • ApplyType (string) –
        • DataType (string) –
        • Description (string) –
        • IsModifiable (string) –
        • MinimumEngineVersion (string) –
        • ParameterName (string) –
        • ParameterValue (string) –
        • Source (string) –

describe_db_security_groups(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_security_groups(
    DBSecurityGroupName='string',
    Marker='string',
    MaxRecords=123
)
Parameters:
  • DBSecurityGroupName (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'
}

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) –

describe_db_snapshots(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_snapshots(
    DBInstanceIdentifier='string',
    DBSnapshotIdentifier='string',
    Marker='string',
    MaxRecords=123,
    SnapshotType='string'
)
Parameters:
  • DBInstanceIdentifier (string) –
  • DBSnapshotIdentifier (string) –
  • Marker (string) –
  • MaxRecords (integer) –
  • SnapshotType (string) –
Return type:

dict

Returns:

Response Syntax

{
    'DBSnapshots': [
        {
            'AllocatedStorage': 'string',
            'AvailabilityZone': 'string',
            'DBInstanceIdentifier': 'string',
            'DBSnapshotIdentifier': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'InstanceCreateTime': 'string',
            'LicenseModel': 'string',
            'MasterUsername': 'string',
            'OptionGroupName': 'string',
            'Port': 'string',
            'SnapshotCreateTime': 'string',
            'SnapshotType': 'string',
            'Status': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) –
    • DBSnapshots (list) –
      • (dict) –
        • AllocatedStorage (string) –
        • AvailabilityZone (string) –
        • DBInstanceIdentifier (string) –
        • DBSnapshotIdentifier (string) –
        • Engine (string) –
        • EngineVersion (string) –
        • InstanceCreateTime (string) –
        • LicenseModel (string) –
        • MasterUsername (string) –
        • OptionGroupName (string) –
        • Port (string) –
        • SnapshotCreateTime (string) –
        • SnapshotType (string) –
        • Status (string) –
    • Marker (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) –
  • 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': 'string',
                'MinimumEngineVersion': 'string',
                'ParameterName': 'string',
                'ParameterValue': 'string',
                'Source': 'string'
            },
        ]
    }
}

Response Structure

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

describe_event_categories(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_event_categories(
    SourceType='string'
)
Parameters:SourceType (string) –
Return type:dict
Returns:Response Syntax
{
    'EventCategoriesMapList': [
        {
            'EventCategories': [
                'string',
            ],
            'SourceType': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • EventCategoriesMapList (list) –
      • (dict) –
        • EventCategories (list) –
          • (string) –
        • SourceType (string) –
describe_event_subscriptions(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_event_subscriptions(
    Marker='string',
    MaxRecords=123,
    SubscriptionName='string'
)
Parameters:
  • Marker (string) –
  • MaxRecords (integer) –
  • SubscriptionName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'EventSubscriptionsList': [
        {
            'CustSubscriptionId': 'string',
            'Enabled': 'string',
            'EventCategoriesList': [
                'string',
            ],
            'NiftyDescription': 'string',
            'NiftyEmailAddressesList': [
                'string',
            ],
            'SourceIdsList': [
                'string',
            ],
            'SourceType': 'string',
            'Status': 'string',
            'SubscriptionCreationTime': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) –
    • EventSubscriptionsList (list) –
      • (dict) –
        • CustSubscriptionId (string) –
        • Enabled (string) –
        • EventCategoriesList (list) –
          • (string) –
        • NiftyDescription (string) –
        • NiftyEmailAddressesList (list) –
          • (string) –
        • SourceIdsList (list) –
          • (string) –
        • SourceType (string) –
        • Status (string) –
        • SubscriptionCreationTime (string) –
    • Marker (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='string',
    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': 'string',
            'EventCategories': [
                'string',
            ],
            'Message': 'string',
            'SourceIdentifier': 'string',
            'SourceType': 'string'
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) –
    • Events (list) –
      • (dict) –
        • Date (string) –
        • EventCategories (list) –
          • (string) –
        • Message (string) –
        • SourceIdentifier (string) –
        • SourceType (string) –
    • Marker (string) –

describe_orderable_db_instance_options(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_orderable_db_instance_options(
    DBInstanceClass='string',
    Engine='string',
    EngineVersion='string',
    LicenseModel='string',
    Marker='string',
    MaxRecords=123
)
Parameters:
  • DBInstanceClass (string) –
  • Engine (string) –
  • EngineVersion (string) –
  • LicenseModel (string) –
  • Marker (string) –
  • MaxRecords (integer) –
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
        },
    ]
}

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) –

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) –
  • LogFileName (string) –
  • Marker (string) –
  • NumberOfLines (integer) –
Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –
    • AdditionalDataPending (boolean) –
    • LogFileData (string) –
    • Marker (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)
modify_db_instance(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.modify_db_instance(
    AllocatedStorage=123,
    ApplyImmediately=True|False,
    BackupRetentionPeriod=123,
    DBInstanceClass='string',
    DBInstanceIdentifier='string',
    DBParameterGroupName='string',
    DBSecurityGroups=[
        'string',
    ],
    MasterUserPassword='string',
    MultiAZ=True|False,
    NewDBInstanceIdentifier='string',
    NiftyMultiAZType=123,
    NiftyReadReplicaDBInstanceIdentifier='string',
    NiftyReadReplicaPrivateAddress='string',
    NiftySlavePrivateAddress='string',
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string'
)
Parameters:
  • AllocatedStorage (integer) –
  • ApplyImmediately (boolean) –
  • BackupRetentionPeriod (integer) –
  • DBInstanceClass (string) –
  • DBInstanceIdentifier (string) –
  • DBParameterGroupName (string) –
  • DBSecurityGroups (list) –
    • (string) –
  • MasterUserPassword (string) –
  • MultiAZ (boolean) –
  • NewDBInstanceIdentifier (string) –
  • NiftyMultiAZType (integer) –
  • NiftyReadReplicaDBInstanceIdentifier (string) –
  • NiftyReadReplicaPrivateAddress (string) –
  • NiftySlavePrivateAddress (string) –
  • PreferredBackupWindow (string) –
  • PreferredMaintenanceWindow (string) –
Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AllocatedStorage': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupFamily': 'string',
                'DBParameterGroupName': 'string',
                'Description': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupDescription': 'string',
                'DBSecurityGroupName': 'string',
                'EC2SecurityGroups': [
                    {
                        'EC2SecurityGroupName': 'string',
                        'EC2SecurityGroupOwnerId': 'string',
                        'Status': 'string'
                    },
                ],
                'IPRanges': [
                    {
                        'CIDRIP': 'string',
                        'Status': 'string'
                    },
                ],
                'NiftyAvailabilityZone': 'string',
                'OwnerId': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 'string'
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': 'string',
        'LatestRestorableTime': 'string',
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 'string',
            'BackupRetentionPeriod': 'string',
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': 'string',
            'NiftyMultiAZType': 'string',
            'Port': 'string'
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            {
                'ReadReplicaDBInstanceIdentifier': 'string'
            },
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {}
            ,
        ]
    }
}

Response Structure

  • (dict) –
    • DBInstance (dict) –
      • AllocatedStorage (string) –
      • AutoMinorVersionUpgrade (boolean) –
      • AvailabilityZone (string) –
      • BackupRetentionPeriod (string) –
      • DBInstanceClass (string) –
      • DBInstanceIdentifier (string) –
      • DBInstanceStatus (string) –
      • DBName (string) –
      • DBParameterGroups (list) –
        • (dict) –
          • DBParameterGroupFamily (string) –
          • DBParameterGroupName (string) –
          • Description (string) –
      • 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) –
      • Endpoint (dict) –
        • Address (string) –
        • NiftyPrivateAddress (string) –
        • Port (string) –
      • Engine (string) –
      • EngineVersion (string) –
      • InstanceCreateTime (string) –
      • LatestRestorableTime (string) –
      • LicenseModel (string) –
      • MasterUsername (string) –
      • MultiAZ (string) –
      • NiftyMasterPrivateAddress (string) –
      • NiftyMultiAZType (string) –
      • NiftyNetworkId (string) –
      • NiftySlavePrivateAddress (string) –
      • NiftyStorageType (integer) –
      • OptionGroupMemberships (list) –
        • (dict) –
          • OptionGroupName (string) –
          • Status (string) –
      • PendingModifiedValues (dict) –
        • AllocatedStorage (string) –
        • BackupRetentionPeriod (string) –
        • DBInstanceClass (string) –
        • DBInstanceIdentifier (string) –
        • EngineVersion (string) –
        • MasterUserPassword (string) –
        • MultiAZ (string) –
        • NiftyMultiAZType (string) –
        • Port (string) –
      • PreferredBackupWindow (string) –
      • PreferredMaintenanceWindow (string) –
      • PubliclyAccessible (boolean) –
      • ReadReplicaDBInstanceIdentifiers (list) –
        • (dict) –
          • ReadReplicaDBInstanceIdentifier (string) –
      • ReadReplicaSourceDBInstanceIdentifier (string) –
      • SecondaryAvailabilityZone (string) –
      • StatusInfos (list) –
        • (dict) –
          • Message (string) –
          • Normal (boolean) –
          • Status (string) –
          • StatusType (string) –
      • VpcSecurityGroups (list) –
        • (dict) –

modify_db_parameter_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.modify_db_parameter_group(
    DBParameterGroupName='string',
    Parameters=[
        {
            'ApplyMethod': 'string',
            'ParameterName': 'string',
            'ParameterValue': 'string'
        },
    ]
)
Parameters:
  • DBParameterGroupName (string) –
  • Parameters (list) –
    • (dict) –
      • ApplyMethod (string) –
      • ParameterName (string) –
      • ParameterValue (string) –
Return type:

dict

Returns:

Response Syntax

{
    'DBParameterGroupName': 'string'
}

Response Structure

  • (dict) –
    • DBParameterGroupName (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',
    ],
    SourceType='string',
    SubscriptionName='string'
)
Parameters:
  • Enabled (boolean) –
  • EventCategories (list) –
    • (string) –
  • NiftyDescription (string) –
  • NiftyEmailAddresses (list) –
    • (string) –
  • SourceType (string) –
  • SubscriptionName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'EventSubscription': {
        'CustSubscriptionId': 'string',
        'Enabled': 'string',
        'EventCategoriesList': [
            'string',
        ],
        'NiftyDescription': 'string',
        'NiftyEmailAddressesList': [
            'string',
        ],
        'SourceIdsList': [
            'string',
        ],
        'SourceType': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string'
    }
}

Response Structure

  • (dict) –
    • EventSubscription (dict) –
      • CustSubscriptionId (string) –
      • Enabled (string) –
      • EventCategoriesList (list) –
        • (string) –
      • NiftyDescription (string) –
      • NiftyEmailAddressesList (list) –
        • (string) –
      • SourceIdsList (list) –
        • (string) –
      • SourceType (string) –
      • Status (string) –
      • SubscriptionCreationTime (string) –

nifty_failover_db_instance(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_failover_db_instance(
    DBInstanceIdentifier='string'
)
Parameters:DBInstanceIdentifier (string) –
Return type:dict
Returns:Response Syntax
{
    'DBInstance': {
        'AllocatedStorage': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupFamily': 'string',
                'DBParameterGroupName': 'string',
                'Description': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupDescription': 'string',
                'DBSecurityGroupName': 'string',
                'EC2SecurityGroups': [
                    {
                        'EC2SecurityGroupName': 'string',
                        'EC2SecurityGroupOwnerId': 'string',
                        'Status': 'string'
                    },
                ],
                'IPRanges': [
                    {
                        'CIDRIP': 'string',
                        'Status': 'string'
                    },
                ],
                'NiftyAvailabilityZone': 'string',
                'OwnerId': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 'string'
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': 'string',
        'LatestRestorableTime': 'string',
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 'string',
            'BackupRetentionPeriod': 'string',
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': 'string',
            'NiftyMultiAZType': 'string',
            'Port': 'string'
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            {
                'ReadReplicaDBInstanceIdentifier': 'string'
            },
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {}
            ,
        ]
    }
}

Response Structure

  • (dict) –
    • DBInstance (dict) –
      • AllocatedStorage (string) –
      • AutoMinorVersionUpgrade (boolean) –
      • AvailabilityZone (string) –
      • BackupRetentionPeriod (string) –
      • DBInstanceClass (string) –
      • DBInstanceIdentifier (string) –
      • DBInstanceStatus (string) –
      • DBName (string) –
      • DBParameterGroups (list) –
        • (dict) –
          • DBParameterGroupFamily (string) –
          • DBParameterGroupName (string) –
          • Description (string) –
      • 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) –
      • Endpoint (dict) –
        • Address (string) –
        • NiftyPrivateAddress (string) –
        • Port (string) –
      • Engine (string) –
      • EngineVersion (string) –
      • InstanceCreateTime (string) –
      • LatestRestorableTime (string) –
      • LicenseModel (string) –
      • MasterUsername (string) –
      • MultiAZ (string) –
      • NiftyMasterPrivateAddress (string) –
      • NiftyMultiAZType (string) –
      • NiftyNetworkId (string) –
      • NiftySlavePrivateAddress (string) –
      • NiftyStorageType (integer) –
      • OptionGroupMemberships (list) –
        • (dict) –
          • OptionGroupName (string) –
          • Status (string) –
      • PendingModifiedValues (dict) –
        • AllocatedStorage (string) –
        • BackupRetentionPeriod (string) –
        • DBInstanceClass (string) –
        • DBInstanceIdentifier (string) –
        • EngineVersion (string) –
        • MasterUserPassword (string) –
        • MultiAZ (string) –
        • NiftyMultiAZType (string) –
        • Port (string) –
      • PreferredBackupWindow (string) –
      • PreferredMaintenanceWindow (string) –
      • PubliclyAccessible (boolean) –
      • ReadReplicaDBInstanceIdentifiers (list) –
        • (dict) –
          • ReadReplicaDBInstanceIdentifier (string) –
      • ReadReplicaSourceDBInstanceIdentifier (string) –
      • SecondaryAvailabilityZone (string) –
      • StatusInfos (list) –
        • (dict) –
          • Message (string) –
          • Normal (boolean) –
          • Status (string) –
          • StatusType (string) –
      • VpcSecurityGroups (list) –
        • (dict) –
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='string',
    StartTime=datetime(2015, 1, 1)
)
Parameters:
  • Dimensions (list) –
    • (dict) –
      • Name (string) –
      • Value (string) –
  • EndTime (datetime) –
  • MetricName (string) –
  • StartTime (datetime) –
Return type:

dict

Returns:

Response Syntax

{
    'Datapoints': [
        {
            'NiftyTargetName': 'string',
            'SampleCount': 'string',
            'Sum': 'string',
            'Timestamp': 'string'
        },
    ],
    'Label': 'string'
}

Response Structure

  • (dict) –
    • Datapoints (list) –
      • (dict) –
        • NiftyTargetName (string) –
        • SampleCount (string) –
        • Sum (string) –
        • Timestamp (string) –
    • Label (string) –

reboot_db_instance(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.reboot_db_instance(
    DBInstanceIdentifier='string',
    ForceFailover=True|False,
    NiftyRebootType='string'
)
Parameters:
  • DBInstanceIdentifier (string) –
  • ForceFailover (boolean) –
  • NiftyRebootType (string) –
Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AllocatedStorage': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupFamily': 'string',
                'DBParameterGroupName': 'string',
                'Description': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupDescription': 'string',
                'DBSecurityGroupName': 'string',
                'EC2SecurityGroups': [
                    {
                        'EC2SecurityGroupName': 'string',
                        'EC2SecurityGroupOwnerId': 'string',
                        'Status': 'string'
                    },
                ],
                'IPRanges': [
                    {
                        'CIDRIP': 'string',
                        'Status': 'string'
                    },
                ],
                'NiftyAvailabilityZone': 'string',
                'OwnerId': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 'string'
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': 'string',
        'LatestRestorableTime': 'string',
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 'string',
            'BackupRetentionPeriod': 'string',
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': 'string',
            'NiftyMultiAZType': 'string',
            'Port': 'string'
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            {
                'ReadReplicaDBInstanceIdentifier': 'string'
            },
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {}
            ,
        ]
    }
}

Response Structure

  • (dict) –
    • DBInstance (dict) –
      • AllocatedStorage (string) –
      • AutoMinorVersionUpgrade (boolean) –
      • AvailabilityZone (string) –
      • BackupRetentionPeriod (string) –
      • DBInstanceClass (string) –
      • DBInstanceIdentifier (string) –
      • DBInstanceStatus (string) –
      • DBName (string) –
      • DBParameterGroups (list) –
        • (dict) –
          • DBParameterGroupFamily (string) –
          • DBParameterGroupName (string) –
          • Description (string) –
      • 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) –
      • Endpoint (dict) –
        • Address (string) –
        • NiftyPrivateAddress (string) –
        • Port (string) –
      • Engine (string) –
      • EngineVersion (string) –
      • InstanceCreateTime (string) –
      • LatestRestorableTime (string) –
      • LicenseModel (string) –
      • MasterUsername (string) –
      • MultiAZ (string) –
      • NiftyMasterPrivateAddress (string) –
      • NiftyMultiAZType (string) –
      • NiftyNetworkId (string) –
      • NiftySlavePrivateAddress (string) –
      • NiftyStorageType (integer) –
      • OptionGroupMemberships (list) –
        • (dict) –
          • OptionGroupName (string) –
          • Status (string) –
      • PendingModifiedValues (dict) –
        • AllocatedStorage (string) –
        • BackupRetentionPeriod (string) –
        • DBInstanceClass (string) –
        • DBInstanceIdentifier (string) –
        • EngineVersion (string) –
        • MasterUserPassword (string) –
        • MultiAZ (string) –
        • NiftyMultiAZType (string) –
        • Port (string) –
      • PreferredBackupWindow (string) –
      • PreferredMaintenanceWindow (string) –
      • PubliclyAccessible (boolean) –
      • ReadReplicaDBInstanceIdentifiers (list) –
        • (dict) –
          • ReadReplicaDBInstanceIdentifier (string) –
      • ReadReplicaSourceDBInstanceIdentifier (string) –
      • SecondaryAvailabilityZone (string) –
      • StatusInfos (list) –
        • (dict) –
          • Message (string) –
          • Normal (boolean) –
          • Status (string) –
          • StatusType (string) –
      • VpcSecurityGroups (list) –
        • (dict) –

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) –
  • SubscriptionName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'EventSubscription': {
        'CustSubscriptionId': 'string',
        'Enabled': 'string',
        'EventCategoriesList': [
            'string',
        ],
        'NiftyDescription': 'string',
        'NiftyEmailAddressesList': [
            'string',
        ],
        'SourceIdsList': [
            'string',
        ],
        'SourceType': 'string',
        'Status': 'string',
        'SubscriptionCreationTime': 'string'
    }
}

Response Structure

  • (dict) –
    • EventSubscription (dict) –
      • CustSubscriptionId (string) –
      • Enabled (string) –
      • EventCategoriesList (list) –
        • (string) –
      • NiftyDescription (string) –
      • NiftyEmailAddressesList (list) –
        • (string) –
      • SourceIdsList (list) –
        • (string) –
      • SourceType (string) –
      • Status (string) –
      • SubscriptionCreationTime (string) –

reset_db_parameter_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.reset_db_parameter_group(
    DBParameterGroupName='string',
    Parameters=[
        {
            'ApplyMethod': 'string',
            'ParameterName': 'string',
            'ParameterValue': 'string'
        },
    ],
    ResetAllParameters=True|False
)
Parameters:
  • DBParameterGroupName (string) –
  • Parameters (list) –
    • (dict) –
      • ApplyMethod (string) –
      • ParameterName (string) –
      • ParameterValue (string) –
  • ResetAllParameters (boolean) –
Return type:

dict

Returns:

Response Syntax

{
    'DBParameterGroupName': 'string'
}

Response Structure

  • (dict) –
    • DBParameterGroupName (string) –

restore_db_instance_from_db_snapshot(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.restore_db_instance_from_db_snapshot(
    AvailabilityZone='string',
    DBInstanceClass='string',
    DBInstanceIdentifier='string',
    DBName='string',
    DBSnapshotIdentifier='string',
    Engine='string',
    LicenseModel='string',
    MultiAZ=True|False,
    NiftyDBParameterGroupName='string',
    NiftyDBSecurityGroups=[
        'string',
    ],
    NiftyMasterPrivateAddress='string',
    NiftyMultiAZType=123,
    NiftyNetworkId='string',
    NiftyReadReplicaDBInstanceIdentifier=123,
    NiftyReadReplicaPrivateAddress='string',
    NiftySlavePrivateAddress='string',
    NiftyStorageType=123,
    NiftyVirtualPrivateAddress='string',
    Port=123,
    PubliclyAccessible=True|False
)
Parameters:
  • AvailabilityZone (string) –
  • DBInstanceClass (string) –
  • DBInstanceIdentifier (string) –
  • DBName (string) –
  • DBSnapshotIdentifier (string) –
  • Engine (string) –
  • LicenseModel (string) –
  • MultiAZ (boolean) –
  • NiftyDBParameterGroupName (string) –
  • NiftyDBSecurityGroups (list) –
    • (string) –
  • NiftyMasterPrivateAddress (string) –
  • NiftyMultiAZType (integer) –
  • NiftyNetworkId (string) –
  • NiftyReadReplicaDBInstanceIdentifier (integer) –
  • NiftyReadReplicaPrivateAddress (string) –
  • NiftySlavePrivateAddress (string) –
  • NiftyStorageType (integer) –
  • NiftyVirtualPrivateAddress (string) –
  • Port (integer) –
  • PubliclyAccessible (boolean) –
Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AllocatedStorage': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupFamily': 'string',
                'DBParameterGroupName': 'string',
                'Description': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupDescription': 'string',
                'DBSecurityGroupName': 'string',
                'EC2SecurityGroups': [
                    {
                        'EC2SecurityGroupName': 'string',
                        'EC2SecurityGroupOwnerId': 'string',
                        'Status': 'string'
                    },
                ],
                'IPRanges': [
                    {
                        'CIDRIP': 'string',
                        'Status': 'string'
                    },
                ],
                'NiftyAvailabilityZone': 'string',
                'OwnerId': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 'string'
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': 'string',
        'LatestRestorableTime': 'string',
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 'string',
            'BackupRetentionPeriod': 'string',
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': 'string',
            'NiftyMultiAZType': 'string',
            'Port': 'string'
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            {
                'ReadReplicaDBInstanceIdentifier': 'string'
            },
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {}
            ,
        ]
    }
}

Response Structure

  • (dict) –
    • DBInstance (dict) –
      • AllocatedStorage (string) –
      • AutoMinorVersionUpgrade (boolean) –
      • AvailabilityZone (string) –
      • BackupRetentionPeriod (string) –
      • DBInstanceClass (string) –
      • DBInstanceIdentifier (string) –
      • DBInstanceStatus (string) –
      • DBName (string) –
      • DBParameterGroups (list) –
        • (dict) –
          • DBParameterGroupFamily (string) –
          • DBParameterGroupName (string) –
          • Description (string) –
      • 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) –
      • Endpoint (dict) –
        • Address (string) –
        • NiftyPrivateAddress (string) –
        • Port (string) –
      • Engine (string) –
      • EngineVersion (string) –
      • InstanceCreateTime (string) –
      • LatestRestorableTime (string) –
      • LicenseModel (string) –
      • MasterUsername (string) –
      • MultiAZ (string) –
      • NiftyMasterPrivateAddress (string) –
      • NiftyMultiAZType (string) –
      • NiftyNetworkId (string) –
      • NiftySlavePrivateAddress (string) –
      • NiftyStorageType (integer) –
      • OptionGroupMemberships (list) –
        • (dict) –
          • OptionGroupName (string) –
          • Status (string) –
      • PendingModifiedValues (dict) –
        • AllocatedStorage (string) –
        • BackupRetentionPeriod (string) –
        • DBInstanceClass (string) –
        • DBInstanceIdentifier (string) –
        • EngineVersion (string) –
        • MasterUserPassword (string) –
        • MultiAZ (string) –
        • NiftyMultiAZType (string) –
        • Port (string) –
      • PreferredBackupWindow (string) –
      • PreferredMaintenanceWindow (string) –
      • PubliclyAccessible (boolean) –
      • ReadReplicaDBInstanceIdentifiers (list) –
        • (dict) –
          • ReadReplicaDBInstanceIdentifier (string) –
      • ReadReplicaSourceDBInstanceIdentifier (string) –
      • SecondaryAvailabilityZone (string) –
      • StatusInfos (list) –
        • (dict) –
          • Message (string) –
          • Normal (boolean) –
          • Status (string) –
          • StatusType (string) –
      • VpcSecurityGroups (list) –
        • (dict) –

restore_db_instance_to_point_in_time(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.restore_db_instance_to_point_in_time(
    AvailabilityZone='string',
    DBInstanceClass='string',
    DBName='string',
    Engine='string',
    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',
    Port=123,
    PubliclyAccessible=True|False,
    RestoreTime=datetime(2015, 1, 1),
    SourceDBInstanceIdentifier='string',
    TargetDBInstanceIdentifier='string',
    UseLatestRestorableTime=True|False
)
Parameters:
  • AvailabilityZone (string) –
  • DBInstanceClass (string) –
  • DBName (string) –
  • Engine (string) –
  • 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) –
  • Port (integer) –
  • PubliclyAccessible (boolean) –
  • RestoreTime (datetime) –
  • SourceDBInstanceIdentifier (string) –
  • TargetDBInstanceIdentifier (string) –
  • UseLatestRestorableTime (boolean) –
Return type:

dict

Returns:

Response Syntax

{
    'DBInstance': {
        'AllocatedStorage': 'string',
        'AutoMinorVersionUpgrade': True|False,
        'AvailabilityZone': 'string',
        'BackupRetentionPeriod': 'string',
        'DBInstanceClass': 'string',
        'DBInstanceIdentifier': 'string',
        'DBInstanceStatus': 'string',
        'DBName': 'string',
        'DBParameterGroups': [
            {
                'DBParameterGroupFamily': 'string',
                'DBParameterGroupName': 'string',
                'Description': 'string'
            },
        ],
        'DBSecurityGroups': [
            {
                'DBSecurityGroupDescription': 'string',
                'DBSecurityGroupName': 'string',
                'EC2SecurityGroups': [
                    {
                        'EC2SecurityGroupName': 'string',
                        'EC2SecurityGroupOwnerId': 'string',
                        'Status': 'string'
                    },
                ],
                'IPRanges': [
                    {
                        'CIDRIP': 'string',
                        'Status': 'string'
                    },
                ],
                'NiftyAvailabilityZone': 'string',
                'OwnerId': 'string'
            },
        ],
        'Endpoint': {
            'Address': 'string',
            'NiftyPrivateAddress': 'string',
            'Port': 'string'
        },
        'Engine': 'string',
        'EngineVersion': 'string',
        'InstanceCreateTime': 'string',
        'LatestRestorableTime': 'string',
        'LicenseModel': 'string',
        'MasterUsername': 'string',
        'MultiAZ': 'string',
        'NiftyMasterPrivateAddress': 'string',
        'NiftyMultiAZType': 'string',
        'NiftyNetworkId': 'string',
        'NiftySlavePrivateAddress': 'string',
        'NiftyStorageType': 123,
        'OptionGroupMemberships': [
            {
                'OptionGroupName': 'string',
                'Status': 'string'
            },
        ],
        'PendingModifiedValues': {
            'AllocatedStorage': 'string',
            'BackupRetentionPeriod': 'string',
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'EngineVersion': 'string',
            'MasterUserPassword': 'string',
            'MultiAZ': 'string',
            'NiftyMultiAZType': 'string',
            'Port': 'string'
        },
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PubliclyAccessible': True|False,
        'ReadReplicaDBInstanceIdentifiers': [
            {
                'ReadReplicaDBInstanceIdentifier': 'string'
            },
        ],
        'ReadReplicaSourceDBInstanceIdentifier': 'string',
        'SecondaryAvailabilityZone': 'string',
        'StatusInfos': [
            {
                'Message': 'string',
                'Normal': True|False,
                'Status': 'string',
                'StatusType': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {}
            ,
        ]
    }
}

Response Structure

  • (dict) –
    • DBInstance (dict) –
      • AllocatedStorage (string) –
      • AutoMinorVersionUpgrade (boolean) –
      • AvailabilityZone (string) –
      • BackupRetentionPeriod (string) –
      • DBInstanceClass (string) –
      • DBInstanceIdentifier (string) –
      • DBInstanceStatus (string) –
      • DBName (string) –
      • DBParameterGroups (list) –
        • (dict) –
          • DBParameterGroupFamily (string) –
          • DBParameterGroupName (string) –
          • Description (string) –
      • 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) –
      • Endpoint (dict) –
        • Address (string) –
        • NiftyPrivateAddress (string) –
        • Port (string) –
      • Engine (string) –
      • EngineVersion (string) –
      • InstanceCreateTime (string) –
      • LatestRestorableTime (string) –
      • LicenseModel (string) –
      • MasterUsername (string) –
      • MultiAZ (string) –
      • NiftyMasterPrivateAddress (string) –
      • NiftyMultiAZType (string) –
      • NiftyNetworkId (string) –
      • NiftySlavePrivateAddress (string) –
      • NiftyStorageType (integer) –
      • OptionGroupMemberships (list) –
        • (dict) –
          • OptionGroupName (string) –
          • Status (string) –
      • PendingModifiedValues (dict) –
        • AllocatedStorage (string) –
        • BackupRetentionPeriod (string) –
        • DBInstanceClass (string) –
        • DBInstanceIdentifier (string) –
        • EngineVersion (string) –
        • MasterUserPassword (string) –
        • MultiAZ (string) –
        • NiftyMultiAZType (string) –
        • Port (string) –
      • PreferredBackupWindow (string) –
      • PreferredMaintenanceWindow (string) –
      • PubliclyAccessible (boolean) –
      • ReadReplicaDBInstanceIdentifiers (list) –
        • (dict) –
          • ReadReplicaDBInstanceIdentifier (string) –
      • ReadReplicaSourceDBInstanceIdentifier (string) –
      • SecondaryAvailabilityZone (string) –
      • StatusInfos (list) –
        • (dict) –
          • Message (string) –
          • Normal (boolean) –
          • Status (string) –
          • StatusType (string) –
      • VpcSecurityGroups (list) –
        • (dict) –

revoke_db_security_group_ingress(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.revoke_db_security_group_ingress(
    CIDRIP='string',
    DBSecurityGroupName='string',
    EC2SecurityGroupName='string'
)
Parameters:
  • CIDRIP (string) –
  • DBSecurityGroupName (string) –
  • EC2SecurityGroupName (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'
    }
}

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) –