prowler-sdk-poc
Version:
964 lines • 103 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 ES extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ES.Types.ClientConfiguration)
config: Config & ES.Types.ClientConfiguration;
/**
* Allows the destination domain owner to accept an inbound cross-cluster search connection request.
*/
acceptInboundCrossClusterSearchConnection(params: ES.Types.AcceptInboundCrossClusterSearchConnectionRequest, callback?: (err: AWSError, data: ES.Types.AcceptInboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.AcceptInboundCrossClusterSearchConnectionResponse, AWSError>;
/**
* Allows the destination domain owner to accept an inbound cross-cluster search connection request.
*/
acceptInboundCrossClusterSearchConnection(callback?: (err: AWSError, data: ES.Types.AcceptInboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.AcceptInboundCrossClusterSearchConnectionResponse, AWSError>;
/**
* Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
*/
addTags(params: ES.Types.AddTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
*/
addTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates a package with an Amazon ES domain.
*/
associatePackage(params: ES.Types.AssociatePackageRequest, callback?: (err: AWSError, data: ES.Types.AssociatePackageResponse) => void): Request<ES.Types.AssociatePackageResponse, AWSError>;
/**
* Associates a package with an Amazon ES domain.
*/
associatePackage(callback?: (err: AWSError, data: ES.Types.AssociatePackageResponse) => void): Request<ES.Types.AssociatePackageResponse, AWSError>;
/**
* Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
*/
cancelElasticsearchServiceSoftwareUpdate(params: ES.Types.CancelElasticsearchServiceSoftwareUpdateRequest, callback?: (err: AWSError, data: ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse) => void): Request<ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse, AWSError>;
/**
* Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
*/
cancelElasticsearchServiceSoftwareUpdate(callback?: (err: AWSError, data: ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse) => void): Request<ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse, AWSError>;
/**
* Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
*/
createElasticsearchDomain(params: ES.Types.CreateElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.CreateElasticsearchDomainResponse) => void): Request<ES.Types.CreateElasticsearchDomainResponse, AWSError>;
/**
* Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
*/
createElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.CreateElasticsearchDomainResponse) => void): Request<ES.Types.CreateElasticsearchDomainResponse, AWSError>;
/**
* Creates a new cross-cluster search connection from a source domain to a destination domain.
*/
createOutboundCrossClusterSearchConnection(params: ES.Types.CreateOutboundCrossClusterSearchConnectionRequest, callback?: (err: AWSError, data: ES.Types.CreateOutboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.CreateOutboundCrossClusterSearchConnectionResponse, AWSError>;
/**
* Creates a new cross-cluster search connection from a source domain to a destination domain.
*/
createOutboundCrossClusterSearchConnection(callback?: (err: AWSError, data: ES.Types.CreateOutboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.CreateOutboundCrossClusterSearchConnectionResponse, AWSError>;
/**
* Create a package for use with Amazon ES domains.
*/
createPackage(params: ES.Types.CreatePackageRequest, callback?: (err: AWSError, data: ES.Types.CreatePackageResponse) => void): Request<ES.Types.CreatePackageResponse, AWSError>;
/**
* Create a package for use with Amazon ES domains.
*/
createPackage(callback?: (err: AWSError, data: ES.Types.CreatePackageResponse) => void): Request<ES.Types.CreatePackageResponse, AWSError>;
/**
* Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
*/
deleteElasticsearchDomain(params: ES.Types.DeleteElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.DeleteElasticsearchDomainResponse) => void): Request<ES.Types.DeleteElasticsearchDomainResponse, AWSError>;
/**
* Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
*/
deleteElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.DeleteElasticsearchDomainResponse) => void): Request<ES.Types.DeleteElasticsearchDomainResponse, AWSError>;
/**
* Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.
*/
deleteElasticsearchServiceRole(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
*/
deleteInboundCrossClusterSearchConnection(params: ES.Types.DeleteInboundCrossClusterSearchConnectionRequest, callback?: (err: AWSError, data: ES.Types.DeleteInboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.DeleteInboundCrossClusterSearchConnectionResponse, AWSError>;
/**
* Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
*/
deleteInboundCrossClusterSearchConnection(callback?: (err: AWSError, data: ES.Types.DeleteInboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.DeleteInboundCrossClusterSearchConnectionResponse, AWSError>;
/**
* Allows the source domain owner to delete an existing outbound cross-cluster search connection.
*/
deleteOutboundCrossClusterSearchConnection(params: ES.Types.DeleteOutboundCrossClusterSearchConnectionRequest, callback?: (err: AWSError, data: ES.Types.DeleteOutboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.DeleteOutboundCrossClusterSearchConnectionResponse, AWSError>;
/**
* Allows the source domain owner to delete an existing outbound cross-cluster search connection.
*/
deleteOutboundCrossClusterSearchConnection(callback?: (err: AWSError, data: ES.Types.DeleteOutboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.DeleteOutboundCrossClusterSearchConnectionResponse, AWSError>;
/**
* Delete the package.
*/
deletePackage(params: ES.Types.DeletePackageRequest, callback?: (err: AWSError, data: ES.Types.DeletePackageResponse) => void): Request<ES.Types.DeletePackageResponse, AWSError>;
/**
* Delete the package.
*/
deletePackage(callback?: (err: AWSError, data: ES.Types.DeletePackageResponse) => void): Request<ES.Types.DeletePackageResponse, AWSError>;
/**
* Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
*/
describeDomainAutoTunes(params: ES.Types.DescribeDomainAutoTunesRequest, callback?: (err: AWSError, data: ES.Types.DescribeDomainAutoTunesResponse) => void): Request<ES.Types.DescribeDomainAutoTunesResponse, AWSError>;
/**
* Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
*/
describeDomainAutoTunes(callback?: (err: AWSError, data: ES.Types.DescribeDomainAutoTunesResponse) => void): Request<ES.Types.DescribeDomainAutoTunesResponse, AWSError>;
/**
* Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
*/
describeElasticsearchDomain(params: ES.Types.DescribeElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainResponse) => void): Request<ES.Types.DescribeElasticsearchDomainResponse, AWSError>;
/**
* Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
*/
describeElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainResponse) => void): Request<ES.Types.DescribeElasticsearchDomainResponse, AWSError>;
/**
* Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
*/
describeElasticsearchDomainConfig(params: ES.Types.DescribeElasticsearchDomainConfigRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainConfigResponse) => void): Request<ES.Types.DescribeElasticsearchDomainConfigResponse, AWSError>;
/**
* Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
*/
describeElasticsearchDomainConfig(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainConfigResponse) => void): Request<ES.Types.DescribeElasticsearchDomainConfigResponse, AWSError>;
/**
* Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
*/
describeElasticsearchDomains(params: ES.Types.DescribeElasticsearchDomainsRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainsResponse) => void): Request<ES.Types.DescribeElasticsearchDomainsResponse, AWSError>;
/**
* Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
*/
describeElasticsearchDomains(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainsResponse) => void): Request<ES.Types.DescribeElasticsearchDomainsResponse, AWSError>;
/**
* Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.
*/
describeElasticsearchInstanceTypeLimits(params: ES.Types.DescribeElasticsearchInstanceTypeLimitsRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse) => void): Request<ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse, AWSError>;
/**
* Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.
*/
describeElasticsearchInstanceTypeLimits(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse) => void): Request<ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse, AWSError>;
/**
* Lists all the inbound cross-cluster search connections for a destination domain.
*/
describeInboundCrossClusterSearchConnections(params: ES.Types.DescribeInboundCrossClusterSearchConnectionsRequest, callback?: (err: AWSError, data: ES.Types.DescribeInboundCrossClusterSearchConnectionsResponse) => void): Request<ES.Types.DescribeInboundCrossClusterSearchConnectionsResponse, AWSError>;
/**
* Lists all the inbound cross-cluster search connections for a destination domain.
*/
describeInboundCrossClusterSearchConnections(callback?: (err: AWSError, data: ES.Types.DescribeInboundCrossClusterSearchConnectionsResponse) => void): Request<ES.Types.DescribeInboundCrossClusterSearchConnectionsResponse, AWSError>;
/**
* Lists all the outbound cross-cluster search connections for a source domain.
*/
describeOutboundCrossClusterSearchConnections(params: ES.Types.DescribeOutboundCrossClusterSearchConnectionsRequest, callback?: (err: AWSError, data: ES.Types.DescribeOutboundCrossClusterSearchConnectionsResponse) => void): Request<ES.Types.DescribeOutboundCrossClusterSearchConnectionsResponse, AWSError>;
/**
* Lists all the outbound cross-cluster search connections for a source domain.
*/
describeOutboundCrossClusterSearchConnections(callback?: (err: AWSError, data: ES.Types.DescribeOutboundCrossClusterSearchConnectionsResponse) => void): Request<ES.Types.DescribeOutboundCrossClusterSearchConnectionsResponse, AWSError>;
/**
* Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
*/
describePackages(params: ES.Types.DescribePackagesRequest, callback?: (err: AWSError, data: ES.Types.DescribePackagesResponse) => void): Request<ES.Types.DescribePackagesResponse, AWSError>;
/**
* Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
*/
describePackages(callback?: (err: AWSError, data: ES.Types.DescribePackagesResponse) => void): Request<ES.Types.DescribePackagesResponse, AWSError>;
/**
* Lists available reserved Elasticsearch instance offerings.
*/
describeReservedElasticsearchInstanceOfferings(params: ES.Types.DescribeReservedElasticsearchInstanceOfferingsRequest, callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse) => void): Request<ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse, AWSError>;
/**
* Lists available reserved Elasticsearch instance offerings.
*/
describeReservedElasticsearchInstanceOfferings(callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse) => void): Request<ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse, AWSError>;
/**
* Returns information about reserved Elasticsearch instances for this account.
*/
describeReservedElasticsearchInstances(params: ES.Types.DescribeReservedElasticsearchInstancesRequest, callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstancesResponse) => void): Request<ES.Types.DescribeReservedElasticsearchInstancesResponse, AWSError>;
/**
* Returns information about reserved Elasticsearch instances for this account.
*/
describeReservedElasticsearchInstances(callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstancesResponse) => void): Request<ES.Types.DescribeReservedElasticsearchInstancesResponse, AWSError>;
/**
* Dissociates a package from the Amazon ES domain.
*/
dissociatePackage(params: ES.Types.DissociatePackageRequest, callback?: (err: AWSError, data: ES.Types.DissociatePackageResponse) => void): Request<ES.Types.DissociatePackageResponse, AWSError>;
/**
* Dissociates a package from the Amazon ES domain.
*/
dissociatePackage(callback?: (err: AWSError, data: ES.Types.DissociatePackageResponse) => void): Request<ES.Types.DissociatePackageResponse, AWSError>;
/**
* Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.
*/
getCompatibleElasticsearchVersions(params: ES.Types.GetCompatibleElasticsearchVersionsRequest, callback?: (err: AWSError, data: ES.Types.GetCompatibleElasticsearchVersionsResponse) => void): Request<ES.Types.GetCompatibleElasticsearchVersionsResponse, AWSError>;
/**
* Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.
*/
getCompatibleElasticsearchVersions(callback?: (err: AWSError, data: ES.Types.GetCompatibleElasticsearchVersionsResponse) => void): Request<ES.Types.GetCompatibleElasticsearchVersionsResponse, AWSError>;
/**
* Returns a list of versions of the package, along with their creation time and commit message.
*/
getPackageVersionHistory(params: ES.Types.GetPackageVersionHistoryRequest, callback?: (err: AWSError, data: ES.Types.GetPackageVersionHistoryResponse) => void): Request<ES.Types.GetPackageVersionHistoryResponse, AWSError>;
/**
* Returns a list of versions of the package, along with their creation time and commit message.
*/
getPackageVersionHistory(callback?: (err: AWSError, data: ES.Types.GetPackageVersionHistoryResponse) => void): Request<ES.Types.GetPackageVersionHistoryResponse, AWSError>;
/**
* Retrieves the complete history of the last 10 upgrades that were performed on the domain.
*/
getUpgradeHistory(params: ES.Types.GetUpgradeHistoryRequest, callback?: (err: AWSError, data: ES.Types.GetUpgradeHistoryResponse) => void): Request<ES.Types.GetUpgradeHistoryResponse, AWSError>;
/**
* Retrieves the complete history of the last 10 upgrades that were performed on the domain.
*/
getUpgradeHistory(callback?: (err: AWSError, data: ES.Types.GetUpgradeHistoryResponse) => void): Request<ES.Types.GetUpgradeHistoryResponse, AWSError>;
/**
* Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
*/
getUpgradeStatus(params: ES.Types.GetUpgradeStatusRequest, callback?: (err: AWSError, data: ES.Types.GetUpgradeStatusResponse) => void): Request<ES.Types.GetUpgradeStatusResponse, AWSError>;
/**
* Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
*/
getUpgradeStatus(callback?: (err: AWSError, data: ES.Types.GetUpgradeStatusResponse) => void): Request<ES.Types.GetUpgradeStatusResponse, AWSError>;
/**
* Returns the name of all Elasticsearch domains owned by the current user's account.
*/
listDomainNames(params: ES.Types.ListDomainNamesRequest, callback?: (err: AWSError, data: ES.Types.ListDomainNamesResponse) => void): Request<ES.Types.ListDomainNamesResponse, AWSError>;
/**
* Returns the name of all Elasticsearch domains owned by the current user's account.
*/
listDomainNames(callback?: (err: AWSError, data: ES.Types.ListDomainNamesResponse) => void): Request<ES.Types.ListDomainNamesResponse, AWSError>;
/**
* Lists all Amazon ES domains associated with the package.
*/
listDomainsForPackage(params: ES.Types.ListDomainsForPackageRequest, callback?: (err: AWSError, data: ES.Types.ListDomainsForPackageResponse) => void): Request<ES.Types.ListDomainsForPackageResponse, AWSError>;
/**
* Lists all Amazon ES domains associated with the package.
*/
listDomainsForPackage(callback?: (err: AWSError, data: ES.Types.ListDomainsForPackageResponse) => void): Request<ES.Types.ListDomainsForPackageResponse, AWSError>;
/**
* List all Elasticsearch instance types that are supported for given ElasticsearchVersion
*/
listElasticsearchInstanceTypes(params: ES.Types.ListElasticsearchInstanceTypesRequest, callback?: (err: AWSError, data: ES.Types.ListElasticsearchInstanceTypesResponse) => void): Request<ES.Types.ListElasticsearchInstanceTypesResponse, AWSError>;
/**
* List all Elasticsearch instance types that are supported for given ElasticsearchVersion
*/
listElasticsearchInstanceTypes(callback?: (err: AWSError, data: ES.Types.ListElasticsearchInstanceTypesResponse) => void): Request<ES.Types.ListElasticsearchInstanceTypesResponse, AWSError>;
/**
* List all supported Elasticsearch versions
*/
listElasticsearchVersions(params: ES.Types.ListElasticsearchVersionsRequest, callback?: (err: AWSError, data: ES.Types.ListElasticsearchVersionsResponse) => void): Request<ES.Types.ListElasticsearchVersionsResponse, AWSError>;
/**
* List all supported Elasticsearch versions
*/
listElasticsearchVersions(callback?: (err: AWSError, data: ES.Types.ListElasticsearchVersionsResponse) => void): Request<ES.Types.ListElasticsearchVersionsResponse, AWSError>;
/**
* Lists all packages associated with the Amazon ES domain.
*/
listPackagesForDomain(params: ES.Types.ListPackagesForDomainRequest, callback?: (err: AWSError, data: ES.Types.ListPackagesForDomainResponse) => void): Request<ES.Types.ListPackagesForDomainResponse, AWSError>;
/**
* Lists all packages associated with the Amazon ES domain.
*/
listPackagesForDomain(callback?: (err: AWSError, data: ES.Types.ListPackagesForDomainResponse) => void): Request<ES.Types.ListPackagesForDomainResponse, AWSError>;
/**
* Returns all tags for the given Elasticsearch domain.
*/
listTags(params: ES.Types.ListTagsRequest, callback?: (err: AWSError, data: ES.Types.ListTagsResponse) => void): Request<ES.Types.ListTagsResponse, AWSError>;
/**
* Returns all tags for the given Elasticsearch domain.
*/
listTags(callback?: (err: AWSError, data: ES.Types.ListTagsResponse) => void): Request<ES.Types.ListTagsResponse, AWSError>;
/**
* Allows you to purchase reserved Elasticsearch instances.
*/
purchaseReservedElasticsearchInstanceOffering(params: ES.Types.PurchaseReservedElasticsearchInstanceOfferingRequest, callback?: (err: AWSError, data: ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse) => void): Request<ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse, AWSError>;
/**
* Allows you to purchase reserved Elasticsearch instances.
*/
purchaseReservedElasticsearchInstanceOffering(callback?: (err: AWSError, data: ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse) => void): Request<ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse, AWSError>;
/**
* Allows the destination domain owner to reject an inbound cross-cluster search connection request.
*/
rejectInboundCrossClusterSearchConnection(params: ES.Types.RejectInboundCrossClusterSearchConnectionRequest, callback?: (err: AWSError, data: ES.Types.RejectInboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.RejectInboundCrossClusterSearchConnectionResponse, AWSError>;
/**
* Allows the destination domain owner to reject an inbound cross-cluster search connection request.
*/
rejectInboundCrossClusterSearchConnection(callback?: (err: AWSError, data: ES.Types.RejectInboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.RejectInboundCrossClusterSearchConnectionResponse, AWSError>;
/**
* Removes the specified set of tags from the specified Elasticsearch domain.
*/
removeTags(params: ES.Types.RemoveTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the specified set of tags from the specified Elasticsearch domain.
*/
removeTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Schedules a service software update for an Amazon ES domain.
*/
startElasticsearchServiceSoftwareUpdate(params: ES.Types.StartElasticsearchServiceSoftwareUpdateRequest, callback?: (err: AWSError, data: ES.Types.StartElasticsearchServiceSoftwareUpdateResponse) => void): Request<ES.Types.StartElasticsearchServiceSoftwareUpdateResponse, AWSError>;
/**
* Schedules a service software update for an Amazon ES domain.
*/
startElasticsearchServiceSoftwareUpdate(callback?: (err: AWSError, data: ES.Types.StartElasticsearchServiceSoftwareUpdateResponse) => void): Request<ES.Types.StartElasticsearchServiceSoftwareUpdateResponse, AWSError>;
/**
* Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
*/
updateElasticsearchDomainConfig(params: ES.Types.UpdateElasticsearchDomainConfigRequest, callback?: (err: AWSError, data: ES.Types.UpdateElasticsearchDomainConfigResponse) => void): Request<ES.Types.UpdateElasticsearchDomainConfigResponse, AWSError>;
/**
* Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
*/
updateElasticsearchDomainConfig(callback?: (err: AWSError, data: ES.Types.UpdateElasticsearchDomainConfigResponse) => void): Request<ES.Types.UpdateElasticsearchDomainConfigResponse, AWSError>;
/**
* Updates a package for use with Amazon ES domains.
*/
updatePackage(params: ES.Types.UpdatePackageRequest, callback?: (err: AWSError, data: ES.Types.UpdatePackageResponse) => void): Request<ES.Types.UpdatePackageResponse, AWSError>;
/**
* Updates a package for use with Amazon ES domains.
*/
updatePackage(callback?: (err: AWSError, data: ES.Types.UpdatePackageResponse) => void): Request<ES.Types.UpdatePackageResponse, AWSError>;
/**
* Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
*/
upgradeElasticsearchDomain(params: ES.Types.UpgradeElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.UpgradeElasticsearchDomainResponse) => void): Request<ES.Types.UpgradeElasticsearchDomainResponse, AWSError>;
/**
* Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
*/
upgradeElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.UpgradeElasticsearchDomainResponse) => void): Request<ES.Types.UpgradeElasticsearchDomainResponse, AWSError>;
}
declare namespace ES {
export type ARN = string;
export interface AcceptInboundCrossClusterSearchConnectionRequest {
/**
* The id of the inbound connection that you want to accept.
*/
CrossClusterSearchConnectionId: CrossClusterSearchConnectionId;
}
export interface AcceptInboundCrossClusterSearchConnectionResponse {
/**
* Specifies the InboundCrossClusterSearchConnection of accepted inbound connection.
*/
CrossClusterSearchConnection?: InboundCrossClusterSearchConnection;
}
export interface AccessPoliciesStatus {
/**
* The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.
*/
Options: PolicyDocument;
/**
* The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.
*/
Status: OptionStatus;
}
export interface AddTagsRequest {
/**
* Specify the ARN for which you want to add the tags.
*/
ARN: ARN;
/**
* List of Tag that need to be added for the Elasticsearch domain.
*/
TagList: TagList;
}
export interface AdditionalLimit {
/**
* Name of Additional Limit is specific to a given InstanceType and for each of it's InstanceRole etc. Attributes and their details: MaximumNumberOfDataNodesSupported This attribute will be present in Master node only to specify how much data nodes upto which given ESPartitionInstanceType can support as master node. MaximumNumberOfDataNodesWithoutMasterNode This attribute will be present in Data node only to specify how much data nodes of given ESPartitionInstanceType upto which you don't need any master nodes to govern them.
*/
LimitName?: LimitName;
/**
* Value for given AdditionalLimit$LimitName .
*/
LimitValues?: LimitValueList;
}
export type AdditionalLimitList = AdditionalLimit[];
export type AdvancedOptions = {[key: string]: String};
export interface AdvancedOptionsStatus {
/**
* Specifies the status of advanced options for the specified Elasticsearch domain.
*/
Options: AdvancedOptions;
/**
* Specifies the status of OptionStatus for advanced options for the specified Elasticsearch 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;
}
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;
/**
* Specifies the SAML application configuration for the domain.
*/
SAMLOptions?: SAMLOptionsInput;
}
export interface AdvancedSecurityOptionsStatus {
/**
* Specifies advanced security options for the specified Elasticsearch domain.
*/
Options: AdvancedSecurityOptions;
/**
* Status of the advanced security options for the specified Elasticsearch domain.
*/
Status: OptionStatus;
}
export interface AssociatePackageRequest {
/**
* Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.
*/
PackageID: PackageID;
/**
* Name of the domain that you want to associate the package with.
*/
DomainName: DomainName;
}
export interface AssociatePackageResponse {
/**
* DomainPackageDetails
*/
DomainPackageDetails?: DomainPackageDetails;
}
export interface AutoTune {
/**
* Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.
*/
AutoTuneType?: AutoTuneType;
/**
* Specifies details of the Auto-Tune action. See the Developer Guide 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 {
/**
* Specifies timestamp at which Auto-Tune maintenance schedule start.
*/
StartAt?: StartAt;
/**
* Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.
*/
Duration?: Duration;
/**
* Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.
*/
CronExpressionForRecurrence?: String;
}
export type AutoTuneMaintenanceScheduleList = AutoTuneMaintenanceSchedule[];
export interface AutoTuneOptions {
/**
* Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
*/
DesiredState?: AutoTuneDesiredState;
/**
* Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.
*/
RollbackOnDisable?: RollbackOnDisable;
/**
* Specifies list of maitenance schedules. See the Developer Guide for more information.
*/
MaintenanceSchedules?: AutoTuneMaintenanceScheduleList;
}
export interface AutoTuneOptionsInput {
/**
* Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
*/
DesiredState?: AutoTuneDesiredState;
/**
* Specifies list of maitenance schedules. See the Developer Guide for more information.
*/
MaintenanceSchedules?: AutoTuneMaintenanceScheduleList;
}
export interface AutoTuneOptionsOutput {
/**
* Specifies the AutoTuneState for the Elasticsearch domain.
*/
State?: AutoTuneState;
/**
* Specifies the error message while enabling or disabling the Auto-Tune.
*/
ErrorMessage?: String;
}
export interface AutoTuneOptionsStatus {
/**
* Specifies Auto-Tune options for the specified Elasticsearch domain.
*/
Options?: AutoTuneOptions;
/**
* Specifies Status of the Auto-Tune options for the specified Elasticsearch 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 {
/**
* Timestamp which tells Auto-Tune options creation date .
*/
CreationDate: UpdateTimestamp;
/**
* Timestamp which tells Auto-Tune options last updated time.
*/
UpdateDate: UpdateTimestamp;
/**
* Specifies the Auto-Tune options latest version.
*/
UpdateVersion?: UIntValue;
/**
* Specifies the AutoTuneState for the Elasticsearch domain.
*/
State: AutoTuneState;
/**
* Specifies the error message while enabling or disabling the Auto-Tune options.
*/
ErrorMessage?: String;
/**
* Indicates whether the Elasticsearch domain is being deleted.
*/
PendingDeletion?: Boolean;
}
export type AutoTuneType = "SCHEDULED_ACTION"|string;
export type BackendRole = string;
export type Boolean = boolean;
export interface CancelElasticsearchServiceSoftwareUpdateRequest {
/**
* The name of the domain that you want to stop the latest service software update on.
*/
DomainName: DomainName;
}
export interface CancelElasticsearchServiceSoftwareUpdateResponse {
/**
* The current status of the Elasticsearch service software update.
*/
ServiceSoftwareOptions?: ServiceSoftwareOptions;
}
export type CloudWatchLogsLogGroupArn = string;
export interface CognitoOptions {
/**
* Specifies the option to enable Cognito for Kibana authentication.
*/
Enabled?: Boolean;
/**
* Specifies the Cognito user pool ID for Kibana authentication.
*/
UserPoolId?: UserPoolId;
/**
* Specifies the Cognito identity pool ID for Kibana authentication.
*/
IdentityPoolId?: IdentityPoolId;
/**
* Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
*/
RoleArn?: RoleArn;
}
export interface CognitoOptionsStatus {
/**
* Specifies the Cognito options for the specified Elasticsearch domain.
*/
Options: CognitoOptions;
/**
* Specifies the status of the Cognito options for the specified Elasticsearch domain.
*/
Status: OptionStatus;
}
export interface ColdStorageOptions {
/**
* Enable cold storage option. Accepted values true or false
*/
Enabled: Boolean;
}
export type CommitMessage = string;
export type CompatibleElasticsearchVersionsList = CompatibleVersionsMap[];
export interface CompatibleVersionsMap {
/**
* The current version of Elasticsearch on which a domain is.
*/
SourceVersion?: ElasticsearchVersionString;
TargetVersions?: ElasticsearchVersionList;
}
export type ConnectionAlias = string;
export interface CreateElasticsearchDomainRequest {
/**
* The name of the Elasticsearch domain that you are 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 X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
*/
ElasticsearchVersion?: ElasticsearchVersionString;
/**
* Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.
*/
ElasticsearchClusterConfig?: ElasticsearchClusterConfig;
/**
* 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 VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains
*/
VPCOptions?: VPCOptions;
/**
* Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
*/
CognitoOptions?: CognitoOptions;
/**
* Specifies the Encryption At Rest Options.
*/
EncryptionAtRestOptions?: EncryptionAtRestOptions;
/**
* Specifies the NodeToNodeEncryptionOptions.
*/
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 Configuration Advanced Options for more information.
*/
AdvancedOptions?: AdvancedOptions;
/**
* Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.
*/
LogPublishingOptions?: LogPublishingOptions;
/**
* Options to specify configuration that will be applied to the domain endpoint.
*/
DomainEndpointOptions?: DomainEndpointOptions;
/**
* Specifies advanced security options.
*/
AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
/**
* Specifies Auto-Tune options.
*/
AutoTuneOptions?: AutoTuneOptionsInput;
/**
* A list of Tag added during domain creation.
*/
TagList?: TagList;
}
export interface CreateElasticsearchDomainResponse {
/**
* The status of the newly created Elasticsearch domain.
*/
DomainStatus?: ElasticsearchDomainStatus;
}
export interface CreateOutboundCrossClusterSearchConnectionRequest {
/**
* Specifies the DomainInformation for the source Elasticsearch domain.
*/
SourceDomainInfo: DomainInformation;
/**
* Specifies the DomainInformation for the destination Elasticsearch domain.
*/
DestinationDomainInfo: DomainInformation;
/**
* Specifies the connection alias that will be used by the customer for this connection.
*/
ConnectionAlias: ConnectionAlias;
}
export interface CreateOutboundCrossClusterSearchConnectionResponse {
/**
* Specifies the DomainInformation for the source Elasticsearch domain.
*/
SourceDomainInfo?: DomainInformation;
/**
* Specifies the DomainInformation for the destination Elasticsearch domain.
*/
DestinationDomainInfo?: DomainInformation;
/**
* Specifies the connection alias provided during the create connection request.
*/
ConnectionAlias?: ConnectionAlias;
/**
* Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection.
*/
ConnectionStatus?: OutboundCrossClusterSearchConnectionStatus;
/**
* Unique id for the created outbound connection, which is used for subsequent operations on connection.
*/
CrossClusterSearchConnectionId?: CrossClusterSearchConnectionId;
}
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 customer S3 location PackageSource for importing the package.
*/
PackageSource: PackageSource;
}
export interface CreatePackageResponse {
/**
* Information about the package PackageDetails.
*/
PackageDetails?: PackageDetails;
}
export type CreatedAt = Date;
export type CrossClusterSearchConnectionId = string;
export type CrossClusterSearchConnectionStatusMessage = string;
export interface DeleteElasticsearchDomainRequest {
/**
* The name of the Elasticsearch domain that you want to permanently delete.
*/
DomainName: DomainName;
}
export interface DeleteElasticsearchDomainResponse {
/**
* The status of the Elasticsearch domain being deleted.
*/
DomainStatus?: ElasticsearchDomainStatus;
}
export interface DeleteInboundCrossClusterSearchConnectionRequest {
/**
* The id of the inbound connection that you want to permanently delete.
*/
CrossClusterSearchConnectionId: CrossClusterSearchConnectionId;
}
export interface DeleteInboundCrossClusterSearchConnectionResponse {
/**
* Specifies the InboundCrossClusterSearchConnection of deleted inbound connection.
*/
CrossClusterSearchConnection?: InboundCrossClusterSearchConnection;
}
export interface DeleteOutboundCrossClusterSearchConnectionRequest {
/**
* The id of the outbound connection that you want to permanently delete.
*/
CrossClusterSearchConnectionId: CrossClusterSearchConnectionId;
}
export interface DeleteOutboundCrossClusterSearchConnectionResponse {
/**
* Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection.
*/
CrossClusterSearchConnection?: OutboundCrossClusterSearchConnection;
}
export interface DeletePackageRequest {
/**
* Internal ID of the package that 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 interface DescribeDomainAutoTunesRequest {
/**
* Specifies 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. It is used for pagination.
*/
NextToken?: NextToken;
}
export interface DescribeDomainAutoTunesResponse {
/**
* Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.
*/
AutoTunes?: AutoTuneList;
/**
* Specifies an identifier to allow retrieval of paginated results.
*/
NextToken?: NextToken;
}
export interface DescribeElasticsearchDomainConfigRequest {
/**
* The Elasticsearch domain that you want to get information about.
*/
DomainName: DomainName;
}
export interface DescribeElasticsearchDomainConfigResponse {
/**
* The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.
*/
DomainConfig: ElasticsearchDomainConfig;
}
export interface DescribeElasticsearchDomainRequest {
/**
* The name of the Elasticsearch domain for which you want information.
*/
DomainName: DomainName;
}
export interface DescribeElasticsearchDomainResponse {
/**
* The current status of the Elasticsearch domain.
*/
DomainStatus: ElasticsearchDomainStatus;
}
export interface DescribeElasticsearchDomainsRequest {
/**
* The Elasticsearch domains for which you want information.
*/
DomainNames: DomainNameList;
}
export interface DescribeElasticsearchDomainsResponse {
/**
* The status of the domains requested in the DescribeElasticsearchDomains request.
*/
DomainStatusList: ElasticsearchDomainStatusList;
}
export interface DescribeElasticsearchInstanceTypeLimitsRequest {
/**
* DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain.
*/
DomainName?: DomainName;
/**
* The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed.
*/
InstanceType: ESPartitionInstanceType;
/**
* Version of Elasticsearch for which Limits are needed.
*/
ElasticsearchVersion: ElasticsearchVersionString;
}
export interface DescribeElasticsearchInstanceTypeLimitsResponse {
LimitsByRole?: LimitsByRole;
}
export interface DescribeInboundCrossClusterSearchConnectionsRequest {
/**
* A list of filters used to match properties for inbound cross-cluster search connection. Available Filter names for this operation are: cross-cluster-search-connection-id source-domain-info.domain-name source-domain-info.owner-id source-domain-info.region destination-domain-info.domain-name
*/
Filters?: FilterList;
/**
* 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. It is used for pagination.
*/
NextToken?: NextToken;
}
export interface DescribeInboundCrossClusterSearchConnectionsResponse {
/**
* Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.
*/
CrossClusterSearchConnections?: InboundCrossClusterSearchConnections;
/**
* 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 DescribeOutboundCrossClusterSearchConnectionsRequest {
/**
* A list of filters used to match properties for outbound cross-cluster search connection. Available Filter names for this operation are: cross-cluster-search-connection-id destination-domain-info.domain-name destination-domain-info.owner-id destination-domain-info.region source-domain-info.domain-name
*/
Filters?: FilterList;
/**
* 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. It is used for pagination.
*/
NextToken?: NextToken;
}
export interface DescribeOutboundCrossClusterSearchConnectionsResponse {
/**
* Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.
*/
CrossClusterSearchConnections?: OutboundCrossClusterSearchConnections;
/**
* 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 DescribePackagesFilter {
/**
* Any field from PackageDetails.
*/
Name?: DescribePackagesFilterName;
/**
* A list of values for the specified field.
*/
Value?: DescribePackagesFilterValues;
}
export type DescribePackagesFilterList = DescribePackagesFilter[];
export type DescribePackagesFilterName = "PackageID"|"PackageName"|"PackageStatus"|string;
export type DescribePackagesFilterValue = string;
export type DescribePackagesFilterValues = DescribePackagesFilterValue[];
export interface DescribePackagesRequest {
/**
* Only returns packages that match the DescribePackagesFilterList values.
*/
Filters?: DescribePackagesFilterList;
/**
* Limits results to a maximum number of packages.
*/
MaxResults?: MaxResults;
/**
* Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
*/
NextToken?: NextToken;
}
export interface DescribePackagesResponse {
/**
* List of PackageDetails objects.
*/
PackageDetailsList?: PackageDetailsList;
NextToken?: String;
}
export interface DescribeReservedElasticsearchInstanceOfferingsRequest {
/**
* The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
*/
ReservedElasticsearchInstanceOfferingId?: GUID;
/**
* Set this value to limit the number of results returned. If not specified, defaults to 100.
*/
MaxResults?: MaxResults;
/**
* NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.
*/
Nex