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.OpenSearchServerless.ListVpcEndpoints

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

Synopsis

data ListVpcEndpoints = ListVpcEndpoints' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- vpcEndpointFilters :: Maybe VpcEndpointFilters
}
newListVpcEndpoints :: ListVpcEndpoints
listVpcEndpoints_maxResults :: Lens' ListVpcEndpoints (Maybe Natural)
listVpcEndpoints_nextToken :: Lens' ListVpcEndpoints (Maybe Text)
listVpcEndpoints_vpcEndpointFilters :: Lens' ListVpcEndpoints (Maybe VpcEndpointFilters)
data ListVpcEndpointsResponse = ListVpcEndpointsResponse' {
- nextToken :: Maybe Text
- vpcEndpointSummaries :: Maybe [VpcEndpointSummary]
- httpStatus :: Int
}
newListVpcEndpointsResponse :: Int -> ListVpcEndpointsResponse
listVpcEndpointsResponse_nextToken :: Lens' ListVpcEndpointsResponse (Maybe Text)
listVpcEndpointsResponse_vpcEndpointSummaries :: Lens' ListVpcEndpointsResponse (Maybe [VpcEndpointSummary])
listVpcEndpointsResponse_httpStatus :: Lens' ListVpcEndpointsResponse Int

Creating a Request

data ListVpcEndpoints Source #

See: newListVpcEndpoints smart constructor.

Constructors

ListVpcEndpoints'

Fields

maxResults :: Maybe Natural
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.
nextToken :: Maybe Text
If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.
vpcEndpointFilters :: Maybe VpcEndpointFilters
Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.

Instances

Instances details

ToJSON ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints Methods toJSON :: ListVpcEndpoints -> Value # toEncoding :: ListVpcEndpoints -> Encoding # toJSONList :: [ListVpcEndpoints] -> Value # toEncodingList :: [ListVpcEndpoints] -> Encoding #
ToHeaders ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints Methods toHeaders :: ListVpcEndpoints -> [Header] #
ToPath ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints Methods toPath :: ListVpcEndpoints -> ByteString #
ToQuery ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints Methods toQuery :: ListVpcEndpoints -> QueryString #
AWSRequest ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints Associated Types type AWSResponse ListVpcEndpoints # Methods request :: (Service -> Service) -> ListVpcEndpoints -> Request ListVpcEndpoints # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListVpcEndpoints -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListVpcEndpoints))) #
Generic ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints Associated Types type Rep ListVpcEndpoints :: Type -> Type # Methods from :: ListVpcEndpoints -> Rep ListVpcEndpoints x # to :: Rep ListVpcEndpoints x -> ListVpcEndpoints #
Read ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints Methods readsPrec :: Int -> ReadS ListVpcEndpoints # readList :: ReadS [ListVpcEndpoints] # readPrec :: ReadPrec ListVpcEndpoints # readListPrec :: ReadPrec [ListVpcEndpoints] #
Show ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints Methods showsPrec :: Int -> ListVpcEndpoints -> ShowS # show :: ListVpcEndpoints -> String # showList :: [ListVpcEndpoints] -> ShowS #
NFData ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints Methods rnf :: ListVpcEndpoints -> () #
Eq ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints Methods (==) :: ListVpcEndpoints -> ListVpcEndpoints -> Bool # (/=) :: ListVpcEndpoints -> ListVpcEndpoints -> Bool #
Hashable ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints Methods hashWithSalt :: Int -> ListVpcEndpoints -> Int # hash :: ListVpcEndpoints -> Int #
type AWSResponse ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints type AWSResponse ListVpcEndpoints = ListVpcEndpointsResponse
type Rep ListVpcEndpoints Source #
Instance details Defined in Amazonka.OpenSearchServerless.ListVpcEndpoints type Rep ListVpcEndpoints = D1 ('MetaData "ListVpcEndpoints" "Amazonka.OpenSearchServerless.ListVpcEndpoints" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "ListVpcEndpoints'" '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 "vpcEndpointFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcEndpointFilters)))))

newListVpcEndpoints :: ListVpcEndpoints Source #

Create a value of ListVpcEndpoints 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:ListVpcEndpoints', listVpcEndpoints_maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

ListVpcEndpoints, listVpcEndpoints_nextToken - If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.

$sel:vpcEndpointFilters:ListVpcEndpoints', listVpcEndpoints_vpcEndpointFilters - Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.

Request Lenses

listVpcEndpoints_maxResults :: Lens' ListVpcEndpoints (Maybe Natural) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

listVpcEndpoints_nextToken :: Lens' ListVpcEndpoints (Maybe Text) Source #

If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.

listVpcEndpoints_vpcEndpointFilters :: Lens' ListVpcEndpoints (Maybe VpcEndpointFilters) Source #

Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.

Destructuring the Response

data ListVpcEndpointsResponse Source #

See: newListVpcEndpointsResponse smart constructor.

Constructors

ListVpcEndpointsResponse'

Fields

nextToken :: Maybe Text
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
vpcEndpointSummaries :: Maybe [VpcEndpointSummary]
Details about each VPC endpoint, including the name and current status.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListVpcEndpointsResponse Source #

Arguments

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

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

ListVpcEndpoints, listVpcEndpointsResponse_nextToken - When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

$sel:vpcEndpointSummaries:ListVpcEndpointsResponse', listVpcEndpointsResponse_vpcEndpointSummaries - Details about each VPC endpoint, including the name and current status.

$sel:httpStatus:ListVpcEndpointsResponse', listVpcEndpointsResponse_httpStatus - The response's http status code.

Response Lenses

listVpcEndpointsResponse_nextToken :: Lens' ListVpcEndpointsResponse (Maybe Text) Source #

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

listVpcEndpointsResponse_vpcEndpointSummaries :: Lens' ListVpcEndpointsResponse (Maybe [VpcEndpointSummary]) Source #

Details about each VPC endpoint, including the name and current status.

listVpcEndpointsResponse_httpStatus :: Lens' ListVpcEndpointsResponse Int Source #

The response's http status code.