libZSservicesZSamazonka-opensearchZSamazonka-opensearch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.OpenSearch.Lens

Contents

Description

 
Synopsis

Operations

RejectInboundConnection

rejectInboundConnection_connectionId :: Lens' RejectInboundConnection Text Source #

The ID of the inbound connection to reject.

rejectInboundConnectionResponse_connection :: Lens' RejectInboundConnectionResponse (Maybe InboundConnection) Source #

The InboundConnection of the rejected inbound connection.

rejectInboundConnectionResponse_httpStatus :: Lens' RejectInboundConnectionResponse Int Source #

The response's http status code.

DescribeOutboundConnections

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

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

  • connection-id
  • remote-domain-info.domain-name
  • remote-domain-info.owner-id
  • remote-domain-info.region
  • local-domain-info.domain-name

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

NextToken is sent in case the earlier API call results contain the NextToken parameter. Used for pagination.

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

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

describeOutboundConnectionsResponse_connections :: Lens' DescribeOutboundConnectionsResponse (Maybe [OutboundConnection]) Source #

A list of OutboundConnection matching the specified filter criteria.

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

describeOutboundConnectionsResponse_httpStatus :: Lens' DescribeOutboundConnectionsResponse Int Source #

The response's http status code.

RemoveTags

removeTags_arn :: Lens' RemoveTags Text Source #

The ARN of the domain from which you want to delete the specified tags.

removeTags_tagKeys :: Lens' RemoveTags [Text] Source #

The TagKey list you want to remove from the domain.

DescribeInstanceTypeLimits

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

The name of the domain you want to modify. Only include this value if you're querying OpenSearch Limits for an existing domain.

describeInstanceTypeLimits_instanceType :: Lens' DescribeInstanceTypeLimits OpenSearchPartitionInstanceType Source #

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

describeInstanceTypeLimits_engineVersion :: Lens' DescribeInstanceTypeLimits Text Source #

Version of OpenSearch for which Limits are needed.

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

Undocumented member.

describeInstanceTypeLimitsResponse_httpStatus :: Lens' DescribeInstanceTypeLimitsResponse Int Source #

The response's http status code.

DescribeInboundConnections

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

A list of filters used to match properties for inbound cross-cluster connections. Available Filter values are:

  • connection-id
  • local-domain-info.domain-name
  • local-domain-info.owner-id
  • local-domain-info.region
  • remote-domain-info.domain-name

describeInboundConnections_nextToken :: Lens' DescribeInboundConnections (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.

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

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

describeInboundConnectionsResponse_connections :: Lens' DescribeInboundConnectionsResponse (Maybe [InboundConnection]) Source #

A list of InboundConnection matching the specified filter criteria.

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

describeInboundConnectionsResponse_httpStatus :: Lens' DescribeInboundConnectionsResponse Int Source #

The response's http status code.

CancelServiceSoftwareUpdate

cancelServiceSoftwareUpdate_domainName :: Lens' CancelServiceSoftwareUpdate Text Source #

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

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

The current status of the OpenSearch service software update.

cancelServiceSoftwareUpdateResponse_httpStatus :: Lens' CancelServiceSoftwareUpdateResponse Int Source #

The response's http status code.

ListDomainsForPackage

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_maxResults :: Lens' ListDomainsForPackage (Maybe Int) Source #

Limits the results to a maximum number of domains.

listDomainsForPackage_packageID :: Lens' ListDomainsForPackage Text Source #

The package for which to list associated 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.

ListPackagesForDomain

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_maxResults :: Lens' ListPackagesForDomain (Maybe Int) Source #

Limits results to a maximum number of packages.

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 to supply to the next call to get the next page of results.

listPackagesForDomainResponse_httpStatus :: Lens' ListPackagesForDomainResponse Int Source #

The response's http status code.

UpgradeDomain

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

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

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

Undocumented member.

upgradeDomain_domainName :: Lens' UpgradeDomain Text Source #

Undocumented member.

upgradeDomain_targetVersion :: Lens' UpgradeDomain Text Source #

The version of OpenSearch you intend to upgrade the domain to.

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

Undocumented member.

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

Undocumented member.

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

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

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

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

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

Undocumented member.

upgradeDomainResponse_httpStatus :: Lens' UpgradeDomainResponse Int Source #

