Class: Aws::FSx::Types::DataRepositoryTaskFilter

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

Note:

When making an API call, you may pass DataRepositoryTaskFilter data as a hash:

{
  name: "file-system-id", # accepts file-system-id, task-lifecycle
  values: ["DataRepositoryTaskFilterValue"],
}

(Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter Name, and one or more Values for the filter.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

Name of the task property to use in filtering the tasks returned in the response.

  • Use file-system-id to retrieve data repository tasks for specific file systems.

  • Use task-lifecycle to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.

Returns:

  • (String)


1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1771

class DataRepositoryTaskFilter < Struct.new(
  :name,
  :values)
  SENSITIVE = []
  include Aws::Structure
end

#valuesArray<String>

Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.

Returns:

  • (Array<String>)


1771
1772
1773
1774
1775
1776
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1771

class DataRepositoryTaskFilter < Struct.new(
  :name,
  :values)
  SENSITIVE = []
  include Aws::Structure
end