Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- AcceptInboundConnection
- AddTags
- AssociatePackage
- AuthorizeVpcEndpointAccess
- CancelServiceSoftwareUpdate
- CreateDomain
- CreateOutboundConnection
- CreatePackage
- CreateVpcEndpoint
- DeleteDomain
- DeleteInboundConnection
- DeleteOutboundConnection
- DeletePackage
- DeleteVpcEndpoint
- DescribeDomain
- DescribeDomainAutoTunes
- DescribeDomainChangeProgress
- DescribeDomainConfig
- DescribeDomains
- DescribeInboundConnections
- DescribeInstanceTypeLimits
- DescribeOutboundConnections
- DescribePackages
- DescribeReservedInstanceOfferings
- DescribeReservedInstances
- DescribeVpcEndpoints
- DissociatePackage
- GetCompatibleVersions
- GetPackageVersionHistory
- GetUpgradeHistory
- GetUpgradeStatus
- ListDomainNames
- ListDomainsForPackage
- ListInstanceTypeDetails
- ListPackagesForDomain
- ListTags
- ListVersions
- ListVpcEndpointAccess
- ListVpcEndpoints
- ListVpcEndpointsForDomain
- PurchaseReservedInstanceOffering
- RejectInboundConnection
- RemoveTags
- RevokeVpcEndpointAccess
- StartServiceSoftwareUpdate
- UpdateDomainConfig
- UpdatePackage
- UpdateVpcEndpoint
- UpgradeDomain
- Types
- AutoTuneDesiredState
- AutoTuneState
- AutoTuneType
- DeploymentStatus
- DescribePackagesFilterName
- DomainPackageStatus
- EngineType
- InboundConnectionStatusCode
- LogType
- OpenSearchPartitionInstanceType
- OpenSearchWarmPartitionInstanceType
- OptionState
- OutboundConnectionStatusCode
- OverallChangeStatus
- PackageStatus
- PackageType
- PrincipalType
- ReservedInstancePaymentOption
- RollbackOnDisable
- ScheduledAutoTuneActionType
- ScheduledAutoTuneSeverityType
- TLSSecurityPolicy
- TimeUnit
- UpgradeStatus
- UpgradeStep
- VolumeType
- VpcEndpointErrorCode
- VpcEndpointStatus
- AWSDomainInformation
- AccessPoliciesStatus
- AdditionalLimit
- AdvancedOptionsStatus
- AdvancedSecurityOptions
- AdvancedSecurityOptionsInput
- AdvancedSecurityOptionsStatus
- AuthorizedPrincipal
- AutoTune
- AutoTuneDetails
- AutoTuneMaintenanceSchedule
- AutoTuneOptions
- AutoTuneOptionsInput
- AutoTuneOptionsOutput
- AutoTuneOptionsStatus
- AutoTuneStatus
- ChangeProgressDetails
- ChangeProgressStage
- ChangeProgressStatusDetails
- ClusterConfig
- ClusterConfigStatus
- CognitoOptions
- CognitoOptionsStatus
- ColdStorageOptions
- CompatibleVersionsMap
- DescribePackagesFilter
- DomainConfig
- DomainEndpointOptions
- DomainEndpointOptionsStatus
- DomainInfo
- DomainInformationContainer
- DomainPackageDetails
- DomainStatus
- DryRunResults
- 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
- VpcEndpoint
- VpcEndpointError
- VpcEndpointSummary
- ZoneAwarenessConfig
Derived from API version 2021-01-01
of the AWS service descriptions, licensed under Apache 2.0.
Use the Amazon OpenSearch Service configuration API to create, configure, and manage 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 Amazon Web Services service endpoints.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _BaseException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _DisabledOperationException :: AsError a => Fold a ServiceError
- _InternalException :: AsError a => Fold a ServiceError
- _InvalidPaginationTokenException :: AsError a => Fold a ServiceError
- _InvalidTypeException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data AcceptInboundConnection = AcceptInboundConnection' Text
- newAcceptInboundConnection :: Text -> AcceptInboundConnection
- data AcceptInboundConnectionResponse = AcceptInboundConnectionResponse' (Maybe InboundConnection) Int
- newAcceptInboundConnectionResponse :: Int -> AcceptInboundConnectionResponse
- data AddTags = AddTags' Text [Tag]
- newAddTags :: Text -> AddTags
- data AddTagsResponse = AddTagsResponse' {
- newAddTagsResponse :: AddTagsResponse
- data AssociatePackage = AssociatePackage' Text Text
- newAssociatePackage :: Text -> Text -> AssociatePackage
- data AssociatePackageResponse = AssociatePackageResponse' (Maybe DomainPackageDetails) Int
- newAssociatePackageResponse :: Int -> AssociatePackageResponse
- data AuthorizeVpcEndpointAccess = AuthorizeVpcEndpointAccess' Text Text
- newAuthorizeVpcEndpointAccess :: Text -> Text -> AuthorizeVpcEndpointAccess
- data AuthorizeVpcEndpointAccessResponse = AuthorizeVpcEndpointAccessResponse' Int AuthorizedPrincipal
- newAuthorizeVpcEndpointAccessResponse :: Int -> AuthorizedPrincipal -> AuthorizeVpcEndpointAccessResponse
- data CancelServiceSoftwareUpdate = CancelServiceSoftwareUpdate' Text
- newCancelServiceSoftwareUpdate :: Text -> CancelServiceSoftwareUpdate
- data CancelServiceSoftwareUpdateResponse = CancelServiceSoftwareUpdateResponse' (Maybe ServiceSoftwareOptions) Int
- newCancelServiceSoftwareUpdateResponse :: Int -> CancelServiceSoftwareUpdateResponse
- data CreateDomain = CreateDomain' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe AdvancedSecurityOptionsInput) (Maybe AutoTuneOptionsInput) (Maybe ClusterConfig) (Maybe CognitoOptions) (Maybe DomainEndpointOptions) (Maybe EBSOptions) (Maybe EncryptionAtRestOptions) (Maybe Text) (Maybe (HashMap LogType LogPublishingOption)) (Maybe NodeToNodeEncryptionOptions) (Maybe SnapshotOptions) (Maybe [Tag]) (Maybe VPCOptions) Text
- newCreateDomain :: Text -> CreateDomain
- data CreateDomainResponse = CreateDomainResponse' (Maybe DomainStatus) Int
- newCreateDomainResponse :: Int -> CreateDomainResponse
- data CreateOutboundConnection = CreateOutboundConnection' DomainInformationContainer DomainInformationContainer Text
- newCreateOutboundConnection :: DomainInformationContainer -> DomainInformationContainer -> Text -> CreateOutboundConnection
- data CreateOutboundConnectionResponse = CreateOutboundConnectionResponse' (Maybe Text) (Maybe Text) (Maybe OutboundConnectionStatus) (Maybe DomainInformationContainer) (Maybe DomainInformationContainer) 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 CreateVpcEndpoint = CreateVpcEndpoint' (Maybe Text) Text VPCOptions
- newCreateVpcEndpoint :: Text -> VPCOptions -> CreateVpcEndpoint
- data CreateVpcEndpointResponse = CreateVpcEndpointResponse' Int VpcEndpoint
- newCreateVpcEndpointResponse :: Int -> VpcEndpoint -> CreateVpcEndpointResponse
- data DeleteDomain = DeleteDomain' Text
- newDeleteDomain :: Text -> DeleteDomain
- data DeleteDomainResponse = DeleteDomainResponse' (Maybe DomainStatus) Int
- newDeleteDomainResponse :: Int -> DeleteDomainResponse
- data DeleteInboundConnection = DeleteInboundConnection' Text
- newDeleteInboundConnection :: Text -> DeleteInboundConnection
- data DeleteInboundConnectionResponse = DeleteInboundConnectionResponse' (Maybe InboundConnection) Int
- newDeleteInboundConnectionResponse :: Int -> DeleteInboundConnectionResponse
- data DeleteOutboundConnection = DeleteOutboundConnection' Text
- newDeleteOutboundConnection :: Text -> DeleteOutboundConnection
- data DeleteOutboundConnectionResponse = DeleteOutboundConnectionResponse' (Maybe OutboundConnection) Int
- newDeleteOutboundConnectionResponse :: Int -> DeleteOutboundConnectionResponse
- data DeletePackage = DeletePackage' Text
- newDeletePackage :: Text -> DeletePackage
- data DeletePackageResponse = DeletePackageResponse' (Maybe PackageDetails) Int
- newDeletePackageResponse :: Int -> DeletePackageResponse
- data DeleteVpcEndpoint = DeleteVpcEndpoint' Text
- newDeleteVpcEndpoint :: Text -> DeleteVpcEndpoint
- data DeleteVpcEndpointResponse = DeleteVpcEndpointResponse' Int VpcEndpointSummary
- newDeleteVpcEndpointResponse :: Int -> VpcEndpointSummary -> DeleteVpcEndpointResponse
- data DescribeDomain = DescribeDomain' Text
- newDescribeDomain :: Text -> DescribeDomain
- data DescribeDomainResponse = DescribeDomainResponse' Int DomainStatus
- newDescribeDomainResponse :: Int -> DomainStatus -> DescribeDomainResponse
- data DescribeDomainAutoTunes = DescribeDomainAutoTunes' (Maybe Int) (Maybe Text) Text
- newDescribeDomainAutoTunes :: Text -> DescribeDomainAutoTunes
- data DescribeDomainAutoTunesResponse = DescribeDomainAutoTunesResponse' (Maybe [AutoTune]) (Maybe Text) Int
- newDescribeDomainAutoTunesResponse :: Int -> DescribeDomainAutoTunesResponse
- data DescribeDomainChangeProgress = DescribeDomainChangeProgress' (Maybe Text) Text
- newDescribeDomainChangeProgress :: Text -> DescribeDomainChangeProgress
- data DescribeDomainChangeProgressResponse = DescribeDomainChangeProgressResponse' (Maybe ChangeProgressStatusDetails) Int
- newDescribeDomainChangeProgressResponse :: Int -> DescribeDomainChangeProgressResponse
- data DescribeDomainConfig = DescribeDomainConfig' Text
- newDescribeDomainConfig :: Text -> DescribeDomainConfig
- data DescribeDomainConfigResponse = DescribeDomainConfigResponse' Int DomainConfig
- newDescribeDomainConfigResponse :: Int -> DomainConfig -> DescribeDomainConfigResponse
- data DescribeDomains = DescribeDomains' [Text]
- newDescribeDomains :: DescribeDomains
- data DescribeDomainsResponse = DescribeDomainsResponse' Int [DomainStatus]
- newDescribeDomainsResponse :: Int -> DescribeDomainsResponse
- data DescribeInboundConnections = DescribeInboundConnections' (Maybe [Filter]) (Maybe Int) (Maybe Text)
- newDescribeInboundConnections :: DescribeInboundConnections
- data DescribeInboundConnectionsResponse = DescribeInboundConnectionsResponse' (Maybe [InboundConnection]) (Maybe Text) Int
- newDescribeInboundConnectionsResponse :: Int -> DescribeInboundConnectionsResponse
- data DescribeInstanceTypeLimits = DescribeInstanceTypeLimits' (Maybe Text) OpenSearchPartitionInstanceType Text
- newDescribeInstanceTypeLimits :: OpenSearchPartitionInstanceType -> Text -> DescribeInstanceTypeLimits
- data DescribeInstanceTypeLimitsResponse = DescribeInstanceTypeLimitsResponse' (Maybe (HashMap Text Limits)) Int
- newDescribeInstanceTypeLimitsResponse :: Int -> DescribeInstanceTypeLimitsResponse
- data DescribeOutboundConnections = DescribeOutboundConnections' (Maybe [Filter]) (Maybe Int) (Maybe Text)
- newDescribeOutboundConnections :: DescribeOutboundConnections
- data DescribeOutboundConnectionsResponse = DescribeOutboundConnectionsResponse' (Maybe [OutboundConnection]) (Maybe Text) Int
- newDescribeOutboundConnectionsResponse :: Int -> DescribeOutboundConnectionsResponse
- data DescribePackages = DescribePackages' (Maybe [DescribePackagesFilter]) (Maybe Int) (Maybe Text)
- newDescribePackages :: DescribePackages
- data DescribePackagesResponse = DescribePackagesResponse' (Maybe Text) (Maybe [PackageDetails]) Int
- newDescribePackagesResponse :: Int -> DescribePackagesResponse
- data DescribeReservedInstanceOfferings = DescribeReservedInstanceOfferings' (Maybe Int) (Maybe Text) (Maybe Text)
- newDescribeReservedInstanceOfferings :: DescribeReservedInstanceOfferings
- data DescribeReservedInstanceOfferingsResponse = DescribeReservedInstanceOfferingsResponse' (Maybe Text) (Maybe [ReservedInstanceOffering]) Int
- newDescribeReservedInstanceOfferingsResponse :: Int -> DescribeReservedInstanceOfferingsResponse
- data DescribeReservedInstances = DescribeReservedInstances' (Maybe Int) (Maybe Text) (Maybe Text)
- newDescribeReservedInstances :: DescribeReservedInstances
- data DescribeReservedInstancesResponse = DescribeReservedInstancesResponse' (Maybe Text) (Maybe [ReservedInstance]) Int
- newDescribeReservedInstancesResponse :: Int -> DescribeReservedInstancesResponse
- data DescribeVpcEndpoints = DescribeVpcEndpoints' [Text]
- newDescribeVpcEndpoints :: DescribeVpcEndpoints
- data DescribeVpcEndpointsResponse = DescribeVpcEndpointsResponse' Int [VpcEndpoint] [VpcEndpointError]
- newDescribeVpcEndpointsResponse :: Int -> DescribeVpcEndpointsResponse
- data DissociatePackage = DissociatePackage' Text Text
- newDissociatePackage :: Text -> Text -> DissociatePackage
- data DissociatePackageResponse = DissociatePackageResponse' (Maybe DomainPackageDetails) Int
- newDissociatePackageResponse :: Int -> DissociatePackageResponse
- data GetCompatibleVersions = GetCompatibleVersions' (Maybe Text)
- newGetCompatibleVersions :: GetCompatibleVersions
- data GetCompatibleVersionsResponse = GetCompatibleVersionsResponse' (Maybe [CompatibleVersionsMap]) Int
- newGetCompatibleVersionsResponse :: Int -> GetCompatibleVersionsResponse
- data GetPackageVersionHistory = GetPackageVersionHistory' (Maybe Int) (Maybe Text) Text
- newGetPackageVersionHistory :: Text -> GetPackageVersionHistory
- data GetPackageVersionHistoryResponse = GetPackageVersionHistoryResponse' (Maybe Text) (Maybe Text) (Maybe [PackageVersionHistory]) Int
- newGetPackageVersionHistoryResponse :: Int -> GetPackageVersionHistoryResponse
- data GetUpgradeHistory = GetUpgradeHistory' (Maybe Int) (Maybe Text) Text
- newGetUpgradeHistory :: Text -> GetUpgradeHistory
- data GetUpgradeHistoryResponse = GetUpgradeHistoryResponse' (Maybe Text) (Maybe [UpgradeHistory]) Int
- newGetUpgradeHistoryResponse :: Int -> GetUpgradeHistoryResponse
- data GetUpgradeStatus = GetUpgradeStatus' Text
- newGetUpgradeStatus :: Text -> GetUpgradeStatus
- data GetUpgradeStatusResponse = GetUpgradeStatusResponse' (Maybe UpgradeStatus) (Maybe Text) (Maybe UpgradeStep) Int
- newGetUpgradeStatusResponse :: Int -> GetUpgradeStatusResponse
- data ListDomainNames = ListDomainNames' (Maybe EngineType)
- newListDomainNames :: ListDomainNames
- data ListDomainNamesResponse = ListDomainNamesResponse' (Maybe [DomainInfo]) Int
- newListDomainNamesResponse :: Int -> ListDomainNamesResponse
- data ListDomainsForPackage = ListDomainsForPackage' (Maybe Int) (Maybe Text) Text
- newListDomainsForPackage :: Text -> ListDomainsForPackage
- data ListDomainsForPackageResponse = ListDomainsForPackageResponse' (Maybe [DomainPackageDetails]) (Maybe Text) Int
- newListDomainsForPackageResponse :: Int -> ListDomainsForPackageResponse
- data ListInstanceTypeDetails = ListInstanceTypeDetails' (Maybe Text) (Maybe Int) (Maybe Text) Text
- newListInstanceTypeDetails :: Text -> ListInstanceTypeDetails
- data ListInstanceTypeDetailsResponse = ListInstanceTypeDetailsResponse' (Maybe [InstanceTypeDetails]) (Maybe Text) Int
- newListInstanceTypeDetailsResponse :: Int -> ListInstanceTypeDetailsResponse
- data ListPackagesForDomain = ListPackagesForDomain' (Maybe Int) (Maybe Text) Text
- newListPackagesForDomain :: Text -> ListPackagesForDomain
- data ListPackagesForDomainResponse = ListPackagesForDomainResponse' (Maybe [DomainPackageDetails]) (Maybe Text) Int
- newListPackagesForDomainResponse :: Int -> ListPackagesForDomainResponse
- data ListTags = ListTags' Text
- newListTags :: Text -> ListTags
- data ListTagsResponse = ListTagsResponse' (Maybe [Tag]) Int
- newListTagsResponse :: Int -> ListTagsResponse
- data ListVersions = ListVersions' (Maybe Int) (Maybe Text)
- newListVersions :: ListVersions
- data ListVersionsResponse = ListVersionsResponse' (Maybe Text) (Maybe [Text]) Int
- newListVersionsResponse :: Int -> ListVersionsResponse
- data ListVpcEndpointAccess = ListVpcEndpointAccess' (Maybe Text) Text
- newListVpcEndpointAccess :: Text -> ListVpcEndpointAccess
- data ListVpcEndpointAccessResponse = ListVpcEndpointAccessResponse' Int [AuthorizedPrincipal] Text
- newListVpcEndpointAccessResponse :: Int -> Text -> ListVpcEndpointAccessResponse
- data ListVpcEndpoints = ListVpcEndpoints' (Maybe Text)
- newListVpcEndpoints :: ListVpcEndpoints
- data ListVpcEndpointsResponse = ListVpcEndpointsResponse' Int [VpcEndpointSummary] Text
- newListVpcEndpointsResponse :: Int -> Text -> ListVpcEndpointsResponse
- data ListVpcEndpointsForDomain = ListVpcEndpointsForDomain' (Maybe Text) Text
- newListVpcEndpointsForDomain :: Text -> ListVpcEndpointsForDomain
- data ListVpcEndpointsForDomainResponse = ListVpcEndpointsForDomainResponse' Int [VpcEndpointSummary] Text
- newListVpcEndpointsForDomainResponse :: Int -> Text -> ListVpcEndpointsForDomainResponse
- data PurchaseReservedInstanceOffering = PurchaseReservedInstanceOffering' (Maybe Natural) Text Text
- newPurchaseReservedInstanceOffering :: Text -> Text -> PurchaseReservedInstanceOffering
- data PurchaseReservedInstanceOfferingResponse = PurchaseReservedInstanceOfferingResponse' (Maybe Text) (Maybe Text) Int
- newPurchaseReservedInstanceOfferingResponse :: Int -> PurchaseReservedInstanceOfferingResponse
- data RejectInboundConnection = RejectInboundConnection' Text
- newRejectInboundConnection :: Text -> RejectInboundConnection
- data RejectInboundConnectionResponse = RejectInboundConnectionResponse' (Maybe InboundConnection) Int
- newRejectInboundConnectionResponse :: Int -> RejectInboundConnectionResponse
- data RemoveTags = RemoveTags' Text [Text]
- newRemoveTags :: Text -> RemoveTags
- data RemoveTagsResponse = RemoveTagsResponse' {
- newRemoveTagsResponse :: RemoveTagsResponse
- data RevokeVpcEndpointAccess = RevokeVpcEndpointAccess' Text Text
- newRevokeVpcEndpointAccess :: Text -> Text -> RevokeVpcEndpointAccess
- data RevokeVpcEndpointAccessResponse = RevokeVpcEndpointAccessResponse' Int
- newRevokeVpcEndpointAccessResponse :: Int -> RevokeVpcEndpointAccessResponse
- data StartServiceSoftwareUpdate = StartServiceSoftwareUpdate' Text
- newStartServiceSoftwareUpdate :: Text -> StartServiceSoftwareUpdate
- data StartServiceSoftwareUpdateResponse = StartServiceSoftwareUpdateResponse' (Maybe ServiceSoftwareOptions) Int
- newStartServiceSoftwareUpdateResponse :: Int -> StartServiceSoftwareUpdateResponse
- data UpdateDomainConfig = UpdateDomainConfig' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe AdvancedSecurityOptionsInput) (Maybe AutoTuneOptions) (Maybe ClusterConfig) (Maybe CognitoOptions) (Maybe DomainEndpointOptions) (Maybe Bool) (Maybe EBSOptions) (Maybe EncryptionAtRestOptions) (Maybe (HashMap LogType LogPublishingOption)) (Maybe NodeToNodeEncryptionOptions) (Maybe SnapshotOptions) (Maybe VPCOptions) Text
- newUpdateDomainConfig :: Text -> UpdateDomainConfig
- data UpdateDomainConfigResponse = UpdateDomainConfigResponse' (Maybe DryRunResults) Int DomainConfig
- newUpdateDomainConfigResponse :: Int -> DomainConfig -> UpdateDomainConfigResponse
- data UpdatePackage = UpdatePackage' (Maybe Text) (Maybe Text) Text PackageSource
- newUpdatePackage :: Text -> PackageSource -> UpdatePackage
- data UpdatePackageResponse = UpdatePackageResponse' (Maybe PackageDetails) Int
- newUpdatePackageResponse :: Int -> UpdatePackageResponse
- data UpdateVpcEndpoint = UpdateVpcEndpoint' Text VPCOptions
- newUpdateVpcEndpoint :: Text -> VPCOptions -> UpdateVpcEndpoint
- data UpdateVpcEndpointResponse = UpdateVpcEndpointResponse' Int VpcEndpoint
- newUpdateVpcEndpointResponse :: Int -> VpcEndpoint -> UpdateVpcEndpointResponse
- data UpgradeDomain = UpgradeDomain' (Maybe (HashMap Text Text)) (Maybe Bool) Text Text
- newUpgradeDomain :: Text -> Text -> UpgradeDomain
- data UpgradeDomainResponse = UpgradeDomainResponse' (Maybe (HashMap Text Text)) (Maybe ChangeProgressDetails) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) Int
- newUpgradeDomainResponse :: Int -> UpgradeDomainResponse
- 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 OverallChangeStatus where
- 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 PrincipalType where
- PrincipalType' { }
- pattern PrincipalType_AWS_ACCOUNT :: PrincipalType
- pattern PrincipalType_AWS_SERVICE :: PrincipalType
- 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_Gp3 :: VolumeType
- pattern VolumeType_Io1 :: VolumeType
- pattern VolumeType_Standard :: VolumeType
- newtype VpcEndpointErrorCode where
- newtype VpcEndpointStatus where
- VpcEndpointStatus' { }
- pattern VpcEndpointStatus_ACTIVE :: VpcEndpointStatus
- pattern VpcEndpointStatus_CREATE_FAILED :: VpcEndpointStatus
- pattern VpcEndpointStatus_CREATING :: VpcEndpointStatus
- pattern VpcEndpointStatus_DELETE_FAILED :: VpcEndpointStatus
- pattern VpcEndpointStatus_DELETING :: VpcEndpointStatus
- pattern VpcEndpointStatus_UPDATE_FAILED :: VpcEndpointStatus
- pattern VpcEndpointStatus_UPDATING :: VpcEndpointStatus
- 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 POSIX) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe SAMLOptionsOutput)
- newAdvancedSecurityOptions :: AdvancedSecurityOptions
- data AdvancedSecurityOptionsInput = AdvancedSecurityOptionsInput' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe MasterUserOptions) (Maybe SAMLOptionsInput)
- newAdvancedSecurityOptionsInput :: AdvancedSecurityOptionsInput
- data AdvancedSecurityOptionsStatus = AdvancedSecurityOptionsStatus' AdvancedSecurityOptions OptionStatus
- newAdvancedSecurityOptionsStatus :: AdvancedSecurityOptions -> OptionStatus -> AdvancedSecurityOptionsStatus
- data AuthorizedPrincipal = AuthorizedPrincipal' (Maybe Text) (Maybe PrincipalType)
- newAuthorizedPrincipal :: AuthorizedPrincipal
- data AutoTune = AutoTune' (Maybe AutoTuneDetails) (Maybe AutoTuneType)
- newAutoTune :: AutoTune
- data AutoTuneDetails = AutoTuneDetails' (Maybe ScheduledAutoTuneDetails)
- newAutoTuneDetails :: AutoTuneDetails
- data AutoTuneMaintenanceSchedule = AutoTuneMaintenanceSchedule' (Maybe Text) (Maybe Duration) (Maybe POSIX)
- newAutoTuneMaintenanceSchedule :: AutoTuneMaintenanceSchedule
- data AutoTuneOptions = AutoTuneOptions' (Maybe AutoTuneDesiredState) (Maybe [AutoTuneMaintenanceSchedule]) (Maybe RollbackOnDisable)
- newAutoTuneOptions :: AutoTuneOptions
- data AutoTuneOptionsInput = AutoTuneOptionsInput' (Maybe AutoTuneDesiredState) (Maybe [AutoTuneMaintenanceSchedule])
- newAutoTuneOptionsInput :: AutoTuneOptionsInput
- data AutoTuneOptionsOutput = AutoTuneOptionsOutput' (Maybe Text) (Maybe AutoTuneState)
- newAutoTuneOptionsOutput :: AutoTuneOptionsOutput
- data AutoTuneOptionsStatus = AutoTuneOptionsStatus' (Maybe AutoTuneOptions) (Maybe AutoTuneStatus)
- newAutoTuneOptionsStatus :: AutoTuneOptionsStatus
- data AutoTuneStatus = AutoTuneStatus' (Maybe Text) (Maybe Bool) (Maybe Natural) POSIX POSIX AutoTuneState
- newAutoTuneStatus :: UTCTime -> UTCTime -> AutoTuneState -> AutoTuneStatus
- data ChangeProgressDetails = ChangeProgressDetails' (Maybe Text) (Maybe Text)
- newChangeProgressDetails :: ChangeProgressDetails
- data ChangeProgressStage = ChangeProgressStage' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newChangeProgressStage :: ChangeProgressStage
- data ChangeProgressStatusDetails = ChangeProgressStatusDetails' (Maybe Text) (Maybe [ChangeProgressStage]) (Maybe [Text]) (Maybe [Text]) (Maybe POSIX) (Maybe OverallChangeStatus) (Maybe Int)
- newChangeProgressStatusDetails :: ChangeProgressStatusDetails
- data ClusterConfig = ClusterConfig' (Maybe ColdStorageOptions) (Maybe Int) (Maybe Bool) (Maybe OpenSearchPartitionInstanceType) (Maybe Int) (Maybe OpenSearchPartitionInstanceType) (Maybe Int) (Maybe Bool) (Maybe OpenSearchWarmPartitionInstanceType) (Maybe ZoneAwarenessConfig) (Maybe Bool)
- newClusterConfig :: ClusterConfig
- data ClusterConfigStatus = ClusterConfigStatus' ClusterConfig OptionStatus
- newClusterConfigStatus :: ClusterConfig -> OptionStatus -> ClusterConfigStatus
- data CognitoOptions = CognitoOptions' (Maybe Bool) (Maybe Text) (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 DescribePackagesFilterName) (Maybe [Text])
- newDescribePackagesFilter :: DescribePackagesFilter
- data DomainConfig = DomainConfig' (Maybe AccessPoliciesStatus) (Maybe AdvancedOptionsStatus) (Maybe AdvancedSecurityOptionsStatus) (Maybe AutoTuneOptionsStatus) (Maybe ChangeProgressDetails) (Maybe ClusterConfigStatus) (Maybe CognitoOptionsStatus) (Maybe DomainEndpointOptionsStatus) (Maybe EBSOptionsStatus) (Maybe EncryptionAtRestOptionsStatus) (Maybe VersionStatus) (Maybe LogPublishingOptionsStatus) (Maybe NodeToNodeEncryptionOptionsStatus) (Maybe SnapshotOptionsStatus) (Maybe VPCDerivedInfoStatus)
- newDomainConfig :: DomainConfig
- data DomainEndpointOptions = DomainEndpointOptions' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe TLSSecurityPolicy)
- 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 Text) (Maybe DomainPackageStatus) (Maybe ErrorDetails) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe PackageType) (Maybe Text) (Maybe Text)
- newDomainPackageDetails :: DomainPackageDetails
- data DomainStatus = DomainStatus' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe AdvancedSecurityOptions) (Maybe AutoTuneOptionsOutput) (Maybe ChangeProgressDetails) (Maybe CognitoOptions) (Maybe Bool) (Maybe Bool) (Maybe DomainEndpointOptions) (Maybe EBSOptions) (Maybe EncryptionAtRestOptions) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe (HashMap LogType LogPublishingOption)) (Maybe NodeToNodeEncryptionOptions) (Maybe Bool) (Maybe ServiceSoftwareOptions) (Maybe SnapshotOptions) (Maybe Bool) (Maybe VPCDerivedInfo) Text Text Text ClusterConfig
- newDomainStatus :: Text -> Text -> Text -> ClusterConfig -> DomainStatus
- data DryRunResults = DryRunResults' (Maybe Text) (Maybe Text)
- newDryRunResults :: DryRunResults
- data Duration = Duration' (Maybe TimeUnit) (Maybe Natural)
- newDuration :: Duration
- data EBSOptions = EBSOptions' (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe VolumeType)
- 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 Text) (Maybe (NonEmpty Text))
- newFilter :: Filter
- data InboundConnection = InboundConnection' (Maybe Text) (Maybe InboundConnectionStatus) (Maybe DomainInformationContainer) (Maybe DomainInformationContainer)
- 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 Bool) (Maybe Bool) (Maybe [Text]) (Maybe OpenSearchPartitionInstanceType) (Maybe Bool)
- newInstanceTypeDetails :: InstanceTypeDetails
- data Limits = Limits' (Maybe [AdditionalLimit]) (Maybe InstanceLimits) (Maybe [StorageType])
- newLimits :: Limits
- data LogPublishingOption = LogPublishingOption' (Maybe Text) (Maybe Bool)
- newLogPublishingOption :: LogPublishingOption
- data LogPublishingOptionsStatus = LogPublishingOptionsStatus' (Maybe (HashMap LogType LogPublishingOption)) (Maybe OptionStatus)
- newLogPublishingOptionsStatus :: LogPublishingOptionsStatus
- data MasterUserOptions = MasterUserOptions' (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive 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 Text) (Maybe Text) (Maybe OutboundConnectionStatus) (Maybe DomainInformationContainer) (Maybe DomainInformationContainer)
- newOutboundConnection :: OutboundConnection
- data OutboundConnectionStatus = OutboundConnectionStatus' (Maybe Text) (Maybe OutboundConnectionStatusCode)
- newOutboundConnectionStatus :: OutboundConnectionStatus
- data PackageDetails = PackageDetails' (Maybe Text) (Maybe POSIX) (Maybe ErrorDetails) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PackageStatus) (Maybe PackageType)
- newPackageDetails :: PackageDetails
- data PackageSource = PackageSource' (Maybe Text) (Maybe Text)
- newPackageSource :: PackageSource
- data PackageVersionHistory = PackageVersionHistory' (Maybe Text) (Maybe POSIX) (Maybe Text)
- newPackageVersionHistory :: PackageVersionHistory
- data RecurringCharge = RecurringCharge' (Maybe Double) (Maybe Text)
- newRecurringCharge :: RecurringCharge
- data ReservedInstance = ReservedInstance' (Maybe Integer) (Maybe Text) (Maybe Int) (Maybe Double) (Maybe Int) (Maybe OpenSearchPartitionInstanceType) (Maybe ReservedInstancePaymentOption) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Double)
- newReservedInstance :: ReservedInstance
- data ReservedInstanceOffering = ReservedInstanceOffering' (Maybe Text) (Maybe Int) (Maybe Double) (Maybe OpenSearchPartitionInstanceType) (Maybe ReservedInstancePaymentOption) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Double)
- newReservedInstanceOffering :: ReservedInstanceOffering
- data SAMLIdp = SAMLIdp' Text Text
- newSAMLIdp :: Text -> Text -> SAMLIdp
- data SAMLOptionsInput = SAMLOptionsInput' (Maybe Bool) (Maybe SAMLIdp) (Maybe Text) (Maybe (Sensitive 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 Text) (Maybe ScheduledAutoTuneActionType) (Maybe POSIX) (Maybe ScheduledAutoTuneSeverityType)
- newScheduledAutoTuneDetails :: ScheduledAutoTuneDetails
- data ServiceSoftwareOptions = ServiceSoftwareOptions' (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe DeploymentStatus)
- newServiceSoftwareOptions :: ServiceSoftwareOptions
- data SnapshotOptions = SnapshotOptions' (Maybe Int)
- newSnapshotOptions :: SnapshotOptions
- data SnapshotOptionsStatus = SnapshotOptionsStatus' SnapshotOptions OptionStatus
- newSnapshotOptionsStatus :: SnapshotOptions -> OptionStatus -> SnapshotOptionsStatus
- data StorageType = StorageType' (Maybe Text) (Maybe [StorageTypeLimit]) (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 POSIX) (Maybe [UpgradeStepItem]) (Maybe Text) (Maybe UpgradeStatus)
- newUpgradeHistory :: UpgradeHistory
- data UpgradeStepItem = UpgradeStepItem' (Maybe [Text]) (Maybe Double) (Maybe UpgradeStep) (Maybe UpgradeStatus)
- 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 VpcEndpoint = VpcEndpoint' (Maybe Text) (Maybe Text) (Maybe VpcEndpointStatus) (Maybe Text) (Maybe Text) (Maybe VPCDerivedInfo)
- newVpcEndpoint :: VpcEndpoint
- data VpcEndpointError = VpcEndpointError' (Maybe VpcEndpointErrorCode) (Maybe Text) (Maybe Text)
- newVpcEndpointError :: VpcEndpointError
- data VpcEndpointSummary = VpcEndpointSummary' (Maybe Text) (Maybe VpcEndpointStatus) (Maybe Text) (Maybe Text)
- newVpcEndpointSummary :: VpcEndpointSummary
- 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
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
BaseException
_BaseException :: AsError a => Fold a ServiceError Source #
An error occurred while processing the request.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
DisabledOperationException
_DisabledOperationException :: AsError a => Fold 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 => Fold 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.
InvalidPaginationTokenException
_InvalidPaginationTokenException :: AsError a => Fold a ServiceError Source #
The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
InvalidTypeException
_InvalidTypeException :: AsError a => Fold 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.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
An exception for creating a resource that already exists. Gives http status code of 400.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
An exception for missing / invalid input fields. Gives http status code of 400.
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.
AcceptInboundConnection
data AcceptInboundConnection Source #
Container for the parameters to the AcceptInboundConnection
operation.
See: newAcceptInboundConnection
smart constructor.
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:
AcceptInboundConnection
, acceptInboundConnection_connectionId
- The ID of the inbound connection to accept.
data AcceptInboundConnectionResponse Source #
Contains details about the accepted inbound connection.
See: newAcceptInboundConnectionResponse
smart constructor.
Instances
Generic AcceptInboundConnectionResponse Source # | |
Read AcceptInboundConnectionResponse Source # | |
Show AcceptInboundConnectionResponse Source # | |
Defined in Amazonka.OpenSearch.AcceptInboundConnection | |
NFData AcceptInboundConnectionResponse Source # | |
Defined in Amazonka.OpenSearch.AcceptInboundConnection rnf :: AcceptInboundConnectionResponse -> () # | |
Eq AcceptInboundConnectionResponse Source # | |
type Rep AcceptInboundConnectionResponse Source # | |
Defined in Amazonka.OpenSearch.AcceptInboundConnection type Rep AcceptInboundConnectionResponse = D1 ('MetaData "AcceptInboundConnectionResponse" "Amazonka.OpenSearch.AcceptInboundConnection" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "AcceptInboundConnectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InboundConnection)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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
- Information about the accepted inbound connection.
$sel:httpStatus:AcceptInboundConnectionResponse'
, acceptInboundConnectionResponse_httpStatus
- The response's http status code.
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:
AddTags
, addTags_arn
- Amazon Resource Name (ARN) for the OpenSearch Service domain to which
you want to attach resource tags.
$sel:tagList:AddTags'
, addTags_tagList
- List of resource tags.
data AddTagsResponse Source #
See: newAddTagsResponse
smart constructor.
Instances
Generic AddTagsResponse Source # | |
Defined in Amazonka.OpenSearch.AddTags type Rep AddTagsResponse :: Type -> Type # from :: AddTagsResponse -> Rep AddTagsResponse x # to :: Rep AddTagsResponse x -> AddTagsResponse # | |
Read AddTagsResponse Source # | |
Defined in Amazonka.OpenSearch.AddTags | |
Show AddTagsResponse Source # | |
Defined in Amazonka.OpenSearch.AddTags showsPrec :: Int -> AddTagsResponse -> ShowS # show :: AddTagsResponse -> String # showList :: [AddTagsResponse] -> ShowS # | |
NFData AddTagsResponse Source # | |
Defined in Amazonka.OpenSearch.AddTags rnf :: AddTagsResponse -> () # | |
Eq AddTagsResponse Source # | |
Defined in Amazonka.OpenSearch.AddTags (==) :: AddTagsResponse -> AddTagsResponse -> Bool # (/=) :: AddTagsResponse -> AddTagsResponse -> Bool # | |
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.
AssociatePackage
data AssociatePackage Source #
Container for the request parameters to the AssociatePackage
operation.
See: newAssociatePackage
smart constructor.
Instances
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:
AssociatePackage
, associatePackage_packageID
- Internal ID of the package to associate with a domain. Use
DescribePackages
to find this value.
AssociatePackage
, associatePackage_domainName
- Name of the domain to associate the package with.
data AssociatePackageResponse Source #
Container for the response returned by the AssociatePackage
operation.
See: newAssociatePackageResponse
smart constructor.
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
- Information about a package that is associated with a domain.
$sel:httpStatus:AssociatePackageResponse'
, associatePackageResponse_httpStatus
- The response's http status code.
AuthorizeVpcEndpointAccess
data AuthorizeVpcEndpointAccess Source #
See: newAuthorizeVpcEndpointAccess
smart constructor.
Instances
newAuthorizeVpcEndpointAccess Source #
:: Text | |
-> Text | |
-> AuthorizeVpcEndpointAccess |
Create a value of AuthorizeVpcEndpointAccess
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:
AuthorizeVpcEndpointAccess
, authorizeVpcEndpointAccess_domainName
- The name of the OpenSearch Service domain to provide access to.
$sel:account:AuthorizeVpcEndpointAccess'
, authorizeVpcEndpointAccess_account
- The Amazon Web Services account ID to grant access to.
data AuthorizeVpcEndpointAccessResponse Source #
See: newAuthorizeVpcEndpointAccessResponse
smart constructor.
Instances
Generic AuthorizeVpcEndpointAccessResponse Source # | |
Read AuthorizeVpcEndpointAccessResponse Source # | |
Show AuthorizeVpcEndpointAccessResponse Source # | |
NFData AuthorizeVpcEndpointAccessResponse Source # | |
Defined in Amazonka.OpenSearch.AuthorizeVpcEndpointAccess rnf :: AuthorizeVpcEndpointAccessResponse -> () # | |
Eq AuthorizeVpcEndpointAccessResponse Source # | |
type Rep AuthorizeVpcEndpointAccessResponse Source # | |
Defined in Amazonka.OpenSearch.AuthorizeVpcEndpointAccess type Rep AuthorizeVpcEndpointAccessResponse = D1 ('MetaData "AuthorizeVpcEndpointAccessResponse" "Amazonka.OpenSearch.AuthorizeVpcEndpointAccess" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "AuthorizeVpcEndpointAccessResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "authorizedPrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthorizedPrincipal))) |
newAuthorizeVpcEndpointAccessResponse Source #
:: Int | |
-> AuthorizedPrincipal |
|
-> AuthorizeVpcEndpointAccessResponse |
Create a value of AuthorizeVpcEndpointAccessResponse
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:AuthorizeVpcEndpointAccessResponse'
, authorizeVpcEndpointAccessResponse_httpStatus
- The response's http status code.
$sel:authorizedPrincipal:AuthorizeVpcEndpointAccessResponse'
, authorizeVpcEndpointAccessResponse_authorizedPrincipal
- Information about the Amazon Web Services account or service that was
provided access to the domain.
CancelServiceSoftwareUpdate
data CancelServiceSoftwareUpdate Source #
Container for the request parameters to cancel a service software update.
See: newCancelServiceSoftwareUpdate
smart constructor.
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:
CancelServiceSoftwareUpdate
, cancelServiceSoftwareUpdate_domainName
- Name of the OpenSearch Service domain that you want to cancel the
service software update on.
data CancelServiceSoftwareUpdateResponse Source #
Container for the response to a CancelServiceSoftwareUpdate
operation.
Contains the status of the update.
See: newCancelServiceSoftwareUpdateResponse
smart constructor.
Instances
newCancelServiceSoftwareUpdateResponse Source #
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:
CancelServiceSoftwareUpdateResponse
, cancelServiceSoftwareUpdateResponse_serviceSoftwareOptions
- Container for the state of your domain relative to the latest service
software.
$sel:httpStatus:CancelServiceSoftwareUpdateResponse'
, cancelServiceSoftwareUpdateResponse_httpStatus
- The response's http status code.
CreateDomain
data CreateDomain Source #
See: newCreateDomain
smart constructor.
Instances
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:
CreateDomain
, createDomain_accessPolicies
- Identity and Access Management (IAM) policy document specifying the
access policies for the new domain.
CreateDomain
, createDomain_advancedOptions
- Key-value pairs to specify advanced configuration options. The following
key-value pairs are supported:
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true."indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded."indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in aTooManyClauses
error."override_main_response_version": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
CreateDomain
, createDomain_advancedSecurityOptions
- Options for fine-grained access control.
CreateDomain
, createDomain_autoTuneOptions
- Options for Auto-Tune.
CreateDomain
, createDomain_clusterConfig
- Container for the cluster configuration of a domain.
CreateDomain
, createDomain_cognitoOptions
- Key-value pairs to configure Amazon Cognito authentication. For more
information, see
Configuring Amazon Cognito authentication for OpenSearch Dashboards.
CreateDomain
, createDomain_domainEndpointOptions
- Additional options for the domain endpoint, such as whether to require
HTTPS for all traffic.
CreateDomain
, createDomain_eBSOptions
- Container for the parameters required to enable EBS-based storage for an
OpenSearch Service domain.
CreateDomain
, createDomain_encryptionAtRestOptions
- Key-value pairs to enable encryption at rest.
CreateDomain
, createDomain_engineVersion
- String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the
engine version for the OpenSearch Service domain. For example,
OpenSearch_1.0
or Elasticsearch_7.9
. For more information, see
Creating and managing Amazon OpenSearch Service domains.
CreateDomain
, createDomain_logPublishingOptions
- Key-value pairs to configure slow log publishing.
CreateDomain
, createDomain_nodeToNodeEncryptionOptions
- Enables node-to-node encryption.
CreateDomain
, createDomain_snapshotOptions
- DEPRECATED. Container for the parameters required to configure automated
snapshots of domain indexes.
$sel:tagList:CreateDomain'
, createDomain_tagList
- List of tags to add to the domain upon creation.
CreateDomain
, createDomain_vPCOptions
- Container for the values required to configure VPC access domains. If
you don't specify these values, OpenSearch Service creates the domain
with a public endpoint. For more information, see
Launching your Amazon OpenSearch Service domains using a VPC.
CreateDomain
, createDomain_domainName
- Name of the OpenSearch Service domain to create. Domain names are unique
across the domains owned by an account within an Amazon Web Services
Region.
data CreateDomainResponse Source #
The result of a CreateDomain
operation. Contains the status of the
newly created domain.
See: newCreateDomainResponse
smart constructor.
Instances
newCreateDomainResponse Source #
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.
CreateOutboundConnection
data CreateOutboundConnection Source #
Container for the parameters to the CreateOutboundConnection
operation.
See: newCreateOutboundConnection
smart constructor.
Instances
newCreateOutboundConnection Source #
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:
CreateOutboundConnection
, createOutboundConnection_localDomainInfo
- Name and Region of the source (local) domain.
CreateOutboundConnection
, createOutboundConnection_remoteDomainInfo
- Name and Region of the destination (remote) domain.
CreateOutboundConnection
, createOutboundConnection_connectionAlias
- Name of the connection.
data CreateOutboundConnectionResponse Source #
The result of a CreateOutboundConnection
request. Contains details
about the newly created cross-cluster connection.
See: newCreateOutboundConnectionResponse
smart constructor.
CreateOutboundConnectionResponse' (Maybe Text) (Maybe Text) (Maybe OutboundConnectionStatus) (Maybe DomainInformationContainer) (Maybe DomainInformationContainer) 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:
CreateOutboundConnection
, createOutboundConnectionResponse_connectionAlias
- Name of the connection.
CreateOutboundConnectionResponse
, createOutboundConnectionResponse_connectionId
- The unique identifier for the created outbound connection, which is used
for subsequent operations on the connection.
CreateOutboundConnectionResponse
, createOutboundConnectionResponse_connectionStatus
- The status of the connection.
CreateOutboundConnection
, createOutboundConnectionResponse_localDomainInfo
- Information about the source (local) domain.
CreateOutboundConnection
, createOutboundConnectionResponse_remoteDomainInfo
- Information about the destination (remote) domain.
$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.
Instances
:: 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:
CreatePackage
, createPackage_packageDescription
- Description of the package.
CreatePackage
, createPackage_packageName
- Unique name for the package.
CreatePackage
, createPackage_packageType
- Type of package.
$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.
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
- Basic information about an OpenSearch Service package.
$sel:httpStatus:CreatePackageResponse'
, createPackageResponse_httpStatus
- The response's http status code.
CreateVpcEndpoint
data CreateVpcEndpoint Source #
See: newCreateVpcEndpoint
smart constructor.
Instances
Create a value of CreateVpcEndpoint
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:clientToken:CreateVpcEndpoint'
, createVpcEndpoint_clientToken
- Unique, case-sensitive identifier to ensure idempotency of the request.
CreateVpcEndpoint
, createVpcEndpoint_domainArn
- The Amazon Resource Name (ARN) of the domain to grant access to.
CreateVpcEndpoint
, createVpcEndpoint_vpcOptions
- Options to specify the subnets and security groups for the endpoint.
data CreateVpcEndpointResponse Source #
See: newCreateVpcEndpointResponse
smart constructor.
Instances
newCreateVpcEndpointResponse Source #
Create a value of CreateVpcEndpointResponse
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:CreateVpcEndpointResponse'
, createVpcEndpointResponse_httpStatus
- The response's http status code.
$sel:vpcEndpoint:CreateVpcEndpointResponse'
, createVpcEndpointResponse_vpcEndpoint
- Information about the newly created VPC endpoint.
DeleteDomain
data DeleteDomain Source #
Container for the parameters to the DeleteDomain
operation.
See: newDeleteDomain
smart constructor.
Instances
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:
DeleteDomain
, deleteDomain_domainName
- The name of the domain you want to permanently delete.
data DeleteDomainResponse Source #
The results 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.
Instances
newDeleteDomainResponse Source #
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.
DeleteInboundConnection
data DeleteInboundConnection Source #
Container for the parameters to the DeleteInboundConnection
operation.
See: newDeleteInboundConnection
smart constructor.
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:
DeleteInboundConnection
, deleteInboundConnection_connectionId
- The ID of the inbound connection to permanently delete.
data DeleteInboundConnectionResponse Source #
The results of a DeleteInboundConnection
operation. Contains details
about the deleted inbound connection.
See: newDeleteInboundConnectionResponse
smart constructor.
Instances
Generic DeleteInboundConnectionResponse Source # | |
Read DeleteInboundConnectionResponse Source # | |
Show DeleteInboundConnectionResponse Source # | |
Defined in Amazonka.OpenSearch.DeleteInboundConnection | |
NFData DeleteInboundConnectionResponse Source # | |
Defined in Amazonka.OpenSearch.DeleteInboundConnection rnf :: DeleteInboundConnectionResponse -> () # | |
Eq DeleteInboundConnectionResponse Source # | |
type Rep DeleteInboundConnectionResponse Source # | |
Defined in Amazonka.OpenSearch.DeleteInboundConnection type Rep DeleteInboundConnectionResponse = D1 ('MetaData "DeleteInboundConnectionResponse" "Amazonka.OpenSearch.DeleteInboundConnection" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DeleteInboundConnectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InboundConnection)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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 deleted inbound connection.
$sel:httpStatus:DeleteInboundConnectionResponse'
, deleteInboundConnectionResponse_httpStatus
- The response's http status code.
DeleteOutboundConnection
data DeleteOutboundConnection Source #
Container for the parameters to the DeleteOutboundConnection
operation.
See: newDeleteOutboundConnection
smart constructor.
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:
DeleteOutboundConnection
, deleteOutboundConnection_connectionId
- The ID of the outbound connection you want to permanently delete.
data DeleteOutboundConnectionResponse Source #
Details about the deleted outbound connection.
See: newDeleteOutboundConnectionResponse
smart constructor.
Instances
Generic DeleteOutboundConnectionResponse Source # | |
Read DeleteOutboundConnectionResponse Source # | |
Show DeleteOutboundConnectionResponse Source # | |
NFData DeleteOutboundConnectionResponse Source # | |
Defined in Amazonka.OpenSearch.DeleteOutboundConnection rnf :: DeleteOutboundConnectionResponse -> () # | |
Eq DeleteOutboundConnectionResponse Source # | |
type Rep DeleteOutboundConnectionResponse Source # | |
Defined in Amazonka.OpenSearch.DeleteOutboundConnection type Rep DeleteOutboundConnectionResponse = D1 ('MetaData "DeleteOutboundConnectionResponse" "Amazonka.OpenSearch.DeleteOutboundConnection" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DeleteOutboundConnectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutboundConnection)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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 deleted inbound connection.
$sel:httpStatus:DeleteOutboundConnectionResponse'
, deleteOutboundConnectionResponse_httpStatus
- The response's http status code.
DeletePackage
data DeletePackage Source #
Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.
See: newDeletePackage
smart constructor.
Instances
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:
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.
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
- Information about the deleted package.
$sel:httpStatus:DeletePackageResponse'
, deletePackageResponse_httpStatus
- The response's http status code.
DeleteVpcEndpoint
data DeleteVpcEndpoint Source #
See: newDeleteVpcEndpoint
smart constructor.
Instances
Create a value of DeleteVpcEndpoint
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:
DeleteVpcEndpoint
, deleteVpcEndpoint_vpcEndpointId
- The unique identifier of the endpoint.
data DeleteVpcEndpointResponse Source #
See: newDeleteVpcEndpointResponse
smart constructor.
Instances
newDeleteVpcEndpointResponse Source #
Create a value of DeleteVpcEndpointResponse
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:DeleteVpcEndpointResponse'
, deleteVpcEndpointResponse_httpStatus
- The response's http status code.
$sel:vpcEndpointSummary:DeleteVpcEndpointResponse'
, deleteVpcEndpointResponse_vpcEndpointSummary
- Information about the deleted endpoint, including its current status
(DELETING
or DELETE_FAILED
).
DescribeDomain
data DescribeDomain Source #
Container for the parameters to the DescribeDomain
operation.
See: newDescribeDomain
smart constructor.
Instances
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:
DescribeDomain
, describeDomain_domainName
- The name of the domain that you want information about.
data DescribeDomainResponse Source #
Contains the status of the domain specified in the request.
See: newDescribeDomainResponse
smart constructor.
Instances
newDescribeDomainResponse Source #
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
- List that contains the status of each specified OpenSearch Service
domain.
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:maxResults:DescribeDomainAutoTunes'
, describeDomainAutoTunes_maxResults
- An optional parameter that specifies the maximum number of results to
return. You can use nextToken
to get the next page of results.
DescribeDomainAutoTunes
, describeDomainAutoTunes_nextToken
- If your initial DescribeDomainAutoTunes
operation returns a
nextToken
, you can include the returned nextToken
in subsequent
DescribeDomainAutoTunes
operations, which returns results in the next
page.
DescribeDomainAutoTunes
, describeDomainAutoTunes_domainName
- Name of the domain that you want Auto-Tune details about.
data DescribeDomainAutoTunesResponse Source #
The result of a DescribeDomainAutoTunes
request.
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:autoTunes:DescribeDomainAutoTunesResponse'
, describeDomainAutoTunesResponse_autoTunes
- The list of setting adjustments that Auto-Tune has made to the domain.
DescribeDomainAutoTunes
, describeDomainAutoTunesResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:httpStatus:DescribeDomainAutoTunesResponse'
, describeDomainAutoTunesResponse_httpStatus
- The response's http status code.
DescribeDomainChangeProgress
data DescribeDomainChangeProgress Source #
Container for the parameters to the DescribeDomainChangeProgress
operation.
See: newDescribeDomainChangeProgress
smart constructor.
Instances
newDescribeDomainChangeProgress Source #
Create a value of DescribeDomainChangeProgress
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:
DescribeDomainChangeProgress
, describeDomainChangeProgress_changeId
- The specific change ID for which you want to get progress information.
If omitted, the request returns information about the most recent
configuration change.
DescribeDomainChangeProgress
, describeDomainChangeProgress_domainName
- The name of the domain to get progress information for.
data DescribeDomainChangeProgressResponse Source #
The result of a DescribeDomainChangeProgress
request. Contains
progress information for the requested domain change.
See: newDescribeDomainChangeProgressResponse
smart constructor.
Instances
newDescribeDomainChangeProgressResponse Source #
Create a value of DescribeDomainChangeProgressResponse
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:changeProgressStatus:DescribeDomainChangeProgressResponse'
, describeDomainChangeProgressResponse_changeProgressStatus
- Container for information about the stages of a configuration change
happening on a domain.
$sel:httpStatus:DescribeDomainChangeProgressResponse'
, describeDomainChangeProgressResponse_httpStatus
- The response's http status code.
DescribeDomainConfig
data DescribeDomainConfig Source #
Container for the parameters to the DescribeDomainConfig
operation.
See: newDescribeDomainConfig
smart constructor.
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:
DescribeDomainConfig
, describeDomainConfig_domainName
- Name of the OpenSearch Service domain configuration that you want to
describe.
data DescribeDomainConfigResponse Source #
Contains the configuration information of the requested domain.
See: newDescribeDomainConfigResponse
smart constructor.
Instances
newDescribeDomainConfigResponse Source #
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
- Container for the configuration of the OpenSearch Service domain.
DescribeDomains
data DescribeDomains Source #
Container for the parameters to the DescribeDomains
operation.
See: newDescribeDomains
smart constructor.
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
- Array of OpenSearch Service domain names that you want information
about. If you don't specify any domains, OpenSearch Service returns
information about all domains owned by the account.
data DescribeDomainsResponse Source #
Contains the status of the specified domains or all domains owned by the account.
See: newDescribeDomainsResponse
smart constructor.
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 requested domains.
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.
$sel:maxResults:DescribeInboundConnections'
, describeInboundConnections_maxResults
- An optional parameter that specifies the maximum number of results to
return. You can use nextToken
to get the next page of results.
DescribeInboundConnections
, describeInboundConnections_nextToken
- If your initial DescribeInboundConnections
operation returns a
nextToken
, you can include the returned nextToken
in subsequent
DescribeInboundConnections
operations, which returns results in the
next page.
data DescribeInboundConnectionsResponse Source #
Contains a list of connections matching the filter criteria.
See: newDescribeInboundConnectionsResponse
smart constructor.
Instances
newDescribeInboundConnectionsResponse Source #
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
- List of inbound connections.
DescribeInboundConnections
, describeInboundConnectionsResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:httpStatus:DescribeInboundConnectionsResponse'
, describeInboundConnectionsResponse_httpStatus
- The response's http status code.
DescribeInstanceTypeLimits
data DescribeInstanceTypeLimits Source #
Container for the parameters to the DescribeInstanceTypeLimits
operation.
See: newDescribeInstanceTypeLimits
smart constructor.
Instances
newDescribeInstanceTypeLimits Source #
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:
DescribeInstanceTypeLimits
, describeInstanceTypeLimits_domainName
- The name of the domain. Only specify if you need the limits for an
existing domain.
DescribeInstanceTypeLimits
, describeInstanceTypeLimits_instanceType
- The OpenSearch Service instance type for which you need limit
information.
DescribeInstanceTypeLimits
, describeInstanceTypeLimits_engineVersion
- Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y
or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
data DescribeInstanceTypeLimitsResponse Source #
Container for the parameters received from the
DescribeInstanceTypeLimits
operation.
See: newDescribeInstanceTypeLimitsResponse
smart constructor.
Instances
Generic DescribeInstanceTypeLimitsResponse Source # | |
Read DescribeInstanceTypeLimitsResponse Source # | |
Show DescribeInstanceTypeLimitsResponse Source # | |
NFData DescribeInstanceTypeLimitsResponse Source # | |
Defined in Amazonka.OpenSearch.DescribeInstanceTypeLimits rnf :: DescribeInstanceTypeLimitsResponse -> () # | |
Eq DescribeInstanceTypeLimitsResponse Source # | |
type Rep DescribeInstanceTypeLimitsResponse Source # | |
Defined in Amazonka.OpenSearch.DescribeInstanceTypeLimits type Rep DescribeInstanceTypeLimitsResponse = D1 ('MetaData "DescribeInstanceTypeLimitsResponse" "Amazonka.OpenSearch.DescribeInstanceTypeLimits" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DescribeInstanceTypeLimitsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limitsByRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Limits))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDescribeInstanceTypeLimitsResponse Source #
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
- Map that contains all applicable instance type limits.data
refers to
data nodes.master
refers to dedicated master nodes.
$sel:httpStatus:DescribeInstanceTypeLimitsResponse'
, describeInstanceTypeLimitsResponse_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
- List of filter names and values that you can use for requests.
$sel:maxResults:DescribeOutboundConnections'
, describeOutboundConnections_maxResults
- An optional parameter that specifies the maximum number of results to
return. You can use nextToken
to get the next page of results.
DescribeOutboundConnections
, describeOutboundConnections_nextToken
- If your initial DescribeOutboundConnections
operation returns a
nextToken
, you can include the returned nextToken
in subsequent
DescribeOutboundConnections
operations, which returns results in the
next page.
data DescribeOutboundConnectionsResponse Source #
Contains a list of connections matching the filter criteria.
See: newDescribeOutboundConnectionsResponse
smart constructor.
Instances
newDescribeOutboundConnectionsResponse Source #
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
- List of outbound connections that match the filter criteria.
DescribeOutboundConnections
, describeOutboundConnectionsResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:httpStatus:DescribeOutboundConnectionsResponse'
, describeOutboundConnectionsResponse_httpStatus
- The response's http status code.
DescribePackages
data DescribePackages Source #
Container for the request parameters to the DescribePackage
operation.
See: newDescribePackages
smart constructor.
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:maxResults:DescribePackages'
, describePackages_maxResults
- An optional parameter that specifies the maximum number of results to
return. You can use nextToken
to get the next page of results.
DescribePackages
, describePackages_nextToken
- If your initial DescribePackageFilters
operation returns a
nextToken
, you can include the returned nextToken
in subsequent
DescribePackageFilters
operations, which returns results in the next
page.
data DescribePackagesResponse Source #
Container for the response returned by the DescribePackages
operation.
See: newDescribePackagesResponse
smart constructor.
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:
DescribePackages
, describePackagesResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:packageDetailsList:DescribePackagesResponse'
, describePackagesResponse_packageDetailsList
- Basic information about a package.
$sel:httpStatus:DescribePackagesResponse'
, describePackagesResponse_httpStatus
- The response's http status code.
DescribeReservedInstanceOfferings
data DescribeReservedInstanceOfferings Source #
Container for the request parameters to a
DescribeReservedInstanceOfferings
operation.
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:maxResults:DescribeReservedInstanceOfferings'
, describeReservedInstanceOfferings_maxResults
- An optional parameter that specifies the maximum number of results to
return. You can use nextToken
to get the next page of results.
DescribeReservedInstanceOfferings
, describeReservedInstanceOfferings_nextToken
- If your initial DescribeReservedInstanceOfferings
operation returns a
nextToken
, you can include the returned nextToken
in subsequent
DescribeReservedInstanceOfferings
operations, which returns results in
the next page.
DescribeReservedInstanceOfferings
, describeReservedInstanceOfferings_reservedInstanceOfferingId
- The Reserved Instance identifier filter value. Use this parameter to
show only the available instance types that match the specified
reservation identifier.
data DescribeReservedInstanceOfferingsResponse Source #
Container for results of a DescribeReservedInstanceOfferings
request.
See: newDescribeReservedInstanceOfferingsResponse
smart constructor.
Instances
newDescribeReservedInstanceOfferingsResponse Source #
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:
DescribeReservedInstanceOfferings
, describeReservedInstanceOfferingsResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:reservedInstanceOfferings:DescribeReservedInstanceOfferingsResponse'
, describeReservedInstanceOfferingsResponse_reservedInstanceOfferings
- List of Reserved Instance offerings.
$sel:httpStatus:DescribeReservedInstanceOfferingsResponse'
, describeReservedInstanceOfferingsResponse_httpStatus
- The response's http status code.
DescribeReservedInstances
data DescribeReservedInstances Source #
Container for the request parameters to the DescribeReservedInstances
operation.
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:maxResults:DescribeReservedInstances'
, describeReservedInstances_maxResults
- An optional parameter that specifies the maximum number of results to
return. You can use nextToken
to get the next page of results.
DescribeReservedInstances
, describeReservedInstances_nextToken
- If your initial DescribeReservedInstances
operation returns a
nextToken
, you can include the returned nextToken
in subsequent
DescribeReservedInstances
operations, which returns results in the
next page.
DescribeReservedInstances
, describeReservedInstances_reservedInstanceId
- The reserved instance identifier filter value. Use this parameter to
show only the reservation that matches the specified reserved OpenSearch
instance ID.
data DescribeReservedInstancesResponse Source #
Container for results from DescribeReservedInstances
See: newDescribeReservedInstancesResponse
smart constructor.
Instances
newDescribeReservedInstancesResponse Source #
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:
DescribeReservedInstances
, describeReservedInstancesResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:reservedInstances:DescribeReservedInstancesResponse'
, describeReservedInstancesResponse_reservedInstances
- List of Reserved Instances in the current Region.
$sel:httpStatus:DescribeReservedInstancesResponse'
, describeReservedInstancesResponse_httpStatus
- The response's http status code.
DescribeVpcEndpoints
data DescribeVpcEndpoints Source #
See: newDescribeVpcEndpoints
smart constructor.
Instances
newDescribeVpcEndpoints :: DescribeVpcEndpoints Source #
Create a value of DescribeVpcEndpoints
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:vpcEndpointIds:DescribeVpcEndpoints'
, describeVpcEndpoints_vpcEndpointIds
- The unique identifiers of the endpoints to get information about.
data DescribeVpcEndpointsResponse Source #
See: newDescribeVpcEndpointsResponse
smart constructor.
Instances
newDescribeVpcEndpointsResponse Source #
Create a value of DescribeVpcEndpointsResponse
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:DescribeVpcEndpointsResponse'
, describeVpcEndpointsResponse_httpStatus
- The response's http status code.
$sel:vpcEndpoints:DescribeVpcEndpointsResponse'
, describeVpcEndpointsResponse_vpcEndpoints
- Information about each requested VPC endpoint.
$sel:vpcEndpointErrors:DescribeVpcEndpointsResponse'
, describeVpcEndpointsResponse_vpcEndpointErrors
- Any errors associated with the request.
DissociatePackage
data DissociatePackage Source #
Container for the request parameters to the DissociatePackage
operation.
See: newDissociatePackage
smart constructor.
Instances
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:
DissociatePackage
, dissociatePackage_packageID
- Internal ID of the package to dissociate from the domain. Use
ListPackagesForDomain
to find this value.
DissociatePackage
, dissociatePackage_domainName
- Name of the domain to dissociate the package from.
data DissociatePackageResponse Source #
Container for the response returned by an DissociatePackage
operation.
See: newDissociatePackageResponse
smart constructor.
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
- Information about a package that has been dissociated from the domain.
$sel:httpStatus:DissociatePackageResponse'
, dissociatePackageResponse_httpStatus
- The response's http status code.
GetCompatibleVersions
data GetCompatibleVersions Source #
Container for the request parameters to GetCompatibleVersions
operation.
See: newGetCompatibleVersions
smart constructor.
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:
GetCompatibleVersions
, getCompatibleVersions_domainName
- The name of an existing domain. Provide this parameter to limit the
results to a single domain.
data GetCompatibleVersionsResponse Source #
Container for the response returned by the GetCompatibleVersions
operation.
See: newGetCompatibleVersionsResponse
smart constructor.
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 OpenSearch or Elasticsearch versions and the versions you can
upgrade them to.
$sel:httpStatus:GetCompatibleVersionsResponse'
, getCompatibleVersionsResponse_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:maxResults:GetPackageVersionHistory'
, getPackageVersionHistory_maxResults
- An optional parameter that specifies the maximum number of results to
return. You can use nextToken
to get the next page of results.
GetPackageVersionHistory
, getPackageVersionHistory_nextToken
- If your initial GetPackageVersionHistory
operation returns a
nextToken
, you can include the returned nextToken
in subsequent
GetPackageVersionHistory
operations, which returns results in the next
page.
GetPackageVersionHistory
, getPackageVersionHistory_packageID
- The unique identifier of the package.
data GetPackageVersionHistoryResponse Source #
Container for response returned by GetPackageVersionHistory
operation.
See: newGetPackageVersionHistoryResponse
smart constructor.
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:
GetPackageVersionHistory
, getPackageVersionHistoryResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
GetPackageVersionHistory
, getPackageVersionHistoryResponse_packageID
- The unique identifier of the package.
$sel:packageVersionHistoryList:GetPackageVersionHistoryResponse'
, getPackageVersionHistoryResponse_packageVersionHistoryList
- A list of package versions, along with their creation time and commit
message.
$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
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:maxResults:GetUpgradeHistory'
, getUpgradeHistory_maxResults
- An optional parameter that specifies the maximum number of results to
return. You can use nextToken
to get the next page of results.
GetUpgradeHistory
, getUpgradeHistory_nextToken
- If your initial GetUpgradeHistory
operation returns a nextToken
, you
can include the returned nextToken
in subsequent GetUpgradeHistory
operations, which returns results in the next page.
GetUpgradeHistory
, getUpgradeHistory_domainName
- The name of an existing domain.
data GetUpgradeHistoryResponse Source #
Container for the response returned by the GetUpgradeHistory
operation.
See: newGetUpgradeHistoryResponse
smart constructor.
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:
GetUpgradeHistory
, getUpgradeHistoryResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:upgradeHistories:GetUpgradeHistoryResponse'
, getUpgradeHistoryResponse_upgradeHistories
- A list of objects corresponding to each upgrade or upgrade eligibility
check performed on a domain.
$sel:httpStatus:GetUpgradeHistoryResponse'
, getUpgradeHistoryResponse_httpStatus
- The response's http status code.
GetUpgradeStatus
data GetUpgradeStatus Source #
Container for the request parameters to the GetUpgradeStatus
operation.
See: newGetUpgradeStatus
smart constructor.
Instances
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:
GetUpgradeStatus
, getUpgradeStatus_domainName
- The domain of the domain to get upgrade status information for.
data GetUpgradeStatusResponse Source #
Container for the response returned by the GetUpgradeStatus
operation.
See: newGetUpgradeStatusResponse
smart constructor.
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
- The status of the current step that an upgrade is on.
GetUpgradeStatusResponse
, getUpgradeStatusResponse_upgradeName
- A string that describes the update.
GetUpgradeStatusResponse
, getUpgradeStatusResponse_upgradeStep
- One of three steps that an upgrade or upgrade eligibility check goes
through.
$sel:httpStatus:GetUpgradeStatusResponse'
, getUpgradeStatusResponse_httpStatus
- The response's http status code.
ListDomainNames
data ListDomainNames Source #
Container for the parameters to the ListDomainNames
operation.
See: newListDomainNames
smart constructor.
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:
ListDomainNames
, listDomainNames_engineType
- Filters the output by domain engine type.
data ListDomainNamesResponse Source #
The results of a ListDomainNames
operation. Contains the names of all
domains owned by this account and their respective engine types.
See: newListDomainNamesResponse
smart constructor.
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
- The names of all OpenSearch Service domains owned by the current user
and their respective engine types.
$sel:httpStatus:ListDomainNamesResponse'
, listDomainNamesResponse_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:maxResults:ListDomainsForPackage'
, listDomainsForPackage_maxResults
- An optional parameter that specifies the maximum number of results to
return. You can use nextToken
to get the next page of results.
ListDomainsForPackage
, listDomainsForPackage_nextToken
- If your initial ListDomainsForPackage
operation returns a nextToken
,
you can include the returned nextToken
in subsequent
ListDomainsForPackage
operations, which returns results in the next
page.
ListDomainsForPackage
, listDomainsForPackage_packageID
- The unique identifier of the package for which to list associated
domains.
data ListDomainsForPackageResponse Source #
Container for the response parameters to the ListDomainsForPackage
operation.
See: newListDomainsForPackageResponse
smart constructor.
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
- Information about all domains associated with a package.
ListDomainsForPackage
, listDomainsForPackageResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:httpStatus:ListDomainsForPackageResponse'
, listDomainsForPackageResponse_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:
ListInstanceTypeDetails
, listInstanceTypeDetails_domainName
- Name of the domain to list instance type details for.
$sel:maxResults:ListInstanceTypeDetails'
, listInstanceTypeDetails_maxResults
- An optional parameter that specifies the maximum number of results to
return. You can use nextToken
to get the next page of results.
ListInstanceTypeDetails
, listInstanceTypeDetails_nextToken
- If your initial ListInstanceTypeDetails
operation returns a
nextToken
, you can include the returned nextToken
in subsequent
ListInstanceTypeDetails
operations, which returns results in the next
page.
ListInstanceTypeDetails
, listInstanceTypeDetails_engineVersion
- Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y
or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
data ListInstanceTypeDetailsResponse Source #
See: newListInstanceTypeDetailsResponse
smart constructor.
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
- Lists all supported instance types and features for the given OpenSearch
or Elasticsearch version.
ListInstanceTypeDetails
, listInstanceTypeDetailsResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:httpStatus:ListInstanceTypeDetailsResponse'
, listInstanceTypeDetailsResponse_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:maxResults:ListPackagesForDomain'
, listPackagesForDomain_maxResults
- An optional parameter that specifies the maximum number of results to
return. You can use nextToken
to get the next page of results.
ListPackagesForDomain
, listPackagesForDomain_nextToken
- If your initial ListPackagesForDomain
operation returns a nextToken
,
you can include the returned nextToken
in subsequent
ListPackagesForDomain
operations, which returns results in the next
page.
ListPackagesForDomain
, 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.
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 all packages associated with a domain.
ListPackagesForDomain
, listPackagesForDomainResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:httpStatus:ListPackagesForDomainResponse'
, listPackagesForDomainResponse_httpStatus
- The response's http status code.
ListTags
Container for the parameters to the ListTags
operation.
See: newListTags
smart constructor.
Instances
ToHeaders ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags | |
ToPath ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags toPath :: ListTags -> ByteString # | |
ToQuery ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags toQuery :: ListTags -> QueryString # | |
AWSRequest ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags type AWSResponse ListTags # request :: (Service -> Service) -> ListTags -> Request ListTags # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTags))) # | |
Generic ListTags Source # | |
Read ListTags Source # | |
Show ListTags Source # | |
NFData ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags | |
Eq ListTags Source # | |
Hashable ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags | |
type AWSResponse ListTags Source # | |
Defined in Amazonka.OpenSearch.ListTags | |
type Rep 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:
ListTags
, listTags_arn
- Amazon Resource Name (ARN) for the domain to view tags for.
data ListTagsResponse Source #
The results of a ListTags
operation.
See: newListTagsResponse
smart constructor.
ListTagsResponse' (Maybe [Tag]) Int |
Instances
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 resource tags associated with the specified domain.
$sel:httpStatus:ListTagsResponse'
, listTagsResponse_httpStatus
- The response's http status code.
ListVersions
data ListVersions Source #
Container for the request parameters to the ListVersions
operation.
See: newListVersions
smart constructor.
ListVersions' (Maybe Int) (Maybe Text) |
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:maxResults:ListVersions'
, listVersions_maxResults
- An optional parameter that specifies the maximum number of results to
return. You can use nextToken
to get the next page of results.
ListVersions
, listVersions_nextToken
- If your initial ListVersions
operation returns a nextToken
, you can
include the returned nextToken
in subsequent ListVersions
operations, which returns results in the next page.
data ListVersionsResponse Source #
Container for the parameters for response received from the
ListVersions
operation.
See: newListVersionsResponse
smart constructor.
Instances
newListVersionsResponse Source #
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:
ListVersions
, listVersionsResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:versions:ListVersionsResponse'
, listVersionsResponse_versions
- A list of all versions of OpenSearch and Elasticsearch that Amazon
OpenSearch Service supports.
$sel:httpStatus:ListVersionsResponse'
, listVersionsResponse_httpStatus
- The response's http status code.
ListVpcEndpointAccess
data ListVpcEndpointAccess Source #
See: newListVpcEndpointAccess
smart constructor.
Instances
newListVpcEndpointAccess Source #
Create a value of ListVpcEndpointAccess
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:
ListVpcEndpointAccess
, listVpcEndpointAccess_nextToken
- If your initial ListVpcEndpointAccess
operation returns a nextToken
,
you can include the returned nextToken
in subsequent
ListVpcEndpointAccess
operations, which returns results in the next
page.
ListVpcEndpointAccess
, listVpcEndpointAccess_domainName
- The name of the OpenSearch Service domain to retrieve access information
for.
data ListVpcEndpointAccessResponse Source #
See: newListVpcEndpointAccessResponse
smart constructor.
Instances
newListVpcEndpointAccessResponse Source #
:: Int | |
-> Text | |
-> ListVpcEndpointAccessResponse |
Create a value of ListVpcEndpointAccessResponse
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:ListVpcEndpointAccessResponse'
, listVpcEndpointAccessResponse_httpStatus
- The response's http status code.
$sel:authorizedPrincipalList:ListVpcEndpointAccessResponse'
, listVpcEndpointAccessResponse_authorizedPrincipalList
- A list of
IAM principals
that can currently access the domain.
ListVpcEndpointAccess
, listVpcEndpointAccessResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
ListVpcEndpoints
data ListVpcEndpoints Source #
See: newListVpcEndpoints
smart constructor.
Instances
newListVpcEndpoints :: ListVpcEndpoints Source #
Create a value of ListVpcEndpoints
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:
ListVpcEndpoints
, listVpcEndpoints_nextToken
- If your initial ListVpcEndpoints
operation returns a nextToken
, you
can include the returned nextToken
in subsequent ListVpcEndpoints
operations, which returns results in the next page.
data ListVpcEndpointsResponse Source #
See: newListVpcEndpointsResponse
smart constructor.
Instances
newListVpcEndpointsResponse Source #
Create a value of ListVpcEndpointsResponse
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:ListVpcEndpointsResponse'
, listVpcEndpointsResponse_httpStatus
- The response's http status code.
$sel:vpcEndpointSummaryList:ListVpcEndpointsResponse'
, listVpcEndpointsResponse_vpcEndpointSummaryList
- Information about each endpoint.
ListVpcEndpoints
, listVpcEndpointsResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
ListVpcEndpointsForDomain
data ListVpcEndpointsForDomain Source #
See: newListVpcEndpointsForDomain
smart constructor.
Instances
newListVpcEndpointsForDomain Source #
Create a value of ListVpcEndpointsForDomain
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:
ListVpcEndpointsForDomain
, listVpcEndpointsForDomain_nextToken
- If your initial ListEndpointsForDomain
operation returns a
nextToken
, you can include the returned nextToken
in subsequent
ListEndpointsForDomain
operations, which returns results in the next
page.
ListVpcEndpointsForDomain
, listVpcEndpointsForDomain_domainName
- The name of the domain to list associated VPC endpoints for.
data ListVpcEndpointsForDomainResponse Source #
See: newListVpcEndpointsForDomainResponse
smart constructor.
Instances
newListVpcEndpointsForDomainResponse Source #
Create a value of ListVpcEndpointsForDomainResponse
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:ListVpcEndpointsForDomainResponse'
, listVpcEndpointsForDomainResponse_httpStatus
- The response's http status code.
$sel:vpcEndpointSummaryList:ListVpcEndpointsForDomainResponse'
, listVpcEndpointsForDomainResponse_vpcEndpointSummaryList
- Information about each endpoint associated with the domain.
ListVpcEndpointsForDomain
, listVpcEndpointsForDomainResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
PurchaseReservedInstanceOffering
data PurchaseReservedInstanceOffering Source #
Container for request parameters to the
PurchaseReservedInstanceOffering
operation.
See: newPurchaseReservedInstanceOffering
smart constructor.
Instances
newPurchaseReservedInstanceOffering Source #
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:
PurchaseReservedInstanceOffering
, purchaseReservedInstanceOffering_instanceCount
- The number of OpenSearch instances to reserve.
PurchaseReservedInstanceOffering
, purchaseReservedInstanceOffering_reservedInstanceOfferingId
- The ID of the Reserved Instance offering to purchase.
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 #
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:
PurchaseReservedInstanceOffering
, purchaseReservedInstanceOfferingResponse_reservationName
- The customer-specified identifier used to track this reservation.
PurchaseReservedInstanceOfferingResponse
, purchaseReservedInstanceOfferingResponse_reservedInstanceId
- The ID of the Reserved Instance offering that was purchased.
$sel:httpStatus:PurchaseReservedInstanceOfferingResponse'
, purchaseReservedInstanceOfferingResponse_httpStatus
- The response's http status code.
RejectInboundConnection
data RejectInboundConnection Source #
Container for the request parameters to the RejectInboundConnection
operation.
See: newRejectInboundConnection
smart constructor.
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:
RejectInboundConnection
, rejectInboundConnection_connectionId
- The unique identifier of the inbound connection to reject.
data RejectInboundConnectionResponse Source #
Represents the output of a RejectInboundConnection
operation.
See: newRejectInboundConnectionResponse
smart constructor.
Instances
Generic RejectInboundConnectionResponse Source # | |
Read RejectInboundConnectionResponse Source # | |
Show RejectInboundConnectionResponse Source # | |
Defined in Amazonka.OpenSearch.RejectInboundConnection | |
NFData RejectInboundConnectionResponse Source # | |
Defined in Amazonka.OpenSearch.RejectInboundConnection rnf :: RejectInboundConnectionResponse -> () # | |
Eq RejectInboundConnectionResponse Source # | |
type Rep RejectInboundConnectionResponse Source # | |
Defined in Amazonka.OpenSearch.RejectInboundConnection type Rep RejectInboundConnectionResponse = D1 ('MetaData "RejectInboundConnectionResponse" "Amazonka.OpenSearch.RejectInboundConnection" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "RejectInboundConnectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InboundConnection)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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
- Contains details about the rejected inbound connection.
$sel:httpStatus:RejectInboundConnectionResponse'
, rejectInboundConnectionResponse_httpStatus
- The response's http status code.
RemoveTags
data RemoveTags Source #
Container for the request parameters to the RemoveTags
operation.
See: newRemoveTags
smart constructor.
Instances
:: 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:
RemoveTags
, removeTags_arn
- The Amazon Resource Name (ARN) of the domain from which you want to
delete the specified tags.
$sel:tagKeys:RemoveTags'
, removeTags_tagKeys
- The list of tag keys to remove from the domain.
data RemoveTagsResponse Source #
See: newRemoveTagsResponse
smart constructor.
Instances
Generic RemoveTagsResponse Source # | |
Defined in Amazonka.OpenSearch.RemoveTags type Rep RemoveTagsResponse :: Type -> Type # from :: RemoveTagsResponse -> Rep RemoveTagsResponse x # to :: Rep RemoveTagsResponse x -> RemoveTagsResponse # | |
Read RemoveTagsResponse Source # | |
Defined in Amazonka.OpenSearch.RemoveTags | |
Show RemoveTagsResponse Source # | |
Defined in Amazonka.OpenSearch.RemoveTags showsPrec :: Int -> RemoveTagsResponse -> ShowS # show :: RemoveTagsResponse -> String # showList :: [RemoveTagsResponse] -> ShowS # | |
NFData RemoveTagsResponse Source # | |
Defined in Amazonka.OpenSearch.RemoveTags rnf :: RemoveTagsResponse -> () # | |
Eq RemoveTagsResponse Source # | |
Defined in Amazonka.OpenSearch.RemoveTags (==) :: RemoveTagsResponse -> RemoveTagsResponse -> Bool # (/=) :: RemoveTagsResponse -> RemoveTagsResponse -> Bool # | |
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.
RevokeVpcEndpointAccess
data RevokeVpcEndpointAccess Source #
See: newRevokeVpcEndpointAccess
smart constructor.
Instances
newRevokeVpcEndpointAccess Source #
:: Text | |
-> Text | |
-> RevokeVpcEndpointAccess |
Create a value of RevokeVpcEndpointAccess
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:
RevokeVpcEndpointAccess
, revokeVpcEndpointAccess_domainName
- The name of the OpenSearch Service domain.
$sel:account:RevokeVpcEndpointAccess'
, revokeVpcEndpointAccess_account
- The account ID to revoke access from.
data RevokeVpcEndpointAccessResponse Source #
See: newRevokeVpcEndpointAccessResponse
smart constructor.
Instances
Generic RevokeVpcEndpointAccessResponse Source # | |
Read RevokeVpcEndpointAccessResponse Source # | |
Show RevokeVpcEndpointAccessResponse Source # | |
Defined in Amazonka.OpenSearch.RevokeVpcEndpointAccess | |
NFData RevokeVpcEndpointAccessResponse Source # | |
Defined in Amazonka.OpenSearch.RevokeVpcEndpointAccess rnf :: RevokeVpcEndpointAccessResponse -> () # | |
Eq RevokeVpcEndpointAccessResponse Source # | |
type Rep RevokeVpcEndpointAccessResponse Source # | |
Defined in Amazonka.OpenSearch.RevokeVpcEndpointAccess type Rep RevokeVpcEndpointAccessResponse = D1 ('MetaData "RevokeVpcEndpointAccessResponse" "Amazonka.OpenSearch.RevokeVpcEndpointAccess" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "RevokeVpcEndpointAccessResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newRevokeVpcEndpointAccessResponse Source #
Create a value of RevokeVpcEndpointAccessResponse
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:RevokeVpcEndpointAccessResponse'
, revokeVpcEndpointAccessResponse_httpStatus
- The response's http status code.
StartServiceSoftwareUpdate
data StartServiceSoftwareUpdate Source #
Container for the request parameters to the StartServiceSoftwareUpdate
operation.
See: newStartServiceSoftwareUpdate
smart constructor.
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:
StartServiceSoftwareUpdate
, startServiceSoftwareUpdate_domainName
- The name of the domain that you want to update to the latest service
software.
data StartServiceSoftwareUpdateResponse Source #
Represents the output of a StartServiceSoftwareUpdate
operation.
Contains the status of the update.
See: newStartServiceSoftwareUpdateResponse
smart constructor.
Instances
Generic StartServiceSoftwareUpdateResponse Source # | |
Read StartServiceSoftwareUpdateResponse Source # | |
Show StartServiceSoftwareUpdateResponse Source # | |
NFData StartServiceSoftwareUpdateResponse Source # | |
Defined in Amazonka.OpenSearch.StartServiceSoftwareUpdate rnf :: StartServiceSoftwareUpdateResponse -> () # | |
Eq StartServiceSoftwareUpdateResponse Source # | |
type Rep StartServiceSoftwareUpdateResponse Source # | |
Defined in Amazonka.OpenSearch.StartServiceSoftwareUpdate type Rep StartServiceSoftwareUpdateResponse = D1 ('MetaData "StartServiceSoftwareUpdateResponse" "Amazonka.OpenSearch.StartServiceSoftwareUpdate" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "StartServiceSoftwareUpdateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceSoftwareOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceSoftwareOptions)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newStartServiceSoftwareUpdateResponse Source #
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:
StartServiceSoftwareUpdateResponse
, startServiceSoftwareUpdateResponse_serviceSoftwareOptions
- The current status of the OpenSearch Service software update.
$sel:httpStatus:StartServiceSoftwareUpdateResponse'
, startServiceSoftwareUpdateResponse_httpStatus
- The response's http status code.
UpdateDomainConfig
data UpdateDomainConfig Source #
Container for the request parameters to the UpdateDomain
operation.
See: newUpdateDomainConfig
smart constructor.
Instances
newUpdateDomainConfig Source #
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:
UpdateDomainConfig
, updateDomainConfig_accessPolicies
- Identity and Access Management (IAM) access policy as a JSON-formatted
string.
UpdateDomainConfig
, updateDomainConfig_advancedOptions
- Key-value pairs to specify advanced configuration options. The following
key-value pairs are supported:
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true."indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded."indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in aTooManyClauses
error."override_main_response_version": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
UpdateDomainConfig
, updateDomainConfig_advancedSecurityOptions
- Options for fine-grained access control.
UpdateDomainConfig
, updateDomainConfig_autoTuneOptions
- Options for Auto-Tune.
UpdateDomainConfig
, updateDomainConfig_clusterConfig
- Changes that you want to make to the cluster configuration, such as the
instance type and number of EC2 instances.
UpdateDomainConfig
, updateDomainConfig_cognitoOptions
- Key-value pairs to configure Amazon Cognito authentication for
OpenSearch Dashboards.
UpdateDomainConfig
, updateDomainConfig_domainEndpointOptions
- Additional options for the domain endpoint, such as whether to require
HTTPS for all traffic.
$sel:dryRun:UpdateDomainConfig'
, updateDomainConfig_dryRun
- This flag, when set to True, specifies whether the UpdateDomain
request should return the results of validation check without actually
applying the change.
UpdateDomainConfig
, updateDomainConfig_eBSOptions
- The type and size of the EBS volume to attach to instances in the
domain.
UpdateDomainConfig
, updateDomainConfig_encryptionAtRestOptions
- Encryption at rest options for the domain.
UpdateDomainConfig
, updateDomainConfig_logPublishingOptions
- Options to publish OpenSearch lots to Amazon CloudWatch Logs.
UpdateDomainConfig
, updateDomainConfig_nodeToNodeEncryptionOptions
- Node-To-Node Encryption options for the domain.
UpdateDomainConfig
, updateDomainConfig_snapshotOptions
- Option to set the time, in UTC format, for the daily automated snapshot.
Default value is 0
hours.
UpdateDomainConfig
, updateDomainConfig_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.
UpdateDomainConfig
, updateDomainConfig_domainName
- The name of the domain that you're updating.
data UpdateDomainConfigResponse Source #
The results of an UpdateDomain
request. Contains the status of the
domain being updated.
See: newUpdateDomainConfigResponse
smart constructor.
Instances
newUpdateDomainConfigResponse Source #
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:dryRunResults:UpdateDomainConfigResponse'
, updateDomainConfigResponse_dryRunResults
- Results of a dry run performed in an update domain request.
$sel:httpStatus:UpdateDomainConfigResponse'
, updateDomainConfigResponse_httpStatus
- The response's http status code.
$sel:domainConfig:UpdateDomainConfigResponse'
, updateDomainConfigResponse_domainConfig
- The status of the updated domain.
UpdatePackage
data UpdatePackage Source #
Container for request parameters to the UpdatePackage
operation.
See: newUpdatePackage
smart constructor.
Instances
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:
UpdatePackage
, updatePackage_commitMessage
- Commit message for the updated file, which is shown as part of
GetPackageVersionHistoryResponse
.
UpdatePackage
, updatePackage_packageDescription
- A new description of the package.
UpdatePackage
, updatePackage_packageID
- The unique identifier for the package.
$sel:packageSource:UpdatePackage'
, updatePackage_packageSource
- Amazon S3 bucket and key for the package.
data UpdatePackageResponse Source #
Container for the response returned by the UpdatePackage
operation.
See: newUpdatePackageResponse
smart constructor.
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 a package.
$sel:httpStatus:UpdatePackageResponse'
, updatePackageResponse_httpStatus
- The response's http status code.
UpdateVpcEndpoint
data UpdateVpcEndpoint Source #
See: newUpdateVpcEndpoint
smart constructor.
Instances
Create a value of UpdateVpcEndpoint
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:
UpdateVpcEndpoint
, updateVpcEndpoint_vpcEndpointId
- The unique identifier of the endpoint.
UpdateVpcEndpoint
, updateVpcEndpoint_vpcOptions
- The security groups and/or subnets to add, remove, or modify.
data UpdateVpcEndpointResponse Source #
See: newUpdateVpcEndpointResponse
smart constructor.
Instances
newUpdateVpcEndpointResponse Source #
Create a value of UpdateVpcEndpointResponse
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:UpdateVpcEndpointResponse'
, updateVpcEndpointResponse_httpStatus
- The response's http status code.
$sel:vpcEndpoint:UpdateVpcEndpointResponse'
, updateVpcEndpointResponse_vpcEndpoint
- The endpoint to be updated.
UpgradeDomain
data UpgradeDomain Source #
Container for the request parameters to the UpgradeDomain
operation.
See: newUpgradeDomain
smart constructor.
Instances
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:
UpgradeDomain
, upgradeDomain_advancedOptions
- Only supports the override_main_response_version
parameter and not
other advanced options. You can only include this option when upgrading
to an OpenSearch version. Specifies whether the domain reports its
version as 7.10 so that it continues to work with Elasticsearch OSS
clients and plugins.
UpgradeDomain
, upgradeDomain_performCheckOnly
- When true, indicates that an upgrade eligibility check needs to be
performed. Does not actually perform the upgrade.
UpgradeDomain
, upgradeDomain_domainName
- Name of the OpenSearch Service domain that you want to upgrade.
UpgradeDomain
, upgradeDomain_targetVersion
- OpenSearch or Elasticsearch version to which you want to upgrade, in the
format Opensearch_X.Y or Elasticsearch_X.Y.
data UpgradeDomainResponse Source #
Container for the response returned by UpgradeDomain
operation.
See: newUpgradeDomainResponse
smart constructor.
UpgradeDomainResponse' (Maybe (HashMap Text Text)) (Maybe ChangeProgressDetails) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe 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:
UpgradeDomain
, upgradeDomainResponse_advancedOptions
- The advanced options configuration for the domain.
UpgradeDomainResponse
, upgradeDomainResponse_changeProgressDetails
- Container for information about a configuration change happening on a
domain.
UpgradeDomain
, upgradeDomainResponse_domainName
- The name of the domain that was upgraded.
UpgradeDomain
, upgradeDomainResponse_performCheckOnly
- When true, indicates that an upgrade eligibility check was performed.
UpgradeDomain
, upgradeDomainResponse_targetVersion
- OpenSearch or Elasticsearch version that the domain was upgraded to.
$sel:upgradeId:UpgradeDomainResponse'
, upgradeDomainResponse_upgradeId
- The unique identifier of the domain upgrade.
$sel:httpStatus:UpgradeDomainResponse'
, upgradeDomainResponse_httpStatus
- The response's http status code.
Types
AutoTuneDesiredState
newtype AutoTuneDesiredState Source #
The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
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.
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.
pattern AutoTuneType_SCHEDULED_ACTION :: AutoTuneType |
Instances
DeploymentStatus
newtype DeploymentStatus Source #
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 #
Instances
DomainPackageStatus
newtype DomainPackageStatus Source #
Instances
EngineType
newtype EngineType Source #
pattern EngineType_Elasticsearch :: EngineType | |
pattern EngineType_OpenSearch :: EngineType |
Instances
InboundConnectionStatusCode
newtype InboundConnectionStatusCode Source #
Instances
LogType
The type of log file. Can be one of the following:
- INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.
- SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the 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 to the domain.
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 #
Instances
OpenSearchWarmPartitionInstanceType
newtype OpenSearchWarmPartitionInstanceType Source #
Instances
OptionState
newtype OptionState Source #
The state of a requested domain configuration change. Can be one of the following:
- Processing - The requested change is still in progress.
- Active - The requested change is processed and deployed to the domain.
pattern OptionState_Active :: OptionState | |
pattern OptionState_Processing :: OptionState | |
pattern OptionState_RequiresIndexDocuments :: OptionState |
Instances
OutboundConnectionStatusCode
newtype OutboundConnectionStatusCode Source #
Instances
OverallChangeStatus
newtype OverallChangeStatus Source #
The overall status value of the domain configuration change.
pattern OverallChangeStatus_COMPLETED :: OverallChangeStatus | |
pattern OverallChangeStatus_FAILED :: OverallChangeStatus | |
pattern OverallChangeStatus_PENDING :: OverallChangeStatus | |
pattern OverallChangeStatus_PROCESSING :: OverallChangeStatus |
Instances
PackageStatus
newtype PackageStatus Source #
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 #
pattern PackageType_TXT_DICTIONARY :: PackageType |
Instances
PrincipalType
newtype PrincipalType Source #
pattern PrincipalType_AWS_ACCOUNT :: PrincipalType | |
pattern PrincipalType_AWS_SERVICE :: PrincipalType |
Instances
ReservedInstancePaymentOption
newtype ReservedInstancePaymentOption Source #
Instances
RollbackOnDisable
newtype RollbackOnDisable Source #
The rollback state while disabling Auto-Tune for the domain.
pattern RollbackOnDisable_DEFAULT_ROLLBACK :: RollbackOnDisable | |
pattern RollbackOnDisable_NO_ROLLBACK :: RollbackOnDisable |
Instances
ScheduledAutoTuneActionType
newtype ScheduledAutoTuneActionType Source #
The Auto-Tune action type.
pattern ScheduledAutoTuneActionType_JVM_HEAP_SIZE_TUNING :: ScheduledAutoTuneActionType | |
pattern ScheduledAutoTuneActionType_JVM_YOUNG_GEN_TUNING :: ScheduledAutoTuneActionType |
Instances
ScheduledAutoTuneSeverityType
newtype ScheduledAutoTuneSeverityType Source #
The Auto-Tune action severity.
Instances
TLSSecurityPolicy
newtype TLSSecurityPolicy Source #
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
.
pattern TimeUnit_HOURS :: TimeUnit |
Instances
UpgradeStatus
newtype UpgradeStatus Source #
pattern UpgradeStatus_FAILED :: UpgradeStatus | |
pattern UpgradeStatus_IN_PROGRESS :: UpgradeStatus | |
pattern UpgradeStatus_SUCCEEDED :: UpgradeStatus | |
pattern UpgradeStatus_SUCCEEDED_WITH_ISSUES :: UpgradeStatus |
Instances
UpgradeStep
newtype UpgradeStep Source #
pattern UpgradeStep_PRE_UPGRADE_CHECK :: UpgradeStep | |
pattern UpgradeStep_SNAPSHOT :: UpgradeStep | |
pattern UpgradeStep_UPGRADE :: UpgradeStep |
Instances
VolumeType
newtype VolumeType Source #
The type of EBS volume that a domain uses. For more information, see Configuring EBS-based storage.
pattern VolumeType_Gp2 :: VolumeType | |
pattern VolumeType_Gp3 :: VolumeType | |
pattern VolumeType_Io1 :: VolumeType | |
pattern VolumeType_Standard :: VolumeType |
Instances
VpcEndpointErrorCode
newtype VpcEndpointErrorCode Source #
pattern VpcEndpointErrorCode_ENDPOINT_NOT_FOUND :: VpcEndpointErrorCode | |
pattern VpcEndpointErrorCode_SERVER_ERROR :: VpcEndpointErrorCode |
Instances
VpcEndpointStatus
newtype VpcEndpointStatus Source #
pattern VpcEndpointStatus_ACTIVE :: VpcEndpointStatus | |
pattern VpcEndpointStatus_CREATE_FAILED :: VpcEndpointStatus | |
pattern VpcEndpointStatus_CREATING :: VpcEndpointStatus | |
pattern VpcEndpointStatus_DELETE_FAILED :: VpcEndpointStatus | |
pattern VpcEndpointStatus_DELETING :: VpcEndpointStatus | |
pattern VpcEndpointStatus_UPDATE_FAILED :: VpcEndpointStatus | |
pattern VpcEndpointStatus_UPDATING :: VpcEndpointStatus |
Instances
AWSDomainInformation
data AWSDomainInformation Source #
Information about an Amazon OpenSearch Service domain.
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
- The Amazon Web Services account ID of the domain owner.
$sel:region:AWSDomainInformation'
, aWSDomainInformation_region
- The Amazon Web Services Region in which the domain is located.
$sel:domainName:AWSDomainInformation'
, aWSDomainInformation_domainName
- Name of the domain.
AccessPoliciesStatus
data AccessPoliciesStatus Source #
The configured access rules for the domain's search endpoint, and the current status of those rules.
See: newAccessPoliciesStatus
smart constructor.
Instances
newAccessPoliciesStatus Source #
:: 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. For more information, see
Configuring access policies.
$sel:status:AccessPoliciesStatus'
, accessPoliciesStatus_status
- The status of the access policy for the domain.
AdditionalLimit
data AdditionalLimit Source #
List of limits that are specific to a given instance type.
See: newAdditionalLimit
smart constructor.
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
- - MaximumNumberOfDataNodesSupported
- This attribute only applies to
master nodes and specifies the maximum number of data nodes of a
given instance type a master node can support.
MaximumNumberOfDataNodesWithoutMasterNode
- This attribute only applies to data nodes and specifies the maximum number of data nodes of a given instance type can exist without a master node governing them.
$sel:limitValues:AdditionalLimit'
, additionalLimit_limitValues
- The values of the additional instance type limits.
AdvancedOptionsStatus
data AdvancedOptionsStatus Source #
Status of the advanced options for the specified domain. The following options are available:
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true."indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded."indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in aTooManyClauses
error."override_main_response_version": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
See: newAdvancedOptionsStatus
smart constructor.
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 status of advanced options for the specified domain.
AdvancedSecurityOptions
data AdvancedSecurityOptions Source #
Container for fine-grained access control settings.
See: newAdvancedSecurityOptions
smart constructor.
AdvancedSecurityOptions' (Maybe POSIX) (Maybe Bool) (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:anonymousAuthDisableDate:AdvancedSecurityOptions'
, advancedSecurityOptions_anonymousAuthDisableDate
- Date and time when the migration period will be disabled. Only necessary
when
enabling fine-grained access control on an existing domain.
$sel:anonymousAuthEnabled:AdvancedSecurityOptions'
, advancedSecurityOptions_anonymousAuthEnabled
- True if a 30-day migration period is enabled, during which
administrators can create role mappings. Only necessary when
enabling fine-grained access control on an existing domain.
AdvancedSecurityOptions
, advancedSecurityOptions_enabled
- True if fine-grained access control is enabled.
$sel:internalUserDatabaseEnabled:AdvancedSecurityOptions'
, advancedSecurityOptions_internalUserDatabaseEnabled
- True if the internal user database is enabled.
$sel:sAMLOptions:AdvancedSecurityOptions'
, advancedSecurityOptions_sAMLOptions
- Container for information about the SAML configuration for OpenSearch
Dashboards.
AdvancedSecurityOptionsInput
data AdvancedSecurityOptionsInput Source #
Options for enabling and configuring fine-grained access control. For more information, see Fine-grained access control in Amazon OpenSearch Service.
See: newAdvancedSecurityOptionsInput
smart constructor.
AdvancedSecurityOptionsInput' (Maybe Bool) (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:anonymousAuthEnabled:AdvancedSecurityOptionsInput'
, advancedSecurityOptionsInput_anonymousAuthEnabled
- True to enable a 30-day migration period during which administrators can
create role mappings. Only necessary when
enabling fine-grained access control on an existing domain.
AdvancedSecurityOptionsInput
, advancedSecurityOptionsInput_enabled
- True to enable fine-grained access control.
$sel:internalUserDatabaseEnabled:AdvancedSecurityOptionsInput'
, advancedSecurityOptionsInput_internalUserDatabaseEnabled
- True to enable the internal user database.
$sel:masterUserOptions:AdvancedSecurityOptionsInput'
, advancedSecurityOptionsInput_masterUserOptions
- Container for information about the master user.
$sel:sAMLOptions:AdvancedSecurityOptionsInput'
, advancedSecurityOptionsInput_sAMLOptions
- Container for information about the SAML configuration for OpenSearch
Dashboards.
AdvancedSecurityOptionsStatus
data AdvancedSecurityOptionsStatus Source #
The status of fine-grained access control settings for a domain.
See: newAdvancedSecurityOptionsStatus
smart constructor.
Instances
newAdvancedSecurityOptionsStatus Source #
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
- Container for fine-grained access control settings.
$sel:status:AdvancedSecurityOptionsStatus'
, advancedSecurityOptionsStatus_status
- Status of the fine-grained access control settings for a domain.
AuthorizedPrincipal
data AuthorizedPrincipal Source #
Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
See: newAuthorizedPrincipal
smart constructor.
Instances
newAuthorizedPrincipal :: AuthorizedPrincipal Source #
Create a value of AuthorizedPrincipal
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:principal:AuthorizedPrincipal'
, authorizedPrincipal_principal
- The
IAM principal
that is allowed access to the domain.
$sel:principalType:AuthorizedPrincipal'
, authorizedPrincipal_principalType
- The type of principal.
AutoTune
Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
See: newAutoTune
smart constructor.
Instances
FromJSON AutoTune Source # | |
Generic AutoTune Source # | |
Read AutoTune Source # | |
Show AutoTune Source # | |
NFData AutoTune Source # | |
Defined in Amazonka.OpenSearch.Types.AutoTune | |
Eq AutoTune Source # | |
Hashable AutoTune Source # | |
Defined in Amazonka.OpenSearch.Types.AutoTune | |
type Rep AutoTune Source # | |
Defined in Amazonka.OpenSearch.Types.AutoTune type Rep AutoTune = D1 ('MetaData "AutoTune" "Amazonka.OpenSearch.Types.AutoTune" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" '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
- Details about an Auto-Tune action.
$sel:autoTuneType:AutoTune'
, autoTune_autoTuneType
- The type of Auto-Tune action.
AutoTuneDetails
data AutoTuneDetails Source #
Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
See: newAutoTuneDetails
smart constructor.
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
- Container for details about a scheduled Auto-Tune action.
AutoTuneMaintenanceSchedule
data AutoTuneMaintenanceSchedule Source #
The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.
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:cronExpressionForRecurrence:AutoTuneMaintenanceSchedule'
, autoTuneMaintenanceSchedule_cronExpressionForRecurrence
- A cron expression for a recurring maintenance schedule during which
Auto-Tune can deploy changes.
$sel:duration:AutoTuneMaintenanceSchedule'
, autoTuneMaintenanceSchedule_duration
- The duration of the maintenance schedule. For example,
"Duration": {"Value": 2, "Unit": "HOURS"}
.
$sel:startAt:AutoTuneMaintenanceSchedule'
, autoTuneMaintenanceSchedule_startAt
- The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
AutoTuneOptions
data AutoTuneOptions Source #
Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
See: newAutoTuneOptions
smart constructor.
AutoTuneOptions' (Maybe AutoTuneDesiredState) (Maybe [AutoTuneMaintenanceSchedule]) (Maybe RollbackOnDisable) |
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
- Whether Auto-Tune is enabled or disabled.
$sel:maintenanceSchedules:AutoTuneOptions'
, autoTuneOptions_maintenanceSchedules
- A list of maintenance schedules during which Auto-Tune can deploy
changes.
$sel:rollbackOnDisable:AutoTuneOptions'
, autoTuneOptions_rollbackOnDisable
- When disabling Auto-Tune, specify NO_ROLLBACK
to retain all prior
Auto-Tune settings or DEFAULT_ROLLBACK
to revert to the OpenSearch
Service defaults. If you specify DEFAULT_ROLLBACK
, you must include a
MaintenanceSchedule
in the request. Otherwise, OpenSearch Service is
unable to perform the rollback.
AutoTuneOptionsInput
data AutoTuneOptionsInput Source #
Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service.
See: newAutoTuneOptionsInput
smart constructor.
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
- Whether Auto-Tune is enabled or disabled.
$sel:maintenanceSchedules:AutoTuneOptionsInput'
, autoTuneOptionsInput_maintenanceSchedules
- A list of maintenance schedules during which Auto-Tune can deploy
changes. Maintenance schedules are overwrite, not append. If your
request includes no schedules, the request deletes all existing
schedules. To preserve existing schedules, make a call to
DescribeDomainConfig
first and use the MaintenanceSchedules
portion
of the response as the basis for this section.
AutoTuneOptionsOutput
data AutoTuneOptionsOutput Source #
The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.
See: newAutoTuneOptionsOutput
smart constructor.
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:errorMessage:AutoTuneOptionsOutput'
, autoTuneOptionsOutput_errorMessage
- Any errors that occurred while enabling or disabling Auto-Tune.
$sel:state:AutoTuneOptionsOutput'
, autoTuneOptionsOutput_state
- The current state of Auto-Tune on the domain.
AutoTuneOptionsStatus
data AutoTuneOptionsStatus Source #
The Auto-Tune status for the domain.
See: newAutoTuneOptionsStatus
smart constructor.
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:options:AutoTuneOptionsStatus'
, autoTuneOptionsStatus_options
- Auto-Tune settings for updating a domain.
$sel:status:AutoTuneOptionsStatus'
, autoTuneOptionsStatus_status
- The current status of Auto-Tune for a domain.
AutoTuneStatus
data AutoTuneStatus Source #
The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
See: newAutoTuneStatus
smart constructor.
Instances
:: 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:errorMessage:AutoTuneStatus'
, autoTuneStatus_errorMessage
- Any errors that occurred while enabling or disabling Auto-Tune.
$sel:pendingDeletion:AutoTuneStatus'
, autoTuneStatus_pendingDeletion
- Indicates whether the domain is being deleted.
$sel:updateVersion:AutoTuneStatus'
, autoTuneStatus_updateVersion
- The latest version of the Auto-Tune options.
$sel:creationDate:AutoTuneStatus'
, autoTuneStatus_creationDate
- Date and time when Auto-Tune was enabled for the domain.
$sel:updateDate:AutoTuneStatus'
, autoTuneStatus_updateDate
- Date and time when the Auto-Tune options were last updated for the
domain.
$sel:state:AutoTuneStatus'
, autoTuneStatus_state
- The current state of Auto-Tune on the domain.
ChangeProgressDetails
data ChangeProgressDetails Source #
Container for information about a configuration change happening on a domain.
See: newChangeProgressDetails
smart constructor.
Instances
newChangeProgressDetails :: ChangeProgressDetails Source #
Create a value of ChangeProgressDetails
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:changeId:ChangeProgressDetails'
, changeProgressDetails_changeId
- The ID of the configuration change.
$sel:message:ChangeProgressDetails'
, changeProgressDetails_message
- A message corresponding to the status of the configuration change.
ChangeProgressStage
data ChangeProgressStage Source #
Progress details for each stage of a domain update.
See: newChangeProgressStage
smart constructor.
Instances
newChangeProgressStage :: ChangeProgressStage Source #
Create a value of ChangeProgressStage
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:description:ChangeProgressStage'
, changeProgressStage_description
- The description of the stage.
$sel:lastUpdated:ChangeProgressStage'
, changeProgressStage_lastUpdated
- The most recent updated timestamp of the stage.
$sel:name:ChangeProgressStage'
, changeProgressStage_name
- The name of the stage.
$sel:status:ChangeProgressStage'
, changeProgressStage_status
- The status of the stage.
ChangeProgressStatusDetails
data ChangeProgressStatusDetails Source #
The progress details of a specific domain configuration change.
See: newChangeProgressStatusDetails
smart constructor.
ChangeProgressStatusDetails' (Maybe Text) (Maybe [ChangeProgressStage]) (Maybe [Text]) (Maybe [Text]) (Maybe POSIX) (Maybe OverallChangeStatus) (Maybe Int) |
Instances
newChangeProgressStatusDetails :: ChangeProgressStatusDetails Source #
Create a value of ChangeProgressStatusDetails
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:changeId:ChangeProgressStatusDetails'
, changeProgressStatusDetails_changeId
- The unique change identifier associated with a specific domain
configuration change.
$sel:changeProgressStages:ChangeProgressStatusDetails'
, changeProgressStatusDetails_changeProgressStages
- The specific stages that the domain is going through to perform the
configuration change.
$sel:completedProperties:ChangeProgressStatusDetails'
, changeProgressStatusDetails_completedProperties
- The list of properties in the domain configuration change that have
completed.
$sel:pendingProperties:ChangeProgressStatusDetails'
, changeProgressStatusDetails_pendingProperties
- The list of properties in the domain configuration change that are still
pending.
$sel:startTime:ChangeProgressStatusDetails'
, changeProgressStatusDetails_startTime
- The time at which the configuration change is made on the domain.
ChangeProgressStatusDetails
, changeProgressStatusDetails_status
- The overall status of the domain configuration change.
$sel:totalNumberOfStages:ChangeProgressStatusDetails'
, changeProgressStatusDetails_totalNumberOfStages
- The total number of stages required for the configuration change.
ClusterConfig
data ClusterConfig Source #
Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
See: newClusterConfig
smart constructor.
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:coldStorageOptions:ClusterConfig'
, clusterConfig_coldStorageOptions
- Container for cold storage configuration options.
$sel:dedicatedMasterCount:ClusterConfig'
, clusterConfig_dedicatedMasterCount
- Number of dedicated master nodes in the cluster. This number must be
greater than 1, otherwise you receive a validation exception.
$sel:dedicatedMasterEnabled:ClusterConfig'
, clusterConfig_dedicatedMasterEnabled
- Indicates whether dedicated master nodes are enabled for the
cluster.True
if the cluster will use a dedicated master node.False
if the cluster will not.
$sel:dedicatedMasterType:ClusterConfig'
, clusterConfig_dedicatedMasterType
- OpenSearch Service instance type of the dedicated master nodes in the
cluster.
$sel:instanceCount:ClusterConfig'
, clusterConfig_instanceCount
- Number of dedicated master nodes in the cluster. This number must be
greater than 1, otherwise you receive a validation exception.
$sel:instanceType:ClusterConfig'
, clusterConfig_instanceType
- Instance type of data nodes in the cluster.
$sel:warmCount:ClusterConfig'
, clusterConfig_warmCount
- The number of warm nodes in the cluster.
$sel:warmEnabled:ClusterConfig'
, clusterConfig_warmEnabled
- Whether to enable warm storage for the cluster.
$sel:warmType:ClusterConfig'
, clusterConfig_warmType
- The instance type for the cluster's warm nodes.
$sel:zoneAwarenessConfig:ClusterConfig'
, clusterConfig_zoneAwarenessConfig
- Container for zone awareness configuration options. Only required if
ZoneAwarenessEnabled
is true
.
$sel:zoneAwarenessEnabled:ClusterConfig'
, clusterConfig_zoneAwarenessEnabled
- Indicates whether multiple Availability Zones are enabled. For more
information, see
Configuring a multi-AZ domain in Amazon OpenSearch Service.
ClusterConfigStatus
data ClusterConfigStatus Source #
The cluster configuration status for a domain.
See: newClusterConfigStatus
smart constructor.
Instances
newClusterConfigStatus Source #
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
- Cluster configuration options for the specified domain.
$sel:status:ClusterConfigStatus'
, clusterConfigStatus_status
- The status of cluster configuration options for the specified domain.
CognitoOptions
data CognitoOptions Source #
Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. 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:enabled:CognitoOptions'
, cognitoOptions_enabled
- Whether to enable or disable Amazon Cognito authentication for
OpenSearch Dashboards.
$sel:identityPoolId:CognitoOptions'
, cognitoOptions_identityPoolId
- The Amazon Cognito identity pool ID that you want OpenSearch Service to
use for OpenSearch Dashboards authentication.
$sel:roleArn:CognitoOptions'
, cognitoOptions_roleArn
- The AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch
Service to configure your user pool and identity pool.
$sel:userPoolId:CognitoOptions'
, cognitoOptions_userPoolId
- The Amazon Cognito user pool ID that you want OpenSearch Service to use
for OpenSearch Dashboards authentication.
CognitoOptionsStatus
data CognitoOptionsStatus Source #
The status of the Cognito options for the specified domain.
See: newCognitoOptionsStatus
smart constructor.
Instances
newCognitoOptionsStatus Source #
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 #
Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service.
See: newColdStorageOptions
smart constructor.
Instances
newColdStorageOptions Source #
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
- Whether to enable or disable cold storage on the domain.
CompatibleVersionsMap
data CompatibleVersionsMap Source #
A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
See: newCompatibleVersionsMap
smart constructor.
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 that the OpenSearch Service domain is running.
$sel:targetVersions:CompatibleVersionsMap'
, compatibleVersionsMap_targetVersions
- The possible versions that you can upgrade the domain to.
DescribePackagesFilter
data DescribePackagesFilter Source #
A filter to apply to the DescribePackage
response.
See: newDescribePackagesFilter
smart constructor.
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:name:DescribePackagesFilter'
, describePackagesFilter_name
- Any field from PackageDetails
.
$sel:value:DescribePackagesFilter'
, describePackagesFilter_value
- A list of values for the specified filter field.
DomainConfig
data DomainConfig Source #
Container for the configuration of an OpenSearch Service domain.
See: newDomainConfig
smart constructor.
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:accessPolicies:DomainConfig'
, domainConfig_accessPolicies
- Specifies the access policies for the domain.
$sel:advancedOptions:DomainConfig'
, domainConfig_advancedOptions
- Key-value pairs to specify advanced configuration options. For more
information, see
Advanced options.
$sel:advancedSecurityOptions:DomainConfig'
, domainConfig_advancedSecurityOptions
- Container for fine-grained access control settings for the domain.
$sel:autoTuneOptions:DomainConfig'
, domainConfig_autoTuneOptions
- Container for Auto-Tune settings for the domain.
$sel:changeProgressDetails:DomainConfig'
, domainConfig_changeProgressDetails
- Container for information about the progress of an existing
configuration change.
$sel:clusterConfig:DomainConfig'
, domainConfig_clusterConfig
- Container for the cluster configuration of a the domain.
$sel:cognitoOptions:DomainConfig'
, domainConfig_cognitoOptions
- Container for Amazon Cognito options for the domain.
$sel:domainEndpointOptions:DomainConfig'
, domainConfig_domainEndpointOptions
- Additional options for the domain endpoint, such as whether to require
HTTPS for all traffic.
$sel:eBSOptions:DomainConfig'
, domainConfig_eBSOptions
- Container for EBS options configured for an OpenSearch Service domain.
$sel:encryptionAtRestOptions:DomainConfig'
, domainConfig_encryptionAtRestOptions
- Key-value pairs to enable encryption at rest.
$sel:engineVersion:DomainConfig'
, domainConfig_engineVersion
- The OpenSearch or Elasticsearch version that the domain is running.
$sel:logPublishingOptions:DomainConfig'
, domainConfig_logPublishingOptions
- Key-value pairs to configure slow log publishing.
$sel:nodeToNodeEncryptionOptions:DomainConfig'
, domainConfig_nodeToNodeEncryptionOptions
- Whether node-to-node encryption is enabled or disabled.
$sel:snapshotOptions:DomainConfig'
, domainConfig_snapshotOptions
- DEPRECATED. Container for parameters required to configure automated
snapshots of domain indexes.
$sel:vPCOptions:DomainConfig'
, domainConfig_vPCOptions
- The current VPC options for the domain and the status of any updates to
their configuration.
DomainEndpointOptions
data DomainEndpointOptions Source #
Options to configure a custom endpoint for an OpenSearch Service domain.
See: newDomainEndpointOptions
smart constructor.
DomainEndpointOptions' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe TLSSecurityPolicy) |
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:customEndpoint:DomainEndpointOptions'
, domainEndpointOptions_customEndpoint
- The fully qualified URL for the custom endpoint.
$sel:customEndpointCertificateArn:DomainEndpointOptions'
, domainEndpointOptions_customEndpointCertificateArn
- The ARN for your security certificate, managed in Amazon Web Services
Certificate Manager (ACM).
$sel:customEndpointEnabled:DomainEndpointOptions'
, domainEndpointOptions_customEndpointEnabled
- Whether to enable a custom endpoint for the domain.
$sel:enforceHTTPS:DomainEndpointOptions'
, domainEndpointOptions_enforceHTTPS
- True to require that all traffic to the domain arrive over HTTPS.
$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 TLS version 1.0 and higher.
- Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2
DomainEndpointOptionsStatus
data DomainEndpointOptionsStatus Source #
The configured endpoint options for a domain and their current status.
See: newDomainEndpointOptionsStatus
smart constructor.
Instances
newDomainEndpointOptionsStatus Source #
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 a domain.
$sel:status:DomainEndpointOptionsStatus'
, domainEndpointOptionsStatus_status
- The status of the endpoint options for a domain.
DomainInfo
data DomainInfo Source #
Information about an OpenSearch Service domain.
See: newDomainInfo
smart constructor.
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
- Name of the domain.
$sel:engineType:DomainInfo'
, domainInfo_engineType
- The type of search engine that the domain is running.OpenSearch
for an
OpenSearch engine, or Elasticsearch
for a legacy Elasticsearch OSS
engine.
DomainInformationContainer
data DomainInformationContainer Source #
Container for information about an OpenSearch Service domain.
See: newDomainInformationContainer
smart constructor.
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
- Information about an Amazon OpenSearch Service domain.
DomainPackageDetails
data DomainPackageDetails Source #
Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.
See: newDomainPackageDetails
smart constructor.
DomainPackageDetails' (Maybe Text) (Maybe DomainPackageStatus) (Maybe ErrorDetails) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe PackageType) (Maybe Text) (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:domainName:DomainPackageDetails'
, domainPackageDetails_domainName
- Name of the domain that the package is associated with.
$sel:domainPackageStatus:DomainPackageDetails'
, domainPackageDetails_domainPackageStatus
- State of the association.
$sel:errorDetails:DomainPackageDetails'
, domainPackageDetails_errorDetails
- Additional information if the package is in an error state. Null
otherwise.
$sel:lastUpdated:DomainPackageDetails'
, domainPackageDetails_lastUpdated
- Timestamp of the most recent update to the package association status.
$sel:packageID:DomainPackageDetails'
, domainPackageDetails_packageID
- Internal ID of the package.
$sel:packageName:DomainPackageDetails'
, domainPackageDetails_packageName
- User-specified name of the package.
$sel:packageType:DomainPackageDetails'
, domainPackageDetails_packageType
- The type of package.
$sel:packageVersion:DomainPackageDetails'
, domainPackageDetails_packageVersion
- The current version of the package.
$sel:referencePath:DomainPackageDetails'
, domainPackageDetails_referencePath
- Denotes the location of the package on the OpenSearch Service cluster
nodes. It's the same as synonym_path
for dictionary files.
DomainStatus
data DomainStatus Source #
The current status of an OpenSearch Service domain.
See: newDomainStatus
smart constructor.
Instances
:: 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:accessPolicies:DomainStatus'
, domainStatus_accessPolicies
- Identity and Access Management (IAM) policy document specifying the
access policies for the domain.
$sel:advancedOptions:DomainStatus'
, domainStatus_advancedOptions
- Key-value pairs that specify advanced configuration options.
$sel:advancedSecurityOptions:DomainStatus'
, domainStatus_advancedSecurityOptions
- Settings for fine-grained access control.
$sel:autoTuneOptions:DomainStatus'
, domainStatus_autoTuneOptions
- Auto-Tune settings for the domain.
$sel:changeProgressDetails:DomainStatus'
, domainStatus_changeProgressDetails
- Information about a configuration change happening on the domain.
$sel:cognitoOptions:DomainStatus'
, domainStatus_cognitoOptions
- Key-value pairs to configure Amazon Cognito authentication for
OpenSearch Dashboards.
$sel:created:DomainStatus'
, domainStatus_created
- Creation status of an OpenSearch Service domain. True if domain creation
is complete. False if domain creation is still in progress.
$sel:deleted:DomainStatus'
, domainStatus_deleted
- Deletion status of an OpenSearch Service domain. True if domain deletion
is complete. False if domain deletion is still in progress. Once
deletion is complete, the status of the domain is no longer returned.
$sel:domainEndpointOptions:DomainStatus'
, domainStatus_domainEndpointOptions
- Additional options for the domain endpoint, such as whether to require
HTTPS for all traffic.
$sel:eBSOptions:DomainStatus'
, domainStatus_eBSOptions
- Container for EBS-based storage settings for the domain.
$sel:encryptionAtRestOptions:DomainStatus'
, domainStatus_encryptionAtRestOptions
- Encryption at rest settings for the domain.
$sel:endpoint:DomainStatus'
, domainStatus_endpoint
- Domain-specific endpoint used to submit index, search, and data upload
requests to the domain.
$sel:endpoints:DomainStatus'
, domainStatus_endpoints
- The key-value pair that exists if the OpenSearch Service domain uses VPC
endpoints.. Example key, value
:
'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
.
$sel:engineVersion:DomainStatus'
, domainStatus_engineVersion
- Version of OpenSearch or Elasticsearch that the domain is running, in
the format Elasticsearch_X.Y
or OpenSearch_X.Y
.
$sel:logPublishingOptions:DomainStatus'
, domainStatus_logPublishingOptions
- Log publishing options for the domain.
$sel:nodeToNodeEncryptionOptions:DomainStatus'
, domainStatus_nodeToNodeEncryptionOptions
- Whether node-to-node encryption is enabled or disabled.
$sel:processing:DomainStatus'
, domainStatus_processing
- The status of the domain configuration. True if OpenSearch Service is
processing configuration changes. False if the configuration is active.
$sel:serviceSoftwareOptions:DomainStatus'
, domainStatus_serviceSoftwareOptions
- The current status of the domain's service software.
$sel:snapshotOptions:DomainStatus'
, domainStatus_snapshotOptions
- DEPRECATED. Container for parameters required to configure automated
snapshots of domain indexes.
$sel:upgradeProcessing:DomainStatus'
, domainStatus_upgradeProcessing
- The status of a domain version upgrade to a new version of OpenSearch or
Elasticsearch. True if OpenSearch Service is in the process of a version
upgrade. False if the configuration is active.
$sel:vPCOptions:DomainStatus'
, domainStatus_vPCOptions
- The VPC configuration for the domain.
$sel:domainId:DomainStatus'
, domainStatus_domainId
- Unique identifier for the domain.
$sel:domainName:DomainStatus'
, domainStatus_domainName
- Name of the domain. Domain names are unique across all domains owned by
the same account within an Amazon Web Services Region.
$sel:arn:DomainStatus'
, domainStatus_arn
- The Amazon Resource Name (ARN) of the domain. For more information, see
IAM identifiers
in the AWS Identity and Access Management User Guide.
$sel:clusterConfig:DomainStatus'
, domainStatus_clusterConfig
- Container for the cluster configuration of the domain.
DryRunResults
data DryRunResults Source #
Results of a dry run performed in an update domain request.
See: newDryRunResults
smart constructor.
DryRunResults' (Maybe Text) (Maybe Text) |
Instances
newDryRunResults :: DryRunResults Source #
Create a value of DryRunResults
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:deploymentType:DryRunResults'
, dryRunResults_deploymentType
- Specifies the way in which OpenSearch Service will apply an update.
Possible values are:
- Blue/Green - The update requires a blue/green deployment.
- DynamicUpdate - No blue/green deployment required
- Undetermined - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete.
- None - The request doesn't include any configuration changes.
$sel:message:DryRunResults'
, dryRunResults_message
- A message corresponding to the deployment type.
Duration
The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.
See: newDuration
smart constructor.
Instances
FromJSON Duration Source # | |
ToJSON Duration Source # | |
Defined in Amazonka.OpenSearch.Types.Duration | |
Generic Duration Source # | |
Read Duration Source # | |
Show Duration Source # | |
NFData Duration Source # | |
Defined in Amazonka.OpenSearch.Types.Duration | |
Eq Duration Source # | |
Hashable Duration Source # | |
Defined in Amazonka.OpenSearch.Types.Duration | |
type Rep Duration Source # | |
Defined in Amazonka.OpenSearch.Types.Duration type Rep Duration = D1 ('MetaData "Duration" "Amazonka.OpenSearch.Types.Duration" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "Duration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeUnit)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) |
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:unit:Duration'
, duration_unit
- The unit of measurement for the duration of a maintenance schedule.
$sel:value:Duration'
, duration_value
- Integer to specify the value of a maintenance schedule duration.
EBSOptions
data EBSOptions Source #
Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
See: newEBSOptions
smart constructor.
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:eBSEnabled:EBSOptions'
, eBSOptions_eBSEnabled
- Indicates whether EBS volumes are attached to data nodes in an
OpenSearch Service domain.
$sel:iops:EBSOptions'
, eBSOptions_iops
- Specifies the baseline input/output (I/O) performance of EBS volumes
attached to data nodes. Applicable only for the gp3
and provisioned
IOPS EBS volume types.
$sel:throughput:EBSOptions'
, eBSOptions_throughput
- Specifies the throughput (in MiB/s) of the EBS volumes attached to data
nodes. Applicable only for the gp3
volume type.
$sel:volumeSize:EBSOptions'
, eBSOptions_volumeSize
- Specifies the size (in GiB) of EBS volumes attached to data nodes.
$sel:volumeType:EBSOptions'
, eBSOptions_volumeType
- Specifies the type of EBS volumes attached to data nodes.
EBSOptionsStatus
data EBSOptionsStatus Source #
The status of the EBS options for the specified OpenSearch Service domain.
See: newEBSOptionsStatus
smart constructor.
Instances
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 configured 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 whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can be used only to create a new domain, not update an existing one.
See: newEncryptionAtRestOptions
smart constructor.
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
- True to enable encryption at rest.
$sel:kmsKeyId:EncryptionAtRestOptions'
, encryptionAtRestOptions_kmsKeyId
- The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
.
EncryptionAtRestOptionsStatus
data EncryptionAtRestOptionsStatus Source #
Status of the encryption at rest options for the specified OpenSearch Service domain.
See: newEncryptionAtRestOptionsStatus
smart constructor.
Instances
newEncryptionAtRestOptionsStatus Source #
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
- 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 #
Additional information if the package is in an error state. Null otherwise.
See: newErrorDetails
smart constructor.
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:errorMessage:ErrorDetails'
, errorDetails_errorMessage
- A message describing the error.
$sel:errorType:ErrorDetails'
, errorDetails_errorType
- The type of error that occurred.
Filter
A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values 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
ToJSON Filter Source # | |
Defined in Amazonka.OpenSearch.Types.Filter | |
Generic Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.OpenSearch.Types.Filter | |
Eq Filter Source # | |
Hashable 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" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty 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:name:Filter'
, filter_name
- The name of the filter.
$sel:values:Filter'
, filter_values
- One or more values for the filter.
InboundConnection
data InboundConnection Source #
Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See: newInboundConnection
smart constructor.
InboundConnection' (Maybe Text) (Maybe InboundConnectionStatus) (Maybe DomainInformationContainer) (Maybe DomainInformationContainer) |
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:connectionId:InboundConnection'
, inboundConnection_connectionId
- The unique identifier of the connection.
$sel:connectionStatus:InboundConnection'
, inboundConnection_connectionStatus
- The current status of the connection.
$sel:localDomainInfo:InboundConnection'
, inboundConnection_localDomainInfo
- Information about the source (local) domain.
$sel:remoteDomainInfo:InboundConnection'
, inboundConnection_remoteDomainInfo
- Information about the destination (remote) domain.
InboundConnectionStatus
data InboundConnectionStatus Source #
The status of an inbound cross-cluster connection for OpenSearch Service.
See: newInboundConnectionStatus
smart constructor.
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
- Information about the connection.
$sel:statusCode:InboundConnectionStatus'
, inboundConnectionStatus_statusCode
- The status code for the connection. Can be one of the following:
- PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
- APPROVED: Inbound connection is pending acceptance by the remote domain owner.
- PROVISIONING: Inbound connection is being provisioned.
- ACTIVE: Inbound connection is active and ready to use.
- REJECTING: Inbound connection rejection is in process.
- REJECTED: Inbound connection is rejected.
- DELETING: Inbound connection deletion is in progress.
- DELETED: Inbound connection is deleted and can no longer be used.
InstanceCountLimits
data InstanceCountLimits Source #
Limits on the number of instances that can be created in OpenSearch Service for a given instance type.
See: newInstanceCountLimits
smart constructor.
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
- The minimum allowed number of instances.
$sel:minimumInstanceCount:InstanceCountLimits'
, instanceCountLimits_minimumInstanceCount
- The maximum allowed number of instances.
InstanceLimits
data InstanceLimits Source #
Instance-related attributes that are available for a given instance type.
See: newInstanceLimits
smart constructor.
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
- Limits on the number of instances that can be created for a given
instance type.
InstanceTypeDetails
data InstanceTypeDetails Source #
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
See: newInstanceTypeDetails
smart constructor.
InstanceTypeDetails' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe OpenSearchPartitionInstanceType) (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:advancedSecurityEnabled:InstanceTypeDetails'
, instanceTypeDetails_advancedSecurityEnabled
- Whether fine-grained access control is supported for the instance type.
$sel:appLogsEnabled:InstanceTypeDetails'
, instanceTypeDetails_appLogsEnabled
- Whether logging is supported for the instance type.
$sel:cognitoEnabled:InstanceTypeDetails'
, instanceTypeDetails_cognitoEnabled
- Whether Amazon Cognito access is supported for the instance type.
$sel:encryptionEnabled:InstanceTypeDetails'
, instanceTypeDetails_encryptionEnabled
- Whether encryption at rest and node-to-node encryption are supported for
the instance type.
$sel:instanceRole:InstanceTypeDetails'
, instanceTypeDetails_instanceRole
- Whether the instance acts as a data node, a dedicated master node, or an
UltraWarm node.
$sel:instanceType:InstanceTypeDetails'
, instanceTypeDetails_instanceType
- The instance type.
$sel:warmEnabled:InstanceTypeDetails'
, instanceTypeDetails_warmEnabled
- Whether UltraWarm is supported for the instance type.
Limits
Limits for a given instance type and for each of its roles.
See: newLimits
smart constructor.
Limits' (Maybe [AdditionalLimit]) (Maybe InstanceLimits) (Maybe [StorageType]) |
Instances
FromJSON Limits Source # | |
Generic Limits Source # | |
Read Limits Source # | |
Show Limits Source # | |
NFData Limits Source # | |
Defined in Amazonka.OpenSearch.Types.Limits | |
Eq Limits Source # | |
Hashable Limits Source # | |
Defined in Amazonka.OpenSearch.Types.Limits | |
type Rep Limits Source # | |
Defined in Amazonka.OpenSearch.Types.Limits type Rep Limits = D1 ('MetaData "Limits" "Amazonka.OpenSearch.Types.Limits" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "Limits'" 'PrefixI 'True) (S1 ('MetaSel ('Just "additionalLimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdditionalLimit])) :*: (S1 ('MetaSel ('Just "instanceLimits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceLimits)) :*: 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:additionalLimits:Limits'
, limits_additionalLimits
- List of additional limits that are specific to a given instance type for
each of its instance roles.
$sel:instanceLimits:Limits'
, limits_instanceLimits
- The limits for a given instance type.
$sel:storageTypes:Limits'
, limits_storageTypes
- Storage-related attributes that are available for a given instance type.
LogPublishingOption
data LogPublishingOption Source #
Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs.
After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.
See: newLogPublishingOption
smart constructor.
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:cloudWatchLogsLogGroupArn:LogPublishingOption'
, logPublishingOption_cloudWatchLogsLogGroupArn
- The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish
logs to.
$sel:enabled:LogPublishingOption'
, logPublishingOption_enabled
- Whether the log should be published.
LogPublishingOptionsStatus
data LogPublishingOptionsStatus Source #
The configured log publishing options for the domain and their current status.
See: newLogPublishingOptionsStatus
smart constructor.
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:options:LogPublishingOptionsStatus'
, logPublishingOptionsStatus_options
- The log publishing options configured for the domain.
$sel:status:LogPublishingOptionsStatus'
, logPublishingOptionsStatus_status
- The status of the log publishing options for the domain.
MasterUserOptions
data MasterUserOptions Source #
Credentials for the master user for a domain.
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:masterUserARN:MasterUserOptions'
, masterUserOptions_masterUserARN
- Amazon Resource Name (ARN) for the master user. Only specify if
InternalUserDatabaseEnabled
is false
.
$sel:masterUserName:MasterUserOptions'
, masterUserOptions_masterUserName
- User name for the master user. Only specify if
InternalUserDatabaseEnabled
is true
.
$sel:masterUserPassword:MasterUserOptions'
, masterUserOptions_masterUserPassword
- Password for the master user. Only specify if
InternalUserDatabaseEnabled
is true
.
NodeToNodeEncryptionOptions
data NodeToNodeEncryptionOptions Source #
Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.
See: newNodeToNodeEncryptionOptions
smart constructor.
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 #
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 an entity.
See: newOptionStatus
smart constructor.
Instances
:: 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 entity is being deleted.
$sel:updateVersion:OptionStatus'
, optionStatus_updateVersion
- The latest version of the entity.
$sel:creationDate:OptionStatus'
, optionStatus_creationDate
- The timestamp 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
- The state of the entity.
OutboundConnection
data OutboundConnection Source #
Specifies details about an outbound cross-cluster connection.
See: newOutboundConnection
smart constructor.
OutboundConnection' (Maybe Text) (Maybe Text) (Maybe OutboundConnectionStatus) (Maybe DomainInformationContainer) (Maybe DomainInformationContainer) |
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:connectionAlias:OutboundConnection'
, outboundConnection_connectionAlias
- Name of the connection.
$sel:connectionId:OutboundConnection'
, outboundConnection_connectionId
- Unique identifier of the connection.
$sel:connectionStatus:OutboundConnection'
, outboundConnection_connectionStatus
- Status of the connection.
$sel:localDomainInfo:OutboundConnection'
, outboundConnection_localDomainInfo
- Information about the source (local) domain.
$sel:remoteDomainInfo:OutboundConnection'
, outboundConnection_remoteDomainInfo
- Information about the destination (remote) domain.
OutboundConnectionStatus
data OutboundConnectionStatus Source #
The status of an outbound cross-cluster connection.
See: newOutboundConnectionStatus
smart constructor.
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.
$sel:statusCode:OutboundConnectionStatus'
, outboundConnectionStatus_statusCode
- The status code for the outbound connection. Can be one of the
following:
- VALIDATING - The outbound connection request is being validated.
- VALIDATION_FAILED - Validation failed for the connection request.
- PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
- APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
- PROVISIONING - Outbound connection request is in process.
- ACTIVE - Outbound connection is active and ready to use.
- REJECTING - Outbound connection rejection by remote domain owner is in progress.
- REJECTED - Outbound connection request is rejected by remote domain owner.
- DELETING - Outbound connection deletion is in progress.
- DELETED - Outbound connection is deleted and can no longer be used.
PackageDetails
data PackageDetails Source #
Basic information about a package.
See: newPackageDetails
smart constructor.
PackageDetails' (Maybe Text) (Maybe POSIX) (Maybe ErrorDetails) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PackageStatus) (Maybe PackageType) |
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:availablePackageVersion:PackageDetails'
, packageDetails_availablePackageVersion
- The package version.
$sel:createdAt:PackageDetails'
, packageDetails_createdAt
- The timestamp when the package was created.
$sel:errorDetails:PackageDetails'
, packageDetails_errorDetails
- Additional information if the package is in an error state. Null
otherwise.
$sel:lastUpdatedAt:PackageDetails'
, packageDetails_lastUpdatedAt
- Date and time when the package was last updated.
$sel:packageDescription:PackageDetails'
, packageDetails_packageDescription
- User-specified description of the package.
$sel:packageID:PackageDetails'
, packageDetails_packageID
- The unique identifier of the package.
$sel:packageName:PackageDetails'
, packageDetails_packageName
- User-specified name of the package.
$sel:packageStatus:PackageDetails'
, packageDetails_packageStatus
- Current status of the package.
$sel:packageType:PackageDetails'
, packageDetails_packageType
- The type of package.
PackageSource
data PackageSource Source #
The Amazon S3 location to import the package from.
See: newPackageSource
smart constructor.
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:s3BucketName:PackageSource'
, packageSource_s3BucketName
- The name of the Amazon S3 bucket containing the package.
$sel:s3Key:PackageSource'
, packageSource_s3Key
- Key (file name) of the package.
PackageVersionHistory
data PackageVersionHistory Source #
Details about 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:commitMessage:PackageVersionHistory'
, packageVersionHistory_commitMessage
- A message associated with the package version when it was uploaded.
$sel:createdAt:PackageVersionHistory'
, packageVersionHistory_createdAt
- The date and time when the package was created.
$sel:packageVersion:PackageVersionHistory'
, packageVersionHistory_packageVersion
- The package version.
RecurringCharge
data RecurringCharge Source #
Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.
See: newRecurringCharge
smart constructor.
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:recurringChargeAmount:RecurringCharge'
, recurringCharge_recurringChargeAmount
- The monetary amount of the recurring charge.
$sel:recurringChargeFrequency:RecurringCharge'
, recurringCharge_recurringChargeFrequency
- The frequency of the recurring charge.
ReservedInstance
data ReservedInstance Source #
Details of an OpenSearch Reserved Instance.
See: newReservedInstance
smart constructor.
ReservedInstance' (Maybe Integer) (Maybe Text) (Maybe Int) (Maybe Double) (Maybe Int) (Maybe OpenSearchPartitionInstanceType) (Maybe ReservedInstancePaymentOption) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Double) |
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:billingSubscriptionId:ReservedInstance'
, reservedInstance_billingSubscriptionId
- The unique identifier of the billing subscription.
$sel:currencyCode:ReservedInstance'
, reservedInstance_currencyCode
- The currency code for the offering.
$sel:duration:ReservedInstance'
, reservedInstance_duration
- The duration, in seconds, for which the OpenSearch instance is reserved.
$sel:fixedPrice:ReservedInstance'
, reservedInstance_fixedPrice
- The upfront fixed charge you will paid to purchase the specific Reserved
Instance offering.
$sel:instanceCount:ReservedInstance'
, reservedInstance_instanceCount
- The number of OpenSearch instances that have been reserved.
$sel:instanceType:ReservedInstance'
, reservedInstance_instanceType
- The OpenSearch instance type offered by theReserved Instance offering.
$sel:paymentOption:ReservedInstance'
, reservedInstance_paymentOption
- The payment option as defined in the Reserved Instance offering.
$sel:recurringCharges:ReservedInstance'
, reservedInstance_recurringCharges
- The recurring charge to your account, regardless of whether you create
any domains using the Reserved Instance offering.
$sel:reservationName:ReservedInstance'
, reservedInstance_reservationName
- The customer-specified identifier to track this reservation.
$sel:reservedInstanceId:ReservedInstance'
, reservedInstance_reservedInstanceId
- The unique identifier for the reservation.
$sel:reservedInstanceOfferingId:ReservedInstance'
, reservedInstance_reservedInstanceOfferingId
- The unique identifier of the Reserved Instance offering.
$sel:startTime:ReservedInstance'
, reservedInstance_startTime
- The date and time when the reservation was purchased.
$sel:state:ReservedInstance'
, reservedInstance_state
- The state of the Reserved Instance.
$sel:usagePrice:ReservedInstance'
, reservedInstance_usagePrice
- The hourly rate at which you're charged for the domain using this
Reserved Instance.
ReservedInstanceOffering
data ReservedInstanceOffering Source #
Details of an OpenSearch Reserved Instance offering.
See: newReservedInstanceOffering
smart constructor.
ReservedInstanceOffering' (Maybe Text) (Maybe Int) (Maybe Double) (Maybe OpenSearchPartitionInstanceType) (Maybe ReservedInstancePaymentOption) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Double) |
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 Instance offering.
$sel:duration:ReservedInstanceOffering'
, reservedInstanceOffering_duration
- The duration, in seconds, for which the offering will reserve the
OpenSearch instance.
$sel:fixedPrice:ReservedInstanceOffering'
, reservedInstanceOffering_fixedPrice
- The upfront fixed charge you will pay to purchase the specific Reserved
Instance offering.
$sel:instanceType:ReservedInstanceOffering'
, reservedInstanceOffering_instanceType
- The OpenSearch instance type offered by the Reserved Instance offering.
$sel:paymentOption:ReservedInstanceOffering'
, reservedInstanceOffering_paymentOption
- Payment option for the Reserved Instance offering
$sel:recurringCharges:ReservedInstanceOffering'
, reservedInstanceOffering_recurringCharges
- The recurring charge to your account, regardless of whether you creates
any domains using the offering.
$sel:reservedInstanceOfferingId:ReservedInstanceOffering'
, reservedInstanceOffering_reservedInstanceOfferingId
- The unique identifier of the Reserved Instance offering.
$sel:usagePrice:ReservedInstanceOffering'
, reservedInstanceOffering_usagePrice
- The hourly rate at which you're charged for the domain using this
Reserved Instance.
SAMLIdp
The SAML identity povider information.
See: newSAMLIdp
smart constructor.
Instances
FromJSON SAMLIdp Source # | |
ToJSON SAMLIdp Source # | |
Defined in Amazonka.OpenSearch.Types.SAMLIdp | |
Generic SAMLIdp Source # | |
Read SAMLIdp Source # | |
Show SAMLIdp Source # | |
NFData SAMLIdp Source # | |
Defined in Amazonka.OpenSearch.Types.SAMLIdp | |
Eq SAMLIdp Source # | |
Hashable SAMLIdp Source # | |
Defined in Amazonka.OpenSearch.Types.SAMLIdp | |
type Rep SAMLIdp Source # | |
Defined in Amazonka.OpenSearch.Types.SAMLIdp type Rep SAMLIdp = D1 ('MetaData "SAMLIdp" "Amazonka.OpenSearch.Types.SAMLIdp" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" '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 the SAML identity provider.
SAMLOptionsInput
data SAMLOptionsInput Source #
The SAML authentication configuration for an Amazon OpenSearch Service domain.
See: newSAMLOptionsInput
smart constructor.
SAMLOptionsInput' (Maybe Bool) (Maybe SAMLIdp) (Maybe Text) (Maybe (Sensitive 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:enabled:SAMLOptionsInput'
, sAMLOptionsInput_enabled
- True to enable SAML authentication for a domain.
$sel:idp:SAMLOptionsInput'
, sAMLOptionsInput_idp
- The SAML Identity Provider's information.
$sel:masterBackendRole:SAMLOptionsInput'
, sAMLOptionsInput_masterBackendRole
- The backend role that the SAML master user is mapped to.
$sel:masterUserName:SAMLOptionsInput'
, sAMLOptionsInput_masterUserName
- The SAML master user name, which is stored in the domain's internal
user database.
$sel:rolesKey:SAMLOptionsInput'
, sAMLOptionsInput_rolesKey
- Element of the SAML assertion to use for backend roles. Default is
roles
.
$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 the user name. 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 a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
See: newScheduledAutoTuneDetails
smart constructor.
ScheduledAutoTuneDetails' (Maybe Text) (Maybe ScheduledAutoTuneActionType) (Maybe POSIX) (Maybe ScheduledAutoTuneSeverityType) |
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:action:ScheduledAutoTuneDetails'
, scheduledAutoTuneDetails_action
- A description of the Auto-Tune action.
$sel:actionType:ScheduledAutoTuneDetails'
, scheduledAutoTuneDetails_actionType
- The type of Auto-Tune action.
$sel:date:ScheduledAutoTuneDetails'
, scheduledAutoTuneDetails_date
- The date and time when the Auto-Tune action is scheduled for the domain.
$sel:severity:ScheduledAutoTuneDetails'
, scheduledAutoTuneDetails_severity
- The severity of the Auto-Tune action. Valid values are LOW
, MEDIUM
,
and HIGH
.
ServiceSoftwareOptions
data ServiceSoftwareOptions Source #
The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
See: newServiceSoftwareOptions
smart constructor.
ServiceSoftwareOptions' (Maybe POSIX) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe DeploymentStatus) |
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: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:currentVersion:ServiceSoftwareOptions'
, serviceSoftwareOptions_currentVersion
- The current service software version present on the domain.
$sel:description:ServiceSoftwareOptions'
, serviceSoftwareOptions_description
- A description of the service software update status.
$sel:newVersion':ServiceSoftwareOptions'
, serviceSoftwareOptions_newVersion
- The new service software version, if one is available.
$sel:optionalDeployment:ServiceSoftwareOptions'
, serviceSoftwareOptions_optionalDeployment
- True if a service software is never automatically updated. False if a
service software is automatically updated after the automated update
date.
$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:updateStatus:ServiceSoftwareOptions'
, serviceSoftwareOptions_updateStatus
- The status of your service software update.
SnapshotOptions
data SnapshotOptions Source #
The time, in UTC format, when OpenSearch Service takes a daily automated
snapshot of the specified domain. Default is 0
hours.
See: newSnapshotOptions
smart constructor.
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 OpenSearch Service takes a daily automated
snapshot of the specified domain. Default is 0
hours.
SnapshotOptionsStatus
data SnapshotOptionsStatus Source #
Container for information about a daily automated snapshot for an OpenSearch Service domain.
See: newSnapshotOptionsStatus
smart constructor.
Instances
newSnapshotOptionsStatus Source #
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 #
A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.
See: newStorageType
smart constructor.
StorageType' (Maybe Text) (Maybe [StorageTypeLimit]) (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:storageSubTypeName:StorageType'
, storageType_storageSubTypeName
- The storage sub-type, such as gp3
or io1
.
$sel:storageTypeLimits:StorageType'
, storageType_storageTypeLimits
- Limits that are applicable for the given storage type.
$sel:storageTypeName:StorageType'
, storageType_storageTypeName
- The name of the storage type.
StorageTypeLimit
data StorageTypeLimit Source #
Limits that are applicable for the given Amazon OpenSearch Service storage type.
See: newStorageTypeLimit
smart constructor.
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 options are available:
- MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.
- MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.
- MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
- MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
- MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
- MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
$sel:limitValues:StorageTypeLimit'
, storageTypeLimit_limitValues
- The limit values.
Tag
A tag (key-value pair) for an Amazon OpenSearch Service resource.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.OpenSearch.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.OpenSearch.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.OpenSearch.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.OpenSearch.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.OpenSearch.Types.Tag" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" '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 tag key. Tag keys must be unique for the domain to which they are
attached.
$sel:value:Tag'
, tag_value
- 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 for an Amazon OpenSearch Service domain.
See: newUpgradeHistory
smart constructor.
UpgradeHistory' (Maybe POSIX) (Maybe [UpgradeStepItem]) (Maybe Text) (Maybe UpgradeStatus) |
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:startTimestamp:UpgradeHistory'
, upgradeHistory_startTimestamp
- UTC timestamp at which the upgrade API call was made, in the format
yyyy-MM-ddTHH:mm:ssZ
.
$sel:stepsList:UpgradeHistory'
, upgradeHistory_stepsList
- A list of each step performed as part of a specific upgrade or upgrade
eligibility check.
$sel:upgradeName:UpgradeHistory'
, upgradeHistory_upgradeName
- A string that describes the upgrade.
$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
UpgradeStepItem
data UpgradeStepItem Source #
Represents a single step of an upgrade or upgrade eligibility check workflow.
See: newUpgradeStepItem
smart constructor.
UpgradeStepItem' (Maybe [Text]) (Maybe Double) (Maybe UpgradeStep) (Maybe UpgradeStatus) |
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:issues:UpgradeStepItem'
, upgradeStepItem_issues
- A list of strings containing detailed information about the errors
encountered in a particular step.
$sel:progressPercent:UpgradeStepItem'
, upgradeStepItem_progressPercent
- The floating point value representing the progress percentage of a
particular step.
$sel:upgradeStep:UpgradeStepItem'
, upgradeStepItem_upgradeStep
- One of three steps that an upgrade or upgrade eligibility check goes
through:
- PreUpgradeCheck
- Snapshot
- Upgrade
$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
VPCDerivedInfo
data VPCDerivedInfo Source #
Information about the subnets and security groups for an Amazon
OpenSearch Service domain provisioned within a virtual private cloud
(VPC). For more information, see
Launching your Amazon OpenSearch Service domains using a VPC.
This information only exists if the domain was created with
VPCOptions
.
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:availabilityZones:VPCDerivedInfo'
, vPCDerivedInfo_availabilityZones
- The list of Availability Zones associated with the VPC subnets.
$sel:securityGroupIds:VPCDerivedInfo'
, vPCDerivedInfo_securityGroupIds
- The list of security group IDs associated with the VPC endpoints for the
domain.
$sel:subnetIds:VPCDerivedInfo'
, vPCDerivedInfo_subnetIds
- A list of subnet IDs associated with the VPC endpoints for the domain.
$sel:vPCId:VPCDerivedInfo'
, vPCDerivedInfo_vPCId
- The ID for your VPC. Amazon VPC generates this value when you create a
VPC.
VPCDerivedInfoStatus
data VPCDerivedInfoStatus Source #
Status of the VPC options for a specified domain.
See: newVPCDerivedInfoStatus
smart constructor.
Instances
newVPCDerivedInfoStatus Source #
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 an Amazon OpenSearch Service VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
See: newVPCOptions
smart constructor.
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 list of security group IDs associated with the VPC endpoints for the
domain. If you do not provide a security group ID, OpenSearch Service
uses the default security group for the VPC.
$sel:subnetIds:VPCOptions'
, vPCOptions_subnetIds
- A list of subnet IDs associated with the VPC endpoints for the domain.
If your domain uses multiple Availability Zones, you need to provide two
subnet IDs, one per zone. Otherwise, provide only one.
VersionStatus
data VersionStatus Source #
The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.
See: newVersionStatus
smart constructor.
Instances
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 or Elasticsearch version for the specified domain.
$sel:status:VersionStatus'
, versionStatus_status
- The status of the version options for the specified domain.
VpcEndpoint
data VpcEndpoint Source #
The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.
See: newVpcEndpoint
smart constructor.
VpcEndpoint' (Maybe Text) (Maybe Text) (Maybe VpcEndpointStatus) (Maybe Text) (Maybe Text) (Maybe VPCDerivedInfo) |
Instances
newVpcEndpoint :: VpcEndpoint Source #
Create a value of VpcEndpoint
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:domainArn:VpcEndpoint'
, vpcEndpoint_domainArn
- The Amazon Resource Name (ARN) of the domain associated with the
endpoint.
$sel:endpoint:VpcEndpoint'
, vpcEndpoint_endpoint
- The connection endpoint ID for connecting to the domain.
$sel:status:VpcEndpoint'
, vpcEndpoint_status
- The current status of the endpoint.
$sel:vpcEndpointId:VpcEndpoint'
, vpcEndpoint_vpcEndpointId
- The unique identifier of the endpoint.
$sel:vpcEndpointOwner:VpcEndpoint'
, vpcEndpoint_vpcEndpointOwner
- The creator of the endpoint.
$sel:vpcOptions:VpcEndpoint'
, vpcEndpoint_vpcOptions
- Options to specify the subnets and security groups for an Amazon
OpenSearch Service VPC endpoint.
VpcEndpointError
data VpcEndpointError Source #
Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.
See: newVpcEndpointError
smart constructor.
Instances
newVpcEndpointError :: VpcEndpointError Source #
Create a value of VpcEndpointError
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:errorCode:VpcEndpointError'
, vpcEndpointError_errorCode
- The code associated with the error.
$sel:errorMessage:VpcEndpointError'
, vpcEndpointError_errorMessage
- A message describing the error.
$sel:vpcEndpointId:VpcEndpointError'
, vpcEndpointError_vpcEndpointId
- The unique identifier of the endpoint.
VpcEndpointSummary
data VpcEndpointSummary Source #
Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
See: newVpcEndpointSummary
smart constructor.
Instances
newVpcEndpointSummary :: VpcEndpointSummary Source #
Create a value of VpcEndpointSummary
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:domainArn:VpcEndpointSummary'
, vpcEndpointSummary_domainArn
- The Amazon Resource Name (ARN) of the domain associated with the
endpoint.
$sel:status:VpcEndpointSummary'
, vpcEndpointSummary_status
- The current status of the endpoint.
$sel:vpcEndpointId:VpcEndpointSummary'
, vpcEndpointSummary_vpcEndpointId
- The unique identifier of the endpoint.
$sel:vpcEndpointOwner:VpcEndpointSummary'
, vpcEndpointSummary_vpcEndpointOwner
- The creator of the endpoint.
ZoneAwarenessConfig
data ZoneAwarenessConfig Source #
The zone awareness configuration for an Amazon OpenSearch Service domain.
See: newZoneAwarenessConfig
smart constructor.
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
- If you enabled multiple Availability Zones, this value is the number of
zones that you want the domain to use. Valid values are 2
and 3
. If
your domain is provisioned within a VPC, this value be equal to number
of subnets.