Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DataSync.Types.TaskFilter

Description

Synopsis

data TaskFilter = TaskFilter' {
- name :: TaskFilterName
- values :: [Text]
- operator :: Operator
}
newTaskFilter :: TaskFilterName -> Operator -> TaskFilter
taskFilter_name :: Lens' TaskFilter TaskFilterName
taskFilter_values :: Lens' TaskFilter [Text]
taskFilter_operator :: Lens' TaskFilter Operator

Documentation

data TaskFilter Source #

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.

For more information, see filtering DataSync resources.

See: newTaskFilter smart constructor.

Constructors

TaskFilter'

Fields

name :: TaskFilterName
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.
values :: [Text]
The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.
operator :: Operator
The operator that is used to compare filter values (for example, Equals or Contains).

Instances

Instances details

ToJSON TaskFilter Source #
Instance details Defined in Amazonka.DataSync.Types.TaskFilter Methods toJSON :: TaskFilter -> Value # toEncoding :: TaskFilter -> Encoding # toJSONList :: [TaskFilter] -> Value # toEncodingList :: [TaskFilter] -> Encoding #
Generic TaskFilter Source #
Instance details Defined in Amazonka.DataSync.Types.TaskFilter Associated Types type Rep TaskFilter :: Type -> Type # Methods from :: TaskFilter -> Rep TaskFilter x # to :: Rep TaskFilter x -> TaskFilter #
Read TaskFilter Source #
Instance details Defined in Amazonka.DataSync.Types.TaskFilter Methods readsPrec :: Int -> ReadS TaskFilter # readList :: ReadS [TaskFilter] # readPrec :: ReadPrec TaskFilter # readListPrec :: ReadPrec [TaskFilter] #
Show TaskFilter Source #
Instance details Defined in Amazonka.DataSync.Types.TaskFilter Methods showsPrec :: Int -> TaskFilter -> ShowS # show :: TaskFilter -> String # showList :: [TaskFilter] -> ShowS #
NFData TaskFilter Source #
Instance details Defined in Amazonka.DataSync.Types.TaskFilter Methods rnf :: TaskFilter -> () #
Eq TaskFilter Source #
Instance details Defined in Amazonka.DataSync.Types.TaskFilter Methods (==) :: TaskFilter -> TaskFilter -> Bool # (/=) :: TaskFilter -> TaskFilter -> Bool #
Hashable TaskFilter Source #
Instance details Defined in Amazonka.DataSync.Types.TaskFilter Methods hashWithSalt :: Int -> TaskFilter -> Int # hash :: TaskFilter -> Int #
type Rep TaskFilter Source #
Instance details Defined in Amazonka.DataSync.Types.TaskFilter type Rep TaskFilter = D1 ('MetaData "TaskFilter" "Amazonka.DataSync.Types.TaskFilter" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "TaskFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TaskFilterName) :: (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Operator))))

newTaskFilter Source #

Arguments

:: TaskFilterName	`$sel:name:TaskFilter'`
-> Operator	`$sel:operator:TaskFilter'`
-> TaskFilter

Create a value of TaskFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:TaskFilter', taskFilter_name - 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.

$sel:values:TaskFilter', taskFilter_values - The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.

$sel:operator:TaskFilter', taskFilter_operator - The operator that is used to compare filter values (for example, Equals or Contains).

taskFilter_name :: Lens' TaskFilter TaskFilterName Source #

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.

taskFilter_values :: Lens' TaskFilter [Text] Source #

The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.

taskFilter_operator :: Lens' TaskFilter Operator Source #

The operator that is used to compare filter values (for example, Equals or Contains).