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.Lens

Contents

Description

 
Synopsis

Operations

AcceptInboundConnection

acceptInboundConnection_connectionId :: Lens' AcceptInboundConnection Text Source #

The ID of the inbound connection to accept.

AddTags

addTags_arn :: Lens' AddTags Text Source #

Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.

addTags_tagList :: Lens' AddTags [Tag] Source #

List of resource tags.

AssociatePackage

associatePackage_packageID :: Lens' AssociatePackage Text Source #

Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

associatePackage_domainName :: Lens' AssociatePackage Text Source #

Name of the domain to associate the package with.

associatePackageResponse_domainPackageDetails :: Lens' AssociatePackageResponse (Maybe DomainPackageDetails) Source #

Information about a package that is associated with a domain.

AuthorizeVpcEndpointAccess

authorizeVpcEndpointAccess_domainName :: Lens' AuthorizeVpcEndpointAccess Text Source #

The name of the OpenSearch Service domain to provide access to.

authorizeVpcEndpointAccess_account :: Lens' AuthorizeVpcEndpointAccess Text Source #

The Amazon Web Services account ID to grant access to.

authorizeVpcEndpointAccessResponse_authorizedPrincipal :: Lens' AuthorizeVpcEndpointAccessResponse AuthorizedPrincipal Source #

Information about the Amazon Web Services account or service that was provided access to the domain.

CancelServiceSoftwareUpdate

cancelServiceSoftwareUpdate_domainName :: Lens' CancelServiceSoftwareUpdate Text Source #

Name of the OpenSearch Service domain that you want to cancel the service software update on.

cancelServiceSoftwareUpdateResponse_serviceSoftwareOptions :: Lens' CancelServiceSoftwareUpdateResponse (Maybe ServiceSoftwareOptions) Source #

Container for the state of your domain relative to the latest service software.

CreateDomain

createDomain_accessPolicies :: Lens' CreateDomain (Maybe Text) Source #

Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

createDomain_advancedOptions :: Lens' CreateDomain (Maybe (HashMap Text Text)) Source #

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

  • "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
  • "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
  • "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
  • "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

createDomain_clusterConfig :: Lens' CreateDomain (Maybe ClusterConfig) Source #

Container for the cluster configuration of a domain.

createDomain_cognitoOptions :: Lens' CreateDomain (Maybe CognitoOptions) Source #

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

createDomain_domainEndpointOptions :: Lens' CreateDomain (Maybe DomainEndpointOptions) Source #

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

createDomain_eBSOptions :: Lens' CreateDomain (Maybe EBSOptions) Source #

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

createDomain_engineVersion :: Lens' CreateDomain (Maybe Text) Source #

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

createDomain_logPublishingOptions :: Lens' CreateDomain (Maybe (HashMap LogType LogPublishingOption)) Source #

Key-value pairs to configure slow log publishing.

createDomain_snapshotOptions :: Lens' CreateDomain (Maybe SnapshotOptions) Source #

DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

createDomain_tagList :: Lens' CreateDomain (Maybe [Tag]) Source #

List of tags to add to the domain upon creation.

createDomain_vPCOptions :: Lens' CreateDomain (Maybe VPCOptions) Source #

Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

createDomain_domainName :: Lens' CreateDomain Text Source #

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

CreateOutboundConnection

createOutboundConnectionResponse_connectionId :: Lens' CreateOutboundConnectionResponse (Maybe Text) Source #

The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.

CreatePackage

createPackage_packageName :: Lens' CreatePackage Text Source #

Unique name for the package.

createPackage_packageSource :: Lens' CreatePackage PackageSource Source #

The Amazon S3 location from which to import the package.

createPackageResponse_packageDetails :: Lens' CreatePackageResponse (Maybe PackageDetails) Source #

Basic information about an OpenSearch Service package.

CreateVpcEndpoint

createVpcEndpoint_clientToken :: Lens' CreateVpcEndpoint (Maybe Text) Source #

Unique, case-sensitive identifier to ensure idempotency of the request.

createVpcEndpoint_domainArn :: Lens' CreateVpcEndpoint Text Source #

The Amazon Resource Name (ARN) of the domain to grant access to.

createVpcEndpoint_vpcOptions :: Lens' CreateVpcEndpoint VPCOptions Source #

Options to specify the subnets and security groups for the endpoint.

createVpcEndpointResponse_vpcEndpoint :: Lens' CreateVpcEndpointResponse VpcEndpoint Source #

Information about the newly created VPC endpoint.

DeleteDomain

deleteDomain_domainName :: Lens' DeleteDomain Text Source #

The name of the domain you want to permanently delete.

DeleteInboundConnection

deleteInboundConnection_connectionId :: Lens' DeleteInboundConnection Text Source #

The ID of the inbound connection to permanently delete.

DeleteOutboundConnection

deleteOutboundConnection_connectionId :: Lens' DeleteOutboundConnection Text Source #

The ID of the outbound connection you want to permanently delete.

DeletePackage

deletePackage_packageID :: Lens' DeletePackage Text Source #

The internal ID of the package you want to delete. Use DescribePackages to find this value.

DeleteVpcEndpoint

deleteVpcEndpoint_vpcEndpointId :: Lens' DeleteVpcEndpoint Text Source #

The unique identifier of the endpoint.

deleteVpcEndpointResponse_vpcEndpointSummary :: Lens' DeleteVpcEndpointResponse VpcEndpointSummary Source #

Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).

DescribeDomain

describeDomain_domainName :: Lens' DescribeDomain Text Source #

The name of the domain that you want information about.

describeDomainResponse_domainStatus :: Lens' DescribeDomainResponse DomainStatus Source #

List that contains the status of each specified OpenSearch Service domain.

DescribeDomainAutoTunes

describeDomainAutoTunes_maxResults :: Lens' DescribeDomainAutoTunes (Maybe Int) Source #

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

describeDomainAutoTunes_nextToken :: Lens' DescribeDomainAutoTunes (Maybe Text) Source #

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

describeDomainAutoTunes_domainName :: Lens' DescribeDomainAutoTunes Text Source #

Name of the domain that you want Auto-Tune details about.

describeDomainAutoTunesResponse_autoTunes :: Lens' DescribeDomainAutoTunesResponse (Maybe [AutoTune]) Source #

The list of setting adjustments that Auto-Tune has made to the domain.

describeDomainAutoTunesResponse_nextToken :: Lens' DescribeDomainAutoTunesResponse (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.

DescribeDomainChangeProgress

describeDomainChangeProgress_changeId :: Lens' DescribeDomainChangeProgress (Maybe Text) Source #

The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

describeDomainChangeProgress_domainName :: Lens' DescribeDomainChangeProgress Text Source #

The name of the domain to get progress information for.

describeDomainChangeProgressResponse_changeProgressStatus :: Lens' DescribeDomainChangeProgressResponse (Maybe ChangeProgressStatusDetails) Source #

Container for information about the stages of a configuration change happening on a domain.

DescribeDomainConfig

describeDomainConfig_domainName :: Lens' DescribeDomainConfig Text Source #

Name of the OpenSearch Service domain configuration that you want to describe.

describeDomainConfigResponse_domainConfig :: Lens' DescribeDomainConfigResponse DomainConfig Source #

Container for the configuration of the OpenSearch Service domain.

DescribeDomains

describeDomains_domainNames :: Lens' DescribeDomains [Text] Source #

