amazonka-elasticsearch-2.0: Amazon Elasticsearch 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.ElasticSearch.Lens

Contents

Description

 
Synopsis

Operations

AcceptInboundCrossClusterSearchConnection

acceptInboundCrossClusterSearchConnection_crossClusterSearchConnectionId :: Lens' AcceptInboundCrossClusterSearchConnection Text Source #

The id of the inbound connection that you want to accept.

acceptInboundCrossClusterSearchConnectionResponse_crossClusterSearchConnection :: Lens' AcceptInboundCrossClusterSearchConnectionResponse (Maybe InboundCrossClusterSearchConnection) Source #

Specifies the InboundCrossClusterSearchConnection of accepted inbound connection.

acceptInboundCrossClusterSearchConnectionResponse_httpStatus :: Lens' AcceptInboundCrossClusterSearchConnectionResponse Int Source #

The response's http status code.

AddTags

addTags_arn :: Lens' AddTags Text Source #

Specify the ARN for which you want to add the tags.

addTags_tagList :: Lens' AddTags [Tag] Source #

List of Tag that need to be added for the Elasticsearch domain.

AssociatePackage

associatePackage_packageID :: Lens' AssociatePackage Text Source #

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

associatePackage_domainName :: Lens' AssociatePackage Text Source #

Name of the domain that you want to associate the package with.

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

DomainPackageDetails

associatePackageResponse_httpStatus :: Lens' AssociatePackageResponse Int Source #

The response's http status code.

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 account ID to grant access to.

authorizeVpcEndpointAccessResponse_httpStatus :: Lens' AuthorizeVpcEndpointAccessResponse Int Source #

The response's http status code.

authorizeVpcEndpointAccessResponse_authorizedPrincipal :: Lens' AuthorizeVpcEndpointAccessResponse AuthorizedPrincipal Source #

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

CancelElasticsearchServiceSoftwareUpdate

cancelElasticsearchServiceSoftwareUpdate_domainName :: Lens' CancelElasticsearchServiceSoftwareUpdate Text Source #

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

cancelElasticsearchServiceSoftwareUpdateResponse_serviceSoftwareOptions :: Lens' CancelElasticsearchServiceSoftwareUpdateResponse (Maybe ServiceSoftwareOptions) Source #

The current status of the Elasticsearch service software update.

cancelElasticsearchServiceSoftwareUpdateResponse_httpStatus :: Lens' CancelElasticsearchServiceSoftwareUpdateResponse Int Source #

The response's http status code.

CreateElasticsearchDomain

createElasticsearchDomain_accessPolicies :: Lens' CreateElasticsearchDomain (Maybe Text) Source #

IAM access policy as a JSON-formatted string.

createElasticsearchDomain_advancedOptions :: Lens' CreateElasticsearchDomain (Maybe (HashMap Text Text)) Source #

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

createElasticsearchDomain_advancedSecurityOptions :: Lens' CreateElasticsearchDomain (Maybe AdvancedSecurityOptionsInput) Source #

Specifies advanced security options.

createElasticsearchDomain_autoTuneOptions :: Lens' CreateElasticsearchDomain (Maybe AutoTuneOptionsInput) Source #

Specifies Auto-Tune options.

createElasticsearchDomain_cognitoOptions :: Lens' CreateElasticsearchDomain (Maybe CognitoOptions) Source #

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

createElasticsearchDomain_domainEndpointOptions :: Lens' CreateElasticsearchDomain (Maybe DomainEndpointOptions) Source #

Options to specify configuration that will be applied to the domain endpoint.

createElasticsearchDomain_eBSOptions :: Lens' CreateElasticsearchDomain (Maybe EBSOptions) Source #

Options to enable, disable and specify the type and size of EBS storage volumes.

createElasticsearchDomain_elasticsearchClusterConfig :: Lens' CreateElasticsearchDomain (Maybe ElasticsearchClusterConfig) Source #

Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

createElasticsearchDomain_elasticsearchVersion :: Lens' CreateElasticsearchDomain (Maybe Text) Source #

String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

createElasticsearchDomain_encryptionAtRestOptions :: Lens' CreateElasticsearchDomain (Maybe EncryptionAtRestOptions) Source #

Specifies the Encryption At Rest Options.

createElasticsearchDomain_logPublishingOptions :: Lens' CreateElasticsearchDomain (Maybe (HashMap LogType LogPublishingOption)) Source #

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

createElasticsearchDomain_nodeToNodeEncryptionOptions :: Lens' CreateElasticsearchDomain (Maybe NodeToNodeEncryptionOptions) Source #

Specifies the NodeToNodeEncryptionOptions.

createElasticsearchDomain_snapshotOptions :: Lens' CreateElasticsearchDomain (Maybe SnapshotOptions) Source #

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

createElasticsearchDomain_tagList :: Lens' CreateElasticsearchDomain (Maybe [Tag]) Source #

A list of Tag added during domain creation.

createElasticsearchDomain_vPCOptions :: Lens' CreateElasticsearchDomain (Maybe VPCOptions) Source #

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

createElasticsearchDomain_domainName :: Lens' CreateElasticsearchDomain Text Source #

The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

createElasticsearchDomainResponse_domainStatus :: Lens' CreateElasticsearchDomainResponse (Maybe ElasticsearchDomainStatus) Source #

The status of the newly created Elasticsearch domain.

createElasticsearchDomainResponse_httpStatus :: Lens' CreateElasticsearchDomainResponse Int Source #

The response's http status code.

CreateOutboundCrossClusterSearchConnection

createOutboundCrossClusterSearchConnection_sourceDomainInfo :: Lens' CreateOutboundCrossClusterSearchConnection DomainInformation Source #

Specifies the DomainInformation for the source Elasticsearch domain.

createOutboundCrossClusterSearchConnection_destinationDomainInfo :: Lens' CreateOutboundCrossClusterSearchConnection DomainInformation Source #

Specifies the DomainInformation for the destination Elasticsearch domain.

createOutboundCrossClusterSearchConnection_connectionAlias :: Lens' CreateOutboundCrossClusterSearchConnection Text Source #

Specifies the connection alias that will be used by the customer for this connection.

createOutboundCrossClusterSearchConnectionResponse_connectionAlias :: Lens' CreateOutboundCrossClusterSearchConnectionResponse (Maybe Text) Source #

Specifies the connection alias provided during the create connection request.

createOutboundCrossClusterSearchConnectionResponse_connectionStatus :: Lens' CreateOutboundCrossClusterSearchConnectionResponse (Maybe OutboundCrossClusterSearchConnectionStatus) Source #

Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection.

createOutboundCrossClusterSearchConnectionResponse_crossClusterSearchConnectionId :: Lens' CreateOutboundCrossClusterSearchConnectionResponse (Maybe Text) Source #

Unique id for the created outbound connection, which is used for subsequent operations on connection.

createOutboundCrossClusterSearchConnectionResponse_destinationDomainInfo :: Lens' CreateOutboundCrossClusterSearchConnectionResponse (Maybe DomainInformation) Source #

Specifies the DomainInformation for the destination Elasticsearch domain.

createOutboundCrossClusterSearchConnectionResponse_sourceDomainInfo :: Lens' CreateOutboundCrossClusterSearchConnectionResponse (Maybe DomainInformation) Source #

Specifies the DomainInformation for the source Elasticsearch domain.

createOutboundCrossClusterSearchConnectionResponse_httpStatus :: Lens' CreateOutboundCrossClusterSearchConnectionResponse Int Source #

The response's http status code.

CreatePackage

createPackage_packageDescription :: Lens' CreatePackage (Maybe Text) Source #

Description of the package.

createPackage_packageName :: Lens' CreatePackage Text Source #

Unique identifier for the package.

createPackage_packageType :: Lens' CreatePackage PackageType Source #

Type of package. Currently supports only TXT-DICTIONARY.

createPackage_packageSource :: Lens' CreatePackage PackageSource Source #

The customer S3 location PackageSource for importing the package.

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

Information about the package PackageDetails.

createPackageResponse_httpStatus :: Lens' CreatePackageResponse Int Source #

The response's http status code.

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_httpStatus :: Lens' CreateVpcEndpointResponse Int Source #

The response's http status code.

createVpcEndpointResponse_vpcEndpoint :: Lens' CreateVpcEndpointResponse VpcEndpoint Source #

Information about the newly created VPC endpoint.

DeleteElasticsearchDomain

deleteElasticsearchDomain_domainName :: Lens' DeleteElasticsearchDomain Text Source #

The name of the Elasticsearch domain that you want to permanently delete.

deleteElasticsearchDomainResponse_domainStatus :: Lens' DeleteElasticsearchDomainResponse (Maybe ElasticsearchDomainStatus) Source #

The status of the Elasticsearch domain being deleted.

deleteElasticsearchDomainResponse_httpStatus :: Lens' DeleteElasticsearchDomainResponse Int Source #

