Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.DescribeOptionGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the available option groups.

This operation returns paginated results.

Synopsis

data DescribeOptionGroups = DescribeOptionGroups' {
- engineName :: Maybe Text
- filters :: Maybe [Filter]
- majorEngineVersion :: Maybe Text
- marker :: Maybe Text
- maxRecords :: Maybe Int
- optionGroupName :: Maybe Text
}
newDescribeOptionGroups :: DescribeOptionGroups
describeOptionGroups_engineName :: Lens' DescribeOptionGroups (Maybe Text)
describeOptionGroups_filters :: Lens' DescribeOptionGroups (Maybe [Filter])
describeOptionGroups_majorEngineVersion :: Lens' DescribeOptionGroups (Maybe Text)
describeOptionGroups_marker :: Lens' DescribeOptionGroups (Maybe Text)
describeOptionGroups_maxRecords :: Lens' DescribeOptionGroups (Maybe Int)
describeOptionGroups_optionGroupName :: Lens' DescribeOptionGroups (Maybe Text)
data DescribeOptionGroupsResponse = DescribeOptionGroupsResponse' {
- marker :: Maybe Text
- optionGroupsList :: Maybe [OptionGroup]
- httpStatus :: Int
}
newDescribeOptionGroupsResponse :: Int -> DescribeOptionGroupsResponse
describeOptionGroupsResponse_marker :: Lens' DescribeOptionGroupsResponse (Maybe Text)
describeOptionGroupsResponse_optionGroupsList :: Lens' DescribeOptionGroupsResponse (Maybe [OptionGroup])
describeOptionGroupsResponse_httpStatus :: Lens' DescribeOptionGroupsResponse Int

Creating a Request

data DescribeOptionGroups Source #

See: newDescribeOptionGroups smart constructor.

Constructors

DescribeOptionGroups'

Fields

engineName :: Maybe Text
Filters the list of option groups to only include groups associated with a specific database engine.
Valid Values:
- ```
mariadb
```
- ```
mysql
```
- ```
oracle-ee
```
- ```
oracle-ee-cdb
```
- ```
oracle-se2
```
- ```
oracle-se2-cdb
```
- ```
postgres
```
- ```
sqlserver-ee
```
- ```
sqlserver-se
```
- ```
sqlserver-ex
```
- ```
sqlserver-web
```
filters :: Maybe [Filter]
This parameter isn't currently supported.
majorEngineVersion :: Maybe Text
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.
marker :: Maybe Text
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.
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.
optionGroupName :: Maybe Text
The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Instances

Instances details

