LocationFilter - AWS DataSync

LocationFilter

You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all your Amazon S3 locations, you can use ListLocations with filter name LocationType S3 and Operator Equals.

Contents

Name

The name of the filter being used. Each API call supports a list of filters that are available for it (for example, LocationType for ListLocations).

Type: String

Valid Values: LocationUri | LocationType | CreationTime

Required: Yes

Operator

The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see API filters for ListTasks and ListLocations.

Type: String

Valid Values: Equals | NotEquals | In | LessThanOrEqual | LessThan | GreaterThanOrEqual | GreaterThan | Contains | NotContains | BeginsWith

Required: Yes

Values

The values that you want to filter for. For example, you might want to display only Amazon S3 locations.

Type: Array of strings

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

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

Required: Yes

See Also

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