libZSservicesZSamazonka-datasyncZSamazonka-datasync
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data ListLocations Source #

ListLocationsRequest

See: newListLocations smart constructor.

Constructors

ListLocations' 

Fields

  • filters :: Maybe [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.

  • nextToken :: Maybe Text

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

  • maxResults :: Maybe Natural

    The maximum number of locations to return.

Instances

Instances details
Eq ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

Read ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

Show ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

Generic ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

Associated Types

type Rep ListLocations :: Type -> Type #

NFData ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

Methods

rnf :: ListLocations -> () #

Hashable ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

ToJSON ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

AWSPager ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

AWSRequest ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

Associated Types

type AWSResponse ListLocations #

ToHeaders ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

ToPath ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

ToQuery ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

type Rep ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

type Rep ListLocations = D1 ('MetaData "ListLocations" "Amazonka.DataSync.ListLocations" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "ListLocations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LocationFilter])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListLocations Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

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:nextToken:ListLocations', listLocations_nextToken - An opaque string that indicates the position at which to begin the next list of locations.

$sel:maxResults:ListLocations', listLocations_maxResults - The maximum number of locations to return.

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_nextToken :: Lens' ListLocations (Maybe Text) Source #

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

listLocations_maxResults :: Lens' ListLocations (Maybe Natural) Source #

The maximum number of locations to return.

Destructuring the Response

data ListLocationsResponse Source #

ListLocationsResponse

See: newListLocationsResponse smart constructor.

Constructors

ListLocationsResponse' 

Fields

Instances

Instances details
Eq ListLocationsResponse Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

Read ListLocationsResponse Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

Show ListLocationsResponse Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

Generic ListLocationsResponse Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

Associated Types

type Rep ListLocationsResponse :: Type -> Type #

NFData ListLocationsResponse Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

Methods

rnf :: ListLocationsResponse -> () #

type Rep ListLocationsResponse Source # 
Instance details

Defined in Amazonka.DataSync.ListLocations

type Rep ListLocationsResponse = D1 ('MetaData "ListLocationsResponse" "Amazonka.DataSync.ListLocations" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "ListLocationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "locations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LocationListEntry])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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:nextToken:ListLocations', listLocationsResponse_nextToken - An opaque string that indicates the position at which to begin returning the next list of locations.

$sel:locations:ListLocationsResponse', listLocationsResponse_locations - An array that contains a list of locations.

$sel:httpStatus:ListLocationsResponse', listLocationsResponse_httpStatus - The response's http status code.

Response Lenses

listLocationsResponse_nextToken :: Lens' ListLocationsResponse (Maybe Text) Source #

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