Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Chime.CreateProxySession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

Synopsis

data CreateProxySession = CreateProxySession' {
- numberSelectionBehavior :: Maybe NumberSelectionBehavior
- geoMatchParams :: Maybe GeoMatchParams
- expiryMinutes :: Maybe Natural
- name :: Maybe (Sensitive Text)
- geoMatchLevel :: Maybe GeoMatchLevel
- participantPhoneNumbers :: NonEmpty (Sensitive Text)
- capabilities :: [Capability]
- voiceConnectorId :: Text
}
newCreateProxySession :: NonEmpty Text -> Text -> CreateProxySession
createProxySession_numberSelectionBehavior :: Lens' CreateProxySession (Maybe NumberSelectionBehavior)
createProxySession_geoMatchParams :: Lens' CreateProxySession (Maybe GeoMatchParams)
createProxySession_expiryMinutes :: Lens' CreateProxySession (Maybe Natural)
createProxySession_name :: Lens' CreateProxySession (Maybe Text)
createProxySession_geoMatchLevel :: Lens' CreateProxySession (Maybe GeoMatchLevel)
createProxySession_participantPhoneNumbers :: Lens' CreateProxySession (NonEmpty Text)
createProxySession_capabilities :: Lens' CreateProxySession [Capability]
createProxySession_voiceConnectorId :: Lens' CreateProxySession Text
data CreateProxySessionResponse = CreateProxySessionResponse' {
- proxySession :: Maybe ProxySession
- httpStatus :: Int
}
newCreateProxySessionResponse :: Int -> CreateProxySessionResponse
createProxySessionResponse_proxySession :: Lens' CreateProxySessionResponse (Maybe ProxySession)
createProxySessionResponse_httpStatus :: Lens' CreateProxySessionResponse Int

Creating a Request

data CreateProxySession Source #

See: newCreateProxySession smart constructor.

Constructors

CreateProxySession'

Fields

numberSelectionBehavior :: Maybe NumberSelectionBehavior
The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
geoMatchParams :: Maybe GeoMatchParams
The country and area code for the proxy phone number.
expiryMinutes :: Maybe Natural
The number of minutes allowed for the proxy session.
name :: Maybe (Sensitive Text)
The name of the proxy session.
geoMatchLevel :: Maybe GeoMatchLevel
The preference for matching the country or area code of the proxy phone number with that of the first participant.
participantPhoneNumbers :: NonEmpty (Sensitive Text)
The participant phone numbers.
capabilities :: [Capability]
The proxy session capabilities.
voiceConnectorId :: Text
The Amazon Chime voice connector ID.

Instances

Instances details

