Amazonka.RDS.DescribeOptionGroupOptions

Describes all available options.

This operation returns paginated results.

Creating a Request

data DescribeOptionGroupOptions

See: newDescribeOptionGroupOptions smart constructor.

Constructors

DescribeOptionGroupOptions'

Fields

• filters :: Maybe [Filter]

  This parameter isn't currently supported.

• majorEngineVersion :: Maybe Text

  If specified, filters the results to include only options for the specified major engine version.

• marker :: Maybe Text

  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.

• maxRecords :: Maybe Int

  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.

• engineName :: Text

  A required parameter. Options available for the given engine name are described.

  Valid Values:

  • mariadb

  • mysql

  • oracle-ee

  • oracle-ee-cdb

  • oracle-se2

  • oracle-se2-cdb

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Instances

ToHeaders DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

toHeaders :: DescribeOptionGroupOptions -> [Header]

ToPath DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

toPath :: DescribeOptionGroupOptions -> ByteString

ToQuery DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

toQuery :: DescribeOptionGroupOptions -> QueryString

AWSPager DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

page :: DescribeOptionGroupOptions -> AWSResponse DescribeOptionGroupOptions -> Maybe DescribeOptionGroupOptions

AWSRequest DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Associated Types

type AWSResponse DescribeOptionGroupOptions

Methods

request :: (Service -> Service) -> DescribeOptionGroupOptions -> Request DescribeOptionGroupOptions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeOptionGroupOptions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeOptionGroupOptions)))

Generic DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Associated Types

type Rep DescribeOptionGroupOptions :: Type -> Type

Methods

from :: DescribeOptionGroupOptions -> Rep DescribeOptionGroupOptions x

to :: Rep DescribeOptionGroupOptions x -> DescribeOptionGroupOptions

Read DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

readsPrec :: Int -> ReadS DescribeOptionGroupOptions

readList :: ReadS [DescribeOptionGroupOptions]

readPrec :: ReadPrec DescribeOptionGroupOptions

readListPrec :: ReadPrec [DescribeOptionGroupOptions]

Show DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

showsPrec :: Int -> DescribeOptionGroupOptions -> ShowS

show :: DescribeOptionGroupOptions -> String

showList :: [DescribeOptionGroupOptions] -> ShowS

NFData DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

rnf :: DescribeOptionGroupOptions -> ()

Eq DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

(==) :: DescribeOptionGroupOptions -> DescribeOptionGroupOptions -> Bool

(/=) :: DescribeOptionGroupOptions -> DescribeOptionGroupOptions -> Bool

Hashable DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

hashWithSalt :: Int -> DescribeOptionGroupOptions -> Int

hash :: DescribeOptionGroupOptions -> Int

type AWSResponse DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

type AWSResponse DescribeOptionGroupOptions = DescribeOptionGroupOptionsResponse

type Rep DescribeOptionGroupOptions

Defined in Amazonka.RDS.DescribeOptionGroupOptions

