View Source aws_opensearch (aws v1.0.4)
Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains.
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 Amazon Web Services service endpoints: https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions.Summary
Functions
Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.
Creates a new direct-query data source to the specified domain.
Attaches tags to an existing Amazon OpenSearch Service domain.
Associates a package with an Amazon OpenSearch Service domain.
Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
Creates an Amazon OpenSearch Service domain.
Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.
Creates a package for use with Amazon OpenSearch Service domains.
Deletes a direct-query data source.
Deletes an Amazon OpenSearch Service domain and all of its data.
Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.
Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.
Deletes an Amazon OpenSearch Service package.
Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
Describes all packages available to OpenSearch Service.
Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
Removes a package from the specified Amazon OpenSearch Service domain.
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).
Lists direct-query data sources for a specific domain.
Lists all Amazon OpenSearch Service domains associated with a given package.
Lists all packages associated with an Amazon OpenSearch Service domain.
Retrieves a list of configuration changes that are scheduled for a domain.
Returns all resource tags for an Amazon OpenSearch Service domain.
Removes the specified set of tags from an Amazon OpenSearch Service domain.
Starts the node maintenance process on the data node.
Schedules a service software update for an Amazon OpenSearch Service domain.
Updates a direct-query data source.
Updates a package for use with Amazon OpenSearch Service domains.
Reschedules a planned domain configuration change for a later time.
Functions
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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html.Creates a new direct-query data source to the specified domain.
For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html.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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html.Associates a package with an Amazon OpenSearch Service domain.
For more information, see Custom packages for Amazon OpenSearch Service: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html.associate_package(Client, DomainName, PackageID, Input0, Options0)
View Sourceauthorize_vpc_endpoint_access(Client, DomainName, Input0, Options0)
View SourceCancels a scheduled service software update for an Amazon OpenSearch Service domain.
You can only perform this operation before theAutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html.
Creates an Amazon OpenSearch Service domain.
For more information, see Creating and managing Amazon OpenSearch Service domains: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html.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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html.Creates a package for use with Amazon OpenSearch Service domains.
For more information, see Custom packages for Amazon OpenSearch Service: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html.Deletes a direct-query data source.
For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-delete.html.Deletes an Amazon OpenSearch Service domain and all of its data.
You can't recover a domain after you delete it.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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html.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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html.delete_outbound_connection(Client, ConnectionId, Input0, Options0)
View SourceDeletes an Amazon OpenSearch Service package.
For more information, see Custom packages for Amazon OpenSearch Service: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html.describe_domain(Client, DomainName, QueryMap, HeadersMap, Options0)
View SourceReturns 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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html.describe_domain_auto_tunes(Client, DomainName, QueryMap, HeadersMap)
View Sourcedescribe_domain_auto_tunes(Client, DomainName, QueryMap, HeadersMap, Options0)
View SourceReturns 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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes.html.describe_domain_change_progress(Client, DomainName, QueryMap, HeadersMap)
View Sourcedescribe_domain_change_progress(Client, DomainName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_domain_config(Client, DomainName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_domain_health(Client, DomainName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_domain_nodes(Client, DomainName, QueryMap, HeadersMap, Options0)
View SourceDescribes 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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#dryrun.describe_dry_run_progress(Client, DomainName, QueryMap, HeadersMap)
View Sourcedescribe_dry_run_progress(Client, DomainName, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html.describe_instance_type_limits(Client, EngineVersion, InstanceType)
View Sourcedescribe_instance_type_limits(Client, EngineVersion, InstanceType, QueryMap, HeadersMap)
View Sourcedescribe_instance_type_limits(Client, EngineVersion, InstanceType, QueryMap, HeadersMap, Options0)
View SourceLists 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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html.Describes all packages available to OpenSearch Service.
For more information, see Custom packages for Amazon OpenSearch Service: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html.Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
For more information, see Reserved Instances in Amazon OpenSearch Service: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html.describe_reserved_instance_offerings(Client, QueryMap, HeadersMap)
View Sourcedescribe_reserved_instance_offerings(Client, QueryMap, HeadersMap, Options0)
View SourceDescribes the Amazon OpenSearch Service instances that you have reserved in a given Region.
For more information, see Reserved Instances in Amazon OpenSearch Service: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html.describe_reserved_instances(Client, QueryMap, HeadersMap, Options0)
View SourceRemoves 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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html.dissociate_package(Client, DomainName, PackageID, Input0, Options0)
View Sourceget_data_source(Client, DomainName, Name, QueryMap, HeadersMap, Options0)
View Sourceget_domain_maintenance_status(Client, DomainName, MaintenanceId, QueryMap, HeadersMap)
View Sourceget_domain_maintenance_status(Client, DomainName, MaintenanceId, QueryMap, HeadersMap, Options0)
View SourceReturns 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: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html.get_package_version_history(Client, PackageID, QueryMap, HeadersMap)
View Sourceget_package_version_history(Client, PackageID, QueryMap, HeadersMap, Options0)
View Sourceget_upgrade_history(Client, DomainName, QueryMap, HeadersMap, Options0)
View Sourceget_upgrade_status(Client, DomainName, QueryMap, HeadersMap, Options0)
View SourceLists direct-query data sources for a specific domain.
For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3.html.list_data_sources(Client, DomainName, QueryMap, HeadersMap, Options0)
View Sourcelist_domain_maintenances(Client, DomainName, QueryMap, HeadersMap)
View Sourcelist_domain_maintenances(Client, DomainName, QueryMap, HeadersMap, Options0)
View SourceLists all Amazon OpenSearch Service domains associated with a given package.
For more information, see Custom packages for Amazon OpenSearch Service: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html.list_domains_for_package(Client, PackageID, QueryMap, HeadersMap, Options0)
View Sourcelist_instance_type_details(Client, EngineVersion, QueryMap, HeadersMap)
View Sourcelist_instance_type_details(Client, EngineVersion, QueryMap, HeadersMap, Options0)
View SourceLists all packages associated with an Amazon OpenSearch Service domain.
For more information, see Custom packages for Amazon OpenSearch Service: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html.list_packages_for_domain(Client, DomainName, QueryMap, HeadersMap)
View Sourcelist_packages_for_domain(Client, DomainName, QueryMap, HeadersMap, Options0)
View SourceRetrieves a list of configuration changes that are scheduled for a domain.
These changes can be service software updates: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html or blue/green Auto-Tune enhancements: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types.list_scheduled_actions(Client, DomainName, QueryMap, HeadersMap, Options0)
View SourceReturns all resource tags for an Amazon OpenSearch Service domain.
For more information, see Tagging Amazon OpenSearch Service domains: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-awsresourcetagging.html.list_vpc_endpoint_access(Client, DomainName, QueryMap, HeadersMap)
View Sourcelist_vpc_endpoint_access(Client, DomainName, QueryMap, HeadersMap, Options0)
View Sourcelist_vpc_endpoints_for_domain(Client, DomainName, QueryMap, HeadersMap)
View Sourcelist_vpc_endpoints_for_domain(Client, DomainName, QueryMap, HeadersMap, Options0)
View SourceRemoves the specified set of tags from an Amazon OpenSearch Service domain.
For more information, see Tagging Amazon OpenSearch Service domains: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging.Starts the node maintenance process on the data node.
These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.Schedules a service software update for an Amazon OpenSearch Service domain.
For more information, see Service software updates in Amazon OpenSearch Service: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html.Updates a direct-query data source.
For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/direct-query-s3-creating.html.Updates a package for use with Amazon OpenSearch Service domains.
For more information, see Custom packages for Amazon OpenSearch Service: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html.Reschedules a planned domain configuration change for a later time.
This change can be a scheduled service software update: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html or a blue/green Auto-Tune enhancement: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types.