Amazonka.PrivateNetworks.ListNetworkSites

Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.

This operation returns paginated results.

Creating a Request

data ListNetworkSites

See: newListNetworkSites smart constructor.

Constructors

ListNetworkSites'

Fields

• filters :: Maybe (HashMap NetworkSiteFilterKeys [Text])

  The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

  • STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

  Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

• maxResults :: Maybe Natural

  The maximum number of results to return.

• startToken :: Maybe Text

  The token for the next page of results.

• networkArn :: Text

  The Amazon Resource Name (ARN) of the network.

Instances

ToJSON ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

toJSON :: ListNetworkSites -> Value

toEncoding :: ListNetworkSites -> Encoding

toJSONList :: [ListNetworkSites] -> Value

toEncodingList :: [ListNetworkSites] -> Encoding

ToHeaders ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

toHeaders :: ListNetworkSites -> [Header]

ToPath ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

toPath :: ListNetworkSites -> ByteString

ToQuery ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

toQuery :: ListNetworkSites -> QueryString

AWSPager ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

page :: ListNetworkSites -> AWSResponse ListNetworkSites -> Maybe ListNetworkSites

AWSRequest ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Associated Types

type AWSResponse ListNetworkSites

Methods

request :: (Service -> Service) -> ListNetworkSites -> Request ListNetworkSites

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListNetworkSites -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListNetworkSites)))

Generic ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Associated Types

type Rep ListNetworkSites :: Type -> Type

Methods

from :: ListNetworkSites -> Rep ListNetworkSites x

to :: Rep ListNetworkSites x -> ListNetworkSites

Read ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

readsPrec :: Int -> ReadS ListNetworkSites

readList :: ReadS [ListNetworkSites]

readPrec :: ReadPrec ListNetworkSites

readListPrec :: ReadPrec [ListNetworkSites]

Show ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

showsPrec :: Int -> ListNetworkSites -> ShowS

show :: ListNetworkSites -> String

showList :: [ListNetworkSites] -> ShowS

NFData ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

rnf :: ListNetworkSites -> ()

Eq ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

(==) :: ListNetworkSites -> ListNetworkSites -> Bool

(/=) :: ListNetworkSites -> ListNetworkSites -> Bool

Hashable ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

hashWithSalt :: Int -> ListNetworkSites -> Int

hash :: ListNetworkSites -> Int

type AWSResponse ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

type AWSResponse ListNetworkSites = ListNetworkSitesResponse

type Rep ListNetworkSites

Defined in Amazonka.PrivateNetworks.ListNetworkSites

type Rep ListNetworkSites = D1 ('MetaData "ListNetworkSites" "Amazonka.PrivateNetworks.ListNetworkSites" "amazonka-privatenetworks-2.0-6kTUHQMy1b1JCa08Y5Egzo" 'False) (C1 ('MetaCons "ListNetworkSites'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap NetworkSiteFilterKeys [Text]))) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "startToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "networkArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListNetworkSites

Arguments

:: Text

ListNetworkSites

-> ListNetworkSites

Create a value of ListNetworkSites 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:ListNetworkSites', listNetworkSites_filters - The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

• STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

$sel:maxResults:ListNetworkSites', listNetworkSites_maxResults - The maximum number of results to return.

$sel:startToken:ListNetworkSites', listNetworkSites_startToken - The token for the next page of results.

ListNetworkSites, listNetworkSites_networkArn - The Amazon Resource Name (ARN) of the network.

Request Lenses

listNetworkSites_filters :: Lens' ListNetworkSites (Maybe (HashMap NetworkSiteFilterKeys [Text]))

The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

• STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

listNetworkSites_maxResults :: Lens' ListNetworkSites (Maybe Natural)

The maximum number of results to return.

listNetworkSites_startToken :: Lens' ListNetworkSites (Maybe Text)

The token for the next page of results.

listNetworkSites_networkArn :: Lens' ListNetworkSites Text

The Amazon Resource Name (ARN) of the network.

Destructuring the Response

data ListNetworkSitesResponse

See: newListNetworkSitesResponse smart constructor.

Constructors

ListNetworkSitesResponse'

Fields

• networkSites :: Maybe [NetworkSite]

  Information about the network sites.

• nextToken :: Maybe Text

  The token for the next page of results.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListNetworkSitesResponse

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Associated Types

type Rep ListNetworkSitesResponse :: Type -> Type

Methods

from :: ListNetworkSitesResponse -> Rep ListNetworkSitesResponse x

to :: Rep ListNetworkSitesResponse x -> ListNetworkSitesResponse

Read ListNetworkSitesResponse

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

readsPrec :: Int -> ReadS ListNetworkSitesResponse

readList :: ReadS [ListNetworkSitesResponse]

readPrec :: ReadPrec ListNetworkSitesResponse

readListPrec :: ReadPrec [ListNetworkSitesResponse]

Show ListNetworkSitesResponse

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

showsPrec :: Int -> ListNetworkSitesResponse -> ShowS

show :: ListNetworkSitesResponse -> String

showList :: [ListNetworkSitesResponse] -> ShowS

NFData ListNetworkSitesResponse

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

rnf :: ListNetworkSitesResponse -> ()

Eq ListNetworkSitesResponse

Defined in Amazonka.PrivateNetworks.ListNetworkSites

Methods

(==) :: ListNetworkSitesResponse -> ListNetworkSitesResponse -> Bool

(/=) :: ListNetworkSitesResponse -> ListNetworkSitesResponse -> Bool

type Rep ListNetworkSitesResponse

Defined in Amazonka.PrivateNetworks.ListNetworkSites

type Rep ListNetworkSitesResponse = D1 ('MetaData "ListNetworkSitesResponse" "Amazonka.PrivateNetworks.ListNetworkSites" "amazonka-privatenetworks-2.0-6kTUHQMy1b1JCa08Y5Egzo" 'False) (C1 ('MetaCons "ListNetworkSitesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "networkSites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NetworkSite])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListNetworkSitesResponse

Arguments

:: Int

$sel:httpStatus:ListNetworkSitesResponse'

-> ListNetworkSitesResponse

Create a value of ListNetworkSitesResponse 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:networkSites:ListNetworkSitesResponse', listNetworkSitesResponse_networkSites - Information about the network sites.

$sel:nextToken:ListNetworkSitesResponse', listNetworkSitesResponse_nextToken - The token for the next page of results.

$sel:httpStatus:ListNetworkSitesResponse', listNetworkSitesResponse_httpStatus - The response's http status code.

Response Lenses

listNetworkSitesResponse_networkSites :: Lens' ListNetworkSitesResponse (Maybe [NetworkSite])

Information about the network sites.

listNetworkSitesResponse_nextToken :: Lens' ListNetworkSitesResponse (Maybe Text)

The token for the next page of results.

listNetworkSitesResponse_httpStatus :: Lens' ListNetworkSitesResponse Int

The response's http status code.