The response's http status code.

DeleteElasticsearchServiceRole

DeleteInboundCrossClusterSearchConnection

deleteInboundCrossClusterSearchConnection_crossClusterSearchConnectionId :: Lens' DeleteInboundCrossClusterSearchConnection Text Source #

The id of the inbound connection that you want to permanently delete.

deleteInboundCrossClusterSearchConnectionResponse_crossClusterSearchConnection :: Lens' DeleteInboundCrossClusterSearchConnectionResponse (Maybe InboundCrossClusterSearchConnection) Source #

Specifies the InboundCrossClusterSearchConnection of deleted inbound connection.

deleteInboundCrossClusterSearchConnectionResponse_httpStatus :: Lens' DeleteInboundCrossClusterSearchConnectionResponse Int Source #

The response's http status code.

DeleteOutboundCrossClusterSearchConnection

deleteOutboundCrossClusterSearchConnection_crossClusterSearchConnectionId :: Lens' DeleteOutboundCrossClusterSearchConnection Text Source #

The id of the outbound connection that you want to permanently delete.

deleteOutboundCrossClusterSearchConnectionResponse_crossClusterSearchConnection :: Lens' DeleteOutboundCrossClusterSearchConnectionResponse (Maybe OutboundCrossClusterSearchConnection) Source #

Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection.

deleteOutboundCrossClusterSearchConnectionResponse_httpStatus :: Lens' DeleteOutboundCrossClusterSearchConnectionResponse Int Source #

The response's http status code.

DeletePackage

deletePackage_packageID :: Lens' DeletePackage Text Source #

Internal ID of the package that you want to delete. Use DescribePackages to find this value.

deletePackageResponse_packageDetails :: Lens' DeletePackageResponse (Maybe PackageDetails) Source #

PackageDetails

deletePackageResponse_httpStatus :: Lens' DeletePackageResponse Int Source #

The response's http status code.

DeleteVpcEndpoint

deleteVpcEndpoint_vpcEndpointId :: Lens' DeleteVpcEndpoint Text Source #

The unique identifier of the endpoint to be deleted.

deleteVpcEndpointResponse_httpStatus :: Lens' DeleteVpcEndpointResponse Int Source #

The response's http status code.

deleteVpcEndpointResponse_vpcEndpointSummary :: Lens' DeleteVpcEndpointResponse VpcEndpointSummary Source #

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

DescribeDomainAutoTunes

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

Set this value to limit the number of results returned. If not specified, defaults to 100.

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

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

describeDomainAutoTunes_domainName :: Lens' DescribeDomainAutoTunes Text Source #

Specifies the domain name for which you want Auto-Tune action details.

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

Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.

describeDomainAutoTunesResponse_nextToken :: Lens' DescribeDomainAutoTunesResponse (Maybe Text) Source #

Specifies an identifier to allow retrieval of paginated results.

describeDomainAutoTunesResponse_httpStatus :: Lens' DescribeDomainAutoTunesResponse Int Source #

The response's http status code.

DescribeDomainChangeProgress

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

The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.

describeDomainChangeProgress_domainName :: Lens' DescribeDomainChangeProgress Text Source #

The domain you want to get the progress information about.

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

Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.

describeDomainChangeProgressResponse_httpStatus :: Lens' DescribeDomainChangeProgressResponse Int Source #

The response's http status code.

DescribeElasticsearchDomain

describeElasticsearchDomain_domainName :: Lens' DescribeElasticsearchDomain Text Source #

The name of the Elasticsearch domain for which you want information.

describeElasticsearchDomainResponse_httpStatus :: Lens' DescribeElasticsearchDomainResponse Int Source #

The response's http status code.

describeElasticsearchDomainResponse_domainStatus :: Lens' DescribeElasticsearchDomainResponse ElasticsearchDomainStatus Source #

The current status of the Elasticsearch domain.

DescribeElasticsearchDomainConfig

describeElasticsearchDomainConfig_domainName :: Lens' DescribeElasticsearchDomainConfig Text Source #

The Elasticsearch domain that you want to get information about.

describeElasticsearchDomainConfigResponse_httpStatus :: Lens' DescribeElasticsearchDomainConfigResponse Int Source #

The response's http status code.

describeElasticsearchDomainConfigResponse_domainConfig :: Lens' DescribeElasticsearchDomainConfigResponse ElasticsearchDomainConfig Source #

The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.

DescribeElasticsearchDomains

describeElasticsearchDomains_domainNames :: Lens' DescribeElasticsearchDomains [Text] Source #

The Elasticsearch domains for which you want information.

describeElasticsearchDomainsResponse_httpStatus :: Lens' DescribeElasticsearchDomainsResponse Int Source #

The response's http status code.

describeElasticsearchDomainsResponse_domainStatusList :: Lens' DescribeElasticsearchDomainsResponse [ElasticsearchDomainStatus] Source #

The status of the domains requested in the DescribeElasticsearchDomains request.

DescribeElasticsearchInstanceTypeLimits

describeElasticsearchInstanceTypeLimits_domainName :: Lens' DescribeElasticsearchInstanceTypeLimits (Maybe Text) Source #

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain.

describeElasticsearchInstanceTypeLimits_instanceType :: Lens' DescribeElasticsearchInstanceTypeLimits ESPartitionInstanceType Source #

The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed.

describeElasticsearchInstanceTypeLimits_elasticsearchVersion :: Lens' DescribeElasticsearchInstanceTypeLimits Text Source #

Version of Elasticsearch for which Limits are needed.

describeElasticsearchInstanceTypeLimitsResponse_limitsByRole :: Lens' DescribeElasticsearchInstanceTypeLimitsResponse (Maybe (HashMap Text Limits)) Source #

Undocumented member.

describeElasticsearchInstanceTypeLimitsResponse_httpStatus :: Lens' DescribeElasticsearchInstanceTypeLimitsResponse Int Source #

The response's http status code.

DescribeInboundCrossClusterSearchConnections

describeInboundCrossClusterSearchConnections_filters :: Lens' DescribeInboundCrossClusterSearchConnections (Maybe [Filter]) Source #

A list of filters used to match properties for inbound cross-cluster search connection. Available Filter names for this operation are:

  • cross-cluster-search-connection-id
  • source-domain-info.domain-name
  • source-domain-info.owner-id
  • source-domain-info.region
  • destination-domain-info.domain-name

describeInboundCrossClusterSearchConnections_maxResults :: Lens' DescribeInboundCrossClusterSearchConnections (Maybe Int) Source #

Set this value to limit the number of results returned. If not specified, defaults to 100.

describeInboundCrossClusterSearchConnections_nextToken :: Lens' DescribeInboundCrossClusterSearchConnections (Maybe Text) Source #

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

describeInboundCrossClusterSearchConnectionsResponse_crossClusterSearchConnections :: Lens' DescribeInboundCrossClusterSearchConnectionsResponse (Maybe [InboundCrossClusterSearchConnection]) Source #

Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.

describeInboundCrossClusterSearchConnectionsResponse_nextToken :: Lens' DescribeInboundCrossClusterSearchConnectionsResponse (Maybe Text) Source #

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

describeInboundCrossClusterSearchConnectionsResponse_httpStatus :: Lens' DescribeInboundCrossClusterSearchConnectionsResponse Int Source #

The response's http status code.

DescribeOutboundCrossClusterSearchConnections

describeOutboundCrossClusterSearchConnections_filters :: Lens' DescribeOutboundCrossClusterSearchConnections (Maybe [Filter]) Source #

A list of filters used to match properties for outbound cross-cluster search connection. Available Filter names for this operation are:

  • cross-cluster-search-connection-id
  • destination-domain-info.domain-name
  • destination-domain-info.owner-id
  • destination-domain-info.region
  • source-domain-info.domain-name

describeOutboundCrossClusterSearchConnections_maxResults :: Lens' DescribeOutboundCrossClusterSearchConnections (Maybe Int) Source #

Set this value to limit the number of results returned. If not specified, defaults to 100.

describeOutboundCrossClusterSearchConnections_nextToken :: Lens' DescribeOutboundCrossClusterSearchConnections (Maybe Text) Source #

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

describeOutboundCrossClusterSearchConnectionsResponse_crossClusterSearchConnections :: Lens' DescribeOutboundCrossClusterSearchConnectionsResponse (Maybe [OutboundCrossClusterSearchConnection]) Source #

Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.

describeOutboundCrossClusterSearchConnectionsResponse_nextToken :: Lens' DescribeOutboundCrossClusterSearchConnectionsResponse (Maybe Text) Source #

If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

describeOutboundCrossClusterSearchConnectionsResponse_httpStatus :: Lens' DescribeOutboundCrossClusterSearchConnectionsResponse Int Source #

The response's http status code.

DescribePackages

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

Only returns packages that match the DescribePackagesFilterList values.

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

