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.Outposts.ListSites

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the Outpost sites for your Amazon Web Services account. Use filters to return specific results.

Use filters to return specific results. If you specify multiple filters, the results include only the resources that match all of the specified filters. For a filter where you can specify multiple values, the results include items that match any of the values that you specify for the filter.

Synopsis

data ListSites = ListSites' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- operatingAddressCityFilter :: Maybe [Text]
- operatingAddressCountryCodeFilter :: Maybe [Text]
- operatingAddressStateOrRegionFilter :: Maybe [Text]
}
newListSites :: ListSites
listSites_maxResults :: Lens' ListSites (Maybe Natural)
listSites_nextToken :: Lens' ListSites (Maybe Text)
listSites_operatingAddressCityFilter :: Lens' ListSites (Maybe [Text])
listSites_operatingAddressCountryCodeFilter :: Lens' ListSites (Maybe [Text])
listSites_operatingAddressStateOrRegionFilter :: Lens' ListSites (Maybe [Text])
data ListSitesResponse = ListSitesResponse' {
- nextToken :: Maybe Text
- sites :: Maybe [Site]
- httpStatus :: Int
}
newListSitesResponse :: Int -> ListSitesResponse
listSitesResponse_nextToken :: Lens' ListSitesResponse (Maybe Text)
listSitesResponse_sites :: Lens' ListSitesResponse (Maybe [Site])
listSitesResponse_httpStatus :: Lens' ListSitesResponse Int

Creating a Request

data ListSites Source #

See: newListSites smart constructor.

Constructors

ListSites'
Fields maxResults :: Maybe Natural nextToken :: Maybe Text operatingAddressCityFilter :: Maybe [Text] Filters the results by city. operatingAddressCountryCodeFilter :: Maybe [Text] Filters the results by country code. operatingAddressStateOrRegionFilter :: Maybe [Text] Filters the results by state or region.

Instances

Instances details