The response's http status code.

DescribeDomainAutoTunes

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

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

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

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

describeDomainAutoTunes_domainName :: Lens' DescribeDomainAutoTunes Text Source #

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

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

An identifier to allow retrieval of paginated results.

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

The list of setting adjustments that Auto-Tune has made to the domain. See Auto-Tune for Amazon OpenSearch Service for more information.

describeDomainAutoTunesResponse_httpStatus :: Lens' DescribeDomainAutoTunesResponse Int Source #

The response's http status code.

DescribeReservedInstances

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

Provides an identifier to allow retrieval of paginated results.

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

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

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

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

describeReservedInstancesResponse_nextToken :: Lens' DescribeReservedInstancesResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeReservedInstancesResponse_reservedInstances :: Lens' DescribeReservedInstancesResponse (Maybe [ReservedInstance]) Source #

List of reserved OpenSearch instances.

describeReservedInstancesResponse_httpStatus :: Lens' DescribeReservedInstancesResponse Int Source #

The response's http status code.

StartServiceSoftwareUpdate

startServiceSoftwareUpdate_domainName :: Lens' StartServiceSoftwareUpdate Text Source #

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

startServiceSoftwareUpdateResponse_serviceSoftwareOptions :: Lens' StartServiceSoftwareUpdateResponse (Maybe ServiceSoftwareOptions) Source #

The current status of the OpenSearch service software update.

startServiceSoftwareUpdateResponse_httpStatus :: Lens' StartServiceSoftwareUpdateResponse Int Source #

The response's http status code.

DeleteOutboundConnection

deleteOutboundConnection_connectionId :: Lens' DeleteOutboundConnection Text Source #

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

deleteOutboundConnectionResponse_connection :: Lens' DeleteOutboundConnectionResponse (Maybe OutboundConnection) Source #

The OutboundConnection of the deleted outbound connection.

deleteOutboundConnectionResponse_httpStatus :: Lens' DeleteOutboundConnectionResponse Int Source #

The response's http status code.

ListVersions

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

Undocumented member.

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

Set this value to limit the number of results returned. Value must be greater than 10 or it won't be honored.

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

Undocumented member.

listVersionsResponse_nextToken :: Lens' ListVersionsResponse (Maybe Text) Source #

Undocumented member.

listVersionsResponse_httpStatus :: Lens' ListVersionsResponse Int Source #

The response's http status code.

DescribeReservedInstanceOfferings

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

Provides an identifier to allow retrieval of paginated results.

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

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

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

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

describeReservedInstanceOfferingsResponse_nextToken :: Lens' DescribeReservedInstanceOfferingsResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeReservedInstanceOfferingsResponse_reservedInstanceOfferings :: Lens' DescribeReservedInstanceOfferingsResponse (Maybe [ReservedInstanceOffering]) Source #

List of reserved OpenSearch instance offerings

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

PurchaseReservedInstanceOffering

purchaseReservedInstanceOffering_instanceCount :: Lens' PurchaseReservedInstanceOffering (Maybe Natural) Source #

The number of OpenSearch instances to reserve.

purchaseReservedInstanceOffering_reservedInstanceOfferingId :: Lens' PurchaseReservedInstanceOffering Text Source #

The ID of the reserved OpenSearch instance offering to purchase.

purchaseReservedInstanceOffering_reservationName :: Lens' PurchaseReservedInstanceOffering Text Source #

A customer-specified identifier to track this reservation.

purchaseReservedInstanceOfferingResponse_reservationName :: Lens' PurchaseReservedInstanceOfferingResponse (Maybe Text) Source #

The customer-specified identifier used to track this reservation.

purchaseReservedInstanceOfferingResponse_reservedInstanceId :: Lens' PurchaseReservedInstanceOfferingResponse (Maybe Text) Source #

Details of the reserved OpenSearch instance which was purchased.

purchaseReservedInstanceOfferingResponse_httpStatus :: Lens' PurchaseReservedInstanceOfferingResponse Int Source #

The response's http status code.

DescribeDomains

describeDomains_domainNames :: Lens' DescribeDomains [Text] Source #

The domains for which you want information.

describeDomainsResponse_httpStatus :: Lens' DescribeDomainsResponse Int Source #

The response's http status code.

