@alma-cdk/cross-region-parameter
Version:
Store AWS SSM Parameter Store Parameters into another AWS Region with AWS CDK
1,043 lines • 104 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class OpenSearch extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: OpenSearch.Types.ClientConfiguration)
config: Config & OpenSearch.Types.ClientConfiguration;
/**
* Allows the remote domain owner to accept an inbound cross-cluster connection request.
*/
acceptInboundConnection(params: OpenSearch.Types.AcceptInboundConnectionRequest, callback?: (err: AWSError, data: OpenSearch.Types.AcceptInboundConnectionResponse) => void): Request<OpenSearch.Types.AcceptInboundConnectionResponse, AWSError>;
/**
* Allows the remote domain owner to accept an inbound cross-cluster connection request.
*/
acceptInboundConnection(callback?: (err: AWSError, data: OpenSearch.Types.AcceptInboundConnectionResponse) => void): Request<OpenSearch.Types.AcceptInboundConnectionResponse, AWSError>;
/**
* 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.
*/
addTags(params: OpenSearch.Types.AddTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
addTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates a package with an Amazon OpenSearch Service domain.
*/
associatePackage(params: OpenSearch.Types.AssociatePackageRequest, callback?: (err: AWSError, data: OpenSearch.Types.AssociatePackageResponse) => void): Request<OpenSearch.Types.AssociatePackageResponse, AWSError>;
/**
* Associates a package with an Amazon OpenSearch Service domain.
*/
associatePackage(callback?: (err: AWSError, data: OpenSearch.Types.AssociatePackageResponse) => void): Request<OpenSearch.Types.AssociatePackageResponse, AWSError>;
/**
* 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.
*/
cancelServiceSoftwareUpdate(params: OpenSearch.Types.CancelServiceSoftwareUpdateRequest, callback?: (err: AWSError, data: OpenSearch.Types.CancelServiceSoftwareUpdateResponse) => void): Request<OpenSearch.Types.CancelServiceSoftwareUpdateResponse, AWSError>;
/**
* 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.
*/
cancelServiceSoftwareUpdate(callback?: (err: AWSError, data: OpenSearch.Types.CancelServiceSoftwareUpdateResponse) => void): Request<OpenSearch.Types.CancelServiceSoftwareUpdateResponse, AWSError>;
/**
* 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.
*/
createDomain(params: OpenSearch.Types.CreateDomainRequest, callback?: (err: AWSError, data: OpenSearch.Types.CreateDomainResponse) => void): Request<OpenSearch.Types.CreateDomainResponse, AWSError>;
/**
* 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.
*/
createDomain(callback?: (err: AWSError, data: OpenSearch.Types.CreateDomainResponse) => void): Request<OpenSearch.Types.CreateDomainResponse, AWSError>;
/**
* Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
*/
createOutboundConnection(params: OpenSearch.Types.CreateOutboundConnectionRequest, callback?: (err: AWSError, data: OpenSearch.Types.CreateOutboundConnectionResponse) => void): Request<OpenSearch.Types.CreateOutboundConnectionResponse, AWSError>;
/**
* Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
*/
createOutboundConnection(callback?: (err: AWSError, data: OpenSearch.Types.CreateOutboundConnectionResponse) => void): Request<OpenSearch.Types.CreateOutboundConnectionResponse, AWSError>;
/**
* Create a package for use with Amazon OpenSearch Service domains.
*/
createPackage(params: OpenSearch.Types.CreatePackageRequest, callback?: (err: AWSError, data: OpenSearch.Types.CreatePackageResponse) => void): Request<OpenSearch.Types.CreatePackageResponse, AWSError>;
/**
* Create a package for use with Amazon OpenSearch Service domains.
*/
createPackage(callback?: (err: AWSError, data: OpenSearch.Types.CreatePackageResponse) => void): Request<OpenSearch.Types.CreatePackageResponse, AWSError>;
/**
* Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.
*/
deleteDomain(params: OpenSearch.Types.DeleteDomainRequest, callback?: (err: AWSError, data: OpenSearch.Types.DeleteDomainResponse) => void): Request<OpenSearch.Types.DeleteDomainResponse, AWSError>;
/**
* Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.
*/
deleteDomain(callback?: (err: AWSError, data: OpenSearch.Types.DeleteDomainResponse) => void): Request<OpenSearch.Types.DeleteDomainResponse, AWSError>;
/**
* Allows the remote domain owner to delete an existing inbound cross-cluster connection.
*/
deleteInboundConnection(params: OpenSearch.Types.DeleteInboundConnectionRequest, callback?: (err: AWSError, data: OpenSearch.Types.DeleteInboundConnectionResponse) => void): Request<OpenSearch.Types.DeleteInboundConnectionResponse, AWSError>;
/**
* Allows the remote domain owner to delete an existing inbound cross-cluster connection.
*/
deleteInboundConnection(callback?: (err: AWSError, data: OpenSearch.Types.DeleteInboundConnectionResponse) => void): Request<OpenSearch.Types.DeleteInboundConnectionResponse, AWSError>;
/**
* Allows the local domain owner to delete an existing outbound cross-cluster connection.
*/
deleteOutboundConnection(params: OpenSearch.Types.DeleteOutboundConnectionRequest, callback?: (err: AWSError, data: OpenSearch.Types.DeleteOutboundConnectionResponse) => void): Request<OpenSearch.Types.DeleteOutboundConnectionResponse, AWSError>;
/**
* Allows the local domain owner to delete an existing outbound cross-cluster connection.
*/
deleteOutboundConnection(callback?: (err: AWSError, data: OpenSearch.Types.DeleteOutboundConnectionResponse) => void): Request<OpenSearch.Types.DeleteOutboundConnectionResponse, AWSError>;
/**
* Deletes the package.
*/
deletePackage(params: OpenSearch.Types.DeletePackageRequest, callback?: (err: AWSError, data: OpenSearch.Types.DeletePackageResponse) => void): Request<OpenSearch.Types.DeletePackageResponse, AWSError>;
/**
* Deletes the package.
*/
deletePackage(callback?: (err: AWSError, data: OpenSearch.Types.DeletePackageResponse) => void): Request<OpenSearch.Types.DeletePackageResponse, AWSError>;
/**
* Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
*/
describeDomain(params: OpenSearch.Types.DescribeDomainRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainResponse) => void): Request<OpenSearch.Types.DescribeDomainResponse, AWSError>;
/**
* Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
*/
describeDomain(callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainResponse) => void): Request<OpenSearch.Types.DescribeDomainResponse, AWSError>;
/**
* Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
*/
describeDomainAutoTunes(params: OpenSearch.Types.DescribeDomainAutoTunesRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainAutoTunesResponse) => void): Request<OpenSearch.Types.DescribeDomainAutoTunesResponse, AWSError>;
/**
* Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
*/
describeDomainAutoTunes(callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainAutoTunesResponse) => void): Request<OpenSearch.Types.DescribeDomainAutoTunesResponse, AWSError>;
/**
* Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
*/
describeDomainChangeProgress(params: OpenSearch.Types.DescribeDomainChangeProgressRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainChangeProgressResponse) => void): Request<OpenSearch.Types.DescribeDomainChangeProgressResponse, AWSError>;
/**
* Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
*/
describeDomainChangeProgress(callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainChangeProgressResponse) => void): Request<OpenSearch.Types.DescribeDomainChangeProgressResponse, AWSError>;
/**
* Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
*/
describeDomainConfig(params: OpenSearch.Types.DescribeDomainConfigRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainConfigResponse) => void): Request<OpenSearch.Types.DescribeDomainConfigResponse, AWSError>;
/**
* Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
*/
describeDomainConfig(callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainConfigResponse) => void): Request<OpenSearch.Types.DescribeDomainConfigResponse, AWSError>;
/**
* Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
*/
describeDomains(params: OpenSearch.Types.DescribeDomainsRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainsResponse) => void): Request<OpenSearch.Types.DescribeDomainsResponse, AWSError>;
/**
* Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
*/
describeDomains(callback?: (err: AWSError, data: OpenSearch.Types.DescribeDomainsResponse) => void): Request<OpenSearch.Types.DescribeDomainsResponse, AWSError>;
/**
* Lists all the inbound cross-cluster connections for a remote domain.
*/
describeInboundConnections(params: OpenSearch.Types.DescribeInboundConnectionsRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeInboundConnectionsResponse) => void): Request<OpenSearch.Types.DescribeInboundConnectionsResponse, AWSError>;
/**
* Lists all the inbound cross-cluster connections for a remote domain.
*/
describeInboundConnections(callback?: (err: AWSError, data: OpenSearch.Types.DescribeInboundConnectionsResponse) => void): Request<OpenSearch.Types.DescribeInboundConnectionsResponse, AWSError>;
/**
* 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.
*/
describeInstanceTypeLimits(params: OpenSearch.Types.DescribeInstanceTypeLimitsRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeInstanceTypeLimitsResponse) => void): Request<OpenSearch.Types.DescribeInstanceTypeLimitsResponse, AWSError>;
/**
* 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.
*/
describeInstanceTypeLimits(callback?: (err: AWSError, data: OpenSearch.Types.DescribeInstanceTypeLimitsResponse) => void): Request<OpenSearch.Types.DescribeInstanceTypeLimitsResponse, AWSError>;
/**
* Lists all the outbound cross-cluster connections for a local domain.
*/
describeOutboundConnections(params: OpenSearch.Types.DescribeOutboundConnectionsRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeOutboundConnectionsResponse) => void): Request<OpenSearch.Types.DescribeOutboundConnectionsResponse, AWSError>;
/**
* Lists all the outbound cross-cluster connections for a local domain.
*/
describeOutboundConnections(callback?: (err: AWSError, data: OpenSearch.Types.DescribeOutboundConnectionsResponse) => void): Request<OpenSearch.Types.DescribeOutboundConnectionsResponse, AWSError>;
/**
* Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.
*/
describePackages(params: OpenSearch.Types.DescribePackagesRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribePackagesResponse) => void): Request<OpenSearch.Types.DescribePackagesResponse, AWSError>;
/**
* Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.
*/
describePackages(callback?: (err: AWSError, data: OpenSearch.Types.DescribePackagesResponse) => void): Request<OpenSearch.Types.DescribePackagesResponse, AWSError>;
/**
* Lists available reserved OpenSearch instance offerings.
*/
describeReservedInstanceOfferings(params: OpenSearch.Types.DescribeReservedInstanceOfferingsRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeReservedInstanceOfferingsResponse) => void): Request<OpenSearch.Types.DescribeReservedInstanceOfferingsResponse, AWSError>;
/**
* Lists available reserved OpenSearch instance offerings.
*/
describeReservedInstanceOfferings(callback?: (err: AWSError, data: OpenSearch.Types.DescribeReservedInstanceOfferingsResponse) => void): Request<OpenSearch.Types.DescribeReservedInstanceOfferingsResponse, AWSError>;
/**
* Returns information about reserved OpenSearch instances for this account.
*/
describeReservedInstances(params: OpenSearch.Types.DescribeReservedInstancesRequest, callback?: (err: AWSError, data: OpenSearch.Types.DescribeReservedInstancesResponse) => void): Request<OpenSearch.Types.DescribeReservedInstancesResponse, AWSError>;
/**
* Returns information about reserved OpenSearch instances for this account.
*/
describeReservedInstances(callback?: (err: AWSError, data: OpenSearch.Types.DescribeReservedInstancesResponse) => void): Request<OpenSearch.Types.DescribeReservedInstancesResponse, AWSError>;
/**
* Dissociates a package from the Amazon OpenSearch Service domain.
*/
dissociatePackage(params: OpenSearch.Types.DissociatePackageRequest, callback?: (err: AWSError, data: OpenSearch.Types.DissociatePackageResponse) => void): Request<OpenSearch.Types.DissociatePackageResponse, AWSError>;
/**
* Dissociates a package from the Amazon OpenSearch Service domain.
*/
dissociatePackage(callback?: (err: AWSError, data: OpenSearch.Types.DissociatePackageResponse) => void): Request<OpenSearch.Types.DissociatePackageResponse, AWSError>;
/**
* 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.
*/
getCompatibleVersions(params: OpenSearch.Types.GetCompatibleVersionsRequest, callback?: (err: AWSError, data: OpenSearch.Types.GetCompatibleVersionsResponse) => void): Request<OpenSearch.Types.GetCompatibleVersionsResponse, AWSError>;
/**
* 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.
*/
getCompatibleVersions(callback?: (err: AWSError, data: OpenSearch.Types.GetCompatibleVersionsResponse) => void): Request<OpenSearch.Types.GetCompatibleVersionsResponse, AWSError>;
/**
* Returns a list of package versions, along with their creation time and commit message.
*/
getPackageVersionHistory(params: OpenSearch.Types.GetPackageVersionHistoryRequest, callback?: (err: AWSError, data: OpenSearch.Types.GetPackageVersionHistoryResponse) => void): Request<OpenSearch.Types.GetPackageVersionHistoryResponse, AWSError>;
/**
* Returns a list of package versions, along with their creation time and commit message.
*/
getPackageVersionHistory(callback?: (err: AWSError, data: OpenSearch.Types.GetPackageVersionHistoryResponse) => void): Request<OpenSearch.Types.GetPackageVersionHistoryResponse, AWSError>;
/**
* Retrieves the complete history of the last 10 upgrades performed on the domain.
*/
getUpgradeHistory(params: OpenSearch.Types.GetUpgradeHistoryRequest, callback?: (err: AWSError, data: OpenSearch.Types.GetUpgradeHistoryResponse) => void): Request<OpenSearch.Types.GetUpgradeHistoryResponse, AWSError>;
/**
* Retrieves the complete history of the last 10 upgrades performed on the domain.
*/
getUpgradeHistory(callback?: (err: AWSError, data: OpenSearch.Types.GetUpgradeHistoryResponse) => void): Request<OpenSearch.Types.GetUpgradeHistoryResponse, AWSError>;
/**
* Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
*/
getUpgradeStatus(params: OpenSearch.Types.GetUpgradeStatusRequest, callback?: (err: AWSError, data: OpenSearch.Types.GetUpgradeStatusResponse) => void): Request<OpenSearch.Types.GetUpgradeStatusResponse, AWSError>;
/**
* Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
*/
getUpgradeStatus(callback?: (err: AWSError, data: OpenSearch.Types.GetUpgradeStatusResponse) => void): Request<OpenSearch.Types.GetUpgradeStatusResponse, AWSError>;
/**
* Returns the names of all domains owned by the current user's account.
*/
listDomainNames(params: OpenSearch.Types.ListDomainNamesRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListDomainNamesResponse) => void): Request<OpenSearch.Types.ListDomainNamesResponse, AWSError>;
/**
* Returns the names of all domains owned by the current user's account.
*/
listDomainNames(callback?: (err: AWSError, data: OpenSearch.Types.ListDomainNamesResponse) => void): Request<OpenSearch.Types.ListDomainNamesResponse, AWSError>;
/**
* Lists all Amazon OpenSearch Service domains associated with the package.
*/
listDomainsForPackage(params: OpenSearch.Types.ListDomainsForPackageRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListDomainsForPackageResponse) => void): Request<OpenSearch.Types.ListDomainsForPackageResponse, AWSError>;
/**
* Lists all Amazon OpenSearch Service domains associated with the package.
*/
listDomainsForPackage(callback?: (err: AWSError, data: OpenSearch.Types.ListDomainsForPackageResponse) => void): Request<OpenSearch.Types.ListDomainsForPackageResponse, AWSError>;
/**
*
*/
listInstanceTypeDetails(params: OpenSearch.Types.ListInstanceTypeDetailsRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListInstanceTypeDetailsResponse) => void): Request<OpenSearch.Types.ListInstanceTypeDetailsResponse, AWSError>;
/**
*
*/
listInstanceTypeDetails(callback?: (err: AWSError, data: OpenSearch.Types.ListInstanceTypeDetailsResponse) => void): Request<OpenSearch.Types.ListInstanceTypeDetailsResponse, AWSError>;
/**
* Lists all packages associated with the Amazon OpenSearch Service domain.
*/
listPackagesForDomain(params: OpenSearch.Types.ListPackagesForDomainRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListPackagesForDomainResponse) => void): Request<OpenSearch.Types.ListPackagesForDomainResponse, AWSError>;
/**
* Lists all packages associated with the Amazon OpenSearch Service domain.
*/
listPackagesForDomain(callback?: (err: AWSError, data: OpenSearch.Types.ListPackagesForDomainResponse) => void): Request<OpenSearch.Types.ListPackagesForDomainResponse, AWSError>;
/**
* Returns all tags for the given domain.
*/
listTags(params: OpenSearch.Types.ListTagsRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListTagsResponse) => void): Request<OpenSearch.Types.ListTagsResponse, AWSError>;
/**
* Returns all tags for the given domain.
*/
listTags(callback?: (err: AWSError, data: OpenSearch.Types.ListTagsResponse) => void): Request<OpenSearch.Types.ListTagsResponse, AWSError>;
/**
* List all supported versions of OpenSearch and Elasticsearch.
*/
listVersions(params: OpenSearch.Types.ListVersionsRequest, callback?: (err: AWSError, data: OpenSearch.Types.ListVersionsResponse) => void): Request<OpenSearch.Types.ListVersionsResponse, AWSError>;
/**
* List all supported versions of OpenSearch and Elasticsearch.
*/
listVersions(callback?: (err: AWSError, data: OpenSearch.Types.ListVersionsResponse) => void): Request<OpenSearch.Types.ListVersionsResponse, AWSError>;
/**
* Allows you to purchase reserved OpenSearch instances.
*/
purchaseReservedInstanceOffering(params: OpenSearch.Types.PurchaseReservedInstanceOfferingRequest, callback?: (err: AWSError, data: OpenSearch.Types.PurchaseReservedInstanceOfferingResponse) => void): Request<OpenSearch.Types.PurchaseReservedInstanceOfferingResponse, AWSError>;
/**
* Allows you to purchase reserved OpenSearch instances.
*/
purchaseReservedInstanceOffering(callback?: (err: AWSError, data: OpenSearch.Types.PurchaseReservedInstanceOfferingResponse) => void): Request<OpenSearch.Types.PurchaseReservedInstanceOfferingResponse, AWSError>;
/**
* Allows the remote domain owner to reject an inbound cross-cluster connection request.
*/
rejectInboundConnection(params: OpenSearch.Types.RejectInboundConnectionRequest, callback?: (err: AWSError, data: OpenSearch.Types.RejectInboundConnectionResponse) => void): Request<OpenSearch.Types.RejectInboundConnectionResponse, AWSError>;
/**
* Allows the remote domain owner to reject an inbound cross-cluster connection request.
*/
rejectInboundConnection(callback?: (err: AWSError, data: OpenSearch.Types.RejectInboundConnectionResponse) => void): Request<OpenSearch.Types.RejectInboundConnectionResponse, AWSError>;
/**
* Removes the specified set of tags from the given domain.
*/
removeTags(params: OpenSearch.Types.RemoveTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the specified set of tags from the given domain.
*/
removeTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Schedules a service software update for an Amazon OpenSearch Service domain.
*/
startServiceSoftwareUpdate(params: OpenSearch.Types.StartServiceSoftwareUpdateRequest, callback?: (err: AWSError, data: OpenSearch.Types.StartServiceSoftwareUpdateResponse) => void): Request<OpenSearch.Types.StartServiceSoftwareUpdateResponse, AWSError>;
/**
* Schedules a service software update for an Amazon OpenSearch Service domain.
*/
startServiceSoftwareUpdate(callback?: (err: AWSError, data: OpenSearch.Types.StartServiceSoftwareUpdateResponse) => void): Request<OpenSearch.Types.StartServiceSoftwareUpdateResponse, AWSError>;
/**
* Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
*/
updateDomainConfig(params: OpenSearch.Types.UpdateDomainConfigRequest, callback?: (err: AWSError, data: OpenSearch.Types.UpdateDomainConfigResponse) => void): Request<OpenSearch.Types.UpdateDomainConfigResponse, AWSError>;
/**
* Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
*/
updateDomainConfig(callback?: (err: AWSError, data: OpenSearch.Types.UpdateDomainConfigResponse) => void): Request<OpenSearch.Types.UpdateDomainConfigResponse, AWSError>;
/**
* Updates a package for use with Amazon OpenSearch Service domains.
*/
updatePackage(params: OpenSearch.Types.UpdatePackageRequest, callback?: (err: AWSError, data: OpenSearch.Types.UpdatePackageResponse) => void): Request<OpenSearch.Types.UpdatePackageResponse, AWSError>;
/**
* Updates a package for use with Amazon OpenSearch Service domains.
*/
updatePackage(callback?: (err: AWSError, data: OpenSearch.Types.UpdatePackageResponse) => void): Request<OpenSearch.Types.UpdatePackageResponse, AWSError>;
/**
* Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
*/
upgradeDomain(params: OpenSearch.Types.UpgradeDomainRequest, callback?: (err: AWSError, data: OpenSearch.Types.UpgradeDomainResponse) => void): Request<OpenSearch.Types.UpgradeDomainResponse, AWSError>;
/**
* Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
*/
upgradeDomain(callback?: (err: AWSError, data: OpenSearch.Types.UpgradeDomainResponse) => void): Request<OpenSearch.Types.UpgradeDomainResponse, AWSError>;
}
declare namespace OpenSearch {
export type ARN = string;
export interface AWSDomainInformation {
OwnerId?: OwnerId;
DomainName: DomainName;
Region?: Region;
}
export interface AcceptInboundConnectionRequest {
/**
* The ID of the inbound connection you want to accept.
*/
ConnectionId: ConnectionId;
}
export interface AcceptInboundConnectionResponse {
/**
* The InboundConnection of the accepted inbound connection.
*/
Connection?: InboundConnection;
}
export interface AccessPoliciesStatus {
/**
* The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. See Configuring access policiesfor more information.
*/
Options: PolicyDocument;
/**
* The status of the access policy for the domain. See OptionStatus for the status information that's included.
*/
Status: OptionStatus;
}
export interface AddTagsRequest {
/**
* Specify the ARN of the domain you want to add tags to.
*/
ARN: ARN;
/**
* List of Tag to add to the domain.
*/
TagList: TagList;
}
export interface AdditionalLimit {
/**
* Additional limit is specific to a given InstanceType and for each of its InstanceRole etc. Attributes and their details: MaximumNumberOfDataNodesSupported This attribute is present on the master node only to specify how much data nodes up to which given ESPartitionInstanceType can support as master node. MaximumNumberOfDataNodesWithoutMasterNode This attribute is present on data node only to specify how much data nodes of given ESPartitionInstanceType up to which you don't need any master nodes to govern them.
*/
LimitName?: LimitName;
/**
* Value for a given AdditionalLimit$LimitName .
*/
LimitValues?: LimitValueList;
}
export type AdditionalLimitList = AdditionalLimit[];
export type AdvancedOptions = {[key: string]: String};
export interface AdvancedOptionsStatus {
/**
* The status of advanced options for the specified domain.
*/
Options: AdvancedOptions;
/**
* The OptionStatus for advanced options for the specified domain.
*/
Status: OptionStatus;
}
export interface AdvancedSecurityOptions {
/**
* True if advanced security is enabled.
*/
Enabled?: Boolean;
/**
* True if the internal user database is enabled.
*/
InternalUserDatabaseEnabled?: Boolean;
/**
* Describes the SAML application configured for a domain.
*/
SAMLOptions?: SAMLOptionsOutput;
/**
* Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
*/
AnonymousAuthDisableDate?: DisableTimestamp;
/**
* True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
*/
AnonymousAuthEnabled?: Boolean;
}
export interface AdvancedSecurityOptionsInput {
/**
* True if advanced security is enabled.
*/
Enabled?: Boolean;
/**
* True if the internal user database is enabled.
*/
InternalUserDatabaseEnabled?: Boolean;
/**
* Credentials for the master user: username and password, ARN, or both.
*/
MasterUserOptions?: MasterUserOptions;
/**
* The SAML application configuration for the domain.
*/
SAMLOptions?: SAMLOptionsInput;
/**
* True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
*/
AnonymousAuthEnabled?: Boolean;
}
export interface AdvancedSecurityOptionsStatus {
/**
* Advanced security options for the specified domain.
*/
Options: AdvancedSecurityOptions;
/**
* Status of the advanced security options for the specified domain.
*/
Status: OptionStatus;
}
export interface AssociatePackageRequest {
/**
* Internal ID of the package to associate with a domain. Use DescribePackages to find this value.
*/
PackageID: PackageID;
/**
* The name of the domain to associate the package with.
*/
DomainName: DomainName;
}
export interface AssociatePackageResponse {
/**
* DomainPackageDetails
*/
DomainPackageDetails?: DomainPackageDetails;
}
export interface AutoTune {
/**
* Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
*/
AutoTuneType?: AutoTuneType;
/**
* Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
*/
AutoTuneDetails?: AutoTuneDetails;
}
export type AutoTuneDate = Date;
export type AutoTuneDesiredState = "ENABLED"|"DISABLED"|string;
export interface AutoTuneDetails {
ScheduledAutoTuneDetails?: ScheduledAutoTuneDetails;
}
export type AutoTuneList = AutoTune[];
export interface AutoTuneMaintenanceSchedule {
/**
* The timestamp at which the Auto-Tune maintenance schedule starts.
*/
StartAt?: StartAt;
/**
* Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
*/
Duration?: Duration;
/**
* A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
*/
CronExpressionForRecurrence?: String;
}
export type AutoTuneMaintenanceScheduleList = AutoTuneMaintenanceSchedule[];
export interface AutoTuneOptions {
/**
* The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
*/
DesiredState?: AutoTuneDesiredState;
/**
* The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
*/
RollbackOnDisable?: RollbackOnDisable;
/**
* A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
*/
MaintenanceSchedules?: AutoTuneMaintenanceScheduleList;
}
export interface AutoTuneOptionsInput {
/**
* The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
*/
DesiredState?: AutoTuneDesiredState;
/**
* A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
*/
MaintenanceSchedules?: AutoTuneMaintenanceScheduleList;
}
export interface AutoTuneOptionsOutput {
/**
* The AutoTuneState for the domain.
*/
State?: AutoTuneState;
/**
* The error message while enabling or disabling Auto-Tune.
*/
ErrorMessage?: String;
}
export interface AutoTuneOptionsStatus {
/**
* Specifies Auto-Tune options for the domain.
*/
Options?: AutoTuneOptions;
/**
* The status of the Auto-Tune options for the domain.
*/
Status?: AutoTuneStatus;
}
export type AutoTuneState = "ENABLED"|"DISABLED"|"ENABLE_IN_PROGRESS"|"DISABLE_IN_PROGRESS"|"DISABLED_AND_ROLLBACK_SCHEDULED"|"DISABLED_AND_ROLLBACK_IN_PROGRESS"|"DISABLED_AND_ROLLBACK_COMPLETE"|"DISABLED_AND_ROLLBACK_ERROR"|"ERROR"|string;
export interface AutoTuneStatus {
/**
* The timestamp of the Auto-Tune options creation date.
*/
CreationDate: UpdateTimestamp;
/**
* The timestamp of when the Auto-Tune options were last updated.
*/
UpdateDate: UpdateTimestamp;
/**
* The latest version of the Auto-Tune options.
*/
UpdateVersion?: UIntValue;
/**
* The AutoTuneState for the domain.
*/
State: AutoTuneState;
/**
* The error message while enabling or disabling Auto-Tune.
*/
ErrorMessage?: String;
/**
* Indicates whether the domain is being deleted.
*/
PendingDeletion?: Boolean;
}
export type AutoTuneType = "SCHEDULED_ACTION"|string;
export type BackendRole = string;
export type Boolean = boolean;
export interface CancelServiceSoftwareUpdateRequest {
/**
* The name of the domain that you want to stop the latest service software update on.
*/
DomainName: DomainName;
}
export interface CancelServiceSoftwareUpdateResponse {
/**
* The current status of the OpenSearch service software update.
*/
ServiceSoftwareOptions?: ServiceSoftwareOptions;
}
export interface ChangeProgressDetails {
/**
* The unique change identifier associated with a specific domain configuration change.
*/
ChangeId?: GUID;
/**
* Contains an optional message associated with the domain configuration change.
*/
Message?: Message;
}
export interface ChangeProgressStage {
/**
* The name of the specific progress stage.
*/
Name?: ChangeProgressStageName;
/**
* The overall status of a specific progress stage.
*/
Status?: ChangeProgressStageStatus;
/**
* The description of the progress stage.
*/
Description?: Description;
/**
* The last updated timestamp of the progress stage.
*/
LastUpdated?: LastUpdated;
}
export type ChangeProgressStageList = ChangeProgressStage[];
export type ChangeProgressStageName = string;
export type ChangeProgressStageStatus = string;
export interface ChangeProgressStatusDetails {
/**
* The unique change identifier associated with a specific domain configuration change.
*/
ChangeId?: GUID;
/**
* The time at which the configuration change is made on the domain.
*/
StartTime?: UpdateTimestamp;
/**
* The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED
*/
Status?: OverallChangeStatus;
/**
* The list of properties involved in the domain configuration change that are still in pending.
*/
PendingProperties?: StringList;
/**
* The list of properties involved in the domain configuration change that are completed.
*/
CompletedProperties?: StringList;
/**
* The total number of stages required for the configuration change.
*/
TotalNumberOfStages?: TotalNumberOfStages;
/**
* The specific stages that the domain is going through to perform the configuration change.
*/
ChangeProgressStages?: ChangeProgressStageList;
}
export type CloudWatchLogsLogGroupArn = string;
export interface ClusterConfig {
/**
* The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
*/
InstanceType?: OpenSearchPartitionInstanceType;
/**
* The number of instances in the specified domain cluster.
*/
InstanceCount?: IntegerClass;
/**
* A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
*/
DedicatedMasterEnabled?: Boolean;
/**
* A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
*/
ZoneAwarenessEnabled?: Boolean;
/**
* The zone awareness configuration for a domain when zone awareness is enabled.
*/
ZoneAwarenessConfig?: ZoneAwarenessConfig;
/**
* The instance type for a dedicated master node.
*/
DedicatedMasterType?: OpenSearchPartitionInstanceType;
/**
* Total number of dedicated master nodes, active and on standby, for the cluster.
*/
DedicatedMasterCount?: IntegerClass;
/**
* True to enable UltraWarm storage.
*/
WarmEnabled?: Boolean;
/**
* The instance type for the OpenSearch cluster's warm nodes.
*/
WarmType?: OpenSearchWarmPartitionInstanceType;
/**
* The number of UltraWarm nodes in the cluster.
*/
WarmCount?: IntegerClass;
/**
* Specifies the ColdStorageOptions config for a Domain
*/
ColdStorageOptions?: ColdStorageOptions;
}
export interface ClusterConfigStatus {
/**
* The cluster configuration for the specified domain.
*/
Options: ClusterConfig;
/**
* The cluster configuration status for the specified domain.
*/
Status: OptionStatus;
}
export interface CognitoOptions {
/**
* The option to enable Cognito for OpenSearch Dashboards authentication.
*/
Enabled?: Boolean;
/**
* The Cognito user pool ID for OpenSearch Dashboards authentication.
*/
UserPoolId?: UserPoolId;
/**
* The Cognito identity pool ID for OpenSearch Dashboards authentication.
*/
IdentityPoolId?: IdentityPoolId;
/**
* The role ARN that provides OpenSearch permissions for accessing Cognito resources.
*/
RoleArn?: RoleArn;
}
export interface CognitoOptionsStatus {
/**
* Cognito options for the specified domain.
*/
Options: CognitoOptions;
/**
* The status of the Cognito options for the specified domain.
*/
Status: OptionStatus;
}
export interface ColdStorageOptions {
/**
* Enable cold storage option. Accepted values true or false
*/
Enabled: Boolean;
}
export type CommitMessage = string;
export type CompatibleVersionsList = CompatibleVersionsMap[];
export interface CompatibleVersionsMap {
/**
* The current version of OpenSearch a domain is on.
*/
SourceVersion?: VersionString;
TargetVersions?: VersionList;
}
export type ConnectionAlias = string;
export type ConnectionId = string;
export type ConnectionStatusMessage = string;
export interface CreateDomainRequest {
/**
* The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
*/
DomainName: DomainName;
/**
* String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see Creating and managing Amazon OpenSearch Service domains .
*/
EngineVersion?: VersionString;
/**
* Configuration options for a domain. Specifies the instance type and number of instances in the domain.
*/
ClusterConfig?: ClusterConfig;
/**
* Options to enable, disable, and specify the type and size of EBS storage volumes.
*/
EBSOptions?: EBSOptions;
/**
* IAM access policy as a JSON-formatted string.
*/
AccessPolicies?: PolicyDocument;
/**
* Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
*/
SnapshotOptions?: SnapshotOptions;
/**
* 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 .
*/
VPCOptions?: VPCOptions;
/**
* Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
*/
CognitoOptions?: CognitoOptions;
/**
* Options for encryption of data at rest.
*/
EncryptionAtRestOptions?: EncryptionAtRestOptions;
/**
* Node-to-node encryption options.
*/
NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
/**
* Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
*/
AdvancedOptions?: AdvancedOptions;
/**
* Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
*/
LogPublishingOptions?: LogPublishingOptions;
/**
* Options to specify configurations that will be applied to the domain endpoint.
*/
DomainEndpointOptions?: DomainEndpointOptions;
/**
* Specifies advanced security options.
*/
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
/**
* A list of Tag added during domain creation.
*/
TagList?: TagList;
/**
* Specifies Auto-Tune options.
*/
AutoTuneOptions?: AutoTuneOptionsInput;
}
export interface CreateDomainResponse {
/**
* The status of the newly created domain.
*/
DomainStatus?: DomainStatus;
}
export interface CreateOutboundConnectionRequest {
/**
* The AWSDomainInformation for the local OpenSearch domain.
*/
LocalDomainInfo: DomainInformationContainer;
/**
* The AWSDomainInformation for the remote OpenSearch domain.
*/
RemoteDomainInfo: DomainInformationContainer;
/**
* The connection alias used used by the customer for this cross-cluster connection.
*/
ConnectionAlias: ConnectionAlias;
}
export interface CreateOutboundConnectionResponse {
/**
* The AWSDomainInformation for the local OpenSearch domain.
*/
LocalDomainInfo?: DomainInformationContainer;
/**
* The AWSDomainInformation for the remote OpenSearch domain.
*/
RemoteDomainInfo?: DomainInformationContainer;
/**
* The connection alias provided during the create connection request.
*/
ConnectionAlias?: ConnectionAlias;
/**
* The OutboundConnectionStatus for the newly created connection.
*/
ConnectionStatus?: OutboundConnectionStatus;
/**
* The unique ID for the created outbound connection, which is used for subsequent operations on the connection.
*/
ConnectionId?: ConnectionId;
}
export interface CreatePackageRequest {
/**
* Unique identifier for the package.
*/
PackageName: PackageName;
/**
* Type of package. Currently supports only TXT-DICTIONARY.
*/
PackageType: PackageType;
/**
* Description of the package.
*/
PackageDescription?: PackageDescription;
/**
* The Amazon S3 location from which to import the package.
*/
PackageSource: PackageSource;
}
export interface CreatePackageResponse {
/**
* Information about the package.
*/
PackageDetails?: PackageDetails;
}
export type CreatedAt = Date;
export interface DeleteDomainRequest {
/**
* The name of the domain you want to permanently delete.
*/
DomainName: DomainName;
}
export interface DeleteDomainResponse {
/**
* The status of the domain being deleted.
*/
DomainStatus?: DomainStatus;
}
export interface DeleteInboundConnectionRequest {
/**
* The ID of the inbound connection to permanently delete.
*/
ConnectionId: ConnectionId;
}
export interface DeleteInboundConnectionResponse {
/**
* The InboundConnection of the deleted inbound connection.
*/
Connection?: InboundConnection;
}
export interface DeleteOutboundConnectionRequest {
/**
* The ID of the outbound connection you want to permanently delete.
*/
ConnectionId: ConnectionId;
}
export interface DeleteOutboundConnectionResponse {
/**
* The OutboundConnection of the deleted outbound connection.
*/
Connection?: OutboundConnection;
}
export interface DeletePackageRequest {
/**
* The internal ID of the package you want to delete. Use DescribePackages to find this value.
*/
PackageID: PackageID;
}
export interface DeletePackageResponse {
/**
* PackageDetails
*/
PackageDetails?: PackageDetails;
}
export type DeploymentCloseDateTimeStamp = Date;
export type DeploymentStatus = "PENDING_UPDATE"|"IN_PROGRESS"|"COMPLETED"|"NOT_ELIGIBLE"|"ELIGIBLE"|string;
export type DeploymentType = string;
export interface DescribeDomainAutoTunesRequest {
/**
* The domain name for which you want Auto-Tune action details.
*/
DomainName: DomainName;
/**
* Set this value to limit the number of results returned. If not specified, defaults to 100.
*/
MaxResults?: MaxResults;
/**
* NextToken is sent in case the earlier API call results contain the NextToken. Used for pagination.
*/
NextToken?: NextToken;
}
export interface DescribeDomainAutoTunesResponse {
/**
* The list of setting adjustments that Auto-Tune has made to the domain. See Auto-Tune for Amazon OpenSearch Service for more information.
*/
AutoTunes?: AutoTuneList;
/**
* An identifier to allow retrieval of paginated results.
*/
NextToken?: NextToken;
}
export interface DescribeDomainChangeProgressRequest {
/**
* The domain you want to get the progress information about.
*/
DomainName: DomainName;
/**
* The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.
*/
ChangeId?: GUID;
}
export interface DescribeDomainChangeProgressResponse {
/**
* Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.
*/
ChangeProgressStatus?: ChangeProgressStatusDetails;
}
export interface DescribeDomainConfigRequest {
/**
* The domain you want to get information about.
*/
DomainName: DomainName;
}
export interface DescribeDomainConfigResponse {
/**
* The configuration information of the domain requested in the DescribeDomainConfig request.
*/
DomainConfig: DomainConfig;
}
export interface DescribeDomainRequest {
/**
* The name of the domain for which you want information.
*/
DomainName: DomainName;
}
export interface DescribeDomainResponse {
/**
* The current status of the domain.
*/
DomainStatus: DomainStatus;
}
export interface DescribeDomainsRequest {
/**
* The domains for which you want information.
*/
DomainNames: DomainNameList;
}
export interface DescribeDomainsResponse {
/**
* The status of the domains requested in the DescribeDomains request.
*/
DomainStatusList: DomainStatusList;
}
export interface DescribeInboundConnectionsRequest {
/**
* A list of filters used to match properties for inbound cross-cluster connections. Available Filter values are: connection-id local-domain-info.domain-name local-domain-info.owner-id local-domain-info.region remote-domain-info.domain-name
*/
Filters?: FilterList;
/**
* Set this value to limit the number of results returned. If not specified, defaults to 100.
*/
MaxResults?: MaxResults;
/**
* If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
*/
NextToken?: NextToken;
}
export interface DescribeInboundConnectionsResponse {
/**
* A list of InboundConnection matching the specified filter criteria.
*/
Connections?: InboundConnections;
/**
* If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
*/
NextToken?: NextToken;
}
export interface DescribeInstanceTypeLimitsRequest {
/**
* The name of the domain you want to modify. Only include this value if you're querying OpenSearch Limits for an existing domain.
*/
DomainName?: DomainName;
/**
* The instance type for an OpenSearch cluster for which OpenSearch Limits are needed.
*/
InstanceType: OpenSearchPartitionInstanceType;
/**
* Version of OpenSearch for which Limits are needed.
*/
EngineVersion: VersionStr