| 1 | package Paws::CustomerProfiles; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'profile' } | ||
| 4 | sub signing_name { 'profile' } | ||
| 5 | sub version { '2020-08-15' } | ||
| 6 | sub flattened_arrays { 0 } | ||
| 7 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 8 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 9 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 10 | }); | ||
| 11 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 12 | ] }); | ||
| 13 | |||
| 14 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller'; | ||
| 15 | |||
| 16 | |||
| 17 | sub AddProfileKey { | ||
| 18 | my $self = shift; | ||
| 19 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::AddProfileKey', @_); | ||
| 20 | return $self->caller->do_call($self, $call_object); | ||
| 21 | } | ||
| 22 | sub CreateDomain { | ||
| 23 | my $self = shift; | ||
| 24 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::CreateDomain', @_); | ||
| 25 | return $self->caller->do_call($self, $call_object); | ||
| 26 | } | ||
| 27 | sub CreateProfile { | ||
| 28 | my $self = shift; | ||
| 29 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::CreateProfile', @_); | ||
| 30 | return $self->caller->do_call($self, $call_object); | ||
| 31 | } | ||
| 32 | sub DeleteDomain { | ||
| 33 | my $self = shift; | ||
| 34 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::DeleteDomain', @_); | ||
| 35 | return $self->caller->do_call($self, $call_object); | ||
| 36 | } | ||
| 37 | sub DeleteIntegration { | ||
| 38 | my $self = shift; | ||
| 39 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::DeleteIntegration', @_); | ||
| 40 | return $self->caller->do_call($self, $call_object); | ||
| 41 | } | ||
| 42 | sub DeleteProfile { | ||
| 43 | my $self = shift; | ||
| 44 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::DeleteProfile', @_); | ||
| 45 | return $self->caller->do_call($self, $call_object); | ||
| 46 | } | ||
| 47 | sub DeleteProfileKey { | ||
| 48 | my $self = shift; | ||
| 49 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::DeleteProfileKey', @_); | ||
| 50 | return $self->caller->do_call($self, $call_object); | ||
| 51 | } | ||
| 52 | sub DeleteProfileObject { | ||
| 53 | my $self = shift; | ||
| 54 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::DeleteProfileObject', @_); | ||
| 55 | return $self->caller->do_call($self, $call_object); | ||
| 56 | } | ||
| 57 | sub DeleteProfileObjectType { | ||
| 58 | my $self = shift; | ||
| 59 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::DeleteProfileObjectType', @_); | ||
| 60 | return $self->caller->do_call($self, $call_object); | ||
| 61 | } | ||
| 62 | sub GetDomain { | ||
| 63 | my $self = shift; | ||
| 64 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::GetDomain', @_); | ||
| 65 | return $self->caller->do_call($self, $call_object); | ||
| 66 | } | ||
| 67 | sub GetIntegration { | ||
| 68 | my $self = shift; | ||
| 69 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::GetIntegration', @_); | ||
| 70 | return $self->caller->do_call($self, $call_object); | ||
| 71 | } | ||
| 72 | sub GetMatches { | ||
| 73 | my $self = shift; | ||
| 74 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::GetMatches', @_); | ||
| 75 | return $self->caller->do_call($self, $call_object); | ||
| 76 | } | ||
| 77 | sub GetProfileObjectType { | ||
| 78 | my $self = shift; | ||
| 79 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::GetProfileObjectType', @_); | ||
| 80 | return $self->caller->do_call($self, $call_object); | ||
| 81 | } | ||
| 82 | sub GetProfileObjectTypeTemplate { | ||
| 83 | my $self = shift; | ||
| 84 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::GetProfileObjectTypeTemplate', @_); | ||
| 85 | return $self->caller->do_call($self, $call_object); | ||
| 86 | } | ||
| 87 | sub ListAccountIntegrations { | ||
| 88 | my $self = shift; | ||
| 89 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::ListAccountIntegrations', @_); | ||
| 90 | return $self->caller->do_call($self, $call_object); | ||
| 91 | } | ||
| 92 | sub ListDomains { | ||
| 93 | my $self = shift; | ||
| 94 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::ListDomains', @_); | ||
| 95 | return $self->caller->do_call($self, $call_object); | ||
| 96 | } | ||
| 97 | sub ListIntegrations { | ||
| 98 | my $self = shift; | ||
| 99 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::ListIntegrations', @_); | ||
| 100 | return $self->caller->do_call($self, $call_object); | ||
| 101 | } | ||
| 102 | sub ListProfileObjects { | ||
| 103 | my $self = shift; | ||
| 104 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::ListProfileObjects', @_); | ||
| 105 | return $self->caller->do_call($self, $call_object); | ||
| 106 | } | ||
| 107 | sub ListProfileObjectTypes { | ||
| 108 | my $self = shift; | ||
| 109 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::ListProfileObjectTypes', @_); | ||
| 110 | return $self->caller->do_call($self, $call_object); | ||
| 111 | } | ||
| 112 | sub ListProfileObjectTypeTemplates { | ||
| 113 | my $self = shift; | ||
| 114 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::ListProfileObjectTypeTemplates', @_); | ||
| 115 | return $self->caller->do_call($self, $call_object); | ||
| 116 | } | ||
| 117 | sub ListTagsForResource { | ||
| 118 | my $self = shift; | ||
| 119 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::ListTagsForResource', @_); | ||
| 120 | return $self->caller->do_call($self, $call_object); | ||
| 121 | } | ||
| 122 | sub MergeProfiles { | ||
| 123 | my $self = shift; | ||
| 124 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::MergeProfiles', @_); | ||
| 125 | return $self->caller->do_call($self, $call_object); | ||
| 126 | } | ||
| 127 | sub PutIntegration { | ||
| 128 | my $self = shift; | ||
| 129 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::PutIntegration', @_); | ||
| 130 | return $self->caller->do_call($self, $call_object); | ||
| 131 | } | ||
| 132 | sub PutProfileObject { | ||
| 133 | my $self = shift; | ||
| 134 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::PutProfileObject', @_); | ||
| 135 | return $self->caller->do_call($self, $call_object); | ||
| 136 | } | ||
| 137 | sub PutProfileObjectType { | ||
| 138 | my $self = shift; | ||
| 139 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::PutProfileObjectType', @_); | ||
| 140 | return $self->caller->do_call($self, $call_object); | ||
| 141 | } | ||
| 142 | sub SearchProfiles { | ||
| 143 | my $self = shift; | ||
| 144 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::SearchProfiles', @_); | ||
| 145 | return $self->caller->do_call($self, $call_object); | ||
| 146 | } | ||
| 147 | sub TagResource { | ||
| 148 | my $self = shift; | ||
| 149 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::TagResource', @_); | ||
| 150 | return $self->caller->do_call($self, $call_object); | ||
| 151 | } | ||
| 152 | sub UntagResource { | ||
| 153 | my $self = shift; | ||
| 154 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::UntagResource', @_); | ||
| 155 | return $self->caller->do_call($self, $call_object); | ||
| 156 | } | ||
| 157 | sub UpdateDomain { | ||
| 158 | my $self = shift; | ||
| 159 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::UpdateDomain', @_); | ||
| 160 | return $self->caller->do_call($self, $call_object); | ||
| 161 | } | ||
| 162 | sub UpdateProfile { | ||
| 163 | my $self = shift; | ||
| 164 | my $call_object = $self->new_with_coercions('Paws::CustomerProfiles::UpdateProfile', @_); | ||
| 165 | return $self->caller->do_call($self, $call_object); | ||
| 166 | } | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | sub operations { qw/AddProfileKey CreateDomain CreateProfile DeleteDomain DeleteIntegration DeleteProfile DeleteProfileKey DeleteProfileObject DeleteProfileObjectType GetDomain GetIntegration GetMatches GetProfileObjectType GetProfileObjectTypeTemplate ListAccountIntegrations ListDomains ListIntegrations ListProfileObjects ListProfileObjectTypes ListProfileObjectTypeTemplates ListTagsForResource MergeProfiles PutIntegration PutProfileObject PutProfileObjectType SearchProfiles TagResource UntagResource UpdateDomain UpdateProfile / } | ||
| 171 | |||
| 172 | 1; | ||
| 173 | |||
| 174 | ### main pod documentation begin ### | ||
| 175 | |||
| 176 | =head1 NAME | ||
| 177 | |||
| 178 | Paws::CustomerProfiles - Perl Interface to AWS Amazon Connect Customer Profiles | ||
| 179 | |||
| 180 | =head1 SYNOPSIS | ||
| 181 | |||
| 182 | use Paws; | ||
| 183 | |||
| 184 | my $obj = Paws->service('CustomerProfiles'); | ||
| 185 | my $res = $obj->Method( | ||
| 186 | Arg1 => $val1, | ||
| 187 | Arg2 => [ 'V1', 'V2' ], | ||
| 188 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 189 | # of the arguments type | ||
| 190 | Arg3 => { Att1 => 'Val1' }, | ||
| 191 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 192 | # the constructor of the arguments type | ||
| 193 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 194 | ); | ||
| 195 | |||
| 196 | =head1 DESCRIPTION | ||
| 197 | |||
| 198 | Amazon Connect Customer Profiles | ||
| 199 | |||
| 200 | Welcome to the Amazon Connect Customer Profiles API Reference. This | ||
| 201 | guide provides information about the Amazon Connect Customer Profiles | ||
| 202 | API, including supported operations, data types, parameters, and | ||
| 203 | schemas. | ||
| 204 | |||
| 205 | Amazon Connect Customer Profiles is a unified customer profile for your | ||
| 206 | contact center that has pre-built connectors powered by AppFlow that | ||
| 207 | make it easy to combine customer information from third party | ||
| 208 | applications, such as Salesforce (CRM), ServiceNow (ITSM), and your | ||
| 209 | enterprise resource planning (ERP), with contact history from your | ||
| 210 | Amazon Connect contact center. | ||
| 211 | |||
| 212 | If you're new to Amazon Connect , you might find it helpful to also | ||
| 213 | review the Amazon Connect Administrator Guide | ||
| 214 | (https://docs.aws.amazon.com/connect/latest/adminguide/what-is-amazon-connect.html). | ||
| 215 | |||
| 216 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/profile-2020-08-15> | ||
| 217 | |||
| 218 | |||
| 219 | =head1 METHODS | ||
| 220 | |||
| 221 | =head2 AddProfileKey | ||
| 222 | |||
| 223 | =over | ||
| 224 | |||
| 225 | =item DomainName => Str | ||
| 226 | |||
| 227 | =item KeyName => Str | ||
| 228 | |||
| 229 | =item ProfileId => Str | ||
| 230 | |||
| 231 | =item Values => ArrayRef[Str|Undef] | ||
| 232 | |||
| 233 | |||
| 234 | =back | ||
| 235 | |||
| 236 | Each argument is described in detail in: L<Paws::CustomerProfiles::AddProfileKey> | ||
| 237 | |||
| 238 | Returns: a L<Paws::CustomerProfiles::AddProfileKeyResponse> instance | ||
| 239 | |||
| 240 | Associates a new key value with a specific profile, such as a Contact | ||
| 241 | Trace Record (CTR) ContactId. | ||
| 242 | |||
| 243 | A profile object can have a single unique key and any number of | ||
| 244 | additional keys that can be used to identify the profile that it | ||
| 245 | belongs to. | ||
| 246 | |||
| 247 | |||
| 248 | =head2 CreateDomain | ||
| 249 | |||
| 250 | =over | ||
| 251 | |||
| 252 | =item DefaultExpirationDays => Int | ||
| 253 | |||
| 254 | =item DomainName => Str | ||
| 255 | |||
| 256 | =item [DeadLetterQueueUrl => Str] | ||
| 257 | |||
| 258 | =item [DefaultEncryptionKey => Str] | ||
| 259 | |||
| 260 | =item [Matching => L<Paws::CustomerProfiles::MatchingRequest>] | ||
| 261 | |||
| 262 | =item [Tags => L<Paws::CustomerProfiles::TagMap>] | ||
| 263 | |||
| 264 | |||
| 265 | =back | ||
| 266 | |||
| 267 | Each argument is described in detail in: L<Paws::CustomerProfiles::CreateDomain> | ||
| 268 | |||
| 269 | Returns: a L<Paws::CustomerProfiles::CreateDomainResponse> instance | ||
| 270 | |||
| 271 | Creates a domain, which is a container for all customer data, such as | ||
| 272 | customer profile attributes, object types, profile keys, and encryption | ||
| 273 | keys. You can create multiple domains, and each domain can have | ||
| 274 | multiple third-party integrations. | ||
| 275 | |||
| 276 | Each Amazon Connect instance can be associated with only one domain. | ||
| 277 | Multiple Amazon Connect instances can be associated with one domain. | ||
| 278 | |||
| 279 | |||
| 280 | =head2 CreateProfile | ||
| 281 | |||
| 282 | =over | ||
| 283 | |||
| 284 | =item DomainName => Str | ||
| 285 | |||
| 286 | =item [AccountNumber => Str] | ||
| 287 | |||
| 288 | =item [AdditionalInformation => Str] | ||
| 289 | |||
| 290 | =item [Address => L<Paws::CustomerProfiles::Address>] | ||
| 291 | |||
| 292 | =item [Attributes => L<Paws::CustomerProfiles::Attributes>] | ||
| 293 | |||
| 294 | =item [BillingAddress => L<Paws::CustomerProfiles::Address>] | ||
| 295 | |||
| 296 | =item [BirthDate => Str] | ||
| 297 | |||
| 298 | =item [BusinessEmailAddress => Str] | ||
| 299 | |||
| 300 | =item [BusinessName => Str] | ||
| 301 | |||
| 302 | =item [BusinessPhoneNumber => Str] | ||
| 303 | |||
| 304 | =item [EmailAddress => Str] | ||
| 305 | |||
| 306 | =item [FirstName => Str] | ||
| 307 | |||
| 308 | =item [Gender => Str] | ||
| 309 | |||
| 310 | =item [HomePhoneNumber => Str] | ||
| 311 | |||
| 312 | =item [LastName => Str] | ||
| 313 | |||
| 314 | =item [MailingAddress => L<Paws::CustomerProfiles::Address>] | ||
| 315 | |||
| 316 | =item [MiddleName => Str] | ||
| 317 | |||
| 318 | =item [MobilePhoneNumber => Str] | ||
| 319 | |||
| 320 | =item [PartyType => Str] | ||
| 321 | |||
| 322 | =item [PersonalEmailAddress => Str] | ||
| 323 | |||
| 324 | =item [PhoneNumber => Str] | ||
| 325 | |||
| 326 | =item [ShippingAddress => L<Paws::CustomerProfiles::Address>] | ||
| 327 | |||
| 328 | |||
| 329 | =back | ||
| 330 | |||
| 331 | Each argument is described in detail in: L<Paws::CustomerProfiles::CreateProfile> | ||
| 332 | |||
| 333 | Returns: a L<Paws::CustomerProfiles::CreateProfileResponse> instance | ||
| 334 | |||
| 335 | Creates a standard profile. | ||
| 336 | |||
| 337 | A standard profile represents the following attributes for a customer | ||
| 338 | profile in a domain. | ||
| 339 | |||
| 340 | |||
| 341 | =head2 DeleteDomain | ||
| 342 | |||
| 343 | =over | ||
| 344 | |||
| 345 | =item DomainName => Str | ||
| 346 | |||
| 347 | |||
| 348 | =back | ||
| 349 | |||
| 350 | Each argument is described in detail in: L<Paws::CustomerProfiles::DeleteDomain> | ||
| 351 | |||
| 352 | Returns: a L<Paws::CustomerProfiles::DeleteDomainResponse> instance | ||
| 353 | |||
| 354 | Deletes a specific domain and all of its customer data, such as | ||
| 355 | customer profile attributes and their related objects. | ||
| 356 | |||
| 357 | |||
| 358 | =head2 DeleteIntegration | ||
| 359 | |||
| 360 | =over | ||
| 361 | |||
| 362 | =item DomainName => Str | ||
| 363 | |||
| 364 | =item Uri => Str | ||
| 365 | |||
| 366 | |||
| 367 | =back | ||
| 368 | |||
| 369 | Each argument is described in detail in: L<Paws::CustomerProfiles::DeleteIntegration> | ||
| 370 | |||
| 371 | Returns: a L<Paws::CustomerProfiles::DeleteIntegrationResponse> instance | ||
| 372 | |||
| 373 | Removes an integration from a specific domain. | ||
| 374 | |||
| 375 | |||
| 376 | =head2 DeleteProfile | ||
| 377 | |||
| 378 | =over | ||
| 379 | |||
| 380 | =item DomainName => Str | ||
| 381 | |||
| 382 | =item ProfileId => Str | ||
| 383 | |||
| 384 | |||
| 385 | =back | ||
| 386 | |||
| 387 | Each argument is described in detail in: L<Paws::CustomerProfiles::DeleteProfile> | ||
| 388 | |||
| 389 | Returns: a L<Paws::CustomerProfiles::DeleteProfileResponse> instance | ||
| 390 | |||
| 391 | Deletes the standard customer profile and all data pertaining to the | ||
| 392 | profile. | ||
| 393 | |||
| 394 | |||
| 395 | =head2 DeleteProfileKey | ||
| 396 | |||
| 397 | =over | ||
| 398 | |||
| 399 | =item DomainName => Str | ||
| 400 | |||
| 401 | =item KeyName => Str | ||
| 402 | |||
| 403 | =item ProfileId => Str | ||
| 404 | |||
| 405 | =item Values => ArrayRef[Str|Undef] | ||
| 406 | |||
| 407 | |||
| 408 | =back | ||
| 409 | |||
| 410 | Each argument is described in detail in: L<Paws::CustomerProfiles::DeleteProfileKey> | ||
| 411 | |||
| 412 | Returns: a L<Paws::CustomerProfiles::DeleteProfileKeyResponse> instance | ||
| 413 | |||
| 414 | Removes a searchable key from a customer profile. | ||
| 415 | |||
| 416 | |||
| 417 | =head2 DeleteProfileObject | ||
| 418 | |||
| 419 | =over | ||
| 420 | |||
| 421 | =item DomainName => Str | ||
| 422 | |||
| 423 | =item ObjectTypeName => Str | ||
| 424 | |||
| 425 | =item ProfileId => Str | ||
| 426 | |||
| 427 | =item ProfileObjectUniqueKey => Str | ||
| 428 | |||
| 429 | |||
| 430 | =back | ||
| 431 | |||
| 432 | Each argument is described in detail in: L<Paws::CustomerProfiles::DeleteProfileObject> | ||
| 433 | |||
| 434 | Returns: a L<Paws::CustomerProfiles::DeleteProfileObjectResponse> instance | ||
| 435 | |||
| 436 | Removes an object associated with a profile of a given | ||
| 437 | ProfileObjectType. | ||
| 438 | |||
| 439 | |||
| 440 | =head2 DeleteProfileObjectType | ||
| 441 | |||
| 442 | =over | ||
| 443 | |||
| 444 | =item DomainName => Str | ||
| 445 | |||
| 446 | =item ObjectTypeName => Str | ||
| 447 | |||
| 448 | |||
| 449 | =back | ||
| 450 | |||
| 451 | Each argument is described in detail in: L<Paws::CustomerProfiles::DeleteProfileObjectType> | ||
| 452 | |||
| 453 | Returns: a L<Paws::CustomerProfiles::DeleteProfileObjectTypeResponse> instance | ||
| 454 | |||
| 455 | Removes a ProfileObjectType from a specific domain as well as removes | ||
| 456 | all the ProfileObjects of that type. It also disables integrations from | ||
| 457 | this specific ProfileObjectType. In addition, it scrubs all of the | ||
| 458 | fields of the standard profile that were populated from this | ||
| 459 | ProfileObjectType. | ||
| 460 | |||
| 461 | |||
| 462 | =head2 GetDomain | ||
| 463 | |||
| 464 | =over | ||
| 465 | |||
| 466 | =item DomainName => Str | ||
| 467 | |||
| 468 | |||
| 469 | =back | ||
| 470 | |||
| 471 | Each argument is described in detail in: L<Paws::CustomerProfiles::GetDomain> | ||
| 472 | |||
| 473 | Returns: a L<Paws::CustomerProfiles::GetDomainResponse> instance | ||
| 474 | |||
| 475 | Returns information about a specific domain. | ||
| 476 | |||
| 477 | |||
| 478 | =head2 GetIntegration | ||
| 479 | |||
| 480 | =over | ||
| 481 | |||
| 482 | =item DomainName => Str | ||
| 483 | |||
| 484 | =item Uri => Str | ||
| 485 | |||
| 486 | |||
| 487 | =back | ||
| 488 | |||
| 489 | Each argument is described in detail in: L<Paws::CustomerProfiles::GetIntegration> | ||
| 490 | |||
| 491 | Returns: a L<Paws::CustomerProfiles::GetIntegrationResponse> instance | ||
| 492 | |||
| 493 | Returns an integration for a domain. | ||
| 494 | |||
| 495 | |||
| 496 | =head2 GetMatches | ||
| 497 | |||
| 498 | =over | ||
| 499 | |||
| 500 | =item DomainName => Str | ||
| 501 | |||
| 502 | =item [MaxResults => Int] | ||
| 503 | |||
| 504 | =item [NextToken => Str] | ||
| 505 | |||
| 506 | |||
| 507 | =back | ||
| 508 | |||
| 509 | Each argument is described in detail in: L<Paws::CustomerProfiles::GetMatches> | ||
| 510 | |||
| 511 | Returns: a L<Paws::CustomerProfiles::GetMatchesResponse> instance | ||
| 512 | |||
| 513 | This API is in preview release for Amazon Connect and subject to | ||
| 514 | change. | ||
| 515 | |||
| 516 | Before calling this API, use CreateDomain | ||
| 517 | (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html) | ||
| 518 | or UpdateDomain | ||
| 519 | (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html) | ||
| 520 | to enable identity resolution: set C<Matching> to true. | ||
| 521 | |||
| 522 | GetMatches returns potentially matching profiles, based on the results | ||
| 523 | of the latest run of a machine learning process. | ||
| 524 | |||
| 525 | Amazon Connect runs a batch process every Saturday at 12AM UTC to | ||
| 526 | identify matching profiles. The results are returned up to seven days | ||
| 527 | after the Saturday run. | ||
| 528 | |||
| 529 | Amazon Connect uses the following profile attributes to identify | ||
| 530 | matches: | ||
| 531 | |||
| 532 | =over | ||
| 533 | |||
| 534 | =item * | ||
| 535 | |||
| 536 | PhoneNumber | ||
| 537 | |||
| 538 | =item * | ||
| 539 | |||
| 540 | HomePhoneNumber | ||
| 541 | |||
| 542 | =item * | ||
| 543 | |||
| 544 | BusinessPhoneNumber | ||
| 545 | |||
| 546 | =item * | ||
| 547 | |||
| 548 | MobilePhoneNumber | ||
| 549 | |||
| 550 | =item * | ||
| 551 | |||
| 552 | EmailAddress | ||
| 553 | |||
| 554 | =item * | ||
| 555 | |||
| 556 | PersonalEmailAddress | ||
| 557 | |||
| 558 | =item * | ||
| 559 | |||
| 560 | BusinessEmailAddress | ||
| 561 | |||
| 562 | =item * | ||
| 563 | |||
| 564 | FullName | ||
| 565 | |||
| 566 | =item * | ||
| 567 | |||
| 568 | BusinessName | ||
| 569 | |||
| 570 | =back | ||
| 571 | |||
| 572 | |||
| 573 | |||
| 574 | =head2 GetProfileObjectType | ||
| 575 | |||
| 576 | =over | ||
| 577 | |||
| 578 | =item DomainName => Str | ||
| 579 | |||
| 580 | =item ObjectTypeName => Str | ||
| 581 | |||
| 582 | |||
| 583 | =back | ||
| 584 | |||
| 585 | Each argument is described in detail in: L<Paws::CustomerProfiles::GetProfileObjectType> | ||
| 586 | |||
| 587 | Returns: a L<Paws::CustomerProfiles::GetProfileObjectTypeResponse> instance | ||
| 588 | |||
| 589 | Returns the object types for a specific domain. | ||
| 590 | |||
| 591 | |||
| 592 | =head2 GetProfileObjectTypeTemplate | ||
| 593 | |||
| 594 | =over | ||
| 595 | |||
| 596 | =item TemplateId => Str | ||
| 597 | |||
| 598 | |||
| 599 | =back | ||
| 600 | |||
| 601 | Each argument is described in detail in: L<Paws::CustomerProfiles::GetProfileObjectTypeTemplate> | ||
| 602 | |||
| 603 | Returns: a L<Paws::CustomerProfiles::GetProfileObjectTypeTemplateResponse> instance | ||
| 604 | |||
| 605 | Returns the template information for a specific object type. | ||
| 606 | |||
| 607 | A template is a predefined ProfileObjectType, such as | ||
| 608 | E<ldquo>Salesforce-AccountE<rdquo> or | ||
| 609 | E<ldquo>Salesforce-Contact.E<rdquo> When a user sends a ProfileObject, | ||
| 610 | using the PutProfileObject API, with an ObjectTypeName that matches one | ||
| 611 | of the TemplateIds, it uses the mappings from the template. | ||
| 612 | |||
| 613 | |||
| 614 | =head2 ListAccountIntegrations | ||
| 615 | |||
| 616 | =over | ||
| 617 | |||
| 618 | =item Uri => Str | ||
| 619 | |||
| 620 | =item [MaxResults => Int] | ||
| 621 | |||
| 622 | =item [NextToken => Str] | ||
| 623 | |||
| 624 | |||
| 625 | =back | ||
| 626 | |||
| 627 | Each argument is described in detail in: L<Paws::CustomerProfiles::ListAccountIntegrations> | ||
| 628 | |||
| 629 | Returns: a L<Paws::CustomerProfiles::ListAccountIntegrationsResponse> instance | ||
| 630 | |||
| 631 | Lists all of the integrations associated to a specific URI in the AWS | ||
| 632 | account. | ||
| 633 | |||
| 634 | |||
| 635 | =head2 ListDomains | ||
| 636 | |||
| 637 | =over | ||
| 638 | |||
| 639 | =item [MaxResults => Int] | ||
| 640 | |||
| 641 | =item [NextToken => Str] | ||
| 642 | |||
| 643 | |||
| 644 | =back | ||
| 645 | |||
| 646 | Each argument is described in detail in: L<Paws::CustomerProfiles::ListDomains> | ||
| 647 | |||
| 648 | Returns: a L<Paws::CustomerProfiles::ListDomainsResponse> instance | ||
| 649 | |||
| 650 | Returns a list of all the domains for an AWS account that have been | ||
| 651 | created. | ||
| 652 | |||
| 653 | |||
| 654 | =head2 ListIntegrations | ||
| 655 | |||
| 656 | =over | ||
| 657 | |||
| 658 | =item DomainName => Str | ||
| 659 | |||
| 660 | =item [MaxResults => Int] | ||
| 661 | |||
| 662 | =item [NextToken => Str] | ||
| 663 | |||
| 664 | |||
| 665 | =back | ||
| 666 | |||
| 667 | Each argument is described in detail in: L<Paws::CustomerProfiles::ListIntegrations> | ||
| 668 | |||
| 669 | Returns: a L<Paws::CustomerProfiles::ListIntegrationsResponse> instance | ||
| 670 | |||
| 671 | Lists all of the integrations in your domain. | ||
| 672 | |||
| 673 | |||
| 674 | =head2 ListProfileObjects | ||
| 675 | |||
| 676 | =over | ||
| 677 | |||
| 678 | =item DomainName => Str | ||
| 679 | |||
| 680 | =item ObjectTypeName => Str | ||
| 681 | |||
| 682 | =item ProfileId => Str | ||
| 683 | |||
| 684 | =item [MaxResults => Int] | ||
| 685 | |||
| 686 | =item [NextToken => Str] | ||
| 687 | |||
| 688 | |||
| 689 | =back | ||
| 690 | |||
| 691 | Each argument is described in detail in: L<Paws::CustomerProfiles::ListProfileObjects> | ||
| 692 | |||
| 693 | Returns: a L<Paws::CustomerProfiles::ListProfileObjectsResponse> instance | ||
| 694 | |||
| 695 | Returns a list of objects associated with a profile of a given | ||
| 696 | ProfileObjectType. | ||
| 697 | |||
| 698 | |||
| 699 | =head2 ListProfileObjectTypes | ||
| 700 | |||
| 701 | =over | ||
| 702 | |||
| 703 | =item DomainName => Str | ||
| 704 | |||
| 705 | =item [MaxResults => Int] | ||
| 706 | |||
| 707 | =item [NextToken => Str] | ||
| 708 | |||
| 709 | |||
| 710 | =back | ||
| 711 | |||
| 712 | Each argument is described in detail in: L<Paws::CustomerProfiles::ListProfileObjectTypes> | ||
| 713 | |||
| 714 | Returns: a L<Paws::CustomerProfiles::ListProfileObjectTypesResponse> instance | ||
| 715 | |||
| 716 | Lists all of the templates available within the service. | ||
| 717 | |||
| 718 | |||
| 719 | =head2 ListProfileObjectTypeTemplates | ||
| 720 | |||
| 721 | =over | ||
| 722 | |||
| 723 | =item [MaxResults => Int] | ||
| 724 | |||
| 725 | =item [NextToken => Str] | ||
| 726 | |||
| 727 | |||
| 728 | =back | ||
| 729 | |||
| 730 | Each argument is described in detail in: L<Paws::CustomerProfiles::ListProfileObjectTypeTemplates> | ||
| 731 | |||
| 732 | Returns: a L<Paws::CustomerProfiles::ListProfileObjectTypeTemplatesResponse> instance | ||
| 733 | |||
| 734 | Lists all of the template information for object types. | ||
| 735 | |||
| 736 | |||
| 737 | =head2 ListTagsForResource | ||
| 738 | |||
| 739 | =over | ||
| 740 | |||
| 741 | =item ResourceArn => Str | ||
| 742 | |||
| 743 | |||
| 744 | =back | ||
| 745 | |||
| 746 | Each argument is described in detail in: L<Paws::CustomerProfiles::ListTagsForResource> | ||
| 747 | |||
| 748 | Returns: a L<Paws::CustomerProfiles::ListTagsForResourceResponse> instance | ||
| 749 | |||
| 750 | Displays the tags associated with an Amazon Connect Customer Profiles | ||
| 751 | resource. In Connect Customer Profiles, domains, profile object types, | ||
| 752 | and integrations can be tagged. | ||
| 753 | |||
| 754 | |||
| 755 | =head2 MergeProfiles | ||
| 756 | |||
| 757 | =over | ||
| 758 | |||
| 759 | =item DomainName => Str | ||
| 760 | |||
| 761 | =item MainProfileId => Str | ||
| 762 | |||
| 763 | =item ProfileIdsToBeMerged => ArrayRef[Str|Undef] | ||
| 764 | |||
| 765 | =item [FieldSourceProfileIds => L<Paws::CustomerProfiles::FieldSourceProfileIds>] | ||
| 766 | |||
| 767 | |||
| 768 | =back | ||
| 769 | |||
| 770 | Each argument is described in detail in: L<Paws::CustomerProfiles::MergeProfiles> | ||
| 771 | |||
| 772 | Returns: a L<Paws::CustomerProfiles::MergeProfilesResponse> instance | ||
| 773 | |||
| 774 | This API is in preview release for Amazon Connect and subject to | ||
| 775 | change. | ||
| 776 | |||
| 777 | Runs an AWS Lambda job that does the following: | ||
| 778 | |||
| 779 | =over | ||
| 780 | |||
| 781 | =item 1. | ||
| 782 | |||
| 783 | All the profileKeys in the C<ProfileToBeMerged> will be moved to the | ||
| 784 | main profile. | ||
| 785 | |||
| 786 | =item 2. | ||
| 787 | |||
| 788 | All the objects in the C<ProfileToBeMerged> will be moved to the main | ||
| 789 | profile. | ||
| 790 | |||
| 791 | =item 3. | ||
| 792 | |||
| 793 | All the C<ProfileToBeMerged> will be deleted at the end. | ||
| 794 | |||
| 795 | =item 4. | ||
| 796 | |||
| 797 | All the profileKeys in the C<ProfileIdsToBeMerged> will be moved to the | ||
| 798 | main profile. | ||
| 799 | |||
| 800 | =item 5. | ||
| 801 | |||
| 802 | Standard fields are merged as follows: | ||
| 803 | |||
| 804 | =over | ||
| 805 | |||
| 806 | =item 1. | ||
| 807 | |||
| 808 | Fields are always "union"-ed if there are no conflicts in standard | ||
| 809 | fields or attributeKeys. | ||
| 810 | |||
| 811 | =item 2. | ||
| 812 | |||
| 813 | When there are conflicting fields: | ||
| 814 | |||
| 815 | =over | ||
| 816 | |||
| 817 | =item 1. | ||
| 818 | |||
| 819 | If no C<SourceProfileIds> entry is specified, the main Profile value is | ||
| 820 | always taken. | ||
| 821 | |||
| 822 | =item 2. | ||
| 823 | |||
| 824 | If a C<SourceProfileIds> entry is specified, the specified profileId is | ||
| 825 | always taken, even if it is a NULL value. | ||
| 826 | |||
| 827 | =back | ||
| 828 | |||
| 829 | =back | ||
| 830 | |||
| 831 | =back | ||
| 832 | |||
| 833 | You can use MergeProfiles together with GetMatches | ||
| 834 | (https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html), | ||
| 835 | which returns potentially matching profiles, or use it with the results | ||
| 836 | of another matching system. After profiles have been merged, they | ||
| 837 | cannot be separated (unmerged). | ||
| 838 | |||
| 839 | |||
| 840 | =head2 PutIntegration | ||
| 841 | |||
| 842 | =over | ||
| 843 | |||
| 844 | =item DomainName => Str | ||
| 845 | |||
| 846 | =item ObjectTypeName => Str | ||
| 847 | |||
| 848 | =item [FlowDefinition => L<Paws::CustomerProfiles::FlowDefinition>] | ||
| 849 | |||
| 850 | =item [Tags => L<Paws::CustomerProfiles::TagMap>] | ||
| 851 | |||
| 852 | =item [Uri => Str] | ||
| 853 | |||
| 854 | |||
| 855 | =back | ||
| 856 | |||
| 857 | Each argument is described in detail in: L<Paws::CustomerProfiles::PutIntegration> | ||
| 858 | |||
| 859 | Returns: a L<Paws::CustomerProfiles::PutIntegrationResponse> instance | ||
| 860 | |||
| 861 | Adds an integration between the service and a third-party service, | ||
| 862 | which includes Amazon AppFlow and Amazon Connect. | ||
| 863 | |||
| 864 | An integration can belong to only one domain. | ||
| 865 | |||
| 866 | |||
| 867 | =head2 PutProfileObject | ||
| 868 | |||
| 869 | =over | ||
| 870 | |||
| 871 | =item DomainName => Str | ||
| 872 | |||
| 873 | =item Object => Str | ||
| 874 | |||
| 875 | =item ObjectTypeName => Str | ||
| 876 | |||
| 877 | |||
| 878 | =back | ||
| 879 | |||
| 880 | Each argument is described in detail in: L<Paws::CustomerProfiles::PutProfileObject> | ||
| 881 | |||
| 882 | Returns: a L<Paws::CustomerProfiles::PutProfileObjectResponse> instance | ||
| 883 | |||
| 884 | Adds additional objects to customer profiles of a given ObjectType. | ||
| 885 | |||
| 886 | When adding a specific profile object, like a Contact Trace Record | ||
| 887 | (CTR), an inferred profile can get created if it is not mapped to an | ||
| 888 | existing profile. The resulting profile will only have a phone number | ||
| 889 | populated in the standard ProfileObject. Any additional CTRs with the | ||
| 890 | same phone number will be mapped to the same inferred profile. | ||
| 891 | |||
| 892 | When a ProfileObject is created and if a ProfileObjectType already | ||
| 893 | exists for the ProfileObject, it will provide data to a standard | ||
| 894 | profile depending on the ProfileObjectType definition. | ||
| 895 | |||
| 896 | PutProfileObject needs an ObjectType, which can be created using | ||
| 897 | PutProfileObjectType. | ||
| 898 | |||
| 899 | |||
| 900 | =head2 PutProfileObjectType | ||
| 901 | |||
| 902 | =over | ||
| 903 | |||
| 904 | =item Description => Str | ||
| 905 | |||
| 906 | =item DomainName => Str | ||
| 907 | |||
| 908 | =item ObjectTypeName => Str | ||
| 909 | |||
| 910 | =item [AllowProfileCreation => Bool] | ||
| 911 | |||
| 912 | =item [EncryptionKey => Str] | ||
| 913 | |||
| 914 | =item [ExpirationDays => Int] | ||
| 915 | |||
| 916 | =item [Fields => L<Paws::CustomerProfiles::FieldMap>] | ||
| 917 | |||
| 918 | =item [Keys => L<Paws::CustomerProfiles::KeyMap>] | ||
| 919 | |||
| 920 | =item [Tags => L<Paws::CustomerProfiles::TagMap>] | ||
| 921 | |||
| 922 | =item [TemplateId => Str] | ||
| 923 | |||
| 924 | |||
| 925 | =back | ||
| 926 | |||
| 927 | Each argument is described in detail in: L<Paws::CustomerProfiles::PutProfileObjectType> | ||
| 928 | |||
| 929 | Returns: a L<Paws::CustomerProfiles::PutProfileObjectTypeResponse> instance | ||
| 930 | |||
| 931 | Defines a ProfileObjectType. | ||
| 932 | |||
| 933 | |||
| 934 | =head2 SearchProfiles | ||
| 935 | |||
| 936 | =over | ||
| 937 | |||
| 938 | =item DomainName => Str | ||
| 939 | |||
| 940 | =item KeyName => Str | ||
| 941 | |||
| 942 | =item Values => ArrayRef[Str|Undef] | ||
| 943 | |||
| 944 | =item [MaxResults => Int] | ||
| 945 | |||
| 946 | =item [NextToken => Str] | ||
| 947 | |||
| 948 | |||
| 949 | =back | ||
| 950 | |||
| 951 | Each argument is described in detail in: L<Paws::CustomerProfiles::SearchProfiles> | ||
| 952 | |||
| 953 | Returns: a L<Paws::CustomerProfiles::SearchProfilesResponse> instance | ||
| 954 | |||
| 955 | Searches for profiles within a specific domain name using name, phone | ||
| 956 | number, email address, account number, or a custom defined index. | ||
| 957 | |||
| 958 | |||
| 959 | =head2 TagResource | ||
| 960 | |||
| 961 | =over | ||
| 962 | |||
| 963 | =item ResourceArn => Str | ||
| 964 | |||
| 965 | =item Tags => L<Paws::CustomerProfiles::TagMap> | ||
| 966 | |||
| 967 | |||
| 968 | =back | ||
| 969 | |||
| 970 | Each argument is described in detail in: L<Paws::CustomerProfiles::TagResource> | ||
| 971 | |||
| 972 | Returns: a L<Paws::CustomerProfiles::TagResourceResponse> instance | ||
| 973 | |||
| 974 | Assigns one or more tags (key-value pairs) to the specified Amazon | ||
| 975 | Connect Customer Profiles resource. Tags can help you organize and | ||
| 976 | categorize your resources. You can also use them to scope user | ||
| 977 | permissions by granting a user permission to access or change only | ||
| 978 | resources with certain tag values. In Connect Customer Profiles, | ||
| 979 | domains, profile object types, and integrations can be tagged. | ||
| 980 | |||
| 981 | Tags don't have any semantic meaning to AWS and are interpreted | ||
| 982 | strictly as strings of characters. | ||
| 983 | |||
| 984 | You can use the TagResource action with a resource that already has | ||
| 985 | tags. If you specify a new tag key, this tag is appended to the list of | ||
| 986 | tags associated with the resource. If you specify a tag key that is | ||
| 987 | already associated with the resource, the new tag value that you | ||
| 988 | specify replaces the previous value for that tag. | ||
| 989 | |||
| 990 | You can associate as many as 50 tags with a resource. | ||
| 991 | |||
| 992 | |||
| 993 | =head2 UntagResource | ||
| 994 | |||
| 995 | =over | ||
| 996 | |||
| 997 | =item ResourceArn => Str | ||
| 998 | |||
| 999 | =item TagKeys => ArrayRef[Str|Undef] | ||
| 1000 | |||
| 1001 | |||
| 1002 | =back | ||
| 1003 | |||
| 1004 | Each argument is described in detail in: L<Paws::CustomerProfiles::UntagResource> | ||
| 1005 | |||
| 1006 | Returns: a L<Paws::CustomerProfiles::UntagResourceResponse> instance | ||
| 1007 | |||
| 1008 | Removes one or more tags from the specified Amazon Connect Customer | ||
| 1009 | Profiles resource. In Connect Customer Profiles, domains, profile | ||
| 1010 | object types, and integrations can be tagged. | ||
| 1011 | |||
| 1012 | |||
| 1013 | =head2 UpdateDomain | ||
| 1014 | |||
| 1015 | =over | ||
| 1016 | |||
| 1017 | =item DomainName => Str | ||
| 1018 | |||
| 1019 | =item [DeadLetterQueueUrl => Str] | ||
| 1020 | |||
| 1021 | =item [DefaultEncryptionKey => Str] | ||
| 1022 | |||
| 1023 | =item [DefaultExpirationDays => Int] | ||
| 1024 | |||
| 1025 | =item [Matching => L<Paws::CustomerProfiles::MatchingRequest>] | ||
| 1026 | |||
| 1027 | =item [Tags => L<Paws::CustomerProfiles::TagMap>] | ||
| 1028 | |||
| 1029 | |||
| 1030 | =back | ||
| 1031 | |||
| 1032 | Each argument is described in detail in: L<Paws::CustomerProfiles::UpdateDomain> | ||
| 1033 | |||
| 1034 | Returns: a L<Paws::CustomerProfiles::UpdateDomainResponse> instance | ||
| 1035 | |||
| 1036 | Updates the properties of a domain, including creating or selecting a | ||
| 1037 | dead letter queue or an encryption key. | ||
| 1038 | |||
| 1039 | After a domain is created, the name canE<rsquo>t be changed. | ||
| 1040 | |||
| 1041 | |||
| 1042 | =head2 UpdateProfile | ||
| 1043 | |||
| 1044 | =over | ||
| 1045 | |||
| 1046 | =item DomainName => Str | ||
| 1047 | |||
| 1048 | =item ProfileId => Str | ||
| 1049 | |||
| 1050 | =item [AccountNumber => Str] | ||
| 1051 | |||
| 1052 | =item [AdditionalInformation => Str] | ||
| 1053 | |||
| 1054 | =item [Address => L<Paws::CustomerProfiles::UpdateAddress>] | ||
| 1055 | |||
| 1056 | =item [Attributes => L<Paws::CustomerProfiles::UpdateAttributes>] | ||
| 1057 | |||
| 1058 | =item [BillingAddress => L<Paws::CustomerProfiles::UpdateAddress>] | ||
| 1059 | |||
| 1060 | =item [BirthDate => Str] | ||
| 1061 | |||
| 1062 | =item [BusinessEmailAddress => Str] | ||
| 1063 | |||
| 1064 | =item [BusinessName => Str] | ||
| 1065 | |||
| 1066 | =item [BusinessPhoneNumber => Str] | ||
| 1067 | |||
| 1068 | =item [EmailAddress => Str] | ||
| 1069 | |||
| 1070 | =item [FirstName => Str] | ||
| 1071 | |||
| 1072 | =item [Gender => Str] | ||
| 1073 | |||
| 1074 | =item [HomePhoneNumber => Str] | ||
| 1075 | |||
| 1076 | =item [LastName => Str] | ||
| 1077 | |||
| 1078 | =item [MailingAddress => L<Paws::CustomerProfiles::UpdateAddress>] | ||
| 1079 | |||
| 1080 | =item [MiddleName => Str] | ||
| 1081 | |||
| 1082 | =item [MobilePhoneNumber => Str] | ||
| 1083 | |||
| 1084 | =item [PartyType => Str] | ||
| 1085 | |||
| 1086 | =item [PersonalEmailAddress => Str] | ||
| 1087 | |||
| 1088 | =item [PhoneNumber => Str] | ||
| 1089 | |||
| 1090 | =item [ShippingAddress => L<Paws::CustomerProfiles::UpdateAddress>] | ||
| 1091 | |||
| 1092 | |||
| 1093 | =back | ||
| 1094 | |||
| 1095 | Each argument is described in detail in: L<Paws::CustomerProfiles::UpdateProfile> | ||
| 1096 | |||
| 1097 | Returns: a L<Paws::CustomerProfiles::UpdateProfileResponse> instance | ||
| 1098 | |||
| 1099 | Updates the properties of a profile. The ProfileId is required for | ||
| 1100 | updating a customer profile. | ||
| 1101 | |||
| 1102 | When calling the UpdateProfile API, specifying an empty string value | ||
| 1103 | means that any existing value will be removed. Not specifying a string | ||
| 1104 | value means that any value already there will be kept. | ||
| 1105 | |||
| 1106 | |||
| 1107 | |||
| 1108 | |||
| 1109 | =head1 PAGINATORS | ||
| 1110 | |||
| 1111 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 1112 | |||
| 1113 | |||
| 1114 | |||
| 1115 | |||
| 1116 | =head1 SEE ALSO | ||
| 1117 | |||
| 1118 | This service class forms part of L<Paws> | ||
| 1119 | |||
| 1120 | =head1 BUGS and CONTRIBUTIONS | ||
| 1121 | |||
| 1122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 1123 | |||
| 1124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 1125 | |||
| 1126 | =cut | ||
| 1127 |