Array of OpenSearch Service domain names that you want information about. If you don't specify any domains, OpenSearch Service returns information about all domains owned by the account.

DescribeInboundConnections

describeInboundConnections_filters :: Lens' DescribeInboundConnections (Maybe [Filter]) Source #

A list of filters used to match properties for inbound cross-cluster connections.

describeInboundConnections_maxResults :: Lens' DescribeInboundConnections (Maybe Int) Source #

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

describeInboundConnections_nextToken :: Lens' DescribeInboundConnections (Maybe Text) Source #

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

describeInboundConnectionsResponse_nextToken :: Lens' DescribeInboundConnectionsResponse (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.

DescribeInstanceTypeLimits

describeInstanceTypeLimits_domainName :: Lens' DescribeInstanceTypeLimits (Maybe Text) Source #

The name of the domain. Only specify if you need the limits for an existing domain.

describeInstanceTypeLimits_instanceType :: Lens' DescribeInstanceTypeLimits OpenSearchPartitionInstanceType Source #

The OpenSearch Service instance type for which you need limit information.

describeInstanceTypeLimits_engineVersion :: Lens' DescribeInstanceTypeLimits Text Source #

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

describeInstanceTypeLimitsResponse_limitsByRole :: Lens' DescribeInstanceTypeLimitsResponse (Maybe (HashMap Text Limits)) Source #

Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.

DescribeOutboundConnections

describeOutboundConnections_filters :: Lens' DescribeOutboundConnections (Maybe [Filter]) Source #

List of filter names and values that you can use for requests.

describeOutboundConnections_maxResults :: Lens' DescribeOutboundConnections (Maybe Int) Source #

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

describeOutboundConnections_nextToken :: Lens' DescribeOutboundConnections (Maybe Text) Source #

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

describeOutboundConnectionsResponse_nextToken :: Lens' DescribeOutboundConnectionsResponse (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.

DescribePackages

describePackages_filters :: Lens' DescribePackages (Maybe [DescribePackagesFilter]) Source #

Only returns packages that match the DescribePackagesFilterList values.

describePackages_maxResults :: Lens' DescribePackages (Maybe Int) Source #

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

describePackages_nextToken :: Lens' DescribePackages (Maybe Text) Source #

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

describePackagesResponse_nextToken :: Lens' DescribePackagesResponse (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.

DescribeReservedInstanceOfferings

describeReservedInstanceOfferings_maxResults :: Lens' DescribeReservedInstanceOfferings (Maybe Int) Source #

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

describeReservedInstanceOfferings_nextToken :: Lens' DescribeReservedInstanceOfferings (Maybe Text) Source #

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

describeReservedInstanceOfferings_reservedInstanceOfferingId :: Lens' DescribeReservedInstanceOfferings (Maybe Text) Source #

The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

describeReservedInstanceOfferingsResponse_nextToken :: Lens' DescribeReservedInstanceOfferingsResponse (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.

DescribeReservedInstances

describeReservedInstances_maxResults :: Lens' DescribeReservedInstances (Maybe Int) Source #

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

describeReservedInstances_nextToken :: Lens' DescribeReservedInstances (Maybe Text) Source #

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

describeReservedInstances_reservedInstanceId :: Lens' DescribeReservedInstances (Maybe Text) Source #

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

describeReservedInstancesResponse_nextToken :: Lens' DescribeReservedInstancesResponse (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.

DescribeVpcEndpoints

describeVpcEndpoints_vpcEndpointIds :: Lens' DescribeVpcEndpoints [Text] Source #

The unique identifiers of the endpoints to get information about.

DissociatePackage

dissociatePackage_packageID :: Lens' DissociatePackage Text Source #

Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.

dissociatePackage_domainName :: Lens' DissociatePackage Text Source #

Name of the domain to dissociate the package from.

dissociatePackageResponse_domainPackageDetails :: Lens' DissociatePackageResponse (Maybe DomainPackageDetails) Source #

Information about a package that has been dissociated from the domain.

GetCompatibleVersions

getCompatibleVersions_domainName :: Lens' GetCompatibleVersions (Maybe Text) Source #

The name of an existing domain. Provide this parameter to limit the results to a single domain.

getCompatibleVersionsResponse_compatibleVersions :: Lens' GetCompatibleVersionsResponse (Maybe [CompatibleVersionsMap]) Source #

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

GetPackageVersionHistory

getPackageVersionHistory_maxResults :: Lens' GetPackageVersionHistory (Maybe Int) Source #

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

getPackageVersionHistory_nextToken :: Lens' GetPackageVersionHistory (Maybe Text) Source #

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

getPackageVersionHistoryResponse_nextToken :: Lens' GetPackageVersionHistoryResponse (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.

getPackageVersionHistoryResponse_packageVersionHistoryList :: Lens' GetPackageVersionHistoryResponse (Maybe [PackageVersionHistory]) Source #

A list of package versions, along with their creation time and commit message.

GetUpgradeHistory

getUpgradeHistory_maxResults :: Lens' GetUpgradeHistory (Maybe Int) Source #

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

getUpgradeHistory_nextToken :: Lens' GetUpgradeHistory (Maybe Text) Source #

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

getUpgradeHistoryResponse_nextToken :: Lens' GetUpgradeHistoryResponse (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.

getUpgradeHistoryResponse_upgradeHistories :: Lens' GetUpgradeHistoryResponse (Maybe [UpgradeHistory]) Source #

A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

GetUpgradeStatus

getUpgradeStatus_domainName :: Lens' GetUpgradeStatus Text Source #

The domain of the domain to get upgrade status information for.

getUpgradeStatusResponse_stepStatus :: Lens' GetUpgradeStatusResponse (Maybe UpgradeStatus) Source #

The status of the current step that an upgrade is on.

getUpgradeStatusResponse_upgradeStep :: Lens' GetUpgradeStatusResponse (Maybe UpgradeStep) Source #

One of three steps that an upgrade or upgrade eligibility check goes through.

ListDomainNames

listDomainNames_engineType :: Lens' ListDomainNames (Maybe EngineType) Source #

Filters the output by domain engine type.

listDomainNamesResponse_domainNames :: Lens' ListDomainNamesResponse (Maybe [DomainInfo]) Source #

The names of all OpenSearch Service domains owned by the current user and their respective engine types.

ListDomainsForPackage

listDomainsForPackage_maxResults :: Lens' ListDomainsForPackage (Maybe Int) Source #

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

listDomainsForPackage_nextToken :: Lens' ListDomainsForPackage (Maybe Text) Source #

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

listDomainsForPackage_packageID :: Lens' ListDomainsForPackage Text Source #

The unique identifier of the package for which to list associated domains.

listDomainsForPackageResponse_nextToken :: Lens' ListDomainsForPackageResponse (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.

ListInstanceTypeDetails

listInstanceTypeDetails_domainName :: Lens' ListInstanceTypeDetails (Maybe Text) Source #

Name of the domain to list instance type details for.

listInstanceTypeDetails_maxResults :: Lens' ListInstanceTypeDetails (Maybe Int) Source #

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

listInstanceTypeDetails_nextToken :: Lens' ListInstanceTypeDetails (Maybe Text) Source #

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

listInstanceTypeDetails_engineVersion :: Lens' ListInstanceTypeDetails Text Source #

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

listInstanceTypeDetailsResponse_instanceTypeDetails :: Lens' ListInstanceTypeDetailsResponse (Maybe [InstanceTypeDetails]) Source #

Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