Eq CreateProxySession Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Methods (==) :: CreateProxySession -> CreateProxySession -> Bool # (/=) :: CreateProxySession -> CreateProxySession -> Bool #
Show CreateProxySession Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Methods showsPrec :: Int -> CreateProxySession -> ShowS # show :: CreateProxySession -> String # showList :: [CreateProxySession] -> ShowS #
Generic CreateProxySession Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Associated Types type Rep CreateProxySession :: Type -> Type # Methods from :: CreateProxySession -> Rep CreateProxySession x # to :: Rep CreateProxySession x -> CreateProxySession #
NFData CreateProxySession Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Methods rnf :: CreateProxySession -> () #
Hashable CreateProxySession Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Methods hashWithSalt :: Int -> CreateProxySession -> Int # hash :: CreateProxySession -> Int #
ToJSON CreateProxySession Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Methods toJSON :: CreateProxySession -> Value # toEncoding :: CreateProxySession -> Encoding # toJSONList :: [CreateProxySession] -> Value # toEncodingList :: [CreateProxySession] -> Encoding #
AWSRequest CreateProxySession Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Associated Types type AWSResponse CreateProxySession # Methods request :: CreateProxySession -> Request CreateProxySession # response :: MonadResource m => Logger -> Service -> Proxy CreateProxySession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateProxySession))) #
ToHeaders CreateProxySession Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Methods toHeaders :: CreateProxySession -> [Header] #
ToPath CreateProxySession Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Methods toPath :: CreateProxySession -> ByteString #
ToQuery CreateProxySession Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Methods toQuery :: CreateProxySession -> QueryString #
type Rep CreateProxySession Source #
Instance details Defined in Amazonka.Chime.CreateProxySession type Rep CreateProxySession = D1 ('MetaData "CreateProxySession" "Amazonka.Chime.CreateProxySession" "libZSservicesZSamazonka-chimeZSamazonka-chime" 'False) (C1 ('MetaCons "CreateProxySession'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "numberSelectionBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NumberSelectionBehavior)) :: S1 ('MetaSel ('Just "geoMatchParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GeoMatchParams))) :: (S1 ('MetaSel ('Just "expiryMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :: ((S1 ('MetaSel ('Just "geoMatchLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GeoMatchLevel)) :: S1 ('MetaSel ('Just "participantPhoneNumbers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty (Sensitive Text)))) :: (S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Capability]) :*: S1 ('MetaSel ('Just "voiceConnectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateProxySession Source #
Instance details Defined in Amazonka.Chime.CreateProxySession type AWSResponse CreateProxySession = CreateProxySessionResponse

newCreateProxySession Source #

Arguments

:: NonEmpty Text	`$sel:participantPhoneNumbers:CreateProxySession'`
-> Text	`$sel:voiceConnectorId:CreateProxySession'`
-> CreateProxySession

Create a value of CreateProxySession 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:numberSelectionBehavior:CreateProxySession', createProxySession_numberSelectionBehavior - The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

$sel:geoMatchParams:CreateProxySession', createProxySession_geoMatchParams - The country and area code for the proxy phone number.

$sel:expiryMinutes:CreateProxySession', createProxySession_expiryMinutes - The number of minutes allowed for the proxy session.

$sel:name:CreateProxySession', createProxySession_name - The name of the proxy session.

$sel:geoMatchLevel:CreateProxySession', createProxySession_geoMatchLevel - The preference for matching the country or area code of the proxy phone number with that of the first participant.

$sel:participantPhoneNumbers:CreateProxySession', createProxySession_participantPhoneNumbers - The participant phone numbers.

$sel:capabilities:CreateProxySession', createProxySession_capabilities - The proxy session capabilities.

$sel:voiceConnectorId:CreateProxySession', createProxySession_voiceConnectorId - The Amazon Chime voice connector ID.

Request Lenses

createProxySession_numberSelectionBehavior :: Lens' CreateProxySession (Maybe NumberSelectionBehavior) Source #

The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

createProxySession_geoMatchParams :: Lens' CreateProxySession (Maybe GeoMatchParams) Source #

The country and area code for the proxy phone number.

createProxySession_expiryMinutes :: Lens' CreateProxySession (Maybe Natural) Source #

The number of minutes allowed for the proxy session.

createProxySession_name :: Lens' CreateProxySession (Maybe Text) Source #

The name of the proxy session.

createProxySession_geoMatchLevel :: Lens' CreateProxySession (Maybe GeoMatchLevel) Source #

The preference for matching the country or area code of the proxy phone number with that of the first participant.

createProxySession_participantPhoneNumbers :: Lens' CreateProxySession (NonEmpty Text) Source #

The participant phone numbers.

createProxySession_capabilities :: Lens' CreateProxySession [Capability] Source #

The proxy session capabilities.

createProxySession_voiceConnectorId :: Lens' CreateProxySession Text Source #

The Amazon Chime voice connector ID.

Destructuring the Response

data CreateProxySessionResponse Source #

See: newCreateProxySessionResponse smart constructor.

Constructors

CreateProxySessionResponse'
Fields proxySession :: Maybe ProxySession The proxy session details. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateProxySessionResponse Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Methods (==) :: CreateProxySessionResponse -> CreateProxySessionResponse -> Bool # (/=) :: CreateProxySessionResponse -> CreateProxySessionResponse -> Bool #
Show CreateProxySessionResponse Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Methods showsPrec :: Int -> CreateProxySessionResponse -> ShowS # show :: CreateProxySessionResponse -> String # showList :: [CreateProxySessionResponse] -> ShowS #
Generic CreateProxySessionResponse Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Associated Types type Rep CreateProxySessionResponse :: Type -> Type # Methods from :: CreateProxySessionResponse -> Rep CreateProxySessionResponse x # to :: Rep CreateProxySessionResponse x -> CreateProxySessionResponse #
NFData CreateProxySessionResponse Source #
Instance details Defined in Amazonka.Chime.CreateProxySession Methods rnf :: CreateProxySessionResponse -> () #
type Rep CreateProxySessionResponse Source #
Instance details Defined in Amazonka.Chime.CreateProxySession type Rep CreateProxySessionResponse = D1 ('MetaData "CreateProxySessionResponse" "Amazonka.Chime.CreateProxySession" "libZSservicesZSamazonka-chimeZSamazonka-chime" 'False) (C1 ('MetaCons "CreateProxySessionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "proxySession") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProxySession)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateProxySessionResponse Source #

Arguments

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

Create a value of CreateProxySessionResponse 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:proxySession:CreateProxySessionResponse', createProxySessionResponse_proxySession - The proxy session details.

$sel:httpStatus:CreateProxySessionResponse', createProxySessionResponse_httpStatus - The response's http status code.

Response Lenses

createProxySessionResponse_proxySession :: Lens' CreateProxySessionResponse (Maybe ProxySession) Source #

The proxy session details.

createProxySessionResponse_httpStatus :: Lens' CreateProxySessionResponse Int Source #

The response's http status code.