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

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

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

Overview

Note:

When passing DataRepositoryTaskFilter as input to an Aws::Client method, you can use a vanilla 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.

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.

    Possible values:

    • file-system-id
    • task-lifecycle

Returns:

  • (String)

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

#valuesArray<String>

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

Returns:

  • (Array<String>)

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