describeDomainsResponse_domainStatusList :: Lens' DescribeDomainsResponse [DomainStatus] Source #

The status of the domains requested in the DescribeDomains request.

AssociatePackage

associatePackage_packageID :: Lens' AssociatePackage Text Source #

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

associatePackage_domainName :: Lens' AssociatePackage Text Source #

The name of the domain 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.

ListInstanceTypeDetails

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

Undocumented member.

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

Undocumented member.

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

Undocumented member.

listInstanceTypeDetails_engineVersion :: Lens' ListInstanceTypeDetails Text Source #

Undocumented member.

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

Undocumented member.

listInstanceTypeDetailsResponse_nextToken :: Lens' ListInstanceTypeDetailsResponse (Maybe Text) Source #

Undocumented member.

listInstanceTypeDetailsResponse_httpStatus :: Lens' ListInstanceTypeDetailsResponse Int Source #

The response's http status code.

GetPackageVersionHistory

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_maxResults :: Lens' GetPackageVersionHistory (Maybe Int) Source #

Limits results to a maximum number of package versions.

getPackageVersionHistory_packageID :: Lens' GetPackageVersionHistory Text Source #

Returns an audit history of package versions.

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

Undocumented member.

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

List of PackageVersionHistory objects.

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

Undocumented member.

getPackageVersionHistoryResponse_httpStatus :: Lens' GetPackageVersionHistoryResponse Int Source #

The response's http status code.

GetUpgradeHistory

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

Undocumented member.

getUpgradeHistory_maxResults :: Lens' GetUpgradeHistory (Maybe Int) 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 the GetUpgradeHistoryResponse object.

getUpgradeHistoryResponse_httpStatus :: Lens' GetUpgradeHistoryResponse 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_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.

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

Limits results to a maximum number of packages.

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

List of PackageDetails objects.

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

Undocumented member.

describePackagesResponse_httpStatus :: Lens' DescribePackagesResponse Int Source #

The response's http status code.

CreateDomain

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

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

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

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

createDomain_nodeToNodeEncryptionOptions :: Lens' CreateDomain (Maybe NodeToNodeEncryptionOptions) Source #

Node-to-node encryption options.

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

IAM access policy as a JSON-formatted string.

createDomain_autoTuneOptions :: Lens' CreateDomain (Maybe AutoTuneOptionsInput) Source #

Specifies Auto-Tune options.

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

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

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

Configuration options for a domain. Specifies the instance type and number of instances in the domain.

createDomain_advancedSecurityOptions :: Lens' CreateDomain (Maybe AdvancedSecurityOptionsInput) Source #

Specifies advanced security options.

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

A list of Tag added during domain creation.

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

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

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

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

createDomain_encryptionAtRestOptions :: Lens' CreateDomain (Maybe EncryptionAtRestOptions) Source #

Options for encryption of data at rest.

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

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

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

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

createDomain_advancedOptions :: Lens' CreateDomain (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 Advanced cluster parameters for more information.

createDomain_domainName :: Lens' CreateDomain Text Source #

The name of the Amazon OpenSearch Service domain you're 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).

createDomainResponse_domainStatus :: Lens' CreateDomainResponse (Maybe DomainStatus) Source #

The status of the newly created domain.

createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int Source #

The response's http status code.

DescribeDomainConfig

describeDomainConfig_domainName :: Lens' DescribeDomainConfig Text Source #

The domain you want to get information about.

describeDomainConfigResponse_httpStatus :: Lens' DescribeDomainConfigResponse Int Source #

The response's http status code.

describeDomainConfigResponse_domainConfig :: Lens' DescribeDomainConfigResponse DomainConfig Source #

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

GetUpgradeStatus

getUpgradeStatus_domainName :: Lens' GetUpgradeStatus Text Source #

Undocumented member.

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

One of four statuses an upgrade have, 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 briefly describes the update.

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

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

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

getUpgradeStatusResponse_httpStatus :: Lens' GetUpgradeStatusResponse Int Source #

The response's http status code.

DeleteInboundConnection

deleteInboundConnection_connectionId :: Lens' DeleteInboundConnection Text Source #

The ID of the inbound connection to permanently delete.

deleteInboundConnectionResponse_connection :: Lens' DeleteInboundConnectionResponse (Maybe InboundConnection) Source #

The InboundConnection of the deleted inbound connection.

