Class: Aws::DataSync::Types::ListLocationsRequest

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 ListLocationsRequest data as a hash:

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

ListLocationsRequest

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::LocationFilter>

You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all tasks on a specific source location, you can use ListLocations with filter name LocationType S3 and Operator Equals.

Returns:



2872
2873
2874
2875
2876
2877
2878
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2872

class ListLocationsRequest < Struct.new(
  :max_results,
  :next_token,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of locations to return.

Returns:

  • (Integer)


2872
2873
2874
2875
2876
2877
2878
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2872

class ListLocationsRequest < Struct.new(
  :max_results,
  :next_token,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

An opaque string that indicates the position at which to begin the next list of locations.

Returns:

  • (String)


2872
2873
2874
2875
2876
2877
2878
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 2872

class ListLocationsRequest < Struct.new(
  :max_results,
  :next_token,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end