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

Class: Aws::DataSync::Types::LocationFilter

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

Overview

Note:

When passing LocationFilter as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "LocationUri", # required, accepts LocationUri, LocationType, CreationTime
  values: ["FilterAttributeValue"], # required
  operator: "Equals", # required, accepts Equals, NotEquals, In, LessThanOrEqual, LessThan, GreaterThanOrEqual, GreaterThan, Contains, NotContains, BeginsWith
}

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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

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

Possible values:

  • LocationUri
  • LocationType
  • CreationTime

Returns:

  • (String) —

    The name of the filter being used.

#operator ⇒ String

The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see query-resources.

Possible values:

  • Equals
  • NotEquals
  • In
  • LessThanOrEqual
  • LessThan
  • GreaterThanOrEqual
  • GreaterThan
  • Contains
  • NotContains
  • BeginsWith

Returns:

  • (String) —

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

#values ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    The values that you want to filter for.