deleteInboundConnectionResponse_httpStatus :: Lens' DeleteInboundConnectionResponse Int Source #

The response's http status code.

DissociatePackage

dissociatePackage_packageID :: Lens' DissociatePackage Text Source #

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

dissociatePackage_domainName :: Lens' DissociatePackage Text Source #

The name of the domain 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.

DescribeDomain

describeDomain_domainName :: Lens' DescribeDomain Text Source #

The name of the domain for which you want information.

describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int Source #

The response's http status code.

describeDomainResponse_domainStatus :: Lens' DescribeDomainResponse DomainStatus Source #

The current status of the domain.

AddTags

addTags_arn :: Lens' AddTags Text Source #

Specify the ARN of the domain you want to add tags to.

addTags_tagList :: Lens' AddTags [Tag] Source #

List of Tag to add to the domain.

AcceptInboundConnection

acceptInboundConnection_connectionId :: Lens' AcceptInboundConnection Text Source #

The ID of the inbound connection you want to accept.

acceptInboundConnectionResponse_connection :: Lens' AcceptInboundConnectionResponse (Maybe InboundConnection) Source #

The InboundConnection of the accepted inbound connection.

acceptInboundConnectionResponse_httpStatus :: Lens' AcceptInboundConnectionResponse Int Source #

The response's http status code.

UpdateDomainConfig

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

Specify the type and size of the EBS volume to use.

updateDomainConfig_nodeToNodeEncryptionOptions :: Lens' UpdateDomainConfig (Maybe NodeToNodeEncryptionOptions) Source #

Specifies node-to-node encryption options.

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

IAM access policy as a JSON-formatted string.

updateDomainConfig_autoTuneOptions :: Lens' UpdateDomainConfig (Maybe AutoTuneOptions) Source #

Specifies Auto-Tune options.

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

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

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

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

updateDomainConfig_advancedSecurityOptions :: Lens' UpdateDomainConfig (Maybe AdvancedSecurityOptionsInput) Source #

Specifies advanced security options.

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

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

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

Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

updateDomainConfig_encryptionAtRestOptions :: Lens' UpdateDomainConfig (Maybe EncryptionAtRestOptions) Source #

Specifies encryption of data at rest options.

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

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

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

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

updateDomainConfig_advancedOptions :: Lens' UpdateDomainConfig (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 Advanced options for more information.

updateDomainConfig_domainName :: Lens' UpdateDomainConfig Text Source #

The name of the domain you're updating.

updateDomainConfigResponse_httpStatus :: Lens' UpdateDomainConfigResponse Int Source #

The response's http status code.

updateDomainConfigResponse_domainConfig :: Lens' UpdateDomainConfigResponse DomainConfig Source #

The status of the updated domain.

ListTags

listTags_arn :: Lens' ListTags Text Source #

Specify the ARN of the domain that the tags you want to view are attached to.

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

List of Tag for the requested domain.

listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #

The response's http status code.

DeletePackage

deletePackage_packageID :: Lens' DeletePackage Text Source #

The internal ID of the package 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.

UpdatePackage

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

A new description of the package.

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

A commit message for the new version which is shown as part of GetPackageVersionHistoryResponse.

updatePackage_packageID :: Lens' UpdatePackage Text Source #

The unique identifier for the package.

updatePackage_packageSource :: Lens' UpdatePackage PackageSource Source #

Undocumented member.

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

Information about the package.

updatePackageResponse_httpStatus :: Lens' UpdatePackageResponse Int Source #

The response's http status code.

CreateOutboundConnection

createOutboundConnection_localDomainInfo :: Lens' CreateOutboundConnection DomainInformationContainer Source #

The AWSDomainInformation for the local OpenSearch domain.

createOutboundConnection_remoteDomainInfo :: Lens' CreateOutboundConnection DomainInformationContainer Source #

The AWSDomainInformation for the remote OpenSearch domain.

createOutboundConnection_connectionAlias :: Lens' CreateOutboundConnection Text Source #

The connection alias used used by the customer for this cross-cluster connection.

createOutboundConnectionResponse_remoteDomainInfo :: Lens' CreateOutboundConnectionResponse (Maybe DomainInformationContainer) Source #

The AWSDomainInformation for the remote OpenSearch domain.

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

