Opensearch

This page documents function available when using the Opensearch module, created with @service Opensearch.

Index

Documentation

Main.Opensearch.accept_inbound_connectionMethod
accept_inbound_connection(connection_id)
accept_inbound_connection(connection_id, params::Dict{String,<:Any})

Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Arguments

  • connection_id: The ID of the inbound connection to accept.
Main.Opensearch.add_tagsMethod
add_tags(arn, tag_list)
add_tags(arn, tag_list, params::Dict{String,<:Any})

Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.

Arguments

  • arn: Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.
  • tag_list: List of resource tags.
Main.Opensearch.associate_packageMethod
associate_package(domain_name, package_id)
associate_package(domain_name, package_id, params::Dict{String,<:Any})

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

Arguments

  • domain_name: Name of the domain to associate the package with.
  • package_id: Internal ID of the package to associate with a domain. Use DescribePackages to find this value.
Main.Opensearch.authorize_vpc_endpoint_accessMethod
authorize_vpc_endpoint_access(account, domain_name)
authorize_vpc_endpoint_access(account, domain_name, params::Dict{String,<:Any})

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Arguments

  • account: The Amazon Web Services account ID to grant access to.
  • domain_name: The name of the OpenSearch Service domain to provide access to.
Main.Opensearch.cancel_service_software_updateMethod
cancel_service_software_update(domain_name)
cancel_service_software_update(domain_name, params::Dict{String,<:Any})

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

Arguments

  • domain_name: Name of the OpenSearch Service domain that you want to cancel the service software update on.
Main.Opensearch.create_domainMethod
create_domain(domain_name)
create_domain(domain_name, params::Dict{String,<:Any})

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

Arguments

  • domain_name: Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccessPolicies": Identity and Access Management (IAM) policy document specifying the access policies for the new domain.
  • "AdvancedOptions": Key-value pairs to specify advanced configuration options. The following key-value pairs are supported: "rest.action.multi.allowexplicitindex": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. "indices.query.bool.maxclausecount": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error. "overridemainresponse_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain. For more information, see Advanced cluster parameters.
  • "AdvancedSecurityOptions": Options for fine-grained access control.
  • "AutoTuneOptions": Options for Auto-Tune.
  • "ClusterConfig": Container for the cluster configuration of a domain.
  • "CognitoOptions": Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
  • "DomainEndpointOptions": Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
  • "EBSOptions": Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
  • "EncryptionAtRestOptions": Key-value pairs to enable encryption at rest.
  • "EngineVersion": String of format ElasticsearchX.Y or OpenSearchX.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch1.0 or Elasticsearch7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.
  • "LogPublishingOptions": Key-value pairs to configure log publishing.
  • "NodeToNodeEncryptionOptions": Enables node-to-node encryption.
  • "OffPeakWindowOptions": Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.
  • "SnapshotOptions": DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.
  • "SoftwareUpdateOptions": Software update options for the domain.
  • "TagList": List of tags to add to the domain upon creation.
  • "VPCOptions": Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
Main.Opensearch.create_outbound_connectionMethod
create_outbound_connection(connection_alias, local_domain_info, remote_domain_info)
create_outbound_connection(connection_alias, local_domain_info, remote_domain_info, params::Dict{String,<:Any})

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Arguments

  • connection_alias: Name of the connection.
  • local_domain_info: Name and Region of the source (local) domain.
  • remote_domain_info: Name and Region of the destination (remote) domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConnectionMode": The connection mode.
  • "ConnectionProperties": The ConnectionProperties for the outbound connection.
Main.Opensearch.create_packageMethod
create_package(package_name, package_source, package_type)
create_package(package_name, package_source, package_type, params::Dict{String,<:Any})

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

Arguments

  • package_name: Unique name for the package.
  • package_source: The Amazon S3 location from which to import the package.
  • package_type: The type of package.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "PackageDescription": Description of the package.
Main.Opensearch.create_vpc_endpointMethod
create_vpc_endpoint(domain_arn, vpc_options)
create_vpc_endpoint(domain_arn, vpc_options, params::Dict{String,<:Any})

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Arguments

  • domain_arn: The Amazon Resource Name (ARN) of the domain to create the endpoint for.
  • vpc_options: Options to specify the subnets and security groups for the endpoint.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": Unique, case-sensitive identifier to ensure idempotency of the request.
Main.Opensearch.delete_domainMethod
delete_domain(domain_name)
delete_domain(domain_name, params::Dict{String,<:Any})

Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.

Arguments

  • domain_name: The name of the domain you want to permanently delete.
Main.Opensearch.delete_inbound_connectionMethod
delete_inbound_connection(connection_id)
delete_inbound_connection(connection_id, params::Dict{String,<:Any})

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Arguments

  • connection_id: The ID of the inbound connection to permanently delete.
