amazonka-opensearch-2.0: Amazon OpenSearch Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.OpenSearch.ListVpcEndpointsForDomain

Description

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

Synopsis

Creating a Request

data ListVpcEndpointsForDomain Source #

See: newListVpcEndpointsForDomain smart constructor.

Constructors

ListVpcEndpointsForDomain' 

Fields

  • nextToken :: Maybe Text

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

  • domainName :: Text

    The name of the domain to list associated VPC endpoints for.

Instances

Instances details
ToHeaders ListVpcEndpointsForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

ToPath ListVpcEndpointsForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

ToQuery ListVpcEndpointsForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

AWSRequest ListVpcEndpointsForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

Generic ListVpcEndpointsForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

Associated Types

type Rep ListVpcEndpointsForDomain :: Type -> Type #

Read ListVpcEndpointsForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

Show ListVpcEndpointsForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

NFData ListVpcEndpointsForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

Eq ListVpcEndpointsForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

Hashable ListVpcEndpointsForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

type AWSResponse ListVpcEndpointsForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

type Rep ListVpcEndpointsForDomain Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

type Rep ListVpcEndpointsForDomain = D1 ('MetaData "ListVpcEndpointsForDomain" "Amazonka.OpenSearch.ListVpcEndpointsForDomain" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "ListVpcEndpointsForDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newListVpcEndpointsForDomain Source #

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

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

ListVpcEndpointsForDomain, listVpcEndpointsForDomain_domainName - The name of the domain to list associated VPC endpoints for.

Request Lenses

listVpcEndpointsForDomain_nextToken :: Lens' ListVpcEndpointsForDomain (Maybe Text) Source #

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

listVpcEndpointsForDomain_domainName :: Lens' ListVpcEndpointsForDomain Text Source #

The name of the domain to list associated VPC endpoints for.

Destructuring the Response

data ListVpcEndpointsForDomainResponse Source #

See: newListVpcEndpointsForDomainResponse smart constructor.

Constructors

ListVpcEndpointsForDomainResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • vpcEndpointSummaryList :: [VpcEndpointSummary]

    Information about each endpoint associated with 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 ListVpcEndpointsForDomainResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

Associated Types

type Rep ListVpcEndpointsForDomainResponse :: Type -> Type #

Read ListVpcEndpointsForDomainResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

Show ListVpcEndpointsForDomainResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

NFData ListVpcEndpointsForDomainResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

Eq ListVpcEndpointsForDomainResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

type Rep ListVpcEndpointsForDomainResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListVpcEndpointsForDomain

type Rep ListVpcEndpointsForDomainResponse = D1 ('MetaData "ListVpcEndpointsForDomainResponse" "Amazonka.OpenSearch.ListVpcEndpointsForDomain" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "ListVpcEndpointsForDomainResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "vpcEndpointSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [VpcEndpointSummary]) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListVpcEndpointsForDomainResponse Source #

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

$sel:vpcEndpointSummaryList:ListVpcEndpointsForDomainResponse', listVpcEndpointsForDomainResponse_vpcEndpointSummaryList - Information about each endpoint associated with the domain.

ListVpcEndpointsForDomain, listVpcEndpointsForDomainResponse_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

listVpcEndpointsForDomainResponse_nextToken :: Lens' ListVpcEndpointsForDomainResponse 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.