The connection alias provided during the create connection request.

createOutboundConnectionResponse_localDomainInfo :: Lens' CreateOutboundConnectionResponse (Maybe DomainInformationContainer) Source #

The AWSDomainInformation for the local OpenSearch domain.

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

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

createOutboundConnectionResponse_connectionStatus :: Lens' CreateOutboundConnectionResponse (Maybe OutboundConnectionStatus) Source #

The OutboundConnectionStatus for the newly created connection.

createOutboundConnectionResponse_httpStatus :: Lens' CreateOutboundConnectionResponse 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 Amazon S3 location from which to import the package.

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

Information about the package.

createPackageResponse_httpStatus :: Lens' CreatePackageResponse Int Source #

The response's http status code.

DeleteDomain

deleteDomain_domainName :: Lens' DeleteDomain Text Source #

The name of the domain you want to permanently delete.

deleteDomainResponse_domainStatus :: Lens' DeleteDomainResponse (Maybe DomainStatus) Source #

The status of the domain being deleted.

deleteDomainResponse_httpStatus :: Lens' DeleteDomainResponse Int Source #

The response's http status code.

GetCompatibleVersions

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

Undocumented member.

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

A map of compatible OpenSearch versions returned as part of the GetCompatibleVersions operation.

getCompatibleVersionsResponse_httpStatus :: Lens' GetCompatibleVersionsResponse Int Source #

The response's http status code.

Types

AWSDomainInformation

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

Undocumented member.

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

Undocumented member.

aWSDomainInformation_domainName :: Lens' AWSDomainInformation Text Source #

Undocumented member.

AccessPoliciesStatus

accessPoliciesStatus_options :: Lens' AccessPoliciesStatus Text Source #

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

accessPoliciesStatus_status :: Lens' AccessPoliciesStatus OptionStatus Source #

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

AdditionalLimit

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

Additional limit is specific to a given InstanceType and for each of its InstanceRole etc. Attributes and their details:

  • MaximumNumberOfDataNodesSupported
  • MaximumNumberOfDataNodesWithoutMasterNode

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

Value for a given AdditionalLimit$LimitName .

AdvancedOptionsStatus

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

The status of advanced options for the specified domain.

advancedOptionsStatus_status :: Lens' AdvancedOptionsStatus OptionStatus Source #

The OptionStatus for advanced options for the specified domain.

AdvancedSecurityOptions

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_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 #

The SAML application configuration for the domain.

AdvancedSecurityOptionsStatus

advancedSecurityOptionsStatus_options :: Lens' AdvancedSecurityOptionsStatus AdvancedSecurityOptions Source #

Advanced security options for the specified domain.

advancedSecurityOptionsStatus_status :: Lens' AdvancedSecurityOptionsStatus OptionStatus Source #

Status of the advanced security options for the specified domain.

AutoTune

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

Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.

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

Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.

AutoTuneDetails

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

Undocumented member.

AutoTuneMaintenanceSchedule

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

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

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

A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.

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

Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.

AutoTuneOptions

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

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

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

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

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

A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.

AutoTuneOptionsInput

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

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

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

A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.

AutoTuneOptionsOutput

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

The AutoTuneState for the domain.

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

The error message while enabling or disabling Auto-Tune.

AutoTuneOptionsStatus

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

The status of the Auto-Tune options for the domain.

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

Specifies Auto-Tune options for the domain.

AutoTuneStatus

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

Indicates whether the domain is being deleted.

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

The error message while enabling or disabling Auto-Tune.

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

The latest version of the Auto-Tune options.

autoTuneStatus_creationDate :: Lens' AutoTuneStatus UTCTime Source #

The timestamp of the Auto-Tune options creation date.

autoTuneStatus_updateDate :: Lens' AutoTuneStatus UTCTime Source #

The timestamp of when the Auto-Tune options were last updated.

autoTuneStatus_state :: Lens' AutoTuneStatus AutoTuneState Source #

The AutoTuneState for the domain.

ClusterConfig

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

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

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

The instance type for a dedicated master node.

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

A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

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

The number of instances in the specified domain cluster.

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

Specifies the ColdStorageOptions config for a Domain

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

A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

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

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

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

True to enable UltraWarm storage.

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

The zone awareness configuration for a domain when zone awareness is enabled.

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

