| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.ElasticSearch.Types
Contents
- Service Configuration
- Errors
- ESPartitionInstanceType
- OptionState
- VolumeType
- AccessPoliciesStatus
- AdvancedOptionsStatus
- DomainInfo
- EBSOptions
- EBSOptionsStatus
- ElasticsearchClusterConfig
- ElasticsearchClusterConfigStatus
- ElasticsearchDomainConfig
- ElasticsearchDomainStatus
- OptionStatus
- SnapshotOptions
- SnapshotOptionsStatus
- Tag
Description
- elasticSearch :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _BaseException :: AsError a => Getting (First ServiceError) a ServiceError
- _DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTypeException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data ESPartitionInstanceType
- = I2_2XLarge_Elasticsearch
- | I2_XLarge_Elasticsearch
- | M3_2XLarge_Elasticsearch
- | M3_Large_Elasticsearch
- | M3_Medium_Elasticsearch
- | M3_XLarge_Elasticsearch
- | R3_2XLarge_Elasticsearch
- | R3_4XLarge_Elasticsearch
- | R3_8XLarge_Elasticsearch
- | R3_Large_Elasticsearch
- | R3_XLarge_Elasticsearch
- | T2_Medium_Elasticsearch
- | T2_Micro_Elasticsearch
- | T2_Small_Elasticsearch
- data OptionState
- data VolumeType
- data AccessPoliciesStatus
- accessPoliciesStatus :: Text -> OptionStatus -> AccessPoliciesStatus
- apsOptions :: Lens' AccessPoliciesStatus Text
- apsStatus :: Lens' AccessPoliciesStatus OptionStatus
- data AdvancedOptionsStatus
- advancedOptionsStatus :: OptionStatus -> AdvancedOptionsStatus
- aosOptions :: Lens' AdvancedOptionsStatus (HashMap Text Text)
- aosStatus :: Lens' AdvancedOptionsStatus OptionStatus
- data DomainInfo
- domainInfo :: DomainInfo
- diDomainName :: Lens' DomainInfo (Maybe Text)
- data EBSOptions
- ebsOptions :: EBSOptions
- eoVolumeSize :: Lens' EBSOptions (Maybe Int)
- eoIOPS :: Lens' EBSOptions (Maybe Int)
- eoVolumeType :: Lens' EBSOptions (Maybe VolumeType)
- eoEBSEnabled :: Lens' EBSOptions (Maybe Bool)
- data EBSOptionsStatus
- ebsOptionsStatus :: EBSOptions -> OptionStatus -> EBSOptionsStatus
- eosOptions :: Lens' EBSOptionsStatus EBSOptions
- eosStatus :: Lens' EBSOptionsStatus OptionStatus
- data ElasticsearchClusterConfig
- elasticsearchClusterConfig :: ElasticsearchClusterConfig
- eccDedicatedMasterCount :: Lens' ElasticsearchClusterConfig (Maybe Int)
- eccDedicatedMasterType :: Lens' ElasticsearchClusterConfig (Maybe ESPartitionInstanceType)
- eccDedicatedMasterEnabled :: Lens' ElasticsearchClusterConfig (Maybe Bool)
- eccInstanceCount :: Lens' ElasticsearchClusterConfig (Maybe Int)
- eccZoneAwarenessEnabled :: Lens' ElasticsearchClusterConfig (Maybe Bool)
- eccInstanceType :: Lens' ElasticsearchClusterConfig (Maybe ESPartitionInstanceType)
- data ElasticsearchClusterConfigStatus
- elasticsearchClusterConfigStatus :: ElasticsearchClusterConfig -> OptionStatus -> ElasticsearchClusterConfigStatus
- eccsOptions :: Lens' ElasticsearchClusterConfigStatus ElasticsearchClusterConfig
- eccsStatus :: Lens' ElasticsearchClusterConfigStatus OptionStatus
- data ElasticsearchDomainConfig
- elasticsearchDomainConfig :: ElasticsearchDomainConfig
- edcEBSOptions :: Lens' ElasticsearchDomainConfig (Maybe EBSOptionsStatus)
- edcAccessPolicies :: Lens' ElasticsearchDomainConfig (Maybe AccessPoliciesStatus)
- edcElasticsearchClusterConfig :: Lens' ElasticsearchDomainConfig (Maybe ElasticsearchClusterConfigStatus)
- edcSnapshotOptions :: Lens' ElasticsearchDomainConfig (Maybe SnapshotOptionsStatus)
- edcAdvancedOptions :: Lens' ElasticsearchDomainConfig (Maybe AdvancedOptionsStatus)
- data ElasticsearchDomainStatus
- elasticsearchDomainStatus :: Text -> Text -> Text -> ElasticsearchClusterConfig -> ElasticsearchDomainStatus
- edsEBSOptions :: Lens' ElasticsearchDomainStatus (Maybe EBSOptions)
- edsAccessPolicies :: Lens' ElasticsearchDomainStatus (Maybe Text)
- edsCreated :: Lens' ElasticsearchDomainStatus (Maybe Bool)
- edsSnapshotOptions :: Lens' ElasticsearchDomainStatus (Maybe SnapshotOptions)
- edsDeleted :: Lens' ElasticsearchDomainStatus (Maybe Bool)
- edsProcessing :: Lens' ElasticsearchDomainStatus (Maybe Bool)
- edsEndpoint :: Lens' ElasticsearchDomainStatus (Maybe Text)
- edsAdvancedOptions :: Lens' ElasticsearchDomainStatus (HashMap Text Text)
- edsDomainId :: Lens' ElasticsearchDomainStatus Text
- edsDomainName :: Lens' ElasticsearchDomainStatus Text
- edsARN :: Lens' ElasticsearchDomainStatus Text
- edsElasticsearchClusterConfig :: Lens' ElasticsearchDomainStatus ElasticsearchClusterConfig
- data OptionStatus
- optionStatus :: UTCTime -> UTCTime -> OptionState -> OptionStatus
- osPendingDeletion :: Lens' OptionStatus (Maybe Bool)
- osUpdateVersion :: Lens' OptionStatus (Maybe Natural)
- osCreationDate :: Lens' OptionStatus UTCTime
- osUpdateDate :: Lens' OptionStatus UTCTime
- osState :: Lens' OptionStatus OptionState
- data SnapshotOptions
- snapshotOptions :: SnapshotOptions
- soAutomatedSnapshotStartHour :: Lens' SnapshotOptions (Maybe Int)
- data SnapshotOptionsStatus
- snapshotOptionsStatus :: SnapshotOptions -> OptionStatus -> SnapshotOptionsStatus
- sosOptions :: Lens' SnapshotOptionsStatus SnapshotOptions
- sosStatus :: Lens' SnapshotOptionsStatus OptionStatus
- data Tag
- tag :: Text -> Text -> Tag
- tagKey :: Lens' Tag Text
- tagValue :: Lens' Tag Text
Service Configuration
elasticSearch :: Service Source #
API version '2015-01-01' of the Amazon Elasticsearch Service SDK configuration.
Errors
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception for missing / invalid input fields. Gives http status code of 400.
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception for creating a resource that already exists. Gives http status code of 400.
_BaseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred while processing the request.
_DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
_InternalException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
_InvalidTypeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
ESPartitionInstanceType
data ESPartitionInstanceType Source #
Constructors
Instances
OptionState
data OptionState Source #
The state of a requested change. One of the following:
- Processing: The request change is still in-process.
- Active: The request change is processed and deployed to the Elasticsearch domain.
Constructors
| Active | |
| Processing | |
| RequiresIndexDocuments |
Instances
VolumeType
data VolumeType Source #
The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storagefor more information.
Instances
AccessPoliciesStatus
data AccessPoliciesStatus Source #
The configured access rules for the domain's document and search endpoints, and the current status of those rules.
See: accessPoliciesStatus smart constructor.
Instances
Arguments
| :: Text | |
| -> OptionStatus | |
| -> AccessPoliciesStatus |
Creates a value of AccessPoliciesStatus with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
apsOptions :: 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.
apsStatus :: Lens' AccessPoliciesStatus OptionStatus Source #
The status of the access policy for the Elasticsearch domain. See
OptionStatus for the status information that's included.
AdvancedOptionsStatus
data AdvancedOptionsStatus Source #
Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:
- Option to allow references to indices in an HTTP request body. Must
be
falsewhen configuring access to individual sub-resources. By default, the value istrue. See Configuration Advanced Options for more information. - Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.
For more information, see Configuring Advanced Options.
See: advancedOptionsStatus smart constructor.
Instances
advancedOptionsStatus Source #
Arguments
| :: OptionStatus | |
| -> AdvancedOptionsStatus |
Creates a value of AdvancedOptionsStatus with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aosOptions :: Lens' AdvancedOptionsStatus (HashMap Text Text) Source #
Specifies the status of advanced options for the specified Elasticsearch domain.
aosStatus :: Lens' AdvancedOptionsStatus OptionStatus Source #
Specifies the status of OptionStatus for advanced options for the
specified Elasticsearch domain.
DomainInfo
domainInfo :: DomainInfo Source #
Creates a value of DomainInfo with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
diDomainName :: Lens' DomainInfo (Maybe Text) Source #
Specifies the DomainName.
EBSOptions
data EBSOptions Source #
Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.
See: ebsOptions smart constructor.
ebsOptions :: EBSOptions Source #
Creates a value of EBSOptions with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eoVolumeSize :: Lens' EBSOptions (Maybe Int) Source #
Integer to specify the size of an EBS volume.
eoIOPS :: Lens' EBSOptions (Maybe Int) Source #
Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
eoVolumeType :: Lens' EBSOptions (Maybe VolumeType) Source #
Specifies the volume type for EBS-based storage.
eoEBSEnabled :: Lens' EBSOptions (Maybe Bool) Source #
Specifies whether EBS-based storage is enabled.
EBSOptionsStatus
data EBSOptionsStatus Source #
Status of the EBS options for the specified Elasticsearch domain.
See: ebsOptionsStatus smart constructor.
Instances
Arguments
| :: EBSOptions | |
| -> OptionStatus | |
| -> EBSOptionsStatus |
Creates a value of EBSOptionsStatus with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eosOptions :: Lens' EBSOptionsStatus EBSOptions Source #
Specifies the EBS options for the specified Elasticsearch domain.
eosStatus :: Lens' EBSOptionsStatus OptionStatus Source #
Specifies the status of the EBS options for the specified Elasticsearch domain.
ElasticsearchClusterConfig
data ElasticsearchClusterConfig Source #
Specifies the configuration for the domain cluster, such as the type and number of instances.
See: elasticsearchClusterConfig smart constructor.
Instances
elasticsearchClusterConfig :: ElasticsearchClusterConfig Source #
Creates a value of ElasticsearchClusterConfig with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eccDedicatedMasterCount :: Lens' ElasticsearchClusterConfig (Maybe Int) Source #
Total number of dedicated master nodes, active and on standby, for the cluster.
eccDedicatedMasterType :: Lens' ElasticsearchClusterConfig (Maybe ESPartitionInstanceType) Source #
The instance type for a dedicated master node.
eccDedicatedMasterEnabled :: 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.
eccInstanceCount :: Lens' ElasticsearchClusterConfig (Maybe Int) Source #
The number of instances in the specified domain cluster.
eccZoneAwarenessEnabled :: Lens' ElasticsearchClusterConfig (Maybe Bool) Source #
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
eccInstanceType :: Lens' ElasticsearchClusterConfig (Maybe ESPartitionInstanceType) Source #
The instance type for an Elasticsearch cluster.
ElasticsearchClusterConfigStatus
data ElasticsearchClusterConfigStatus Source #
Specifies the configuration status for the specified Elasticsearch domain.
See: elasticsearchClusterConfigStatus smart constructor.
Instances
elasticsearchClusterConfigStatus Source #
Arguments
| :: ElasticsearchClusterConfig | |
| -> OptionStatus | |
| -> ElasticsearchClusterConfigStatus |
Creates a value of ElasticsearchClusterConfigStatus with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eccsOptions :: Lens' ElasticsearchClusterConfigStatus ElasticsearchClusterConfig Source #
Specifies the cluster configuration for the specified Elasticsearch domain.
eccsStatus :: Lens' ElasticsearchClusterConfigStatus OptionStatus Source #
Specifies the status of the configuration for the specified Elasticsearch domain.
ElasticsearchDomainConfig
data ElasticsearchDomainConfig Source #
The configuration of an Elasticsearch domain.
See: elasticsearchDomainConfig smart constructor.
Instances
elasticsearchDomainConfig :: ElasticsearchDomainConfig Source #
Creates a value of ElasticsearchDomainConfig with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
edcEBSOptions :: Lens' ElasticsearchDomainConfig (Maybe EBSOptionsStatus) Source #
Specifies the EBSOptions for the Elasticsearch domain.
edcAccessPolicies :: Lens' ElasticsearchDomainConfig (Maybe AccessPoliciesStatus) Source #
IAM access policy as a JSON-formatted string.
edcElasticsearchClusterConfig :: Lens' ElasticsearchDomainConfig (Maybe ElasticsearchClusterConfigStatus) Source #
Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.
edcSnapshotOptions :: Lens' ElasticsearchDomainConfig (Maybe SnapshotOptionsStatus) Source #
Specifies the SnapshotOptions for the Elasticsearch domain.
edcAdvancedOptions :: Lens' ElasticsearchDomainConfig (Maybe AdvancedOptionsStatus) Source #
Specifies the AdvancedOptions for the domain. See
Configuring Advanced Options
for more information.
ElasticsearchDomainStatus
data ElasticsearchDomainStatus Source #
The current status of an Elasticsearch domain.
See: elasticsearchDomainStatus smart constructor.
Instances
elasticsearchDomainStatus Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ElasticsearchClusterConfig | |
| -> ElasticsearchDomainStatus |
Creates a value of ElasticsearchDomainStatus with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
edsEBSOptions :: Lens' ElasticsearchDomainStatus (Maybe EBSOptions) Source #
The EBSOptions for the specified domain. See
Configuring EBS-based Storage
for more information.
edsAccessPolicies :: Lens' ElasticsearchDomainStatus (Maybe Text) Source #
IAM access policy as a JSON-formatted string.
edsSnapshotOptions :: Lens' ElasticsearchDomainStatus (Maybe SnapshotOptions) Source #
Specifies the status of the SnapshotOptions
edsEndpoint :: Lens' ElasticsearchDomainStatus (Maybe Text) Source #
The Elasticsearch domain endpoint that you use to submit index and search requests.
edsAdvancedOptions :: Lens' ElasticsearchDomainStatus (HashMap Text Text) Source #
Specifies the status of the AdvancedOptions
edsDomainId :: Lens' ElasticsearchDomainStatus Text Source #
The unique identifier for the specified Elasticsearch domain.
edsDomainName :: 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).
edsARN :: 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.
edsElasticsearchClusterConfig :: Lens' ElasticsearchDomainStatus ElasticsearchClusterConfig Source #
The type and number of instances in the domain cluster.
OptionStatus
data OptionStatus Source #
Provides the current status of the entity.
See: optionStatus smart constructor.
Arguments
| :: UTCTime | |
| -> UTCTime | |
| -> OptionState | |
| -> OptionStatus |
Creates a value of OptionStatus with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
osPendingDeletion :: Lens' OptionStatus (Maybe Bool) Source #
Indicates whether the Elasticsearch domain is being deleted.
osUpdateVersion :: Lens' OptionStatus (Maybe Natural) Source #
Specifies the latest version for the entity.
osCreationDate :: Lens' OptionStatus UTCTime Source #
Timestamp which tells the creation date for the entity.
osUpdateDate :: Lens' OptionStatus UTCTime Source #
Timestamp which tells the last updated time for the entity.
osState :: Lens' OptionStatus OptionState Source #
Provides the OptionState for the Elasticsearch domain.
SnapshotOptions
data SnapshotOptions 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.
See: snapshotOptions smart constructor.
Instances
snapshotOptions :: SnapshotOptions Source #
Creates a value of SnapshotOptions with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
soAutomatedSnapshotStartHour :: 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
data SnapshotOptionsStatus Source #
Status of a daily automated snapshot.
See: snapshotOptionsStatus smart constructor.
Instances
snapshotOptionsStatus Source #
Arguments
| :: SnapshotOptions | |
| -> OptionStatus | |
| -> SnapshotOptionsStatus |
Creates a value of SnapshotOptionsStatus with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sosOptions :: Lens' SnapshotOptionsStatus SnapshotOptions Source #
Specifies the daily snapshot options specified for the Elasticsearch domain.
sosStatus :: Lens' SnapshotOptionsStatus OptionStatus Source #
Specifies the status of a daily automated snapshot.
Tag
Specifies a key value pair for a resource tag.
See: tag smart constructor.