ToHeaders DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods toHeaders :: DescribeOptionGroups -> [Header] #
ToPath DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods toPath :: DescribeOptionGroups -> ByteString #
ToQuery DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods toQuery :: DescribeOptionGroups -> QueryString #
AWSPager DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods page :: DescribeOptionGroups -> AWSResponse DescribeOptionGroups -> Maybe DescribeOptionGroups #
AWSRequest DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Associated Types type AWSResponse DescribeOptionGroups # Methods request :: (Service -> Service) -> DescribeOptionGroups -> Request DescribeOptionGroups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeOptionGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeOptionGroups))) #
Generic DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Associated Types type Rep DescribeOptionGroups :: Type -> Type # Methods from :: DescribeOptionGroups -> Rep DescribeOptionGroups x # to :: Rep DescribeOptionGroups x -> DescribeOptionGroups #
Read DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods readsPrec :: Int -> ReadS DescribeOptionGroups # readList :: ReadS [DescribeOptionGroups] # readPrec :: ReadPrec DescribeOptionGroups # readListPrec :: ReadPrec [DescribeOptionGroups] #
Show DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods showsPrec :: Int -> DescribeOptionGroups -> ShowS # show :: DescribeOptionGroups -> String # showList :: [DescribeOptionGroups] -> ShowS #
NFData DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods rnf :: DescribeOptionGroups -> () #
Eq DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods (==) :: DescribeOptionGroups -> DescribeOptionGroups -> Bool # (/=) :: DescribeOptionGroups -> DescribeOptionGroups -> Bool #
Hashable DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods hashWithSalt :: Int -> DescribeOptionGroups -> Int # hash :: DescribeOptionGroups -> Int #
type AWSResponse DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups type AWSResponse DescribeOptionGroups = DescribeOptionGroupsResponse
type Rep DescribeOptionGroups Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups type Rep DescribeOptionGroups = D1 ('MetaData "DescribeOptionGroups" "Amazonka.RDS.DescribeOptionGroups" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeOptionGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "engineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (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 "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeOptionGroups :: DescribeOptionGroups Source #

Create a value of DescribeOptionGroups 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:

DescribeOptionGroups, describeOptionGroups_engineName - Filters the list of option groups to only include groups associated with a specific database engine.

Valid Values:

```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

$sel:filters:DescribeOptionGroups', describeOptionGroups_filters - This parameter isn't currently supported.

DescribeOptionGroups, describeOptionGroups_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.

DescribeOptionGroups, describeOptionGroups_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.

$sel:maxRecords:DescribeOptionGroups', describeOptionGroups_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.

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

Request Lenses

describeOptionGroups_engineName :: Lens' DescribeOptionGroups (Maybe Text) Source #

Filters the list of option groups to only include groups associated with a specific database engine.

Valid Values:

```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

describeOptionGroups_filters :: Lens' DescribeOptionGroups (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeOptionGroups_majorEngineVersion :: Lens' DescribeOptionGroups (Maybe Text) Source #

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.

describeOptionGroups_marker :: Lens' DescribeOptionGroups (Maybe Text) Source #

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.

describeOptionGroups_maxRecords :: Lens' DescribeOptionGroups (Maybe Int) Source #

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.

describeOptionGroups_optionGroupName :: Lens' DescribeOptionGroups (Maybe Text) Source #

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

Destructuring the Response

data DescribeOptionGroupsResponse Source #

List of option groups.

See: newDescribeOptionGroupsResponse smart constructor.

Constructors

DescribeOptionGroupsResponse'
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`. optionGroupsList :: Maybe [OptionGroup] List of option groups. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeOptionGroupsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Associated Types type Rep DescribeOptionGroupsResponse :: Type -> Type # Methods from :: DescribeOptionGroupsResponse -> Rep DescribeOptionGroupsResponse x # to :: Rep DescribeOptionGroupsResponse x -> DescribeOptionGroupsResponse #
Read DescribeOptionGroupsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods readsPrec :: Int -> ReadS DescribeOptionGroupsResponse # readList :: ReadS [DescribeOptionGroupsResponse] # readPrec :: ReadPrec DescribeOptionGroupsResponse # readListPrec :: ReadPrec [DescribeOptionGroupsResponse] #
Show DescribeOptionGroupsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods showsPrec :: Int -> DescribeOptionGroupsResponse -> ShowS # show :: DescribeOptionGroupsResponse -> String # showList :: [DescribeOptionGroupsResponse] -> ShowS #
NFData DescribeOptionGroupsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods rnf :: DescribeOptionGroupsResponse -> () #
Eq DescribeOptionGroupsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups Methods (==) :: DescribeOptionGroupsResponse -> DescribeOptionGroupsResponse -> Bool # (/=) :: DescribeOptionGroupsResponse -> DescribeOptionGroupsResponse -> Bool #
type Rep DescribeOptionGroupsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeOptionGroups type Rep DescribeOptionGroupsResponse = D1 ('MetaData "DescribeOptionGroupsResponse" "Amazonka.RDS.DescribeOptionGroups" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeOptionGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "optionGroupsList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptionGroup])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeOptionGroupsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeOptionGroupsResponse'`
-> DescribeOptionGroupsResponse

Create a value of DescribeOptionGroupsResponse 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:

DescribeOptionGroups, describeOptionGroupsResponse_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:optionGroupsList:DescribeOptionGroupsResponse', describeOptionGroupsResponse_optionGroupsList - List of option groups.

$sel:httpStatus:DescribeOptionGroupsResponse', describeOptionGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeOptionGroupsResponse_marker :: Lens' DescribeOptionGroupsResponse (Maybe Text) Source #

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.

describeOptionGroupsResponse_optionGroupsList :: Lens' DescribeOptionGroupsResponse (Maybe [OptionGroup]) Source #

List of option groups.

describeOptionGroupsResponse_httpStatus :: Lens' DescribeOptionGroupsResponse Int Source #

The response's http status code.