The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::Kendra::BatchDeleteDocument - Arguments for method BatchDeleteDocument on Paws::Kendra

DESCRIPTION

This class represents the parameters used for calling the method BatchDeleteDocument on the AWSKendraFrontendService service. Use the attributes of this class as arguments to method BatchDeleteDocument.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to BatchDeleteDocument.

SYNOPSIS

    my $kendra = Paws->service('Kendra');
    my $BatchDeleteDocumentResponse = $kendra->BatchDeleteDocument(
      DocumentIdList => [
        'MyDocumentId', ...    # min: 1, max: 2048
      ],
      IndexId                       => 'MyIndexId',
      DataSourceSyncJobMetricTarget => {
        DataSourceId        => 'MyDataSourceId',    # min: 1, max: 100
        DataSourceSyncJobId =>
          'MyDataSourceSyncJobId',                  # min: 1, max: 100; OPTIONAL
      },    # OPTIONAL
    );

    # Results:
    my $FailedDocuments = $BatchDeleteDocumentResponse->FailedDocuments;

    # Returns a L<Paws::Kendra::BatchDeleteDocumentResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kendra/BatchDeleteDocument

ATTRIBUTES

DataSourceSyncJobMetricTarget => Paws::Kendra::DataSourceSyncJobMetricTarget

REQUIRED DocumentIdList => ArrayRef[Str|Undef]

One or more identifiers for documents to delete from the index.

REQUIRED IndexId => Str

The identifier of the index that contains the documents to delete.

SEE ALSO

This class forms part of Paws, documenting arguments for method BatchDeleteDocument in Paws::Kendra

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues