« blib/lib/Paws/Chime/CreatePhoneNumberOrderResponse.pm
↑ Summary
blib/lib/Paws/Chime/CreateProxySessionResponse.pm »
| 1 | |||
| 2 | package Paws::Chime::CreateProxySession; | ||
| 3 | use Moose; | ||
| 4 | has Capabilities => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 5 | has ExpiryMinutes => (is => 'ro', isa => 'Int'); | ||
| 6 | has GeoMatchLevel => (is => 'ro', isa => 'Str'); | ||
| 7 | has GeoMatchParams => (is => 'ro', isa => 'Paws::Chime::GeoMatchParams'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str'); | ||
| 9 | has NumberSelectionBehavior => (is => 'ro', isa => 'Str'); | ||
| 10 | has ParticipantPhoneNumbers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 11 | has VoiceConnectorId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'voiceConnectorId', required => 1); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateProxySession'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/voice-connectors/{voiceConnectorId}/proxy-sessions'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Chime::CreateProxySessionResponse'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Chime::CreateProxySession - Arguments for method CreateProxySession on L<Paws::Chime> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateProxySession on the | ||
| 30 | L<Amazon Chime|Paws::Chime> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateProxySession. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateProxySession. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $chime = Paws->service('Chime'); | ||
| 38 | my $CreateProxySessionResponse = $chime->CreateProxySession( | ||
| 39 | Capabilities => [ | ||
| 40 | 'Voice', ... # values: Voice, SMS | ||
| 41 | ], | ||
| 42 | ParticipantPhoneNumbers => [ 'MyE164PhoneNumber', ... ], | ||
| 43 | VoiceConnectorId => 'MyNonEmptyString128', | ||
| 44 | ExpiryMinutes => 1, # OPTIONAL | ||
| 45 | GeoMatchLevel => 'Country', # OPTIONAL | ||
| 46 | GeoMatchParams => { | ||
| 47 | AreaCode => 'MyAreaCode', | ||
| 48 | Country => 'MyCountry', | ||
| 49 | |||
| 50 | }, # OPTIONAL | ||
| 51 | Name => 'MyProxySessionNameString', # OPTIONAL | ||
| 52 | NumberSelectionBehavior => 'PreferSticky', # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $ProxySession = $CreateProxySessionResponse->ProxySession; | ||
| 57 | |||
| 58 | # Returns a L<Paws::Chime::CreateProxySessionResponse> object. | ||
| 59 | |||
| 60 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 61 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/chime/CreateProxySession> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> Capabilities => ArrayRef[Str|Undef] | ||
| 67 | |||
| 68 | The proxy session capabilities. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 ExpiryMinutes => Int | ||
| 73 | |||
| 74 | The number of minutes allowed for the proxy session. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 GeoMatchLevel => Str | ||
| 79 | |||
| 80 | The preference for matching the country or area code of the proxy phone | ||
| 81 | number with that of the first participant. | ||
| 82 | |||
| 83 | Valid values are: C<"Country">, C<"AreaCode"> | ||
| 84 | |||
| 85 | =head2 GeoMatchParams => L<Paws::Chime::GeoMatchParams> | ||
| 86 | |||
| 87 | The country and area code for the proxy phone number. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 Name => Str | ||
| 92 | |||
| 93 | The name of the proxy session. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 NumberSelectionBehavior => Str | ||
| 98 | |||
| 99 | The preference for proxy phone number reuse, or stickiness, between the | ||
| 100 | same participants across sessions. | ||
| 101 | |||
| 102 | Valid values are: C<"PreferSticky">, C<"AvoidSticky"> | ||
| 103 | |||
| 104 | =head2 B<REQUIRED> ParticipantPhoneNumbers => ArrayRef[Str|Undef] | ||
| 105 | |||
| 106 | The participant phone numbers. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> VoiceConnectorId => Str | ||
| 111 | |||
| 112 | The Amazon Chime voice connector ID. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head1 SEE ALSO | ||
| 118 | |||
| 119 | This class forms part of L<Paws>, documenting arguments for method CreateProxySession in L<Paws::Chime> | ||
| 120 | |||
| 121 | =head1 BUGS and CONTRIBUTIONS | ||
| 122 | |||
| 123 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 124 | |||
| 125 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 126 | |||
| 127 | =cut | ||
| 128 |