« blib/lib/Paws/CustomerProfiles/ScheduledTriggerProperties.pm
↑ Summary
blib/lib/Paws/CustomerProfiles/SearchProfilesResponse.pm »
| 1 | |||
| 2 | package Paws::CustomerProfiles::SearchProfiles; | ||
| 3 | use Moose; | ||
| 4 | has DomainName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DomainName', required => 1); | ||
| 5 | has KeyName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'max-results'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'next-token'); | ||
| 8 | has Values => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchProfiles'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/domains/{DomainName}/profiles/search'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CustomerProfiles::SearchProfilesResponse'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CustomerProfiles::SearchProfiles - Arguments for method SearchProfiles on L<Paws::CustomerProfiles> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method SearchProfiles on the | ||
| 27 | L<Amazon Connect Customer Profiles|Paws::CustomerProfiles> service. Use the attributes of this class | ||
| 28 | as arguments to method SearchProfiles. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchProfiles. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $profile = Paws->service('CustomerProfiles'); | ||
| 35 | my $SearchProfilesResponse = $profile->SearchProfiles( | ||
| 36 | DomainName => 'Myname', | ||
| 37 | KeyName => 'Myname', | ||
| 38 | Values => [ | ||
| 39 | 'Mystring1To255', ... # min: 1, max: 255 | ||
| 40 | ], | ||
| 41 | MaxResults => 1, # OPTIONAL | ||
| 42 | NextToken => 'Mytoken', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $Items = $SearchProfilesResponse->Items; | ||
| 47 | my $NextToken = $SearchProfilesResponse->NextToken; | ||
| 48 | |||
| 49 | # Returns a L<Paws::CustomerProfiles::SearchProfilesResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/profile/SearchProfiles> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> DomainName => Str | ||
| 58 | |||
| 59 | The unique name of the domain. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> KeyName => Str | ||
| 64 | |||
| 65 | A searchable identifier of a customer profile. The predefined keys you | ||
| 66 | can use to search include: _account, _profileId, _fullName, _phone, | ||
| 67 | _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, | ||
| 68 | _salesforceContactId, _zendeskUserId, _zendeskExternalId, | ||
| 69 | _serviceNowSystemId. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 MaxResults => Int | ||
| 74 | |||
| 75 | The maximum number of objects returned per page. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 NextToken => Str | ||
| 80 | |||
| 81 | The pagination token from the previous SearchProfiles API call. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> Values => ArrayRef[Str|Undef] | ||
| 86 | |||
| 87 | A list of key values. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head1 SEE ALSO | ||
| 93 | |||
| 94 | This class forms part of L<Paws>, documenting arguments for method SearchProfiles in L<Paws::CustomerProfiles> | ||
| 95 | |||
| 96 | =head1 BUGS and CONTRIBUTIONS | ||
| 97 | |||
| 98 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 99 | |||
| 100 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 101 | |||
| 102 | =cut | ||
| 103 |