Amazonka.CloudWatchEvents.ListRules

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.

Creating a Request

data ListRules

See: newListRules smart constructor.

Constructors

ListRules'

Fields

• 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.

• limit :: Maybe Natural

  The maximum number of results to return.

• namePrefix :: Maybe Text

  The prefix matching the rule name.

• nextToken :: Maybe Text

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

Instances

ToJSON ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

toJSON :: ListRules -> Value

toEncoding :: ListRules -> Encoding

toJSONList :: [ListRules] -> Value

toEncodingList :: [ListRules] -> Encoding

ToHeaders ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

toHeaders :: ListRules -> [Header]

ToPath ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

toPath :: ListRules -> ByteString

ToQuery ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

toQuery :: ListRules -> QueryString

AWSPager ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

page :: ListRules -> AWSResponse ListRules -> Maybe ListRules

AWSRequest ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

Associated Types

type AWSResponse ListRules

Methods

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

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

Generic ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

Associated Types

type Rep ListRules :: Type -> Type

Methods

from :: ListRules -> Rep ListRules x

to :: Rep ListRules x -> ListRules

Read ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

readsPrec :: Int -> ReadS ListRules

readList :: ReadS [ListRules]

readPrec :: ReadPrec ListRules

readListPrec :: ReadPrec [ListRules]

Show ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

showsPrec :: Int -> ListRules -> ShowS

show :: ListRules -> String

showList :: [ListRules] -> ShowS

NFData ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

rnf :: ListRules -> ()

Eq ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

(==) :: ListRules -> ListRules -> Bool

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

Hashable ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

hashWithSalt :: Int -> ListRules -> Int

hash :: ListRules -> Int

type AWSResponse ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

type AWSResponse ListRules = ListRulesResponse

type Rep ListRules

Defined in Amazonka.CloudWatchEvents.ListRules

type Rep ListRules = D1 ('MetaData "ListRules" "Amazonka.CloudWatchEvents.ListRules" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "ListRules'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eventBusName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "namePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListRules :: ListRules

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:

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:limit:ListRules', listRules_limit - The maximum number of results to return.

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

ListRules, listRules_nextToken - The token returned by a previous call to retrieve the next set of results.

Request Lenses

listRules_eventBusName :: Lens' ListRules (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.

listRules_limit :: Lens' ListRules (Maybe Natural)

The maximum number of results to return.

listRules_namePrefix :: Lens' ListRules (Maybe Text)

The prefix matching the rule name.

listRules_nextToken :: Lens' ListRules (Maybe Text)

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

Destructuring the Response

data ListRulesResponse

See: newListRulesResponse smart constructor.

Constructors

ListRulesResponse'

Fields

• nextToken :: Maybe Text

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

• rules :: Maybe [Rule]

  The rules that match the specified criteria.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListRulesResponse

Defined in Amazonka.CloudWatchEvents.ListRules

Associated Types

type Rep ListRulesResponse :: Type -> Type

Methods

from :: ListRulesResponse -> Rep ListRulesResponse x

to :: Rep ListRulesResponse x -> ListRulesResponse

Read ListRulesResponse

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

readsPrec :: Int -> ReadS ListRulesResponse

readList :: ReadS [ListRulesResponse]

readPrec :: ReadPrec ListRulesResponse

readListPrec :: ReadPrec [ListRulesResponse]

Show ListRulesResponse

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

showsPrec :: Int -> ListRulesResponse -> ShowS

show :: ListRulesResponse -> String

showList :: [ListRulesResponse] -> ShowS

NFData ListRulesResponse

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

rnf :: ListRulesResponse -> ()

Eq ListRulesResponse

Defined in Amazonka.CloudWatchEvents.ListRules

Methods

(==) :: ListRulesResponse -> ListRulesResponse -> Bool

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

type Rep ListRulesResponse

Defined in Amazonka.CloudWatchEvents.ListRules

type Rep ListRulesResponse = D1 ('MetaData "ListRulesResponse" "Amazonka.CloudWatchEvents.ListRules" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "ListRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Rule])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRulesResponse

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:

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

$sel:rules:ListRulesResponse', listRulesResponse_rules - The rules that match the specified criteria.

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

Response Lenses

listRulesResponse_nextToken :: Lens' ListRulesResponse (Maybe Text)

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

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

The rules that match the specified criteria.

listRulesResponse_httpStatus :: Lens' ListRulesResponse Int

The response's http status code.