listInstanceTypeDetailsResponse_nextToken :: Lens' ListInstanceTypeDetailsResponse (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.

ListPackagesForDomain

listPackagesForDomain_maxResults :: Lens' ListPackagesForDomain (Maybe Int) Source #

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

listPackagesForDomain_nextToken :: Lens' ListPackagesForDomain (Maybe Text) Source #

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

listPackagesForDomain_domainName :: Lens' ListPackagesForDomain Text Source #

The name of the domain for which you want to list associated packages.

listPackagesForDomainResponse_nextToken :: Lens' ListPackagesForDomainResponse (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.

ListTags

listTags_arn :: Lens' ListTags Text Source #

Amazon Resource Name (ARN) for the domain to view tags for.

listTagsResponse_tagList :: Lens' ListTagsResponse (Maybe [Tag]) Source #

List of resource tags associated with the specified domain.

listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #

The response's http status code.

ListVersions

listVersions_maxResults :: Lens' ListVersions (Maybe Int) Source #

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

listVersions_nextToken :: Lens' ListVersions (Maybe Text) Source #

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

listVersionsResponse_nextToken :: Lens' ListVersionsResponse (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.

listVersionsResponse_versions :: Lens' ListVersionsResponse (Maybe [Text]) Source #

A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

ListVpcEndpointAccess

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.

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.

ListVpcEndpoints

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.

listVpcEndpointsResponse_nextToken :: Lens' ListVpcEndpointsResponse 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.

ListVpcEndpointsForDomain

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.

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.

PurchaseReservedInstanceOffering

purchaseReservedInstanceOffering_reservationName :: Lens' PurchaseReservedInstanceOffering Text Source #

A customer-specified identifier to track this reservation.

RejectInboundConnection

rejectInboundConnection_connectionId :: Lens' RejectInboundConnection Text Source #

The unique identifier of the inbound connection to reject.

RemoveTags

removeTags_arn :: Lens' RemoveTags Text Source #

The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.

removeTags_tagKeys :: Lens' RemoveTags [Text] Source #

The list of tag keys to remove from the domain.

RevokeVpcEndpointAccess

revokeVpcEndpointAccess_domainName :: Lens' RevokeVpcEndpointAccess Text Source #

The name of the OpenSearch Service domain.

StartServiceSoftwareUpdate

startServiceSoftwareUpdate_domainName :: Lens' StartServiceSoftwareUpdate Text Source #

The name of the domain that you want to update to the latest service software.

UpdateDomainConfig

updateDomainConfig_accessPolicies :: Lens' UpdateDomainConfig (Maybe Text) Source #

Identity and Access Management (IAM) access policy as a JSON-formatted string.

updateDomainConfig_advancedOptions :: Lens' UpdateDomainConfig (Maybe (HashMap Text Text)) Source #

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

  • "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
  • "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
  • "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
  • "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters.

updateDomainConfig_clusterConfig :: Lens' UpdateDomainConfig (Maybe ClusterConfig) Source #

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

updateDomainConfig_cognitoOptions :: Lens' UpdateDomainConfig (Maybe CognitoOptions) Source #

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

updateDomainConfig_domainEndpointOptions :: Lens' UpdateDomainConfig (Maybe DomainEndpointOptions) Source #

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

updateDomainConfig_dryRun :: Lens' UpdateDomainConfig (Maybe Bool) Source #

This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation check without actually applying the change.

updateDomainConfig_eBSOptions :: Lens' UpdateDomainConfig (Maybe EBSOptions) Source #

The type and size of the EBS volume to attach to instances in the domain.

updateDomainConfig_logPublishingOptions :: Lens' UpdateDomainConfig (Maybe (HashMap LogType LogPublishingOption)) Source #

Options to publish OpenSearch lots to Amazon CloudWatch Logs.

updateDomainConfig_snapshotOptions :: Lens' UpdateDomainConfig (Maybe SnapshotOptions) Source #

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

updateDomainConfig_vPCOptions :: Lens' UpdateDomainConfig (Maybe VPCOptions) Source #

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

updateDomainConfig_domainName :: Lens' UpdateDomainConfig Text Source #

The name of the domain that you're updating.

updateDomainConfigResponse_dryRunResults :: Lens' UpdateDomainConfigResponse (Maybe DryRunResults) Source #

Results of a dry run performed in an update domain request.

UpdatePackage

updatePackage_commitMessage :: Lens' UpdatePackage (Maybe Text) Source #

Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.

updatePackage_packageDescription :: Lens' UpdatePackage (Maybe Text) Source #

A new description of the package.

updatePackage_packageID :: Lens' UpdatePackage Text Source #

The unique identifier for the package.

updatePackage_packageSource :: Lens' UpdatePackage PackageSource Source #

Amazon S3 bucket and key for the package.

UpdateVpcEndpoint

updateVpcEndpoint_vpcEndpointId :: Lens' UpdateVpcEndpoint Text Source #

The unique identifier of the endpoint.

updateVpcEndpoint_vpcOptions :: Lens' UpdateVpcEndpoint VPCOptions Source #

The security groups and/or subnets to add, remove, or modify.

UpgradeDomain

upgradeDomain_advancedOptions :: Lens' UpgradeDomain (Maybe (HashMap Text Text)) Source #

Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.

upgradeDomain_performCheckOnly :: Lens' UpgradeDomain (Maybe Bool) Source #

When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

upgradeDomain_domainName :: Lens' UpgradeDomain Text Source #

Name of the OpenSearch Service domain that you want to upgrade.

upgradeDomain_targetVersion :: Lens' UpgradeDomain Text Source #

OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

upgradeDomainResponse_advancedOptions :: Lens' UpgradeDomainResponse (Maybe (HashMap Text Text)) Source #

The advanced options configuration for the domain.

upgradeDomainResponse_changeProgressDetails :: Lens' UpgradeDomainResponse (Maybe ChangeProgressDetails) Source #

Container for information about a configuration change happening on a domain.

upgradeDomainResponse_domainName :: Lens' UpgradeDomainResponse (Maybe Text) Source #

The name of the domain that was upgraded.

upgradeDomainResponse_performCheckOnly :: Lens' UpgradeDomainResponse (Maybe Bool) Source #

When true, indicates that an upgrade eligibility check was performed.

upgradeDomainResponse_targetVersion :: Lens' UpgradeDomainResponse (Maybe Text) Source #

OpenSearch or Elasticsearch version that the domain was upgraded to.

upgradeDomainResponse_upgradeId :: Lens' UpgradeDomainResponse (Maybe Text) Source #

The unique identifier of the domain upgrade.

Types

AWSDomainInformation

aWSDomainInformation_ownerId :: Lens' AWSDomainInformation (Maybe Text) Source #

The Amazon Web Services account ID of the domain owner.

aWSDomainInformation_region :: Lens' AWSDomainInformation (Maybe Text) Source #

The Amazon Web Services Region in which the domain is located.

AccessPoliciesStatus

accessPoliciesStatus_options :: Lens' AccessPoliciesStatus Text Source #

The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.

accessPoliciesStatus_status :: Lens' AccessPoliciesStatus OptionStatus Source #

The status of the access policy for the domain.

AdditionalLimit

additionalLimit_limitName :: Lens' AdditionalLimit (Maybe Text) Source #

  • MaximumNumberOfDataNodesSupported - This attribute only applies to master nodes and specifies the maximum number of data nodes of a given instance type a master node can support.
  • MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies to data nodes and specifies the maximum number of data nodes of a given instance type can exist without a master node governing them.