The number of UltraWarm nodes in the cluster.

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

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

ClusterConfigStatus

clusterConfigStatus_options :: Lens' ClusterConfigStatus ClusterConfig Source #

The cluster configuration for the specified domain.

clusterConfigStatus_status :: Lens' ClusterConfigStatus OptionStatus Source #

The cluster configuration status for the specified domain.

CognitoOptions

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

The Cognito identity pool ID for OpenSearch Dashboards authentication.

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

The option to enable Cognito for OpenSearch Dashboards authentication.

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

The Cognito user pool ID for OpenSearch Dashboards authentication.

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

The role ARN that provides OpenSearch permissions for accessing Cognito resources.

CognitoOptionsStatus

cognitoOptionsStatus_options :: Lens' CognitoOptionsStatus CognitoOptions Source #

Cognito options for the specified domain.

cognitoOptionsStatus_status :: Lens' CognitoOptionsStatus OptionStatus Source #

The status of the Cognito options for the specified 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 OpenSearch a domain is on.

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

Undocumented member.

DescribePackagesFilter

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

A list of values for the specified field.

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

Any field from PackageDetails.

DomainConfig

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

The EBSOptions for the domain.

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

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.

domainConfig_nodeToNodeEncryptionOptions :: Lens' DomainConfig (Maybe NodeToNodeEncryptionOptionsStatus) Source #

The NodeToNodeEncryptionOptions for the domain.

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

IAM access policy as a JSON-formatted string.

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

Specifies AutoTuneOptions for the domain.

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

Log publishing options for the given domain.

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

The ClusterConfig for the domain.

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

Specifies AdvancedSecurityOptions for the domain.

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

The SnapshotOptions for the domain.

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

The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

domainConfig_encryptionAtRestOptions :: Lens' DomainConfig (Maybe EncryptionAtRestOptionsStatus) Source #

The EncryptionAtRestOptions for the domain.

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

The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

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

The DomainEndpointOptions for the domain.

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

The AdvancedOptions for the domain. See Advanced options for more information.

DomainEndpointOptions

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

Whether only HTTPS endpoint should be enabled for the domain.

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

Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:

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

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

Whether to enable a custom endpoint for the domain.

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

The fully qualified domain for your custom endpoint.

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

The ACM certificate ARN for your custom endpoint.

DomainEndpointOptionsStatus

domainEndpointOptionsStatus_options :: Lens' DomainEndpointOptionsStatus DomainEndpointOptions Source #

Options to configure the endpoint for the domain.

domainEndpointOptionsStatus_status :: Lens' DomainEndpointOptionsStatus OptionStatus Source #

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

DomainInfo

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

The DomainName.

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

Specifies the EngineType of the domain.

DomainInformationContainer

domainInformationContainer_aWSDomainInformation :: Lens' DomainInformationContainer (Maybe AWSDomainInformation) Source #

Undocumented member.

DomainPackageDetails

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

The timestamp of the most recent update to the package association status.

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

The internal ID of the package.

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

Currently supports only TXT-DICTIONARY.

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

User-specified name of the package.

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

Undocumented member.

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

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

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

The name of the domain you've associated a package with.

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

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

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

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

DomainStatus

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

The EBSOptions for the specified domain.

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

Undocumented member.

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

The status of the NodeToNodeEncryptionOptions.

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

IAM access policy as a JSON-formatted string.

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

The current status of the domain's service software.

domainStatus_autoTuneOptions :: Lens' DomainStatus (Maybe AutoTuneOptionsOutput) Source #

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

domainStatus_logPublishingOptions :: Lens' DomainStatus (Maybe (HashMap LogType LogPublishingOption)) Source #

Log publishing options for the given domain.

domainStatus_advancedSecurityOptions :: Lens' DomainStatus (Maybe AdvancedSecurityOptions) Source #

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

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

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

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

The status of the SnapshotOptions.

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

The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

domainStatus_encryptionAtRestOptions :: Lens' DomainStatus (Maybe EncryptionAtRestOptions) Source #

The status of the EncryptionAtRestOptions.

domainStatus_deleted :: Lens' DomainStatus (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.

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

The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

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

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

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

The current status of the domain's endpoint options.

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

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

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

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

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

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

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

The status of the AdvancedOptions.

domainStatus_domainId :: Lens' DomainStatus Text Source #

