| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.OpenSearch
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- RejectInboundConnection
- DescribeOutboundConnections
- RemoveTags
- DescribeInstanceTypeLimits
- DescribeInboundConnections
- CancelServiceSoftwareUpdate
- ListDomainsForPackage
- ListPackagesForDomain
- UpgradeDomain
- DescribeDomainAutoTunes
- DescribeReservedInstances
- StartServiceSoftwareUpdate
- DeleteOutboundConnection
- ListVersions
- DescribeReservedInstanceOfferings
- ListDomainNames
- PurchaseReservedInstanceOffering
- DescribeDomains
- AssociatePackage
- ListInstanceTypeDetails
- GetPackageVersionHistory
- GetUpgradeHistory
- DescribePackages
- CreateDomain
- DescribeDomainConfig
- GetUpgradeStatus
- DeleteInboundConnection
- DissociatePackage
- DescribeDomain
- AddTags
- AcceptInboundConnection
- UpdateDomainConfig
- ListTags
- DeletePackage
- UpdatePackage
- CreateOutboundConnection
- CreatePackage
- DeleteDomain
- GetCompatibleVersions
- Types
- AutoTuneDesiredState
- AutoTuneState
- AutoTuneType
- DeploymentStatus
- DescribePackagesFilterName
- DomainPackageStatus
- EngineType
- InboundConnectionStatusCode
- LogType
- OpenSearchPartitionInstanceType
- OpenSearchWarmPartitionInstanceType
- OptionState
- OutboundConnectionStatusCode
- PackageStatus
- PackageType
- ReservedInstancePaymentOption
- RollbackOnDisable
- ScheduledAutoTuneActionType
- ScheduledAutoTuneSeverityType
- TLSSecurityPolicy
- TimeUnit
- UpgradeStatus
- UpgradeStep
- VolumeType
- AWSDomainInformation
- AccessPoliciesStatus
- AdditionalLimit
- AdvancedOptionsStatus
- AdvancedSecurityOptions
- AdvancedSecurityOptionsInput
- AdvancedSecurityOptionsStatus
- AutoTune
- AutoTuneDetails
- AutoTuneMaintenanceSchedule
- AutoTuneOptions
- AutoTuneOptionsInput
- AutoTuneOptionsOutput
- AutoTuneOptionsStatus
- AutoTuneStatus
- ClusterConfig
- ClusterConfigStatus
- CognitoOptions
- CognitoOptionsStatus
- ColdStorageOptions
- CompatibleVersionsMap
- DescribePackagesFilter
- DomainConfig
- DomainEndpointOptions
- DomainEndpointOptionsStatus
- DomainInfo
- DomainInformationContainer
- DomainPackageDetails
- DomainStatus
- Duration
- EBSOptions
- EBSOptionsStatus
- EncryptionAtRestOptions
- EncryptionAtRestOptionsStatus
- ErrorDetails
- Filter
- InboundConnection
- InboundConnectionStatus
- InstanceCountLimits
- InstanceLimits
- InstanceTypeDetails
- Limits
- LogPublishingOption
- LogPublishingOptionsStatus
- MasterUserOptions
- NodeToNodeEncryptionOptions
- NodeToNodeEncryptionOptionsStatus
- OptionStatus
- OutboundConnection
- OutboundConnectionStatus
- PackageDetails
- PackageSource
- PackageVersionHistory
- RecurringCharge
- ReservedInstance
- ReservedInstanceOffering
- SAMLIdp
- SAMLOptionsInput
- SAMLOptionsOutput
- ScheduledAutoTuneDetails
- ServiceSoftwareOptions
- SnapshotOptions
- SnapshotOptionsStatus
- StorageType
- StorageTypeLimit
- Tag
- UpgradeHistory
- UpgradeStepItem
- VPCDerivedInfo
- VPCDerivedInfoStatus
- VPCOptions
- VersionStatus
- ZoneAwarenessConfig
Description
Derived from API version 2021-01-01 of the AWS service descriptions, licensed under Apache 2.0.
Amazon OpenSearch Configuration Service
Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon OpenSearch Service domains.
For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs.
The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: 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
- _InvalidPaginationTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data RejectInboundConnection = RejectInboundConnection' Text
- newRejectInboundConnection :: Text -> RejectInboundConnection
- data RejectInboundConnectionResponse = RejectInboundConnectionResponse' (Maybe InboundConnection) Int
- newRejectInboundConnectionResponse :: Int -> RejectInboundConnectionResponse
- data DescribeOutboundConnections = DescribeOutboundConnections' (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeOutboundConnections :: DescribeOutboundConnections
- data DescribeOutboundConnectionsResponse = DescribeOutboundConnectionsResponse' (Maybe [OutboundConnection]) (Maybe Text) Int
- newDescribeOutboundConnectionsResponse :: Int -> DescribeOutboundConnectionsResponse
- data RemoveTags = RemoveTags' Text [Text]
- newRemoveTags :: Text -> RemoveTags
- data RemoveTagsResponse = RemoveTagsResponse' {
- newRemoveTagsResponse :: RemoveTagsResponse
- data DescribeInstanceTypeLimits = DescribeInstanceTypeLimits' (Maybe Text) OpenSearchPartitionInstanceType Text
- newDescribeInstanceTypeLimits :: OpenSearchPartitionInstanceType -> Text -> DescribeInstanceTypeLimits
- data DescribeInstanceTypeLimitsResponse = DescribeInstanceTypeLimitsResponse' (Maybe (HashMap Text Limits)) Int
- newDescribeInstanceTypeLimitsResponse :: Int -> DescribeInstanceTypeLimitsResponse
- data DescribeInboundConnections = DescribeInboundConnections' (Maybe [Filter]) (Maybe Text) (Maybe Int)
- newDescribeInboundConnections :: DescribeInboundConnections
- data DescribeInboundConnectionsResponse = DescribeInboundConnectionsResponse' (Maybe [InboundConnection]) (Maybe Text) Int
- newDescribeInboundConnectionsResponse :: Int -> DescribeInboundConnectionsResponse
- data CancelServiceSoftwareUpdate = CancelServiceSoftwareUpdate' Text
- newCancelServiceSoftwareUpdate :: Text -> CancelServiceSoftwareUpdate
- data CancelServiceSoftwareUpdateResponse = CancelServiceSoftwareUpdateResponse' (Maybe ServiceSoftwareOptions) Int
- newCancelServiceSoftwareUpdateResponse :: Int -> CancelServiceSoftwareUpdateResponse
- data ListDomainsForPackage = ListDomainsForPackage' (Maybe Text) (Maybe Int) Text
- newListDomainsForPackage :: Text -> ListDomainsForPackage
- data ListDomainsForPackageResponse = ListDomainsForPackageResponse' (Maybe [DomainPackageDetails]) (Maybe Text) Int
- newListDomainsForPackageResponse :: Int -> ListDomainsForPackageResponse
- data ListPackagesForDomain = ListPackagesForDomain' (Maybe Text) (Maybe Int) Text
- newListPackagesForDomain :: Text -> ListPackagesForDomain
- data ListPackagesForDomainResponse = ListPackagesForDomainResponse' (Maybe [DomainPackageDetails]) (Maybe Text) Int
- newListPackagesForDomainResponse :: Int -> ListPackagesForDomainResponse
- data UpgradeDomain = UpgradeDomain' (Maybe Bool) (Maybe (HashMap Text Text)) Text Text
- newUpgradeDomain :: Text -> Text -> UpgradeDomain
- data UpgradeDomainResponse = UpgradeDomainResponse' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newUpgradeDomainResponse :: Int -> UpgradeDomainResponse
- data DescribeDomainAutoTunes = DescribeDomainAutoTunes' (Maybe Text) (Maybe Int) Text
- newDescribeDomainAutoTunes :: Text -> DescribeDomainAutoTunes
- data DescribeDomainAutoTunesResponse = DescribeDomainAutoTunesResponse' (Maybe Text) (Maybe [AutoTune]) Int
- newDescribeDomainAutoTunesResponse :: Int -> DescribeDomainAutoTunesResponse
- data DescribeReservedInstances = DescribeReservedInstances' (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeReservedInstances :: DescribeReservedInstances
- data DescribeReservedInstancesResponse = DescribeReservedInstancesResponse' (Maybe Text) (Maybe [ReservedInstance]) Int
- newDescribeReservedInstancesResponse :: Int -> DescribeReservedInstancesResponse
- data StartServiceSoftwareUpdate = StartServiceSoftwareUpdate' Text
- newStartServiceSoftwareUpdate :: Text -> StartServiceSoftwareUpdate
- data StartServiceSoftwareUpdateResponse = StartServiceSoftwareUpdateResponse' (Maybe ServiceSoftwareOptions) Int
- newStartServiceSoftwareUpdateResponse :: Int -> StartServiceSoftwareUpdateResponse
- data DeleteOutboundConnection = DeleteOutboundConnection' Text
- newDeleteOutboundConnection :: Text -> DeleteOutboundConnection
- data DeleteOutboundConnectionResponse = DeleteOutboundConnectionResponse' (Maybe OutboundConnection) Int
- newDeleteOutboundConnectionResponse :: Int -> DeleteOutboundConnectionResponse
- data ListVersions = ListVersions' (Maybe Text) (Maybe Int)
- newListVersions :: ListVersions
- data ListVersionsResponse = ListVersionsResponse' (Maybe [Text]) (Maybe Text) Int
- newListVersionsResponse :: Int -> ListVersionsResponse
- data DescribeReservedInstanceOfferings = DescribeReservedInstanceOfferings' (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeReservedInstanceOfferings :: DescribeReservedInstanceOfferings
- data DescribeReservedInstanceOfferingsResponse = DescribeReservedInstanceOfferingsResponse' (Maybe Text) (Maybe [ReservedInstanceOffering]) Int
- newDescribeReservedInstanceOfferingsResponse :: Int -> DescribeReservedInstanceOfferingsResponse
- data ListDomainNames = ListDomainNames' (Maybe EngineType)
- newListDomainNames :: ListDomainNames
- data ListDomainNamesResponse = ListDomainNamesResponse' (Maybe [DomainInfo]) Int
- newListDomainNamesResponse :: Int -> ListDomainNamesResponse
- data PurchaseReservedInstanceOffering = PurchaseReservedInstanceOffering' (Maybe Natural) Text Text
- newPurchaseReservedInstanceOffering :: Text -> Text -> PurchaseReservedInstanceOffering
- data PurchaseReservedInstanceOfferingResponse = PurchaseReservedInstanceOfferingResponse' (Maybe Text) (Maybe Text) Int
- newPurchaseReservedInstanceOfferingResponse :: Int -> PurchaseReservedInstanceOfferingResponse
- data DescribeDomains = DescribeDomains' [Text]
- newDescribeDomains :: DescribeDomains
- data DescribeDomainsResponse = DescribeDomainsResponse' Int [DomainStatus]
- newDescribeDomainsResponse :: Int -> DescribeDomainsResponse
- data AssociatePackage = AssociatePackage' Text Text
- newAssociatePackage :: Text -> Text -> AssociatePackage
- data AssociatePackageResponse = AssociatePackageResponse' (Maybe DomainPackageDetails) Int
- newAssociatePackageResponse :: Int -> AssociatePackageResponse
- data ListInstanceTypeDetails = ListInstanceTypeDetails' (Maybe Text) (Maybe Text) (Maybe Int) Text
- newListInstanceTypeDetails :: Text -> ListInstanceTypeDetails
- data ListInstanceTypeDetailsResponse = ListInstanceTypeDetailsResponse' (Maybe [InstanceTypeDetails]) (Maybe Text) Int
- newListInstanceTypeDetailsResponse :: Int -> ListInstanceTypeDetailsResponse
- data GetPackageVersionHistory = GetPackageVersionHistory' (Maybe Text) (Maybe Int) Text
- newGetPackageVersionHistory :: Text -> GetPackageVersionHistory
- data GetPackageVersionHistoryResponse = GetPackageVersionHistoryResponse' (Maybe Text) (Maybe [PackageVersionHistory]) (Maybe Text) Int
- newGetPackageVersionHistoryResponse :: Int -> GetPackageVersionHistoryResponse
- data GetUpgradeHistory = GetUpgradeHistory' (Maybe Text) (Maybe Int) Text
- newGetUpgradeHistory :: Text -> GetUpgradeHistory
- data GetUpgradeHistoryResponse = GetUpgradeHistoryResponse' (Maybe Text) (Maybe [UpgradeHistory]) Int
- newGetUpgradeHistoryResponse :: Int -> GetUpgradeHistoryResponse
- data DescribePackages = DescribePackages' (Maybe [DescribePackagesFilter]) (Maybe Text) (Maybe Int)
- newDescribePackages :: DescribePackages
- data DescribePackagesResponse = DescribePackagesResponse' (Maybe [PackageDetails]) (Maybe Text) Int
- newDescribePackagesResponse :: Int -> DescribePackagesResponse
- data CreateDomain = CreateDomain' (Maybe EBSOptions) (Maybe Text) (Maybe NodeToNodeEncryptionOptions) (Maybe Text) (Maybe AutoTuneOptionsInput) (Maybe (HashMap LogType LogPublishingOption)) (Maybe ClusterConfig) (Maybe AdvancedSecurityOptionsInput) (Maybe [Tag]) (Maybe SnapshotOptions) (Maybe CognitoOptions) (Maybe EncryptionAtRestOptions) (Maybe VPCOptions) (Maybe DomainEndpointOptions) (Maybe (HashMap Text Text)) Text
- newCreateDomain :: Text -> CreateDomain
- data CreateDomainResponse = CreateDomainResponse' (Maybe DomainStatus) Int
- newCreateDomainResponse :: Int -> CreateDomainResponse
- data DescribeDomainConfig = DescribeDomainConfig' Text
- newDescribeDomainConfig :: Text -> DescribeDomainConfig
- data DescribeDomainConfigResponse = DescribeDomainConfigResponse' Int DomainConfig
- newDescribeDomainConfigResponse :: Int -> DomainConfig -> DescribeDomainConfigResponse
- data GetUpgradeStatus = GetUpgradeStatus' Text
- newGetUpgradeStatus :: Text -> GetUpgradeStatus
- data GetUpgradeStatusResponse = GetUpgradeStatusResponse' (Maybe UpgradeStatus) (Maybe Text) (Maybe UpgradeStep) Int
- newGetUpgradeStatusResponse :: Int -> GetUpgradeStatusResponse
- data DeleteInboundConnection = DeleteInboundConnection' Text
- newDeleteInboundConnection :: Text -> DeleteInboundConnection
- data DeleteInboundConnectionResponse = DeleteInboundConnectionResponse' (Maybe InboundConnection) Int
- newDeleteInboundConnectionResponse :: Int -> DeleteInboundConnectionResponse
- data DissociatePackage = DissociatePackage' Text Text
- newDissociatePackage :: Text -> Text -> DissociatePackage
- data DissociatePackageResponse = DissociatePackageResponse' (Maybe DomainPackageDetails) Int
- newDissociatePackageResponse :: Int -> DissociatePackageResponse
- data DescribeDomain = DescribeDomain' Text
- newDescribeDomain :: Text -> DescribeDomain
- data DescribeDomainResponse = DescribeDomainResponse' Int DomainStatus
- newDescribeDomainResponse :: Int -> DomainStatus -> DescribeDomainResponse
- data AddTags = AddTags' Text [Tag]
- newAddTags :: Text -> AddTags
- data AddTagsResponse = AddTagsResponse' {
- newAddTagsResponse :: AddTagsResponse
- data AcceptInboundConnection = AcceptInboundConnection' Text
- newAcceptInboundConnection :: Text -> AcceptInboundConnection
- data AcceptInboundConnectionResponse = AcceptInboundConnectionResponse' (Maybe InboundConnection) Int
- newAcceptInboundConnectionResponse :: Int -> AcceptInboundConnectionResponse
- data UpdateDomainConfig = UpdateDomainConfig' (Maybe EBSOptions) (Maybe NodeToNodeEncryptionOptions) (Maybe Text) (Maybe AutoTuneOptions) (Maybe (HashMap LogType LogPublishingOption)) (Maybe ClusterConfig) (Maybe AdvancedSecurityOptionsInput) (Maybe SnapshotOptions) (Maybe CognitoOptions) (Maybe EncryptionAtRestOptions) (Maybe VPCOptions) (Maybe DomainEndpointOptions) (Maybe (HashMap Text Text)) Text
- newUpdateDomainConfig :: Text -> UpdateDomainConfig
- data UpdateDomainConfigResponse = UpdateDomainConfigResponse' Int DomainConfig
- newUpdateDomainConfigResponse :: Int -> DomainConfig -> UpdateDomainConfigResponse
- data ListTags = ListTags' Text
- newListTags :: Text -> ListTags
- data ListTagsResponse = ListTagsResponse' (Maybe [Tag]) Int
- newListTagsResponse :: Int -> ListTagsResponse
- data DeletePackage = DeletePackage' Text
- newDeletePackage :: Text -> DeletePackage
- data DeletePackageResponse = DeletePackageResponse' (Maybe PackageDetails) Int
- newDeletePackageResponse :: Int -> DeletePackageResponse
- data UpdatePackage = UpdatePackage' (Maybe Text) (Maybe Text) Text PackageSource
- newUpdatePackage :: Text -> PackageSource -> UpdatePackage
- data UpdatePackageResponse = UpdatePackageResponse' (Maybe PackageDetails) Int
- newUpdatePackageResponse :: Int -> UpdatePackageResponse
- data CreateOutboundConnection = CreateOutboundConnection' DomainInformationContainer DomainInformationContainer Text
- newCreateOutboundConnection :: DomainInformationContainer -> DomainInformationContainer -> Text -> CreateOutboundConnection
- data CreateOutboundConnectionResponse = CreateOutboundConnectionResponse' (Maybe DomainInformationContainer) (Maybe Text) (Maybe DomainInformationContainer) (Maybe Text) (Maybe OutboundConnectionStatus) Int
- newCreateOutboundConnectionResponse :: Int -> CreateOutboundConnectionResponse
- data CreatePackage = CreatePackage' (Maybe Text) Text PackageType PackageSource
- newCreatePackage :: Text -> PackageType -> PackageSource -> CreatePackage
- data CreatePackageResponse = CreatePackageResponse' (Maybe PackageDetails) Int
- newCreatePackageResponse :: Int -> CreatePackageResponse
- data DeleteDomain = DeleteDomain' Text
- newDeleteDomain :: Text -> DeleteDomain
- data DeleteDomainResponse = DeleteDomainResponse' (Maybe DomainStatus) Int
- newDeleteDomainResponse :: Int -> DeleteDomainResponse
- data GetCompatibleVersions = GetCompatibleVersions' (Maybe Text)
- newGetCompatibleVersions :: GetCompatibleVersions
- data GetCompatibleVersionsResponse = GetCompatibleVersionsResponse' (Maybe [CompatibleVersionsMap]) Int
- newGetCompatibleVersionsResponse :: Int -> GetCompatibleVersionsResponse
- newtype AutoTuneDesiredState where
- newtype AutoTuneState where
- AutoTuneState' { }
- pattern AutoTuneState_DISABLED :: AutoTuneState
- pattern AutoTuneState_DISABLED_AND_ROLLBACK_COMPLETE :: AutoTuneState
- pattern AutoTuneState_DISABLED_AND_ROLLBACK_ERROR :: AutoTuneState
- pattern AutoTuneState_DISABLED_AND_ROLLBACK_IN_PROGRESS :: AutoTuneState
- pattern AutoTuneState_DISABLED_AND_ROLLBACK_SCHEDULED :: AutoTuneState
- pattern AutoTuneState_DISABLE_IN_PROGRESS :: AutoTuneState
- pattern AutoTuneState_ENABLED :: AutoTuneState
- pattern AutoTuneState_ENABLE_IN_PROGRESS :: AutoTuneState
- pattern AutoTuneState_ERROR :: AutoTuneState
- newtype AutoTuneType where
- AutoTuneType' { }
- pattern AutoTuneType_SCHEDULED_ACTION :: AutoTuneType
- newtype DeploymentStatus where
- DeploymentStatus' { }
- pattern DeploymentStatus_COMPLETED :: DeploymentStatus
- pattern DeploymentStatus_ELIGIBLE :: DeploymentStatus
- pattern DeploymentStatus_IN_PROGRESS :: DeploymentStatus
- pattern DeploymentStatus_NOT_ELIGIBLE :: DeploymentStatus
- pattern DeploymentStatus_PENDING_UPDATE :: DeploymentStatus
- newtype DescribePackagesFilterName where
- newtype DomainPackageStatus where
- DomainPackageStatus' { }
- pattern DomainPackageStatus_ACTIVE :: DomainPackageStatus
- pattern DomainPackageStatus_ASSOCIATING :: DomainPackageStatus
- pattern DomainPackageStatus_ASSOCIATION_FAILED :: DomainPackageStatus
- pattern DomainPackageStatus_DISSOCIATING :: DomainPackageStatus
- pattern DomainPackageStatus_DISSOCIATION_FAILED :: DomainPackageStatus
- newtype EngineType where
- EngineType' { }
- pattern EngineType_Elasticsearch :: EngineType
- pattern EngineType_OpenSearch :: EngineType
- newtype InboundConnectionStatusCode where
- InboundConnectionStatusCode' { }
- pattern InboundConnectionStatusCode_ACTIVE :: InboundConnectionStatusCode
- pattern InboundConnectionStatusCode_APPROVED :: InboundConnectionStatusCode
- pattern InboundConnectionStatusCode_DELETED :: InboundConnectionStatusCode
- pattern InboundConnectionStatusCode_DELETING :: InboundConnectionStatusCode
- pattern InboundConnectionStatusCode_PENDING_ACCEPTANCE :: InboundConnectionStatusCode
- pattern InboundConnectionStatusCode_PROVISIONING :: InboundConnectionStatusCode
- pattern InboundConnectionStatusCode_REJECTED :: InboundConnectionStatusCode
- pattern InboundConnectionStatusCode_REJECTING :: InboundConnectionStatusCode
- newtype LogType where
- LogType' {
- fromLogType :: Text
- pattern LogType_AUDIT_LOGS :: LogType
- pattern LogType_ES_APPLICATION_LOGS :: LogType
- pattern LogType_INDEX_SLOW_LOGS :: LogType
- pattern LogType_SEARCH_SLOW_LOGS :: LogType
- LogType' {
- newtype OpenSearchPartitionInstanceType where
- OpenSearchPartitionInstanceType' { }
- pattern OpenSearchPartitionInstanceType_C4_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C4_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C4_8xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C4_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C4_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C5_18xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C5_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C5_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C5_9xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C5_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C5_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C6g_12xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C6g_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C6g_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C6g_8xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C6g_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_C6g_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_D2_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_D2_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_D2_8xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_D2_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_I2_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_I2_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_I3_16xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_I3_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_I3_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_I3_8xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_I3_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_I3_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M3_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M3_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M3_medium_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M3_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M4_10xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M4_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M4_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M4_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M4_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M5_12xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M5_24xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M5_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M5_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M5_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M5_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M6g_12xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M6g_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M6g_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M6g_8xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M6g_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_M6g_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R3_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R3_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R3_8xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R3_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R3_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R4_16xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R4_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R4_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R4_8xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R4_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R4_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R5_12xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R5_24xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R5_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R5_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R5_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R5_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6g_12xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6g_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6g_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6g_8xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6g_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6g_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6gd_12xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6gd_16xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6gd_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6gd_4xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6gd_8xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6gd_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_R6gd_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_T2_medium_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_T2_micro_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_T2_small_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_T3_2xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_T3_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_T3_medium_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_T3_micro_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_T3_nano_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_T3_small_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_T3_xlarge_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_T4g_medium_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_T4g_small_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_Ultrawarm1_large_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_Ultrawarm1_medium_search :: OpenSearchPartitionInstanceType
- pattern OpenSearchPartitionInstanceType_Ultrawarm1_xlarge_search :: OpenSearchPartitionInstanceType
- newtype OpenSearchWarmPartitionInstanceType where
- OpenSearchWarmPartitionInstanceType' { }
- pattern OpenSearchWarmPartitionInstanceType_Ultrawarm1_large_search :: OpenSearchWarmPartitionInstanceType
- pattern OpenSearchWarmPartitionInstanceType_Ultrawarm1_medium_search :: OpenSearchWarmPartitionInstanceType
- pattern OpenSearchWarmPartitionInstanceType_Ultrawarm1_xlarge_search :: OpenSearchWarmPartitionInstanceType
- newtype OptionState where
- OptionState' { }
- pattern OptionState_Active :: OptionState
- pattern OptionState_Processing :: OptionState
- pattern OptionState_RequiresIndexDocuments :: OptionState
- newtype OutboundConnectionStatusCode where
- OutboundConnectionStatusCode' { }
- pattern OutboundConnectionStatusCode_ACTIVE :: OutboundConnectionStatusCode
- pattern OutboundConnectionStatusCode_APPROVED :: OutboundConnectionStatusCode
- pattern OutboundConnectionStatusCode_DELETED :: OutboundConnectionStatusCode
- pattern OutboundConnectionStatusCode_DELETING :: OutboundConnectionStatusCode
- pattern OutboundConnectionStatusCode_PENDING_ACCEPTANCE :: OutboundConnectionStatusCode
- pattern OutboundConnectionStatusCode_PROVISIONING :: OutboundConnectionStatusCode
- pattern OutboundConnectionStatusCode_REJECTED :: OutboundConnectionStatusCode
- pattern OutboundConnectionStatusCode_REJECTING :: OutboundConnectionStatusCode
- pattern OutboundConnectionStatusCode_VALIDATING :: OutboundConnectionStatusCode
- pattern OutboundConnectionStatusCode_VALIDATION_FAILED :: OutboundConnectionStatusCode
- newtype PackageStatus where
- PackageStatus' { }
- pattern PackageStatus_AVAILABLE :: PackageStatus
- pattern PackageStatus_COPYING :: PackageStatus
- pattern PackageStatus_COPY_FAILED :: PackageStatus
- pattern PackageStatus_DELETED :: PackageStatus
- pattern PackageStatus_DELETE_FAILED :: PackageStatus
- pattern PackageStatus_DELETING :: PackageStatus
- pattern PackageStatus_VALIDATING :: PackageStatus
- pattern PackageStatus_VALIDATION_FAILED :: PackageStatus
- newtype PackageType where
- PackageType' { }
- pattern PackageType_TXT_DICTIONARY :: PackageType
- newtype ReservedInstancePaymentOption where
- newtype RollbackOnDisable where
- newtype ScheduledAutoTuneActionType where
- newtype ScheduledAutoTuneSeverityType where
- newtype TLSSecurityPolicy where
- newtype TimeUnit where
- TimeUnit' {
- fromTimeUnit :: Text
- pattern TimeUnit_HOURS :: TimeUnit
- TimeUnit' {
- newtype UpgradeStatus where
- UpgradeStatus' { }
- pattern UpgradeStatus_FAILED :: UpgradeStatus
- pattern UpgradeStatus_IN_PROGRESS :: UpgradeStatus
- pattern UpgradeStatus_SUCCEEDED :: UpgradeStatus
- pattern UpgradeStatus_SUCCEEDED_WITH_ISSUES :: UpgradeStatus
- newtype UpgradeStep where
- UpgradeStep' { }
- pattern UpgradeStep_PRE_UPGRADE_CHECK :: UpgradeStep
- pattern UpgradeStep_SNAPSHOT :: UpgradeStep
- pattern UpgradeStep_UPGRADE :: UpgradeStep
- newtype VolumeType where
- VolumeType' { }
- pattern VolumeType_Gp2 :: VolumeType
- pattern VolumeType_Io1 :: VolumeType
- pattern VolumeType_Standard :: VolumeType
- data AWSDomainInformation = AWSDomainInformation' (Maybe Text) (Maybe Text) Text
- newAWSDomainInformation :: Text -> AWSDomainInformation
- data AccessPoliciesStatus = AccessPoliciesStatus' Text OptionStatus
- newAccessPoliciesStatus :: Text -> OptionStatus -> AccessPoliciesStatus
- data AdditionalLimit = AdditionalLimit' (Maybe Text) (Maybe [Text])
- newAdditionalLimit :: AdditionalLimit
- data AdvancedOptionsStatus = AdvancedOptionsStatus' (HashMap Text Text) OptionStatus
- newAdvancedOptionsStatus :: OptionStatus -> AdvancedOptionsStatus
- data AdvancedSecurityOptions = AdvancedSecurityOptions' (Maybe Bool) (Maybe Bool) (Maybe SAMLOptionsOutput)
- newAdvancedSecurityOptions :: AdvancedSecurityOptions
- data AdvancedSecurityOptionsInput = AdvancedSecurityOptionsInput' (Maybe Bool) (Maybe Bool) (Maybe MasterUserOptions) (Maybe SAMLOptionsInput)
- newAdvancedSecurityOptionsInput :: AdvancedSecurityOptionsInput
- data AdvancedSecurityOptionsStatus = AdvancedSecurityOptionsStatus' AdvancedSecurityOptions OptionStatus
- newAdvancedSecurityOptionsStatus :: AdvancedSecurityOptions -> OptionStatus -> AdvancedSecurityOptionsStatus
- data AutoTune = AutoTune' (Maybe AutoTuneDetails) (Maybe AutoTuneType)
- newAutoTune :: AutoTune
- data AutoTuneDetails = AutoTuneDetails' (Maybe ScheduledAutoTuneDetails)
- newAutoTuneDetails :: AutoTuneDetails
- data AutoTuneMaintenanceSchedule = AutoTuneMaintenanceSchedule' (Maybe POSIX) (Maybe Text) (Maybe Duration)
- newAutoTuneMaintenanceSchedule :: AutoTuneMaintenanceSchedule
- data AutoTuneOptions = AutoTuneOptions' (Maybe AutoTuneDesiredState) (Maybe RollbackOnDisable) (Maybe [AutoTuneMaintenanceSchedule])
- newAutoTuneOptions :: AutoTuneOptions
- data AutoTuneOptionsInput = AutoTuneOptionsInput' (Maybe AutoTuneDesiredState) (Maybe [AutoTuneMaintenanceSchedule])
- newAutoTuneOptionsInput :: AutoTuneOptionsInput
- data AutoTuneOptionsOutput = AutoTuneOptionsOutput' (Maybe AutoTuneState) (Maybe Text)
- newAutoTuneOptionsOutput :: AutoTuneOptionsOutput
- data AutoTuneOptionsStatus = AutoTuneOptionsStatus' (Maybe AutoTuneStatus) (Maybe AutoTuneOptions)
- newAutoTuneOptionsStatus :: AutoTuneOptionsStatus
- data AutoTuneStatus = AutoTuneStatus' (Maybe Bool) (Maybe Text) (Maybe Natural) POSIX POSIX AutoTuneState
- newAutoTuneStatus :: UTCTime -> UTCTime -> AutoTuneState -> AutoTuneStatus
- data ClusterConfig = ClusterConfig' (Maybe Int) (Maybe OpenSearchPartitionInstanceType) (Maybe Bool) (Maybe Int) (Maybe ColdStorageOptions) (Maybe Bool) (Maybe OpenSearchPartitionInstanceType) (Maybe Bool) (Maybe ZoneAwarenessConfig) (Maybe Int) (Maybe OpenSearchWarmPartitionInstanceType)
- newClusterConfig :: ClusterConfig
- data ClusterConfigStatus = ClusterConfigStatus' ClusterConfig OptionStatus
- newClusterConfigStatus :: ClusterConfig -> OptionStatus -> ClusterConfigStatus
- data CognitoOptions = CognitoOptions' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text)
- newCognitoOptions :: CognitoOptions
- data CognitoOptionsStatus = CognitoOptionsStatus' CognitoOptions OptionStatus
- newCognitoOptionsStatus :: CognitoOptions -> OptionStatus -> CognitoOptionsStatus
- data ColdStorageOptions = ColdStorageOptions' Bool
- newColdStorageOptions :: Bool -> ColdStorageOptions
- data CompatibleVersionsMap = CompatibleVersionsMap' (Maybe Text) (Maybe [Text])
- newCompatibleVersionsMap :: CompatibleVersionsMap
- data DescribePackagesFilter = DescribePackagesFilter' (Maybe [Text]) (Maybe DescribePackagesFilterName)
- newDescribePackagesFilter :: DescribePackagesFilter
- data DomainConfig = DomainConfig' (Maybe EBSOptionsStatus) (Maybe VersionStatus) (Maybe NodeToNodeEncryptionOptionsStatus) (Maybe AccessPoliciesStatus) (Maybe AutoTuneOptionsStatus) (Maybe LogPublishingOptionsStatus) (Maybe ClusterConfigStatus) (Maybe AdvancedSecurityOptionsStatus) (Maybe SnapshotOptionsStatus) (Maybe CognitoOptionsStatus) (Maybe EncryptionAtRestOptionsStatus) (Maybe VPCDerivedInfoStatus) (Maybe DomainEndpointOptionsStatus) (Maybe AdvancedOptionsStatus)
- newDomainConfig :: DomainConfig
- data DomainEndpointOptions = DomainEndpointOptions' (Maybe Bool) (Maybe TLSSecurityPolicy) (Maybe Bool) (Maybe Text) (Maybe Text)
- newDomainEndpointOptions :: DomainEndpointOptions
- data DomainEndpointOptionsStatus = DomainEndpointOptionsStatus' DomainEndpointOptions OptionStatus
- newDomainEndpointOptionsStatus :: DomainEndpointOptions -> OptionStatus -> DomainEndpointOptionsStatus
- data DomainInfo = DomainInfo' (Maybe Text) (Maybe EngineType)
- newDomainInfo :: DomainInfo
- data DomainInformationContainer = DomainInformationContainer' (Maybe AWSDomainInformation)
- newDomainInformationContainer :: DomainInformationContainer
- data DomainPackageDetails = DomainPackageDetails' (Maybe POSIX) (Maybe Text) (Maybe PackageType) (Maybe Text) (Maybe Text) (Maybe DomainPackageStatus) (Maybe Text) (Maybe ErrorDetails) (Maybe Text)
- newDomainPackageDetails :: DomainPackageDetails
- data DomainStatus = DomainStatus' (Maybe EBSOptions) (Maybe Text) (Maybe NodeToNodeEncryptionOptions) (Maybe Text) (Maybe ServiceSoftwareOptions) (Maybe AutoTuneOptionsOutput) (Maybe (HashMap LogType LogPublishingOption)) (Maybe AdvancedSecurityOptions) (Maybe Bool) (Maybe SnapshotOptions) (Maybe CognitoOptions) (Maybe EncryptionAtRestOptions) (Maybe Bool) (Maybe VPCDerivedInfo) (Maybe (HashMap Text Text)) (Maybe DomainEndpointOptions) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe (HashMap Text Text)) Text Text Text ClusterConfig
- newDomainStatus :: Text -> Text -> Text -> ClusterConfig -> DomainStatus
- data Duration = Duration' (Maybe Natural) (Maybe TimeUnit)
- newDuration :: Duration
- data EBSOptions = EBSOptions' (Maybe Int) (Maybe Int) (Maybe VolumeType) (Maybe Bool)
- newEBSOptions :: EBSOptions
- data EBSOptionsStatus = EBSOptionsStatus' EBSOptions OptionStatus
- newEBSOptionsStatus :: EBSOptions -> OptionStatus -> EBSOptionsStatus
- data EncryptionAtRestOptions = EncryptionAtRestOptions' (Maybe Bool) (Maybe Text)
- newEncryptionAtRestOptions :: EncryptionAtRestOptions
- data EncryptionAtRestOptionsStatus = EncryptionAtRestOptionsStatus' EncryptionAtRestOptions OptionStatus
- newEncryptionAtRestOptionsStatus :: EncryptionAtRestOptions -> OptionStatus -> EncryptionAtRestOptionsStatus
- data ErrorDetails = ErrorDetails' (Maybe Text) (Maybe Text)
- newErrorDetails :: ErrorDetails
- data Filter = Filter' (Maybe (NonEmpty Text)) (Maybe Text)
- newFilter :: Filter
- data InboundConnection = InboundConnection' (Maybe DomainInformationContainer) (Maybe DomainInformationContainer) (Maybe Text) (Maybe InboundConnectionStatus)
- newInboundConnection :: InboundConnection
- data InboundConnectionStatus = InboundConnectionStatus' (Maybe Text) (Maybe InboundConnectionStatusCode)
- newInboundConnectionStatus :: InboundConnectionStatus
- data InstanceCountLimits = InstanceCountLimits' (Maybe Int) (Maybe Int)
- newInstanceCountLimits :: InstanceCountLimits
- data InstanceLimits = InstanceLimits' (Maybe InstanceCountLimits)
- newInstanceLimits :: InstanceLimits
- data InstanceTypeDetails = InstanceTypeDetails' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe OpenSearchPartitionInstanceType) (Maybe Bool) (Maybe Bool) (Maybe Bool)
- newInstanceTypeDetails :: InstanceTypeDetails
- data Limits = Limits' (Maybe InstanceLimits) (Maybe [AdditionalLimit]) (Maybe [StorageType])
- newLimits :: Limits
- data LogPublishingOption = LogPublishingOption' (Maybe Bool) (Maybe Text)
- newLogPublishingOption :: LogPublishingOption
- data LogPublishingOptionsStatus = LogPublishingOptionsStatus' (Maybe OptionStatus) (Maybe (HashMap LogType LogPublishingOption))
- newLogPublishingOptionsStatus :: LogPublishingOptionsStatus
- data MasterUserOptions = MasterUserOptions' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text)
- newMasterUserOptions :: MasterUserOptions
- data NodeToNodeEncryptionOptions = NodeToNodeEncryptionOptions' (Maybe Bool)
- newNodeToNodeEncryptionOptions :: NodeToNodeEncryptionOptions
- data NodeToNodeEncryptionOptionsStatus = NodeToNodeEncryptionOptionsStatus' NodeToNodeEncryptionOptions OptionStatus
- newNodeToNodeEncryptionOptionsStatus :: NodeToNodeEncryptionOptions -> OptionStatus -> NodeToNodeEncryptionOptionsStatus
- data OptionStatus = OptionStatus' (Maybe Bool) (Maybe Natural) POSIX POSIX OptionState
- newOptionStatus :: UTCTime -> UTCTime -> OptionState -> OptionStatus
- data OutboundConnection = OutboundConnection' (Maybe DomainInformationContainer) (Maybe Text) (Maybe DomainInformationContainer) (Maybe Text) (Maybe OutboundConnectionStatus)
- newOutboundConnection :: OutboundConnection
- data OutboundConnectionStatus = OutboundConnectionStatus' (Maybe Text) (Maybe OutboundConnectionStatusCode)
- newOutboundConnectionStatus :: OutboundConnectionStatus
- data PackageDetails = PackageDetails' (Maybe Text) (Maybe PackageType) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe PackageStatus) (Maybe Text) (Maybe ErrorDetails) (Maybe Text)
- newPackageDetails :: PackageDetails
- data PackageSource = PackageSource' (Maybe Text) (Maybe Text)
- newPackageSource :: PackageSource
- data PackageVersionHistory = PackageVersionHistory' (Maybe POSIX) (Maybe Text) (Maybe Text)
- newPackageVersionHistory :: PackageVersionHistory
- data RecurringCharge = RecurringCharge' (Maybe Text) (Maybe Double)
- newRecurringCharge :: RecurringCharge
- data ReservedInstance = ReservedInstance' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe POSIX) (Maybe OpenSearchPartitionInstanceType) (Maybe Text) (Maybe Integer) (Maybe [RecurringCharge]) (Maybe Double) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Int) (Maybe ReservedInstancePaymentOption)
- newReservedInstance :: ReservedInstance
- data ReservedInstanceOffering = ReservedInstanceOffering' (Maybe Text) (Maybe OpenSearchPartitionInstanceType) (Maybe [RecurringCharge]) (Maybe Double) (Maybe Text) (Maybe Double) (Maybe Int) (Maybe ReservedInstancePaymentOption)
- newReservedInstanceOffering :: ReservedInstanceOffering
- data SAMLIdp = SAMLIdp' Text Text
- newSAMLIdp :: Text -> Text -> SAMLIdp
- data SAMLOptionsInput = SAMLOptionsInput' (Maybe (Sensitive Text)) (Maybe Bool) (Maybe SAMLIdp) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text)
- newSAMLOptionsInput :: SAMLOptionsInput
- data SAMLOptionsOutput = SAMLOptionsOutput' (Maybe Bool) (Maybe SAMLIdp) (Maybe Text) (Maybe Int) (Maybe Text)
- newSAMLOptionsOutput :: SAMLOptionsOutput
- data ScheduledAutoTuneDetails = ScheduledAutoTuneDetails' (Maybe ScheduledAutoTuneSeverityType) (Maybe Text) (Maybe POSIX) (Maybe ScheduledAutoTuneActionType)
- newScheduledAutoTuneDetails :: ScheduledAutoTuneDetails
- data ServiceSoftwareOptions = ServiceSoftwareOptions' (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe DeploymentStatus) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text)
- newServiceSoftwareOptions :: ServiceSoftwareOptions
- data SnapshotOptions = SnapshotOptions' (Maybe Int)
- newSnapshotOptions :: SnapshotOptions
- data SnapshotOptionsStatus = SnapshotOptionsStatus' SnapshotOptions OptionStatus
- newSnapshotOptionsStatus :: SnapshotOptions -> OptionStatus -> SnapshotOptionsStatus
- data StorageType = StorageType' (Maybe [StorageTypeLimit]) (Maybe Text) (Maybe Text)
- newStorageType :: StorageType
- data StorageTypeLimit = StorageTypeLimit' (Maybe Text) (Maybe [Text])
- newStorageTypeLimit :: StorageTypeLimit
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data UpgradeHistory = UpgradeHistory' (Maybe UpgradeStatus) (Maybe [UpgradeStepItem]) (Maybe Text) (Maybe POSIX)
- newUpgradeHistory :: UpgradeHistory
- data UpgradeStepItem = UpgradeStepItem' (Maybe UpgradeStatus) (Maybe Double) (Maybe [Text]) (Maybe UpgradeStep)
- newUpgradeStepItem :: UpgradeStepItem
- data VPCDerivedInfo = VPCDerivedInfo' (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe [Text])
- newVPCDerivedInfo :: VPCDerivedInfo
- data VPCDerivedInfoStatus = VPCDerivedInfoStatus' VPCDerivedInfo OptionStatus
- newVPCDerivedInfoStatus :: VPCDerivedInfo -> OptionStatus -> VPCDerivedInfoStatus
- data VPCOptions = VPCOptions' (Maybe [Text]) (Maybe [Text])
- newVPCOptions :: VPCOptions
- data VersionStatus = VersionStatus' Text OptionStatus
- newVersionStatus :: Text -> OptionStatus -> VersionStatus
- data ZoneAwarenessConfig = ZoneAwarenessConfig' (Maybe Int)
- newZoneAwarenessConfig :: ZoneAwarenessConfig
Service Configuration
defaultService :: Service Source #
API version 2021-01-01 of the Amazon OpenSearch Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by OpenSearch.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception for missing / invalid input fields. Gives http status code of 400.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception for creating a resource that already exists. Gives http status code of 400.
ConflictException
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
BaseException
_BaseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred while processing the request.
DisabledOperationException
_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
_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
_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
_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.
InvalidPaginationTokenException
_InvalidPaginationTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
LimitExceededException
_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.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
RejectInboundConnection
data RejectInboundConnection Source #
Container for the parameters to the RejectInboundConnection
operation.
See: newRejectInboundConnection smart constructor.
Constructors
| RejectInboundConnection' Text |
Instances
newRejectInboundConnection Source #
Create a value of RejectInboundConnection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connectionId:RejectInboundConnection', rejectInboundConnection_connectionId - The ID of the inbound connection to reject.
data RejectInboundConnectionResponse Source #
The result of a RejectInboundConnection operation. Contains details
about the rejected inbound connection.
See: newRejectInboundConnectionResponse smart constructor.
Constructors
| RejectInboundConnectionResponse' (Maybe InboundConnection) Int |
Instances
newRejectInboundConnectionResponse Source #
Create a value of RejectInboundConnectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connection:RejectInboundConnectionResponse', rejectInboundConnectionResponse_connection - The InboundConnection of the rejected inbound connection.
$sel:httpStatus:RejectInboundConnectionResponse', rejectInboundConnectionResponse_httpStatus - The response's http status code.
DescribeOutboundConnections
data DescribeOutboundConnections Source #
Container for the parameters to the DescribeOutboundConnections
operation.
See: newDescribeOutboundConnections smart constructor.
Instances
newDescribeOutboundConnections :: DescribeOutboundConnections Source #
Create a value of DescribeOutboundConnections with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeOutboundConnections', describeOutboundConnections_filters - 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
$sel:nextToken:DescribeOutboundConnections', describeOutboundConnections_nextToken - NextToken is sent in case the earlier API call results contain the
NextToken parameter. Used for pagination.
$sel:maxResults:DescribeOutboundConnections', describeOutboundConnections_maxResults - Set this value to limit the number of results returned. If not
specified, defaults to 100.
data DescribeOutboundConnectionsResponse Source #
The result of a DescribeOutboundConnections request. Contains the
list of connections matching the filter criteria.
See: newDescribeOutboundConnectionsResponse smart constructor.
Constructors
| DescribeOutboundConnectionsResponse' (Maybe [OutboundConnection]) (Maybe Text) Int |
Instances
newDescribeOutboundConnectionsResponse Source #
Arguments
| :: Int | |
| -> DescribeOutboundConnectionsResponse |
Create a value of DescribeOutboundConnectionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connections:DescribeOutboundConnectionsResponse', describeOutboundConnectionsResponse_connections - A list of OutboundConnection matching the specified filter criteria.
$sel:nextToken:DescribeOutboundConnections', describeOutboundConnectionsResponse_nextToken - 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.
$sel:httpStatus:DescribeOutboundConnectionsResponse', describeOutboundConnectionsResponse_httpStatus - The response's http status code.
RemoveTags
data RemoveTags Source #
Container for the parameters to the RemoveTags operation. Specify
the ARN for the domain from which you want to remove the specified
TagKey.
See: newRemoveTags smart constructor.
Constructors
| RemoveTags' Text [Text] |
Instances
Arguments
| :: Text | |
| -> RemoveTags |
Create a value of RemoveTags with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:RemoveTags', removeTags_arn - The ARN of the domain from which you want to delete the specified
tags.
$sel:tagKeys:RemoveTags', removeTags_tagKeys - The TagKey list you want to remove from the domain.
data RemoveTagsResponse Source #
See: newRemoveTagsResponse smart constructor.
Constructors
| RemoveTagsResponse' | |
Instances
| Eq RemoveTagsResponse Source # | |
Defined in Amazonka.OpenSearch.RemoveTags Methods (==) :: RemoveTagsResponse -> RemoveTagsResponse -> Bool # (/=) :: RemoveTagsResponse -> RemoveTagsResponse -> Bool # | |
| Read RemoveTagsResponse Source # | |
Defined in Amazonka.OpenSearch.RemoveTags Methods readsPrec :: Int -> ReadS RemoveTagsResponse # readList :: ReadS [RemoveTagsResponse] # | |
| Show RemoveTagsResponse Source # | |
Defined in Amazonka.OpenSearch.RemoveTags Methods showsPrec :: Int -> RemoveTagsResponse -> ShowS # show :: RemoveTagsResponse -> String # showList :: [RemoveTagsResponse] -> ShowS # | |
| Generic RemoveTagsResponse Source # | |
Defined in Amazonka.OpenSearch.RemoveTags Associated Types type Rep RemoveTagsResponse :: Type -> Type # Methods from :: RemoveTagsResponse -> Rep RemoveTagsResponse x # to :: Rep RemoveTagsResponse x -> RemoveTagsResponse # | |
| NFData RemoveTagsResponse Source # | |
Defined in Amazonka.OpenSearch.RemoveTags Methods rnf :: RemoveTagsResponse -> () # | |
| type Rep RemoveTagsResponse Source # | |
newRemoveTagsResponse :: RemoveTagsResponse Source #
Create a value of RemoveTagsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeInstanceTypeLimits
data DescribeInstanceTypeLimits Source #
Container for the parameters to the DescribeInstanceTypeLimits
operation.
See: newDescribeInstanceTypeLimits smart constructor.
Constructors
| DescribeInstanceTypeLimits' (Maybe Text) OpenSearchPartitionInstanceType Text |
Instances
newDescribeInstanceTypeLimits Source #
Arguments
| :: OpenSearchPartitionInstanceType | |
| -> Text | |
| -> DescribeInstanceTypeLimits |
Create a value of DescribeInstanceTypeLimits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:DescribeInstanceTypeLimits', describeInstanceTypeLimits_domainName - The name of the domain you want to modify. Only include this value if
you're querying OpenSearch Limits for an existing domain.
$sel:instanceType:DescribeInstanceTypeLimits', describeInstanceTypeLimits_instanceType - The instance type for an OpenSearch cluster for which OpenSearch
Limits are needed.
$sel:engineVersion:DescribeInstanceTypeLimits', describeInstanceTypeLimits_engineVersion - Version of OpenSearch for which Limits are needed.
data DescribeInstanceTypeLimitsResponse Source #
Container for the parameters received from the
DescribeInstanceTypeLimits operation.
See: newDescribeInstanceTypeLimitsResponse smart constructor.
Instances
newDescribeInstanceTypeLimitsResponse Source #
Arguments
| :: Int | |
| -> DescribeInstanceTypeLimitsResponse |
Create a value of DescribeInstanceTypeLimitsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:limitsByRole:DescribeInstanceTypeLimitsResponse', describeInstanceTypeLimitsResponse_limitsByRole - Undocumented member.
$sel:httpStatus:DescribeInstanceTypeLimitsResponse', describeInstanceTypeLimitsResponse_httpStatus - The response's http status code.
DescribeInboundConnections
data DescribeInboundConnections Source #
Container for the parameters to the DescribeInboundConnections
operation.
See: newDescribeInboundConnections smart constructor.
Instances
newDescribeInboundConnections :: DescribeInboundConnections Source #
Create a value of DescribeInboundConnections with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeInboundConnections', describeInboundConnections_filters - 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
$sel:nextToken:DescribeInboundConnections', describeInboundConnections_nextToken - 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.
$sel:maxResults:DescribeInboundConnections', describeInboundConnections_maxResults - Set this value to limit the number of results returned. If not
specified, defaults to 100.
data DescribeInboundConnectionsResponse Source #
The result of a DescribeInboundConnections request. Contains a list
of connections matching the filter criteria.
See: newDescribeInboundConnectionsResponse smart constructor.
Constructors
| DescribeInboundConnectionsResponse' (Maybe [InboundConnection]) (Maybe Text) Int |
Instances
newDescribeInboundConnectionsResponse Source #
Arguments
| :: Int | |
| -> DescribeInboundConnectionsResponse |
Create a value of DescribeInboundConnectionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connections:DescribeInboundConnectionsResponse', describeInboundConnectionsResponse_connections - A list of InboundConnection matching the specified filter criteria.
$sel:nextToken:DescribeInboundConnections', describeInboundConnectionsResponse_nextToken - 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.
$sel:httpStatus:DescribeInboundConnectionsResponse', describeInboundConnectionsResponse_httpStatus - The response's http status code.
CancelServiceSoftwareUpdate
data CancelServiceSoftwareUpdate Source #
Container for the parameters to the CancelServiceSoftwareUpdate
operation. Specifies the name of the domain that you wish to cancel a
service software update on.
See: newCancelServiceSoftwareUpdate smart constructor.
Constructors
| CancelServiceSoftwareUpdate' Text |
Instances
newCancelServiceSoftwareUpdate Source #
Create a value of CancelServiceSoftwareUpdate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:CancelServiceSoftwareUpdate', cancelServiceSoftwareUpdate_domainName - The name of the domain that you want to stop the latest service software
update on.
data CancelServiceSoftwareUpdateResponse Source #
The result of a CancelServiceSoftwareUpdate operation. Contains the
status of the update.
See: newCancelServiceSoftwareUpdateResponse smart constructor.
Constructors
| CancelServiceSoftwareUpdateResponse' (Maybe ServiceSoftwareOptions) Int |
Instances
newCancelServiceSoftwareUpdateResponse Source #
Arguments
| :: Int | |
| -> CancelServiceSoftwareUpdateResponse |
Create a value of CancelServiceSoftwareUpdateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceSoftwareOptions:CancelServiceSoftwareUpdateResponse', cancelServiceSoftwareUpdateResponse_serviceSoftwareOptions - The current status of the OpenSearch service software update.
$sel:httpStatus:CancelServiceSoftwareUpdateResponse', cancelServiceSoftwareUpdateResponse_httpStatus - The response's http status code.
ListDomainsForPackage
data ListDomainsForPackage Source #
Container for the request parameters to the ListDomainsForPackage
operation.
See: newListDomainsForPackage smart constructor.
Instances
newListDomainsForPackage Source #
Create a value of ListDomainsForPackage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDomainsForPackage', listDomainsForPackage_nextToken - Used for pagination. Only necessary if a previous API call includes a
non-null NextToken value. If provided, returns results for the next
page.
$sel:maxResults:ListDomainsForPackage', listDomainsForPackage_maxResults - Limits the results to a maximum number of domains.
$sel:packageID:ListDomainsForPackage', listDomainsForPackage_packageID - The package for which to list associated domains.
data ListDomainsForPackageResponse Source #
Container for the response parameters to the ListDomainsForPackage
operation.
See: newListDomainsForPackageResponse smart constructor.
Constructors
| ListDomainsForPackageResponse' (Maybe [DomainPackageDetails]) (Maybe Text) Int |
Instances
newListDomainsForPackageResponse Source #
Create a value of ListDomainsForPackageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainPackageDetailsList:ListDomainsForPackageResponse', listDomainsForPackageResponse_domainPackageDetailsList - List of DomainPackageDetails objects.
$sel:nextToken:ListDomainsForPackage', listDomainsForPackageResponse_nextToken - Undocumented member.
$sel:httpStatus:ListDomainsForPackageResponse', listDomainsForPackageResponse_httpStatus - The response's http status code.
ListPackagesForDomain
data ListPackagesForDomain Source #
Container for the request parameters to the ListPackagesForDomain
operation.
See: newListPackagesForDomain smart constructor.
Instances
newListPackagesForDomain Source #
Create a value of ListPackagesForDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListPackagesForDomain', listPackagesForDomain_nextToken - Used for pagination. Only necessary if a previous API call includes a
non-null NextToken value. If provided, returns results for the next
page.
$sel:maxResults:ListPackagesForDomain', listPackagesForDomain_maxResults - Limits results to a maximum number of packages.
$sel:domainName:ListPackagesForDomain', listPackagesForDomain_domainName - The name of the domain for which you want to list associated packages.
data ListPackagesForDomainResponse Source #
Container for the response parameters to the ListPackagesForDomain
operation.
See: newListPackagesForDomainResponse smart constructor.
Constructors
| ListPackagesForDomainResponse' (Maybe [DomainPackageDetails]) (Maybe Text) Int |
Instances
newListPackagesForDomainResponse Source #
Create a value of ListPackagesForDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainPackageDetailsList:ListPackagesForDomainResponse', listPackagesForDomainResponse_domainPackageDetailsList - List of DomainPackageDetails objects.
$sel:nextToken:ListPackagesForDomain', listPackagesForDomainResponse_nextToken - Pagination token to supply to the next call to get the next page of
results.
$sel:httpStatus:ListPackagesForDomainResponse', listPackagesForDomainResponse_httpStatus - The response's http status code.
UpgradeDomain
data UpgradeDomain Source #
Container for the request parameters to UpgradeDomain operation.
See: newUpgradeDomain smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpgradeDomain |
Create a value of UpgradeDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:performCheckOnly:UpgradeDomain', upgradeDomain_performCheckOnly - When true, indicates that an upgrade eligibility check needs to be
performed. Does not actually perform the upgrade.
$sel:advancedOptions:UpgradeDomain', upgradeDomain_advancedOptions - Undocumented member.
$sel:domainName:UpgradeDomain', upgradeDomain_domainName - Undocumented member.
$sel:targetVersion:UpgradeDomain', upgradeDomain_targetVersion - The version of OpenSearch you intend to upgrade the domain to.
data UpgradeDomainResponse Source #
Container for response returned by UpgradeDomain operation.
See: newUpgradeDomainResponse smart constructor.
Constructors
| UpgradeDomainResponse' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newUpgradeDomainResponse Source #
Create a value of UpgradeDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:UpgradeDomain', upgradeDomainResponse_domainName - Undocumented member.
$sel:upgradeId:UpgradeDomainResponse', upgradeDomainResponse_upgradeId - Undocumented member.
$sel:performCheckOnly:UpgradeDomain', upgradeDomainResponse_performCheckOnly - When true, indicates that an upgrade eligibility check needs to be
performed. Does not actually perform the upgrade.
$sel:targetVersion:UpgradeDomain', upgradeDomainResponse_targetVersion - The version of OpenSearch that you intend to upgrade the domain to.
$sel:advancedOptions:UpgradeDomain', upgradeDomainResponse_advancedOptions - Undocumented member.
$sel:httpStatus:UpgradeDomainResponse', upgradeDomainResponse_httpStatus - The response's http status code.
DescribeDomainAutoTunes
data DescribeDomainAutoTunes Source #
Container for the parameters to the DescribeDomainAutoTunes operation.
See: newDescribeDomainAutoTunes smart constructor.
Instances
newDescribeDomainAutoTunes Source #
Create a value of DescribeDomainAutoTunes with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeDomainAutoTunes', describeDomainAutoTunes_nextToken - NextToken is sent in case the earlier API call results contain the
NextToken. Used for pagination.
$sel:maxResults:DescribeDomainAutoTunes', describeDomainAutoTunes_maxResults - Set this value to limit the number of results returned. If not
specified, defaults to 100.
$sel:domainName:DescribeDomainAutoTunes', describeDomainAutoTunes_domainName - The domain name for which you want Auto-Tune action details.
data DescribeDomainAutoTunesResponse Source #
The result of a DescribeDomainAutoTunes request. See
Auto-Tune for Amazon OpenSearch Service
for more information.
See: newDescribeDomainAutoTunesResponse smart constructor.
Instances
newDescribeDomainAutoTunesResponse Source #
Create a value of DescribeDomainAutoTunesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeDomainAutoTunes', describeDomainAutoTunesResponse_nextToken - An identifier to allow retrieval of paginated results.
$sel:autoTunes:DescribeDomainAutoTunesResponse', describeDomainAutoTunesResponse_autoTunes - The list of setting adjustments that Auto-Tune has made to the domain.
See
Auto-Tune for Amazon OpenSearch Service
for more information.
$sel:httpStatus:DescribeDomainAutoTunesResponse', describeDomainAutoTunesResponse_httpStatus - The response's http status code.
DescribeReservedInstances
data DescribeReservedInstances Source #
Container for parameters to DescribeReservedInstances
See: newDescribeReservedInstances smart constructor.
Instances
newDescribeReservedInstances :: DescribeReservedInstances Source #
Create a value of DescribeReservedInstances with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeReservedInstances', describeReservedInstances_nextToken - Provides an identifier to allow retrieval of paginated results.
$sel:reservedInstanceId:DescribeReservedInstances', describeReservedInstances_reservedInstanceId - The reserved instance identifier filter value. Use this parameter to
show only the reservation that matches the specified reserved OpenSearch
instance ID.
$sel:maxResults:DescribeReservedInstances', describeReservedInstances_maxResults - Set this value to limit the number of results returned. If not
specified, defaults to 100.
data DescribeReservedInstancesResponse Source #
Container for results from DescribeReservedInstances
See: newDescribeReservedInstancesResponse smart constructor.
Constructors
| DescribeReservedInstancesResponse' (Maybe Text) (Maybe [ReservedInstance]) Int |
Instances
newDescribeReservedInstancesResponse Source #
Arguments
| :: Int | |
| -> DescribeReservedInstancesResponse |
Create a value of DescribeReservedInstancesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeReservedInstances', describeReservedInstancesResponse_nextToken - Provides an identifier to allow retrieval of paginated results.
$sel:reservedInstances:DescribeReservedInstancesResponse', describeReservedInstancesResponse_reservedInstances - List of reserved OpenSearch instances.
$sel:httpStatus:DescribeReservedInstancesResponse', describeReservedInstancesResponse_httpStatus - The response's http status code.
StartServiceSoftwareUpdate
data StartServiceSoftwareUpdate Source #
Container for the parameters to the StartServiceSoftwareUpdate
operation. Specifies the name of the domain to schedule a service
software update for.
See: newStartServiceSoftwareUpdate smart constructor.
Constructors
| StartServiceSoftwareUpdate' Text |
Instances
newStartServiceSoftwareUpdate Source #
Create a value of StartServiceSoftwareUpdate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:StartServiceSoftwareUpdate', startServiceSoftwareUpdate_domainName - The name of the domain that you want to update to the latest service
software.
data StartServiceSoftwareUpdateResponse Source #
The result of a StartServiceSoftwareUpdate operation. Contains the
status of the update.
See: newStartServiceSoftwareUpdateResponse smart constructor.
Constructors
| StartServiceSoftwareUpdateResponse' (Maybe ServiceSoftwareOptions) Int |
Instances
newStartServiceSoftwareUpdateResponse Source #
Arguments
| :: Int | |
| -> StartServiceSoftwareUpdateResponse |
Create a value of StartServiceSoftwareUpdateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceSoftwareOptions:StartServiceSoftwareUpdateResponse', startServiceSoftwareUpdateResponse_serviceSoftwareOptions - The current status of the OpenSearch service software update.
$sel:httpStatus:StartServiceSoftwareUpdateResponse', startServiceSoftwareUpdateResponse_httpStatus - The response's http status code.
DeleteOutboundConnection
data DeleteOutboundConnection Source #
Container for the parameters to the DeleteOutboundConnection
operation.
See: newDeleteOutboundConnection smart constructor.
Constructors
| DeleteOutboundConnection' Text |
Instances
newDeleteOutboundConnection Source #
Create a value of DeleteOutboundConnection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connectionId:DeleteOutboundConnection', deleteOutboundConnection_connectionId - The ID of the outbound connection you want to permanently delete.
data DeleteOutboundConnectionResponse Source #
The result of a DeleteOutboundConnection operation. Contains details
about the deleted outbound connection.
See: newDeleteOutboundConnectionResponse smart constructor.
Constructors
| DeleteOutboundConnectionResponse' (Maybe OutboundConnection) Int |
Instances
newDeleteOutboundConnectionResponse Source #
Create a value of DeleteOutboundConnectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connection:DeleteOutboundConnectionResponse', deleteOutboundConnectionResponse_connection - The OutboundConnection of the deleted outbound connection.
$sel:httpStatus:DeleteOutboundConnectionResponse', deleteOutboundConnectionResponse_httpStatus - The response's http status code.
ListVersions
data ListVersions Source #
Container for the parameters to the ListVersions operation.
Use MaxResults to control the maximum number of results to retrieve
in a single call.
Use NextToken in response to retrieve more results. If the received
response does not contain a NextToken, there are no more results to
retrieve.
See: newListVersions smart constructor.
Constructors
| ListVersions' (Maybe Text) (Maybe Int) |
Instances
newListVersions :: ListVersions Source #
Create a value of ListVersions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListVersions', listVersions_nextToken - Undocumented member.
$sel:maxResults:ListVersions', listVersions_maxResults - Set this value to limit the number of results returned. Value must be
greater than 10 or it won't be honored.
data ListVersionsResponse Source #
Container for the parameters for response received from the
ListVersions operation.
See: newListVersionsResponse smart constructor.
Instances
newListVersionsResponse Source #
Arguments
| :: Int | |
| -> ListVersionsResponse |
Create a value of ListVersionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:versions:ListVersionsResponse', listVersionsResponse_versions - Undocumented member.
$sel:nextToken:ListVersions', listVersionsResponse_nextToken - Undocumented member.
$sel:httpStatus:ListVersionsResponse', listVersionsResponse_httpStatus - The response's http status code.
DescribeReservedInstanceOfferings
data DescribeReservedInstanceOfferings Source #
Container for parameters to DescribeReservedInstanceOfferings
See: newDescribeReservedInstanceOfferings smart constructor.
Instances
newDescribeReservedInstanceOfferings :: DescribeReservedInstanceOfferings Source #
Create a value of DescribeReservedInstanceOfferings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeReservedInstanceOfferings', describeReservedInstanceOfferings_nextToken - Provides an identifier to allow retrieval of paginated results.
$sel:reservedInstanceOfferingId:DescribeReservedInstanceOfferings', describeReservedInstanceOfferings_reservedInstanceOfferingId - The offering identifier filter value. Use this parameter to show only
the available offering that matches the specified reservation
identifier.
$sel:maxResults:DescribeReservedInstanceOfferings', describeReservedInstanceOfferings_maxResults - Set this value to limit the number of results returned. If not
specified, defaults to 100.
data DescribeReservedInstanceOfferingsResponse Source #
Container for results from DescribeReservedInstanceOfferings
See: newDescribeReservedInstanceOfferingsResponse smart constructor.
Constructors
| DescribeReservedInstanceOfferingsResponse' (Maybe Text) (Maybe [ReservedInstanceOffering]) Int |
Instances
newDescribeReservedInstanceOfferingsResponse Source #
Arguments
| :: Int | |
| -> DescribeReservedInstanceOfferingsResponse |
Create a value of DescribeReservedInstanceOfferingsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:DescribeReservedInstanceOfferings', describeReservedInstanceOfferingsResponse_nextToken - Provides an identifier to allow retrieval of paginated results.
$sel:reservedInstanceOfferings:DescribeReservedInstanceOfferingsResponse', describeReservedInstanceOfferingsResponse_reservedInstanceOfferings - List of reserved OpenSearch instance offerings
$sel:httpStatus:DescribeReservedInstanceOfferingsResponse', describeReservedInstanceOfferingsResponse_httpStatus - The response's http status code.
ListDomainNames
data ListDomainNames Source #
Container for the parameters to the ListDomainNames operation.
See: newListDomainNames smart constructor.
Constructors
| ListDomainNames' (Maybe EngineType) |
Instances
newListDomainNames :: ListDomainNames Source #
Create a value of ListDomainNames with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:engineType:ListDomainNames', listDomainNames_engineType - Optional parameter to filter the output by domain engine type.
Acceptable values are 'Elasticsearch' and 'OpenSearch'.
data ListDomainNamesResponse Source #
The result of a ListDomainNames operation. Contains the names of all
domains owned by this account and their respective engine types.
See: newListDomainNamesResponse smart constructor.
Constructors
| ListDomainNamesResponse' (Maybe [DomainInfo]) Int |
Instances
newListDomainNamesResponse Source #
Create a value of ListDomainNamesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainNames:ListDomainNamesResponse', listDomainNamesResponse_domainNames - List of domain names and respective engine types.
$sel:httpStatus:ListDomainNamesResponse', listDomainNamesResponse_httpStatus - The response's http status code.
PurchaseReservedInstanceOffering
data PurchaseReservedInstanceOffering Source #
Container for parameters to PurchaseReservedInstanceOffering
See: newPurchaseReservedInstanceOffering smart constructor.
Constructors
| PurchaseReservedInstanceOffering' (Maybe Natural) Text Text |
Instances
newPurchaseReservedInstanceOffering Source #
Arguments
| :: Text |
|
| -> Text | |
| -> PurchaseReservedInstanceOffering |
Create a value of PurchaseReservedInstanceOffering with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceCount:PurchaseReservedInstanceOffering', purchaseReservedInstanceOffering_instanceCount - The number of OpenSearch instances to reserve.
$sel:reservedInstanceOfferingId:PurchaseReservedInstanceOffering', purchaseReservedInstanceOffering_reservedInstanceOfferingId - The ID of the reserved OpenSearch instance offering to purchase.
$sel:reservationName:PurchaseReservedInstanceOffering', purchaseReservedInstanceOffering_reservationName - A customer-specified identifier to track this reservation.
data PurchaseReservedInstanceOfferingResponse Source #
Represents the output of a PurchaseReservedInstanceOffering operation.
See: newPurchaseReservedInstanceOfferingResponse smart constructor.
Instances
newPurchaseReservedInstanceOfferingResponse Source #
Arguments
| :: Int | |
| -> PurchaseReservedInstanceOfferingResponse |
Create a value of PurchaseReservedInstanceOfferingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reservationName:PurchaseReservedInstanceOffering', purchaseReservedInstanceOfferingResponse_reservationName - The customer-specified identifier used to track this reservation.
$sel:reservedInstanceId:PurchaseReservedInstanceOfferingResponse', purchaseReservedInstanceOfferingResponse_reservedInstanceId - Details of the reserved OpenSearch instance which was purchased.
$sel:httpStatus:PurchaseReservedInstanceOfferingResponse', purchaseReservedInstanceOfferingResponse_httpStatus - The response's http status code.
DescribeDomains
data DescribeDomains Source #
Container for the parameters to the DescribeDomains operation. By
default, the API returns the status of all domains.
See: newDescribeDomains smart constructor.
Constructors
| DescribeDomains' [Text] |
Instances
newDescribeDomains :: DescribeDomains Source #
Create a value of DescribeDomains with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainNames:DescribeDomains', describeDomains_domainNames - The domains for which you want information.
data DescribeDomainsResponse Source #
The result of a DescribeDomains request. Contains the status of the
specified domains or all domains owned by the account.
See: newDescribeDomainsResponse smart constructor.
Constructors
| DescribeDomainsResponse' Int [DomainStatus] |
Instances
newDescribeDomainsResponse Source #
Create a value of DescribeDomainsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeDomainsResponse', describeDomainsResponse_httpStatus - The response's http status code.
$sel:domainStatusList:DescribeDomainsResponse', describeDomainsResponse_domainStatusList - The status of the domains requested in the DescribeDomains request.
AssociatePackage
data AssociatePackage Source #
Container for the request parameters to the AssociatePackage
operation.
See: newAssociatePackage smart constructor.
Constructors
| AssociatePackage' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AssociatePackage |
Create a value of AssociatePackage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:packageID:AssociatePackage', associatePackage_packageID - Internal ID of the package to associate with a domain. Use
DescribePackages to find this value.
$sel:domainName:AssociatePackage', associatePackage_domainName - The name of the domain to associate the package with.
data AssociatePackageResponse Source #
Container for the response returned by AssociatePackage operation.
See: newAssociatePackageResponse smart constructor.
Constructors
| AssociatePackageResponse' (Maybe DomainPackageDetails) Int |
Instances
newAssociatePackageResponse Source #
Create a value of AssociatePackageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainPackageDetails:AssociatePackageResponse', associatePackageResponse_domainPackageDetails - DomainPackageDetails
$sel:httpStatus:AssociatePackageResponse', associatePackageResponse_httpStatus - The response's http status code.
ListInstanceTypeDetails
data ListInstanceTypeDetails Source #
See: newListInstanceTypeDetails smart constructor.
Instances
newListInstanceTypeDetails Source #
Create a value of ListInstanceTypeDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListInstanceTypeDetails', listInstanceTypeDetails_nextToken - Undocumented member.
$sel:domainName:ListInstanceTypeDetails', listInstanceTypeDetails_domainName - Undocumented member.
$sel:maxResults:ListInstanceTypeDetails', listInstanceTypeDetails_maxResults - Undocumented member.
$sel:engineVersion:ListInstanceTypeDetails', listInstanceTypeDetails_engineVersion - Undocumented member.
data ListInstanceTypeDetailsResponse Source #
See: newListInstanceTypeDetailsResponse smart constructor.
Constructors
| ListInstanceTypeDetailsResponse' (Maybe [InstanceTypeDetails]) (Maybe Text) Int |
Instances
newListInstanceTypeDetailsResponse Source #
Create a value of ListInstanceTypeDetailsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceTypeDetails:ListInstanceTypeDetailsResponse', listInstanceTypeDetailsResponse_instanceTypeDetails - Undocumented member.
$sel:nextToken:ListInstanceTypeDetails', listInstanceTypeDetailsResponse_nextToken - Undocumented member.
$sel:httpStatus:ListInstanceTypeDetailsResponse', listInstanceTypeDetailsResponse_httpStatus - The response's http status code.
GetPackageVersionHistory
data GetPackageVersionHistory Source #
Container for the request parameters to the GetPackageVersionHistory
operation.
See: newGetPackageVersionHistory smart constructor.
Instances
newGetPackageVersionHistory Source #
Create a value of GetPackageVersionHistory with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetPackageVersionHistory', getPackageVersionHistory_nextToken - Used for pagination. Only necessary if a previous API call includes a
non-null NextToken value. If provided, returns results for the next
page.
$sel:maxResults:GetPackageVersionHistory', getPackageVersionHistory_maxResults - Limits results to a maximum number of package versions.
$sel:packageID:GetPackageVersionHistory', getPackageVersionHistory_packageID - Returns an audit history of package versions.
data GetPackageVersionHistoryResponse Source #
Container for response returned by GetPackageVersionHistory
operation.
See: newGetPackageVersionHistoryResponse smart constructor.
Constructors
| GetPackageVersionHistoryResponse' (Maybe Text) (Maybe [PackageVersionHistory]) (Maybe Text) Int |
Instances
newGetPackageVersionHistoryResponse Source #
Create a value of GetPackageVersionHistoryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:packageID:GetPackageVersionHistory', getPackageVersionHistoryResponse_packageID - Undocumented member.
$sel:packageVersionHistoryList:GetPackageVersionHistoryResponse', getPackageVersionHistoryResponse_packageVersionHistoryList - List of PackageVersionHistory objects.
$sel:nextToken:GetPackageVersionHistory', getPackageVersionHistoryResponse_nextToken - Undocumented member.
$sel:httpStatus:GetPackageVersionHistoryResponse', getPackageVersionHistoryResponse_httpStatus - The response's http status code.
GetUpgradeHistory
data GetUpgradeHistory Source #
Container for the request parameters to the GetUpgradeHistory
operation.
See: newGetUpgradeHistory smart constructor.
Instances
Arguments
| :: Text | |
| -> GetUpgradeHistory |
Create a value of GetUpgradeHistory with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetUpgradeHistory', getUpgradeHistory_nextToken - Undocumented member.
$sel:maxResults:GetUpgradeHistory', getUpgradeHistory_maxResults - Undocumented member.
$sel:domainName:GetUpgradeHistory', getUpgradeHistory_domainName - Undocumented member.
data GetUpgradeHistoryResponse Source #
Container for the response returned by the GetUpgradeHistory
operation.
See: newGetUpgradeHistoryResponse smart constructor.
Constructors
| GetUpgradeHistoryResponse' (Maybe Text) (Maybe [UpgradeHistory]) Int |
Instances
newGetUpgradeHistoryResponse Source #
Create a value of GetUpgradeHistoryResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:GetUpgradeHistory', getUpgradeHistoryResponse_nextToken - Pagination token that needs to be supplied to the next call to get the
next page of results.
$sel:upgradeHistories:GetUpgradeHistoryResponse', getUpgradeHistoryResponse_upgradeHistories - A list of UpgradeHistory objects corresponding to each upgrade or
upgrade eligibility check performed on a domain returned as part of the
GetUpgradeHistoryResponse object.
$sel:httpStatus:GetUpgradeHistoryResponse', getUpgradeHistoryResponse_httpStatus - The response's http status code.
DescribePackages
data DescribePackages Source #
Container for the request parameters to the DescribePackage
operation.
See: newDescribePackages smart constructor.
Constructors
| DescribePackages' (Maybe [DescribePackagesFilter]) (Maybe Text) (Maybe Int) |
Instances
newDescribePackages :: DescribePackages Source #
Create a value of DescribePackages with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribePackages', describePackages_filters - Only returns packages that match the DescribePackagesFilterList
values.
$sel:nextToken:DescribePackages', describePackages_nextToken - Used for pagination. Only necessary if a previous API call includes a
non-null NextToken value. If provided, returns results for the next
page.
$sel:maxResults:DescribePackages', describePackages_maxResults - Limits results to a maximum number of packages.
data DescribePackagesResponse Source #
Container for the response returned by the DescribePackages
operation.
See: newDescribePackagesResponse smart constructor.
Constructors
| DescribePackagesResponse' (Maybe [PackageDetails]) (Maybe Text) Int |
Instances
newDescribePackagesResponse Source #
Create a value of DescribePackagesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:packageDetailsList:DescribePackagesResponse', describePackagesResponse_packageDetailsList - List of PackageDetails objects.
$sel:nextToken:DescribePackages', describePackagesResponse_nextToken - Undocumented member.
$sel:httpStatus:DescribePackagesResponse', describePackagesResponse_httpStatus - The response's http status code.
CreateDomain
data CreateDomain Source #
See: newCreateDomain smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> CreateDomain |
Create a value of CreateDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eBSOptions:CreateDomain', createDomain_eBSOptions - Options to enable, disable, and specify the type and size of EBS storage
volumes.
$sel:engineVersion:CreateDomain', createDomain_engineVersion - 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
.
$sel:nodeToNodeEncryptionOptions:CreateDomain', createDomain_nodeToNodeEncryptionOptions - Node-to-node encryption options.
$sel:accessPolicies:CreateDomain', createDomain_accessPolicies - IAM access policy as a JSON-formatted string.
$sel:autoTuneOptions:CreateDomain', createDomain_autoTuneOptions - Specifies Auto-Tune options.
$sel:logPublishingOptions:CreateDomain', createDomain_logPublishingOptions - Map of LogType and LogPublishingOption, each containing options to
publish a given type of OpenSearch log.
$sel:clusterConfig:CreateDomain', createDomain_clusterConfig - Configuration options for a domain. Specifies the instance type and
number of instances in the domain.
$sel:advancedSecurityOptions:CreateDomain', createDomain_advancedSecurityOptions - Specifies advanced security options.
$sel:tagList:CreateDomain', createDomain_tagList - A list of Tag added during domain creation.
$sel:snapshotOptions:CreateDomain', createDomain_snapshotOptions - Option to set time, in UTC format, of the daily automated snapshot.
Default value is 0 hours.
$sel:cognitoOptions:CreateDomain', createDomain_cognitoOptions - Options to specify the Cognito user and identity pools for OpenSearch
Dashboards authentication. For more information, see
Configuring Amazon Cognito authentication for OpenSearch Dashboards.
$sel:encryptionAtRestOptions:CreateDomain', createDomain_encryptionAtRestOptions - Options for encryption of data at rest.
$sel:vPCOptions:CreateDomain', createDomain_vPCOptions - 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
.
$sel:domainEndpointOptions:CreateDomain', createDomain_domainEndpointOptions - Options to specify configurations that will be applied to the domain
endpoint.
$sel:advancedOptions:CreateDomain', createDomain_advancedOptions - 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.
$sel:domainName:CreateDomain', createDomain_domainName - 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).
data CreateDomainResponse Source #
The result of a CreateDomain operation. Contains the status of the
newly created Amazon OpenSearch Service domain.
See: newCreateDomainResponse smart constructor.
Constructors
| CreateDomainResponse' (Maybe DomainStatus) Int |
Instances
newCreateDomainResponse Source #
Arguments
| :: Int | |
| -> CreateDomainResponse |
Create a value of CreateDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainStatus:CreateDomainResponse', createDomainResponse_domainStatus - The status of the newly created domain.
$sel:httpStatus:CreateDomainResponse', createDomainResponse_httpStatus - The response's http status code.
DescribeDomainConfig
data DescribeDomainConfig Source #
Container for the parameters to the DescribeDomainConfig operation.
Specifies the domain name for which you want configuration information.
See: newDescribeDomainConfig smart constructor.
Constructors
| DescribeDomainConfig' Text |
Instances
newDescribeDomainConfig Source #
Create a value of DescribeDomainConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:DescribeDomainConfig', describeDomainConfig_domainName - The domain you want to get information about.
data DescribeDomainConfigResponse Source #
The result of a DescribeDomainConfig request. Contains the
configuration information of the requested domain.
See: newDescribeDomainConfigResponse smart constructor.
Constructors
| DescribeDomainConfigResponse' Int DomainConfig |
Instances
newDescribeDomainConfigResponse Source #
Arguments
| :: Int | |
| -> DomainConfig | |
| -> DescribeDomainConfigResponse |
Create a value of DescribeDomainConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeDomainConfigResponse', describeDomainConfigResponse_httpStatus - The response's http status code.
$sel:domainConfig:DescribeDomainConfigResponse', describeDomainConfigResponse_domainConfig - The configuration information of the domain requested in the
DescribeDomainConfig request.
GetUpgradeStatus
data GetUpgradeStatus Source #
Container for the request parameters to the GetUpgradeStatus
operation.
See: newGetUpgradeStatus smart constructor.
Constructors
| GetUpgradeStatus' Text |
Instances
Arguments
| :: Text | |
| -> GetUpgradeStatus |
Create a value of GetUpgradeStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:GetUpgradeStatus', getUpgradeStatus_domainName - Undocumented member.
data GetUpgradeStatusResponse Source #
Container for the response returned by the GetUpgradeStatus
operation.
See: newGetUpgradeStatusResponse smart constructor.
Constructors
| GetUpgradeStatusResponse' (Maybe UpgradeStatus) (Maybe Text) (Maybe UpgradeStep) Int |
Instances
newGetUpgradeStatusResponse Source #
Create a value of GetUpgradeStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stepStatus:GetUpgradeStatusResponse', getUpgradeStatusResponse_stepStatus - 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
$sel:upgradeName:GetUpgradeStatusResponse', getUpgradeStatusResponse_upgradeName - A string that briefly describes the update.
$sel:upgradeStep:GetUpgradeStatusResponse', getUpgradeStatusResponse_upgradeStep - One of three steps an upgrade or upgrade eligibility check goes through:
- PreUpgradeCheck
- Snapshot
- Upgrade
$sel:httpStatus:GetUpgradeStatusResponse', getUpgradeStatusResponse_httpStatus - The response's http status code.
DeleteInboundConnection
data DeleteInboundConnection Source #
Container for the parameters to the DeleteInboundConnection
operation.
See: newDeleteInboundConnection smart constructor.
Constructors
| DeleteInboundConnection' Text |
Instances
newDeleteInboundConnection Source #
Create a value of DeleteInboundConnection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connectionId:DeleteInboundConnection', deleteInboundConnection_connectionId - The ID of the inbound connection to permanently delete.
data DeleteInboundConnectionResponse Source #
The result of a DeleteInboundConnection operation. Contains details
about the deleted inbound connection.
See: newDeleteInboundConnectionResponse smart constructor.
Constructors
| DeleteInboundConnectionResponse' (Maybe InboundConnection) Int |
Instances
newDeleteInboundConnectionResponse Source #
Create a value of DeleteInboundConnectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connection:DeleteInboundConnectionResponse', deleteInboundConnectionResponse_connection - The InboundConnection of the deleted inbound connection.
$sel:httpStatus:DeleteInboundConnectionResponse', deleteInboundConnectionResponse_httpStatus - The response's http status code.
DissociatePackage
data DissociatePackage Source #
Container for the request parameters to the DissociatePackage
operation.
See: newDissociatePackage smart constructor.
Constructors
| DissociatePackage' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DissociatePackage |
Create a value of DissociatePackage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:packageID:DissociatePackage', dissociatePackage_packageID - The internal ID of the package to associate with a domain. Use
DescribePackages to find this value.
$sel:domainName:DissociatePackage', dissociatePackage_domainName - The name of the domain to associate the package with.
data DissociatePackageResponse Source #
Container for the response returned by DissociatePackage operation.
See: newDissociatePackageResponse smart constructor.
Constructors
| DissociatePackageResponse' (Maybe DomainPackageDetails) Int |
Instances
newDissociatePackageResponse Source #
Create a value of DissociatePackageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainPackageDetails:DissociatePackageResponse', dissociatePackageResponse_domainPackageDetails - DomainPackageDetails
$sel:httpStatus:DissociatePackageResponse', dissociatePackageResponse_httpStatus - The response's http status code.
DescribeDomain
data DescribeDomain Source #
Container for the parameters to the DescribeDomain operation.
See: newDescribeDomain smart constructor.
Constructors
| DescribeDomain' Text |
Instances
Arguments
| :: Text | |
| -> DescribeDomain |
Create a value of DescribeDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:DescribeDomain', describeDomain_domainName - The name of the domain for which you want information.
data DescribeDomainResponse Source #
The result of a DescribeDomain request. Contains the status of the
domain specified in the request.
See: newDescribeDomainResponse smart constructor.
Constructors
| DescribeDomainResponse' Int DomainStatus |
Instances
newDescribeDomainResponse Source #
Arguments
| :: Int | |
| -> DomainStatus | |
| -> DescribeDomainResponse |
Create a value of DescribeDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeDomainResponse', describeDomainResponse_httpStatus - The response's http status code.
$sel:domainStatus:DescribeDomainResponse', describeDomainResponse_domainStatus - The current status of the domain.
AddTags
Container for the parameters to the AddTags operation. Specifies the
tags to attach to the domain.
See: newAddTags smart constructor.
Instances
Create a value of AddTags with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:AddTags', addTags_arn - Specify the ARN of the domain you want to add tags to.
$sel:tagList:AddTags', addTags_tagList - List of Tag to add to the domain.
data AddTagsResponse Source #
See: newAddTagsResponse smart constructor.
Constructors
| AddTagsResponse' | |
Instances
| Eq AddTagsResponse Source # | |
Defined in Amazonka.OpenSearch.AddTags Methods (==) :: AddTagsResponse -> AddTagsResponse -> Bool # (/=) :: AddTagsResponse -> AddTagsResponse -> Bool # | |
| Read AddTagsResponse Source # | |
Defined in Amazonka.OpenSearch.AddTags Methods readsPrec :: Int -> ReadS AddTagsResponse # readList :: ReadS [AddTagsResponse] # | |
| Show AddTagsResponse Source # | |
Defined in Amazonka.OpenSearch.AddTags Methods showsPrec :: Int -> AddTagsResponse -> ShowS # show :: AddTagsResponse -> String # showList :: [AddTagsResponse] -> ShowS # | |
| Generic AddTagsResponse Source # | |
Defined in Amazonka.OpenSearch.AddTags Associated Types type Rep AddTagsResponse :: Type -> Type # Methods from :: AddTagsResponse -> Rep AddTagsResponse x # to :: Rep AddTagsResponse x -> AddTagsResponse # | |
| NFData AddTagsResponse Source # | |
Defined in Amazonka.OpenSearch.AddTags Methods rnf :: AddTagsResponse -> () # | |
| type Rep AddTagsResponse Source # | |
newAddTagsResponse :: AddTagsResponse Source #
Create a value of AddTagsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
AcceptInboundConnection
data AcceptInboundConnection Source #
Container for the parameters to the AcceptInboundConnection
operation.
See: newAcceptInboundConnection smart constructor.
Constructors
| AcceptInboundConnection' Text |
Instances
newAcceptInboundConnection Source #
Create a value of AcceptInboundConnection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connectionId:AcceptInboundConnection', acceptInboundConnection_connectionId - The ID of the inbound connection you want to accept.
data AcceptInboundConnectionResponse Source #
The result of an AcceptInboundConnection operation. Contains details
about the accepted inbound connection.
See: newAcceptInboundConnectionResponse smart constructor.
Constructors
| AcceptInboundConnectionResponse' (Maybe InboundConnection) Int |
Instances
newAcceptInboundConnectionResponse Source #
Create a value of AcceptInboundConnectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:connection:AcceptInboundConnectionResponse', acceptInboundConnectionResponse_connection - The InboundConnection of the accepted inbound connection.
$sel:httpStatus:AcceptInboundConnectionResponse', acceptInboundConnectionResponse_httpStatus - The response's http status code.
UpdateDomainConfig
data UpdateDomainConfig Source #
Container for the parameters to the UpdateDomain operation.
Specifies the type and number of instances in the domain cluster.
See: newUpdateDomainConfig smart constructor.
Constructors
Instances
newUpdateDomainConfig Source #
Arguments
| :: Text | |
| -> UpdateDomainConfig |
Create a value of UpdateDomainConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eBSOptions:UpdateDomainConfig', updateDomainConfig_eBSOptions - Specify the type and size of the EBS volume to use.
$sel:nodeToNodeEncryptionOptions:UpdateDomainConfig', updateDomainConfig_nodeToNodeEncryptionOptions - Specifies node-to-node encryption options.
$sel:accessPolicies:UpdateDomainConfig', updateDomainConfig_accessPolicies - IAM access policy as a JSON-formatted string.
$sel:autoTuneOptions:UpdateDomainConfig', updateDomainConfig_autoTuneOptions - Specifies Auto-Tune options.
$sel:logPublishingOptions:UpdateDomainConfig', updateDomainConfig_logPublishingOptions - Map of LogType and LogPublishingOption, each containing options to
publish a given type of OpenSearch log.
$sel:clusterConfig:UpdateDomainConfig', updateDomainConfig_clusterConfig - The type and number of instances to instantiate for the domain cluster.
$sel:advancedSecurityOptions:UpdateDomainConfig', updateDomainConfig_advancedSecurityOptions - Specifies advanced security options.
$sel:snapshotOptions:UpdateDomainConfig', updateDomainConfig_snapshotOptions - Option to set the time, in UTC format, for the daily automated snapshot.
Default value is 0 hours.
$sel:cognitoOptions:UpdateDomainConfig', updateDomainConfig_cognitoOptions - Options to specify the Cognito user and identity pools for OpenSearch
Dashboards authentication. For more information, see
Configuring Amazon Cognito authentication for OpenSearch Dashboards.
$sel:encryptionAtRestOptions:UpdateDomainConfig', updateDomainConfig_encryptionAtRestOptions - Specifies encryption of data at rest options.
$sel:vPCOptions:UpdateDomainConfig', updateDomainConfig_vPCOptions - 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
.
$sel:domainEndpointOptions:UpdateDomainConfig', updateDomainConfig_domainEndpointOptions - Options to specify configuration that will be applied to the domain
endpoint.
$sel:advancedOptions:UpdateDomainConfig', updateDomainConfig_advancedOptions - 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.
$sel:domainName:UpdateDomainConfig', updateDomainConfig_domainName - The name of the domain you're updating.
data UpdateDomainConfigResponse Source #
The result of an UpdateDomain request. Contains the status of the
domain being updated.
See: newUpdateDomainConfigResponse smart constructor.
Constructors
| UpdateDomainConfigResponse' Int DomainConfig |
Instances
newUpdateDomainConfigResponse Source #
Arguments
| :: Int | |
| -> DomainConfig | |
| -> UpdateDomainConfigResponse |
Create a value of UpdateDomainConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDomainConfigResponse', updateDomainConfigResponse_httpStatus - The response's http status code.
$sel:domainConfig:UpdateDomainConfigResponse', updateDomainConfigResponse_domainConfig - The status of the updated domain.
ListTags
Container for the parameters to the ListTags operation. Specify the
ARN of the domain that the tags you want to view are attached to.
See: newListTags smart constructor.
Instances
| Eq ListTags Source # | |
| Read ListTags Source # | |
| Show ListTags Source # | |
| Generic ListTags Source # | |
| NFData ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags | |
| Hashable ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags | |
| AWSRequest ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags Associated Types type AWSResponse ListTags # Methods request :: ListTags -> Request ListTags # response :: MonadResource m => Logger -> Service -> Proxy ListTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTags))) # | |
| ToHeaders ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags | |
| ToPath ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags Methods toPath :: ListTags -> ByteString # | |
| ToQuery ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags Methods toQuery :: ListTags -> QueryString # | |
| type Rep ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags | |
| type AWSResponse ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags | |
Create a value of ListTags with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ListTags', listTags_arn - Specify the ARN of the domain that the tags you want to view are
attached to.
data ListTagsResponse Source #
The result of a ListTags operation. Contains tags for all requested
domains.
See: newListTagsResponse smart constructor.
Constructors
| ListTagsResponse' (Maybe [Tag]) Int |
Instances
Arguments
| :: Int | |
| -> ListTagsResponse |
Create a value of ListTagsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tagList:ListTagsResponse', listTagsResponse_tagList - List of Tag for the requested domain.
$sel:httpStatus:ListTagsResponse', listTagsResponse_httpStatus - The response's http status code.
DeletePackage
data DeletePackage Source #
Container for the request parameters to the DeletePackage operation.
See: newDeletePackage smart constructor.
Constructors
| DeletePackage' Text |
Instances
Arguments
| :: Text | |
| -> DeletePackage |
Create a value of DeletePackage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:packageID:DeletePackage', deletePackage_packageID - The internal ID of the package you want to delete. Use
DescribePackages to find this value.
data DeletePackageResponse Source #
Container for the response parameters to the DeletePackage
operation.
See: newDeletePackageResponse smart constructor.
Constructors
| DeletePackageResponse' (Maybe PackageDetails) Int |
Instances
newDeletePackageResponse Source #
Create a value of DeletePackageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:packageDetails:DeletePackageResponse', deletePackageResponse_packageDetails - PackageDetails
$sel:httpStatus:DeletePackageResponse', deletePackageResponse_httpStatus - The response's http status code.
UpdatePackage
data UpdatePackage Source #
Container for request parameters to the UpdatePackage operation.
See: newUpdatePackage smart constructor.
Constructors
| UpdatePackage' (Maybe Text) (Maybe Text) Text PackageSource |
Instances
Arguments
| :: Text | |
| -> PackageSource | |
| -> UpdatePackage |
Create a value of UpdatePackage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:packageDescription:UpdatePackage', updatePackage_packageDescription - A new description of the package.
$sel:commitMessage:UpdatePackage', updatePackage_commitMessage - A commit message for the new version which is shown as part of
GetPackageVersionHistoryResponse.
$sel:packageID:UpdatePackage', updatePackage_packageID - The unique identifier for the package.
$sel:packageSource:UpdatePackage', updatePackage_packageSource - Undocumented member.
data UpdatePackageResponse Source #
Container for the response returned by the UpdatePackage operation.
See: newUpdatePackageResponse smart constructor.
Constructors
| UpdatePackageResponse' (Maybe PackageDetails) Int |
Instances
newUpdatePackageResponse Source #
Create a value of UpdatePackageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:packageDetails:UpdatePackageResponse', updatePackageResponse_packageDetails - Information about the package.
$sel:httpStatus:UpdatePackageResponse', updatePackageResponse_httpStatus - The response's http status code.
CreateOutboundConnection
data CreateOutboundConnection Source #
Container for the parameters to the CreateOutboundConnection
operation.
See: newCreateOutboundConnection smart constructor.
Instances
newCreateOutboundConnection Source #
Arguments
| :: DomainInformationContainer | |
| -> DomainInformationContainer | |
| -> Text | |
| -> CreateOutboundConnection |
Create a value of CreateOutboundConnection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:localDomainInfo:CreateOutboundConnection', createOutboundConnection_localDomainInfo - The AWSDomainInformation for the local OpenSearch domain.
$sel:remoteDomainInfo:CreateOutboundConnection', createOutboundConnection_remoteDomainInfo - The AWSDomainInformation for the remote OpenSearch domain.
$sel:connectionAlias:CreateOutboundConnection', createOutboundConnection_connectionAlias - The connection alias used used by the customer for this cross-cluster
connection.
data CreateOutboundConnectionResponse Source #
The result of a CreateOutboundConnection request. Contains the
details about the newly created cross-cluster connection.
See: newCreateOutboundConnectionResponse smart constructor.
Constructors
| CreateOutboundConnectionResponse' (Maybe DomainInformationContainer) (Maybe Text) (Maybe DomainInformationContainer) (Maybe Text) (Maybe OutboundConnectionStatus) Int |
Instances
newCreateOutboundConnectionResponse Source #
Create a value of CreateOutboundConnectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:remoteDomainInfo:CreateOutboundConnection', createOutboundConnectionResponse_remoteDomainInfo - The AWSDomainInformation for the remote OpenSearch domain.
$sel:connectionAlias:CreateOutboundConnection', createOutboundConnectionResponse_connectionAlias - The connection alias provided during the create connection request.
$sel:localDomainInfo:CreateOutboundConnection', createOutboundConnectionResponse_localDomainInfo - The AWSDomainInformation for the local OpenSearch domain.
$sel:connectionId:CreateOutboundConnectionResponse', createOutboundConnectionResponse_connectionId - The unique ID for the created outbound connection, which is used for
subsequent operations on the connection.
$sel:connectionStatus:CreateOutboundConnectionResponse', createOutboundConnectionResponse_connectionStatus - The OutboundConnectionStatus for the newly created connection.
$sel:httpStatus:CreateOutboundConnectionResponse', createOutboundConnectionResponse_httpStatus - The response's http status code.
CreatePackage
data CreatePackage Source #
Container for request parameters to the CreatePackage operation.
See: newCreatePackage smart constructor.
Constructors
| CreatePackage' (Maybe Text) Text PackageType PackageSource |
Instances
Arguments
| :: Text | |
| -> PackageType | |
| -> PackageSource | |
| -> CreatePackage |
Create a value of CreatePackage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:packageDescription:CreatePackage', createPackage_packageDescription - Description of the package.
$sel:packageName:CreatePackage', createPackage_packageName - Unique identifier for the package.
$sel:packageType:CreatePackage', createPackage_packageType - Type of package. Currently supports only TXT-DICTIONARY.
$sel:packageSource:CreatePackage', createPackage_packageSource - The Amazon S3 location from which to import the package.
data CreatePackageResponse Source #
Container for the response returned by the CreatePackage operation.
See: newCreatePackageResponse smart constructor.
Constructors
| CreatePackageResponse' (Maybe PackageDetails) Int |
Instances
newCreatePackageResponse Source #
Create a value of CreatePackageResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:packageDetails:CreatePackageResponse', createPackageResponse_packageDetails - Information about the package.
$sel:httpStatus:CreatePackageResponse', createPackageResponse_httpStatus - The response's http status code.
DeleteDomain
data DeleteDomain Source #
Container for the parameters to the DeleteDomain operation.
Specifies the name of the domain you want to delete.
See: newDeleteDomain smart constructor.
Constructors
| DeleteDomain' Text |
Instances
Arguments
| :: Text | |
| -> DeleteDomain |
Create a value of DeleteDomain with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:DeleteDomain', deleteDomain_domainName - The name of the domain you want to permanently delete.
data DeleteDomainResponse Source #
The result of a DeleteDomain request. Contains the status of the
pending deletion, or a "domain not found" error if the domain and all
of its resources have been deleted.
See: newDeleteDomainResponse smart constructor.
Constructors
| DeleteDomainResponse' (Maybe DomainStatus) Int |
Instances
newDeleteDomainResponse Source #
Arguments
| :: Int | |
| -> DeleteDomainResponse |
Create a value of DeleteDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainStatus:DeleteDomainResponse', deleteDomainResponse_domainStatus - The status of the domain being deleted.
$sel:httpStatus:DeleteDomainResponse', deleteDomainResponse_httpStatus - The response's http status code.
GetCompatibleVersions
data GetCompatibleVersions Source #
Container for the request parameters to GetCompatibleVersions
operation.
See: newGetCompatibleVersions smart constructor.
Constructors
| GetCompatibleVersions' (Maybe Text) |
Instances
newGetCompatibleVersions :: GetCompatibleVersions Source #
Create a value of GetCompatibleVersions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:GetCompatibleVersions', getCompatibleVersions_domainName - Undocumented member.
data GetCompatibleVersionsResponse Source #
Container for the response returned by the GetCompatibleVersions
operation.
See: newGetCompatibleVersionsResponse smart constructor.
Constructors
| GetCompatibleVersionsResponse' (Maybe [CompatibleVersionsMap]) Int |
Instances
newGetCompatibleVersionsResponse Source #
Create a value of GetCompatibleVersionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:compatibleVersions:GetCompatibleVersionsResponse', getCompatibleVersionsResponse_compatibleVersions - A map of compatible OpenSearch versions returned as part of the
GetCompatibleVersions operation.
$sel:httpStatus:GetCompatibleVersionsResponse', getCompatibleVersionsResponse_httpStatus - The response's http status code.
Types
AutoTuneDesiredState
newtype AutoTuneDesiredState Source #
The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
Constructors
| AutoTuneDesiredState' | |
Fields | |
Bundled Patterns
| pattern AutoTuneDesiredState_DISABLED :: AutoTuneDesiredState | |
| pattern AutoTuneDesiredState_ENABLED :: AutoTuneDesiredState |
Instances
AutoTuneState
newtype AutoTuneState Source #
The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.
Constructors
| AutoTuneState' | |
Fields | |
Bundled Patterns
| pattern AutoTuneState_DISABLED :: AutoTuneState | |
| pattern AutoTuneState_DISABLED_AND_ROLLBACK_COMPLETE :: AutoTuneState | |
| pattern AutoTuneState_DISABLED_AND_ROLLBACK_ERROR :: AutoTuneState | |
| pattern AutoTuneState_DISABLED_AND_ROLLBACK_IN_PROGRESS :: AutoTuneState | |
| pattern AutoTuneState_DISABLED_AND_ROLLBACK_SCHEDULED :: AutoTuneState | |
| pattern AutoTuneState_DISABLE_IN_PROGRESS :: AutoTuneState | |
| pattern AutoTuneState_ENABLED :: AutoTuneState | |
| pattern AutoTuneState_ENABLE_IN_PROGRESS :: AutoTuneState | |
| pattern AutoTuneState_ERROR :: AutoTuneState |
Instances
AutoTuneType
newtype AutoTuneType Source #
Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
Constructors
| AutoTuneType' | |
Fields | |
Bundled Patterns
| pattern AutoTuneType_SCHEDULED_ACTION :: AutoTuneType |
Instances
DeploymentStatus
newtype DeploymentStatus Source #
Constructors
| DeploymentStatus' | |
Fields | |
Bundled Patterns
| pattern DeploymentStatus_COMPLETED :: DeploymentStatus | |
| pattern DeploymentStatus_ELIGIBLE :: DeploymentStatus | |
| pattern DeploymentStatus_IN_PROGRESS :: DeploymentStatus | |
| pattern DeploymentStatus_NOT_ELIGIBLE :: DeploymentStatus | |
| pattern DeploymentStatus_PENDING_UPDATE :: DeploymentStatus |
Instances
DescribePackagesFilterName
newtype DescribePackagesFilterName Source #
Constructors
| DescribePackagesFilterName' | |
Fields | |
Bundled Patterns
Instances
DomainPackageStatus
newtype DomainPackageStatus Source #
Constructors
| DomainPackageStatus' | |
Fields | |
Bundled Patterns
Instances
EngineType
newtype EngineType Source #
Constructors
| EngineType' | |
Fields | |
Bundled Patterns
| pattern EngineType_Elasticsearch :: EngineType | |
| pattern EngineType_OpenSearch :: EngineType |
Instances
InboundConnectionStatusCode
newtype InboundConnectionStatusCode Source #
Constructors
| InboundConnectionStatusCode' | |
Fields | |
Bundled Patterns
Instances
LogType
Type of log file. Can be one of the following:
- INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
- SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
- ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
- AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
Constructors
| LogType' | |
Fields
| |
Bundled Patterns
| pattern LogType_AUDIT_LOGS :: LogType | |
| pattern LogType_ES_APPLICATION_LOGS :: LogType | |
| pattern LogType_INDEX_SLOW_LOGS :: LogType | |
| pattern LogType_SEARCH_SLOW_LOGS :: LogType |
Instances
OpenSearchPartitionInstanceType
newtype OpenSearchPartitionInstanceType Source #
Constructors
| OpenSearchPartitionInstanceType' | |
Fields | |
Bundled Patterns
Instances
OpenSearchWarmPartitionInstanceType
newtype OpenSearchWarmPartitionInstanceType Source #
Constructors
| OpenSearchWarmPartitionInstanceType' | |
Bundled Patterns
Instances
OptionState
newtype OptionState Source #
The state of a requested change. One of the following:
- Processing: The request change is still in progress.
- Active: The request change is processed and deployed to the domain.
Constructors
| OptionState' | |
Fields | |
Bundled Patterns
| pattern OptionState_Active :: OptionState | |
| pattern OptionState_Processing :: OptionState | |
| pattern OptionState_RequiresIndexDocuments :: OptionState |
Instances
OutboundConnectionStatusCode
newtype OutboundConnectionStatusCode Source #
Constructors
| OutboundConnectionStatusCode' | |
Fields | |
Bundled Patterns
Instances
PackageStatus
newtype PackageStatus Source #
Constructors
| PackageStatus' | |
Fields | |
Bundled Patterns
| pattern PackageStatus_AVAILABLE :: PackageStatus | |
| pattern PackageStatus_COPYING :: PackageStatus | |
| pattern PackageStatus_COPY_FAILED :: PackageStatus | |
| pattern PackageStatus_DELETED :: PackageStatus | |
| pattern PackageStatus_DELETE_FAILED :: PackageStatus | |
| pattern PackageStatus_DELETING :: PackageStatus | |
| pattern PackageStatus_VALIDATING :: PackageStatus | |
| pattern PackageStatus_VALIDATION_FAILED :: PackageStatus |
Instances
PackageType
newtype PackageType Source #
Constructors
| PackageType' | |
Fields | |
Bundled Patterns
| pattern PackageType_TXT_DICTIONARY :: PackageType |
Instances
ReservedInstancePaymentOption
newtype ReservedInstancePaymentOption Source #
Constructors
| ReservedInstancePaymentOption' | |
Fields | |
Bundled Patterns
Instances
RollbackOnDisable
newtype RollbackOnDisable Source #
The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
Constructors
| RollbackOnDisable' | |
Fields | |
Bundled Patterns
| pattern RollbackOnDisable_DEFAULT_ROLLBACK :: RollbackOnDisable | |
| pattern RollbackOnDisable_NO_ROLLBACK :: RollbackOnDisable |
Instances
ScheduledAutoTuneActionType
newtype ScheduledAutoTuneActionType Source #
The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING, and JVM_YOUNG_GEN_TUNING.
Constructors
| ScheduledAutoTuneActionType' | |
Fields | |
Bundled Patterns
| pattern ScheduledAutoTuneActionType_JVM_HEAP_SIZE_TUNING :: ScheduledAutoTuneActionType | |
| pattern ScheduledAutoTuneActionType_JVM_YOUNG_GEN_TUNING :: ScheduledAutoTuneActionType |
Instances
ScheduledAutoTuneSeverityType
newtype ScheduledAutoTuneSeverityType Source #
The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.
Constructors
| ScheduledAutoTuneSeverityType' | |
Fields | |
Bundled Patterns
Instances
TLSSecurityPolicy
newtype TLSSecurityPolicy Source #
Constructors
| TLSSecurityPolicy' | |
Fields | |
Bundled Patterns
| pattern TLSSecurityPolicy_Policy_Min_TLS_1_0_2019_07 :: TLSSecurityPolicy | |
| pattern TLSSecurityPolicy_Policy_Min_TLS_1_2_2019_07 :: TLSSecurityPolicy |
Instances
TimeUnit
The unit of a maintenance schedule duration. Valid value is HOUR. See Auto-Tune for Amazon OpenSearch Service for more information.
Constructors
| TimeUnit' | |
Fields
| |
Bundled Patterns
| pattern TimeUnit_HOURS :: TimeUnit |
Instances
UpgradeStatus
newtype UpgradeStatus Source #
Constructors
| UpgradeStatus' | |
Fields | |
Bundled Patterns
| pattern UpgradeStatus_FAILED :: UpgradeStatus | |
| pattern UpgradeStatus_IN_PROGRESS :: UpgradeStatus | |
| pattern UpgradeStatus_SUCCEEDED :: UpgradeStatus | |
| pattern UpgradeStatus_SUCCEEDED_WITH_ISSUES :: UpgradeStatus |
Instances
UpgradeStep
newtype UpgradeStep Source #
Constructors
| UpgradeStep' | |
Fields | |
Bundled Patterns
| pattern UpgradeStep_PRE_UPGRADE_CHECK :: UpgradeStep | |
| pattern UpgradeStep_SNAPSHOT :: UpgradeStep | |
| pattern UpgradeStep_UPGRADE :: UpgradeStep |
Instances
VolumeType
newtype VolumeType Source #
The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storage for more information.
Constructors
| VolumeType' | |
Fields | |
Bundled Patterns
| pattern VolumeType_Gp2 :: VolumeType | |
| pattern VolumeType_Io1 :: VolumeType | |
| pattern VolumeType_Standard :: VolumeType |
Instances
AWSDomainInformation
data AWSDomainInformation Source #
See: newAWSDomainInformation smart constructor.
Instances
newAWSDomainInformation Source #
Create a value of AWSDomainInformation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ownerId:AWSDomainInformation', aWSDomainInformation_ownerId - Undocumented member.
$sel:region:AWSDomainInformation', aWSDomainInformation_region - Undocumented member.
$sel:domainName:AWSDomainInformation', aWSDomainInformation_domainName - Undocumented member.
AccessPoliciesStatus
data AccessPoliciesStatus Source #
The configured access rules for the domain's document and search endpoints, and the current status of those rules.
See: newAccessPoliciesStatus smart constructor.
Constructors
| AccessPoliciesStatus' Text OptionStatus |
Instances
newAccessPoliciesStatus Source #
Arguments
| :: Text | |
| -> OptionStatus | |
| -> AccessPoliciesStatus |
Create a value of AccessPoliciesStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:AccessPoliciesStatus', accessPoliciesStatus_options - The access policy configured for the domain. Access policies can be
resource-based, IP-based, or IAM-based. See
Configuring access policiesfor
more information.
$sel:status:AccessPoliciesStatus', accessPoliciesStatus_status - The status of the access policy for the domain. See OptionStatus for
the status information that's included.
AdditionalLimit
data AdditionalLimit Source #
List of limits that are specific to a given InstanceType and for each of
its InstanceRole .
See: newAdditionalLimit smart constructor.
Constructors
| AdditionalLimit' (Maybe Text) (Maybe [Text]) |
Instances
newAdditionalLimit :: AdditionalLimit Source #
Create a value of AdditionalLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:limitName:AdditionalLimit', additionalLimit_limitName - Additional limit is specific to a given InstanceType and for each of its
InstanceRole etc.
Attributes and their details:
- MaximumNumberOfDataNodesSupported
- MaximumNumberOfDataNodesWithoutMasterNode
$sel:limitValues:AdditionalLimit', additionalLimit_limitValues - Value for a given AdditionalLimit$LimitName .
AdvancedOptionsStatus
data AdvancedOptionsStatus Source #
Status of the advanced options for the specified 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 Advanced cluster parameters for more information. - Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.
For more information, see Advanced cluster parameters.
See: newAdvancedOptionsStatus smart constructor.
Constructors
| AdvancedOptionsStatus' (HashMap Text Text) OptionStatus |
Instances
newAdvancedOptionsStatus Source #
Create a value of AdvancedOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:AdvancedOptionsStatus', advancedOptionsStatus_options - The status of advanced options for the specified domain.
$sel:status:AdvancedOptionsStatus', advancedOptionsStatus_status - The OptionStatus for advanced options for the specified domain.
AdvancedSecurityOptions
data AdvancedSecurityOptions Source #
The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.
See: newAdvancedSecurityOptions smart constructor.
Constructors
| AdvancedSecurityOptions' (Maybe Bool) (Maybe Bool) (Maybe SAMLOptionsOutput) |
Instances
newAdvancedSecurityOptions :: AdvancedSecurityOptions Source #
Create a value of AdvancedSecurityOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:AdvancedSecurityOptions', advancedSecurityOptions_enabled - True if advanced security is enabled.
$sel:internalUserDatabaseEnabled:AdvancedSecurityOptions', advancedSecurityOptions_internalUserDatabaseEnabled - True if the internal user database is enabled.
$sel:sAMLOptions:AdvancedSecurityOptions', advancedSecurityOptions_sAMLOptions - Describes the SAML application configured for a domain.
AdvancedSecurityOptionsInput
data AdvancedSecurityOptionsInput Source #
The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).
See: newAdvancedSecurityOptionsInput smart constructor.
Constructors
| AdvancedSecurityOptionsInput' (Maybe Bool) (Maybe Bool) (Maybe MasterUserOptions) (Maybe SAMLOptionsInput) |
Instances
newAdvancedSecurityOptionsInput :: AdvancedSecurityOptionsInput Source #
Create a value of AdvancedSecurityOptionsInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:AdvancedSecurityOptionsInput', advancedSecurityOptionsInput_enabled - True if advanced security is enabled.
$sel:internalUserDatabaseEnabled:AdvancedSecurityOptionsInput', advancedSecurityOptionsInput_internalUserDatabaseEnabled - True if the internal user database is enabled.
$sel:masterUserOptions:AdvancedSecurityOptionsInput', advancedSecurityOptionsInput_masterUserOptions - Credentials for the master user: username and password, ARN, or both.
$sel:sAMLOptions:AdvancedSecurityOptionsInput', advancedSecurityOptionsInput_sAMLOptions - The SAML application configuration for the domain.
AdvancedSecurityOptionsStatus
data AdvancedSecurityOptionsStatus Source #
The status of advanced security options for the specified domain.
See: newAdvancedSecurityOptionsStatus smart constructor.
Instances
newAdvancedSecurityOptionsStatus Source #
Arguments
| :: AdvancedSecurityOptions | |
| -> OptionStatus | |
| -> AdvancedSecurityOptionsStatus |
Create a value of AdvancedSecurityOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:AdvancedSecurityOptionsStatus', advancedSecurityOptionsStatus_options - Advanced security options for the specified domain.
$sel:status:AdvancedSecurityOptionsStatus', advancedSecurityOptionsStatus_status - Status of the advanced security options for the specified domain.
AutoTune
Specifies the Auto-Tune type and Auto-Tune action details.
See: newAutoTune smart constructor.
Constructors
| AutoTune' (Maybe AutoTuneDetails) (Maybe AutoTuneType) |
Instances
| Eq AutoTune Source # | |
| Read AutoTune Source # | |
| Show AutoTune Source # | |
| Generic AutoTune Source # | |
| NFData AutoTune Source # | |
Defined in Amazonka.OpenSearch.Types.AutoTune | |
| Hashable AutoTune Source # | |
Defined in Amazonka.OpenSearch.Types.AutoTune | |
| FromJSON AutoTune Source # | |
| type Rep AutoTune Source # | |
Defined in Amazonka.OpenSearch.Types.AutoTune type Rep AutoTune = D1 ('MetaData "AutoTune" "Amazonka.OpenSearch.Types.AutoTune" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "AutoTune'" 'PrefixI 'True) (S1 ('MetaSel ('Just "autoTuneDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoTuneDetails)) :*: S1 ('MetaSel ('Just "autoTuneType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoTuneType)))) | |
newAutoTune :: AutoTune Source #
Create a value of AutoTune with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoTuneDetails:AutoTune', autoTune_autoTuneDetails - Specifies details about the Auto-Tune action. See
Auto-Tune for Amazon OpenSearch Service
for more information.
$sel:autoTuneType:AutoTune', autoTune_autoTuneType - Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
AutoTuneDetails
data AutoTuneDetails Source #
Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
See: newAutoTuneDetails smart constructor.
Constructors
| AutoTuneDetails' (Maybe ScheduledAutoTuneDetails) |
Instances
newAutoTuneDetails :: AutoTuneDetails Source #
Create a value of AutoTuneDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scheduledAutoTuneDetails:AutoTuneDetails', autoTuneDetails_scheduledAutoTuneDetails - Undocumented member.
AutoTuneMaintenanceSchedule
data AutoTuneMaintenanceSchedule Source #
Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
See: newAutoTuneMaintenanceSchedule smart constructor.
Instances
newAutoTuneMaintenanceSchedule :: AutoTuneMaintenanceSchedule Source #
Create a value of AutoTuneMaintenanceSchedule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:startAt:AutoTuneMaintenanceSchedule', autoTuneMaintenanceSchedule_startAt - The timestamp at which the Auto-Tune maintenance schedule starts.
$sel:cronExpressionForRecurrence:AutoTuneMaintenanceSchedule', autoTuneMaintenanceSchedule_cronExpressionForRecurrence - A cron expression for a recurring maintenance schedule. See
Auto-Tune for Amazon OpenSearch Service
for more information.
$sel:duration:AutoTuneMaintenanceSchedule', autoTuneMaintenanceSchedule_duration - Specifies maintenance schedule duration: duration value and duration
unit. See
Auto-Tune for Amazon OpenSearch Service
for more information.
AutoTuneOptions
data AutoTuneOptions Source #
The Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.
See: newAutoTuneOptions smart constructor.
Constructors
| AutoTuneOptions' (Maybe AutoTuneDesiredState) (Maybe RollbackOnDisable) (Maybe [AutoTuneMaintenanceSchedule]) |
Instances
newAutoTuneOptions :: AutoTuneOptions Source #
Create a value of AutoTuneOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:desiredState:AutoTuneOptions', autoTuneOptions_desiredState - The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
$sel:rollbackOnDisable:AutoTuneOptions', autoTuneOptions_rollbackOnDisable - The rollback state while disabling Auto-Tune for the domain. Valid
values are NO_ROLLBACK and DEFAULT_ROLLBACK.
$sel:maintenanceSchedules:AutoTuneOptions', autoTuneOptions_maintenanceSchedules - A list of maintenance schedules. See
Auto-Tune for Amazon OpenSearch Service
for more information.
AutoTuneOptionsInput
data AutoTuneOptionsInput Source #
The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
See: newAutoTuneOptionsInput smart constructor.
Constructors
| AutoTuneOptionsInput' (Maybe AutoTuneDesiredState) (Maybe [AutoTuneMaintenanceSchedule]) |
Instances
newAutoTuneOptionsInput :: AutoTuneOptionsInput Source #
Create a value of AutoTuneOptionsInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:desiredState:AutoTuneOptionsInput', autoTuneOptionsInput_desiredState - The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
$sel:maintenanceSchedules:AutoTuneOptionsInput', autoTuneOptionsInput_maintenanceSchedules - A list of maintenance schedules. See
Auto-Tune for Amazon OpenSearch Service
for more information.
AutoTuneOptionsOutput
data AutoTuneOptionsOutput Source #
The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
See: newAutoTuneOptionsOutput smart constructor.
Constructors
| AutoTuneOptionsOutput' (Maybe AutoTuneState) (Maybe Text) |
Instances
newAutoTuneOptionsOutput :: AutoTuneOptionsOutput Source #
Create a value of AutoTuneOptionsOutput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:state:AutoTuneOptionsOutput', autoTuneOptionsOutput_state - The AutoTuneState for the domain.
$sel:errorMessage:AutoTuneOptionsOutput', autoTuneOptionsOutput_errorMessage - The error message while enabling or disabling Auto-Tune.
AutoTuneOptionsStatus
data AutoTuneOptionsStatus Source #
The Auto-Tune status for the domain.
See: newAutoTuneOptionsStatus smart constructor.
Constructors
| AutoTuneOptionsStatus' (Maybe AutoTuneStatus) (Maybe AutoTuneOptions) |
Instances
newAutoTuneOptionsStatus :: AutoTuneOptionsStatus Source #
Create a value of AutoTuneOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:AutoTuneOptionsStatus', autoTuneOptionsStatus_status - The status of the Auto-Tune options for the domain.
$sel:options:AutoTuneOptionsStatus', autoTuneOptionsStatus_options - Specifies Auto-Tune options for the domain.
AutoTuneStatus
data AutoTuneStatus Source #
Provides the current Auto-Tune status for the domain.
See: newAutoTuneStatus smart constructor.
Constructors
| AutoTuneStatus' (Maybe Bool) (Maybe Text) (Maybe Natural) POSIX POSIX AutoTuneState |
Instances
Arguments
| :: UTCTime | |
| -> UTCTime | |
| -> AutoTuneState | |
| -> AutoTuneStatus |
Create a value of AutoTuneStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pendingDeletion:AutoTuneStatus', autoTuneStatus_pendingDeletion - Indicates whether the domain is being deleted.
$sel:errorMessage:AutoTuneStatus', autoTuneStatus_errorMessage - The error message while enabling or disabling Auto-Tune.
$sel:updateVersion:AutoTuneStatus', autoTuneStatus_updateVersion - The latest version of the Auto-Tune options.
$sel:creationDate:AutoTuneStatus', autoTuneStatus_creationDate - The timestamp of the Auto-Tune options creation date.
$sel:updateDate:AutoTuneStatus', autoTuneStatus_updateDate - The timestamp of when the Auto-Tune options were last updated.
$sel:state:AutoTuneStatus', autoTuneStatus_state - The AutoTuneState for the domain.
ClusterConfig
data ClusterConfig Source #
The configuration for the domain cluster, such as the type and number of instances.
See: newClusterConfig smart constructor.
Constructors
Instances
newClusterConfig :: ClusterConfig Source #
Create a value of ClusterConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dedicatedMasterCount:ClusterConfig', clusterConfig_dedicatedMasterCount - Total number of dedicated master nodes, active and on standby, for the
cluster.
$sel:dedicatedMasterType:ClusterConfig', clusterConfig_dedicatedMasterType - The instance type for a dedicated master node.
$sel:dedicatedMasterEnabled:ClusterConfig', clusterConfig_dedicatedMasterEnabled - A boolean value to indicate whether a dedicated master node is enabled.
See
Dedicated master nodes in Amazon OpenSearch Service
for more information.
$sel:instanceCount:ClusterConfig', clusterConfig_instanceCount - The number of instances in the specified domain cluster.
$sel:coldStorageOptions:ClusterConfig', clusterConfig_coldStorageOptions - Specifies the ColdStorageOptions config for a Domain
$sel:zoneAwarenessEnabled:ClusterConfig', clusterConfig_zoneAwarenessEnabled - A boolean value to indicate whether zone awareness is enabled. See
Configuring a multi-AZ domain in Amazon OpenSearch Service
for more information.
$sel:instanceType:ClusterConfig', clusterConfig_instanceType - The instance type for an OpenSearch cluster. UltraWarm instance types
are not supported for data instances.
$sel:warmEnabled:ClusterConfig', clusterConfig_warmEnabled - True to enable UltraWarm storage.
$sel:zoneAwarenessConfig:ClusterConfig', clusterConfig_zoneAwarenessConfig - The zone awareness configuration for a domain when zone awareness is
enabled.
$sel:warmCount:ClusterConfig', clusterConfig_warmCount - The number of UltraWarm nodes in the cluster.
$sel:warmType:ClusterConfig', clusterConfig_warmType - The instance type for the OpenSearch cluster's warm nodes.
ClusterConfigStatus
data ClusterConfigStatus Source #
The configuration status for the specified domain.
See: newClusterConfigStatus smart constructor.
Constructors
| ClusterConfigStatus' ClusterConfig OptionStatus |
Instances
newClusterConfigStatus Source #
Arguments
| :: ClusterConfig | |
| -> OptionStatus | |
| -> ClusterConfigStatus |
Create a value of ClusterConfigStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:ClusterConfigStatus', clusterConfigStatus_options - The cluster configuration for the specified domain.
$sel:status:ClusterConfigStatus', clusterConfigStatus_status - The cluster configuration status for the specified domain.
CognitoOptions
data 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.
See: newCognitoOptions smart constructor.
Instances
newCognitoOptions :: CognitoOptions Source #
Create a value of CognitoOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:identityPoolId:CognitoOptions', cognitoOptions_identityPoolId - The Cognito identity pool ID for OpenSearch Dashboards authentication.
$sel:enabled:CognitoOptions', cognitoOptions_enabled - The option to enable Cognito for OpenSearch Dashboards authentication.
$sel:userPoolId:CognitoOptions', cognitoOptions_userPoolId - The Cognito user pool ID for OpenSearch Dashboards authentication.
$sel:roleArn:CognitoOptions', cognitoOptions_roleArn - The role ARN that provides OpenSearch permissions for accessing Cognito
resources.
CognitoOptionsStatus
data CognitoOptionsStatus Source #
The status of the Cognito options for the specified domain.
See: newCognitoOptionsStatus smart constructor.
Constructors
| CognitoOptionsStatus' CognitoOptions OptionStatus |
Instances
newCognitoOptionsStatus Source #
Arguments
| :: CognitoOptions | |
| -> OptionStatus | |
| -> CognitoOptionsStatus |
Create a value of CognitoOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:CognitoOptionsStatus', cognitoOptionsStatus_options - Cognito options for the specified domain.
$sel:status:CognitoOptionsStatus', cognitoOptionsStatus_status - The status of the Cognito options for the specified domain.
ColdStorageOptions
data ColdStorageOptions Source #
Specifies the configuration for cold storage options such as enabled
See: newColdStorageOptions smart constructor.
Constructors
| ColdStorageOptions' Bool |
Instances
newColdStorageOptions Source #
Arguments
| :: Bool | |
| -> ColdStorageOptions |
Create a value of ColdStorageOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:ColdStorageOptions', coldStorageOptions_enabled - Enable cold storage option. Accepted values true or false
CompatibleVersionsMap
data CompatibleVersionsMap Source #
A map from an EngineVersion to a list of compatible
EngineVersion s to which the domain can be upgraded.
See: newCompatibleVersionsMap smart constructor.
Constructors
| CompatibleVersionsMap' (Maybe Text) (Maybe [Text]) |
Instances
newCompatibleVersionsMap :: CompatibleVersionsMap Source #
Create a value of CompatibleVersionsMap with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceVersion:CompatibleVersionsMap', compatibleVersionsMap_sourceVersion - The current version of OpenSearch a domain is on.
$sel:targetVersions:CompatibleVersionsMap', compatibleVersionsMap_targetVersions - Undocumented member.
DescribePackagesFilter
data DescribePackagesFilter Source #
A filter to apply to the DescribePackage response.
See: newDescribePackagesFilter smart constructor.
Constructors
| DescribePackagesFilter' (Maybe [Text]) (Maybe DescribePackagesFilterName) |
Instances
newDescribePackagesFilter :: DescribePackagesFilter Source #
Create a value of DescribePackagesFilter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:DescribePackagesFilter', describePackagesFilter_value - A list of values for the specified field.
$sel:name:DescribePackagesFilter', describePackagesFilter_name - Any field from PackageDetails.
DomainConfig
data DomainConfig Source #
The configuration of a domain.
See: newDomainConfig smart constructor.
Constructors
Instances
newDomainConfig :: DomainConfig Source #
Create a value of DomainConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eBSOptions:DomainConfig', domainConfig_eBSOptions - The EBSOptions for the domain.
$sel:engineVersion:DomainConfig', domainConfig_engineVersion - String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the
engine version for the OpenSearch or Elasticsearch domain.
$sel:nodeToNodeEncryptionOptions:DomainConfig', domainConfig_nodeToNodeEncryptionOptions - The NodeToNodeEncryptionOptions for the domain.
$sel:accessPolicies:DomainConfig', domainConfig_accessPolicies - IAM access policy as a JSON-formatted string.
$sel:autoTuneOptions:DomainConfig', domainConfig_autoTuneOptions - Specifies AutoTuneOptions for the domain.
$sel:logPublishingOptions:DomainConfig', domainConfig_logPublishingOptions - Log publishing options for the given domain.
$sel:clusterConfig:DomainConfig', domainConfig_clusterConfig - The ClusterConfig for the domain.
$sel:advancedSecurityOptions:DomainConfig', domainConfig_advancedSecurityOptions - Specifies AdvancedSecurityOptions for the domain.
$sel:snapshotOptions:DomainConfig', domainConfig_snapshotOptions - The SnapshotOptions for the domain.
$sel:cognitoOptions:DomainConfig', domainConfig_cognitoOptions - The CognitoOptions for the specified domain. For more information, see
Configuring Amazon Cognito authentication for OpenSearch Dashboards.
$sel:encryptionAtRestOptions:DomainConfig', domainConfig_encryptionAtRestOptions - The EncryptionAtRestOptions for the domain.
$sel:vPCOptions:DomainConfig', domainConfig_vPCOptions - The VPCOptions for the specified domain. For more information, see
Launching your Amazon OpenSearch Service domains using a VPC.
$sel:domainEndpointOptions:DomainConfig', domainConfig_domainEndpointOptions - The DomainEndpointOptions for the domain.
$sel:advancedOptions:DomainConfig', domainConfig_advancedOptions - The AdvancedOptions for the domain. See
Advanced options
for more information.
DomainEndpointOptions
data DomainEndpointOptions Source #
Options to configure the endpoint for the domain.
See: newDomainEndpointOptions smart constructor.
Constructors
| DomainEndpointOptions' (Maybe Bool) (Maybe TLSSecurityPolicy) (Maybe Bool) (Maybe Text) (Maybe Text) |
Instances
newDomainEndpointOptions :: DomainEndpointOptions Source #
Create a value of DomainEndpointOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enforceHTTPS:DomainEndpointOptions', domainEndpointOptions_enforceHTTPS - Whether only HTTPS endpoint should be enabled for the domain.
$sel:tLSSecurityPolicy:DomainEndpointOptions', domainEndpointOptions_tLSSecurityPolicy - 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
$sel:customEndpointEnabled:DomainEndpointOptions', domainEndpointOptions_customEndpointEnabled - Whether to enable a custom endpoint for the domain.
$sel:customEndpoint:DomainEndpointOptions', domainEndpointOptions_customEndpoint - The fully qualified domain for your custom endpoint.
$sel:customEndpointCertificateArn:DomainEndpointOptions', domainEndpointOptions_customEndpointCertificateArn - The ACM certificate ARN for your custom endpoint.
DomainEndpointOptionsStatus
data DomainEndpointOptionsStatus Source #
The configured endpoint options for the domain and their current status.
See: newDomainEndpointOptionsStatus smart constructor.
Instances
newDomainEndpointOptionsStatus Source #
Arguments
| :: DomainEndpointOptions | |
| -> OptionStatus | |
| -> DomainEndpointOptionsStatus |
Create a value of DomainEndpointOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:DomainEndpointOptionsStatus', domainEndpointOptionsStatus_options - Options to configure the endpoint for the domain.
$sel:status:DomainEndpointOptionsStatus', domainEndpointOptionsStatus_status - The status of the endpoint options for the domain. See OptionStatus
for the status information that's included.
DomainInfo
data DomainInfo Source #
See: newDomainInfo smart constructor.
Constructors
| DomainInfo' (Maybe Text) (Maybe EngineType) |
Instances
newDomainInfo :: DomainInfo Source #
Create a value of DomainInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domainName:DomainInfo', domainInfo_domainName - The DomainName.
$sel:engineType:DomainInfo', domainInfo_engineType - Specifies the EngineType of the domain.
DomainInformationContainer
data DomainInformationContainer Source #
See: newDomainInformationContainer smart constructor.
Constructors
| DomainInformationContainer' (Maybe AWSDomainInformation) |
Instances
newDomainInformationContainer :: DomainInformationContainer Source #
Create a value of DomainInformationContainer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aWSDomainInformation:DomainInformationContainer', domainInformationContainer_aWSDomainInformation - Undocumented member.
DomainPackageDetails
data DomainPackageDetails Source #
Information on a package associated with a domain.
See: newDomainPackageDetails smart constructor.
Constructors
| DomainPackageDetails' (Maybe POSIX) (Maybe Text) (Maybe PackageType) (Maybe Text) (Maybe Text) (Maybe DomainPackageStatus) (Maybe Text) (Maybe ErrorDetails) (Maybe Text) |
Instances
newDomainPackageDetails :: DomainPackageDetails Source #
Create a value of DomainPackageDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastUpdated:DomainPackageDetails', domainPackageDetails_lastUpdated - The timestamp of the most recent update to the package association
status.
$sel:packageID:DomainPackageDetails', domainPackageDetails_packageID - The internal ID of the package.
$sel:packageType:DomainPackageDetails', domainPackageDetails_packageType - Currently supports only TXT-DICTIONARY.
$sel:packageName:DomainPackageDetails', domainPackageDetails_packageName - User-specified name of the package.
$sel:packageVersion:DomainPackageDetails', domainPackageDetails_packageVersion - Undocumented member.
$sel:domainPackageStatus:DomainPackageDetails', domainPackageDetails_domainPackageStatus - State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED,
ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.
$sel:domainName:DomainPackageDetails', domainPackageDetails_domainName - The name of the domain you've associated a package with.
$sel:errorDetails:DomainPackageDetails', domainPackageDetails_errorDetails - Additional information if the package is in an error state. Null
otherwise.
$sel:referencePath:DomainPackageDetails', domainPackageDetails_referencePath - The relative path on Amazon OpenSearch Service nodes, which can be used
as synonym_path when the package is a synonym file.
DomainStatus
data DomainStatus Source #
The current status of a domain.
See: newDomainStatus smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ClusterConfig | |
| -> DomainStatus |
Create a value of DomainStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:eBSOptions:DomainStatus', domainStatus_eBSOptions - The EBSOptions for the specified domain.
$sel:engineVersion:DomainStatus', domainStatus_engineVersion - Undocumented member.
$sel:nodeToNodeEncryptionOptions:DomainStatus', domainStatus_nodeToNodeEncryptionOptions - The status of the NodeToNodeEncryptionOptions.
$sel:accessPolicies:DomainStatus', domainStatus_accessPolicies - IAM access policy as a JSON-formatted string.
$sel:serviceSoftwareOptions:DomainStatus', domainStatus_serviceSoftwareOptions - The current status of the domain's service software.
$sel:autoTuneOptions:DomainStatus', domainStatus_autoTuneOptions - The current status of the domain's Auto-Tune options.
$sel:logPublishingOptions:DomainStatus', domainStatus_logPublishingOptions - Log publishing options for the given domain.
$sel:advancedSecurityOptions:DomainStatus', domainStatus_advancedSecurityOptions - The current status of the domain's advanced security options.
$sel:created:DomainStatus', domainStatus_created - The domain creation status. True if the creation of a domain is
complete. False if domain creation is still in progress.
$sel:snapshotOptions:DomainStatus', domainStatus_snapshotOptions - The status of the SnapshotOptions.
$sel:cognitoOptions:DomainStatus', domainStatus_cognitoOptions - The CognitoOptions for the specified domain. For more information, see
Configuring Amazon Cognito authentication for OpenSearch Dashboards.
$sel:encryptionAtRestOptions:DomainStatus', domainStatus_encryptionAtRestOptions - The status of the EncryptionAtRestOptions.
$sel:deleted:DomainStatus', domainStatus_deleted - 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.
$sel:vPCOptions:DomainStatus', domainStatus_vPCOptions - The VPCOptions for the specified domain. For more information, see
Launching your Amazon OpenSearch Service domains using a VPC.
$sel:endpoints:DomainStatus', domainStatus_endpoints - 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'.
$sel:domainEndpointOptions:DomainStatus', domainStatus_domainEndpointOptions - The current status of the domain's endpoint options.
$sel:processing:DomainStatus', domainStatus_processing - The status of the domain configuration. True if Amazon OpenSearch
Service is processing configuration changes. False if the
configuration is active.
$sel:endpoint:DomainStatus', domainStatus_endpoint - The domain endpoint that you use to submit index and search requests.
$sel:upgradeProcessing:DomainStatus', domainStatus_upgradeProcessing - The status of a domain version upgrade. True if Amazon OpenSearch
Service is undergoing a version upgrade. False if the configuration is
active.
$sel:advancedOptions:DomainStatus', domainStatus_advancedOptions - The status of the AdvancedOptions.
$sel:domainId:DomainStatus', domainStatus_domainId - The unique identifier for the specified domain.
$sel:domainName:DomainStatus', domainStatus_domainName - 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).
$sel:arn:DomainStatus', domainStatus_arn - The Amazon Resource Name (ARN) of a domain. See
IAM identifiers
in the AWS Identity and Access Management User Guide for more
information.
$sel:clusterConfig:DomainStatus', domainStatus_clusterConfig - The type and number of instances in the domain.
Duration
The maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
See: newDuration smart constructor.
Instances
| Eq Duration Source # | |
| Read Duration Source # | |
| Show Duration Source # | |
| Generic Duration Source # | |
| NFData Duration Source # | |
Defined in Amazonka.OpenSearch.Types.Duration | |
| Hashable Duration Source # | |
Defined in Amazonka.OpenSearch.Types.Duration | |
| ToJSON Duration Source # | |
Defined in Amazonka.OpenSearch.Types.Duration | |
| FromJSON Duration Source # | |
| type Rep Duration Source # | |
Defined in Amazonka.OpenSearch.Types.Duration type Rep Duration = D1 ('MetaData "Duration" "Amazonka.OpenSearch.Types.Duration" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "Duration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeUnit)))) | |
newDuration :: Duration Source #
Create a value of Duration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Duration', duration_value - Integer to specify the value of a maintenance schedule duration. See
Auto-Tune for Amazon OpenSearch Service
for more information.
$sel:unit:Duration', duration_unit - The unit of a maintenance schedule duration. Valid value is HOURS. See
Auto-Tune for Amazon OpenSearch Service
for more information.
EBSOptions
data EBSOptions Source #
Options to enable, disable, and specify the properties of EBS storage volumes.
See: newEBSOptions smart constructor.
Constructors
| EBSOptions' (Maybe Int) (Maybe Int) (Maybe VolumeType) (Maybe Bool) |
Instances
newEBSOptions :: EBSOptions Source #
Create a value of EBSOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumeSize:EBSOptions', eBSOptions_volumeSize - Integer to specify the size of an EBS volume.
$sel:iops:EBSOptions', eBSOptions_iops - The IOPD for a Provisioned IOPS EBS volume (SSD).
$sel:volumeType:EBSOptions', eBSOptions_volumeType - The volume type for EBS-based storage.
$sel:eBSEnabled:EBSOptions', eBSOptions_eBSEnabled - Whether EBS-based storage is enabled.
EBSOptionsStatus
data EBSOptionsStatus Source #
Status of the EBS options for the specified domain.
See: newEBSOptionsStatus smart constructor.
Constructors
| EBSOptionsStatus' EBSOptions OptionStatus |
Instances
Arguments
| :: EBSOptions | |
| -> OptionStatus | |
| -> EBSOptionsStatus |
Create a value of EBSOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:EBSOptionsStatus', eBSOptionsStatus_options - The EBS options for the specified domain.
$sel:status:EBSOptionsStatus', eBSOptionsStatus_status - The status of the EBS options for the specified domain.
EncryptionAtRestOptions
data EncryptionAtRestOptions Source #
Specifies encryption at rest options.
See: newEncryptionAtRestOptions smart constructor.
Constructors
| EncryptionAtRestOptions' (Maybe Bool) (Maybe Text) |
Instances
newEncryptionAtRestOptions :: EncryptionAtRestOptions Source #
Create a value of EncryptionAtRestOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:EncryptionAtRestOptions', encryptionAtRestOptions_enabled - The option to enable encryption at rest.
$sel:kmsKeyId:EncryptionAtRestOptions', encryptionAtRestOptions_kmsKeyId - The KMS key ID for encryption at rest options.
EncryptionAtRestOptionsStatus
data EncryptionAtRestOptionsStatus Source #
Status of the encryption At Rest options for the specified domain.
See: newEncryptionAtRestOptionsStatus smart constructor.
Instances
newEncryptionAtRestOptionsStatus Source #
Arguments
| :: EncryptionAtRestOptions | |
| -> OptionStatus | |
| -> EncryptionAtRestOptionsStatus |
Create a value of EncryptionAtRestOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:EncryptionAtRestOptionsStatus', encryptionAtRestOptionsStatus_options - The Encryption At Rest options for the specified domain.
$sel:status:EncryptionAtRestOptionsStatus', encryptionAtRestOptionsStatus_status - The status of the Encryption At Rest options for the specified domain.
ErrorDetails
data ErrorDetails Source #
See: newErrorDetails smart constructor.
Constructors
| ErrorDetails' (Maybe Text) (Maybe Text) |
Instances
newErrorDetails :: ErrorDetails Source #
Create a value of ErrorDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorType:ErrorDetails', errorDetails_errorType - Undocumented member.
$sel:errorMessage:ErrorDetails', errorDetails_errorMessage - Undocumented member.
Filter
A filter used to limit results when describing inbound or outbound cross-cluster connections. Multiple values can be specified per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.
See: newFilter smart constructor.
Instances
| Eq Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| Generic Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.OpenSearch.Types.Filter | |
| Hashable Filter Source # | |
Defined in Amazonka.OpenSearch.Types.Filter | |
| ToJSON Filter Source # | |
Defined in Amazonka.OpenSearch.Types.Filter | |
| type Rep Filter Source # | |
Defined in Amazonka.OpenSearch.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.OpenSearch.Types.Filter" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Filter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:values:Filter', filter_values - Contains one or more values for the filter.
$sel:name:Filter', filter_name - The name of the filter.
InboundConnection
data InboundConnection Source #
Details of an inbound connection.
See: newInboundConnection smart constructor.
Constructors
| InboundConnection' (Maybe DomainInformationContainer) (Maybe DomainInformationContainer) (Maybe Text) (Maybe InboundConnectionStatus) |
Instances
newInboundConnection :: InboundConnection Source #
Create a value of InboundConnection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:remoteDomainInfo:InboundConnection', inboundConnection_remoteDomainInfo - The AWSDomainInformation for the remote OpenSearch domain.
$sel:localDomainInfo:InboundConnection', inboundConnection_localDomainInfo - The AWSDomainInformation for the local OpenSearch domain.
$sel:connectionId:InboundConnection', inboundConnection_connectionId - The connection ID for the inbound cross-cluster connection.
$sel:connectionStatus:InboundConnection', inboundConnection_connectionStatus - The InboundConnectionStatus for the outbound connection.
InboundConnectionStatus
data InboundConnectionStatus Source #
The connection status of an inbound cross-cluster connection.
See: newInboundConnectionStatus smart constructor.
Constructors
| InboundConnectionStatus' (Maybe Text) (Maybe InboundConnectionStatusCode) |
Instances
newInboundConnectionStatus :: InboundConnectionStatus Source #
Create a value of InboundConnectionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:InboundConnectionStatus', inboundConnectionStatus_message - Verbose information for the inbound connection status.
$sel:statusCode:InboundConnectionStatus', inboundConnectionStatus_statusCode - 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
data InstanceCountLimits Source #
InstanceCountLimits represents the limits on the number of instances that can be created in Amazon OpenSearch Service for a given InstanceType.
See: newInstanceCountLimits smart constructor.
Constructors
| InstanceCountLimits' (Maybe Int) (Maybe Int) |
Instances
newInstanceCountLimits :: InstanceCountLimits Source #
Create a value of InstanceCountLimits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maximumInstanceCount:InstanceCountLimits', instanceCountLimits_maximumInstanceCount - Undocumented member.
$sel:minimumInstanceCount:InstanceCountLimits', instanceCountLimits_minimumInstanceCount - Undocumented member.
InstanceLimits
data InstanceLimits Source #
InstanceLimits represents the list of instance-related attributes that are available for a given InstanceType.
See: newInstanceLimits smart constructor.
Constructors
| InstanceLimits' (Maybe InstanceCountLimits) |
Instances
newInstanceLimits :: InstanceLimits Source #
Create a value of InstanceLimits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceCountLimits:InstanceLimits', instanceLimits_instanceCountLimits - Undocumented member.
InstanceTypeDetails
data InstanceTypeDetails Source #
See: newInstanceTypeDetails smart constructor.
Constructors
| InstanceTypeDetails' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe OpenSearchPartitionInstanceType) (Maybe Bool) (Maybe Bool) (Maybe Bool) |
Instances
newInstanceTypeDetails :: InstanceTypeDetails Source #
Create a value of InstanceTypeDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encryptionEnabled:InstanceTypeDetails', instanceTypeDetails_encryptionEnabled - Undocumented member.
$sel:cognitoEnabled:InstanceTypeDetails', instanceTypeDetails_cognitoEnabled - Undocumented member.
$sel:instanceRole:InstanceTypeDetails', instanceTypeDetails_instanceRole - Undocumented member.
$sel:instanceType:InstanceTypeDetails', instanceTypeDetails_instanceType - Undocumented member.
$sel:warmEnabled:InstanceTypeDetails', instanceTypeDetails_warmEnabled - Undocumented member.
$sel:advancedSecurityEnabled:InstanceTypeDetails', instanceTypeDetails_advancedSecurityEnabled - Undocumented member.
$sel:appLogsEnabled:InstanceTypeDetails', instanceTypeDetails_appLogsEnabled - Undocumented member.
Limits
Limits for a given InstanceType and for each of its roles.
Limits contains the following: StorageTypes , InstanceLimits , and
AdditionalLimits
See: newLimits smart constructor.
Constructors
| Limits' (Maybe InstanceLimits) (Maybe [AdditionalLimit]) (Maybe [StorageType]) |
Instances
| Eq Limits Source # | |
| Read Limits Source # | |
| Show Limits Source # | |
| Generic Limits Source # | |
| NFData Limits Source # | |
Defined in Amazonka.OpenSearch.Types.Limits | |
| Hashable Limits Source # | |
Defined in Amazonka.OpenSearch.Types.Limits | |
| FromJSON Limits Source # | |
| type Rep Limits Source # | |
Defined in Amazonka.OpenSearch.Types.Limits type Rep Limits = D1 ('MetaData "Limits" "Amazonka.OpenSearch.Types.Limits" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "Limits'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceLimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceLimits)) :*: (S1 ('MetaSel ('Just "additionalLimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdditionalLimit])) :*: S1 ('MetaSel ('Just "storageTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StorageType]))))) | |
Create a value of Limits with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceLimits:Limits', limits_instanceLimits - Undocumented member.
$sel:additionalLimits:Limits', limits_additionalLimits - List of additional limits that are specific to a given InstanceType and
for each of its InstanceRole .
$sel:storageTypes:Limits', limits_storageTypes - Storage-related types and attributes that are available for a given
InstanceType.
LogPublishingOption
data LogPublishingOption Source #
Log Publishing option that is set for a given domain. Attributes and their details:
- CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
- Enabled: Whether the log publishing for a given log type is enabled or not.
See: newLogPublishingOption smart constructor.
Constructors
| LogPublishingOption' (Maybe Bool) (Maybe Text) |
Instances
newLogPublishingOption :: LogPublishingOption Source #
Create a value of LogPublishingOption with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:LogPublishingOption', logPublishingOption_enabled - Whether the given log publishing option is enabled or not.
$sel:cloudWatchLogsLogGroupArn:LogPublishingOption', logPublishingOption_cloudWatchLogsLogGroupArn - Undocumented member.
LogPublishingOptionsStatus
data LogPublishingOptionsStatus Source #
The configured log publishing options for the domain and their current status.
See: newLogPublishingOptionsStatus smart constructor.
Constructors
| LogPublishingOptionsStatus' (Maybe OptionStatus) (Maybe (HashMap LogType LogPublishingOption)) |
Instances
newLogPublishingOptionsStatus :: LogPublishingOptionsStatus Source #
Create a value of LogPublishingOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:LogPublishingOptionsStatus', logPublishingOptionsStatus_status - The status of the log publishing options for the domain. See
OptionStatus for the status information that's included.
$sel:options:LogPublishingOptionsStatus', logPublishingOptionsStatus_options - The log publishing options configured for the domain.
MasterUserOptions
data MasterUserOptions Source #
Credentials for the master user: username and password, ARN, or both.
See: newMasterUserOptions smart constructor.
Instances
newMasterUserOptions :: MasterUserOptions Source #
Create a value of MasterUserOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:masterUserPassword:MasterUserOptions', masterUserOptions_masterUserPassword - The master user's password, which is stored in the Amazon OpenSearch
Service domain's internal database.
$sel:masterUserName:MasterUserOptions', masterUserOptions_masterUserName - The master user's username, which is stored in the Amazon OpenSearch
Service domain's internal database.
$sel:masterUserARN:MasterUserOptions', masterUserOptions_masterUserARN - ARN for the master user (if IAM is enabled).
NodeToNodeEncryptionOptions
data NodeToNodeEncryptionOptions Source #
The node-to-node encryption options.
See: newNodeToNodeEncryptionOptions smart constructor.
Constructors
| NodeToNodeEncryptionOptions' (Maybe Bool) |
Instances
newNodeToNodeEncryptionOptions :: NodeToNodeEncryptionOptions Source #
Create a value of NodeToNodeEncryptionOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:NodeToNodeEncryptionOptions', nodeToNodeEncryptionOptions_enabled - True to enable node-to-node encryption.
NodeToNodeEncryptionOptionsStatus
data NodeToNodeEncryptionOptionsStatus Source #
Status of the node-to-node encryption options for the specified domain.
See: newNodeToNodeEncryptionOptionsStatus smart constructor.
Instances
newNodeToNodeEncryptionOptionsStatus Source #
Arguments
| :: NodeToNodeEncryptionOptions | |
| -> OptionStatus | |
| -> NodeToNodeEncryptionOptionsStatus |
Create a value of NodeToNodeEncryptionOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:NodeToNodeEncryptionOptionsStatus', nodeToNodeEncryptionOptionsStatus_options - The node-to-node encryption options for the specified domain.
$sel:status:NodeToNodeEncryptionOptionsStatus', nodeToNodeEncryptionOptionsStatus_status - The status of the node-to-node encryption options for the specified
domain.
OptionStatus
data OptionStatus Source #
Provides the current status of the entity.
See: newOptionStatus smart constructor.
Constructors
| OptionStatus' (Maybe Bool) (Maybe Natural) POSIX POSIX OptionState |
Instances
Arguments
| :: UTCTime | |
| -> UTCTime | |
| -> OptionState | |
| -> OptionStatus |
Create a value of OptionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pendingDeletion:OptionStatus', optionStatus_pendingDeletion - Indicates whether the domain is being deleted.
$sel:updateVersion:OptionStatus', optionStatus_updateVersion - The latest version of the entity.
$sel:creationDate:OptionStatus', optionStatus_creationDate - The timestamp of when the entity was created.
$sel:updateDate:OptionStatus', optionStatus_updateDate - The timestamp of the last time the entity was updated.
$sel:state:OptionStatus', optionStatus_state - Provides the OptionState for the domain.
OutboundConnection
data OutboundConnection Source #
Specifies details about an outbound connection.
See: newOutboundConnection smart constructor.
Constructors
| OutboundConnection' (Maybe DomainInformationContainer) (Maybe Text) (Maybe DomainInformationContainer) (Maybe Text) (Maybe OutboundConnectionStatus) |
Instances
newOutboundConnection :: OutboundConnection Source #
Create a value of OutboundConnection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:remoteDomainInfo:OutboundConnection', outboundConnection_remoteDomainInfo - The DomainInformation for the remote OpenSearch domain.
$sel:connectionAlias:OutboundConnection', outboundConnection_connectionAlias - The connection alias for the outbound cross-cluster connection.
$sel:localDomainInfo:OutboundConnection', outboundConnection_localDomainInfo - The DomainInformation for the local OpenSearch domain.
$sel:connectionId:OutboundConnection', outboundConnection_connectionId - The connection ID for the outbound cross-cluster connection.
$sel:connectionStatus:OutboundConnection', outboundConnection_connectionStatus - The OutboundConnectionStatus for the outbound connection.
OutboundConnectionStatus
data OutboundConnectionStatus Source #
The connection status of an outbound cross-cluster connection.
See: newOutboundConnectionStatus smart constructor.
Constructors
| OutboundConnectionStatus' (Maybe Text) (Maybe OutboundConnectionStatusCode) |
Instances
newOutboundConnectionStatus :: OutboundConnectionStatus Source #
Create a value of OutboundConnectionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:OutboundConnectionStatus', outboundConnectionStatus_message - Verbose information for the outbound connection status.
$sel:statusCode:OutboundConnectionStatus', outboundConnectionStatus_statusCode - 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
data PackageDetails Source #
Basic information about a package.
See: newPackageDetails smart constructor.
Constructors
| PackageDetails' (Maybe Text) (Maybe PackageType) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe PackageStatus) (Maybe Text) (Maybe ErrorDetails) (Maybe Text) |
Instances
newPackageDetails :: PackageDetails Source #
Create a value of PackageDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:packageID:PackageDetails', packageDetails_packageID - Internal ID of the package.
$sel:packageType:PackageDetails', packageDetails_packageType - Currently supports only TXT-DICTIONARY.
$sel:lastUpdatedAt:PackageDetails', packageDetails_lastUpdatedAt - Undocumented member.
$sel:createdAt:PackageDetails', packageDetails_createdAt - The timestamp of when the package was created.
$sel:packageName:PackageDetails', packageDetails_packageName - User-specified name of the package.
$sel:packageStatus:PackageDetails', packageDetails_packageStatus - Current state of the package. Values are COPYING, COPY_FAILED,
AVAILABLE, DELETING, and DELETE_FAILED.
$sel:packageDescription:PackageDetails', packageDetails_packageDescription - User-specified description of the package.
$sel:errorDetails:PackageDetails', packageDetails_errorDetails - Additional information if the package is in an error state. Null
otherwise.
$sel:availablePackageVersion:PackageDetails', packageDetails_availablePackageVersion - Undocumented member.
PackageSource
data PackageSource Source #
The Amazon S3 location for importing the package specified as
S3BucketName and S3Key
See: newPackageSource smart constructor.
Constructors
| PackageSource' (Maybe Text) (Maybe Text) |
Instances
newPackageSource :: PackageSource Source #
Create a value of PackageSource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Key:PackageSource', packageSource_s3Key - Key (file name) of the package.
$sel:s3BucketName:PackageSource', packageSource_s3BucketName - The name of the Amazon S3 bucket containing the package.
PackageVersionHistory
data PackageVersionHistory Source #
Details of a package version.
See: newPackageVersionHistory smart constructor.
Instances
newPackageVersionHistory :: PackageVersionHistory Source #
Create a value of PackageVersionHistory with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdAt:PackageVersionHistory', packageVersionHistory_createdAt - The timestamp of when the package was created.
$sel:packageVersion:PackageVersionHistory', packageVersionHistory_packageVersion - The package version.
$sel:commitMessage:PackageVersionHistory', packageVersionHistory_commitMessage - A message associated with the package version.
RecurringCharge
data RecurringCharge Source #
Contains the specific price and frequency of a recurring charges for a reserved OpenSearch instance, or for a reserved OpenSearch instance offering.
See: newRecurringCharge smart constructor.
Constructors
| RecurringCharge' (Maybe Text) (Maybe Double) |
Instances
newRecurringCharge :: RecurringCharge Source #
Create a value of RecurringCharge with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recurringChargeFrequency:RecurringCharge', recurringCharge_recurringChargeFrequency - The frequency of the recurring charge.
$sel:recurringChargeAmount:RecurringCharge', recurringCharge_recurringChargeAmount - The monetary amount of the recurring charge.
ReservedInstance
data ReservedInstance Source #
Details of a reserved OpenSearch instance.
See: newReservedInstance smart constructor.
Constructors
| ReservedInstance' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe POSIX) (Maybe OpenSearchPartitionInstanceType) (Maybe Text) (Maybe Integer) (Maybe [RecurringCharge]) (Maybe Double) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Int) (Maybe ReservedInstancePaymentOption) |
Instances
newReservedInstance :: ReservedInstance Source #
Create a value of ReservedInstance with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:state:ReservedInstance', reservedInstance_state - The state of the reserved OpenSearch instance.
$sel:currencyCode:ReservedInstance', reservedInstance_currencyCode - The currency code for the reserved OpenSearch instance offering.
$sel:instanceCount:ReservedInstance', reservedInstance_instanceCount - The number of OpenSearch instances that have been reserved.
$sel:startTime:ReservedInstance', reservedInstance_startTime - The time the reservation started.
$sel:instanceType:ReservedInstance', reservedInstance_instanceType - The OpenSearch instance type offered by the reserved instance offering.
$sel:reservationName:ReservedInstance', reservedInstance_reservationName - The customer-specified identifier to track this reservation.
$sel:billingSubscriptionId:ReservedInstance', reservedInstance_billingSubscriptionId - Undocumented member.
$sel:recurringCharges:ReservedInstance', reservedInstance_recurringCharges - The charge to your account regardless of whether you are creating any
domains using the instance offering.
$sel:usagePrice:ReservedInstance', reservedInstance_usagePrice - The rate you are charged for each hour for the domain that is using this
reserved instance.
$sel:reservedInstanceId:ReservedInstance', reservedInstance_reservedInstanceId - The unique identifier for the reservation.
$sel:reservedInstanceOfferingId:ReservedInstance', reservedInstance_reservedInstanceOfferingId - The offering identifier.
$sel:fixedPrice:ReservedInstance', reservedInstance_fixedPrice - The upfront fixed charge you will paid to purchase the specific reserved
OpenSearch instance offering.
$sel:duration:ReservedInstance', reservedInstance_duration - The duration, in seconds, for which the OpenSearch instance is reserved.
$sel:paymentOption:ReservedInstance', reservedInstance_paymentOption - The payment option as defined in the reserved OpenSearch instance
offering.
ReservedInstanceOffering
data ReservedInstanceOffering Source #
Details of a reserved OpenSearch instance offering.
See: newReservedInstanceOffering smart constructor.
Constructors
| ReservedInstanceOffering' (Maybe Text) (Maybe OpenSearchPartitionInstanceType) (Maybe [RecurringCharge]) (Maybe Double) (Maybe Text) (Maybe Double) (Maybe Int) (Maybe ReservedInstancePaymentOption) |
Instances
newReservedInstanceOffering :: ReservedInstanceOffering Source #
Create a value of ReservedInstanceOffering with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:currencyCode:ReservedInstanceOffering', reservedInstanceOffering_currencyCode - The currency code for the reserved OpenSearch instance offering.
$sel:instanceType:ReservedInstanceOffering', reservedInstanceOffering_instanceType - The OpenSearch instance type offered by the reserved instance offering.
$sel:recurringCharges:ReservedInstanceOffering', reservedInstanceOffering_recurringCharges - The charge to your account regardless of whether you are creating any
domains using the instance offering.
$sel:usagePrice:ReservedInstanceOffering', reservedInstanceOffering_usagePrice - The rate you are charged for each hour the domain that is using the
offering is running.
$sel:reservedInstanceOfferingId:ReservedInstanceOffering', reservedInstanceOffering_reservedInstanceOfferingId - The OpenSearch reserved instance offering identifier.
$sel:fixedPrice:ReservedInstanceOffering', reservedInstanceOffering_fixedPrice - The upfront fixed charge you will pay to purchase the specific reserved
OpenSearch instance offering.
$sel:duration:ReservedInstanceOffering', reservedInstanceOffering_duration - The duration, in seconds, for which the offering will reserve the
OpenSearch instance.
$sel:paymentOption:ReservedInstanceOffering', reservedInstanceOffering_paymentOption - Payment option for the reserved OpenSearch instance offering
SAMLIdp
The SAML identity povider's information.
See: newSAMLIdp smart constructor.
Instances
| Eq SAMLIdp Source # | |
| Read SAMLIdp Source # | |
| Show SAMLIdp Source # | |
| Generic SAMLIdp Source # | |
| NFData SAMLIdp Source # | |
Defined in Amazonka.OpenSearch.Types.SAMLIdp | |
| Hashable SAMLIdp Source # | |
Defined in Amazonka.OpenSearch.Types.SAMLIdp | |
| ToJSON SAMLIdp Source # | |
Defined in Amazonka.OpenSearch.Types.SAMLIdp | |
| FromJSON SAMLIdp Source # | |
| type Rep SAMLIdp Source # | |
Defined in Amazonka.OpenSearch.Types.SAMLIdp type Rep SAMLIdp = D1 ('MetaData "SAMLIdp" "Amazonka.OpenSearch.Types.SAMLIdp" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "SAMLIdp'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metadataContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of SAMLIdp with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metadataContent:SAMLIdp', sAMLIdp_metadataContent - The metadata of the SAML application in XML format.
$sel:entityId:SAMLIdp', sAMLIdp_entityId - The unique entity ID of the application in SAML identity provider.
SAMLOptionsInput
data SAMLOptionsInput Source #
The SAML application configuration for the domain.
See: newSAMLOptionsInput smart constructor.
Constructors
| SAMLOptionsInput' (Maybe (Sensitive Text)) (Maybe Bool) (Maybe SAMLIdp) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) |
Instances
newSAMLOptionsInput :: SAMLOptionsInput Source #
Create a value of SAMLOptionsInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:masterUserName:SAMLOptionsInput', sAMLOptionsInput_masterUserName - The SAML master username, which is stored in the Amazon OpenSearch
Service domain's internal database.
$sel:enabled:SAMLOptionsInput', sAMLOptionsInput_enabled - True if SAML is enabled.
$sel:idp:SAMLOptionsInput', sAMLOptionsInput_idp - The SAML Identity Provider's information.
$sel:rolesKey:SAMLOptionsInput', sAMLOptionsInput_rolesKey - Element of the SAML assertion to use for backend roles. Default is
roles.
$sel:masterBackendRole:SAMLOptionsInput', sAMLOptionsInput_masterBackendRole - The backend role that the SAML master user is mapped to.
$sel:sessionTimeoutMinutes:SAMLOptionsInput', sAMLOptionsInput_sessionTimeoutMinutes - The duration, in minutes, after which a user session becomes inactive.
Acceptable values are between 1 and 1440, and the default value is 60.
$sel:subjectKey:SAMLOptionsInput', sAMLOptionsInput_subjectKey - Element of the SAML assertion to use for username. Default is NameID.
SAMLOptionsOutput
data SAMLOptionsOutput Source #
Describes the SAML application configured for the domain.
See: newSAMLOptionsOutput smart constructor.
Instances
newSAMLOptionsOutput :: SAMLOptionsOutput Source #
Create a value of SAMLOptionsOutput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:SAMLOptionsOutput', sAMLOptionsOutput_enabled - True if SAML is enabled.
$sel:idp:SAMLOptionsOutput', sAMLOptionsOutput_idp - Describes the SAML identity provider's information.
$sel:rolesKey:SAMLOptionsOutput', sAMLOptionsOutput_rolesKey - The key used for matching the SAML roles attribute.
$sel:sessionTimeoutMinutes:SAMLOptionsOutput', sAMLOptionsOutput_sessionTimeoutMinutes - The duration, in minutes, after which a user session becomes inactive.
$sel:subjectKey:SAMLOptionsOutput', sAMLOptionsOutput_subjectKey - The key used for matching the SAML subject attribute.
ScheduledAutoTuneDetails
data ScheduledAutoTuneDetails Source #
Specifies details about the scheduled Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
See: newScheduledAutoTuneDetails smart constructor.
Constructors
| ScheduledAutoTuneDetails' (Maybe ScheduledAutoTuneSeverityType) (Maybe Text) (Maybe POSIX) (Maybe ScheduledAutoTuneActionType) |
Instances
newScheduledAutoTuneDetails :: ScheduledAutoTuneDetails Source #
Create a value of ScheduledAutoTuneDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:severity:ScheduledAutoTuneDetails', scheduledAutoTuneDetails_severity - The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.
$sel:action:ScheduledAutoTuneDetails', scheduledAutoTuneDetails_action - The Auto-Tune action description.
$sel:date:ScheduledAutoTuneDetails', scheduledAutoTuneDetails_date - The timestamp of the Auto-Tune action scheduled for the domain.
$sel:actionType:ScheduledAutoTuneDetails', scheduledAutoTuneDetails_actionType - The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and
JVM_YOUNG_GEN_TUNING.
ServiceSoftwareOptions
data ServiceSoftwareOptions Source #
The current options of an domain service software options.
See: newServiceSoftwareOptions smart constructor.
Constructors
| ServiceSoftwareOptions' (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe DeploymentStatus) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) |
Instances
newServiceSoftwareOptions :: ServiceSoftwareOptions Source #
Create a value of ServiceSoftwareOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automatedUpdateDate:ServiceSoftwareOptions', serviceSoftwareOptions_automatedUpdateDate - The timestamp, in Epoch time, until which you can manually request a
service software update. After this date, we automatically update your
service software.
$sel:currentVersion:ServiceSoftwareOptions', serviceSoftwareOptions_currentVersion - The current service software version present on the domain.
$sel:optionalDeployment:ServiceSoftwareOptions', serviceSoftwareOptions_optionalDeployment - True if a service software is never automatically updated. False if
a service software is automatically updated after AutomatedUpdateDate.
$sel:updateStatus:ServiceSoftwareOptions', serviceSoftwareOptions_updateStatus - The status of your service software update. This field can take the
following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS,
COMPLETED, and NOT_ELIGIBLE.
$sel:cancellable:ServiceSoftwareOptions', serviceSoftwareOptions_cancellable - True if you're able to cancel your service software version update.
False if you can't cancel your service software update.
$sel:updateAvailable:ServiceSoftwareOptions', serviceSoftwareOptions_updateAvailable - True if you're able to update your service software version. False
if you can't update your service software version.
$sel:description:ServiceSoftwareOptions', serviceSoftwareOptions_description - The description of the UpdateStatus.
$sel:newVersion':ServiceSoftwareOptions', serviceSoftwareOptions_newVersion - The new service software version if one is available.
SnapshotOptions
data SnapshotOptions Source #
The time, in UTC format, when the service takes a daily automated
snapshot of the specified domain. Default is 0 hours.
See: newSnapshotOptions smart constructor.
Constructors
| SnapshotOptions' (Maybe Int) |
Instances
newSnapshotOptions :: SnapshotOptions Source #
Create a value of SnapshotOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:automatedSnapshotStartHour:SnapshotOptions', snapshotOptions_automatedSnapshotStartHour - The time, in UTC format, when the service takes a daily automated
snapshot of the specified domain. Default is 0 hours.
SnapshotOptionsStatus
data SnapshotOptionsStatus Source #
Status of a daily automated snapshot.
See: newSnapshotOptionsStatus smart constructor.
Constructors
| SnapshotOptionsStatus' SnapshotOptions OptionStatus |
Instances
newSnapshotOptionsStatus Source #
Arguments
| :: SnapshotOptions | |
| -> OptionStatus | |
| -> SnapshotOptionsStatus |
Create a value of SnapshotOptionsStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:SnapshotOptionsStatus', snapshotOptionsStatus_options - The daily snapshot options specified for the domain.
$sel:status:SnapshotOptionsStatus', snapshotOptionsStatus_status - The status of a daily automated snapshot.
StorageType
data StorageType Source #
StorageTypes represents the list of storage-related types and their attributes that are available for a given InstanceType.
See: newStorageType smart constructor.
Constructors
| StorageType' (Maybe [StorageTypeLimit]) (Maybe Text) (Maybe Text) |
Instances
newStorageType :: StorageType Source #
Create a value of StorageType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:storageTypeLimits:StorageType', storageType_storageTypeLimits - Limits that are applicable for the given storage type.
$sel:storageSubTypeName:StorageType', storageType_storageSubTypeName - Undocumented member.
$sel:storageTypeName:StorageType', storageType_storageTypeName - Undocumented member.
StorageTypeLimit
data StorageTypeLimit Source #
Limits that are applicable for the given storage type.
See: newStorageTypeLimit smart constructor.
Constructors
| StorageTypeLimit' (Maybe Text) (Maybe [Text]) |
Instances
newStorageTypeLimit :: StorageTypeLimit Source #
Create a value of StorageTypeLimit with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:limitName:StorageTypeLimit', storageTypeLimit_limitName - Name of storage limits that are applicable for the given storage type.
If StorageType is "ebs", the following storage options are
applicable:
- MinimumVolumeSize
- MaximumVolumeSize
- MaximumIops
- MinimumIops
$sel:limitValues:StorageTypeLimit', storageTypeLimit_limitValues - Values for the StorageTypeLimit$LimitName .
Tag
A key value pair for a resource tag.
See: newTag smart constructor.
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.OpenSearch.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.OpenSearch.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.OpenSearch.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.OpenSearch.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.OpenSearch.Types.Tag" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag', tag_key - The TagKey, the name of the tag. Tag keys must be unique for the
domain to which they are attached.
$sel:value:Tag', tag_value - 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
data UpgradeHistory Source #
History of the last 10 upgrades and upgrade eligibility checks.
See: newUpgradeHistory smart constructor.
Constructors
| UpgradeHistory' (Maybe UpgradeStatus) (Maybe [UpgradeStepItem]) (Maybe Text) (Maybe POSIX) |
Instances
newUpgradeHistory :: UpgradeHistory Source #
Create a value of UpgradeHistory with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:upgradeStatus:UpgradeHistory', upgradeHistory_upgradeStatus - The current status of the upgrade. The status can take one of the
following values:
- In Progress
- Succeeded
- Succeeded with Issues
- Failed
$sel:stepsList:UpgradeHistory', upgradeHistory_stepsList - A list of UpgradeStepItem s representing information about each step
performed as part of a specific upgrade or upgrade eligibility check.
$sel:upgradeName:UpgradeHistory', upgradeHistory_upgradeName - A string that briefly describes the upgrade.
$sel:startTimestamp:UpgradeHistory', upgradeHistory_startTimestamp - UTC timestamp at which the upgrade API call was made in
"yyyy-MM-ddTHH:mm:ssZ" format.
UpgradeStepItem
data UpgradeStepItem Source #
Represents a single step of the upgrade or upgrade eligibility check workflow.
See: newUpgradeStepItem smart constructor.
Constructors
| UpgradeStepItem' (Maybe UpgradeStatus) (Maybe Double) (Maybe [Text]) (Maybe UpgradeStep) |
Instances
newUpgradeStepItem :: UpgradeStepItem Source #
Create a value of UpgradeStepItem with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:upgradeStepStatus:UpgradeStepItem', upgradeStepItem_upgradeStepStatus - The current status of the upgrade. The status can take one of the
following values:
- In Progress
- Succeeded
- Succeeded with Issues
- Failed
$sel:progressPercent:UpgradeStepItem', upgradeStepItem_progressPercent - The floating point value representing the progress percentage of a
particular step.
$sel:issues:UpgradeStepItem', upgradeStepItem_issues - A list of strings containing detailed information about the errors
encountered in a particular step.
$sel:upgradeStep:UpgradeStepItem', upgradeStepItem_upgradeStep - One of three steps an upgrade or upgrade eligibility check goes through:
- PreUpgradeCheck
- Snapshot
- Upgrade
VPCDerivedInfo
data VPCDerivedInfo 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.
See: newVPCDerivedInfo smart constructor.
Instances
newVPCDerivedInfo :: VPCDerivedInfo Source #
Create a value of VPCDerivedInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityGroupIds:VPCDerivedInfo', vPCDerivedInfo_securityGroupIds - The security groups for the VPC endpoint.
$sel:subnetIds:VPCDerivedInfo', vPCDerivedInfo_subnetIds - The subnets for the VPC endpoint.
$sel:vPCId:VPCDerivedInfo', vPCDerivedInfo_vPCId - The VPC ID for the domain. Exists only if the domain was created with
VPCOptions.
$sel:availabilityZones:VPCDerivedInfo', vPCDerivedInfo_availabilityZones - The Availability Zones for the domain. Exists only if the domain was
created with VPCOptions.
VPCDerivedInfoStatus
data VPCDerivedInfoStatus Source #
Status of the VPC options for the specified domain.
See: newVPCDerivedInfoStatus smart constructor.
Constructors
| VPCDerivedInfoStatus' VPCDerivedInfo OptionStatus |
Instances
newVPCDerivedInfoStatus Source #
Arguments
| :: VPCDerivedInfo | |
| -> OptionStatus | |
| -> VPCDerivedInfoStatus |
Create a value of VPCDerivedInfoStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:VPCDerivedInfoStatus', vPCDerivedInfoStatus_options - The VPC options for the specified domain.
$sel:status:VPCDerivedInfoStatus', vPCDerivedInfoStatus_status - The status of the VPC options for the specified domain.
VPCOptions
data 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.
See: newVPCOptions smart constructor.
Constructors
| VPCOptions' (Maybe [Text]) (Maybe [Text]) |
Instances
newVPCOptions :: VPCOptions Source #
Create a value of VPCOptions with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityGroupIds:VPCOptions', vPCOptions_securityGroupIds - The security groups for the VPC endpoint.
$sel:subnetIds:VPCOptions', vPCOptions_subnetIds - The subnets for the VPC endpoint.
VersionStatus
data VersionStatus Source #
The status of the OpenSearch version options for the specified OpenSearch domain.
See: newVersionStatus smart constructor.
Constructors
| VersionStatus' Text OptionStatus |
Instances
Arguments
| :: Text | |
| -> OptionStatus | |
| -> VersionStatus |
Create a value of VersionStatus with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:options:VersionStatus', versionStatus_options - The OpenSearch version for the specified OpenSearch domain.
$sel:status:VersionStatus', versionStatus_status - The status of the OpenSearch version options for the specified
OpenSearch domain.
ZoneAwarenessConfig
data ZoneAwarenessConfig Source #
The zone awareness configuration for the domain cluster, such as the number of availability zones.
See: newZoneAwarenessConfig smart constructor.
Constructors
| ZoneAwarenessConfig' (Maybe Int) |
Instances
newZoneAwarenessConfig :: ZoneAwarenessConfig Source #
Create a value of ZoneAwarenessConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:availabilityZoneCount:ZoneAwarenessConfig', zoneAwarenessConfig_availabilityZoneCount - 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.