« blib/lib/Paws/CustomerProfiles/PutProfileObjectResponse.pm
↑ Summary
blib/lib/Paws/CustomerProfiles/PutProfileObjectTypeResponse.pm »
| 1 | |||
| 2 | package Paws::CustomerProfiles::PutProfileObjectType; | ||
| 3 | use Moose; | ||
| 4 | has AllowProfileCreation => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DomainName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DomainName', required => 1); | ||
| 7 | has EncryptionKey => (is => 'ro', isa => 'Str'); | ||
| 8 | has ExpirationDays => (is => 'ro', isa => 'Int'); | ||
| 9 | has Fields => (is => 'ro', isa => 'Paws::CustomerProfiles::FieldMap'); | ||
| 10 | has Keys => (is => 'ro', isa => 'Paws::CustomerProfiles::KeyMap'); | ||
| 11 | has ObjectTypeName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'ObjectTypeName', required => 1); | ||
| 12 | has Tags => (is => 'ro', isa => 'Paws::CustomerProfiles::TagMap'); | ||
| 13 | has TemplateId => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutProfileObjectType'); | ||
| 18 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/domains/{DomainName}/object-types/{ObjectTypeName}'); | ||
| 19 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 20 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CustomerProfiles::PutProfileObjectTypeResponse'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::CustomerProfiles::PutProfileObjectType - Arguments for method PutProfileObjectType on L<Paws::CustomerProfiles> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method PutProfileObjectType on the | ||
| 32 | L<Amazon Connect Customer Profiles|Paws::CustomerProfiles> service. Use the attributes of this class | ||
| 33 | as arguments to method PutProfileObjectType. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutProfileObjectType. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $profile = Paws->service('CustomerProfiles'); | ||
| 40 | my $PutProfileObjectTypeResponse = $profile->PutProfileObjectType( | ||
| 41 | Description => 'Mytext', | ||
| 42 | DomainName => 'Myname', | ||
| 43 | ObjectTypeName => 'MytypeName', | ||
| 44 | AllowProfileCreation => 1, # OPTIONAL | ||
| 45 | EncryptionKey => 'MyencryptionKey', # OPTIONAL | ||
| 46 | ExpirationDays => 1, # OPTIONAL | ||
| 47 | Fields => { | ||
| 48 | 'Myname' => { | ||
| 49 | ContentType => 'STRING' | ||
| 50 | , # values: STRING, NUMBER, PHONE_NUMBER, EMAIL_ADDRESS, NAME; OPTIONAL | ||
| 51 | Source => 'Mytext', # min: 1, max: 1000 | ||
| 52 | Target => 'Mytext', # min: 1, max: 1000 | ||
| 53 | }, # key: min: 1, max: 64 | ||
| 54 | }, # OPTIONAL | ||
| 55 | Keys => { | ||
| 56 | 'Myname' => [ | ||
| 57 | { | ||
| 58 | FieldNames => [ | ||
| 59 | 'Myname', ... # min: 1, max: 64 | ||
| 60 | ], # OPTIONAL | ||
| 61 | StandardIdentifiers => [ | ||
| 62 | 'PROFILE', | ||
| 63 | ... # values: PROFILE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY | ||
| 64 | ], # OPTIONAL | ||
| 65 | }, | ||
| 66 | ... | ||
| 67 | ], # key: min: 1, max: 64 | ||
| 68 | }, # OPTIONAL | ||
| 69 | Tags => { | ||
| 70 | 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256 | ||
| 71 | }, # OPTIONAL | ||
| 72 | TemplateId => 'Myname', # OPTIONAL | ||
| 73 | ); | ||
| 74 | |||
| 75 | # Results: | ||
| 76 | my $AllowProfileCreation = | ||
| 77 | $PutProfileObjectTypeResponse->AllowProfileCreation; | ||
| 78 | my $CreatedAt = $PutProfileObjectTypeResponse->CreatedAt; | ||
| 79 | my $Description = $PutProfileObjectTypeResponse->Description; | ||
| 80 | my $EncryptionKey = $PutProfileObjectTypeResponse->EncryptionKey; | ||
| 81 | my $ExpirationDays = $PutProfileObjectTypeResponse->ExpirationDays; | ||
| 82 | my $Fields = $PutProfileObjectTypeResponse->Fields; | ||
| 83 | my $Keys = $PutProfileObjectTypeResponse->Keys; | ||
| 84 | my $LastUpdatedAt = $PutProfileObjectTypeResponse->LastUpdatedAt; | ||
| 85 | my $ObjectTypeName = $PutProfileObjectTypeResponse->ObjectTypeName; | ||
| 86 | my $Tags = $PutProfileObjectTypeResponse->Tags; | ||
| 87 | my $TemplateId = $PutProfileObjectTypeResponse->TemplateId; | ||
| 88 | |||
| 89 | # Returns a L<Paws::CustomerProfiles::PutProfileObjectTypeResponse> object. | ||
| 90 | |||
| 91 | 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. | ||
| 92 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/profile/PutProfileObjectType> | ||
| 93 | |||
| 94 | =head1 ATTRIBUTES | ||
| 95 | |||
| 96 | |||
| 97 | =head2 AllowProfileCreation => Bool | ||
| 98 | |||
| 99 | Indicates whether a profile should be created when data is received if | ||
| 100 | one doesnE<rsquo>t exist for an object of this type. The default is | ||
| 101 | C<FALSE>. If the AllowProfileCreation flag is set to C<FALSE>, then the | ||
| 102 | service tries to fetch a standard profile and associate this object | ||
| 103 | with the profile. If it is set to C<TRUE>, and if no match is found, | ||
| 104 | then the service creates a new standard profile. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 B<REQUIRED> Description => Str | ||
| 109 | |||
| 110 | Description of the profile object type. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> DomainName => Str | ||
| 115 | |||
| 116 | The unique name of the domain. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 EncryptionKey => Str | ||
| 121 | |||
| 122 | The customer-provided key to encrypt the profile object that will be | ||
| 123 | created in this profile object type. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 ExpirationDays => Int | ||
| 128 | |||
| 129 | The number of days until the data in the object expires. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 Fields => L<Paws::CustomerProfiles::FieldMap> | ||
| 134 | |||
| 135 | A map of the name and ObjectType field. | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 Keys => L<Paws::CustomerProfiles::KeyMap> | ||
| 140 | |||
| 141 | A list of unique keys that can be used to map data to the profile. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 B<REQUIRED> ObjectTypeName => Str | ||
| 146 | |||
| 147 | The name of the profile object type. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head2 Tags => L<Paws::CustomerProfiles::TagMap> | ||
| 152 | |||
| 153 | The tags used to organize, track, or control access for this resource. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 TemplateId => Str | ||
| 158 | |||
| 159 | A unique identifier for the object template. | ||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | |||
| 164 | =head1 SEE ALSO | ||
| 165 | |||
| 166 | This class forms part of L<Paws>, documenting arguments for method PutProfileObjectType in L<Paws::CustomerProfiles> | ||
| 167 | |||
| 168 | =head1 BUGS and CONTRIBUTIONS | ||
| 169 | |||
| 170 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 171 | |||
| 172 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 173 | |||
| 174 | =cut | ||
| 175 |