additionalLimit_limitValues :: Lens' AdditionalLimit (Maybe [Text]) Source #

The values of the additional instance type limits.

AdvancedOptionsStatus

advancedOptionsStatus_options :: Lens' AdvancedOptionsStatus (HashMap Text Text) Source #

The status of advanced options for the specified domain.

advancedOptionsStatus_status :: Lens' AdvancedOptionsStatus OptionStatus Source #

The status of advanced options for the specified domain.

AdvancedSecurityOptions

advancedSecurityOptions_anonymousAuthEnabled :: Lens' AdvancedSecurityOptions (Maybe Bool) Source #

True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

advancedSecurityOptions_enabled :: Lens' AdvancedSecurityOptions (Maybe Bool) Source #

True if fine-grained access control is enabled.

advancedSecurityOptions_sAMLOptions :: Lens' AdvancedSecurityOptions (Maybe SAMLOptionsOutput) Source #

Container for information about the SAML configuration for OpenSearch Dashboards.

AdvancedSecurityOptionsInput

advancedSecurityOptionsInput_anonymousAuthEnabled :: Lens' AdvancedSecurityOptionsInput (Maybe Bool) Source #

True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

advancedSecurityOptionsInput_sAMLOptions :: Lens' AdvancedSecurityOptionsInput (Maybe SAMLOptionsInput) Source #

Container for information about the SAML configuration for OpenSearch Dashboards.

AdvancedSecurityOptionsStatus

advancedSecurityOptionsStatus_status :: Lens' AdvancedSecurityOptionsStatus OptionStatus Source #

Status of the fine-grained access control settings for a domain.

AuthorizedPrincipal

AutoTune

autoTune_autoTuneDetails :: Lens' AutoTune (Maybe AutoTuneDetails) Source #

Details about an Auto-Tune action.

autoTune_autoTuneType :: Lens' AutoTune (Maybe AutoTuneType) Source #

The type of Auto-Tune action.

AutoTuneDetails

autoTuneDetails_scheduledAutoTuneDetails :: Lens' AutoTuneDetails (Maybe ScheduledAutoTuneDetails) Source #

Container for details about a scheduled Auto-Tune action.

AutoTuneMaintenanceSchedule

autoTuneMaintenanceSchedule_cronExpressionForRecurrence :: Lens' AutoTuneMaintenanceSchedule (Maybe Text) Source #

A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

autoTuneMaintenanceSchedule_duration :: Lens' AutoTuneMaintenanceSchedule (Maybe Duration) Source #

The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}.

autoTuneMaintenanceSchedule_startAt :: Lens' AutoTuneMaintenanceSchedule (Maybe UTCTime) Source #

The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

AutoTuneOptions

autoTuneOptions_maintenanceSchedules :: Lens' AutoTuneOptions (Maybe [AutoTuneMaintenanceSchedule]) Source #

A list of maintenance schedules during which Auto-Tune can deploy changes.

autoTuneOptions_rollbackOnDisable :: Lens' AutoTuneOptions (Maybe RollbackOnDisable) Source #

When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

AutoTuneOptionsInput

autoTuneOptionsInput_maintenanceSchedules :: Lens' AutoTuneOptionsInput (Maybe [AutoTuneMaintenanceSchedule]) Source #

A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance schedules are overwrite, not append. If your request includes no schedules, the request deletes all existing schedules. To preserve existing schedules, make a call to DescribeDomainConfig first and use the MaintenanceSchedules portion of the response as the basis for this section.

AutoTuneOptionsOutput

autoTuneOptionsOutput_errorMessage :: Lens' AutoTuneOptionsOutput (Maybe Text) Source #

Any errors that occurred while enabling or disabling Auto-Tune.

autoTuneOptionsOutput_state :: Lens' AutoTuneOptionsOutput (Maybe AutoTuneState) Source #

The current state of Auto-Tune on the domain.

AutoTuneOptionsStatus

autoTuneOptionsStatus_status :: Lens' AutoTuneOptionsStatus (Maybe AutoTuneStatus) Source #

The current status of Auto-Tune for a domain.

AutoTuneStatus

autoTuneStatus_errorMessage :: Lens' AutoTuneStatus (Maybe Text) Source #

Any errors that occurred while enabling or disabling Auto-Tune.

autoTuneStatus_pendingDeletion :: Lens' AutoTuneStatus (Maybe Bool) Source #

Indicates whether the domain is being deleted.

autoTuneStatus_updateVersion :: Lens' AutoTuneStatus (Maybe Natural) Source #

The latest version of the Auto-Tune options.

autoTuneStatus_creationDate :: Lens' AutoTuneStatus UTCTime Source #

Date and time when Auto-Tune was enabled for the domain.

autoTuneStatus_updateDate :: Lens' AutoTuneStatus UTCTime Source #

Date and time when the Auto-Tune options were last updated for the domain.

autoTuneStatus_state :: Lens' AutoTuneStatus AutoTuneState Source #

The current state of Auto-Tune on the domain.

ChangeProgressDetails

changeProgressDetails_message :: Lens' ChangeProgressDetails (Maybe Text) Source #

A message corresponding to the status of the configuration change.

ChangeProgressStage

changeProgressStage_lastUpdated :: Lens' ChangeProgressStage (Maybe UTCTime) Source #

The most recent updated timestamp of the stage.

ChangeProgressStatusDetails

changeProgressStatusDetails_changeId :: Lens' ChangeProgressStatusDetails (Maybe Text) Source #

The unique change identifier associated with a specific domain configuration change.

changeProgressStatusDetails_changeProgressStages :: Lens' ChangeProgressStatusDetails (Maybe [ChangeProgressStage]) Source #

The specific stages that the domain is going through to perform the configuration change.

changeProgressStatusDetails_completedProperties :: Lens' ChangeProgressStatusDetails (Maybe [Text]) Source #

The list of properties in the domain configuration change that have completed.

changeProgressStatusDetails_pendingProperties :: Lens' ChangeProgressStatusDetails (Maybe [Text]) Source #

The list of properties in the domain configuration change that are still pending.

changeProgressStatusDetails_startTime :: Lens' ChangeProgressStatusDetails (Maybe UTCTime) Source #

The time at which the configuration change is made on the domain.

changeProgressStatusDetails_status :: Lens' ChangeProgressStatusDetails (Maybe OverallChangeStatus) Source #

The overall status of the domain configuration change.

changeProgressStatusDetails_totalNumberOfStages :: Lens' ChangeProgressStatusDetails (Maybe Int) Source #

The total number of stages required for the configuration change.

ClusterConfig

clusterConfig_coldStorageOptions :: Lens' ClusterConfig (Maybe ColdStorageOptions) Source #

Container for cold storage configuration options.

clusterConfig_dedicatedMasterCount :: Lens' ClusterConfig (Maybe Int) Source #

Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

clusterConfig_dedicatedMasterEnabled :: Lens' ClusterConfig (Maybe Bool) Source #

Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

clusterConfig_dedicatedMasterType :: Lens' ClusterConfig (Maybe OpenSearchPartitionInstanceType) Source #

OpenSearch Service instance type of the dedicated master nodes in the cluster.

clusterConfig_instanceCount :: Lens' ClusterConfig (Maybe Int) Source #

Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

clusterConfig_warmCount :: Lens' ClusterConfig (Maybe Int) Source #

The number of warm nodes in the cluster.

clusterConfig_warmEnabled :: Lens' ClusterConfig (Maybe Bool) Source #

Whether to enable warm storage for the cluster.

clusterConfig_warmType :: Lens' ClusterConfig (Maybe OpenSearchWarmPartitionInstanceType) Source #

The instance type for the cluster's warm nodes.

clusterConfig_zoneAwarenessConfig :: Lens' ClusterConfig (Maybe ZoneAwarenessConfig) Source #

Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

clusterConfig_zoneAwarenessEnabled :: Lens' ClusterConfig (Maybe Bool) Source #

Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

ClusterConfigStatus

clusterConfigStatus_options :: Lens' ClusterConfigStatus ClusterConfig Source #

Cluster configuration options for the specified domain.

clusterConfigStatus_status :: Lens' ClusterConfigStatus OptionStatus Source #

The status of cluster configuration options for the specified domain.

CognitoOptions

cognitoOptions_enabled :: Lens' CognitoOptions (Maybe Bool) Source #

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

cognitoOptions_identityPoolId :: Lens' CognitoOptions (Maybe Text) Source #

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

cognitoOptions_roleArn :: Lens' CognitoOptions (Maybe Text) Source #

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

cognitoOptions_userPoolId :: Lens' CognitoOptions (Maybe Text) Source #

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

CognitoOptionsStatus

cognitoOptionsStatus_status :: Lens' CognitoOptionsStatus OptionStatus Source #

The status of the Cognito options for the specified domain.

ColdStorageOptions

coldStorageOptions_enabled :: Lens' ColdStorageOptions Bool Source #

Whether to enable or disable cold storage on the domain.

CompatibleVersionsMap

compatibleVersionsMap_sourceVersion :: Lens' CompatibleVersionsMap (Maybe Text) Source #

The current version that the OpenSearch Service domain is running.

compatibleVersionsMap_targetVersions :: Lens' CompatibleVersionsMap (Maybe [Text]) Source #

The possible versions that you can upgrade the domain to.

DescribePackagesFilter

describePackagesFilter_value :: Lens' DescribePackagesFilter (Maybe [Text]) Source #

A list of values for the specified filter field.

DomainConfig

domainConfig_accessPolicies :: Lens' DomainConfig (Maybe AccessPoliciesStatus) Source #

Specifies the access policies for the domain.

domainConfig_advancedOptions :: Lens' DomainConfig (Maybe AdvancedOptionsStatus) Source #

Key-value pairs to specify advanced configuration options. For more information, see Advanced options.

domainConfig_advancedSecurityOptions :: Lens' DomainConfig (Maybe AdvancedSecurityOptionsStatus) Source #

Container for fine-grained access control settings for the domain.

domainConfig_autoTuneOptions :: Lens' DomainConfig (Maybe AutoTuneOptionsStatus) Source #

Container for Auto-Tune settings for the domain.

domainConfig_changeProgressDetails :: Lens' DomainConfig (Maybe ChangeProgressDetails) Source #

Container for information about the progress of an existing configuration change.

domainConfig_clusterConfig :: Lens' DomainConfig (Maybe ClusterConfigStatus) Source #

Container for the cluster configuration of a the domain.

domainConfig_cognitoOptions :: Lens' DomainConfig (Maybe CognitoOptionsStatus) Source #

Container for Amazon Cognito options for the domain.

domainConfig_domainEndpointOptions :: Lens' DomainConfig (Maybe DomainEndpointOptionsStatus) Source #

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

domainConfig_eBSOptions :: Lens' DomainConfig (Maybe EBSOptionsStatus) Source #

Container for EBS options configured for an OpenSearch Service domain.

domainConfig_engineVersion :: Lens' DomainConfig (Maybe VersionStatus) Source #

The OpenSearch or Elasticsearch version that the domain is running.

domainConfig_logPublishingOptions :: Lens' DomainConfig (Maybe LogPublishingOptionsStatus) Source #

Key-value pairs to configure slow log publishing.

domainConfig_snapshotOptions :: Lens' DomainConfig (Maybe SnapshotOptionsStatus) Source #

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

domainConfig_vPCOptions :: Lens' DomainConfig (Maybe VPCDerivedInfoStatus) Source #

The current VPC options for the domain and the status of any updates to their configuration.

DomainEndpointOptions

domainEndpointOptions_customEndpoint :: Lens' DomainEndpointOptions (Maybe Text) Source #

The fully qualified URL for the custom endpoint.

domainEndpointOptions_customEndpointCertificateArn :: Lens' DomainEndpointOptions (Maybe Text) Source #

The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

domainEndpointOptions_customEndpointEnabled :: Lens' DomainEndpointOptions (Maybe Bool) Source #

Whether to enable a custom endpoint for the domain.

domainEndpointOptions_enforceHTTPS :: Lens' DomainEndpointOptions (Maybe Bool) Source #

True to require that all traffic to the domain arrive over HTTPS.

domainEndpointOptions_tLSSecurityPolicy :: Lens' DomainEndpointOptions (Maybe TLSSecurityPolicy) Source #

Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

Can be one of the following values:

  • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.
  • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

DomainEndpointOptionsStatus

DomainInfo

domainInfo_engineType :: Lens' DomainInfo (Maybe EngineType) Source #

The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.

DomainInformationContainer

DomainPackageDetails

domainPackageDetails_domainName :: Lens' DomainPackageDetails (Maybe Text) Source #

Name of the domain that the package is associated with.

domainPackageDetails_errorDetails :: Lens' DomainPackageDetails (Maybe ErrorDetails) Source #

Additional information if the package is in an error state. Null otherwise.

domainPackageDetails_lastUpdated :: Lens' DomainPackageDetails (Maybe UTCTime) Source #

Timestamp of the most recent update to the package association status.

domainPackageDetails_referencePath :: Lens' DomainPackageDetails (Maybe Text) Source #

Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as synonym_path for dictionary files.

DomainStatus

domainStatus_accessPolicies :: Lens' DomainStatus (Maybe Text) Source #

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

domainStatus_advancedOptions :: Lens' DomainStatus (Maybe (HashMap Text Text)) Source #

Key-value pairs that specify advanced configuration options.

domainStatus_changeProgressDetails :: Lens' DomainStatus (Maybe ChangeProgressDetails) Source #

Information about a configuration change happening on the domain.

domainStatus_cognitoOptions :: Lens' DomainStatus (Maybe CognitoOptions) Source #

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

domainStatus_created :: Lens' DomainStatus (Maybe Bool) Source #

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

domainStatus_deleted :: Lens' DomainStatus (Maybe Bool) Source #

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

domainStatus_domainEndpointOptions :: Lens' DomainStatus (Maybe DomainEndpointOptions) Source #

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

domainStatus_eBSOptions :: Lens' DomainStatus (Maybe EBSOptions) Source #

Container for EBS-based storage settings for the domain.

domainStatus_endpoint :: Lens' DomainStatus (Maybe Text) Source #

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

domainStatus_endpoints :: Lens' DomainStatus (Maybe (HashMap Text Text)) Source #

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

domainStatus_engineVersion :: Lens' DomainStatus (Maybe Text) Source #

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

domainStatus_nodeToNodeEncryptionOptions :: Lens' DomainStatus (Maybe NodeToNodeEncryptionOptions) Source #

Whether node-to-node encryption is enabled or disabled.

domainStatus_processing :: Lens' DomainStatus (Maybe Bool) Source #

The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

domainStatus_serviceSoftwareOptions :: Lens' DomainStatus (Maybe ServiceSoftwareOptions) Source #

The current status of the domain's service software.

domainStatus_snapshotOptions :: Lens' DomainStatus (Maybe SnapshotOptions) Source #

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

domainStatus_upgradeProcessing :: Lens' DomainStatus (Maybe Bool) Source #

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

domainStatus_vPCOptions :: Lens' DomainStatus (Maybe VPCDerivedInfo) Source #

The VPC configuration for the domain.

domainStatus_domainId :: Lens' DomainStatus Text Source #

Unique identifier for the domain.

domainStatus_domainName :: Lens' DomainStatus Text Source #

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

domainStatus_arn :: Lens' DomainStatus Text Source #

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

domainStatus_clusterConfig :: Lens' DomainStatus ClusterConfig Source #

Container for the cluster configuration of the domain.

DryRunResults

dryRunResults_deploymentType :: Lens' DryRunResults (Maybe Text) Source #

Specifies the way in which OpenSearch Service will apply an update. Possible values are:

  • Blue/Green - The update requires a blue/green deployment.
  • DynamicUpdate - No blue/green deployment required
  • Undetermined - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete.
  • None - The request doesn't include any configuration changes.

dryRunResults_message :: Lens' DryRunResults (Maybe Text) Source #

A message corresponding to the deployment type.

Duration

duration_unit :: Lens' Duration (Maybe TimeUnit) Source #

The unit of measurement for the duration of a maintenance schedule.

duration_value :: Lens' Duration (Maybe Natural) Source #

Integer to specify the value of a maintenance schedule duration.

EBSOptions

eBSOptions_eBSEnabled :: Lens' EBSOptions (Maybe Bool) Source #

Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

eBSOptions_iops :: Lens' EBSOptions (Maybe Int) Source #

Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

eBSOptions_throughput :: Lens' EBSOptions (Maybe Int) Source #

Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

eBSOptions_volumeSize :: Lens' EBSOptions (Maybe Int) Source #

Specifies the size (in GiB) of EBS volumes attached to data nodes.

eBSOptions_volumeType :: Lens' EBSOptions (Maybe VolumeType) Source #

Specifies the type of EBS volumes attached to data nodes.

EBSOptionsStatus

eBSOptionsStatus_options :: Lens' EBSOptionsStatus EBSOptions Source #

The configured EBS options for the specified domain.

eBSOptionsStatus_status :: Lens' EBSOptionsStatus OptionStatus Source #

The status of the EBS options for the specified domain.

EncryptionAtRestOptions

encryptionAtRestOptions_kmsKeyId :: Lens' EncryptionAtRestOptions (Maybe Text) Source #

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

EncryptionAtRestOptionsStatus

encryptionAtRestOptionsStatus_status :: Lens' EncryptionAtRestOptionsStatus OptionStatus Source #

The status of the encryption at rest options for the specified domain.

ErrorDetails

errorDetails_errorMessage :: Lens' ErrorDetails (Maybe Text) Source #

A message describing the error.

errorDetails_errorType :: Lens' ErrorDetails (Maybe Text) Source #

The type of error that occurred.

Filter

filter_name :: Lens' Filter (Maybe Text) Source #

The name of the filter.

filter_values :: Lens' Filter (Maybe (NonEmpty Text)) Source #

One or more values for the filter.

InboundConnection

inboundConnection_connectionId :: Lens' InboundConnection (Maybe Text) Source #

The unique identifier of the connection.

InboundConnectionStatus

inboundConnectionStatus_statusCode :: Lens' InboundConnectionStatus (Maybe InboundConnectionStatusCode) Source #

The status code for the connection. Can be one of the following:

  • PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
  • APPROVED: Inbound connection is pending acceptance by the remote domain owner.
  • PROVISIONING: Inbound connection is being provisioned.
  • ACTIVE: Inbound connection is active and ready to use.
  • REJECTING: Inbound connection rejection is in process.
  • REJECTED: Inbound connection is rejected.
  • DELETING: Inbound connection deletion is in progress.
  • DELETED: Inbound connection is deleted and can no longer be used.

InstanceCountLimits

InstanceLimits

instanceLimits_instanceCountLimits :: Lens' InstanceLimits (Maybe InstanceCountLimits) Source #

Limits on the number of instances that can be created for a given instance type.

InstanceTypeDetails

instanceTypeDetails_advancedSecurityEnabled :: Lens' InstanceTypeDetails (Maybe Bool) Source #

Whether fine-grained access control is supported for the instance type.

instanceTypeDetails_appLogsEnabled :: Lens' InstanceTypeDetails (Maybe Bool) Source #

Whether logging is supported for the instance type.

instanceTypeDetails_cognitoEnabled :: Lens' InstanceTypeDetails (Maybe Bool) Source #

Whether Amazon Cognito access is supported for the instance type.

instanceTypeDetails_encryptionEnabled :: Lens' InstanceTypeDetails (Maybe Bool) Source #

Whether encryption at rest and node-to-node encryption are supported for the instance type.

instanceTypeDetails_instanceRole :: Lens' InstanceTypeDetails (Maybe [Text]) Source #

Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.

instanceTypeDetails_warmEnabled :: Lens' InstanceTypeDetails (Maybe Bool) Source #

Whether UltraWarm is supported for the instance type.

Limits

limits_additionalLimits :: Lens' Limits (Maybe [AdditionalLimit]) Source #

List of additional limits that are specific to a given instance type for each of its instance roles.

limits_instanceLimits :: Lens' Limits (Maybe InstanceLimits) Source #

The limits for a given instance type.

limits_storageTypes :: Lens' Limits (Maybe [StorageType]) Source #

Storage-related attributes that are available for a given instance type.

LogPublishingOption

logPublishingOption_cloudWatchLogsLogGroupArn :: Lens' LogPublishingOption (Maybe Text) Source #

The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

logPublishingOption_enabled :: Lens' LogPublishingOption (Maybe Bool) Source #

Whether the log should be published.

LogPublishingOptionsStatus

logPublishingOptionsStatus_status :: Lens' LogPublishingOptionsStatus (Maybe OptionStatus) Source #

The status of the log publishing options for the domain.

MasterUserOptions

masterUserOptions_masterUserARN :: Lens' MasterUserOptions (Maybe Text) Source #

Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false.

masterUserOptions_masterUserName :: Lens' MasterUserOptions (Maybe Text) Source #

User name for the master user. Only specify if InternalUserDatabaseEnabled is true.

masterUserOptions_masterUserPassword :: Lens' MasterUserOptions (Maybe Text) Source #

Password for the master user. Only specify if InternalUserDatabaseEnabled is true.

NodeToNodeEncryptionOptions

NodeToNodeEncryptionOptionsStatus

nodeToNodeEncryptionOptionsStatus_status :: Lens' NodeToNodeEncryptionOptionsStatus OptionStatus Source #

The status of the node-to-node encryption options for the specified domain.

OptionStatus

optionStatus_pendingDeletion :: Lens' OptionStatus (Maybe Bool) Source #

Indicates whether the entity is being deleted.

optionStatus_updateVersion :: Lens' OptionStatus (Maybe Natural) Source #

The latest version of the entity.

optionStatus_creationDate :: Lens' OptionStatus UTCTime Source #

