NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $kendra = Paws->service('Kendra');
    my $ListDataSourceSyncJobsResponse = $kendra->ListDataSourceSyncJobs(
      Id              => 'MyDataSourceId',
      IndexId         => 'MyIndexId',
      MaxResults      => 1,                  # OPTIONAL
      NextToken       => 'MyNextToken',      # OPTIONAL
      StartTimeFilter => {
        EndTime   => '1970-01-01T01:00:00',    # OPTIONAL
        StartTime => '1970-01-01T01:00:00',    # OPTIONAL
      },    # OPTIONAL
      StatusFilter => 'FAILED',    # OPTIONAL
    );

    # Results:
    my $History   = $ListDataSourceSyncJobsResponse->History;
    my $NextToken = $ListDataSourceSyncJobsResponse->NextToken;

    # Returns a L<Paws::Kendra::ListDataSourceSyncJobsResponse> 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/ListDataSourceSyncJobs

ATTRIBUTES

REQUIRED Id => Str

The identifier of the data source.

REQUIRED IndexId => Str

The identifier of the index that contains the data source.

MaxResults => Int

The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

NextToken => Str

If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the NextToken to fetch the next set of jobs.

StartTimeFilter => Paws::Kendra::TimeRange

When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.

StatusFilter => Str

When specified, only returns synchronization jobs with the Status field equal to the specified status.

Valid values are: "FAILED", "SUCCEEDED", "SYNCING", "INCOMPLETE", "STOPPING", "ABORTED", "SYNCING_INDEXING"

SEE ALSO

This class forms part of Paws, documenting arguments for method ListDataSourceSyncJobs 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