Amazonka.Config.DescribeConfigRules

Returns details about your Config rules.

This operation returns paginated results.

Creating a Request

data DescribeConfigRules

See: newDescribeConfigRules smart constructor.

Constructors

DescribeConfigRules'

Fields

• configRuleNames :: Maybe [Text]

  The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.

• filters :: Maybe DescribeConfigRulesFilters

  Returns a list of Detecive or Proactive Config rules. By default, this API returns an unfiltered list.

• nextToken :: Maybe Text

  The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Instances

ToJSON DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

Methods

toJSON :: DescribeConfigRules -> Value

toEncoding :: DescribeConfigRules -> Encoding

toJSONList :: [DescribeConfigRules] -> Value

toEncodingList :: [DescribeConfigRules] -> Encoding

ToHeaders DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

Methods

toHeaders :: DescribeConfigRules -> [Header]

ToPath DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

Methods

toPath :: DescribeConfigRules -> ByteString

ToQuery DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

Methods

toQuery :: DescribeConfigRules -> QueryString

AWSPager DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

Methods

page :: DescribeConfigRules -> AWSResponse DescribeConfigRules -> Maybe DescribeConfigRules

AWSRequest DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

Associated Types

type AWSResponse DescribeConfigRules

Methods

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

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

Generic DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

Associated Types

type Rep DescribeConfigRules :: Type -> Type

Methods

from :: DescribeConfigRules -> Rep DescribeConfigRules x

to :: Rep DescribeConfigRules x -> DescribeConfigRules

Read DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

Methods

readsPrec :: Int -> ReadS DescribeConfigRules

readList :: ReadS [DescribeConfigRules]

readPrec :: ReadPrec DescribeConfigRules

readListPrec :: ReadPrec [DescribeConfigRules]

Show DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

Methods

showsPrec :: Int -> DescribeConfigRules -> ShowS

show :: DescribeConfigRules -> String

showList :: [DescribeConfigRules] -> ShowS

NFData DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

Methods

rnf :: DescribeConfigRules -> ()

Eq DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

Methods

(==) :: DescribeConfigRules -> DescribeConfigRules -> Bool

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

Hashable DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

Methods

hashWithSalt :: Int -> DescribeConfigRules -> Int

hash :: DescribeConfigRules -> Int

type AWSResponse DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

type AWSResponse DescribeConfigRules = DescribeConfigRulesResponse

type Rep DescribeConfigRules

Defined in Amazonka.Config.DescribeConfigRules

type Rep DescribeConfigRules = D1 ('MetaData "DescribeConfigRules" "Amazonka.Config.DescribeConfigRules" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "DescribeConfigRules'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configRuleNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DescribeConfigRulesFilters)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeConfigRules :: DescribeConfigRules

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

DescribeConfigRules, describeConfigRules_configRuleNames - The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.

$sel:filters:DescribeConfigRules', describeConfigRules_filters - Returns a list of Detecive or Proactive Config rules. By default, this API returns an unfiltered list.

DescribeConfigRules, describeConfigRules_nextToken - The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Request Lenses

describeConfigRules_configRuleNames :: Lens' DescribeConfigRules (Maybe [Text])

The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.

describeConfigRules_filters :: Lens' DescribeConfigRules (Maybe DescribeConfigRulesFilters)

Returns a list of Detecive or Proactive Config rules. By default, this API returns an unfiltered list.

describeConfigRules_nextToken :: Lens' DescribeConfigRules (Maybe Text)

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Destructuring the Response

data DescribeConfigRulesResponse

See: newDescribeConfigRulesResponse smart constructor.

Constructors

DescribeConfigRulesResponse'

Fields

• configRules :: Maybe [ConfigRule]

  The details about your Config rules.

• nextToken :: Maybe Text

  The string that you use in a subsequent request to get the next page of results in a paginated response.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeConfigRulesResponse

Defined in Amazonka.Config.DescribeConfigRules

Associated Types

type Rep DescribeConfigRulesResponse :: Type -> Type

Methods

from :: DescribeConfigRulesResponse -> Rep DescribeConfigRulesResponse x

to :: Rep DescribeConfigRulesResponse x -> DescribeConfigRulesResponse

Read DescribeConfigRulesResponse

Defined in Amazonka.Config.DescribeConfigRules

Methods

readsPrec :: Int -> ReadS DescribeConfigRulesResponse

readList :: ReadS [DescribeConfigRulesResponse]

readPrec :: ReadPrec DescribeConfigRulesResponse

readListPrec :: ReadPrec [DescribeConfigRulesResponse]

Show DescribeConfigRulesResponse

Defined in Amazonka.Config.DescribeConfigRules

Methods

showsPrec :: Int -> DescribeConfigRulesResponse -> ShowS

show :: DescribeConfigRulesResponse -> String

showList :: [DescribeConfigRulesResponse] -> ShowS

NFData DescribeConfigRulesResponse

Defined in Amazonka.Config.DescribeConfigRules

Methods

rnf :: DescribeConfigRulesResponse -> ()

Eq DescribeConfigRulesResponse

Defined in Amazonka.Config.DescribeConfigRules

Methods

(==) :: DescribeConfigRulesResponse -> DescribeConfigRulesResponse -> Bool

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

type Rep DescribeConfigRulesResponse

Defined in Amazonka.Config.DescribeConfigRules

type Rep DescribeConfigRulesResponse = D1 ('MetaData "DescribeConfigRulesResponse" "Amazonka.Config.DescribeConfigRules" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "DescribeConfigRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConfigRule])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeConfigRulesResponse

Arguments

:: Int

$sel:httpStatus:DescribeConfigRulesResponse'

-> DescribeConfigRulesResponse

Create a value of DescribeConfigRulesResponse 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:configRules:DescribeConfigRulesResponse', describeConfigRulesResponse_configRules - The details about your Config rules.

DescribeConfigRules, describeConfigRulesResponse_nextToken - The string that you use in a subsequent request to get the next page of results in a paginated response.

$sel:httpStatus:DescribeConfigRulesResponse', describeConfigRulesResponse_httpStatus - The response's http status code.

Response Lenses

describeConfigRulesResponse_configRules :: Lens' DescribeConfigRulesResponse (Maybe [ConfigRule])

The details about your Config rules.

describeConfigRulesResponse_nextToken :: Lens' DescribeConfigRulesResponse (Maybe Text)

The string that you use in a subsequent request to get the next page of results in a paginated response.

describeConfigRulesResponse_httpStatus :: Lens' DescribeConfigRulesResponse Int

The response's http status code.