Limits results to a maximum number of packages.

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

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

describePackagesResponse_nextToken :: Lens' DescribePackagesResponse (Maybe Text) Source #

Undocumented member.

describePackagesResponse_packageDetailsList :: Lens' DescribePackagesResponse (Maybe [PackageDetails]) Source #

List of PackageDetails objects.

describePackagesResponse_httpStatus :: Lens' DescribePackagesResponse Int Source #

The response's http status code.

DescribeReservedElasticsearchInstanceOfferings

describeReservedElasticsearchInstanceOfferings_maxResults :: Lens' DescribeReservedElasticsearchInstanceOfferings (Maybe Int) Source #

Set this value to limit the number of results returned. If not specified, defaults to 100.

describeReservedElasticsearchInstanceOfferings_nextToken :: Lens' DescribeReservedElasticsearchInstanceOfferings (Maybe Text) Source #

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

describeReservedElasticsearchInstanceOfferings_reservedElasticsearchInstanceOfferingId :: Lens' DescribeReservedElasticsearchInstanceOfferings (Maybe Text) Source #

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

describeReservedElasticsearchInstanceOfferingsResponse_nextToken :: Lens' DescribeReservedElasticsearchInstanceOfferingsResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeReservedElasticsearchInstanceOfferingsResponse_reservedElasticsearchInstanceOfferings :: Lens' DescribeReservedElasticsearchInstanceOfferingsResponse (Maybe [ReservedElasticsearchInstanceOffering]) Source #

List of reserved Elasticsearch instance offerings

describeReservedElasticsearchInstanceOfferingsResponse_httpStatus :: Lens' DescribeReservedElasticsearchInstanceOfferingsResponse Int Source #

The response's http status code.

DescribeReservedElasticsearchInstances

describeReservedElasticsearchInstances_maxResults :: Lens' DescribeReservedElasticsearchInstances (Maybe Int) Source #

Set this value to limit the number of results returned. If not specified, defaults to 100.

describeReservedElasticsearchInstances_nextToken :: Lens' DescribeReservedElasticsearchInstances (Maybe Text) Source #

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

describeReservedElasticsearchInstances_reservedElasticsearchInstanceId :: Lens' DescribeReservedElasticsearchInstances (Maybe Text) Source #

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

describeReservedElasticsearchInstancesResponse_nextToken :: Lens' DescribeReservedElasticsearchInstancesResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeReservedElasticsearchInstancesResponse_reservedElasticsearchInstances :: Lens' DescribeReservedElasticsearchInstancesResponse (Maybe [ReservedElasticsearchInstance]) Source #

List of reserved Elasticsearch instances.

describeReservedElasticsearchInstancesResponse_httpStatus :: Lens' DescribeReservedElasticsearchInstancesResponse Int Source #

The response's http status code.

DescribeVpcEndpoints

describeVpcEndpoints_vpcEndpointIds :: Lens' DescribeVpcEndpoints [Text] Source #

The unique identifiers of the endpoints to get information about.

describeVpcEndpointsResponse_httpStatus :: Lens' DescribeVpcEndpointsResponse Int Source #

The response's http status code.

describeVpcEndpointsResponse_vpcEndpoints :: Lens' DescribeVpcEndpointsResponse [VpcEndpoint] Source #

Information about each requested VPC endpoint.

describeVpcEndpointsResponse_vpcEndpointErrors :: Lens' DescribeVpcEndpointsResponse [VpcEndpointError] Source #

Any errors associated with the request.

DissociatePackage

dissociatePackage_packageID :: Lens' DissociatePackage Text Source #

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

dissociatePackage_domainName :: Lens' DissociatePackage Text Source #

Name of the domain that you want to associate the package with.

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

DomainPackageDetails

dissociatePackageResponse_httpStatus :: Lens' DissociatePackageResponse Int Source #

The response's http status code.

GetCompatibleElasticsearchVersions

getCompatibleElasticsearchVersions_domainName :: Lens' GetCompatibleElasticsearchVersions (Maybe Text) Source #

Undocumented member.

getCompatibleElasticsearchVersionsResponse_compatibleElasticsearchVersions :: Lens' GetCompatibleElasticsearchVersionsResponse (Maybe [CompatibleVersionsMap]) Source #

A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation.

getCompatibleElasticsearchVersionsResponse_httpStatus :: Lens' GetCompatibleElasticsearchVersionsResponse Int Source #

The response's http status code.

GetPackageVersionHistory

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

Limits results to a maximum number of versions.

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

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

getPackageVersionHistory_packageID :: Lens' GetPackageVersionHistory Text Source #

Returns an audit history of versions of the package.

getPackageVersionHistoryResponse_nextToken :: Lens' GetPackageVersionHistoryResponse (Maybe Text) Source #

Undocumented member.

getPackageVersionHistoryResponse_packageID :: Lens' GetPackageVersionHistoryResponse (Maybe Text) Source #

Undocumented member.

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

List of PackageVersionHistory objects.

getPackageVersionHistoryResponse_httpStatus :: Lens' GetPackageVersionHistoryResponse Int Source #

The response's http status code.

GetUpgradeHistory

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

Undocumented member.

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

Undocumented member.

getUpgradeHistory_domainName :: Lens' GetUpgradeHistory Text Source #

Undocumented member.

getUpgradeHistoryResponse_nextToken :: Lens' GetUpgradeHistoryResponse (Maybe Text) Source #

Pagination token that needs to be supplied to the next call to get the next page of results

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

A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of GetUpgradeHistoryResponse object.

getUpgradeHistoryResponse_httpStatus :: Lens' GetUpgradeHistoryResponse Int Source #

The response's http status code.

GetUpgradeStatus

getUpgradeStatus_domainName :: Lens' GetUpgradeStatus Text Source #

Undocumented member.

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

One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

getUpgradeStatusResponse_upgradeName :: Lens' GetUpgradeStatusResponse (Maybe Text) Source #

A string that describes the update briefly

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

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

getUpgradeStatusResponse_httpStatus :: Lens' GetUpgradeStatusResponse Int Source #

The response's http status code.

ListDomainNames

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

Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.

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

List of domain names and respective engine types.

listDomainNamesResponse_httpStatus :: Lens' ListDomainNamesResponse Int Source #

The response's http status code.

ListDomainsForPackage

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

Limits results to a maximum number of domains.

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

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

listDomainsForPackage_packageID :: Lens' ListDomainsForPackage Text Source #

The package for which to list domains.

listDomainsForPackageResponse_domainPackageDetailsList :: Lens' ListDomainsForPackageResponse (Maybe [DomainPackageDetails]) Source #

List of DomainPackageDetails objects.

listDomainsForPackageResponse_nextToken :: Lens' ListDomainsForPackageResponse (Maybe Text) Source #

Undocumented member.

listDomainsForPackageResponse_httpStatus :: Lens' ListDomainsForPackageResponse Int Source #

The response's http status code.

ListElasticsearchInstanceTypes

listElasticsearchInstanceTypes_domainName :: Lens' ListElasticsearchInstanceTypes (Maybe Text) Source #

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

listElasticsearchInstanceTypes_maxResults :: Lens' ListElasticsearchInstanceTypes (Maybe Int) Source #

Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

listElasticsearchInstanceTypes_nextToken :: Lens' ListElasticsearchInstanceTypes (Maybe Text) Source #

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

listElasticsearchInstanceTypes_elasticsearchVersion :: Lens' ListElasticsearchInstanceTypes Text Source #

Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

listElasticsearchInstanceTypesResponse_elasticsearchInstanceTypes :: Lens' ListElasticsearchInstanceTypesResponse (Maybe [ESPartitionInstanceType]) Source #

List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion

listElasticsearchInstanceTypesResponse_nextToken :: Lens' ListElasticsearchInstanceTypesResponse (Maybe Text) Source #

In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.

listElasticsearchInstanceTypesResponse_httpStatus :: Lens' ListElasticsearchInstanceTypesResponse Int Source #

The response's http status code.

ListElasticsearchVersions

listElasticsearchVersions_maxResults :: Lens' ListElasticsearchVersions (Maybe Int) Source #

Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored.

listElasticsearchVersions_nextToken :: Lens' ListElasticsearchVersions (Maybe Text) Source #

Undocumented member.

listElasticsearchVersionsResponse_elasticsearchVersions :: Lens' ListElasticsearchVersionsResponse (Maybe [Text]) Source #

Undocumented member.

listElasticsearchVersionsResponse_nextToken :: Lens' ListElasticsearchVersionsResponse (Maybe Text) Source #

Undocumented member.

listElasticsearchVersionsResponse_httpStatus :: Lens' ListElasticsearchVersionsResponse Int Source #

The response's http status code.

ListPackagesForDomain

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

Limits results to a maximum number of packages.

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

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

listPackagesForDomain_domainName :: Lens' ListPackagesForDomain Text Source #

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

