Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudWatchEvents.ListRules

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.

ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

This operation returns paginated results.

Synopsis

data ListRules = ListRules' {
- nextToken :: Maybe Text
- eventBusName :: Maybe Text
- namePrefix :: Maybe Text
- limit :: Maybe Natural
}
newListRules :: ListRules
listRules_nextToken :: Lens' ListRules (Maybe Text)
listRules_eventBusName :: Lens' ListRules (Maybe Text)
listRules_namePrefix :: Lens' ListRules (Maybe Text)
listRules_limit :: Lens' ListRules (Maybe Natural)
data ListRulesResponse = ListRulesResponse' {
- rules :: Maybe [Rule]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListRulesResponse :: Int -> ListRulesResponse
listRulesResponse_rules :: Lens' ListRulesResponse (Maybe [Rule])
listRulesResponse_nextToken :: Lens' ListRulesResponse (Maybe Text)
listRulesResponse_httpStatus :: Lens' ListRulesResponse Int

Creating a Request

data ListRules Source #

See: newListRules smart constructor.

Constructors

ListRules'
Fields nextToken :: Maybe Text The token returned by a previous call to retrieve the next set of results. eventBusName :: Maybe Text The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used. namePrefix :: Maybe Text The prefix matching the rule name. limit :: Maybe Natural The maximum number of results to return.

Instances

Instances details

Eq ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods (==) :: ListRules -> ListRules -> Bool # (/=) :: ListRules -> ListRules -> Bool #
Read ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods readsPrec :: Int -> ReadS ListRules # readList :: ReadS [ListRules] # readPrec :: ReadPrec ListRules # readListPrec :: ReadPrec [ListRules] #
Show ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods showsPrec :: Int -> ListRules -> ShowS # show :: ListRules -> String # showList :: [ListRules] -> ShowS #
Generic ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Associated Types type Rep ListRules :: Type -> Type # Methods from :: ListRules -> Rep ListRules x # to :: Rep ListRules x -> ListRules #
NFData ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods rnf :: ListRules -> () #
Hashable ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods hashWithSalt :: Int -> ListRules -> Int # hash :: ListRules -> Int #
ToJSON ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods toJSON :: ListRules -> Value # toEncoding :: ListRules -> Encoding # toJSONList :: [ListRules] -> Value # toEncodingList :: [ListRules] -> Encoding #
AWSPager ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods page :: ListRules -> AWSResponse ListRules -> Maybe ListRules #
AWSRequest ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Associated Types type AWSResponse ListRules # Methods request :: ListRules -> Request ListRules # response :: MonadResource m => Logger -> Service -> Proxy ListRules -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRules))) #
ToHeaders ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods toHeaders :: ListRules -> [Header] #
ToPath ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods toPath :: ListRules -> ByteString #
ToQuery ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods toQuery :: ListRules -> QueryString #
type Rep ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules type Rep ListRules = D1 ('MetaData "ListRules" "Amazonka.CloudWatchEvents.ListRules" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "ListRules'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "eventBusName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "namePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListRules Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules type AWSResponse ListRules = ListRulesResponse

newListRules :: ListRules Source #

Create a value of ListRules 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:nextToken:ListRules', listRules_nextToken - The token returned by a previous call to retrieve the next set of results.

$sel:eventBusName:ListRules', listRules_eventBusName - The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.

$sel:namePrefix:ListRules', listRules_namePrefix - The prefix matching the rule name.

$sel:limit:ListRules', listRules_limit - The maximum number of results to return.

Request Lenses

listRules_nextToken :: Lens' ListRules (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

listRules_eventBusName :: Lens' ListRules (Maybe Text) Source #

The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.

listRules_namePrefix :: Lens' ListRules (Maybe Text) Source #

The prefix matching the rule name.

listRules_limit :: Lens' ListRules (Maybe Natural) Source #

The maximum number of results to return.

Destructuring the Response

data ListRulesResponse Source #

See: newListRulesResponse smart constructor.

Constructors

ListRulesResponse'
Fields rules :: Maybe [Rule] The rules that match the specified criteria. nextToken :: Maybe Text Indicates whether there are additional results to retrieve. If there are no more results, the value is null. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListRulesResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods (==) :: ListRulesResponse -> ListRulesResponse -> Bool # (/=) :: ListRulesResponse -> ListRulesResponse -> Bool #
Read ListRulesResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods readsPrec :: Int -> ReadS ListRulesResponse # readList :: ReadS [ListRulesResponse] # readPrec :: ReadPrec ListRulesResponse # readListPrec :: ReadPrec [ListRulesResponse] #
Show ListRulesResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods showsPrec :: Int -> ListRulesResponse -> ShowS # show :: ListRulesResponse -> String # showList :: [ListRulesResponse] -> ShowS #
Generic ListRulesResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Associated Types type Rep ListRulesResponse :: Type -> Type # Methods from :: ListRulesResponse -> Rep ListRulesResponse x # to :: Rep ListRulesResponse x -> ListRulesResponse #
NFData ListRulesResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules Methods rnf :: ListRulesResponse -> () #
type Rep ListRulesResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListRules type Rep ListRulesResponse = D1 ('MetaData "ListRulesResponse" "Amazonka.CloudWatchEvents.ListRules" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "ListRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Rule])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRulesResponse Source #

Arguments

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

Create a value of ListRulesResponse 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:rules:ListRulesResponse', listRulesResponse_rules - The rules that match the specified criteria.

$sel:nextToken:ListRules', listRulesResponse_nextToken - Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

$sel:httpStatus:ListRulesResponse', listRulesResponse_httpStatus - The response's http status code.

Response Lenses

listRulesResponse_rules :: Lens' ListRulesResponse (Maybe [Rule]) Source #

The rules that match the specified criteria.

listRulesResponse_nextToken :: Lens' ListRulesResponse (Maybe Text) Source #

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

listRulesResponse_httpStatus :: Lens' ListRulesResponse Int Source #

The response's http status code.