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.Chime.CreateSipRule

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

Synopsis

data CreateSipRule = CreateSipRule' {
- disabled :: Maybe Bool
- name :: Text
- triggerType :: SipRuleTriggerType
- triggerValue :: Text
- targetApplications :: NonEmpty SipRuleTargetApplication
}
newCreateSipRule :: Text -> SipRuleTriggerType -> Text -> NonEmpty SipRuleTargetApplication -> CreateSipRule
createSipRule_disabled :: Lens' CreateSipRule (Maybe Bool)
createSipRule_name :: Lens' CreateSipRule Text
createSipRule_triggerType :: Lens' CreateSipRule SipRuleTriggerType
createSipRule_triggerValue :: Lens' CreateSipRule Text
createSipRule_targetApplications :: Lens' CreateSipRule (NonEmpty SipRuleTargetApplication)
data CreateSipRuleResponse = CreateSipRuleResponse' {
- sipRule :: Maybe SipRule
- httpStatus :: Int
}
newCreateSipRuleResponse :: Int -> CreateSipRuleResponse
createSipRuleResponse_sipRule :: Lens' CreateSipRuleResponse (Maybe SipRule)
createSipRuleResponse_httpStatus :: Lens' CreateSipRuleResponse Int

Creating a Request

data CreateSipRule Source #

See: newCreateSipRule smart constructor.

Constructors

CreateSipRule'

Fields

disabled :: Maybe Bool
Enables or disables a rule. You must disable rules before you can delete them.
name :: Text
The name of the SIP rule.
triggerType :: SipRuleTriggerType
The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
triggerValue :: Text
If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.
targetApplications :: NonEmpty SipRuleTargetApplication
List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.

Instances

Instances details

ToJSON CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule Methods toJSON :: CreateSipRule -> Value # toEncoding :: CreateSipRule -> Encoding # toJSONList :: [CreateSipRule] -> Value # toEncodingList :: [CreateSipRule] -> Encoding #
ToHeaders CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule Methods toHeaders :: CreateSipRule -> [Header] #
ToPath CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule Methods toPath :: CreateSipRule -> ByteString #
ToQuery CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule Methods toQuery :: CreateSipRule -> QueryString #
AWSRequest CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule Associated Types type AWSResponse CreateSipRule # Methods request :: (Service -> Service) -> CreateSipRule -> Request CreateSipRule # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSipRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSipRule))) #
Generic CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule Associated Types type Rep CreateSipRule :: Type -> Type # Methods from :: CreateSipRule -> Rep CreateSipRule x # to :: Rep CreateSipRule x -> CreateSipRule #
Read CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule Methods readsPrec :: Int -> ReadS CreateSipRule # readList :: ReadS [CreateSipRule] # readPrec :: ReadPrec CreateSipRule # readListPrec :: ReadPrec [CreateSipRule] #
Show CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule Methods showsPrec :: Int -> CreateSipRule -> ShowS # show :: CreateSipRule -> String # showList :: [CreateSipRule] -> ShowS #
NFData CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule Methods rnf :: CreateSipRule -> () #
Eq CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule Methods (==) :: CreateSipRule -> CreateSipRule -> Bool # (/=) :: CreateSipRule -> CreateSipRule -> Bool #
Hashable CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule Methods hashWithSalt :: Int -> CreateSipRule -> Int # hash :: CreateSipRule -> Int #
type AWSResponse CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule type AWSResponse CreateSipRule = CreateSipRuleResponse
type Rep CreateSipRule Source #
Instance details Defined in Amazonka.Chime.CreateSipRule type Rep CreateSipRule = D1 ('MetaData "CreateSipRule" "Amazonka.Chime.CreateSipRule" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "CreateSipRule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "disabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "triggerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SipRuleTriggerType) :: (S1 ('MetaSel ('Just "triggerValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "targetApplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty SipRuleTargetApplication))))))

newCreateSipRule Source #

Arguments

:: Text	`CreateSipRule`
-> SipRuleTriggerType	`CreateSipRule`
-> Text	`CreateSipRule`
-> NonEmpty SipRuleTargetApplication	`CreateSipRule`
-> CreateSipRule

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

CreateSipRule, createSipRule_disabled - Enables or disables a rule. You must disable rules before you can delete them.

CreateSipRule, createSipRule_name - The name of the SIP rule.

CreateSipRule, createSipRule_triggerType - The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

CreateSipRule, createSipRule_triggerValue - If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

CreateSipRule, createSipRule_targetApplications - List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.

Request Lenses

createSipRule_disabled :: Lens' CreateSipRule (Maybe Bool) Source #

Enables or disables a rule. You must disable rules before you can delete them.

createSipRule_name :: Lens' CreateSipRule Text Source #

The name of the SIP rule.

createSipRule_triggerType :: Lens' CreateSipRule SipRuleTriggerType Source #

The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

createSipRule_triggerValue :: Lens' CreateSipRule Text Source #

If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

createSipRule_targetApplications :: Lens' CreateSipRule (NonEmpty SipRuleTargetApplication) Source #

List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.

Destructuring the Response

data CreateSipRuleResponse Source #

See: newCreateSipRuleResponse smart constructor.

Constructors

CreateSipRuleResponse'
Fields sipRule :: Maybe SipRule Returns the SIP rule information, including the rule ID, triggers, and target applications. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateSipRuleResponse Source #

Arguments

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

Create a value of CreateSipRuleResponse 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:sipRule:CreateSipRuleResponse', createSipRuleResponse_sipRule - Returns the SIP rule information, including the rule ID, triggers, and target applications.

$sel:httpStatus:CreateSipRuleResponse', createSipRuleResponse_httpStatus - The response's http status code.

Response Lenses

createSipRuleResponse_sipRule :: Lens' CreateSipRuleResponse (Maybe SipRule) Source #

Returns the SIP rule information, including the rule ID, triggers, and target applications.

createSipRuleResponse_httpStatus :: Lens' CreateSipRuleResponse Int Source #

The response's http status code.