Main.Opensearch.delete_outbound_connectionMethod
delete_outbound_connection(connection_id)
delete_outbound_connection(connection_id, params::Dict{String,<:Any})

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Arguments

  • connection_id: The ID of the outbound connection you want to permanently delete.
Main.Opensearch.delete_packageMethod
delete_package(package_id)
delete_package(package_id, params::Dict{String,<:Any})

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

Arguments

  • package_id: The internal ID of the package you want to delete. Use DescribePackages to find this value.
Main.Opensearch.delete_vpc_endpointMethod
delete_vpc_endpoint(vpc_endpoint_id)
delete_vpc_endpoint(vpc_endpoint_id, params::Dict{String,<:Any})

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Arguments

  • vpc_endpoint_id: The unique identifier of the endpoint.
Main.Opensearch.describe_domainMethod
describe_domain(domain_name)
describe_domain(domain_name, params::Dict{String,<:Any})

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

Arguments

  • domain_name: The name of the domain that you want information about.
Main.Opensearch.describe_domain_auto_tunesMethod
describe_domain_auto_tunes(domain_name)
describe_domain_auto_tunes(domain_name, params::Dict{String,<:Any})

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

Arguments

  • domain_name: Name of the domain that you want Auto-Tune details about.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "NextToken": If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.
Main.Opensearch.describe_domain_change_progressMethod
describe_domain_change_progress(domain_name)
describe_domain_change_progress(domain_name, params::Dict{String,<:Any})

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

Arguments

  • domain_name: The name of the domain to get progress information for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "changeid": The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.
Main.Opensearch.describe_domain_configMethod
describe_domain_config(domain_name)
describe_domain_config(domain_name, params::Dict{String,<:Any})

Returns the configuration of an Amazon OpenSearch Service domain.

Arguments

  • domain_name: Name of the OpenSearch Service domain configuration that you want to describe.
Main.Opensearch.describe_domain_healthMethod
describe_domain_health(domain_name)
describe_domain_health(domain_name, params::Dict{String,<:Any})

Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

Arguments

  • domain_name: The name of the domain.
Main.Opensearch.describe_domain_nodesMethod
describe_domain_nodes(domain_name)
describe_domain_nodes(domain_name, params::Dict{String,<:Any})

Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

Arguments

  • domain_name: The name of the domain.
Main.Opensearch.describe_domainsMethod
describe_domains(domain_names)
describe_domains(domain_names, params::Dict{String,<:Any})

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

Arguments

  • domain_names: Array of OpenSearch Service domain names that you want information about. If you don't specify any domains, OpenSearch Service returns information about all domains owned by the account.
Main.Opensearch.describe_dry_run_progressMethod
describe_dry_run_progress(domain_name)
describe_dry_run_progress(domain_name, params::Dict{String,<:Any})

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

Arguments

  • domain_name: The name of the domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "dryRunId": The unique identifier of the dry run.
  • "loadDryRunConfig": Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you're planning to make on the domain.
Main.Opensearch.describe_inbound_connectionsMethod
describe_inbound_connections()
describe_inbound_connections(params::Dict{String,<:Any})

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": A list of filters used to match properties for inbound cross-cluster connections.
  • "MaxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "NextToken": If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.
Main.Opensearch.describe_instance_type_limitsMethod
describe_instance_type_limits(engine_version, instance_type)
describe_instance_type_limits(engine_version, instance_type, params::Dict{String,<:Any})

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

Arguments

  • engine_version: Version of OpenSearch or Elasticsearch, in the format ElasticsearchX.Y or OpenSearchX.Y. Defaults to the latest version of OpenSearch.
  • instance_type: The OpenSearch Service instance type for which you need limit information.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domainName": The name of the domain. Only specify if you need the limits for an existing domain.
Main.Opensearch.describe_outbound_connectionsMethod
describe_outbound_connections()
describe_outbound_connections(params::Dict{String,<:Any})

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": List of filter names and values that you can use for requests.
  • "MaxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "NextToken": If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.
Main.Opensearch.describe_packagesMethod
describe_packages()
describe_packages(params::Dict{String,<:Any})

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": Only returns packages that match the DescribePackagesFilterList values.
  • "MaxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "NextToken": If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.
Main.Opensearch.describe_reserved_instance_offeringsMethod
describe_reserved_instance_offerings()
describe_reserved_instance_offerings(params::Dict{String,<:Any})

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "nextToken": If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.
  • "offeringId": The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.
Main.Opensearch.describe_reserved_instancesMethod
describe_reserved_instances()
describe_reserved_instances(params::Dict{String,<:Any})

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "nextToken": If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.
  • "reservationId": The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
