Neptune / Client / describe_valid_db_instance_modifications

describe_valid_db_instance_modifications

Neptune.Client.describe_valid_db_instance_modifications(**kwargs)

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

See also: AWS API Documentation

Request Syntax

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

Parameters:

DBInstanceIdentifier (string) –

[REQUIRED]

The customer identifier or the ARN of your DB instance.

Return type:

dict

Returns:

Response Syntax

{
    'ValidDBInstanceModificationsMessage': {
        'Storage': [
            {
                'StorageType': 'string',
                'StorageSize': [
                    {
                        'From': 123,
                        'To': 123,
                        'Step': 123
                    },
                ],
                'ProvisionedIops': [
                    {
                        'From': 123,
                        'To': 123,
                        'Step': 123
                    },
                ],
                'IopsToStorageRatio': [
                    {
                        'From': 123.0,
                        'To': 123.0
                    },
                ]
            },
        ]
    }
}

Response Structure

• (dict) –

  • ValidDBInstanceModificationsMessage (dict) –

    Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

    • Storage (list) –

      Valid storage options for your DB instance.

      • (dict) –

        Information about valid modifications that you can make to your DB instance.

        Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

        • StorageType (string) –

          The valid storage types for your DB instance. For example, gp2, io1.

        • StorageSize (list) –

          The valid range of storage in gibibytes. For example, 100 to 16384.

          • (dict) –

            A range of integer values.

            • From (integer) –

              The minimum value in the range.

            • To (integer) –

              The maximum value in the range.

            • Step (integer) –

              The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn’t a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000…

        • ProvisionedIops (list) –

          The valid range of provisioned IOPS. For example, 1000-20000.

          • (dict) –

            A range of integer values.

            • From (integer) –

              The minimum value in the range.

            • To (integer) –

              The maximum value in the range.

            • Step (integer) –

              The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn’t a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000…

        • IopsToStorageRatio (list) –

          The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

          • (dict) –

            A range of double values.

            • From (float) –

              The minimum value in the range.

            • To (float) –

              The maximum value in the range.

Exceptions

• Neptune.Client.exceptions.DBInstanceNotFoundFault

• Neptune.Client.exceptions.InvalidDBInstanceStateFault