listPackagesForDomainResponse_domainPackageDetailsList :: Lens' ListPackagesForDomainResponse (Maybe [DomainPackageDetails]) Source #

List of DomainPackageDetails objects.

listPackagesForDomainResponse_nextToken :: Lens' ListPackagesForDomainResponse (Maybe Text) Source #

Pagination token that needs to be supplied to the next call to get the next page of results.

listPackagesForDomainResponse_httpStatus :: Lens' ListPackagesForDomainResponse Int Source #

The response's http status code.

ListTags

listTags_arn :: Lens' ListTags Text Source #

Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.

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

List of Tag for the requested Elasticsearch domain.

listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #

The response's http status code.

ListVpcEndpointAccess

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

Provides an identifier to allow retrieval of paginated results.

listVpcEndpointAccess_domainName :: Lens' ListVpcEndpointAccess Text Source #

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

listVpcEndpointAccessResponse_httpStatus :: Lens' ListVpcEndpointAccessResponse Int Source #

The response's http status code.

listVpcEndpointAccessResponse_authorizedPrincipalList :: Lens' ListVpcEndpointAccessResponse [AuthorizedPrincipal] Source #

List of AuthorizedPrincipal describing the details of the permissions to manage VPC endpoints against the specified domain.

listVpcEndpointAccessResponse_nextToken :: Lens' ListVpcEndpointAccessResponse Text Source #

Provides an identifier to allow retrieval of paginated results.

ListVpcEndpoints

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

Identifier to allow retrieval of paginated results.

listVpcEndpointsResponse_httpStatus :: Lens' ListVpcEndpointsResponse Int Source #

The response's http status code.

listVpcEndpointsResponse_vpcEndpointSummaryList :: Lens' ListVpcEndpointsResponse [VpcEndpointSummary] Source #

Information about each endpoint.

listVpcEndpointsResponse_nextToken :: Lens' ListVpcEndpointsResponse Text Source #

Provides an identifier to allow retrieval of paginated results.

ListVpcEndpointsForDomain

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

Provides an identifier to allow retrieval of paginated results.

listVpcEndpointsForDomain_domainName :: Lens' ListVpcEndpointsForDomain Text Source #

Name of the ElasticSearch domain whose VPC endpoints are to be listed.

listVpcEndpointsForDomainResponse_httpStatus :: Lens' ListVpcEndpointsForDomainResponse Int Source #

The response's http status code.

listVpcEndpointsForDomainResponse_vpcEndpointSummaryList :: Lens' ListVpcEndpointsForDomainResponse [VpcEndpointSummary] Source #

Provides list of VpcEndpointSummary summarizing details of the VPC endpoints.

listVpcEndpointsForDomainResponse_nextToken :: Lens' ListVpcEndpointsForDomainResponse Text Source #

Information about each endpoint associated with the domain.

PurchaseReservedElasticsearchInstanceOffering

purchaseReservedElasticsearchInstanceOffering_instanceCount :: Lens' PurchaseReservedElasticsearchInstanceOffering (Maybe Natural) Source #

The number of Elasticsearch instances to reserve.

purchaseReservedElasticsearchInstanceOffering_reservedElasticsearchInstanceOfferingId :: Lens' PurchaseReservedElasticsearchInstanceOffering Text Source #

The ID of the reserved Elasticsearch instance offering to purchase.

purchaseReservedElasticsearchInstanceOffering_reservationName :: Lens' PurchaseReservedElasticsearchInstanceOffering Text Source #

A customer-specified identifier to track this reservation.

purchaseReservedElasticsearchInstanceOfferingResponse_reservationName :: Lens' PurchaseReservedElasticsearchInstanceOfferingResponse (Maybe Text) Source #

The customer-specified identifier used to track this reservation.

purchaseReservedElasticsearchInstanceOfferingResponse_reservedElasticsearchInstanceId :: Lens' PurchaseReservedElasticsearchInstanceOfferingResponse (Maybe Text) Source #

Details of the reserved Elasticsearch instance which was purchased.

purchaseReservedElasticsearchInstanceOfferingResponse_httpStatus :: Lens' PurchaseReservedElasticsearchInstanceOfferingResponse Int Source #

The response's http status code.

RejectInboundCrossClusterSearchConnection

rejectInboundCrossClusterSearchConnection_crossClusterSearchConnectionId :: Lens' RejectInboundCrossClusterSearchConnection Text Source #

The id of the inbound connection that you want to reject.

rejectInboundCrossClusterSearchConnectionResponse_crossClusterSearchConnection :: Lens' RejectInboundCrossClusterSearchConnectionResponse (Maybe InboundCrossClusterSearchConnection) Source #

Specifies the InboundCrossClusterSearchConnection of rejected inbound connection.

rejectInboundCrossClusterSearchConnectionResponse_httpStatus :: Lens' RejectInboundCrossClusterSearchConnectionResponse Int Source #

The response's http status code.

RemoveTags

removeTags_arn :: Lens' RemoveTags Text Source #

Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.

removeTags_tagKeys :: Lens' RemoveTags [Text] Source #

Specifies the TagKey list which you want to remove from the Elasticsearch domain.

RevokeVpcEndpointAccess

revokeVpcEndpointAccess_domainName :: Lens' RevokeVpcEndpointAccess Text Source #

The name of the OpenSearch Service domain.

revokeVpcEndpointAccess_account :: Lens' RevokeVpcEndpointAccess Text Source #

The account ID to revoke access from.

revokeVpcEndpointAccessResponse_httpStatus :: Lens' RevokeVpcEndpointAccessResponse Int Source #

The response's http status code.

StartElasticsearchServiceSoftwareUpdate

startElasticsearchServiceSoftwareUpdate_domainName :: Lens' StartElasticsearchServiceSoftwareUpdate Text Source #

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

startElasticsearchServiceSoftwareUpdateResponse_serviceSoftwareOptions :: Lens' StartElasticsearchServiceSoftwareUpdateResponse (Maybe ServiceSoftwareOptions) Source #

The current status of the Elasticsearch service software update.

startElasticsearchServiceSoftwareUpdateResponse_httpStatus :: Lens' StartElasticsearchServiceSoftwareUpdateResponse Int Source #

The response's http status code.

UpdateElasticsearchDomainConfig

updateElasticsearchDomainConfig_accessPolicies :: Lens' UpdateElasticsearchDomainConfig (Maybe Text) Source #

IAM access policy as a JSON-formatted string.

updateElasticsearchDomainConfig_advancedOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe (HashMap Text Text)) Source #

Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

updateElasticsearchDomainConfig_advancedSecurityOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe AdvancedSecurityOptionsInput) Source #

Specifies advanced security options.

updateElasticsearchDomainConfig_autoTuneOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe AutoTuneOptions) Source #

Specifies Auto-Tune options.

updateElasticsearchDomainConfig_cognitoOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe CognitoOptions) Source #

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

updateElasticsearchDomainConfig_domainEndpointOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe DomainEndpointOptions) Source #

Options to specify configuration that will be applied to the domain endpoint.

updateElasticsearchDomainConfig_dryRun :: Lens' UpdateElasticsearchDomainConfig (Maybe Bool) Source #

This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.

updateElasticsearchDomainConfig_eBSOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe EBSOptions) Source #

Specify the type and size of the EBS volume that you want to use.

updateElasticsearchDomainConfig_elasticsearchClusterConfig :: Lens' UpdateElasticsearchDomainConfig (Maybe ElasticsearchClusterConfig) Source #

The type and number of instances to instantiate for the domain cluster.

updateElasticsearchDomainConfig_encryptionAtRestOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe EncryptionAtRestOptions) Source #

Specifies the Encryption At Rest Options.

updateElasticsearchDomainConfig_logPublishingOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe (HashMap LogType LogPublishingOption)) Source #

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

updateElasticsearchDomainConfig_nodeToNodeEncryptionOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe NodeToNodeEncryptionOptions) Source #

Specifies the NodeToNodeEncryptionOptions.

updateElasticsearchDomainConfig_snapshotOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe SnapshotOptions) Source #

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

updateElasticsearchDomainConfig_vPCOptions :: Lens' UpdateElasticsearchDomainConfig (Maybe VPCOptions) Source #

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

updateElasticsearchDomainConfig_domainName :: Lens' UpdateElasticsearchDomainConfig Text Source #

The name of the Elasticsearch domain that you are updating.

updateElasticsearchDomainConfigResponse_dryRunResults :: Lens' UpdateElasticsearchDomainConfigResponse (Maybe DryRunResults) Source #

Contains result of DryRun.

updateElasticsearchDomainConfigResponse_httpStatus :: Lens' UpdateElasticsearchDomainConfigResponse Int Source #

The response's http status code.

updateElasticsearchDomainConfigResponse_domainConfig :: Lens' UpdateElasticsearchDomainConfigResponse ElasticsearchDomainConfig Source #

The status of the updated Elasticsearch domain.

UpdatePackage

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

An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse.

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

New description of the package.

updatePackage_packageID :: Lens' UpdatePackage Text Source #

Unique identifier for the package.

updatePackage_packageSource :: Lens' UpdatePackage PackageSource Source #

Undocumented member.

updatePackageResponse_packageDetails :: Lens' UpdatePackageResponse (Maybe PackageDetails) Source #

Information about the package PackageDetails.

updatePackageResponse_httpStatus :: Lens' UpdatePackageResponse Int Source #

The response's http status code.

UpdateVpcEndpoint

updateVpcEndpoint_vpcEndpointId :: Lens' UpdateVpcEndpoint Text Source #

Unique identifier of the VPC endpoint to be updated.

updateVpcEndpoint_vpcOptions :: Lens' UpdateVpcEndpoint VPCOptions Source #

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

updateVpcEndpointResponse_httpStatus :: Lens' UpdateVpcEndpointResponse Int Source #

The response's http status code.

updateVpcEndpointResponse_vpcEndpoint :: Lens' UpdateVpcEndpointResponse VpcEndpoint Source #

The endpoint to be updated.

UpgradeElasticsearchDomain

upgradeElasticsearchDomain_performCheckOnly :: Lens' UpgradeElasticsearchDomain (Maybe Bool) Source #

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

upgradeElasticsearchDomain_domainName :: Lens' UpgradeElasticsearchDomain Text Source #

Undocumented member.

upgradeElasticsearchDomain_targetVersion :: Lens' UpgradeElasticsearchDomain Text Source #

The version of Elasticsearch that you intend to upgrade the domain to.

upgradeElasticsearchDomainResponse_changeProgressDetails :: Lens' UpgradeElasticsearchDomainResponse (Maybe ChangeProgressDetails) Source #

Undocumented member.

upgradeElasticsearchDomainResponse_domainName :: Lens' UpgradeElasticsearchDomainResponse (Maybe Text) Source #

Undocumented member.

upgradeElasticsearchDomainResponse_performCheckOnly :: Lens' UpgradeElasticsearchDomainResponse (Maybe Bool) Source #

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

upgradeElasticsearchDomainResponse_targetVersion :: Lens' UpgradeElasticsearchDomainResponse (Maybe Text) Source #

The version of Elasticsearch that you intend to upgrade the domain to.

upgradeElasticsearchDomainResponse_httpStatus :: Lens' UpgradeElasticsearchDomainResponse Int Source #

The response's http status code.

Types

AccessPoliciesStatus

accessPoliciesStatus_options :: Lens' AccessPoliciesStatus Text Source #

The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.

accessPoliciesStatus_status :: Lens' AccessPoliciesStatus OptionStatus Source #

The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.

AdditionalLimit

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

Name of Additional Limit is specific to a given InstanceType and for each of it's InstanceRole etc. Attributes and their details:

  • MaximumNumberOfDataNodesSupported
  • MaximumNumberOfDataNodesWithoutMasterNode

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

Value for given AdditionalLimit$LimitName .

AdvancedOptionsStatus

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

Specifies the status of advanced options for the specified Elasticsearch domain.

advancedOptionsStatus_status :: Lens' AdvancedOptionsStatus OptionStatus Source #

Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.

AdvancedSecurityOptions

advancedSecurityOptions_anonymousAuthDisableDate :: Lens' AdvancedSecurityOptions (Maybe UTCTime) Source #

Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

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

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

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

True if advanced security is enabled.

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

True if the internal user database is enabled.

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

Describes the SAML application configured for a domain.

AdvancedSecurityOptionsInput

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

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

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

True if advanced security is enabled.

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

True if the internal user database is enabled.

advancedSecurityOptionsInput_masterUserOptions :: Lens' AdvancedSecurityOptionsInput (Maybe MasterUserOptions) Source #

Credentials for the master user: username and password, ARN, or both.

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

Specifies the SAML application configuration for the domain.

AdvancedSecurityOptionsStatus

advancedSecurityOptionsStatus_options :: Lens' AdvancedSecurityOptionsStatus AdvancedSecurityOptions Source #

Specifies advanced security options for the specified Elasticsearch domain.

advancedSecurityOptionsStatus_status :: Lens' AdvancedSecurityOptionsStatus OptionStatus Source #

Status of the advanced security options for the specified Elasticsearch domain.

AuthorizedPrincipal

authorizedPrincipal_principal :: Lens' AuthorizedPrincipal (Maybe Text) Source #

The IAM principal that is allowed access to the domain.

authorizedPrincipal_principalType :: Lens' AuthorizedPrincipal (Maybe PrincipalType) Source #

The type of principal.

AutoTune

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

Specifies details of the Auto-Tune action. See the Developer Guide for more information.

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

Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

AutoTuneDetails

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

Undocumented member.

AutoTuneMaintenanceSchedule

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

Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.

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

Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

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

Specifies timestamp at which Auto-Tune maintenance schedule start.

AutoTuneOptions

autoTuneOptions_desiredState :: Lens' AutoTuneOptions (Maybe AutoTuneDesiredState) Source #

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

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

Specifies list of maitenance schedules. See the Developer Guide for more information.

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

Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.

AutoTuneOptionsInput

autoTuneOptionsInput_desiredState :: Lens' AutoTuneOptionsInput (Maybe AutoTuneDesiredState) Source #

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

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

Specifies list of maitenance schedules. See the Developer Guide for more information.

AutoTuneOptionsOutput

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

Specifies the error message while enabling or disabling the Auto-Tune.

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

Specifies the AutoTuneState for the Elasticsearch domain.

AutoTuneOptionsStatus

autoTuneOptionsStatus_options :: Lens' AutoTuneOptionsStatus (Maybe AutoTuneOptions) Source #

Specifies Auto-Tune options for the specified Elasticsearch domain.

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

Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.

AutoTuneStatus

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

Specifies the error message while enabling or disabling the Auto-Tune options.

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

Indicates whether the Elasticsearch domain is being deleted.

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

Specifies the Auto-Tune options latest version.

autoTuneStatus_creationDate :: Lens' AutoTuneStatus UTCTime Source #

Timestamp which tells Auto-Tune options creation date .

autoTuneStatus_updateDate :: Lens' AutoTuneStatus UTCTime Source #

Timestamp which tells Auto-Tune options last updated time.

autoTuneStatus_state :: Lens' AutoTuneStatus AutoTuneState Source #

Specifies the AutoTuneState for the Elasticsearch domain.

ChangeProgressDetails

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

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

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

Contains an optional message associated with the domain configuration change.

ChangeProgressStage

changeProgressStage_description :: Lens' ChangeProgressStage (Maybe Text) Source #

The description of the progress stage.

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

The last updated timestamp of the progress stage.

changeProgressStage_name :: Lens' ChangeProgressStage (Maybe Text) Source #

The name of the specific progress stage.

changeProgressStage_status :: Lens' ChangeProgressStage (Maybe Text) Source #

The overall status of a specific progress 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 involved in the domain configuration change that are completed.

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

The list of properties involved in the domain configuration change that are still in 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. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED

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

The total number of stages required for the configuration change.

CognitoOptions

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

Specifies the option to enable Cognito for Kibana authentication.

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

Specifies the Cognito identity pool ID for Kibana authentication.

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

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

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

Specifies the Cognito user pool ID for Kibana authentication.

CognitoOptionsStatus

cognitoOptionsStatus_options :: Lens' CognitoOptionsStatus CognitoOptions Source #

Specifies the Cognito options for the specified Elasticsearch domain.

cognitoOptionsStatus_status :: Lens' CognitoOptionsStatus OptionStatus Source #

Specifies the status of the Cognito options for the specified Elasticsearch domain.

ColdStorageOptions

coldStorageOptions_enabled :: Lens' ColdStorageOptions Bool Source #

Enable cold storage option. Accepted values true or false

CompatibleVersionsMap

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

The current version of Elasticsearch on which a domain is.

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

Undocumented member.

DescribePackagesFilter

describePackagesFilter_name :: Lens' DescribePackagesFilter (Maybe DescribePackagesFilterName) Source #

Any field from PackageDetails.

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

A list of values for the specified field.

DomainEndpointOptions

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

Specify the fully qualified domain for your custom endpoint.

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

Specify ACM certificate ARN for your custom endpoint.

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

Specify if custom endpoint should be enabled for the Elasticsearch domain.

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

Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

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

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. It can be one of the following values:

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

DomainEndpointOptionsStatus

domainEndpointOptionsStatus_options :: Lens' DomainEndpointOptionsStatus DomainEndpointOptions Source #

Options to configure endpoint for the Elasticsearch domain.

domainEndpointOptionsStatus_status :: Lens' DomainEndpointOptionsStatus OptionStatus Source #

The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status information that's included.

