DataRepositoryTaskFilter - Amazon FSx
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DataRepositoryTaskFilter

(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.

Contents

Name

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.

Type: String

Valid Values: file-system-id | task-lifecycle | data-repository-association-id | file-cache-id

Required: No

Values

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

Type: Array of strings

Array Members: Maximum number of 20 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[0-9a-zA-Z\*\.\\/\?\-\_]*$

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: