OpenSearchService class

Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon OpenSearch Service domains.

Constructors

OpenSearchService({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

acceptInboundConnection({required String connectionId}) → Future<AcceptInboundConnectionResponse>
Allows the remote domain owner to accept an inbound cross-cluster connection request.
addTags({required String arn, required List<Tag> tagList}) → Future<void>
Attaches tags to an existing domain. Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See Tagging Amazon OpenSearch Service domains for more information.
associatePackage({required String domainName, required String packageID}) → Future<AssociatePackageResponse>
Associates a package with an Amazon OpenSearch Service domain.
cancelServiceSoftwareUpdate({required String domainName}) → Future<CancelServiceSoftwareUpdateResponse>
Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createDomain({required String domainName, String? accessPolicies, Map<String, String>? advancedOptions, AdvancedSecurityOptionsInput? advancedSecurityOptions, AutoTuneOptionsInput? autoTuneOptions, ClusterConfig? clusterConfig, CognitoOptions? cognitoOptions, DomainEndpointOptions? domainEndpointOptions, EBSOptions? eBSOptions, EncryptionAtRestOptions? encryptionAtRestOptions, String? engineVersion, Map<LogType, LogPublishingOption>? logPublishingOptions, NodeToNodeEncryptionOptions? nodeToNodeEncryptionOptions, SnapshotOptions? snapshotOptions, List<Tag>? tagList, VPCOptions? vPCOptions}) → Future<CreateDomainResponse>
Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.
createOutboundConnection({required String connectionAlias, required DomainInformationContainer localDomainInfo, required DomainInformationContainer remoteDomainInfo}) → Future<CreateOutboundConnectionResponse>
Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
createPackage({required String packageName, required PackageSource packageSource, required PackageType packageType, String? packageDescription}) → Future<CreatePackageResponse>
Create a package for use with Amazon OpenSearch Service domains.
deleteDomain({required String domainName}) → Future<DeleteDomainResponse>
Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.
deleteInboundConnection({required String connectionId}) → Future<DeleteInboundConnectionResponse>
Allows the remote domain owner to delete an existing inbound cross-cluster connection.
deleteOutboundConnection({required String connectionId}) → Future<DeleteOutboundConnectionResponse>
Allows the local domain owner to delete an existing outbound cross-cluster connection.
deletePackage({required String packageID}) → Future<DeletePackageResponse>
Deletes the package.
describeDomain({required String domainName}) → Future<DescribeDomainResponse>
Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
describeDomainAutoTunes({required String domainName, int? maxResults, String? nextToken}) → Future<DescribeDomainAutoTunesResponse>
Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
describeDomainChangeProgress({required String domainName, String? changeId}) → Future<DescribeDomainChangeProgressResponse>
Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
describeDomainConfig({required String domainName}) → Future<DescribeDomainConfigResponse>
Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
describeDomains({required List<String> domainNames}) → Future<DescribeDomainsResponse>
Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
describeInboundConnections({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<DescribeInboundConnectionsResponse>
Lists all the inbound cross-cluster connections for a remote domain.
describeInstanceTypeLimits({required String engineVersion, required OpenSearchPartitionInstanceType instanceType, String? domainName}) → Future<DescribeInstanceTypeLimitsResponse>
Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the DomainName to see which limits you can modify.
describeOutboundConnections({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<DescribeOutboundConnectionsResponse>
Lists all the outbound cross-cluster connections for a local domain.
describePackages({List<DescribePackagesFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribePackagesResponse>
Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.
describeReservedInstanceOfferings({int? maxResults, String? nextToken, String? reservedInstanceOfferingId}) → Future<DescribeReservedInstanceOfferingsResponse>
Lists available reserved OpenSearch instance offerings.
describeReservedInstances({int? maxResults, String? nextToken, String? reservedInstanceId}) → Future<DescribeReservedInstancesResponse>
Returns information about reserved OpenSearch instances for this account.
dissociatePackage({required String domainName, required String packageID}) → Future<DissociatePackageResponse>
Dissociates a package from the Amazon OpenSearch Service domain.
getCompatibleVersions({String? domainName}) → Future<GetCompatibleVersionsResponse>
Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a DomainName to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain.
getPackageVersionHistory({required String packageID, int? maxResults, String? nextToken}) → Future<GetPackageVersionHistoryResponse>
Returns a list of package versions, along with their creation time and commit message.
getUpgradeHistory({required String domainName, int? maxResults, String? nextToken}) → Future<GetUpgradeHistoryResponse>
Retrieves the complete history of the last 10 upgrades performed on the domain.
getUpgradeStatus({required String domainName}) → Future<GetUpgradeStatusResponse>
Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
listDomainNames({EngineType? engineType}) → Future<ListDomainNamesResponse>
Returns the names of all domains owned by the current user's account.
listDomainsForPackage({required String packageID, int? maxResults, String? nextToken}) → Future<ListDomainsForPackageResponse>
Lists all Amazon OpenSearch Service domains associated with the package.
listInstanceTypeDetails({required String engineVersion, String? domainName, int? maxResults, String? nextToken}) → Future<ListInstanceTypeDetailsResponse>
May throw BaseException. May throw InternalException. May throw ResourceNotFoundException. May throw ValidationException.
listPackagesForDomain({required String domainName, int? maxResults, String? nextToken}) → Future<ListPackagesForDomainResponse>
Lists all packages associated with the Amazon OpenSearch Service domain.
listTags({required String arn}) → Future<ListTagsResponse>
Returns all tags for the given domain.
listVersions({int? maxResults, String? nextToken}) → Future<ListVersionsResponse>
List all supported versions of OpenSearch and Elasticsearch.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
purchaseReservedInstanceOffering({required String reservationName, required String reservedInstanceOfferingId, int? instanceCount}) → Future<PurchaseReservedInstanceOfferingResponse>
Allows you to purchase reserved OpenSearch instances.
rejectInboundConnection({required String connectionId}) → Future<RejectInboundConnectionResponse>
Allows the remote domain owner to reject an inbound cross-cluster connection request.
removeTags({required String arn, required List<String> tagKeys}) → Future<void>
Removes the specified set of tags from the given domain.
startServiceSoftwareUpdate({required String domainName}) → Future<StartServiceSoftwareUpdateResponse>
Schedules a service software update for an Amazon OpenSearch Service domain.
toString() → String
A string representation of this object.
inherited
updateDomainConfig({required String domainName, String? accessPolicies, Map<String, String>? advancedOptions, AdvancedSecurityOptionsInput? advancedSecurityOptions, AutoTuneOptions? autoTuneOptions, ClusterConfig? clusterConfig, CognitoOptions? cognitoOptions, DomainEndpointOptions? domainEndpointOptions, bool? dryRun, EBSOptions? eBSOptions, EncryptionAtRestOptions? encryptionAtRestOptions, Map<LogType, LogPublishingOption>? logPublishingOptions, NodeToNodeEncryptionOptions? nodeToNodeEncryptionOptions, SnapshotOptions? snapshotOptions, VPCOptions? vPCOptions}) → Future<UpdateDomainConfigResponse>
Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
updatePackage({required String packageID, required PackageSource packageSource, String? commitMessage, String? packageDescription}) → Future<UpdatePackageResponse>
Updates a package for use with Amazon OpenSearch Service domains.
upgradeDomain({required String domainName, required String targetVersion, Map<String, String>? advancedOptions, bool? performCheckOnly}) → Future<UpgradeDomainResponse>
Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Operators

operator ==(Object other) → bool
The equality operator.
inherited