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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a rule for the specified Amazon Connect instance.

Synopsis

data DescribeRule = DescribeRule' {
- instanceId :: Text
- ruleId :: Text
}
newDescribeRule :: Text -> Text -> DescribeRule
describeRule_instanceId :: Lens' DescribeRule Text
describeRule_ruleId :: Lens' DescribeRule Text
data DescribeRuleResponse = DescribeRuleResponse' {
- httpStatus :: Int
- rule :: Rule
}
newDescribeRuleResponse :: Int -> Rule -> DescribeRuleResponse
describeRuleResponse_httpStatus :: Lens' DescribeRuleResponse Int
describeRuleResponse_rule :: Lens' DescribeRuleResponse Rule

Creating a Request

data DescribeRule Source #

See: newDescribeRule smart constructor.

Constructors

DescribeRule'
Fields instanceId :: Text The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. ruleId :: Text A unique identifier for the rule.

Instances

Instances details

ToHeaders DescribeRule Source #
Instance details Defined in Amazonka.Connect.DescribeRule Methods toHeaders :: DescribeRule -> [Header] #
ToPath DescribeRule Source #
Instance details Defined in Amazonka.Connect.DescribeRule Methods toPath :: DescribeRule -> ByteString #
ToQuery DescribeRule Source #
Instance details Defined in Amazonka.Connect.DescribeRule Methods toQuery :: DescribeRule -> QueryString #
AWSRequest DescribeRule Source #
Instance details Defined in Amazonka.Connect.DescribeRule Associated Types type AWSResponse DescribeRule # Methods request :: (Service -> Service) -> DescribeRule -> Request DescribeRule # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRule))) #
Generic DescribeRule Source #
Instance details Defined in Amazonka.Connect.DescribeRule Associated Types type Rep DescribeRule :: Type -> Type # Methods from :: DescribeRule -> Rep DescribeRule x # to :: Rep DescribeRule x -> DescribeRule #
Read DescribeRule Source #
Instance details Defined in Amazonka.Connect.DescribeRule Methods readsPrec :: Int -> ReadS DescribeRule # readList :: ReadS [DescribeRule] # readPrec :: ReadPrec DescribeRule # readListPrec :: ReadPrec [DescribeRule] #
Show DescribeRule Source #
Instance details Defined in Amazonka.Connect.DescribeRule Methods showsPrec :: Int -> DescribeRule -> ShowS # show :: DescribeRule -> String # showList :: [DescribeRule] -> ShowS #
NFData DescribeRule Source #
Instance details Defined in Amazonka.Connect.DescribeRule Methods rnf :: DescribeRule -> () #
Eq DescribeRule Source #
Instance details Defined in Amazonka.Connect.DescribeRule Methods (==) :: DescribeRule -> DescribeRule -> Bool # (/=) :: DescribeRule -> DescribeRule -> Bool #
Hashable DescribeRule Source #
Instance details Defined in Amazonka.Connect.DescribeRule Methods hashWithSalt :: Int -> DescribeRule -> Int # hash :: DescribeRule -> Int #
type AWSResponse DescribeRule Source #
Instance details Defined in Amazonka.Connect.DescribeRule type AWSResponse DescribeRule = DescribeRuleResponse
type Rep DescribeRule Source #
Instance details Defined in Amazonka.Connect.DescribeRule type Rep DescribeRule = D1 ('MetaData "DescribeRule" "Amazonka.Connect.DescribeRule" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "DescribeRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeRule Source #

Arguments

:: Text	`DescribeRule`
-> Text	`DescribeRule`
-> DescribeRule

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

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

DescribeRule, describeRule_ruleId - A unique identifier for the rule.

Request Lenses

describeRule_instanceId :: Lens' DescribeRule Text Source #

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

describeRule_ruleId :: Lens' DescribeRule Text Source #

A unique identifier for the rule.

Destructuring the Response

data DescribeRuleResponse Source #

See: newDescribeRuleResponse smart constructor.

Constructors

DescribeRuleResponse'
Fields httpStatus :: Int The response's http status code. rule :: Rule Information about the rule.

Instances

Instances details

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

newDescribeRuleResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeRuleResponse'`
-> Rule	`$sel:rule:DescribeRuleResponse'`
-> DescribeRuleResponse

Create a value of DescribeRuleResponse 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:httpStatus:DescribeRuleResponse', describeRuleResponse_httpStatus - The response's http status code.

$sel:rule:DescribeRuleResponse', describeRuleResponse_rule - Information about the rule.

Response Lenses

describeRuleResponse_httpStatus :: Lens' DescribeRuleResponse Int Source #

The response's http status code.

describeRuleResponse_rule :: Lens' DescribeRuleResponse Rule Source #

Information about the rule.