ElasticsearchService
public struct ElasticsearchService
Client object for interacting with AWS ElasticsearchService service.
Amazon Elasticsearch Configuration Service Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains. For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs. The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the ElasticsearchService client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)
Parameters
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
Allows the destination domain owner to accept an inbound cross-cluster search connection request.
Declaration
Swift
public func acceptInboundCrossClusterSearchConnection(_ input: AcceptInboundCrossClusterSearchConnectionRequest) -> EventLoopFuture<AcceptInboundCrossClusterSearchConnectionResponse>
-
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.
Declaration
Swift
@discardableResult public func addTags(_ input: AddTagsRequest) -> EventLoopFuture<Void>
-
Associates a package with an Amazon ES domain.
Declaration
Swift
public func associatePackage(_ input: AssociatePackageRequest) -> EventLoopFuture<AssociatePackageResponse>
-
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.
Declaration
Swift
public func cancelElasticsearchServiceSoftwareUpdate(_ input: CancelElasticsearchServiceSoftwareUpdateRequest) -> EventLoopFuture<CancelElasticsearchServiceSoftwareUpdateResponse>
-
Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
Declaration
Swift
public func createElasticsearchDomain(_ input: CreateElasticsearchDomainRequest) -> EventLoopFuture<CreateElasticsearchDomainResponse>
-
Creates a new cross-cluster search connection from a source domain to a destination domain.
Declaration
Swift
public func createOutboundCrossClusterSearchConnection(_ input: CreateOutboundCrossClusterSearchConnectionRequest) -> EventLoopFuture<CreateOutboundCrossClusterSearchConnectionResponse>
-
Create a package for use with Amazon ES domains.
Declaration
Swift
public func createPackage(_ input: CreatePackageRequest) -> EventLoopFuture<CreatePackageResponse>
-
Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
Declaration
Swift
public func deleteElasticsearchDomain(_ input: DeleteElasticsearchDomainRequest) -> EventLoopFuture<DeleteElasticsearchDomainResponse>
-
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.
Declaration
Swift
@discardableResult public func deleteElasticsearchServiceRole() -> EventLoopFuture<Void>
-
Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
Declaration
Swift
public func deleteInboundCrossClusterSearchConnection(_ input: DeleteInboundCrossClusterSearchConnectionRequest) -> EventLoopFuture<DeleteInboundCrossClusterSearchConnectionResponse>
-
Allows the source domain owner to delete an existing outbound cross-cluster search connection.
Declaration
Swift
public func deleteOutboundCrossClusterSearchConnection(_ input: DeleteOutboundCrossClusterSearchConnectionRequest) -> EventLoopFuture<DeleteOutboundCrossClusterSearchConnectionResponse>
-
Delete the package.
Declaration
Swift
public func deletePackage(_ input: DeletePackageRequest) -> EventLoopFuture<DeletePackageResponse>
-
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
Declaration
Swift
public func describeElasticsearchDomain(_ input: DescribeElasticsearchDomainRequest) -> EventLoopFuture<DescribeElasticsearchDomainResponse>
-
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
Declaration
Swift
public func describeElasticsearchDomainConfig(_ input: DescribeElasticsearchDomainConfigRequest) -> EventLoopFuture<DescribeElasticsearchDomainConfigResponse>
-
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
Declaration
Swift
public func describeElasticsearchDomains(_ input: DescribeElasticsearchDomainsRequest) -> EventLoopFuture<DescribeElasticsearchDomainsResponse>
-
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.
Declaration
Swift
public func describeElasticsearchInstanceTypeLimits(_ input: DescribeElasticsearchInstanceTypeLimitsRequest) -> EventLoopFuture<DescribeElasticsearchInstanceTypeLimitsResponse>
-
Lists all the inbound cross-cluster search connections for a destination domain.
Declaration
Swift
public func describeInboundCrossClusterSearchConnections(_ input: DescribeInboundCrossClusterSearchConnectionsRequest) -> EventLoopFuture<DescribeInboundCrossClusterSearchConnectionsResponse>
-
Lists all the outbound cross-cluster search connections for a source domain.
Declaration
Swift
public func describeOutboundCrossClusterSearchConnections(_ input: DescribeOutboundCrossClusterSearchConnectionsRequest) -> EventLoopFuture<DescribeOutboundCrossClusterSearchConnectionsResponse>
-
Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
Declaration
Swift
public func describePackages(_ input: DescribePackagesRequest) -> EventLoopFuture<DescribePackagesResponse>
-
Lists available reserved Elasticsearch instance offerings.
Declaration
Swift
public func describeReservedElasticsearchInstanceOfferings(_ input: DescribeReservedElasticsearchInstanceOfferingsRequest) -> EventLoopFuture<DescribeReservedElasticsearchInstanceOfferingsResponse>
-
Returns information about reserved Elasticsearch instances for this account.
Declaration
Swift
public func describeReservedElasticsearchInstances(_ input: DescribeReservedElasticsearchInstancesRequest) -> EventLoopFuture<DescribeReservedElasticsearchInstancesResponse>
-
Dissociates a package from the Amazon ES domain.
Declaration
Swift
public func dissociatePackage(_ input: DissociatePackageRequest) -> EventLoopFuture<DissociatePackageResponse>
-
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.
Declaration
Swift
public func getCompatibleElasticsearchVersions(_ input: GetCompatibleElasticsearchVersionsRequest) -> EventLoopFuture<GetCompatibleElasticsearchVersionsResponse>
-
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
Declaration
Swift
public func getUpgradeHistory(_ input: GetUpgradeHistoryRequest) -> EventLoopFuture<GetUpgradeHistoryResponse>
-
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
Declaration
Swift
public func getUpgradeStatus(_ input: GetUpgradeStatusRequest) -> EventLoopFuture<GetUpgradeStatusResponse>
-
Returns the name of all Elasticsearch domains owned by the current user’s account.
Declaration
Swift
public func listDomainNames() -> EventLoopFuture<ListDomainNamesResponse>
-
Lists all Amazon ES domains associated with the package.
Declaration
Swift
public func listDomainsForPackage(_ input: ListDomainsForPackageRequest) -> EventLoopFuture<ListDomainsForPackageResponse>
-
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
Declaration
Swift
public func listElasticsearchInstanceTypes(_ input: ListElasticsearchInstanceTypesRequest) -> EventLoopFuture<ListElasticsearchInstanceTypesResponse>
-
List all supported Elasticsearch versions
Declaration
Swift
public func listElasticsearchVersions(_ input: ListElasticsearchVersionsRequest) -> EventLoopFuture<ListElasticsearchVersionsResponse>
-
Lists all packages associated with the Amazon ES domain.
Declaration
Swift
public func listPackagesForDomain(_ input: ListPackagesForDomainRequest) -> EventLoopFuture<ListPackagesForDomainResponse>
-
Returns all tags for the given Elasticsearch domain.
Declaration
Swift
public func listTags(_ input: ListTagsRequest) -> EventLoopFuture<ListTagsResponse>
-
Allows you to purchase reserved Elasticsearch instances.
Declaration
Swift
public func purchaseReservedElasticsearchInstanceOffering(_ input: PurchaseReservedElasticsearchInstanceOfferingRequest) -> EventLoopFuture<PurchaseReservedElasticsearchInstanceOfferingResponse>
-
Allows the destination domain owner to reject an inbound cross-cluster search connection request.
Declaration
Swift
public func rejectInboundCrossClusterSearchConnection(_ input: RejectInboundCrossClusterSearchConnectionRequest) -> EventLoopFuture<RejectInboundCrossClusterSearchConnectionResponse>
-
Removes the specified set of tags from the specified Elasticsearch domain.
Declaration
Swift
@discardableResult public func removeTags(_ input: RemoveTagsRequest) -> EventLoopFuture<Void>
-
Schedules a service software update for an Amazon ES domain.
Declaration
Swift
public func startElasticsearchServiceSoftwareUpdate(_ input: StartElasticsearchServiceSoftwareUpdateRequest) -> EventLoopFuture<StartElasticsearchServiceSoftwareUpdateResponse>
-
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
Declaration
Swift
public func updateElasticsearchDomainConfig(_ input: UpdateElasticsearchDomainConfigRequest) -> EventLoopFuture<UpdateElasticsearchDomainConfigResponse>
-
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
Declaration
Swift
public func upgradeElasticsearchDomain(_ input: UpgradeElasticsearchDomainRequest) -> EventLoopFuture<UpgradeElasticsearchDomainResponse>
-
Lists all the inbound cross-cluster search connections for a destination domain.
Declaration
Swift
public func describeInboundCrossClusterSearchConnectionsPaginator(_ input: DescribeInboundCrossClusterSearchConnectionsRequest, onPage: @escaping (DescribeInboundCrossClusterSearchConnectionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists all the outbound cross-cluster search connections for a source domain.
Declaration
Swift
public func describeOutboundCrossClusterSearchConnectionsPaginator(_ input: DescribeOutboundCrossClusterSearchConnectionsRequest, onPage: @escaping (DescribeOutboundCrossClusterSearchConnectionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
Declaration
Swift
public func describePackagesPaginator(_ input: DescribePackagesRequest, onPage: @escaping (DescribePackagesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists available reserved Elasticsearch instance offerings.
Declaration
Swift
public func describeReservedElasticsearchInstanceOfferingsPaginator(_ input: DescribeReservedElasticsearchInstanceOfferingsRequest, onPage: @escaping (DescribeReservedElasticsearchInstanceOfferingsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Returns information about reserved Elasticsearch instances for this account.
Declaration
Swift
public func describeReservedElasticsearchInstancesPaginator(_ input: DescribeReservedElasticsearchInstancesRequest, onPage: @escaping (DescribeReservedElasticsearchInstancesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
Declaration
Swift
public func getUpgradeHistoryPaginator(_ input: GetUpgradeHistoryRequest, onPage: @escaping (GetUpgradeHistoryResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists all Amazon ES domains associated with the package.
Declaration
Swift
public func listDomainsForPackagePaginator(_ input: ListDomainsForPackageRequest, onPage: @escaping (ListDomainsForPackageResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
Declaration
Swift
public func listElasticsearchInstanceTypesPaginator(_ input: ListElasticsearchInstanceTypesRequest, onPage: @escaping (ListElasticsearchInstanceTypesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
List all supported Elasticsearch versions
Declaration
Swift
public func listElasticsearchVersionsPaginator(_ input: ListElasticsearchVersionsRequest, onPage: @escaping (ListElasticsearchVersionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists all packages associated with the Amazon ES domain.
Declaration
Swift
public func listPackagesForDomainPaginator(_ input: ListPackagesForDomainRequest, onPage: @escaping (ListPackagesForDomainResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct DescribeInboundCrossClusterSearchConnectionsRequest : AWSShape
extension ElasticsearchService.DescribeInboundCrossClusterSearchConnectionsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct DescribeOutboundCrossClusterSearchConnectionsRequest : AWSShape
extension ElasticsearchService.DescribeOutboundCrossClusterSearchConnectionsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct DescribePackagesRequest : AWSShape
extension ElasticsearchService.DescribePackagesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct DescribeReservedElasticsearchInstanceOfferingsRequest : AWSShape
extension ElasticsearchService.DescribeReservedElasticsearchInstanceOfferingsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct DescribeReservedElasticsearchInstancesRequest : AWSShape
extension ElasticsearchService.DescribeReservedElasticsearchInstancesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetUpgradeHistoryRequest : AWSShape
extension ElasticsearchService.GetUpgradeHistoryRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListDomainsForPackageRequest : AWSShape
extension ElasticsearchService.ListDomainsForPackageRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListElasticsearchInstanceTypesRequest : AWSShape
extension ElasticsearchService.ListElasticsearchInstanceTypesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListElasticsearchVersionsRequest : AWSShape
extension ElasticsearchService.ListElasticsearchVersionsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListPackagesForDomainRequest : AWSShape
extension ElasticsearchService.ListPackagesForDomainRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum DeploymentStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DescribePackagesFilterName : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DomainPackageStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ESPartitionInstanceType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ESWarmPartitionInstanceType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum InboundCrossClusterSearchConnectionStatusCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum LogType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum OptionState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum OutboundCrossClusterSearchConnectionStatusCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum PackageStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum PackageType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReservedElasticsearchInstancePaymentOption : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum TLSSecurityPolicy : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum UpgradeStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum UpgradeStep : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum VolumeType : String, CustomStringConvertible, Codable