« blib/lib/Paws/CustomerProfiles.pm
↑ Summary
blib/lib/Paws/CustomerProfiles/AddProfileKeyResponse.pm »
| 1 | |||
| 2 | package Paws::CustomerProfiles::AddProfileKey; | ||
| 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 ProfileId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Values => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'AddProfileKey'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/domains/{DomainName}/profiles/keys'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CustomerProfiles::AddProfileKeyResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CustomerProfiles::AddProfileKey - Arguments for method AddProfileKey on L<Paws::CustomerProfiles> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method AddProfileKey on the | ||
| 26 | L<Amazon Connect Customer Profiles|Paws::CustomerProfiles> service. Use the attributes of this class | ||
| 27 | as arguments to method AddProfileKey. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AddProfileKey. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $profile = Paws->service('CustomerProfiles'); | ||
| 34 | my $AddProfileKeyResponse = $profile->AddProfileKey( | ||
| 35 | DomainName => 'Myname', | ||
| 36 | KeyName => 'Myname', | ||
| 37 | ProfileId => 'Myuuid', | ||
| 38 | Values => [ | ||
| 39 | 'Mystring1To255', ... # min: 1, max: 255 | ||
| 40 | ], | ||
| 41 | |||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $KeyName = $AddProfileKeyResponse->KeyName; | ||
| 46 | my $Values = $AddProfileKeyResponse->Values; | ||
| 47 | |||
| 48 | # Returns a L<Paws::CustomerProfiles::AddProfileKeyResponse> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/profile/AddProfileKey> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> DomainName => Str | ||
| 57 | |||
| 58 | The unique name of the domain. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> KeyName => Str | ||
| 63 | |||
| 64 | A searchable identifier of a customer profile. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> ProfileId => Str | ||
| 69 | |||
| 70 | The unique identifier of a customer profile. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> Values => ArrayRef[Str|Undef] | ||
| 75 | |||
| 76 | A list of key values. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method AddProfileKey in L<Paws::CustomerProfiles> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |