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.OpenSearch.ListVpcEndpointAccess

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Creating a Request

data ListVpcEndpointAccess Source #

See: newListVpcEndpointAccess smart constructor.

Constructors

ListVpcEndpointAccess'
Fields nextToken :: Maybe Text If your initial `ListVpcEndpointAccess` operation returns a `nextToken`, you can include the returned `nextToken` in subsequent `ListVpcEndpointAccess` operations, which returns results in the next page. domainName :: Text The name of the OpenSearch Service domain to retrieve access information for.

Instances

Instances details

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

newListVpcEndpointAccess Source #

Arguments

:: Text	`ListVpcEndpointAccess`
-> ListVpcEndpointAccess

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

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

ListVpcEndpointAccess, listVpcEndpointAccess_domainName - The name of the OpenSearch Service domain to retrieve access information for.

Request Lenses

listVpcEndpointAccess_nextToken :: Lens' ListVpcEndpointAccess (Maybe Text) Source #

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

listVpcEndpointAccess_domainName :: Lens' ListVpcEndpointAccess Text Source #

The name of the OpenSearch Service domain to retrieve access information for.

Destructuring the Response

data ListVpcEndpointAccessResponse Source #

See: newListVpcEndpointAccessResponse smart constructor.

Constructors

ListVpcEndpointAccessResponse'
Fields httpStatus :: Int The response's http status code. authorizedPrincipalList :: [AuthorizedPrincipal] A list of IAM principals that can currently access the domain. nextToken :: 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.

Instances

Instances details

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

newListVpcEndpointAccessResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListVpcEndpointAccessResponse'`
-> Text	`ListVpcEndpointAccess`
-> ListVpcEndpointAccessResponse

Create a value of ListVpcEndpointAccessResponse 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:httpStatus:ListVpcEndpointAccessResponse', listVpcEndpointAccessResponse_httpStatus - The response's http status code.

$sel:authorizedPrincipalList:ListVpcEndpointAccessResponse', listVpcEndpointAccessResponse_authorizedPrincipalList - A list of IAM principals that can currently access the domain.

ListVpcEndpointAccess, listVpcEndpointAccessResponse_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.

Response Lenses

listVpcEndpointAccessResponse_httpStatus :: Lens' ListVpcEndpointAccessResponse Int Source #

The response's http status code.

listVpcEndpointAccessResponse_authorizedPrincipalList :: Lens' ListVpcEndpointAccessResponse [AuthorizedPrincipal] Source #

A list of IAM principals that can currently access the domain.

listVpcEndpointAccessResponse_nextToken :: Lens' ListVpcEndpointAccessResponse 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.