Main.Opensearch.describe_vpc_endpointsMethod
describe_vpc_endpoints(vpc_endpoint_ids)
describe_vpc_endpoints(vpc_endpoint_ids, params::Dict{String,<:Any})

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

Arguments

  • vpc_endpoint_ids: The unique identifiers of the endpoints to get information about.
Main.Opensearch.dissociate_packageMethod
dissociate_package(domain_name, package_id)
dissociate_package(domain_name, package_id, params::Dict{String,<:Any})

Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

Arguments

  • domain_name: Name of the domain to dissociate the package from.
  • package_id: Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.
Main.Opensearch.get_compatible_versionsMethod
get_compatible_versions()
get_compatible_versions(params::Dict{String,<:Any})

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domainName": The name of an existing domain. Provide this parameter to limit the results to a single domain.
Main.Opensearch.get_package_version_historyMethod
get_package_version_history(package_id)
get_package_version_history(package_id, params::Dict{String,<:Any})

Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.

Arguments

  • package_id: The unique identifier of the package.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "nextToken": If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.
Main.Opensearch.get_upgrade_historyMethod
get_upgrade_history(domain_name)
get_upgrade_history(domain_name, params::Dict{String,<:Any})

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

Arguments

  • domain_name: The name of an existing domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "nextToken": If your initial GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.
Main.Opensearch.get_upgrade_statusMethod
get_upgrade_status(domain_name)
get_upgrade_status(domain_name, params::Dict{String,<:Any})

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

Arguments

  • domain_name: The domain of the domain to get upgrade status information for.
Main.Opensearch.list_domain_namesMethod
list_domain_names()
list_domain_names(params::Dict{String,<:Any})

Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "engineType": Filters the output by domain engine type.
Main.Opensearch.list_domains_for_packageMethod
list_domains_for_package(package_id)
list_domains_for_package(package_id, params::Dict{String,<:Any})

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

Arguments

  • package_id: The unique identifier of the package for which to list associated domains.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "nextToken": If your initial ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.
Main.Opensearch.list_instance_type_detailsMethod
list_instance_type_details(engine_version)
list_instance_type_details(engine_version, params::Dict{String,<:Any})

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

Arguments

  • engine_version: The version of OpenSearch or Elasticsearch, in the format ElasticsearchX.Y or OpenSearchX.Y. Defaults to the latest version of OpenSearch.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domainName": The name of the domain.
  • "instanceType": An optional parameter that lists information for a given instance type.
  • "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "nextToken": If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.
  • "retrieveAZs": An optional parameter that specifies the Availability Zones for the domain.
Main.Opensearch.list_packages_for_domainMethod
list_packages_for_domain(domain_name)
list_packages_for_domain(domain_name, params::Dict{String,<:Any})

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

Arguments

  • domain_name: The name of the domain for which you want to list associated packages.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "nextToken": If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.
Main.Opensearch.list_scheduled_actionsMethod
list_scheduled_actions(domain_name)
list_scheduled_actions(domain_name, params::Dict{String,<:Any})

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

Arguments

  • domain_name: The name of the domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "nextToken": If your initial ListScheduledActions operation returns a nextToken, you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.
Main.Opensearch.list_tagsMethod
list_tags(arn)
list_tags(arn, params::Dict{String,<:Any})

Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

Arguments

  • arn: Amazon Resource Name (ARN) for the domain to view tags for.
Main.Opensearch.list_versionsMethod
list_versions()
list_versions(params::Dict{String,<:Any})

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • "nextToken": If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.
Main.Opensearch.list_vpc_endpoint_accessMethod
list_vpc_endpoint_access(domain_name)
list_vpc_endpoint_access(domain_name, params::Dict{String,<:Any})

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Arguments

  • domain_name: The name of the OpenSearch Service domain to retrieve access information for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": If your initial ListVpcEndpointAccess operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.
Main.Opensearch.list_vpc_endpointsMethod
list_vpc_endpoints()
list_vpc_endpoints(params::Dict{String,<:Any})

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.
Main.Opensearch.list_vpc_endpoints_for_domainMethod
list_vpc_endpoints_for_domain(domain_name)
list_vpc_endpoints_for_domain(domain_name, params::Dict{String,<:Any})

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

Arguments

  • domain_name: The name of the domain to list associated VPC endpoints for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.
Main.Opensearch.purchase_reserved_instance_offeringMethod
purchase_reserved_instance_offering(reservation_name, reserved_instance_offering_id)
purchase_reserved_instance_offering(reservation_name, reserved_instance_offering_id, params::Dict{String,<:Any})

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

Arguments

  • reservation_name: A customer-specified identifier to track this reservation.
  • reserved_instance_offering_id: The ID of the Reserved Instance offering to purchase.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "InstanceCount": The number of OpenSearch instances to reserve.