DomainInfo

domainInfo_domainName :: Lens' DomainInfo (Maybe Text) Source #

Specifies the DomainName.

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

Specifies the EngineType of the domain.

DomainInformation

domainInformation_ownerId :: Lens' DomainInformation (Maybe Text) Source #

Undocumented member.

domainInformation_region :: Lens' DomainInformation (Maybe Text) Source #

Undocumented member.

domainInformation_domainName :: Lens' DomainInformation Text Source #

Undocumented member.

DomainPackageDetails

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

Name of the domain you've associated a package with.

domainPackageDetails_domainPackageStatus :: Lens' DomainPackageDetails (Maybe DomainPackageStatus) Source #

State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

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 association status.

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

Internal ID of the package.

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

User specified name of the package.

domainPackageDetails_packageType :: Lens' DomainPackageDetails (Maybe PackageType) Source #

Currently supports only TXT-DICTIONARY.

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

Undocumented member.

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

The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

DryRunResults

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

Specifies the deployment mechanism through which the update shall be applied on the domain. Possible responses are Blue/Green (The update will require a blue/green deployment.) DynamicUpdate (The update can be applied in-place without a Blue/Green deployment required.) Undetermined (The domain is undergoing an update which needs to complete before the deployment type can be predicted.) None (The configuration change matches the current configuration and will not result in any update.)

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

Contains an optional message associated with the DryRunResults.

Duration

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

Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.

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

Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

EBSOptions

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

Specifies whether EBS-based storage is enabled.

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

Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

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

Specifies the Throughput for GP3 EBS volume (SSD).

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

Integer to specify the size of an EBS volume.

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

Specifies the volume type for EBS-based storage.

EBSOptionsStatus

eBSOptionsStatus_options :: Lens' EBSOptionsStatus EBSOptions Source #

Specifies the EBS options for the specified Elasticsearch domain.

eBSOptionsStatus_status :: Lens' EBSOptionsStatus OptionStatus Source #

Specifies the status of the EBS options for the specified Elasticsearch domain.

ElasticsearchClusterConfig

elasticsearchClusterConfig_coldStorageOptions :: Lens' ElasticsearchClusterConfig (Maybe ColdStorageOptions) Source #

Specifies the ColdStorageOptions config for Elasticsearch Domain

elasticsearchClusterConfig_dedicatedMasterCount :: Lens' ElasticsearchClusterConfig (Maybe Int) Source #

Total number of dedicated master nodes, active and on standby, for the cluster.

elasticsearchClusterConfig_dedicatedMasterEnabled :: Lens' ElasticsearchClusterConfig (Maybe Bool) Source #

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

elasticsearchClusterConfig_dedicatedMasterType :: Lens' ElasticsearchClusterConfig (Maybe ESPartitionInstanceType) Source #

The instance type for a dedicated master node.

elasticsearchClusterConfig_instanceCount :: Lens' ElasticsearchClusterConfig (Maybe Int) Source #

The number of instances in the specified domain cluster.

elasticsearchClusterConfig_instanceType :: Lens' ElasticsearchClusterConfig (Maybe ESPartitionInstanceType) Source #

The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

elasticsearchClusterConfig_warmCount :: Lens' ElasticsearchClusterConfig (Maybe Int) Source #

The number of warm nodes in the cluster.

elasticsearchClusterConfig_warmEnabled :: Lens' ElasticsearchClusterConfig (Maybe Bool) Source #

True to enable warm storage.

elasticsearchClusterConfig_warmType :: Lens' ElasticsearchClusterConfig (Maybe ESWarmPartitionInstanceType) Source #

The instance type for the Elasticsearch cluster's warm nodes.

elasticsearchClusterConfig_zoneAwarenessConfig :: Lens' ElasticsearchClusterConfig (Maybe ZoneAwarenessConfig) Source #

Specifies the zone awareness configuration for a domain when zone awareness is enabled.

elasticsearchClusterConfig_zoneAwarenessEnabled :: Lens' ElasticsearchClusterConfig (Maybe Bool) Source #

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

ElasticsearchClusterConfigStatus

elasticsearchClusterConfigStatus_options :: Lens' ElasticsearchClusterConfigStatus ElasticsearchClusterConfig Source #

Specifies the cluster configuration for the specified Elasticsearch domain.

elasticsearchClusterConfigStatus_status :: Lens' ElasticsearchClusterConfigStatus OptionStatus Source #

Specifies the status of the configuration for the specified Elasticsearch domain.

ElasticsearchDomainConfig

elasticsearchDomainConfig_accessPolicies :: Lens' ElasticsearchDomainConfig (Maybe AccessPoliciesStatus) Source #

IAM access policy as a JSON-formatted string.

elasticsearchDomainConfig_advancedOptions :: Lens' ElasticsearchDomainConfig (Maybe AdvancedOptionsStatus) Source #

Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

elasticsearchDomainConfig_advancedSecurityOptions :: Lens' ElasticsearchDomainConfig (Maybe AdvancedSecurityOptionsStatus) Source #

Specifies AdvancedSecurityOptions for the domain.

elasticsearchDomainConfig_autoTuneOptions :: Lens' ElasticsearchDomainConfig (Maybe AutoTuneOptionsStatus) Source #

Specifies AutoTuneOptions for the domain.

elasticsearchDomainConfig_changeProgressDetails :: Lens' ElasticsearchDomainConfig (Maybe ChangeProgressDetails) Source #

Specifies change details of the domain configuration change.

elasticsearchDomainConfig_cognitoOptions :: Lens' ElasticsearchDomainConfig (Maybe CognitoOptionsStatus) Source #

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

elasticsearchDomainConfig_domainEndpointOptions :: Lens' ElasticsearchDomainConfig (Maybe DomainEndpointOptionsStatus) Source #

Specifies the DomainEndpointOptions for the Elasticsearch domain.

elasticsearchDomainConfig_eBSOptions :: Lens' ElasticsearchDomainConfig (Maybe EBSOptionsStatus) Source #

Specifies the EBSOptions for the Elasticsearch domain.

elasticsearchDomainConfig_elasticsearchClusterConfig :: Lens' ElasticsearchDomainConfig (Maybe ElasticsearchClusterConfigStatus) Source #

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

elasticsearchDomainConfig_elasticsearchVersion :: Lens' ElasticsearchDomainConfig (Maybe ElasticsearchVersionStatus) Source #

String of format X.Y to specify version for the Elasticsearch domain.

elasticsearchDomainConfig_encryptionAtRestOptions :: Lens' ElasticsearchDomainConfig (Maybe EncryptionAtRestOptionsStatus) Source #

Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

elasticsearchDomainConfig_logPublishingOptions :: Lens' ElasticsearchDomainConfig (Maybe LogPublishingOptionsStatus) Source #

Log publishing options for the given domain.

elasticsearchDomainConfig_nodeToNodeEncryptionOptions :: Lens' ElasticsearchDomainConfig (Maybe NodeToNodeEncryptionOptionsStatus) Source #

Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

elasticsearchDomainConfig_snapshotOptions :: Lens' ElasticsearchDomainConfig (Maybe SnapshotOptionsStatus) Source #

Specifies the SnapshotOptions for the Elasticsearch domain.

elasticsearchDomainConfig_vPCOptions :: Lens' ElasticsearchDomainConfig (Maybe VPCDerivedInfoStatus) Source #

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

ElasticsearchDomainStatus

elasticsearchDomainStatus_accessPolicies :: Lens' ElasticsearchDomainStatus (Maybe Text) Source #

IAM access policy as a JSON-formatted string.

elasticsearchDomainStatus_advancedOptions :: Lens' ElasticsearchDomainStatus (Maybe (HashMap Text Text)) Source #

Specifies the status of the AdvancedOptions

elasticsearchDomainStatus_advancedSecurityOptions :: Lens' ElasticsearchDomainStatus (Maybe AdvancedSecurityOptions) Source #

The current status of the Elasticsearch domain's advanced security options.

elasticsearchDomainStatus_autoTuneOptions :: Lens' ElasticsearchDomainStatus (Maybe AutoTuneOptionsOutput) Source #

The current status of the Elasticsearch domain's Auto-Tune options.

elasticsearchDomainStatus_changeProgressDetails :: Lens' ElasticsearchDomainStatus (Maybe ChangeProgressDetails) Source #

Specifies change details of the domain configuration change.

elasticsearchDomainStatus_cognitoOptions :: Lens' ElasticsearchDomainStatus (Maybe CognitoOptions) Source #

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

elasticsearchDomainStatus_created :: Lens' ElasticsearchDomainStatus (Maybe Bool) Source #

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

elasticsearchDomainStatus_deleted :: Lens' ElasticsearchDomainStatus (Maybe Bool) Source #

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

elasticsearchDomainStatus_domainEndpointOptions :: Lens' ElasticsearchDomainStatus (Maybe DomainEndpointOptions) Source #