The timestamp when the entity was created.

optionStatus_updateDate :: Lens' OptionStatus UTCTime Source #

The timestamp of the last time the entity was updated.

OutboundConnection

outboundConnection_connectionId :: Lens' OutboundConnection (Maybe Text) Source #

Unique identifier of the connection.

OutboundConnectionStatus

outboundConnectionStatus_message :: Lens' OutboundConnectionStatus (Maybe Text) Source #

Verbose information for the outbound connection.

outboundConnectionStatus_statusCode :: Lens' OutboundConnectionStatus (Maybe OutboundConnectionStatusCode) Source #

The status code for the outbound connection. Can be one of the following:

  • VALIDATING - The outbound connection request is being validated.
  • VALIDATION_FAILED - Validation failed for the connection request.
  • PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
  • APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
  • PROVISIONING - Outbound connection request is in process.
  • ACTIVE - Outbound connection is active and ready to use.
  • REJECTING - Outbound connection rejection by remote domain owner is in progress.
  • REJECTED - Outbound connection request is rejected by remote domain owner.
  • DELETING - Outbound connection deletion is in progress.
  • DELETED - Outbound connection is deleted and can no longer be used.

PackageDetails

packageDetails_createdAt :: Lens' PackageDetails (Maybe UTCTime) Source #

The timestamp when the package was created.

packageDetails_errorDetails :: Lens' PackageDetails (Maybe ErrorDetails) Source #

Additional information if the package is in an error state. Null otherwise.

packageDetails_lastUpdatedAt :: Lens' PackageDetails (Maybe UTCTime) Source #

Date and time when the package was last updated.

packageDetails_packageDescription :: Lens' PackageDetails (Maybe Text) Source #

User-specified description of the package.

packageDetails_packageID :: Lens' PackageDetails (Maybe Text) Source #

The unique identifier of the package.

packageDetails_packageName :: Lens' PackageDetails (Maybe Text) Source #

User-specified name of the package.

PackageSource

packageSource_s3BucketName :: Lens' PackageSource (Maybe Text) Source #

The name of the Amazon S3 bucket containing the package.

packageSource_s3Key :: Lens' PackageSource (Maybe Text) Source #

Key (file name) of the package.

PackageVersionHistory

packageVersionHistory_commitMessage :: Lens' PackageVersionHistory (Maybe Text) Source #

A message associated with the package version when it was uploaded.

packageVersionHistory_createdAt :: Lens' PackageVersionHistory (Maybe UTCTime) Source #

The date and time when the package was created.

RecurringCharge

recurringCharge_recurringChargeAmount :: Lens' RecurringCharge (Maybe Double) Source #

The monetary amount of the recurring charge.

ReservedInstance

reservedInstance_billingSubscriptionId :: Lens' ReservedInstance (Maybe Integer) Source #

The unique identifier of the billing subscription.

reservedInstance_currencyCode :: Lens' ReservedInstance (Maybe Text) Source #

The currency code for the offering.

reservedInstance_duration :: Lens' ReservedInstance (Maybe Int) Source #

The duration, in seconds, for which the OpenSearch instance is reserved.

reservedInstance_fixedPrice :: Lens' ReservedInstance (Maybe Double) Source #

The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.

reservedInstance_instanceCount :: Lens' ReservedInstance (Maybe Int) Source #

The number of OpenSearch instances that have been reserved.

reservedInstance_instanceType :: Lens' ReservedInstance (Maybe OpenSearchPartitionInstanceType) Source #

The OpenSearch instance type offered by theReserved Instance offering.

reservedInstance_paymentOption :: Lens' ReservedInstance (Maybe ReservedInstancePaymentOption) Source #

The payment option as defined in the Reserved Instance offering.

reservedInstance_recurringCharges :: Lens' ReservedInstance (Maybe [RecurringCharge]) Source #

The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.

reservedInstance_reservationName :: Lens' ReservedInstance (Maybe Text) Source #

The customer-specified identifier to track this reservation.

reservedInstance_reservedInstanceId :: Lens' ReservedInstance (Maybe Text) Source #

The unique identifier for the reservation.

reservedInstance_reservedInstanceOfferingId :: Lens' ReservedInstance (Maybe Text) Source #

The unique identifier of the Reserved Instance offering.

reservedInstance_startTime :: Lens' ReservedInstance (Maybe UTCTime) Source #

The date and time when the reservation was purchased.

reservedInstance_state :: Lens' ReservedInstance (Maybe Text) Source #

The state of the Reserved Instance.

reservedInstance_usagePrice :: Lens' ReservedInstance (Maybe Double) Source #

The hourly rate at which you're charged for the domain using this Reserved Instance.

ReservedInstanceOffering

reservedInstanceOffering_currencyCode :: Lens' ReservedInstanceOffering (Maybe Text) Source #

The currency code for the Reserved Instance offering.

reservedInstanceOffering_duration :: Lens' ReservedInstanceOffering (Maybe Int) Source #

The duration, in seconds, for which the offering will reserve the OpenSearch instance.

reservedInstanceOffering_fixedPrice :: Lens' ReservedInstanceOffering (Maybe Double) Source #

The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.

reservedInstanceOffering_instanceType :: Lens' ReservedInstanceOffering (Maybe OpenSearchPartitionInstanceType) Source #

The OpenSearch instance type offered by the Reserved Instance offering.

reservedInstanceOffering_recurringCharges :: Lens' ReservedInstanceOffering (Maybe [RecurringCharge]) Source #

The recurring charge to your account, regardless of whether you creates any domains using the offering.

reservedInstanceOffering_reservedInstanceOfferingId :: Lens' ReservedInstanceOffering (Maybe Text) Source #

The unique identifier of the Reserved Instance offering.

reservedInstanceOffering_usagePrice :: Lens' ReservedInstanceOffering (Maybe Double) Source #

The hourly rate at which you're charged for the domain using this Reserved Instance.

SAMLIdp

sAMLIdp_metadataContent :: Lens' SAMLIdp Text Source #

The metadata of the SAML application, in XML format.

sAMLIdp_entityId :: Lens' SAMLIdp Text Source #

The unique entity ID of the application in the SAML identity provider.

SAMLOptionsInput

sAMLOptionsInput_enabled :: Lens' SAMLOptionsInput (Maybe Bool) Source #

True to enable SAML authentication for a domain.

sAMLOptionsInput_idp :: Lens' SAMLOptionsInput (Maybe SAMLIdp) Source #

The SAML Identity Provider's information.

sAMLOptionsInput_masterBackendRole :: Lens' SAMLOptionsInput (Maybe Text) Source #

The backend role that the SAML master user is mapped to.

sAMLOptionsInput_masterUserName :: Lens' SAMLOptionsInput (Maybe Text) Source #

The SAML master user name, which is stored in the domain's internal user database.

sAMLOptionsInput_rolesKey :: Lens' SAMLOptionsInput (Maybe Text) Source #

Element of the SAML assertion to use for backend roles. Default is roles.

sAMLOptionsInput_sessionTimeoutMinutes :: Lens' SAMLOptionsInput (Maybe Int) Source #

The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

sAMLOptionsInput_subjectKey :: Lens' SAMLOptionsInput (Maybe Text) Source #

Element of the SAML assertion to use for the user name. Default is NameID.

SAMLOptionsOutput

sAMLOptionsOutput_idp :: Lens' SAMLOptionsOutput (Maybe SAMLIdp) Source #

