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

Inherits:

Struct

• Object
• Struct
• Aws::DataSync::Types::ListLocationsRequest

Defined in:

gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb

Overview

ListLocationsRequest

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Array<Types::LocationFilter>

  You can use API filters to narrow down the list of resources returned by ListLocations.

• #max_results ⇒ Integer

  The maximum number of locations to return.

• #next_token ⇒ String

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

Instance Attribute Details

#filters ⇒ Array<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:

• (Array<Types::LocationFilter>)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3396

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

#max_results ⇒ Integer

The maximum number of locations to return.

Returns:

• (Integer)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3396

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

#next_token ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3396

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