« blib/lib/Paws/Kendra/DescribeIndex.pm
↑ Summary
blib/lib/Paws/Kendra/DescribeQuerySuggestionsBlockList.pm »
| 1 | |||
| 2 | package Paws::Kendra::DescribeIndexResponse; | ||
| 3 | use Moose; | ||
| 4 | has CapacityUnits => (is => 'ro', isa => 'Paws::Kendra::CapacityUnitsConfiguration'); | ||
| 5 | has CreatedAt => (is => 'ro', isa => 'Str'); | ||
| 6 | has Description => (is => 'ro', isa => 'Str'); | ||
| 7 | has DocumentMetadataConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::DocumentMetadataConfiguration]'); | ||
| 8 | has Edition => (is => 'ro', isa => 'Str'); | ||
| 9 | has ErrorMessage => (is => 'ro', isa => 'Str'); | ||
| 10 | has Id => (is => 'ro', isa => 'Str'); | ||
| 11 | has IndexStatistics => (is => 'ro', isa => 'Paws::Kendra::IndexStatistics'); | ||
| 12 | has Name => (is => 'ro', isa => 'Str'); | ||
| 13 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 14 | has ServerSideEncryptionConfiguration => (is => 'ro', isa => 'Paws::Kendra::ServerSideEncryptionConfiguration'); | ||
| 15 | has Status => (is => 'ro', isa => 'Str'); | ||
| 16 | has UpdatedAt => (is => 'ro', isa => 'Str'); | ||
| 17 | has UserContextPolicy => (is => 'ro', isa => 'Str'); | ||
| 18 | has UserTokenConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::UserTokenConfiguration]'); | ||
| 19 | |||
| 20 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::Kendra::DescribeIndexResponse | ||
| 27 | |||
| 28 | =head1 ATTRIBUTES | ||
| 29 | |||
| 30 | |||
| 31 | =head2 CapacityUnits => L<Paws::Kendra::CapacityUnitsConfiguration> | ||
| 32 | |||
| 33 | For Enterprise edition indexes, you can choose to use additional | ||
| 34 | capacity to meet the needs of your application. This contains the | ||
| 35 | capacity units used for the index. A 0 for the query capacity or the | ||
| 36 | storage capacity indicates that the index is using the default capacity | ||
| 37 | for the index. | ||
| 38 | |||
| 39 | |||
| 40 | =head2 CreatedAt => Str | ||
| 41 | |||
| 42 | The Unix datetime that the index was created. | ||
| 43 | |||
| 44 | |||
| 45 | =head2 Description => Str | ||
| 46 | |||
| 47 | The description of the index. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 DocumentMetadataConfigurations => ArrayRef[L<Paws::Kendra::DocumentMetadataConfiguration>] | ||
| 51 | |||
| 52 | Configuration settings for any metadata applied to the documents in the | ||
| 53 | index. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 Edition => Str | ||
| 57 | |||
| 58 | The Amazon Kendra edition used for the index. You decide the edition | ||
| 59 | when you create the index. | ||
| 60 | |||
| 61 | Valid values are: C<"DEVELOPER_EDITION">, C<"ENTERPRISE_EDITION"> | ||
| 62 | =head2 ErrorMessage => Str | ||
| 63 | |||
| 64 | When th eC<Status> field value is C<FAILED>, the C<ErrorMessage> field | ||
| 65 | contains a message that explains why. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Id => Str | ||
| 69 | |||
| 70 | The name of the index. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 IndexStatistics => L<Paws::Kendra::IndexStatistics> | ||
| 74 | |||
| 75 | Provides information about the number of FAQ questions and answers and | ||
| 76 | the number of text documents indexed. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 Name => Str | ||
| 80 | |||
| 81 | The name of the index. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 RoleArn => Str | ||
| 85 | |||
| 86 | The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra | ||
| 87 | permission to write to your Amazon Cloudwatch logs. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 ServerSideEncryptionConfiguration => L<Paws::Kendra::ServerSideEncryptionConfiguration> | ||
| 91 | |||
| 92 | The identifier of the AWS KMS customer master key (CMK) used to encrypt | ||
| 93 | your data. Amazon Kendra doesn't support asymmetric CMKs. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 Status => Str | ||
| 97 | |||
| 98 | The current status of the index. When the value is C<ACTIVE>, the index | ||
| 99 | is ready for use. If the C<Status> field value is C<FAILED>, the | ||
| 100 | C<ErrorMessage> field contains a message that explains why. | ||
| 101 | |||
| 102 | Valid values are: C<"CREATING">, C<"ACTIVE">, C<"DELETING">, C<"FAILED">, C<"UPDATING">, C<"SYSTEM_UPDATING"> | ||
| 103 | =head2 UpdatedAt => Str | ||
| 104 | |||
| 105 | The Unix datetime that the index was last updated. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 UserContextPolicy => Str | ||
| 109 | |||
| 110 | The user context policy for the Amazon Kendra index. | ||
| 111 | |||
| 112 | Valid values are: C<"ATTRIBUTE_FILTER">, C<"USER_TOKEN"> | ||
| 113 | =head2 UserTokenConfigurations => ArrayRef[L<Paws::Kendra::UserTokenConfiguration>] | ||
| 114 | |||
| 115 | The user token configuration for the Amazon Kendra index. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 _request_id => Str | ||
| 119 | |||
| 120 | |||
| 121 | =cut | ||
| 122 | |||
| 123 | 1; |