RDS / Client / describe_option_group_options

describe_option_group_options#

RDS.Client.describe_option_group_options(**kwargs)#

Describes all available options for the specified engine.

Request Syntax

response = client.describe_option_group_options(
    EngineName='string',
    MajorEngineVersion='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

Parameters:

EngineName (string) –
[REQUIRED]

The name of the engine to describe options for.

Valid Values:
- db2-ae
- db2-se
- mariadb
- mysql
- oracle-ee
- oracle-ee-cdb
- oracle-se2
- oracle-se2-cdb
- postgres
- sqlserver-ee
- sqlserver-se
- sqlserver-ex
- sqlserver-web
MajorEngineVersion (string) – If specified, filters the results to include only options for the specified major engine version.
Filters (list) –
This parameter isn’t currently supported.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
  
  Note
  Currently, wildcards are not supported in filters.
  
  The following actions can be filtered:
  - DescribeDBClusterBacktracks
  - DescribeDBClusterEndpoints
  - DescribeDBClusters
  - DescribeDBInstances
  - DescribeDBRecommendations
  - DescribePendingMaintenanceActions
  - Name (string) – [REQUIRED]
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) – [REQUIRED]
    
    One or more filter values. Filter values are case-sensitive.
    - (string) –
MaxRecords (integer) –
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.
Marker (string) – An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Return type:

dict

Returns:

Response Syntax

{
    'OptionGroupOptions': [
        {
            'Name': 'string',
            'Description': 'string',
            'EngineName': 'string',
            'MajorEngineVersion': 'string',
            'MinimumRequiredMinorEngineVersion': 'string',
            'PortRequired': True|False,
            'DefaultPort': 123,
            'OptionsDependedOn': [
                'string',
            ],
            'OptionsConflictsWith': [
                'string',
            ],
            'Persistent': True|False,
            'Permanent': True|False,
            'RequiresAutoMinorEngineVersionUpgrade': True|False,
            'VpcOnly': True|False,
            'SupportsOptionVersionDowngrade': True|False,
            'OptionGroupOptionSettings': [
                {
                    'SettingName': 'string',
                    'SettingDescription': 'string',
                    'DefaultValue': 'string',
                    'ApplyType': 'string',
                    'AllowedValues': 'string',
                    'IsModifiable': True|False,
                    'IsRequired': True|False,
                    'MinimumEngineVersionPerAllowedValue': [
                        {
                            'AllowedValue': 'string',
                            'MinimumEngineVersion': 'string'
                        },
                    ]
                },
            ],
            'OptionGroupOptionVersions': [
                {
                    'Version': 'string',
                    'IsDefault': True|False
                },
            ],
            'CopyableCrossAccount': True|False
        },
    ],
    'Marker': 'string'
}

Response Structure

(dict) –
- OptionGroupOptions (list) –
  
  List of available option group options.
  - (dict) –
    
    Available option.
    - Name (string) –
      
      The name of the option.
    - Description (string) –
      
      The description of the option.
    - EngineName (string) –
      
      The name of the engine that this option can be applied to.
    - MajorEngineVersion (string) –
      
      Indicates the major engine version that the option is available for.
    - MinimumRequiredMinorEngineVersion (string) –
      
      The minimum required engine version for the option to be applied.
    - PortRequired (boolean) –
      
      Indicates whether the option requires a port.
    - DefaultPort (integer) –
      
      If the option requires a port, specifies the default port for the option.
    - OptionsDependedOn (list) –
      
      The options that are prerequisites for this option.
      - (string) –
    - OptionsConflictsWith (list) –
      
      The options that conflict with this option.
      - (string) –
    - Persistent (boolean) –
      
      Persistent options can’t be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
    - Permanent (boolean) –
      
      Permanent options can never be removed from an option group. An option group containing a permanent option can’t be removed from a DB instance.
    - RequiresAutoMinorEngineVersionUpgrade (boolean) –
      
      If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
    - VpcOnly (boolean) –
      
      If true, you can only use this option with a DB instance that is in a VPC.
    - SupportsOptionVersionDowngrade (boolean) –
      
      If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
    - OptionGroupOptionSettings (list) –
      
      The option settings that are available (and the default value) for each option in an option group.
      - (dict) –
        
        Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
        
        SettingName (string) –
        
        The name of the option group option.
        
        SettingDescription (string) –
        
        The description of the option group option.
        
        DefaultValue (string) –
        
        The default value for the option group option.
        
        ApplyType (string) –
        
        The DB engine specific parameter type for the option group option.
        
        AllowedValues (string) –
        
        Indicates the acceptable values for the option group option.
        
        IsModifiable (boolean) –
        
        Indicates whether this option group option can be changed from the default value.
        
        IsRequired (boolean) –
        
        Indicates whether a value must be specified for this option setting of the option group option.
        
        MinimumEngineVersionPerAllowedValue (list) –
        
        The minimum DB engine version required for the corresponding allowed value for this option setting.
        
        (dict) –
        
        The minimum DB engine version required for each corresponding allowed value for an option setting.
        
        AllowedValue (string) –
        
        The allowed value for an option setting.
        
        MinimumEngineVersion (string) –
        
        The minimum DB engine version required for the allowed value.
    - OptionGroupOptionVersions (list) –
      
      The versions that are available for the option.
      - (dict) –
        
        The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.
        
        Version (string) –
        
        The version of the option.
        
        IsDefault (boolean) –
        
        Indicates whether the version is the default version of the option.
    - CopyableCrossAccount (boolean) –
      
      Indicates whether the option can be copied across Amazon Web Services accounts.
- Marker (string) –
  
  An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Examples

This example lists information for all option group options for the specified DB engine.

response = client.describe_option_group_options(
    EngineName='mysql',
    MajorEngineVersion='5.6',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}