Describes the SAML identity provider's information.

sAMLOptionsOutput_rolesKey :: Lens' SAMLOptionsOutput (Maybe Text) Source #

The key used for matching the SAML roles attribute.

sAMLOptionsOutput_sessionTimeoutMinutes :: Lens' SAMLOptionsOutput (Maybe Int) Source #

The duration, in minutes, after which a user session becomes inactive.

sAMLOptionsOutput_subjectKey :: Lens' SAMLOptionsOutput (Maybe Text) Source #

The key used for matching the SAML subject attribute.

ScheduledAutoTuneDetails

scheduledAutoTuneDetails_date :: Lens' ScheduledAutoTuneDetails (Maybe UTCTime) Source #

The date and time when the Auto-Tune action is scheduled for the domain.

scheduledAutoTuneDetails_severity :: Lens' ScheduledAutoTuneDetails (Maybe ScheduledAutoTuneSeverityType) Source #

The severity of the Auto-Tune action. Valid values are LOW, MEDIUM, and HIGH.

ServiceSoftwareOptions

serviceSoftwareOptions_automatedUpdateDate :: Lens' ServiceSoftwareOptions (Maybe UTCTime) Source #

The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

serviceSoftwareOptions_cancellable :: Lens' ServiceSoftwareOptions (Maybe Bool) Source #

True if you're able to cancel your service software version update. False if you can't cancel your service software update.

serviceSoftwareOptions_currentVersion :: Lens' ServiceSoftwareOptions (Maybe Text) Source #

The current service software version present on the domain.

serviceSoftwareOptions_description :: Lens' ServiceSoftwareOptions (Maybe Text) Source #

A description of the service software update status.

serviceSoftwareOptions_newVersion :: Lens' ServiceSoftwareOptions (Maybe Text) Source #

The new service software version, if one is available.

serviceSoftwareOptions_optionalDeployment :: Lens' ServiceSoftwareOptions (Maybe Bool) Source #

True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

serviceSoftwareOptions_updateAvailable :: Lens' ServiceSoftwareOptions (Maybe Bool) Source #

True if you're able to update your service software version. False if you can't update your service software version.

SnapshotOptions

snapshotOptions_automatedSnapshotStartHour :: Lens' SnapshotOptions (Maybe Int) Source #

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

SnapshotOptionsStatus

snapshotOptionsStatus_options :: Lens' SnapshotOptionsStatus SnapshotOptions Source #

The daily snapshot options specified for the domain.

snapshotOptionsStatus_status :: Lens' SnapshotOptionsStatus OptionStatus Source #

The status of a daily automated snapshot.

StorageType

storageType_storageSubTypeName :: Lens' StorageType (Maybe Text) Source #

The storage sub-type, such as gp3 or io1.

storageType_storageTypeLimits :: Lens' StorageType (Maybe [StorageTypeLimit]) Source #

Limits that are applicable for the given storage type.

storageType_storageTypeName :: Lens' StorageType (Maybe Text) Source #

The name of the storage type.

StorageTypeLimit

storageTypeLimit_limitName :: Lens' StorageTypeLimit (Maybe Text) Source #

Name of storage limits that are applicable for the given storage type. If StorageType is ebs, the following options are available:

  • MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.
  • MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.
  • MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
  • MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
  • MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
  • MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.

Tag

tag_key :: Lens' Tag Text Source #

The tag key. Tag keys must be unique for the domain to which they are attached.

tag_value :: Lens' Tag Text Source #

The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

UpgradeHistory

upgradeHistory_startTimestamp :: Lens' UpgradeHistory (Maybe UTCTime) Source #

UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ.

upgradeHistory_stepsList :: Lens' UpgradeHistory (Maybe [UpgradeStepItem]) Source #

A list of each step performed as part of a specific upgrade or upgrade eligibility check.

upgradeHistory_upgradeName :: Lens' UpgradeHistory (Maybe Text) Source #

A string that describes the upgrade.

upgradeHistory_upgradeStatus :: Lens' UpgradeHistory (Maybe UpgradeStatus) Source #

The current status of the upgrade. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

UpgradeStepItem

upgradeStepItem_issues :: Lens' UpgradeStepItem (Maybe [Text]) Source #

A list of strings containing detailed information about the errors encountered in a particular step.

upgradeStepItem_progressPercent :: Lens' UpgradeStepItem (Maybe Double) Source #

The floating point value representing the progress percentage of a particular step.

upgradeStepItem_upgradeStep :: Lens' UpgradeStepItem (Maybe UpgradeStep) Source #

One of three steps that an upgrade or upgrade eligibility check goes through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

upgradeStepItem_upgradeStepStatus :: Lens' UpgradeStepItem (Maybe UpgradeStatus) Source #

The current status of the upgrade. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

VPCDerivedInfo

vPCDerivedInfo_availabilityZones :: Lens' VPCDerivedInfo (Maybe [Text]) Source #

The list of Availability Zones associated with the VPC subnets.

vPCDerivedInfo_securityGroupIds :: Lens' VPCDerivedInfo (Maybe [Text]) Source #

The list of security group IDs associated with the VPC endpoints for the domain.

vPCDerivedInfo_subnetIds :: Lens' VPCDerivedInfo (Maybe [Text]) Source #

A list of subnet IDs associated with the VPC endpoints for the domain.

vPCDerivedInfo_vPCId :: Lens' VPCDerivedInfo (Maybe Text) Source #

The ID for your VPC. Amazon VPC generates this value when you create a VPC.

VPCDerivedInfoStatus

vPCDerivedInfoStatus_status :: Lens' VPCDerivedInfoStatus OptionStatus Source #

The status of the VPC options for the specified domain.

VPCOptions

vPCOptions_securityGroupIds :: Lens' VPCOptions (Maybe [Text]) Source #

The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

vPCOptions_subnetIds :: Lens' VPCOptions (Maybe [Text]) Source #

A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

VersionStatus

versionStatus_options :: Lens' VersionStatus Text Source #

The OpenSearch or Elasticsearch version for the specified domain.

versionStatus_status :: Lens' VersionStatus OptionStatus Source #

The status of the version options for the specified domain.

VpcEndpoint

vpcEndpoint_domainArn :: Lens' VpcEndpoint (Maybe Text) Source #

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

vpcEndpoint_endpoint :: Lens' VpcEndpoint (Maybe Text) Source #

The connection endpoint ID for connecting to the domain.

vpcEndpoint_status :: Lens' VpcEndpoint (Maybe VpcEndpointStatus) Source #

The current status of the endpoint.

vpcEndpoint_vpcEndpointId :: Lens' VpcEndpoint (Maybe Text) Source #

The unique identifier of the endpoint.

vpcEndpoint_vpcOptions :: Lens' VpcEndpoint (Maybe VPCDerivedInfo) Source #

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

VpcEndpointError

vpcEndpointError_vpcEndpointId :: Lens' VpcEndpointError (Maybe Text) Source #

The unique identifier of the endpoint.

VpcEndpointSummary

vpcEndpointSummary_domainArn :: Lens' VpcEndpointSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

vpcEndpointSummary_vpcEndpointId :: Lens' VpcEndpointSummary (Maybe Text) Source #

The unique identifier of the endpoint.

ZoneAwarenessConfig

zoneAwarenessConfig_availabilityZoneCount :: Lens' ZoneAwarenessConfig (Maybe Int) Source #

If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.