You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::DataSync::Types::TaskFilter
- Inherits:
-
Struct
- Object
- Struct
- Aws::DataSync::Types::TaskFilter
- Defined in:
- (unknown)
Overview
When passing TaskFilter as input to an Aws::Client method, you can use a vanilla Hash:
{
name: "LocationId", # required, accepts LocationId, CreationTime
values: ["FilterAttributeValue"], # required
operator: "Equals", # required, accepts Equals, NotEquals, In, LessThanOrEqual, LessThan, GreaterThanOrEqual, GreaterThan, Contains, NotContains, BeginsWith
}
You can use API filters to narrow down the list of resources returned by ListTasks
. For example, to retrieve all tasks on a source location, you can use ListTasks
with filter name LocationId
and Operator Equals
with the ARN for the location.
Instance Attribute Summary collapse
-
#name ⇒ String
The name of the filter being used.
-
#operator ⇒ String
The operator that is used to compare filter values (for example,
Equals
orContains
). -
#values ⇒ Array<String>
The values that you want to filter for.
Instance Attribute Details
#name ⇒ String
The name of the filter being used. Each API call supports a list of
filters that are available for it. For example, LocationId
for
ListTasks
.
Possible values:
- LocationId
- CreationTime
#operator ⇒ String
The operator that is used to compare filter values (for example,
Equals
or Contains
). For more about API filtering operators, see
query-resources.
Possible values:
- Equals
- NotEquals
- In
- LessThanOrEqual
- LessThan
- GreaterThanOrEqual
- GreaterThan
- Contains
- NotContains
- BeginsWith
#values ⇒ Array<String>
The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.