AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DataSync::Types::ListTasksRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListTasksRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      name: "LocationId", # required, accepts LocationId, CreationTime
      values: ["FilterAttributeValue"], # required
      operator: "Equals", # required, accepts Equals, NotEquals, In, LessThanOrEqual, LessThan, GreaterThanOrEqual, GreaterThan, Contains, NotContains, BeginsWith
    },
  ],
}

ListTasksRequest

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::TaskFilter>

You can use API filters to narrow down the list of resources returned by ListTasks. For example, to retrieve all tasks on a specific source location, you can use ListTasks with filter name LocationId and Operator Equals with the ARN for the location.

Returns:

  • (Array<Types::TaskFilter>)

    You can use API filters to narrow down the list of resources returned by ListTasks.

#max_resultsInteger

The maximum number of tasks to return.

Returns:

  • (Integer)

    The maximum number of tasks to return.

#next_tokenString

An opaque string that indicates the position at which to begin the next list of tasks.

Returns:

  • (String)

    An opaque string that indicates the position at which to begin the next list of tasks.