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.Connect.ListRules

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List all rules for the specified Amazon Connect instance.

This operation returns paginated results.

Synopsis

data ListRules = ListRules' {
- eventSourceName :: Maybe EventSourceName
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- publishStatus :: Maybe RulePublishStatus
- instanceId :: Text
}
newListRules :: Text -> ListRules
listRules_eventSourceName :: Lens' ListRules (Maybe EventSourceName)
listRules_maxResults :: Lens' ListRules (Maybe Natural)
listRules_nextToken :: Lens' ListRules (Maybe Text)
listRules_publishStatus :: Lens' ListRules (Maybe RulePublishStatus)
listRules_instanceId :: Lens' ListRules Text
data ListRulesResponse = ListRulesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- ruleSummaryList :: [RuleSummary]
}
newListRulesResponse :: Int -> ListRulesResponse
listRulesResponse_nextToken :: Lens' ListRulesResponse (Maybe Text)
listRulesResponse_httpStatus :: Lens' ListRulesResponse Int
listRulesResponse_ruleSummaryList :: Lens' ListRulesResponse [RuleSummary]

Creating a Request

data ListRules Source #

See: newListRules smart constructor.

Constructors

ListRules'

Fields

eventSourceName :: Maybe EventSourceName
The name of the event source.
maxResults :: Maybe Natural
The maximum number of results to return per page.
nextToken :: Maybe Text
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
publishStatus :: Maybe RulePublishStatus
The publish status of the rule.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

ToHeaders ListRules Source #
Instance details Defined in Amazonka.Connect.ListRules Methods toHeaders :: ListRules -> [Header] #
ToPath ListRules Source #
Instance details Defined in Amazonka.Connect.ListRules Methods toPath :: ListRules -> ByteString #
ToQuery ListRules Source #
Instance details Defined in Amazonka.Connect.ListRules Methods toQuery :: ListRules -> QueryString #
AWSPager ListRules Source #
Instance details Defined in Amazonka.Connect.ListRules Methods page :: ListRules -> AWSResponse ListRules -> Maybe ListRules #
AWSRequest ListRules Source #
Instance details Defined in Amazonka.Connect.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 Source #
Instance details Defined in Amazonka.Connect.ListRules Associated Types type Rep ListRules :: Type -> Type # Methods from :: ListRules -> Rep ListRules x # to :: Rep ListRules x -> ListRules #
Read ListRules Source #
Instance details Defined in Amazonka.Connect.ListRules Methods readsPrec :: Int -> ReadS ListRules # readList :: ReadS [ListRules] # readPrec :: ReadPrec ListRules # readListPrec :: ReadPrec [ListRules] #
Show ListRules Source #
Instance details Defined in Amazonka.Connect.ListRules Methods showsPrec :: Int -> ListRules -> ShowS # show :: ListRules -> String # showList :: [ListRules] -> ShowS #
NFData ListRules Source #
Instance details Defined in Amazonka.Connect.ListRules Methods rnf :: ListRules -> () #
Eq ListRules Source #
Instance details Defined in Amazonka.Connect.ListRules Methods (==) :: ListRules -> ListRules -> Bool # (/=) :: ListRules -> ListRules -> Bool #
Hashable ListRules Source #
Instance details Defined in Amazonka.Connect.ListRules Methods hashWithSalt :: Int -> ListRules -> Int # hash :: ListRules -> Int #
type AWSResponse ListRules Source #
Instance details Defined in Amazonka.Connect.ListRules type AWSResponse ListRules = ListRulesResponse
type Rep ListRules Source #
Instance details Defined in Amazonka.Connect.ListRules type Rep ListRules = D1 ('MetaData "ListRules" "Amazonka.Connect.ListRules" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "ListRules'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eventSourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSourceName)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "publishStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RulePublishStatus)) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListRules Source #

Arguments

:: Text	`ListRules`
-> 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_eventSourceName - The name of the event source.

$sel:maxResults:ListRules', listRules_maxResults - The maximum number of results to return per page.

ListRules, listRules_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

ListRules, listRules_publishStatus - The publish status of the rule.

ListRules, listRules_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Request Lenses

listRules_eventSourceName :: Lens' ListRules (Maybe EventSourceName) Source #

The name of the event source.

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

The maximum number of results to return per page.

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

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

listRules_publishStatus :: Lens' ListRules (Maybe RulePublishStatus) Source #

The publish status of the rule.

listRules_instanceId :: Lens' ListRules Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Destructuring the Response

data ListRulesResponse Source #

See: newListRulesResponse smart constructor.

Constructors

ListRulesResponse'
Fields nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. httpStatus :: Int The response's http status code. ruleSummaryList :: [RuleSummary] Summary information about a rule.

Instances

Instances details

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

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:

ListRules, listRulesResponse_nextToken - If there are additional results, this is the token for the next set of results.

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

$sel:ruleSummaryList:ListRulesResponse', listRulesResponse_ruleSummaryList - Summary information about a rule.

Response Lenses

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

If there are additional results, this is the token for the next set of results.

listRulesResponse_httpStatus :: Lens' ListRulesResponse Int Source #

The response's http status code.

listRulesResponse_ruleSummaryList :: Lens' ListRulesResponse [RuleSummary] Source #

Summary information about a rule.