The current status of the Elasticsearch domain's endpoint options.

elasticsearchDomainStatus_eBSOptions :: Lens' ElasticsearchDomainStatus (Maybe EBSOptions) Source #

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

elasticsearchDomainStatus_elasticsearchVersion :: Lens' ElasticsearchDomainStatus (Maybe Text) Source #

Undocumented member.

elasticsearchDomainStatus_encryptionAtRestOptions :: Lens' ElasticsearchDomainStatus (Maybe EncryptionAtRestOptions) Source #

Specifies the status of the EncryptionAtRestOptions.

elasticsearchDomainStatus_endpoint :: Lens' ElasticsearchDomainStatus (Maybe Text) Source #

The Elasticsearch domain endpoint that you use to submit index and search requests.

elasticsearchDomainStatus_endpoints :: Lens' ElasticsearchDomainStatus (Maybe (HashMap Text Text)) Source #

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

elasticsearchDomainStatus_logPublishingOptions :: Lens' ElasticsearchDomainStatus (Maybe (HashMap LogType LogPublishingOption)) Source #

Log publishing options for the given domain.

elasticsearchDomainStatus_nodeToNodeEncryptionOptions :: Lens' ElasticsearchDomainStatus (Maybe NodeToNodeEncryptionOptions) Source #

Specifies the status of the NodeToNodeEncryptionOptions.

elasticsearchDomainStatus_processing :: Lens' ElasticsearchDomainStatus (Maybe Bool) Source #

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

elasticsearchDomainStatus_serviceSoftwareOptions :: Lens' ElasticsearchDomainStatus (Maybe ServiceSoftwareOptions) Source #

The current status of the Elasticsearch domain's service software.

elasticsearchDomainStatus_snapshotOptions :: Lens' ElasticsearchDomainStatus (Maybe SnapshotOptions) Source #

Specifies the status of the SnapshotOptions

elasticsearchDomainStatus_upgradeProcessing :: Lens' ElasticsearchDomainStatus (Maybe Bool) Source #

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

elasticsearchDomainStatus_vPCOptions :: Lens' ElasticsearchDomainStatus (Maybe VPCDerivedInfo) Source #

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

elasticsearchDomainStatus_domainId :: Lens' ElasticsearchDomainStatus Text Source #

The unique identifier for the specified Elasticsearch domain.

elasticsearchDomainStatus_domainName :: Lens' ElasticsearchDomainStatus Text Source #

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

elasticsearchDomainStatus_arn :: Lens' ElasticsearchDomainStatus Text Source #

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

elasticsearchDomainStatus_elasticsearchClusterConfig :: Lens' ElasticsearchDomainStatus ElasticsearchClusterConfig Source #

The type and number of instances in the domain cluster.

ElasticsearchVersionStatus

elasticsearchVersionStatus_options :: Lens' ElasticsearchVersionStatus Text Source #

Specifies the Elasticsearch version for the specified Elasticsearch domain.

elasticsearchVersionStatus_status :: Lens' ElasticsearchVersionStatus OptionStatus Source #

Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.

EncryptionAtRestOptions

encryptionAtRestOptions_enabled :: Lens' EncryptionAtRestOptions (Maybe Bool) Source #

Specifies the option to enable Encryption At Rest.

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

Specifies the KMS Key ID for Encryption At Rest options.

EncryptionAtRestOptionsStatus

encryptionAtRestOptionsStatus_options :: Lens' EncryptionAtRestOptionsStatus EncryptionAtRestOptions Source #

Specifies the Encryption At Rest options for the specified Elasticsearch domain.

encryptionAtRestOptionsStatus_status :: Lens' EncryptionAtRestOptionsStatus OptionStatus Source #

Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.

ErrorDetails

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

Undocumented member.

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

Undocumented member.

Filter

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

Specifies the name of the filter.

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

Contains one or more values for the filter.

InboundCrossClusterSearchConnection

inboundCrossClusterSearchConnection_connectionStatus :: Lens' InboundCrossClusterSearchConnection (Maybe InboundCrossClusterSearchConnectionStatus) Source #

Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.

inboundCrossClusterSearchConnection_crossClusterSearchConnectionId :: Lens' InboundCrossClusterSearchConnection (Maybe Text) Source #

Specifies the connection id for the inbound cross-cluster search connection.

inboundCrossClusterSearchConnection_destinationDomainInfo :: Lens' InboundCrossClusterSearchConnection (Maybe DomainInformation) Source #

Specifies the DomainInformation for the destination Elasticsearch domain.

inboundCrossClusterSearchConnection_sourceDomainInfo :: Lens' InboundCrossClusterSearchConnection (Maybe DomainInformation) Source #

Specifies the DomainInformation for the source Elasticsearch domain.

InboundCrossClusterSearchConnectionStatus

inboundCrossClusterSearchConnectionStatus_message :: Lens' InboundCrossClusterSearchConnectionStatus (Maybe Text) Source #

Specifies verbose information for the inbound connection status.

inboundCrossClusterSearchConnectionStatus_statusCode :: Lens' InboundCrossClusterSearchConnectionStatus (Maybe InboundCrossClusterSearchConnectionStatusCode) Source #

The state code for inbound connection. This can be one of the following:

  • PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
  • APPROVED: Inbound connection is pending acceptance by destination domain owner.
  • 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 cannot be used further.

InstanceCountLimits

instanceCountLimits_maximumInstanceCount :: Lens' InstanceCountLimits (Maybe Int) Source #

Undocumented member.

instanceCountLimits_minimumInstanceCount :: Lens' InstanceCountLimits (Maybe Int) Source #

Undocumented member.

InstanceLimits

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

Undocumented member.

Limits

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

List of additional limits that are specific to a given InstanceType and for each of it's InstanceRole .

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

Undocumented member.

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

StorageType represents the list of storage related types and attributes that are available for given InstanceType.

LogPublishingOption

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

Undocumented member.

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

Specifies whether given log publishing option is enabled or not.

LogPublishingOptionsStatus

logPublishingOptionsStatus_options :: Lens' LogPublishingOptionsStatus (Maybe (HashMap LogType LogPublishingOption)) Source #

The log publishing options configured for the Elasticsearch domain.

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

The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the status information that's included.

MasterUserOptions

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

ARN for the master user (if IAM is enabled).

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

The master user's username, which is stored in the Amazon Elasticsearch Service domain's internal database.

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

The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database.

NodeToNodeEncryptionOptions

nodeToNodeEncryptionOptions_enabled :: Lens' NodeToNodeEncryptionOptions (Maybe Bool) Source #

Specify true to enable node-to-node encryption.

NodeToNodeEncryptionOptionsStatus

nodeToNodeEncryptionOptionsStatus_options :: Lens' NodeToNodeEncryptionOptionsStatus NodeToNodeEncryptionOptions Source #

Specifies the node-to-node encryption options for the specified Elasticsearch domain.

nodeToNodeEncryptionOptionsStatus_status :: Lens' NodeToNodeEncryptionOptionsStatus OptionStatus Source #

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

OptionStatus

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

Indicates whether the Elasticsearch domain is being deleted.

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

Specifies the latest version for the entity.

optionStatus_creationDate :: Lens' OptionStatus UTCTime Source #

Timestamp which tells the creation date for the entity.

optionStatus_updateDate :: Lens' OptionStatus UTCTime Source #

Timestamp which tells the last updated time for the entity.

optionStatus_state :: Lens' OptionStatus OptionState Source #

Provides the OptionState for the Elasticsearch domain.

OutboundCrossClusterSearchConnection

outboundCrossClusterSearchConnection_connectionAlias :: Lens' OutboundCrossClusterSearchConnection (Maybe Text) Source #

Specifies the connection alias for the outbound cross-cluster search connection.

outboundCrossClusterSearchConnection_connectionStatus :: Lens' OutboundCrossClusterSearchConnection (Maybe OutboundCrossClusterSearchConnectionStatus) Source #

Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.

outboundCrossClusterSearchConnection_crossClusterSearchConnectionId :: Lens' OutboundCrossClusterSearchConnection (Maybe Text) Source #

Specifies the connection id for the outbound cross-cluster search connection.

outboundCrossClusterSearchConnection_destinationDomainInfo :: Lens' OutboundCrossClusterSearchConnection (Maybe DomainInformation) Source #

Specifies the DomainInformation for the destination Elasticsearch domain.

outboundCrossClusterSearchConnection_sourceDomainInfo :: Lens' OutboundCrossClusterSearchConnection (Maybe DomainInformation) Source #

Specifies the DomainInformation for the source Elasticsearch domain.

OutboundCrossClusterSearchConnectionStatus

outboundCrossClusterSearchConnectionStatus_message :: Lens' OutboundCrossClusterSearchConnectionStatus (Maybe Text) Source #

Specifies verbose information for the outbound connection status.