type Rep DescribeOptionGroupOptions = D1 ('MetaData "DescribeOptionGroupOptions" "Amazonka.RDS.DescribeOptionGroupOptions" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeOptionGroupOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "majorEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "engineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeOptionGroupOptions

Arguments

:: Text

DescribeOptionGroupOptions

-> DescribeOptionGroupOptions

Create a value of DescribeOptionGroupOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:filters:DescribeOptionGroupOptions', describeOptionGroupOptions_filters - This parameter isn't currently supported.

DescribeOptionGroupOptions, describeOptionGroupOptions_majorEngineVersion - If specified, filters the results to include only options for the specified major engine version.

DescribeOptionGroupOptions, describeOptionGroupOptions_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.

$sel:maxRecords:DescribeOptionGroupOptions', describeOptionGroupOptions_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.

DescribeOptionGroupOptions, describeOptionGroupOptions_engineName - A required parameter. Options available for the given engine name are described.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Request Lenses

describeOptionGroupOptions_filters :: Lens' DescribeOptionGroupOptions (Maybe [Filter])

This parameter isn't currently supported.

describeOptionGroupOptions_majorEngineVersion :: Lens' DescribeOptionGroupOptions (Maybe Text)

If specified, filters the results to include only options for the specified major engine version.

describeOptionGroupOptions_marker :: Lens' DescribeOptionGroupOptions (Maybe Text)

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.

describeOptionGroupOptions_maxRecords :: Lens' DescribeOptionGroupOptions (Maybe Int)

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.

describeOptionGroupOptions_engineName :: Lens' DescribeOptionGroupOptions Text

A required parameter. Options available for the given engine name are described.

Valid Values:

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Destructuring the Response

data DescribeOptionGroupOptionsResponse

See: newDescribeOptionGroupOptionsResponse smart constructor.

Constructors

DescribeOptionGroupOptionsResponse'

Fields

• marker :: Maybe Text

  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.

• optionGroupOptions :: Maybe [OptionGroupOption]
• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeOptionGroupOptionsResponse

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Associated Types

type Rep DescribeOptionGroupOptionsResponse :: Type -> Type

Methods

from :: DescribeOptionGroupOptionsResponse -> Rep DescribeOptionGroupOptionsResponse x

to :: Rep DescribeOptionGroupOptionsResponse x -> DescribeOptionGroupOptionsResponse

Read DescribeOptionGroupOptionsResponse

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

readsPrec :: Int -> ReadS DescribeOptionGroupOptionsResponse

readList :: ReadS [DescribeOptionGroupOptionsResponse]

readPrec :: ReadPrec DescribeOptionGroupOptionsResponse

readListPrec :: ReadPrec [DescribeOptionGroupOptionsResponse]

Show DescribeOptionGroupOptionsResponse

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

showsPrec :: Int -> DescribeOptionGroupOptionsResponse -> ShowS

show :: DescribeOptionGroupOptionsResponse -> String

showList :: [DescribeOptionGroupOptionsResponse] -> ShowS

NFData DescribeOptionGroupOptionsResponse

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

rnf :: DescribeOptionGroupOptionsResponse -> ()

Eq DescribeOptionGroupOptionsResponse

Defined in Amazonka.RDS.DescribeOptionGroupOptions

Methods

(==) :: DescribeOptionGroupOptionsResponse -> DescribeOptionGroupOptionsResponse -> Bool

(/=) :: DescribeOptionGroupOptionsResponse -> DescribeOptionGroupOptionsResponse -> Bool

type Rep DescribeOptionGroupOptionsResponse

Defined in Amazonka.RDS.DescribeOptionGroupOptions

type Rep DescribeOptionGroupOptionsResponse = D1 ('MetaData "DescribeOptionGroupOptionsResponse" "Amazonka.RDS.DescribeOptionGroupOptions" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeOptionGroupOptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "optionGroupOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptionGroupOption])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeOptionGroupOptionsResponse

Arguments

:: Int

$sel:httpStatus:DescribeOptionGroupOptionsResponse'

-> DescribeOptionGroupOptionsResponse

Create a value of DescribeOptionGroupOptionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeOptionGroupOptions, describeOptionGroupOptionsResponse_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.

$sel:optionGroupOptions:DescribeOptionGroupOptionsResponse', describeOptionGroupOptionsResponse_optionGroupOptions - Undocumented member.

$sel:httpStatus:DescribeOptionGroupOptionsResponse', describeOptionGroupOptionsResponse_httpStatus - The response's http status code.

Response Lenses

describeOptionGroupOptionsResponse_marker :: Lens' DescribeOptionGroupOptionsResponse (Maybe Text)

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.

describeOptionGroupOptionsResponse_optionGroupOptions :: Lens' DescribeOptionGroupOptionsResponse (Maybe [OptionGroupOption])

Undocumented member.

describeOptionGroupOptionsResponse_httpStatus :: Lens' DescribeOptionGroupOptionsResponse Int

The response's http status code.