ToHeaders ListSites Source #
Instance details Defined in Amazonka.Outposts.ListSites Methods toHeaders :: ListSites -> [Header] #
ToPath ListSites Source #
Instance details Defined in Amazonka.Outposts.ListSites Methods toPath :: ListSites -> ByteString #
ToQuery ListSites Source #
Instance details Defined in Amazonka.Outposts.ListSites Methods toQuery :: ListSites -> QueryString #
AWSRequest ListSites Source #
Instance details Defined in Amazonka.Outposts.ListSites Associated Types type AWSResponse ListSites # Methods request :: (Service -> Service) -> ListSites -> Request ListSites # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSites -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSites))) #
Generic ListSites Source #
Instance details Defined in Amazonka.Outposts.ListSites Associated Types type Rep ListSites :: Type -> Type # Methods from :: ListSites -> Rep ListSites x # to :: Rep ListSites x -> ListSites #
Read ListSites Source #
Instance details Defined in Amazonka.Outposts.ListSites Methods readsPrec :: Int -> ReadS ListSites # readList :: ReadS [ListSites] # readPrec :: ReadPrec ListSites # readListPrec :: ReadPrec [ListSites] #
Show ListSites Source #
Instance details Defined in Amazonka.Outposts.ListSites Methods showsPrec :: Int -> ListSites -> ShowS # show :: ListSites -> String # showList :: [ListSites] -> ShowS #
NFData ListSites Source #
Instance details Defined in Amazonka.Outposts.ListSites Methods rnf :: ListSites -> () #
Eq ListSites Source #
Instance details Defined in Amazonka.Outposts.ListSites Methods (==) :: ListSites -> ListSites -> Bool # (/=) :: ListSites -> ListSites -> Bool #
Hashable ListSites Source #
Instance details Defined in Amazonka.Outposts.ListSites Methods hashWithSalt :: Int -> ListSites -> Int # hash :: ListSites -> Int #
type AWSResponse ListSites Source #
Instance details Defined in Amazonka.Outposts.ListSites type AWSResponse ListSites = ListSitesResponse
type Rep ListSites Source #
Instance details Defined in Amazonka.Outposts.ListSites type Rep ListSites = D1 ('MetaData "ListSites" "Amazonka.Outposts.ListSites" "amazonka-outposts-2.0-7IMF8shlTNW2uMOjzEu2r2" 'False) (C1 ('MetaCons "ListSites'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "operatingAddressCityFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "operatingAddressCountryCodeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "operatingAddressStateOrRegionFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newListSites :: ListSites Source #

Create a value of ListSites 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:maxResults:ListSites', listSites_maxResults - Undocumented member.

ListSites, listSites_nextToken - Undocumented member.

$sel:operatingAddressCityFilter:ListSites', listSites_operatingAddressCityFilter - Filters the results by city.

$sel:operatingAddressCountryCodeFilter:ListSites', listSites_operatingAddressCountryCodeFilter - Filters the results by country code.

$sel:operatingAddressStateOrRegionFilter:ListSites', listSites_operatingAddressStateOrRegionFilter - Filters the results by state or region.

Request Lenses

listSites_maxResults :: Lens' ListSites (Maybe Natural) Source #

Undocumented member.

listSites_nextToken :: Lens' ListSites (Maybe Text) Source #

Undocumented member.

listSites_operatingAddressCityFilter :: Lens' ListSites (Maybe [Text]) Source #

Filters the results by city.

listSites_operatingAddressCountryCodeFilter :: Lens' ListSites (Maybe [Text]) Source #

Filters the results by country code.

listSites_operatingAddressStateOrRegionFilter :: Lens' ListSites (Maybe [Text]) Source #

Filters the results by state or region.

Destructuring the Response

data ListSitesResponse Source #

See: newListSitesResponse smart constructor.

Constructors

ListSitesResponse'
Fields nextToken :: Maybe Text sites :: Maybe [Site] httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListSitesResponse Source #
Instance details Defined in Amazonka.Outposts.ListSites Associated Types type Rep ListSitesResponse :: Type -> Type # Methods from :: ListSitesResponse -> Rep ListSitesResponse x # to :: Rep ListSitesResponse x -> ListSitesResponse #
Read ListSitesResponse Source #
Instance details Defined in Amazonka.Outposts.ListSites Methods readsPrec :: Int -> ReadS ListSitesResponse # readList :: ReadS [ListSitesResponse] # readPrec :: ReadPrec ListSitesResponse # readListPrec :: ReadPrec [ListSitesResponse] #
Show ListSitesResponse Source #
Instance details Defined in Amazonka.Outposts.ListSites Methods showsPrec :: Int -> ListSitesResponse -> ShowS # show :: ListSitesResponse -> String # showList :: [ListSitesResponse] -> ShowS #
NFData ListSitesResponse Source #
Instance details Defined in Amazonka.Outposts.ListSites Methods rnf :: ListSitesResponse -> () #
Eq ListSitesResponse Source #
Instance details Defined in Amazonka.Outposts.ListSites Methods (==) :: ListSitesResponse -> ListSitesResponse -> Bool # (/=) :: ListSitesResponse -> ListSitesResponse -> Bool #
type Rep ListSitesResponse Source #
Instance details Defined in Amazonka.Outposts.ListSites type Rep ListSitesResponse = D1 ('MetaData "ListSitesResponse" "Amazonka.Outposts.ListSites" "amazonka-outposts-2.0-7IMF8shlTNW2uMOjzEu2r2" 'False) (C1 ('MetaCons "ListSitesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Site])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSitesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListSitesResponse'`
-> ListSitesResponse

Create a value of ListSitesResponse 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:

ListSites, listSitesResponse_nextToken - Undocumented member.

$sel:sites:ListSitesResponse', listSitesResponse_sites - Undocumented member.

$sel:httpStatus:ListSitesResponse', listSitesResponse_httpStatus - The response's http status code.

Response Lenses

listSitesResponse_nextToken :: Lens' ListSitesResponse (Maybe Text) Source #

Undocumented member.

listSitesResponse_sites :: Lens' ListSitesResponse (Maybe [Site]) Source #

Undocumented member.

listSitesResponse_httpStatus :: Lens' ListSitesResponse Int Source #

The response's http status code.