The unique identifier for the specified domain.

domainStatus_domainName :: Lens' DomainStatus Text Source #

The name of a 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).

domainStatus_arn :: Lens' DomainStatus Text Source #

The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

domainStatus_clusterConfig :: Lens' DomainStatus ClusterConfig Source #

The type and number of instances in the domain.

Duration

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

Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.

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

The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune for Amazon OpenSearch Service for more information.

EBSOptions

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

Integer to specify the size of an EBS volume.

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

The IOPD for a Provisioned IOPS EBS volume (SSD).

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

The volume type for EBS-based storage.

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

Whether EBS-based storage is enabled.

EBSOptionsStatus

eBSOptionsStatus_options :: Lens' EBSOptionsStatus EBSOptions Source #

The EBS options for the specified domain.

eBSOptionsStatus_status :: Lens' EBSOptionsStatus OptionStatus Source #

The status of the EBS options for the specified domain.

EncryptionAtRestOptions

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

The option to enable encryption at rest.

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

The KMS key ID for encryption at rest options.

EncryptionAtRestOptionsStatus

encryptionAtRestOptionsStatus_options :: Lens' EncryptionAtRestOptionsStatus EncryptionAtRestOptions Source #

The Encryption At Rest options for the specified domain.

encryptionAtRestOptionsStatus_status :: Lens' EncryptionAtRestOptionsStatus OptionStatus Source #

The status of the Encryption At Rest options for the specified domain.

ErrorDetails

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

Undocumented member.

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

Undocumented member.

Filter

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

Contains one or more values for the filter.

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

The name of the filter.

InboundConnection

inboundConnection_remoteDomainInfo :: Lens' InboundConnection (Maybe DomainInformationContainer) Source #

The AWSDomainInformation for the remote OpenSearch domain.

inboundConnection_localDomainInfo :: Lens' InboundConnection (Maybe DomainInformationContainer) Source #

The AWSDomainInformation for the local OpenSearch domain.

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

The connection ID for the inbound cross-cluster connection.

inboundConnection_connectionStatus :: Lens' InboundConnection (Maybe InboundConnectionStatus) Source #

The InboundConnectionStatus for the outbound connection.

InboundConnectionStatus

inboundConnectionStatus_message :: Lens' InboundConnectionStatus (Maybe Text) Source #

Verbose information for the inbound connection status.

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

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

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

InstanceCountLimits

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.

InstanceTypeDetails

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

Undocumented member.

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

Undocumented member.

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

Undocumented member.

instanceTypeDetails_instanceType :: Lens' InstanceTypeDetails (Maybe OpenSearchPartitionInstanceType) Source #

Undocumented member.

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

Undocumented member.

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

Undocumented member.

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

Undocumented member.

Limits

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

Undocumented member.

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

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

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

Storage-related types and attributes that are available for a given InstanceType.

LogPublishingOption

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

Whether the given log publishing option is enabled or not.

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

Undocumented member.

LogPublishingOptionsStatus

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

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

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

The log publishing options configured for the domain.

MasterUserOptions

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

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

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

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

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

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

NodeToNodeEncryptionOptions

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

True to enable node-to-node encryption.

NodeToNodeEncryptionOptionsStatus

nodeToNodeEncryptionOptionsStatus_options :: Lens' NodeToNodeEncryptionOptionsStatus NodeToNodeEncryptionOptions Source #

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

nodeToNodeEncryptionOptionsStatus_status :: Lens' NodeToNodeEncryptionOptionsStatus OptionStatus Source #

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

OptionStatus

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

Indicates whether the domain is being deleted.

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

The latest version of the entity.

optionStatus_creationDate :: Lens' OptionStatus UTCTime Source #

The timestamp of when the entity was created.

optionStatus_updateDate :: Lens' OptionStatus UTCTime Source #

The timestamp of the last time the entity was updated.

optionStatus_state :: Lens' OptionStatus OptionState Source #

Provides the OptionState for the domain.

OutboundConnection

outboundConnection_remoteDomainInfo :: Lens' OutboundConnection (Maybe DomainInformationContainer) Source #

The DomainInformation for the remote OpenSearch domain.

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

The connection alias for the outbound cross-cluster connection.

outboundConnection_localDomainInfo :: Lens' OutboundConnection (Maybe DomainInformationContainer) Source #

