Class: Aws::Chime::Types::CreateProxySessionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb

Overview

Note:

When making an API call, you may pass CreateProxySessionRequest data as a hash:

{
  voice_connector_id: "NonEmptyString128", # required
  participant_phone_numbers: ["E164PhoneNumber"], # required
  name: "ProxySessionNameString",
  expiry_minutes: 1,
  capabilities: ["Voice"], # required, accepts Voice, SMS
  number_selection_behavior: "PreferSticky", # accepts PreferSticky, AvoidSticky
  geo_match_level: "Country", # accepts Country, AreaCode
  geo_match_params: {
    country: "Country", # required
    area_code: "AreaCode", # required
  },
}

Constant Summary collapse

SENSITIVE =
[:name]

Instance Attribute Summary collapse

Instance Attribute Details

#capabilitiesArray<String>

The proxy session capabilities.

Returns:

  • (Array<String>)


2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2693

class CreateProxySessionRequest < Struct.new(
  :voice_connector_id,
  :participant_phone_numbers,
  :name,
  :expiry_minutes,
  :capabilities,
  :number_selection_behavior,
  :geo_match_level,
  :geo_match_params)
  SENSITIVE = [:name]
  include Aws::Structure
end

#expiry_minutesInteger

The number of minutes allowed for the proxy session.

Returns:

  • (Integer)


2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2693

class CreateProxySessionRequest < Struct.new(
  :voice_connector_id,
  :participant_phone_numbers,
  :name,
  :expiry_minutes,
  :capabilities,
  :number_selection_behavior,
  :geo_match_level,
  :geo_match_params)
  SENSITIVE = [:name]
  include Aws::Structure
end

#geo_match_levelString

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

Returns:

  • (String)


2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2693

class CreateProxySessionRequest < Struct.new(
  :voice_connector_id,
  :participant_phone_numbers,
  :name,
  :expiry_minutes,
  :capabilities,
  :number_selection_behavior,
  :geo_match_level,
  :geo_match_params)
  SENSITIVE = [:name]
  include Aws::Structure
end

#geo_match_paramsTypes::GeoMatchParams

The country and area code for the proxy phone number.



2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2693

class CreateProxySessionRequest < Struct.new(
  :voice_connector_id,
  :participant_phone_numbers,
  :name,
  :expiry_minutes,
  :capabilities,
  :number_selection_behavior,
  :geo_match_level,
  :geo_match_params)
  SENSITIVE = [:name]
  include Aws::Structure
end

#nameString

The name of the proxy session.

Returns:

  • (String)


2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2693

class CreateProxySessionRequest < Struct.new(
  :voice_connector_id,
  :participant_phone_numbers,
  :name,
  :expiry_minutes,
  :capabilities,
  :number_selection_behavior,
  :geo_match_level,
  :geo_match_params)
  SENSITIVE = [:name]
  include Aws::Structure
end

#number_selection_behaviorString

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

Returns:

  • (String)


2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2693

class CreateProxySessionRequest < Struct.new(
  :voice_connector_id,
  :participant_phone_numbers,
  :name,
  :expiry_minutes,
  :capabilities,
  :number_selection_behavior,
  :geo_match_level,
  :geo_match_params)
  SENSITIVE = [:name]
  include Aws::Structure
end

#participant_phone_numbersArray<String>

The participant phone numbers.

Returns:

  • (Array<String>)


2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2693

class CreateProxySessionRequest < Struct.new(
  :voice_connector_id,
  :participant_phone_numbers,
  :name,
  :expiry_minutes,
  :capabilities,
  :number_selection_behavior,
  :geo_match_level,
  :geo_match_params)
  SENSITIVE = [:name]
  include Aws::Structure
end

#voice_connector_idString

The Amazon Chime voice connector ID.

Returns:

  • (String)


2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2693

class CreateProxySessionRequest < Struct.new(
  :voice_connector_id,
  :participant_phone_numbers,
  :name,
  :expiry_minutes,
  :capabilities,
  :number_selection_behavior,
  :geo_match_level,
  :geo_match_params)
  SENSITIVE = [:name]
  include Aws::Structure
end