| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.DataSync.ListLocations
Description
Returns a list of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
This operation returns paginated results.
Synopsis
- data ListLocations = ListLocations' {
- filters :: Maybe [LocationFilter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- newListLocations :: ListLocations
- listLocations_filters :: Lens' ListLocations (Maybe [LocationFilter])
- listLocations_maxResults :: Lens' ListLocations (Maybe Natural)
- listLocations_nextToken :: Lens' ListLocations (Maybe Text)
- data ListLocationsResponse = ListLocationsResponse' {
- locations :: Maybe [LocationListEntry]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListLocationsResponse :: Int -> ListLocationsResponse
- listLocationsResponse_locations :: Lens' ListLocationsResponse (Maybe [LocationListEntry])
- listLocationsResponse_nextToken :: Lens' ListLocationsResponse (Maybe Text)
- listLocationsResponse_httpStatus :: Lens' ListLocationsResponse Int
Creating a Request
data ListLocations Source #
ListLocationsRequest
See: newListLocations smart constructor.
Constructors
| ListLocations' | |
Fields
| |
Instances
newListLocations :: ListLocations Source #
Create a value of ListLocations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListLocations', listLocations_filters - 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.
$sel:maxResults:ListLocations', listLocations_maxResults - The maximum number of locations to return.
ListLocations, listLocations_nextToken - An opaque string that indicates the position at which to begin the next
list of locations.
Request Lenses
listLocations_filters :: Lens' ListLocations (Maybe [LocationFilter]) Source #
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.
listLocations_maxResults :: Lens' ListLocations (Maybe Natural) Source #
The maximum number of locations to return.
listLocations_nextToken :: Lens' ListLocations (Maybe Text) Source #
An opaque string that indicates the position at which to begin the next list of locations.
Destructuring the Response
data ListLocationsResponse Source #
ListLocationsResponse
See: newListLocationsResponse smart constructor.
Constructors
| ListLocationsResponse' | |
Fields
| |
Instances
newListLocationsResponse Source #
Create a value of ListLocationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:locations:ListLocationsResponse', listLocationsResponse_locations - An array that contains a list of locations.
ListLocations, listLocationsResponse_nextToken - An opaque string that indicates the position at which to begin returning
the next list of locations.
$sel:httpStatus:ListLocationsResponse', listLocationsResponse_httpStatus - The response's http status code.
Response Lenses
listLocationsResponse_locations :: Lens' ListLocationsResponse (Maybe [LocationListEntry]) Source #
An array that contains a list of locations.
listLocationsResponse_nextToken :: Lens' ListLocationsResponse (Maybe Text) Source #
An opaque string that indicates the position at which to begin returning the next list of locations.
listLocationsResponse_httpStatus :: Lens' ListLocationsResponse Int Source #
The response's http status code.