Main.Opensearch.reject_inbound_connectionMethod
reject_inbound_connection(connection_id)
reject_inbound_connection(connection_id, params::Dict{String,<:Any})

Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.

Arguments

  • connection_id: The unique identifier of the inbound connection to reject.
Main.Opensearch.remove_tagsMethod
remove_tags(arn, tag_keys)
remove_tags(arn, tag_keys, params::Dict{String,<:Any})

Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

Arguments

  • arn: The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.
  • tag_keys: The list of tag keys to remove from the domain.
Main.Opensearch.revoke_vpc_endpoint_accessMethod
revoke_vpc_endpoint_access(account, domain_name)
revoke_vpc_endpoint_access(account, domain_name, params::Dict{String,<:Any})

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

Arguments

  • account: The account ID to revoke access from.
  • domain_name: The name of the OpenSearch Service domain.
Main.Opensearch.start_service_software_updateMethod
start_service_software_update(domain_name)
start_service_software_update(domain_name, params::Dict{String,<:Any})

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

Arguments

  • domain_name: The name of the domain that you want to update to the latest service software.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DesiredStartTime": The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.
  • "ScheduleAt": When to start the service software update. NOW - Immediately schedules the update to happen in the current hour if there's capacity available. TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime. OFFPEAKWINDOW - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days. Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.
Main.Opensearch.update_domain_configMethod
update_domain_config(domain_name)
update_domain_config(domain_name, params::Dict{String,<:Any})

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.sl

Arguments

  • domain_name: The name of the domain that you're updating.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccessPolicies": Identity and Access Management (IAM) access policy as a JSON-formatted string.
  • "AdvancedOptions": Key-value pairs to specify advanced configuration options. The following key-value pairs are supported: "rest.action.multi.allowexplicitindex": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. "indices.query.bool.maxclausecount": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error. For more information, see Advanced cluster parameters.
  • "AdvancedSecurityOptions": Options for fine-grained access control.
  • "AutoTuneOptions": Options for Auto-Tune.
  • "ClusterConfig": Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
  • "CognitoOptions": Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
  • "DomainEndpointOptions": Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
  • "DryRun": This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.
  • "DryRunMode": The type of dry run to perform. Basic only returns the type of deployment (blue/green or dynamic) that the update will cause. Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update.
  • "EBSOptions": The type and size of the EBS volume to attach to instances in the domain.
  • "EncryptionAtRestOptions": Encryption at rest options for the domain.
  • "LogPublishingOptions": Options to publish OpenSearch logs to Amazon CloudWatch Logs.
  • "NodeToNodeEncryptionOptions": Node-to-node encryption options for the domain.
  • "OffPeakWindowOptions": Off-peak window options for the domain.
  • "SnapshotOptions": Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
  • "SoftwareUpdateOptions": Service software update options for the domain.
  • "VPCOptions": Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
Main.Opensearch.update_packageMethod
update_package(package_id, package_source)
update_package(package_id, package_source, params::Dict{String,<:Any})

Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

Arguments

  • package_id: The unique identifier for the package.
  • package_source: Amazon S3 bucket and key for the package.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "CommitMessage": Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.
  • "PackageDescription": A new description of the package.
Main.Opensearch.update_scheduled_actionMethod
update_scheduled_action(action_id, action_type, domain_name, schedule_at)
update_scheduled_action(action_id, action_type, domain_name, schedule_at, params::Dict{String,<:Any})

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

Arguments

  • action_id: The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.
  • action_type: The type of action to reschedule. Can be one of SERVICESOFTWAREUPDATE, JVMHEAPSIZETUNING, or JVMYOUNGGENTUNING. To retrieve this value, send a ListScheduledActions request.
  • domain_name: The name of the domain to reschedule an action for.
  • schedule_at: When to schedule the action. NOW - Immediately schedules the update to happen in the current hour if there's capacity available. TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime. OFFPEAKWINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DesiredStartTime": The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.
Main.Opensearch.update_vpc_endpointMethod
update_vpc_endpoint(vpc_endpoint_id, vpc_options)
update_vpc_endpoint(vpc_endpoint_id, vpc_options, params::Dict{String,<:Any})

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Arguments

  • vpc_endpoint_id: The unique identifier of the endpoint.
  • vpc_options: The security groups and/or subnets to add, remove, or modify.
Main.Opensearch.upgrade_domainMethod
upgrade_domain(domain_name, target_version)
upgrade_domain(domain_name, target_version, params::Dict{String,<:Any})

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Arguments

  • domain_name: Name of the OpenSearch Service domain that you want to upgrade.
  • target_version: OpenSearch or Elasticsearch version to which you want to upgrade, in the format OpensearchX.Y or ElasticsearchX.Y.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AdvancedOptions": Only supports the overridemainresponse_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.
  • "PerformCheckOnly": When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.