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

filter: Statementstmt 0.0% 0 / 21 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 23 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Connect::CreateUser;
3 use Moose;
4 has DirectoryUserId => (is => 'ro', isa => 'Str');
5 has HierarchyGroupId => (is => 'ro', isa => 'Str');
6 has IdentityInfo => (is => 'ro', isa => 'Paws::Connect::UserIdentityInfo');
7 has InstanceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'InstanceId', required => 1);
8 has Password => (is => 'ro', isa => 'Str');
9 has PhoneConfig => (is => 'ro', isa => 'Paws::Connect::UserPhoneConfig', required => 1);
10 has RoutingProfileId => (is => 'ro', isa => 'Str', required => 1);
11 has SecurityProfileIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
12 has Tags => (is => 'ro', isa => 'Paws::Connect::TagMap');
13 has Username => (is => 'ro', isa => 'Str', required => 1);
14  
15 use MooseX::ClassAttribute;
16  
17 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateUser');
18 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/users/{InstanceId}');
19 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
20 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Connect::CreateUserResponse');
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::Connect::CreateUser - Arguments for method CreateUser on L<Paws::Connect>
28  
29 =head1 DESCRIPTION
30  
31 This class represents the parameters used for calling the method CreateUser on the
32 L<Amazon Connect Service|Paws::Connect> service. Use the attributes of this class
33 as arguments to method CreateUser.
34  
35 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateUser.
36  
37 =head1 SYNOPSIS
38  
39 my $connect = Paws->service('Connect');
40 my $CreateUserResponse = $connect->CreateUser(
41 InstanceId => 'MyInstanceId',
42 PhoneConfig => {
43 PhoneType => 'SOFT_PHONE', # values: SOFT_PHONE, DESK_PHONE
44 AfterContactWorkTimeLimit => 1, # OPTIONAL
45 AutoAccept => 1, # OPTIONAL
46 DeskPhoneNumber => 'MyPhoneNumber', # OPTIONAL
47 },
48 RoutingProfileId => 'MyRoutingProfileId',
49 SecurityProfileIds => [ 'MySecurityProfileId', ... ],
50 Username => 'MyAgentUsername',
51 DirectoryUserId => 'MyDirectoryUserId', # OPTIONAL
52 HierarchyGroupId => 'MyHierarchyGroupId', # OPTIONAL
53 IdentityInfo => {
54 Email => 'MyEmail', # OPTIONAL
55 FirstName => 'MyAgentFirstName', # min: 1, max: 100; OPTIONAL
56 LastName => 'MyAgentLastName', # min: 1, max: 100; OPTIONAL
57 }, # OPTIONAL
58 Password => 'MyPassword', # OPTIONAL
59 Tags => {
60 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256
61 }, # OPTIONAL
62 );
63  
64 # Results:
65 my $UserArn = $CreateUserResponse->UserArn;
66 my $UserId = $CreateUserResponse->UserId;
67  
68 # Returns a L<Paws::Connect::CreateUserResponse> object.
69  
70 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.
71 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/connect/CreateUser>
72  
73 =head1 ATTRIBUTES
74  
75  
76 =head2 DirectoryUserId => Str
77  
78 The identifier of the user account in the directory used for identity
79 management. If Amazon Connect cannot access the directory, you can
80 specify this identifier to authenticate users. If you include the
81 identifier, we assume that Amazon Connect cannot access the directory.
82 Otherwise, the identity information is used to authenticate users from
83 your directory.
84  
85 This parameter is required if you are using an existing directory for
86 identity management in Amazon Connect when Amazon Connect cannot access
87 your directory to authenticate users. If you are using SAML for
88 identity management and include this parameter, an error is returned.
89  
90  
91  
92 =head2 HierarchyGroupId => Str
93  
94 The identifier of the hierarchy group for the user.
95  
96  
97  
98 =head2 IdentityInfo => L<Paws::Connect::UserIdentityInfo>
99  
100 The information about the identity of the user.
101  
102  
103  
104 =head2 B<REQUIRED> InstanceId => Str
105  
106 The identifier of the Amazon Connect instance. You can find the
107 instanceId in the ARN of the instance.
108  
109  
110  
111 =head2 Password => Str
112  
113 The password for the user account. A password is required if you are
114 using Amazon Connect for identity management. Otherwise, it is an error
115 to include a password.
116  
117  
118  
119 =head2 B<REQUIRED> PhoneConfig => L<Paws::Connect::UserPhoneConfig>
120  
121 The phone settings for the user.
122  
123  
124  
125 =head2 B<REQUIRED> RoutingProfileId => Str
126  
127 The identifier of the routing profile for the user.
128  
129  
130  
131 =head2 B<REQUIRED> SecurityProfileIds => ArrayRef[Str|Undef]
132  
133 The identifier of the security profile for the user.
134  
135  
136  
137 =head2 Tags => L<Paws::Connect::TagMap>
138  
139 One or more tags.
140  
141  
142  
143 =head2 B<REQUIRED> Username => Str
144  
145 The user name for the account. For instances not using SAML for
146 identity management, the user name can include up to 20 characters. If
147 you are using SAML for identity management, the user name can include
148 up to 64 characters from [a-zA-Z0-9_-.\@]+.
149  
150  
151  
152  
153 =head1 SEE ALSO
154  
155 This class forms part of L<Paws>, documenting arguments for method CreateUser in L<Paws::Connect>
156  
157 =head1 BUGS and CONTRIBUTIONS
158  
159 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
160  
161 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
162  
163 =cut
164