The DomainInformation for the local OpenSearch domain.

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

The connection ID for the outbound cross-cluster connection.

outboundConnection_connectionStatus :: Lens' OutboundConnection (Maybe OutboundConnectionStatus) Source #

The OutboundConnectionStatus for the outbound connection.

OutboundConnectionStatus

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

Verbose information for the outbound connection status.

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

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

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

PackageDetails

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

Internal ID of the package.

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

Currently supports only TXT-DICTIONARY.

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

Undocumented member.

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

The timestamp of when the package was created.

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, and DELETE_FAILED.

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

User-specified description of the package.

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

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

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

Undocumented member.

PackageSource

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

Key (file name) of the package.

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

The name of the Amazon S3 bucket containing the package.

PackageVersionHistory

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

The timestamp of when the package was created.

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

The package version.

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

A message associated with the package version.

RecurringCharge

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

The frequency of the recurring charge.

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

The monetary amount of the recurring charge.

ReservedInstance

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

The state of the reserved OpenSearch instance.

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

The currency code for the reserved OpenSearch instance offering.

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

The number of OpenSearch instances that have been reserved.

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

The time the reservation started.

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

The OpenSearch instance type offered by the reserved instance offering.

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

The customer-specified identifier to track this reservation.

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

Undocumented member.

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

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

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

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

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

The unique identifier for the reservation.

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

The offering identifier.

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

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

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

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

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

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

ReservedInstanceOffering

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

The currency code for the reserved OpenSearch instance offering.

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

The OpenSearch instance type offered by the reserved instance offering.

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

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

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

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

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

The OpenSearch reserved instance offering identifier.

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

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

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

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

reservedInstanceOffering_paymentOption :: Lens' ReservedInstanceOffering (Maybe ReservedInstancePaymentOption) Source #

Payment option for the reserved OpenSearch instance offering

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

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

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

True if SAML is enabled.

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

The SAML Identity Provider's information.

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

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

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

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

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

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

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

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

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

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

scheduledAutoTuneDetails_action :: Lens' ScheduledAutoTuneDetails (Maybe Text) Source #

The Auto-Tune action description.

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

The timestamp of the Auto-Tune action scheduled for the domain.

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

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

ServiceSoftwareOptions

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

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

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

The current service software version present on the domain.

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

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

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

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

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

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.

SnapshotOptions

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

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

SnapshotOptionsStatus

snapshotOptionsStatus_options :: Lens' SnapshotOptionsStatus SnapshotOptions Source #

The daily snapshot options specified for the domain.

snapshotOptionsStatus_status :: Lens' SnapshotOptionsStatus OptionStatus Source #

The status of a daily automated snapshot.

StorageType

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

Limits that are applicable for the given storage type.

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

Undocumented member.

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 the given storage type. If StorageType is "ebs", the following storage options are applicable:

  1. MinimumVolumeSize
  2. MaximumVolumeSize
  3. MaximumIops
  4. MinimumIops

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

Values for the StorageTypeLimit$LimitName .

Tag

tag_key :: Lens' Tag Text Source #

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

tag_value :: Lens' Tag Text Source #

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

UpgradeHistory

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

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

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

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

A list of UpgradeStepItem s representing information about each step performed as part of a specific upgrade or upgrade eligibility check.

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

A string that briefly describes the upgrade.

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

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

UpgradeStepItem

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

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

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

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

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

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

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

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

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

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

VPCDerivedInfo

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

The security groups for the VPC endpoint.

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

The subnets for the VPC endpoint.

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

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

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

The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.

VPCDerivedInfoStatus

vPCDerivedInfoStatus_options :: Lens' VPCDerivedInfoStatus VPCDerivedInfo Source #

The VPC options for the specified domain.

vPCDerivedInfoStatus_status :: Lens' VPCDerivedInfoStatus OptionStatus Source #

The status of the VPC options for the specified domain.

VPCOptions

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

The security groups for the VPC endpoint.

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

The subnets for the VPC endpoint.

VersionStatus

versionStatus_options :: Lens' VersionStatus Text Source #

The OpenSearch version for the specified OpenSearch domain.

versionStatus_status :: Lens' VersionStatus OptionStatus Source #

The status of the OpenSearch version options for the specified OpenSearch domain.

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.