Network.AWS.RDS.DescribeOptionGroups

Describes the available option groups.

This operation returns paginated results.

Creating a Request

describeOptionGroups :: DescribeOptionGroups

Creates a value of DescribeOptionGroups with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dogFilters - This parameter is not currently supported.
• dogEngineName - Filters the list of option groups to only include groups associated with a specific database engine.
• dogMajorEngineVersion - 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.
• dogMarker - 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 .
• dogMaxRecords - 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 the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
• dogOptionGroupName - The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

data DescribeOptionGroups

See: describeOptionGroups smart constructor.

Instances

Eq DescribeOptionGroups

Methods

(==) :: DescribeOptionGroups -> DescribeOptionGroups -> Bool

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

Data DescribeOptionGroups

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeOptionGroups -> c DescribeOptionGroups

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeOptionGroups

toConstr :: DescribeOptionGroups -> Constr

dataTypeOf :: DescribeOptionGroups -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeOptionGroups)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeOptionGroups)

gmapT :: (forall b. Data b => b -> b) -> DescribeOptionGroups -> DescribeOptionGroups

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeOptionGroups -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeOptionGroups -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeOptionGroups -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeOptionGroups -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeOptionGroups -> m DescribeOptionGroups

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeOptionGroups -> m DescribeOptionGroups

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeOptionGroups -> m DescribeOptionGroups

Read DescribeOptionGroups

Methods

readsPrec :: Int -> ReadS DescribeOptionGroups

readList :: ReadS [DescribeOptionGroups]

readPrec :: ReadPrec DescribeOptionGroups

readListPrec :: ReadPrec [DescribeOptionGroups]

Show DescribeOptionGroups

Methods

showsPrec :: Int -> DescribeOptionGroups -> ShowS

show :: DescribeOptionGroups -> String

showList :: [DescribeOptionGroups] -> ShowS

Generic DescribeOptionGroups

Associated Types

type Rep DescribeOptionGroups :: * -> *

Methods

from :: DescribeOptionGroups -> Rep DescribeOptionGroups x

to :: Rep DescribeOptionGroups x -> DescribeOptionGroups

Hashable DescribeOptionGroups

Methods

hashWithSalt :: Int -> DescribeOptionGroups -> Int

hash :: DescribeOptionGroups -> Int

NFData DescribeOptionGroups

Methods

rnf :: DescribeOptionGroups -> ()

AWSPager DescribeOptionGroups

Methods

page :: DescribeOptionGroups -> Rs DescribeOptionGroups -> Maybe DescribeOptionGroups

AWSRequest DescribeOptionGroups

Associated Types

type Rs DescribeOptionGroups :: *

Methods

request :: DescribeOptionGroups -> Request DescribeOptionGroups

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeOptionGroups -> ClientResponse -> m (Response DescribeOptionGroups)

ToHeaders DescribeOptionGroups

Methods

toHeaders :: DescribeOptionGroups -> [Header]

ToPath DescribeOptionGroups

Methods

toPath :: DescribeOptionGroups -> ByteString

ToQuery DescribeOptionGroups

Methods

toQuery :: DescribeOptionGroups -> QueryString

type Rep DescribeOptionGroups

type Rep DescribeOptionGroups = D1 * (MetaData "DescribeOptionGroups" "Network.AWS.RDS.DescribeOptionGroups" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "DescribeOptionGroups'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dogFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Filter]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dogEngineName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dogMajorEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dogMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dogMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_dogOptionGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))))

type Rs DescribeOptionGroups

type Rs DescribeOptionGroups = DescribeOptionGroupsResponse

Request Lenses

dogFilters :: Lens' DescribeOptionGroups [Filter]

This parameter is not currently supported.

dogEngineName :: Lens' DescribeOptionGroups (Maybe Text)

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

dogMajorEngineVersion :: Lens' DescribeOptionGroups (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.

dogMarker :: Lens' DescribeOptionGroups (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 .

dogMaxRecords :: Lens' DescribeOptionGroups (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 the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.

dogOptionGroupName :: Lens' DescribeOptionGroups (Maybe Text)

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

Destructuring the Response

describeOptionGroupsResponse

Arguments

:: Int

dogrsResponseStatus

-> DescribeOptionGroupsResponse

Creates a value of DescribeOptionGroupsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dogrsMarker - 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 .
• dogrsOptionGroupsList - List of option groups.
• dogrsResponseStatus - -- | The response status code.

data DescribeOptionGroupsResponse

List of option groups.

See: describeOptionGroupsResponse smart constructor.

Instances

Eq DescribeOptionGroupsResponse

Methods

(==) :: DescribeOptionGroupsResponse -> DescribeOptionGroupsResponse -> Bool

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

Data DescribeOptionGroupsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeOptionGroupsResponse -> c DescribeOptionGroupsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeOptionGroupsResponse

toConstr :: DescribeOptionGroupsResponse -> Constr

dataTypeOf :: DescribeOptionGroupsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeOptionGroupsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeOptionGroupsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeOptionGroupsResponse -> DescribeOptionGroupsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeOptionGroupsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeOptionGroupsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeOptionGroupsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeOptionGroupsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeOptionGroupsResponse -> m DescribeOptionGroupsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeOptionGroupsResponse -> m DescribeOptionGroupsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeOptionGroupsResponse -> m DescribeOptionGroupsResponse

Read DescribeOptionGroupsResponse

Methods

readsPrec :: Int -> ReadS DescribeOptionGroupsResponse

readList :: ReadS [DescribeOptionGroupsResponse]

readPrec :: ReadPrec DescribeOptionGroupsResponse

readListPrec :: ReadPrec [DescribeOptionGroupsResponse]

Show DescribeOptionGroupsResponse

Methods

showsPrec :: Int -> DescribeOptionGroupsResponse -> ShowS

show :: DescribeOptionGroupsResponse -> String

showList :: [DescribeOptionGroupsResponse] -> ShowS

Generic DescribeOptionGroupsResponse

Associated Types

type Rep DescribeOptionGroupsResponse :: * -> *

Methods

from :: DescribeOptionGroupsResponse -> Rep DescribeOptionGroupsResponse x

to :: Rep DescribeOptionGroupsResponse x -> DescribeOptionGroupsResponse

NFData DescribeOptionGroupsResponse

Methods

rnf :: DescribeOptionGroupsResponse -> ()

type Rep DescribeOptionGroupsResponse

type Rep DescribeOptionGroupsResponse = D1 * (MetaData "DescribeOptionGroupsResponse" "Network.AWS.RDS.DescribeOptionGroups" "amazonka-rds-1.6.0-1gpCa37cwlvAUzWljvprAs" False) (C1 * (MetaCons "DescribeOptionGroupsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dogrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dogrsOptionGroupsList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [OptionGroup]))) (S1 * (MetaSel (Just Symbol "_dogrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dogrsMarker :: Lens' DescribeOptionGroupsResponse (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 .

dogrsOptionGroupsList :: Lens' DescribeOptionGroupsResponse [OptionGroup]

List of option groups.

dogrsResponseStatus :: Lens' DescribeOptionGroupsResponse Int

• - | The response status code.