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

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

Overview

Note:

When making an API call, you may pass LocationFilter data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

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

Returns:

  • (String)


2514
2515
2516
2517
2518
2519
2520
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2514

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

#operatorString

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.

Returns:

  • (String)


2514
2515
2516
2517
2518
2519
2520
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2514

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

#valuesArray<String>

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

Returns:

  • (Array<String>)


2514
2515
2516
2517
2518
2519
2520
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2514

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