Request Parameters Response Elements Errors Examples See Also

DescribeOptionGroups

Describes the available option groups.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

EngineName

A filter to only include option groups associated with this database engine.

Valid Values:

db2-ae
db2-ce
db2-se
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web

Type: String

Required: No

Filters.Filter.N

This parameter isn't currently supported.

Type: Array of Filter objects

Required: No

MajorEngineVersion

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Type: String

Required: No

Marker

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

Type: String

Required: No

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Required: No

OptionGroupName

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

Marker

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

Type: String

OptionGroupsList.OptionGroup.N

List of option groups.

Type: Array of OptionGroup objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

OptionGroupNotFoundFault

The specified option group could not be found.

HTTP Status Code: 404

Examples

Example

This example illustrates one usage of DescribeOptionGroups.

Sample Request



https://rds.us-east-1.amazonaws.com/
   ?Action=DescribeOptionGroups
   &MaxRecords=100
   &OptionGroupName=myawsuser-grp1
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-east-1/rds/aws4_request
   &X-Amz-Date=20140421T231357Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=fabfbeb85c44e3f151d44211790c5135a9074fdb8d85ec117788ac6cfab6c5bc

Sample Response




  
    
      
        true
        5.6
        myawsuser-grp1
        mysql
        my test option group
        
      
    
  
  
    8c6201fc-b9ff-11d3-f92b-31fa5e8dbc99

Example

This example illustrates one usage of DescribeOptionGroups.

Sample Request



https://rds.us-west-2.amazonaws.com/
    ?Action=DescribeOptionGroups
    &MaxRecords=100
    &SignatureMethod=HmacSHA256
    &SignatureVersion=4
    &Version=2014-10-31
    &X-Amz-Algorithm=AWS4-HMAC-SHA256
    &X-Amz-Credential=AKIADQKE4SARGYLE/20140613/us-west-2/rds/aws4_request
    &X-Amz-Date=20140613T223341Z
    &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
    &X-Amz-Signature=5ae331adcd684c27d66e0b794a51933effe32a4c026eba2e994ae483ee47a0ba

Sample Response




  
    
      
        default:mysql-5-5
        true
        5.5
        mysql
        Default option group MySQL 5.5
        
      
      
        default:postgres-9-3
        true
        9.3
        postgres
        Default option group for postgres 9.3
        
      
      
        default:sqlserver-ex-10-50
        true
        10.50
        sqlserver-ex
        Default option group for sqlserver-ex 10.50
        
      
      
        default:sqlserver-se-10-50-mirrored
        true
        10.50
        sqlserver-se
        Default Mirroring-enabled option group for sqlserver-se 10.50
        
          
        
      
      
        default:sqlserver-se-11-00
        true
        11.00
        sqlserver-se
        Default option group for sqlserver-se 11.00
        
      
      
        myawsuser-opt-grp
        false
        11.2
        oracle-ee
        test option group
        
          
          
          
        
      
          
        
      
    
  
  
    b2ce0772-f55a-11e3-bd0f-bb88ac05a37c