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.Types.SipRule

Description

Synopsis

Documentation

data SipRule Source #

The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

See: newSipRule smart constructor.

Constructors

SipRule'

Fields

createdTimestamp :: Maybe ISO8601
The time at which the SIP rule was created, in ISO 8601 format.
disabled :: Maybe Bool
Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
name :: Maybe Text
The name of the SIP rule.
sipRuleId :: Maybe Text
The SIP rule ID.
targetApplications :: Maybe (NonEmpty SipRuleTargetApplication)
Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
triggerType :: Maybe SipRuleTriggerType
The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
triggerValue :: Maybe Text
If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.
updatedTimestamp :: Maybe ISO8601
The time at which the SIP rule was last updated, in ISO 8601 format.

Instances

Instances details

FromJSON SipRule Source #
Instance details Defined in Amazonka.Chime.Types.SipRule Methods parseJSON :: Value -> Parser SipRule # parseJSONList :: Value -> Parser [SipRule] #
Generic SipRule Source #
Instance details Defined in Amazonka.Chime.Types.SipRule Associated Types type Rep SipRule :: Type -> Type # Methods from :: SipRule -> Rep SipRule x # to :: Rep SipRule x -> SipRule #
Read SipRule Source #
Instance details Defined in Amazonka.Chime.Types.SipRule Methods readsPrec :: Int -> ReadS SipRule # readList :: ReadS [SipRule] # readPrec :: ReadPrec SipRule # readListPrec :: ReadPrec [SipRule] #
Show SipRule Source #
Instance details Defined in Amazonka.Chime.Types.SipRule Methods showsPrec :: Int -> SipRule -> ShowS # show :: SipRule -> String # showList :: [SipRule] -> ShowS #
NFData SipRule Source #
Instance details Defined in Amazonka.Chime.Types.SipRule Methods rnf :: SipRule -> () #
Eq SipRule Source #
Instance details Defined in Amazonka.Chime.Types.SipRule Methods (==) :: SipRule -> SipRule -> Bool # (/=) :: SipRule -> SipRule -> Bool #
Hashable SipRule Source #
Instance details Defined in Amazonka.Chime.Types.SipRule Methods hashWithSalt :: Int -> SipRule -> Int # hash :: SipRule -> Int #
type Rep SipRule Source #
Instance details Defined in Amazonka.Chime.Types.SipRule type Rep SipRule = D1 ('MetaData "SipRule" "Amazonka.Chime.Types.SipRule" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "SipRule'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "disabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sipRuleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "targetApplications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SipRuleTargetApplication))) :: S1 ('MetaSel ('Just "triggerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SipRuleTriggerType))) :: (S1 ('MetaSel ('Just "triggerValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "updatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))))

newSipRule :: SipRule Source #

Create a value of SipRule 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:createdTimestamp:SipRule', sipRule_createdTimestamp - The time at which the SIP rule was created, in ISO 8601 format.

$sel:disabled:SipRule', sipRule_disabled - Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

$sel:name:SipRule', sipRule_name - The name of the SIP rule.

$sel:sipRuleId:SipRule', sipRule_sipRuleId - The SIP rule ID.

$sel:targetApplications:SipRule', sipRule_targetApplications - Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

$sel:triggerType:SipRule', sipRule_triggerType - The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

$sel:triggerValue:SipRule', sipRule_triggerValue - If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

$sel:updatedTimestamp:SipRule', sipRule_updatedTimestamp - The time at which the SIP rule was last updated, in ISO 8601 format.

sipRule_createdTimestamp :: Lens' SipRule (Maybe UTCTime) Source #

The time at which the SIP rule was created, in ISO 8601 format.

sipRule_disabled :: Lens' SipRule (Maybe Bool) Source #

Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

sipRule_name :: Lens' SipRule (Maybe Text) Source #

The name of the SIP rule.

sipRule_sipRuleId :: Lens' SipRule (Maybe Text) Source #

The SIP rule ID.

sipRule_targetApplications :: Lens' SipRule (Maybe (NonEmpty SipRuleTargetApplication)) Source #

Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

sipRule_triggerType :: Lens' SipRule (Maybe SipRuleTriggerType) Source #

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

sipRule_triggerValue :: Lens' SipRule (Maybe Text) Source #

If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

sipRule_updatedTimestamp :: Lens' SipRule (Maybe UTCTime) Source #

The time at which the SIP rule was last updated, in ISO 8601 format.