outboundCrossClusterSearchConnectionStatus_statusCode :: Lens' OutboundCrossClusterSearchConnectionStatus (Maybe OutboundCrossClusterSearchConnectionStatusCode) Source #

The state code for outbound connection. This 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 destination domain owner.
  • PROVISIONING: Outbound connection request is in process.
  • ACTIVE: Outbound connection is active and ready to use.
  • REJECTED: Outbound connection request is rejected by destination domain owner.
  • DELETING: Outbound connection deletion is in progress.
  • DELETED: Outbound connection is deleted and cannot be used further.

PackageDetails

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

Undocumented member.

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

Timestamp which tells creation date of the package.

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 #

Undocumented member.

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

User-specified description of the package.

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

Internal ID of the package.

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

User specified name of the package.

packageDetails_packageStatus :: Lens' PackageDetails (Maybe PackageStatus) Source #

Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED

packageDetails_packageType :: Lens' PackageDetails (Maybe PackageType) Source #

Currently supports only TXT-DICTIONARY.

PackageSource

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

Name of the 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 version.

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

Timestamp which tells creation time of the package version.

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

Version of the package.

RecurringCharge

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

The monetary amount of the recurring charge.

recurringCharge_recurringChargeFrequency :: Lens' RecurringCharge (Maybe Text) Source #

The frequency of the recurring charge.

ReservedElasticsearchInstance

reservedElasticsearchInstance_currencyCode :: Lens' ReservedElasticsearchInstance (Maybe Text) Source #

The currency code for the reserved Elasticsearch instance offering.

reservedElasticsearchInstance_duration :: Lens' ReservedElasticsearchInstance (Maybe Int) Source #

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

reservedElasticsearchInstance_elasticsearchInstanceCount :: Lens' ReservedElasticsearchInstance (Maybe Int) Source #

The number of Elasticsearch instances that have been reserved.

reservedElasticsearchInstance_elasticsearchInstanceType :: Lens' ReservedElasticsearchInstance (Maybe ESPartitionInstanceType) Source #

The Elasticsearch instance type offered by the reserved instance offering.

reservedElasticsearchInstance_fixedPrice :: Lens' ReservedElasticsearchInstance (Maybe Double) Source #

The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.

reservedElasticsearchInstance_paymentOption :: Lens' ReservedElasticsearchInstance (Maybe ReservedElasticsearchInstancePaymentOption) Source #

The payment option as defined in the reserved Elasticsearch instance offering.

reservedElasticsearchInstance_recurringCharges :: Lens' ReservedElasticsearchInstance (Maybe [RecurringCharge]) Source #

The charge to your account regardless of whether you are creating any domains using the instance offering.

reservedElasticsearchInstance_reservationName :: Lens' ReservedElasticsearchInstance (Maybe Text) Source #

The customer-specified identifier to track this reservation.

reservedElasticsearchInstance_reservedElasticsearchInstanceId :: Lens' ReservedElasticsearchInstance (Maybe Text) Source #

The unique identifier for the reservation.

reservedElasticsearchInstance_reservedElasticsearchInstanceOfferingId :: Lens' ReservedElasticsearchInstance (Maybe Text) Source #

The offering identifier.

reservedElasticsearchInstance_startTime :: Lens' ReservedElasticsearchInstance (Maybe UTCTime) Source #

The time the reservation started.

reservedElasticsearchInstance_state :: Lens' ReservedElasticsearchInstance (Maybe Text) Source #

The state of the reserved Elasticsearch instance.

reservedElasticsearchInstance_usagePrice :: Lens' ReservedElasticsearchInstance (Maybe Double) Source #

The rate you are charged for each hour for the domain that is using this reserved instance.

ReservedElasticsearchInstanceOffering

reservedElasticsearchInstanceOffering_currencyCode :: Lens' ReservedElasticsearchInstanceOffering (Maybe Text) Source #

The currency code for the reserved Elasticsearch instance offering.

reservedElasticsearchInstanceOffering_duration :: Lens' ReservedElasticsearchInstanceOffering (Maybe Int) Source #

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

reservedElasticsearchInstanceOffering_elasticsearchInstanceType :: Lens' ReservedElasticsearchInstanceOffering (Maybe ESPartitionInstanceType) Source #

The Elasticsearch instance type offered by the reserved instance offering.

reservedElasticsearchInstanceOffering_fixedPrice :: Lens' ReservedElasticsearchInstanceOffering (Maybe Double) Source #

The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.

reservedElasticsearchInstanceOffering_paymentOption :: Lens' ReservedElasticsearchInstanceOffering (Maybe ReservedElasticsearchInstancePaymentOption) Source #

Payment option for the reserved Elasticsearch instance offering

reservedElasticsearchInstanceOffering_recurringCharges :: Lens' ReservedElasticsearchInstanceOffering (Maybe [RecurringCharge]) Source #

The charge to your account regardless of whether you are creating any domains using the instance offering.

reservedElasticsearchInstanceOffering_reservedElasticsearchInstanceOfferingId :: Lens' ReservedElasticsearchInstanceOffering (Maybe Text) Source #

The Elasticsearch reserved instance offering identifier.

reservedElasticsearchInstanceOffering_usagePrice :: Lens' ReservedElasticsearchInstanceOffering (Maybe Double) Source #

The rate you are charged for each hour the domain that is using the offering is running.

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 SAML Identity Provider.

SAMLOptionsInput

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

True if SAML is enabled.

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

Specifies the SAML Identity Provider's information.

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

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

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

The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database.

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

The key to use for matching the SAML Roles attribute.

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 #

The key to use for matching the SAML Subject attribute.

SAMLOptionsOutput

sAMLOptionsOutput_enabled :: Lens' SAMLOptionsOutput (Maybe Bool) Source #

True if SAML is enabled.

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_action :: Lens' ScheduledAutoTuneDetails (Maybe Text) Source #

Specifies Auto-Tune action description.

scheduledAutoTuneDetails_actionType :: Lens' ScheduledAutoTuneDetails (Maybe ScheduledAutoTuneActionType) Source #

Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.

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

Specifies timestamp for the Auto-Tune action scheduled for the domain.

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

Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.

ServiceSoftwareOptions

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

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 are able to cancel your service software version update. False if you are not able to cancel your service software version.

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

The current service software version that is present on the domain.

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

The description of the UpdateStatus.

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

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

True if you are able to update you service software version. False if you are not able to update your service software version.

serviceSoftwareOptions_updateStatus :: Lens' ServiceSoftwareOptions (Maybe DeploymentStatus) Source #

The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

SnapshotOptions

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

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

SnapshotOptionsStatus

snapshotOptionsStatus_options :: Lens' SnapshotOptionsStatus SnapshotOptions Source #

Specifies the daily snapshot options specified for the Elasticsearch domain.

snapshotOptionsStatus_status :: Lens' SnapshotOptionsStatus OptionStatus Source #

Specifies the status of a daily automated snapshot.

StorageType

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

Undocumented member.

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

List of limits that are applicable for given storage type.

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

Undocumented member.

StorageTypeLimit

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

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

  1. MinimumVolumeSize
  2. MaximumVolumeSize
  3. MaximumIops
  4. MinimumIops
  5. MaximumThroughput
  6. MinimumThroughput

storageTypeLimit_limitValues :: Lens' StorageTypeLimit (Maybe [Text]) Source #

Values for the StorageTypeLimit$LimitName .

Tag

tag_key :: Lens' Tag Text Source #

Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

tag_value :: Lens' Tag Text Source #

Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not 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 "yyyy-MM-ddTHH:mm:ssZ" format.

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

A list of UpgradeStepItem s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.

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

A string that describes the update briefly

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

The overall status of the update. 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 progress percentage of a particular step.

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

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

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

The status of a particular step during an 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 availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

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

Specifies the security groups for VPC endpoint.

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

Specifies the subnets for VPC endpoint.

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

The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

VPCDerivedInfoStatus

vPCDerivedInfoStatus_options :: Lens' VPCDerivedInfoStatus VPCDerivedInfo Source #

Specifies the VPC options for the specified Elasticsearch domain.

vPCDerivedInfoStatus_status :: Lens' VPCDerivedInfoStatus OptionStatus Source #

Specifies the status of the VPC options for the specified Elasticsearch domain.

VPCOptions

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

Specifies the security groups for VPC endpoint.

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

Specifies the subnets for VPC endpoint.

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_vpcEndpointOwner :: Lens' VpcEndpoint (Maybe Text) Source #

The creator 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_errorCode :: Lens' VpcEndpointError (Maybe VpcEndpointErrorCode) Source #

The code associated with the error.

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

A message describing the error.

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_status :: Lens' VpcEndpointSummary (Maybe VpcEndpointStatus) Source #

The current status of the endpoint.

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

The unique identifier of the endpoint.

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

The creator of the endpoint.

ZoneAwarenessConfig

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

An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled