| 1 | |||
| 2 | package Paws::Kendra::CreateIndex; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has Edition => (is => 'ro', isa => 'Str'); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has ServerSideEncryptionConfiguration => (is => 'ro', isa => 'Paws::Kendra::ServerSideEncryptionConfiguration'); | ||
| 10 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::Tag]'); | ||
| 11 | has UserContextPolicy => (is => 'ro', isa => 'Str'); | ||
| 12 | has UserTokenConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::UserTokenConfiguration]'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateIndex'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kendra::CreateIndexResponse'); | ||
| 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::CreateIndex - Arguments for method CreateIndex on L<Paws::Kendra> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateIndex on the | ||
| 30 | L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateIndex. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateIndex. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $kendra = Paws->service('Kendra'); | ||
| 38 | my $CreateIndexResponse = $kendra->CreateIndex( | ||
| 39 | Name => 'MyIndexName', | ||
| 40 | RoleArn => 'MyRoleArn', | ||
| 41 | ClientToken => 'MyClientTokenName', # OPTIONAL | ||
| 42 | Description => 'MyDescription', # OPTIONAL | ||
| 43 | Edition => 'DEVELOPER_EDITION', # OPTIONAL | ||
| 44 | ServerSideEncryptionConfiguration => { | ||
| 45 | KmsKeyId => 'MyKmsKeyId', # min: 1, max: 2048; OPTIONAL | ||
| 46 | }, # OPTIONAL | ||
| 47 | Tags => [ | ||
| 48 | { | ||
| 49 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 50 | Value => 'MyTagValue', # max: 256 | ||
| 51 | |||
| 52 | }, | ||
| 53 | ... | ||
| 54 | ], # OPTIONAL | ||
| 55 | UserContextPolicy => 'ATTRIBUTE_FILTER', # OPTIONAL | ||
| 56 | UserTokenConfigurations => [ | ||
| 57 | { | ||
| 58 | JsonTokenTypeConfiguration => { | ||
| 59 | GroupAttributeField => 'MyString', # min: 1, max: 2048 | ||
| 60 | UserNameAttributeField => 'MyString', # min: 1, max: 2048 | ||
| 61 | |||
| 62 | }, # OPTIONAL | ||
| 63 | JwtTokenTypeConfiguration => { | ||
| 64 | KeyLocation => 'URL', # values: URL, SECRET_MANAGER | ||
| 65 | ClaimRegex => 'MyClaimRegex', # min: 1, max: 100; OPTIONAL | ||
| 66 | GroupAttributeField => | ||
| 67 | 'MyGroupAttributeField', # min: 1, max: 100; OPTIONAL | ||
| 68 | Issuer => 'MyIssuer', # min: 1, max: 65; OPTIONAL | ||
| 69 | SecretManagerArn => 'MyRoleArn', # min: 1, max: 1284 | ||
| 70 | URL => 'MyUrl', # min: 1, max: 2048; OPTIONAL | ||
| 71 | UserNameAttributeField => | ||
| 72 | 'MyUserNameAttributeField', # min: 1, max: 100; OPTIONAL | ||
| 73 | }, # OPTIONAL | ||
| 74 | }, | ||
| 75 | ... | ||
| 76 | ], # OPTIONAL | ||
| 77 | ); | ||
| 78 | |||
| 79 | # Results: | ||
| 80 | my $Id = $CreateIndexResponse->Id; | ||
| 81 | |||
| 82 | # Returns a L<Paws::Kendra::CreateIndexResponse> object. | ||
| 83 | |||
| 84 | 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. | ||
| 85 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra/CreateIndex> | ||
| 86 | |||
| 87 | =head1 ATTRIBUTES | ||
| 88 | |||
| 89 | |||
| 90 | =head2 ClientToken => Str | ||
| 91 | |||
| 92 | A token that you provide to identify the request to create an index. | ||
| 93 | Multiple calls to the C<CreateIndex> operation with the same client | ||
| 94 | token will create only one index. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 Description => Str | ||
| 99 | |||
| 100 | A description for the index. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 Edition => Str | ||
| 105 | |||
| 106 | The Amazon Kendra edition to use for the index. Choose | ||
| 107 | C<DEVELOPER_EDITION> for indexes intended for development, testing, or | ||
| 108 | proof of concept. Use C<ENTERPRISE_EDITION> for your production | ||
| 109 | databases. Once you set the edition for an index, it can't be changed. | ||
| 110 | |||
| 111 | The C<Edition> parameter is optional. If you don't supply a value, the | ||
| 112 | default is C<ENTERPRISE_EDITION>. | ||
| 113 | |||
| 114 | For more information on quota limits for enterprise and developer | ||
| 115 | editions, see Quotas | ||
| 116 | (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html). | ||
| 117 | |||
| 118 | Valid values are: C<"DEVELOPER_EDITION">, C<"ENTERPRISE_EDITION"> | ||
| 119 | |||
| 120 | =head2 B<REQUIRED> Name => Str | ||
| 121 | |||
| 122 | The name for the new index. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 B<REQUIRED> RoleArn => Str | ||
| 127 | |||
| 128 | An AWS Identity and Access Management (IAM) role that gives Amazon | ||
| 129 | Kendra permissions to access your Amazon CloudWatch logs and metrics. | ||
| 130 | This is also the role used when you use the C<BatchPutDocument> | ||
| 131 | operation to index documents from an Amazon S3 bucket. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 ServerSideEncryptionConfiguration => L<Paws::Kendra::ServerSideEncryptionConfiguration> | ||
| 136 | |||
| 137 | The identifier of the AWS KMS customer managed key (CMK) to use to | ||
| 138 | encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support | ||
| 139 | asymmetric CMKs. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 Tags => ArrayRef[L<Paws::Kendra::Tag>] | ||
| 144 | |||
| 145 | A list of key-value pairs that identify the index. You can use the tags | ||
| 146 | to identify and organize your resources and to control access to | ||
| 147 | resources. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head2 UserContextPolicy => Str | ||
| 152 | |||
| 153 | The user context policy. | ||
| 154 | |||
| 155 | =over | ||
| 156 | |||
| 157 | =item ATTRIBUTE_FILTER | ||
| 158 | |||
| 159 | All indexed content is searchable and displayable for all users. If | ||
| 160 | there is an access control list, it is ignored. You can filter on user | ||
| 161 | and group attributes. | ||
| 162 | |||
| 163 | =item USER_TOKEN | ||
| 164 | |||
| 165 | Enables SSO and token-based user access control. All documents with no | ||
| 166 | access control and all documents accessible to the user will be | ||
| 167 | searchable and displayable. | ||
| 168 | |||
| 169 | =back | ||
| 170 | |||
| 171 | |||
| 172 | Valid values are: C<"ATTRIBUTE_FILTER">, C<"USER_TOKEN"> | ||
| 173 | |||
| 174 | =head2 UserTokenConfigurations => ArrayRef[L<Paws::Kendra::UserTokenConfiguration>] | ||
| 175 | |||
| 176 | The user token configuration. | ||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head1 SEE ALSO | ||
| 182 | |||
| 183 | This class forms part of L<Paws>, documenting arguments for method CreateIndex in L<Paws::Kendra> | ||
| 184 | |||
| 185 | =head1 BUGS and CONTRIBUTIONS | ||
| 186 | |||
| 187 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 188 | |||
| 189 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 190 | |||
| 191 | =cut | ||
| 192 |