blib/lib/Paws/Connect/StartOutboundVoiceContact.pm untested

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Connect::StartOutboundVoiceContact;
3 use Moose;
4 has Attributes => (is => 'ro', isa => 'Paws::Connect::Attributes');
5 has ClientToken => (is => 'ro', isa => 'Str');
6 has ContactFlowId => (is => 'ro', isa => 'Str', required => 1);
7 has DestinationPhoneNumber => (is => 'ro', isa => 'Str', required => 1);
8 has InstanceId => (is => 'ro', isa => 'Str', required => 1);
9 has QueueId => (is => 'ro', isa => 'Str');
10 has SourcePhoneNumber => (is => 'ro', isa => 'Str');
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartOutboundVoiceContact');
15 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/contact/outbound-voice');
16 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
17 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Connect::StartOutboundVoiceContactResponse');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::Connect::StartOutboundVoiceContact - Arguments for method StartOutboundVoiceContact on L<Paws::Connect>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method StartOutboundVoiceContact on the
29 L<Amazon Connect Service|Paws::Connect> service. Use the attributes of this class
30 as arguments to method StartOutboundVoiceContact.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartOutboundVoiceContact.
33  
34 =head1 SYNOPSIS
35  
36 my $connect = Paws->service('Connect');
37 my $StartOutboundVoiceContactResponse = $connect->StartOutboundVoiceContact(
38 ContactFlowId => 'MyContactFlowId',
39 DestinationPhoneNumber => 'MyPhoneNumber',
40 InstanceId => 'MyInstanceId',
41 Attributes => {
42 'MyAttributeName' =>
43 'MyAttributeValue', # key: min: 1, max: 32767, value: max: 32767
44 }, # OPTIONAL
45 ClientToken => 'MyClientToken', # OPTIONAL
46 QueueId => 'MyQueueId', # OPTIONAL
47 SourcePhoneNumber => 'MyPhoneNumber', # OPTIONAL
48 );
49  
50 # Results:
51 my $ContactId = $StartOutboundVoiceContactResponse->ContactId;
52  
53 # Returns a L<Paws::Connect::StartOutboundVoiceContactResponse> object.
54  
55 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.
56 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/connect/StartOutboundVoiceContact>
57  
58 =head1 ATTRIBUTES
59  
60  
61 =head2 Attributes => L<Paws::Connect::Attributes>
62  
63 A custom key-value pair using an attribute map. The attributes are
64 standard Amazon Connect attributes, and can be accessed in contact
65 flows just like any other contact attributes.
66  
67 There can be up to 32,768 UTF-8 bytes across all key-value pairs per
68 contact. Attribute keys can include only alphanumeric, dash, and
69 underscore characters.
70  
71  
72  
73 =head2 ClientToken => Str
74  
75 A unique, case-sensitive identifier that you provide to ensure the
76 idempotency of the request. The token is valid for 7 days after
77 creation. If a contact is already started, the contact ID is returned.
78  
79  
80  
81 =head2 B<REQUIRED> ContactFlowId => Str
82  
83 The identifier of the contact flow for the outbound call. To see the
84 ContactFlowId in the Amazon Connect console user interface, on the
85 navigation menu go to B<Routing>, B<Contact Flows>. Choose the contact
86 flow. On the contact flow page, under the name of the contact flow,
87 choose B<Show additional flow information>. The ContactFlowId is the
88 last part of the ARN, shown here in bold:
89  
90 arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/B<846ec553-a005-41c0-8341-xxxxxxxxxxxx>
91  
92  
93  
94 =head2 B<REQUIRED> DestinationPhoneNumber => Str
95  
96 The phone number of the customer, in E.164 format.
97  
98  
99  
100 =head2 B<REQUIRED> InstanceId => Str
101  
102 The identifier of the Amazon Connect instance. You can find the
103 instanceId in the ARN of the instance.
104  
105  
106  
107 =head2 QueueId => Str
108  
109 The queue for the call. If you specify a queue, the phone displayed for
110 caller ID is the phone number specified in the queue. If you do not
111 specify a queue, the queue defined in the contact flow is used. If you
112 do not specify a queue, you must specify a source phone number.
113  
114  
115  
116 =head2 SourcePhoneNumber => Str
117  
118 The phone number associated with the Amazon Connect instance, in E.164
119 format. If you do not specify a source phone number, you must specify a
120 queue.
121  
122  
123  
124  
125 =head1 SEE ALSO
126  
127 This class forms part of L<Paws>, documenting arguments for method StartOutboundVoiceContact in L<Paws::Connect>
128  
129 =head1 BUGS and CONTRIBUTIONS
130  
131 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
132  
133 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
134  
135 =cut
136