« blib/lib/Paws/Kendra/BatchDeleteDocumentResponseFailedDocument.pm
↑ Summary
blib/lib/Paws/Kendra/BatchGetDocumentStatusResponse.pm »
| 1 | |||
| 2 | package Paws::Kendra::BatchGetDocumentStatus; | ||
| 3 | use Moose; | ||
| 4 | has DocumentInfoList => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::DocumentInfo]', required => 1); | ||
| 5 | has IndexId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'BatchGetDocumentStatus'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Kendra::BatchGetDocumentStatusResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Kendra::BatchGetDocumentStatus - Arguments for method BatchGetDocumentStatus on L<Paws::Kendra> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method BatchGetDocumentStatus on the | ||
| 23 | L<AWSKendraFrontendService|Paws::Kendra> service. Use the attributes of this class | ||
| 24 | as arguments to method BatchGetDocumentStatus. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchGetDocumentStatus. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $kendra = Paws->service('Kendra'); | ||
| 31 | my $BatchGetDocumentStatusResponse = $kendra->BatchGetDocumentStatus( | ||
| 32 | DocumentInfoList => [ | ||
| 33 | { | ||
| 34 | DocumentId => 'MyDocumentId', # min: 1, max: 2048 | ||
| 35 | Attributes => [ | ||
| 36 | { | ||
| 37 | Key => 'MyDocumentAttributeKey', # min: 1, max: 200 | ||
| 38 | Value => { | ||
| 39 | DateValue => '1970-01-01T01:00:00', # OPTIONAL | ||
| 40 | LongValue => 1, # OPTIONAL | ||
| 41 | StringListValue => [ | ||
| 42 | 'MyString', ... # min: 1, max: 2048 | ||
| 43 | ], # OPTIONAL | ||
| 44 | StringValue => 'MyDocumentAttributeStringValue' | ||
| 45 | , # min: 1, max: 2048; OPTIONAL | ||
| 46 | }, | ||
| 47 | |||
| 48 | }, | ||
| 49 | ... | ||
| 50 | ], # OPTIONAL | ||
| 51 | }, | ||
| 52 | ... | ||
| 53 | ], | ||
| 54 | IndexId => 'MyIndexId', | ||
| 55 | |||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $DocumentStatusList = | ||
| 60 | $BatchGetDocumentStatusResponse->DocumentStatusList; | ||
| 61 | my $Errors = $BatchGetDocumentStatusResponse->Errors; | ||
| 62 | |||
| 63 | # Returns a L<Paws::Kendra::BatchGetDocumentStatusResponse> object. | ||
| 64 | |||
| 65 | 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. | ||
| 66 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kendra/BatchGetDocumentStatus> | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> DocumentInfoList => ArrayRef[L<Paws::Kendra::DocumentInfo>] | ||
| 72 | |||
| 73 | A list of C<DocumentInfo> objects that identify the documents for which | ||
| 74 | to get the status. You identify the documents by their document ID and | ||
| 75 | optional attributes. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> IndexId => Str | ||
| 80 | |||
| 81 | The identifier of the index to add documents to. The index ID is | ||
| 82 | returned by the CreateIndex | ||
| 83 | (https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html) | ||
| 84 | operation. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, documenting arguments for method BatchGetDocumentStatus in L<Paws::Kendra> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |