« blib/lib/Paws/Kendra/ConnectionConfiguration.pm
↑ Summary
blib/lib/Paws/Kendra/CreateDataSourceResponse.pm »
| 1 | |||
| 2 | package Paws::Kendra::CreateDataSource; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has Configuration => (is => 'ro', isa => 'Paws::Kendra::DataSourceConfiguration'); | ||
| 6 | has Description => (is => 'ro', isa => 'Str'); | ||
| 7 | has IndexId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 10 | has Schedule => (is => 'ro', isa => 'Str'); | ||
| 11 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::Tag]'); | ||
| 12 | has Type => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDataSource'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kendra::CreateDataSourceResponse'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Kendra::CreateDataSource - Arguments for method CreateDataSource on L<Paws::Kendra> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateDataSource on the | ||
| 30 | L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateDataSource. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDataSource. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $kendra = Paws->service('Kendra'); | ||
| 38 | my $CreateDataSourceResponse = $kendra->CreateDataSource( | ||
| 39 | IndexId => 'MyIndexId', | ||
| 40 | Name => 'MyDataSourceName', | ||
| 41 | Type => 'S3', | ||
| 42 | ClientToken => 'MyClientTokenName', # OPTIONAL | ||
| 43 | Configuration => { | ||
| 44 | ConfluenceConfiguration => { | ||
| 45 | SecretArn => 'MySecretArn', # min: 1, max: 1284 | ||
| 46 | ServerUrl => 'MyUrl', # min: 1, max: 2048 | ||
| 47 | Version => 'CLOUD', # values: CLOUD, SERVER | ||
| 48 | AttachmentConfiguration => { | ||
| 49 | AttachmentFieldMappings => [ | ||
| 50 | { | ||
| 51 | DataSourceFieldName => 'AUTHOR' | ||
| 52 | , # values: AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION; OPTIONAL | ||
| 53 | DateFieldFormat => | ||
| 54 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 55 | IndexFieldName => | ||
| 56 | 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 57 | }, | ||
| 58 | ... | ||
| 59 | ], # min: 1, max: 11; OPTIONAL | ||
| 60 | CrawlAttachments => 1, # OPTIONAL | ||
| 61 | }, # OPTIONAL | ||
| 62 | BlogConfiguration => { | ||
| 63 | BlogFieldMappings => [ | ||
| 64 | { | ||
| 65 | DataSourceFieldName => 'AUTHOR' | ||
| 66 | , # values: AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION; OPTIONAL | ||
| 67 | DateFieldFormat => | ||
| 68 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 69 | IndexFieldName => | ||
| 70 | 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 71 | }, | ||
| 72 | ... | ||
| 73 | ], # min: 1, max: 9; OPTIONAL | ||
| 74 | }, # OPTIONAL | ||
| 75 | ExclusionPatterns => [ | ||
| 76 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 77 | ... # min: 1, max: 150 | ||
| 78 | ], # max: 100; OPTIONAL | ||
| 79 | InclusionPatterns => [ | ||
| 80 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 81 | ... # min: 1, max: 150 | ||
| 82 | ], # max: 100; OPTIONAL | ||
| 83 | PageConfiguration => { | ||
| 84 | PageFieldMappings => [ | ||
| 85 | { | ||
| 86 | DataSourceFieldName => 'AUTHOR' | ||
| 87 | , # values: AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION; OPTIONAL | ||
| 88 | DateFieldFormat => | ||
| 89 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 90 | IndexFieldName => | ||
| 91 | 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 92 | }, | ||
| 93 | ... | ||
| 94 | ], # min: 1, max: 12; OPTIONAL | ||
| 95 | }, # OPTIONAL | ||
| 96 | SpaceConfiguration => { | ||
| 97 | CrawlArchivedSpaces => 1, # OPTIONAL | ||
| 98 | CrawlPersonalSpaces => 1, # OPTIONAL | ||
| 99 | ExcludeSpaces => [ | ||
| 100 | 'MyConfluenceSpaceIdentifier', ... # min: 1, max: 255 | ||
| 101 | ], # min: 1; OPTIONAL | ||
| 102 | IncludeSpaces => [ | ||
| 103 | 'MyConfluenceSpaceIdentifier', ... # min: 1, max: 255 | ||
| 104 | ], # min: 1; OPTIONAL | ||
| 105 | SpaceFieldMappings => [ | ||
| 106 | { | ||
| 107 | DataSourceFieldName => 'DISPLAY_URL' | ||
| 108 | , # values: DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL; OPTIONAL | ||
| 109 | DateFieldFormat => | ||
| 110 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 111 | IndexFieldName => | ||
| 112 | 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 113 | }, | ||
| 114 | ... | ||
| 115 | ], # min: 1, max: 4; OPTIONAL | ||
| 116 | }, # OPTIONAL | ||
| 117 | VpcConfiguration => { | ||
| 118 | SecurityGroupIds => [ | ||
| 119 | 'MyVpcSecurityGroupId', ... # min: 1, max: 200 | ||
| 120 | ], # min: 1, max: 10 | ||
| 121 | SubnetIds => [ | ||
| 122 | 'MySubnetId', ... # min: 1, max: 200 | ||
| 123 | ], # min: 1, max: 6 | ||
| 124 | |||
| 125 | }, # OPTIONAL | ||
| 126 | }, # OPTIONAL | ||
| 127 | DatabaseConfiguration => { | ||
| 128 | ColumnConfiguration => { | ||
| 129 | ChangeDetectingColumns => [ | ||
| 130 | 'MyColumnName', ... # min: 1, max: 100 | ||
| 131 | ], # min: 1, max: 5 | ||
| 132 | DocumentDataColumnName => 'MyColumnName', # min: 1, max: 100 | ||
| 133 | DocumentIdColumnName => 'MyColumnName', # min: 1, max: 100 | ||
| 134 | DocumentTitleColumnName => 'MyColumnName', # min: 1, max: 100 | ||
| 135 | FieldMappings => [ | ||
| 136 | { | ||
| 137 | DataSourceFieldName => | ||
| 138 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 139 | IndexFieldName => | ||
| 140 | 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 141 | DateFieldFormat => | ||
| 142 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 143 | }, | ||
| 144 | ... | ||
| 145 | ], # min: 1, max: 100; OPTIONAL | ||
| 146 | }, | ||
| 147 | ConnectionConfiguration => { | ||
| 148 | DatabaseHost => 'MyDatabaseHost', # min: 1, max: 253 | ||
| 149 | DatabaseName => 'MyDatabaseName', # min: 1, max: 100 | ||
| 150 | DatabasePort => 1, # min: 1, max: 65535 | ||
| 151 | SecretArn => 'MySecretArn', # min: 1, max: 1284 | ||
| 152 | TableName => 'MyTableName', # min: 1, max: 100 | ||
| 153 | |||
| 154 | }, | ||
| 155 | DatabaseEngineType => 'RDS_AURORA_MYSQL' | ||
| 156 | , # values: RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL | ||
| 157 | AclConfiguration => { | ||
| 158 | AllowedGroupsColumnName => 'MyColumnName', # min: 1, max: 100 | ||
| 159 | |||
| 160 | }, # OPTIONAL | ||
| 161 | SqlConfiguration => { | ||
| 162 | QueryIdentifiersEnclosingOption => | ||
| 163 | 'DOUBLE_QUOTES', # values: DOUBLE_QUOTES, NONE; OPTIONAL | ||
| 164 | }, # OPTIONAL | ||
| 165 | VpcConfiguration => { | ||
| 166 | SecurityGroupIds => [ | ||
| 167 | 'MyVpcSecurityGroupId', ... # min: 1, max: 200 | ||
| 168 | ], # min: 1, max: 10 | ||
| 169 | SubnetIds => [ | ||
| 170 | 'MySubnetId', ... # min: 1, max: 200 | ||
| 171 | ], # min: 1, max: 6 | ||
| 172 | |||
| 173 | }, # OPTIONAL | ||
| 174 | }, # OPTIONAL | ||
| 175 | GoogleDriveConfiguration => { | ||
| 176 | SecretArn => 'MySecretArn', # min: 1, max: 1284 | ||
| 177 | ExcludeMimeTypes => [ | ||
| 178 | 'MyMimeType', ... # min: 1, max: 256 | ||
| 179 | ], # max: 30; OPTIONAL | ||
| 180 | ExcludeSharedDrives => [ | ||
| 181 | 'MySharedDriveId', ... # min: 1, max: 256 | ||
| 182 | ], # max: 100; OPTIONAL | ||
| 183 | ExcludeUserAccounts => [ | ||
| 184 | 'MyUserAccount', ... # min: 1, max: 256 | ||
| 185 | ], # max: 100; OPTIONAL | ||
| 186 | ExclusionPatterns => [ | ||
| 187 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 188 | ... # min: 1, max: 150 | ||
| 189 | ], # max: 100; OPTIONAL | ||
| 190 | FieldMappings => [ | ||
| 191 | { | ||
| 192 | DataSourceFieldName => 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 193 | IndexFieldName => 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 194 | DateFieldFormat => | ||
| 195 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 196 | }, | ||
| 197 | ... | ||
| 198 | ], # min: 1, max: 100; OPTIONAL | ||
| 199 | InclusionPatterns => [ | ||
| 200 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 201 | ... # min: 1, max: 150 | ||
| 202 | ], # max: 100; OPTIONAL | ||
| 203 | }, # OPTIONAL | ||
| 204 | OneDriveConfiguration => { | ||
| 205 | OneDriveUsers => { | ||
| 206 | OneDriveUserList => [ | ||
| 207 | 'MyOneDriveUser', ... # min: 1, max: 256 | ||
| 208 | ], # min: 1, max: 100; OPTIONAL | ||
| 209 | OneDriveUserS3Path => { | ||
| 210 | Bucket => 'MyS3BucketName', # min: 3, max: 63 | ||
| 211 | Key => 'MyS3ObjectKey', # min: 1, max: 1024 | ||
| 212 | |||
| 213 | }, # OPTIONAL | ||
| 214 | }, | ||
| 215 | SecretArn => 'MySecretArn', # min: 1, max: 1284 | ||
| 216 | TenantDomain => 'MyTenantDomain', # min: 1, max: 256 | ||
| 217 | DisableLocalGroups => 1, # OPTIONAL | ||
| 218 | ExclusionPatterns => [ | ||
| 219 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 220 | ... # min: 1, max: 150 | ||
| 221 | ], # max: 100; OPTIONAL | ||
| 222 | FieldMappings => [ | ||
| 223 | { | ||
| 224 | DataSourceFieldName => 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 225 | IndexFieldName => 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 226 | DateFieldFormat => | ||
| 227 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 228 | }, | ||
| 229 | ... | ||
| 230 | ], # min: 1, max: 100; OPTIONAL | ||
| 231 | InclusionPatterns => [ | ||
| 232 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 233 | ... # min: 1, max: 150 | ||
| 234 | ], # max: 100; OPTIONAL | ||
| 235 | }, # OPTIONAL | ||
| 236 | S3Configuration => { | ||
| 237 | BucketName => 'MyS3BucketName', # min: 3, max: 63 | ||
| 238 | AccessControlListConfiguration => { | ||
| 239 | KeyPath => 'MyS3ObjectKey', # min: 1, max: 1024 | ||
| 240 | }, # OPTIONAL | ||
| 241 | DocumentsMetadataConfiguration => { | ||
| 242 | S3Prefix => 'MyS3ObjectKey', # min: 1, max: 1024 | ||
| 243 | }, # OPTIONAL | ||
| 244 | ExclusionPatterns => [ | ||
| 245 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 246 | ... # min: 1, max: 150 | ||
| 247 | ], # max: 100; OPTIONAL | ||
| 248 | InclusionPatterns => [ | ||
| 249 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 250 | ... # min: 1, max: 150 | ||
| 251 | ], # max: 100; OPTIONAL | ||
| 252 | InclusionPrefixes => [ | ||
| 253 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 254 | ... # min: 1, max: 150 | ||
| 255 | ], # max: 100; OPTIONAL | ||
| 256 | }, # OPTIONAL | ||
| 257 | SalesforceConfiguration => { | ||
| 258 | SecretArn => 'MySecretArn', # min: 1, max: 1284 | ||
| 259 | ServerUrl => 'MyUrl', # min: 1, max: 2048 | ||
| 260 | ChatterFeedConfiguration => { | ||
| 261 | DocumentDataFieldName => 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 262 | DocumentTitleFieldName => | ||
| 263 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 264 | FieldMappings => [ | ||
| 265 | { | ||
| 266 | DataSourceFieldName => | ||
| 267 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 268 | IndexFieldName => | ||
| 269 | 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 270 | DateFieldFormat => | ||
| 271 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 272 | }, | ||
| 273 | ... | ||
| 274 | ], # min: 1, max: 100; OPTIONAL | ||
| 275 | IncludeFilterTypes => [ | ||
| 276 | 'ACTIVE_USER', ... # values: ACTIVE_USER, STANDARD_USER | ||
| 277 | ], # min: 1, max: 2; OPTIONAL | ||
| 278 | }, # OPTIONAL | ||
| 279 | CrawlAttachments => 1, # OPTIONAL | ||
| 280 | ExcludeAttachmentFilePatterns => [ | ||
| 281 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 282 | ... # min: 1, max: 150 | ||
| 283 | ], # max: 100; OPTIONAL | ||
| 284 | IncludeAttachmentFilePatterns => [ | ||
| 285 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 286 | ... # min: 1, max: 150 | ||
| 287 | ], # max: 100; OPTIONAL | ||
| 288 | KnowledgeArticleConfiguration => { | ||
| 289 | IncludedStates => [ | ||
| 290 | 'DRAFT', ... # values: DRAFT, PUBLISHED, ARCHIVED | ||
| 291 | ], # min: 1, max: 3 | ||
| 292 | CustomKnowledgeArticleTypeConfigurations => [ | ||
| 293 | { | ||
| 294 | DocumentDataFieldName => | ||
| 295 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 296 | Name => 'MySalesforceCustomKnowledgeArticleTypeName' | ||
| 297 | , # min: 1, max: 100 | ||
| 298 | DocumentTitleFieldName => | ||
| 299 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 300 | FieldMappings => [ | ||
| 301 | { | ||
| 302 | DataSourceFieldName => | ||
| 303 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 304 | IndexFieldName => | ||
| 305 | 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 306 | DateFieldFormat => | ||
| 307 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 308 | }, | ||
| 309 | ... | ||
| 310 | ], # min: 1, max: 100; OPTIONAL | ||
| 311 | }, | ||
| 312 | ... | ||
| 313 | ], # min: 1, max: 10; OPTIONAL | ||
| 314 | StandardKnowledgeArticleTypeConfiguration => { | ||
| 315 | DocumentDataFieldName => | ||
| 316 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 317 | DocumentTitleFieldName => | ||
| 318 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 319 | FieldMappings => [ | ||
| 320 | { | ||
| 321 | DataSourceFieldName => | ||
| 322 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 323 | IndexFieldName => | ||
| 324 | 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 325 | DateFieldFormat => | ||
| 326 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 327 | }, | ||
| 328 | ... | ||
| 329 | ], # min: 1, max: 100; OPTIONAL | ||
| 330 | }, # OPTIONAL | ||
| 331 | }, # OPTIONAL | ||
| 332 | StandardObjectAttachmentConfiguration => { | ||
| 333 | DocumentTitleFieldName => | ||
| 334 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 335 | FieldMappings => [ | ||
| 336 | { | ||
| 337 | DataSourceFieldName => | ||
| 338 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 339 | IndexFieldName => | ||
| 340 | 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 341 | DateFieldFormat => | ||
| 342 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 343 | }, | ||
| 344 | ... | ||
| 345 | ], # min: 1, max: 100; OPTIONAL | ||
| 346 | }, # OPTIONAL | ||
| 347 | StandardObjectConfigurations => [ | ||
| 348 | { | ||
| 349 | DocumentDataFieldName => | ||
| 350 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 351 | Name => 'ACCOUNT' | ||
| 352 | , # values: ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER | ||
| 353 | DocumentTitleFieldName => | ||
| 354 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 355 | FieldMappings => [ | ||
| 356 | { | ||
| 357 | DataSourceFieldName => | ||
| 358 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 359 | IndexFieldName => | ||
| 360 | 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 361 | DateFieldFormat => | ||
| 362 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 363 | }, | ||
| 364 | ... | ||
| 365 | ], # min: 1, max: 100; OPTIONAL | ||
| 366 | }, | ||
| 367 | ... | ||
| 368 | ], # min: 1, max: 17; OPTIONAL | ||
| 369 | }, # OPTIONAL | ||
| 370 | ServiceNowConfiguration => { | ||
| 371 | HostUrl => 'MyServiceNowHostUrl', # min: 1, max: 2048 | ||
| 372 | SecretArn => 'MySecretArn', # min: 1, max: 1284 | ||
| 373 | ServiceNowBuildVersion => 'LONDON', # values: LONDON, OTHERS | ||
| 374 | AuthenticationType => | ||
| 375 | 'HTTP_BASIC', # values: HTTP_BASIC, OAUTH2; OPTIONAL | ||
| 376 | KnowledgeArticleConfiguration => { | ||
| 377 | DocumentDataFieldName => 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 378 | CrawlAttachments => 1, # OPTIONAL | ||
| 379 | DocumentTitleFieldName => | ||
| 380 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 381 | ExcludeAttachmentFilePatterns => [ | ||
| 382 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 383 | ... # min: 1, max: 150 | ||
| 384 | ], # max: 100; OPTIONAL | ||
| 385 | FieldMappings => [ | ||
| 386 | { | ||
| 387 | DataSourceFieldName => | ||
| 388 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 389 | IndexFieldName => | ||
| 390 | 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 391 | DateFieldFormat => | ||
| 392 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 393 | }, | ||
| 394 | ... | ||
| 395 | ], # min: 1, max: 100; OPTIONAL | ||
| 396 | FilterQuery => 'MyServiceNowKnowledgeArticleFilterQuery' | ||
| 397 | , # min: 1, max: 2048; OPTIONAL | ||
| 398 | IncludeAttachmentFilePatterns => [ | ||
| 399 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 400 | ... # min: 1, max: 150 | ||
| 401 | ], # max: 100; OPTIONAL | ||
| 402 | }, # OPTIONAL | ||
| 403 | ServiceCatalogConfiguration => { | ||
| 404 | DocumentDataFieldName => 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 405 | CrawlAttachments => 1, # OPTIONAL | ||
| 406 | DocumentTitleFieldName => | ||
| 407 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 408 | ExcludeAttachmentFilePatterns => [ | ||
| 409 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 410 | ... # min: 1, max: 150 | ||
| 411 | ], # max: 100; OPTIONAL | ||
| 412 | FieldMappings => [ | ||
| 413 | { | ||
| 414 | DataSourceFieldName => | ||
| 415 | 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 416 | IndexFieldName => | ||
| 417 | 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 418 | DateFieldFormat => | ||
| 419 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 420 | }, | ||
| 421 | ... | ||
| 422 | ], # min: 1, max: 100; OPTIONAL | ||
| 423 | IncludeAttachmentFilePatterns => [ | ||
| 424 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 425 | ... # min: 1, max: 150 | ||
| 426 | ], # max: 100; OPTIONAL | ||
| 427 | }, # OPTIONAL | ||
| 428 | }, # OPTIONAL | ||
| 429 | SharePointConfiguration => { | ||
| 430 | SecretArn => 'MySecretArn', # min: 1, max: 1284 | ||
| 431 | SharePointVersion => 'SHAREPOINT_2013' | ||
| 432 | , # values: SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE | ||
| 433 | Urls => [ | ||
| 434 | 'MyUrl', ... # min: 1, max: 2048 | ||
| 435 | ], # min: 1, max: 100 | ||
| 436 | CrawlAttachments => 1, # OPTIONAL | ||
| 437 | DisableLocalGroups => 1, # OPTIONAL | ||
| 438 | DocumentTitleFieldName => 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 439 | ExclusionPatterns => [ | ||
| 440 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 441 | ... # min: 1, max: 150 | ||
| 442 | ], # max: 100; OPTIONAL | ||
| 443 | FieldMappings => [ | ||
| 444 | { | ||
| 445 | DataSourceFieldName => 'MyDataSourceFieldName', # min: 1, max: 100 | ||
| 446 | IndexFieldName => 'MyIndexFieldName', # min: 1, max: 30; OPTIONAL | ||
| 447 | DateFieldFormat => | ||
| 448 | 'MyDataSourceDateFieldFormat', # min: 4, max: 40; OPTIONAL | ||
| 449 | }, | ||
| 450 | ... | ||
| 451 | ], # min: 1, max: 100; OPTIONAL | ||
| 452 | InclusionPatterns => [ | ||
| 453 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 454 | ... # min: 1, max: 150 | ||
| 455 | ], # max: 100; OPTIONAL | ||
| 456 | SslCertificateS3Path => { | ||
| 457 | Bucket => 'MyS3BucketName', # min: 3, max: 63 | ||
| 458 | Key => 'MyS3ObjectKey', # min: 1, max: 1024 | ||
| 459 | |||
| 460 | }, # OPTIONAL | ||
| 461 | UseChangeLog => 1, # OPTIONAL | ||
| 462 | VpcConfiguration => { | ||
| 463 | SecurityGroupIds => [ | ||
| 464 | 'MyVpcSecurityGroupId', ... # min: 1, max: 200 | ||
| 465 | ], # min: 1, max: 10 | ||
| 466 | SubnetIds => [ | ||
| 467 | 'MySubnetId', ... # min: 1, max: 200 | ||
| 468 | ], # min: 1, max: 6 | ||
| 469 | |||
| 470 | }, # OPTIONAL | ||
| 471 | }, # OPTIONAL | ||
| 472 | WebCrawlerConfiguration => { | ||
| 473 | Urls => { | ||
| 474 | SeedUrlConfiguration => { | ||
| 475 | SeedUrls => [ | ||
| 476 | 'MySeedUrl', ... # min: 1, max: 2048 | ||
| 477 | ], # max: 100 | ||
| 478 | WebCrawlerMode => 'HOST_ONLY' | ||
| 479 | , # values: HOST_ONLY, SUBDOMAINS, EVERYTHING; OPTIONAL | ||
| 480 | }, # OPTIONAL | ||
| 481 | SiteMapsConfiguration => { | ||
| 482 | SiteMaps => [ | ||
| 483 | 'MySiteMap', ... # min: 1, max: 2048 | ||
| 484 | ], # max: 3 | ||
| 485 | |||
| 486 | }, # OPTIONAL | ||
| 487 | }, | ||
| 488 | AuthenticationConfiguration => { | ||
| 489 | BasicAuthentication => [ | ||
| 490 | { | ||
| 491 | Credentials => 'MySecretArn', # min: 1, max: 1284 | ||
| 492 | Host => 'MyHost', # min: 1, max: 253 | ||
| 493 | Port => 1, # min: 1, max: 65535 | ||
| 494 | |||
| 495 | }, | ||
| 496 | ... | ||
| 497 | ], # max: 10; OPTIONAL | ||
| 498 | }, # OPTIONAL | ||
| 499 | CrawlDepth => 1, # max: 10; OPTIONAL | ||
| 500 | MaxContentSizePerPageInMegaBytes => | ||
| 501 | 1.0, # min: 1e-06, max: 50; OPTIONAL | ||
| 502 | MaxLinksPerPage => 1, # min: 1, max: 1000; OPTIONAL | ||
| 503 | MaxUrlsPerMinuteCrawlRate => 1, # min: 1, max: 300; OPTIONAL | ||
| 504 | ProxyConfiguration => { | ||
| 505 | Host => 'MyHost', # min: 1, max: 253 | ||
| 506 | Port => 1, # min: 1, max: 65535 | ||
| 507 | Credentials => 'MySecretArn', # min: 1, max: 1284 | ||
| 508 | }, # OPTIONAL | ||
| 509 | UrlExclusionPatterns => [ | ||
| 510 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 511 | ... # min: 1, max: 150 | ||
| 512 | ], # max: 100; OPTIONAL | ||
| 513 | UrlInclusionPatterns => [ | ||
| 514 | 'MyDataSourceInclusionsExclusionsStringsMember', | ||
| 515 | ... # min: 1, max: 150 | ||
| 516 | ], # max: 100; OPTIONAL | ||
| 517 | }, # OPTIONAL | ||
| 518 | }, # OPTIONAL | ||
| 519 | Description => 'MyDescription', # OPTIONAL | ||
| 520 | RoleArn => 'MyRoleArn', # OPTIONAL | ||
| 521 | Schedule => 'MyScanSchedule', # OPTIONAL | ||
| 522 | Tags => [ | ||
| 523 | { | ||
| 524 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 525 | Value => 'MyTagValue', # max: 256 | ||
| 526 | |||
| 527 | }, | ||
| 528 | ... | ||
| 529 | ], # OPTIONAL | ||
| 530 | ); | ||
| 531 | |||
| 532 | # Results: | ||
| 533 | my $Id = $CreateDataSourceResponse->Id; | ||
| 534 | |||
| 535 | # Returns a L<Paws::Kendra::CreateDataSourceResponse> object. | ||
| 536 | |||
| 537 | 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. | ||
| 538 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra/CreateDataSource> | ||
| 539 | |||
| 540 | =head1 ATTRIBUTES | ||
| 541 | |||
| 542 | |||
| 543 | =head2 ClientToken => Str | ||
| 544 | |||
| 545 | A token that you provide to identify the request to create a data | ||
| 546 | source. Multiple calls to the C<CreateDataSource> operation with the | ||
| 547 | same client token will create only one data source. | ||
| 548 | |||
| 549 | |||
| 550 | |||
| 551 | =head2 Configuration => L<Paws::Kendra::DataSourceConfiguration> | ||
| 552 | |||
| 553 | The connector configuration information that is required to access the | ||
| 554 | repository. | ||
| 555 | |||
| 556 | You can't specify the C<Configuration> parameter when the C<Type> | ||
| 557 | parameter is set to C<CUSTOM>. If you do, you receive a | ||
| 558 | C<ValidationException> exception. | ||
| 559 | |||
| 560 | The C<Configuration> parameter is required for all other data sources. | ||
| 561 | |||
| 562 | |||
| 563 | |||
| 564 | =head2 Description => Str | ||
| 565 | |||
| 566 | A description for the data source. | ||
| 567 | |||
| 568 | |||
| 569 | |||
| 570 | =head2 B<REQUIRED> IndexId => Str | ||
| 571 | |||
| 572 | The identifier of the index that should be associated with this data | ||
| 573 | source. | ||
| 574 | |||
| 575 | |||
| 576 | |||
| 577 | =head2 B<REQUIRED> Name => Str | ||
| 578 | |||
| 579 | A unique name for the data source. A data source name can't be changed | ||
| 580 | without deleting and recreating the data source. | ||
| 581 | |||
| 582 | |||
| 583 | |||
| 584 | =head2 RoleArn => Str | ||
| 585 | |||
| 586 | The Amazon Resource Name (ARN) of a role with permission to access the | ||
| 587 | data source. For more information, see IAM Roles for Amazon Kendra | ||
| 588 | (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html). | ||
| 589 | |||
| 590 | You can't specify the C<RoleArn> parameter when the C<Type> parameter | ||
| 591 | is set to C<CUSTOM>. If you do, you receive a C<ValidationException> | ||
| 592 | exception. | ||
| 593 | |||
| 594 | The C<RoleArn> parameter is required for all other data sources. | ||
| 595 | |||
| 596 | |||
| 597 | |||
| 598 | =head2 Schedule => Str | ||
| 599 | |||
| 600 | Sets the frequency that Amazon Kendra will check the documents in your | ||
| 601 | repository and update the index. If you don't set a schedule Amazon | ||
| 602 | Kendra will not periodically update the index. You can call the | ||
| 603 | C<StartDataSourceSyncJob> operation to update the index. | ||
| 604 | |||
| 605 | You can't specify the C<Schedule> parameter when the C<Type> parameter | ||
| 606 | is set to C<CUSTOM>. If you do, you receive a C<ValidationException> | ||
| 607 | exception. | ||
| 608 | |||
| 609 | |||
| 610 | |||
| 611 | =head2 Tags => ArrayRef[L<Paws::Kendra::Tag>] | ||
| 612 | |||
| 613 | A list of key-value pairs that identify the data source. You can use | ||
| 614 | the tags to identify and organize your resources and to control access | ||
| 615 | to resources. | ||
| 616 | |||
| 617 | |||
| 618 | |||
| 619 | =head2 B<REQUIRED> Type => Str | ||
| 620 | |||
| 621 | The type of repository that contains the data source. | ||
| 622 | |||
| 623 | Valid values are: C<"S3">, C<"SHAREPOINT">, C<"DATABASE">, C<"SALESFORCE">, C<"ONEDRIVE">, C<"SERVICENOW">, C<"CUSTOM">, C<"CONFLUENCE">, C<"GOOGLEDRIVE">, C<"WEBCRAWLER"> | ||
| 624 | |||
| 625 | |||
| 626 | =head1 SEE ALSO | ||
| 627 | |||
| 628 | This class forms part of L<Paws>, documenting arguments for method CreateDataSource in L<Paws::Kendra> | ||
| 629 | |||
| 630 | =head1 BUGS and CONTRIBUTIONS | ||
| 631 | |||
| 632 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 633 | |||
| 634 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 635 | |||
| 636 | =cut | ||
| 637 |