Struct aws_sdk_opensearch::Client

pub struct Client { /* private fields */ }

Client for Amazon OpenSearch Service

Client for invoking operations on Amazon OpenSearch Service. Each operation on Amazon OpenSearch Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_opensearch::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_opensearch::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_opensearch::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

Examples found in repository

src/client.rs (line 70)

    fn from(
        client: aws_smithy_client::Client<
            aws_smithy_client::erase::DynConnector,
            aws_smithy_client::erase::DynMiddleware<aws_smithy_client::erase::DynConnector>,
        >,
    ) -> Self {
        Self::with_config(client, crate::Config::builder().build())
    }

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn accept_inbound_connection(&self) -> AcceptInboundConnection

Constructs a fluent builder for the AcceptInboundConnection operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):

    The ID of the inbound connection you want to accept.

• On success, responds with AcceptInboundConnectionOutput with field(s):
  • connection(Option<InboundConnection>):

    The InboundConnection of the accepted inbound connection.

• On failure, responds with SdkError<AcceptInboundConnectionError>

pub fn add_tags(&self) -> AddTags

Constructs a fluent builder for the AddTags operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    Specify the ARN of the domain you want to add tags to.

  • tag_list(Vec<Tag>) / set_tag_list(Option<Vec<Tag>>):

    List of Tag to add to the domain.

• On success, responds with AddTagsOutput
• On failure, responds with SdkError<AddTagsError>

pub fn associate_package(&self) -> AssociatePackage

Constructs a fluent builder for the AssociatePackage operation.

• The fluent builder is configurable:
  • package_id(impl Into<String>) / set_package_id(Option<String>):

    Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of the domain to associate the package with.

• On success, responds with AssociatePackageOutput with field(s):
  • domain_package_details(Option<DomainPackageDetails>):

    DomainPackageDetails

• On failure, responds with SdkError<AssociatePackageError>

pub fn cancel_service_software_update(&self) -> CancelServiceSoftwareUpdate

Constructs a fluent builder for the CancelServiceSoftwareUpdate operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of the domain that you want to stop the latest service software update on.

• On success, responds with CancelServiceSoftwareUpdateOutput with field(s):
  • service_software_options(Option<ServiceSoftwareOptions>):

    The current status of the OpenSearch service software update.

• On failure, responds with SdkError<CancelServiceSoftwareUpdateError>

pub fn create_domain(&self) -> CreateDomain

Constructs a fluent builder for the CreateDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of the Amazon OpenSearch Service domain you’re creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • engine_version(impl Into<String>) / set_engine_version(Option<String>):

    String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, “OpenSearch_1.0” or “Elasticsearch_7.9”. For more information, see Creating and managing Amazon OpenSearch Service domains .

  • cluster_config(ClusterConfig) / set_cluster_config(Option<ClusterConfig>):

    Configuration options for a domain. Specifies the instance type and number of instances in the domain.

  • ebs_options(EbsOptions) / set_ebs_options(Option<EbsOptions>):

    Options to enable, disable, and specify the type and size of EBS storage volumes.

  • access_policies(impl Into<String>) / set_access_policies(Option<String>):

    IAM access policy as a JSON-formatted string.

  • snapshot_options(SnapshotOptions) / set_snapshot_options(Option<SnapshotOptions>):

    Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

  • vpc_options(VpcOptions) / set_vpc_options(Option<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 .

  • cognito_options(CognitoOptions) / set_cognito_options(Option<CognitoOptions>):

    Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

  • encryption_at_rest_options(EncryptionAtRestOptions) / set_encryption_at_rest_options(Option<EncryptionAtRestOptions>):

    Options for encryption of data at rest.

  • node_to_node_encryption_options(NodeToNodeEncryptionOptions) / set_node_to_node_encryption_options(Option<NodeToNodeEncryptionOptions>):

    Node-to-node encryption options.

  • advanced_options(HashMap<String, String>) / set_advanced_options(Option<HashMap<String, String>>):

    Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.

  • log_publishing_options(HashMap<LogType, LogPublishingOption>) / set_log_publishing_options(Option<HashMap<LogType, LogPublishingOption>>):

    Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

  • domain_endpoint_options(DomainEndpointOptions) / set_domain_endpoint_options(Option<DomainEndpointOptions>):

    Options to specify configurations that will be applied to the domain endpoint.

  • advanced_security_options(AdvancedSecurityOptionsInput) / set_advanced_security_options(Option<AdvancedSecurityOptionsInput>):

    Specifies advanced security options.

  • tag_list(Vec<Tag>) / set_tag_list(Option<Vec<Tag>>):

    A list of Tag added during domain creation.

  • auto_tune_options(AutoTuneOptionsInput) / set_auto_tune_options(Option<AutoTuneOptionsInput>):

    Specifies Auto-Tune options.

• On success, responds with CreateDomainOutput with field(s):
  • domain_status(Option<DomainStatus>):

    The status of the newly created domain.

• On failure, responds with SdkError<CreateDomainError>

pub fn create_outbound_connection(&self) -> CreateOutboundConnection

Constructs a fluent builder for the CreateOutboundConnection operation.

• The fluent builder is configurable:
  • local_domain_info(DomainInformationContainer) / set_local_domain_info(Option<DomainInformationContainer>):

    The AWSDomainInformation for the local OpenSearch domain.

  • remote_domain_info(DomainInformationContainer) / set_remote_domain_info(Option<DomainInformationContainer>):

    The AWSDomainInformation for the remote OpenSearch domain.

  • connection_alias(impl Into<String>) / set_connection_alias(Option<String>):

    The connection alias used used by the customer for this cross-cluster connection.

• On success, responds with CreateOutboundConnectionOutput with field(s):
  • local_domain_info(Option<DomainInformationContainer>):

    The AWSDomainInformation for the local OpenSearch domain.

  • remote_domain_info(Option<DomainInformationContainer>):

    The AWSDomainInformation for the remote OpenSearch domain.

  • connection_alias(Option<String>):

    The connection alias provided during the create connection request.

  • connection_status(Option<OutboundConnectionStatus>):

    The OutboundConnectionStatus for the newly created connection.

  • connection_id(Option<String>):

    The unique ID for the created outbound connection, which is used for subsequent operations on the connection.

• On failure, responds with SdkError<CreateOutboundConnectionError>

pub fn create_package(&self) -> CreatePackage

Constructs a fluent builder for the CreatePackage operation.

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):

    Unique identifier for the package.

  • package_type(PackageType) / set_package_type(Option<PackageType>):

    Type of package. Currently supports only TXT-DICTIONARY.

  • package_description(impl Into<String>) / set_package_description(Option<String>):

    Description of the package.

  • package_source(PackageSource) / set_package_source(Option<PackageSource>):

    The Amazon S3 location from which to import the package.

• On success, responds with CreatePackageOutput with field(s):
  • package_details(Option<PackageDetails>):

    Information about the package.

• On failure, responds with SdkError<CreatePackageError>

pub fn delete_domain(&self) -> DeleteDomain

Constructs a fluent builder for the DeleteDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of the domain you want to permanently delete.

• On success, responds with DeleteDomainOutput with field(s):
  • domain_status(Option<DomainStatus>):

    The status of the domain being deleted.

• On failure, responds with SdkError<DeleteDomainError>

pub fn delete_inbound_connection(&self) -> DeleteInboundConnection

Constructs a fluent builder for the DeleteInboundConnection operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):

    The ID of the inbound connection to permanently delete.

• On success, responds with DeleteInboundConnectionOutput with field(s):
  • connection(Option<InboundConnection>):

    The InboundConnection of the deleted inbound connection.

• On failure, responds with SdkError<DeleteInboundConnectionError>

pub fn delete_outbound_connection(&self) -> DeleteOutboundConnection

Constructs a fluent builder for the DeleteOutboundConnection operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):

    The ID of the outbound connection you want to permanently delete.

• On success, responds with DeleteOutboundConnectionOutput with field(s):
  • connection(Option<OutboundConnection>):

    The OutboundConnection of the deleted outbound connection.

• On failure, responds with SdkError<DeleteOutboundConnectionError>

pub fn delete_package(&self) -> DeletePackage

Constructs a fluent builder for the DeletePackage operation.

• The fluent builder is configurable:
  • package_id(impl Into<String>) / set_package_id(Option<String>):

    The internal ID of the package you want to delete. Use DescribePackages to find this value.

• On success, responds with DeletePackageOutput with field(s):
  • package_details(Option<PackageDetails>):

    PackageDetails

• On failure, responds with SdkError<DeletePackageError>

pub fn describe_domain(&self) -> DescribeDomain

Constructs a fluent builder for the DescribeDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of the domain for which you want information.

• On success, responds with DescribeDomainOutput with field(s):
  • domain_status(Option<DomainStatus>):

    The current status of the domain.

• On failure, responds with SdkError<DescribeDomainError>

pub fn describe_domain_auto_tunes(&self) -> DescribeDomainAutoTunes

Constructs a fluent builder for the DescribeDomainAutoTunes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The domain name for which you want Auto-Tune action details.

  • max_results(i32) / set_max_results(i32):

    Set this value to limit the number of results returned. If not specified, defaults to 100.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    NextToken is sent in case the earlier API call results contain the NextToken. Used for pagination.

• On success, responds with DescribeDomainAutoTunesOutput with field(s):
  • auto_tunes(Option<Vec<AutoTune>>):

    The list of setting adjustments that Auto-Tune has made to the domain. See Auto-Tune for Amazon OpenSearch Service for more information.

  • next_token(Option<String>):

    An identifier to allow retrieval of paginated results.

• On failure, responds with SdkError<DescribeDomainAutoTunesError>

pub fn describe_domain_change_progress(&self) -> DescribeDomainChangeProgress

Constructs a fluent builder for the DescribeDomainChangeProgress operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The domain you want to get the progress information about.

  • change_id(impl Into<String>) / set_change_id(Option<String>):

    The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.

• On success, responds with DescribeDomainChangeProgressOutput with field(s):
  • change_progress_status(Option<ChangeProgressStatusDetails>):

    Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.

• On failure, responds with SdkError<DescribeDomainChangeProgressError>

pub fn describe_domain_config(&self) -> DescribeDomainConfig

Constructs a fluent builder for the DescribeDomainConfig operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The domain you want to get information about.

• On success, responds with DescribeDomainConfigOutput with field(s):
  • domain_config(Option<DomainConfig>):

    The configuration information of the domain requested in the DescribeDomainConfig request.

• On failure, responds with SdkError<DescribeDomainConfigError>

pub fn describe_domains(&self) -> DescribeDomains

Constructs a fluent builder for the DescribeDomains operation.

• The fluent builder is configurable:
  • domain_names(Vec<String>) / set_domain_names(Option<Vec<String>>):

    The domains for which you want information.

• On success, responds with DescribeDomainsOutput with field(s):
  • domain_status_list(Option<Vec<DomainStatus>>):

    The status of the domains requested in the DescribeDomains request.

• On failure, responds with SdkError<DescribeDomainsError>

pub fn describe_inbound_connections(&self) -> DescribeInboundConnections

Constructs a fluent builder for the DescribeInboundConnections operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    A list of filters used to match properties for inbound cross-cluster connections. Available Filter values are:

    • connection-id
    • local-domain-info.domain-name
    • local-domain-info.owner-id
    • local-domain-info.region
    • remote-domain-info.domain-name

  • max_results(i32) / set_max_results(i32):

    Set this value to limit the number of results returned. If not specified, defaults to 100.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    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.

• On success, responds with DescribeInboundConnectionsOutput with field(s):
  • connections(Option<Vec<InboundConnection>>):

    A list of InboundConnection matching the specified filter criteria.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<DescribeInboundConnectionsError>

pub fn describe_instance_type_limits(&self) -> DescribeInstanceTypeLimits

Constructs a fluent builder for the DescribeInstanceTypeLimits operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of the domain you want to modify. Only include this value if you’re querying OpenSearch Limits for an existing domain.

  • instance_type(OpenSearchPartitionInstanceType) / set_instance_type(Option<OpenSearchPartitionInstanceType>):

    The instance type for an OpenSearch cluster for which OpenSearch Limits are needed.

  • engine_version(impl Into<String>) / set_engine_version(Option<String>):

    Version of OpenSearch for which Limits are needed.

• On success, responds with DescribeInstanceTypeLimitsOutput with field(s):
  • limits_by_role(Option<HashMap<String, Limits>>):

    The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:

    • data: If the given InstanceType is used as a data node
    • master: If the given InstanceType is used as a master node
    • ultra_warm: If the given InstanceType is used as a warm node

• On failure, responds with SdkError<DescribeInstanceTypeLimitsError>

pub fn describe_outbound_connections(&self) -> DescribeOutboundConnections

Constructs a fluent builder for the DescribeOutboundConnections operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(Vec<Filter>) / set_filters(Option<Vec<Filter>>):

    A list of filters used to match properties for outbound cross-cluster connections. Available Filter names for this operation are:

    • connection-id
    • remote-domain-info.domain-name
    • remote-domain-info.owner-id
    • remote-domain-info.region
    • local-domain-info.domain-name

  • max_results(i32) / set_max_results(i32):

    Set this value to limit the number of results returned. If not specified, defaults to 100.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    NextToken is sent in case the earlier API call results contain the NextToken parameter. Used for pagination.

• On success, responds with DescribeOutboundConnectionsOutput with field(s):
  • connections(Option<Vec<OutboundConnection>>):

    A list of OutboundConnection matching the specified filter criteria.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<DescribeOutboundConnectionsError>

pub fn describe_packages(&self) -> DescribePackages

Constructs a fluent builder for the DescribePackages operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • filters(Vec<DescribePackagesFilter>) / set_filters(Option<Vec<DescribePackagesFilter>>):

    Only returns packages that match the DescribePackagesFilterList values.

  • max_results(i32) / set_max_results(i32):

    Limits results to a maximum number of packages.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

• On success, responds with DescribePackagesOutput with field(s):
  • package_details_list(Option<Vec<PackageDetails>>):

    List of PackageDetails objects.

  • next_token(Option<String>): (undocumented)
• On failure, responds with SdkError<DescribePackagesError>

pub fn describe_reserved_instance_offerings(
    &self
) -> DescribeReservedInstanceOfferings

Constructs a fluent builder for the DescribeReservedInstanceOfferings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • reserved_instance_offering_id(impl Into<String>) / set_reserved_instance_offering_id(Option<String>):

    The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

  • max_results(i32) / set_max_results(i32):

    Set this value to limit the number of results returned. If not specified, defaults to 100.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

• On success, responds with DescribeReservedInstanceOfferingsOutput with field(s):
  • next_token(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • reserved_instance_offerings(Option<Vec<ReservedInstanceOffering>>):

    List of reserved OpenSearch instance offerings

• On failure, responds with SdkError<DescribeReservedInstanceOfferingsError>

pub fn describe_reserved_instances(&self) -> DescribeReservedInstances

Constructs a fluent builder for the DescribeReservedInstances operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • reserved_instance_id(impl Into<String>) / set_reserved_instance_id(Option<String>):

    The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

  • max_results(i32) / set_max_results(i32):

    Set this value to limit the number of results returned. If not specified, defaults to 100.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

• On success, responds with DescribeReservedInstancesOutput with field(s):
  • next_token(Option<String>):

    Provides an identifier to allow retrieval of paginated results.

  • reserved_instances(Option<Vec<ReservedInstance>>):

    List of reserved OpenSearch instances.

• On failure, responds with SdkError<DescribeReservedInstancesError>

pub fn dissociate_package(&self) -> DissociatePackage

Constructs a fluent builder for the DissociatePackage operation.

• The fluent builder is configurable:
  • package_id(impl Into<String>) / set_package_id(Option<String>):

    The internal ID of the package to associate with a domain. Use DescribePackages to find this value.

  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of the domain to associate the package with.

• On success, responds with DissociatePackageOutput with field(s):
  • domain_package_details(Option<DomainPackageDetails>):

    DomainPackageDetails

• On failure, responds with SdkError<DissociatePackageError>

pub fn get_compatible_versions(&self) -> GetCompatibleVersions

Constructs a fluent builder for the GetCompatibleVersions operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

• On success, responds with GetCompatibleVersionsOutput with field(s):
  • compatible_versions(Option<Vec<CompatibleVersionsMap>>):

    A map of compatible OpenSearch versions returned as part of the GetCompatibleVersions operation.

• On failure, responds with SdkError<GetCompatibleVersionsError>

pub fn get_package_version_history(&self) -> GetPackageVersionHistory

Constructs a fluent builder for the GetPackageVersionHistory operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • package_id(impl Into<String>) / set_package_id(Option<String>):

    Returns an audit history of package versions.

  • max_results(i32) / set_max_results(i32):

    Limits results to a maximum number of package versions.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

• On success, responds with GetPackageVersionHistoryOutput with field(s):
  • package_id(Option<String>): (undocumented)
  • package_version_history_list(Option<Vec<PackageVersionHistory>>):

    List of PackageVersionHistory objects.

  • next_token(Option<String>): (undocumented)
• On failure, responds with SdkError<GetPackageVersionHistoryError>

pub fn get_upgrade_history(&self) -> GetUpgradeHistory

Constructs a fluent builder for the GetUpgradeHistory operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • max_results(i32) / set_max_results(i32):

    Set this value to limit the number of results returned.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

• On success, responds with GetUpgradeHistoryOutput with field(s):
  • upgrade_histories(Option<Vec<UpgradeHistory>>):

    A list of UpgradeHistory objects corresponding to each upgrade or upgrade eligibility check performed on a domain returned as part of the GetUpgradeHistoryResponse object.

  • next_token(Option<String>):

    Pagination token that needs to be supplied to the next call to get the next page of results.

• On failure, responds with SdkError<GetUpgradeHistoryError>

pub fn get_upgrade_status(&self) -> GetUpgradeStatus

Constructs a fluent builder for the GetUpgradeStatus operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

• On success, responds with GetUpgradeStatusOutput with field(s):
  • upgrade_step(Option<UpgradeStep>):

    One of three steps an upgrade or upgrade eligibility check goes through:

    • PreUpgradeCheck
    • Snapshot
    • Upgrade

  • step_status(Option<UpgradeStatus>):

    One of four statuses an upgrade have, returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

    • In Progress
    • Succeeded
    • Succeeded with Issues
    • Failed

  • upgrade_name(Option<String>):

    A string that briefly describes the update.

• On failure, responds with SdkError<GetUpgradeStatusError>

pub fn list_domain_names(&self) -> ListDomainNames

Constructs a fluent builder for the ListDomainNames operation.

• The fluent builder is configurable:
  • engine_type(EngineType) / set_engine_type(Option<EngineType>):

    Optional parameter to filter the output by domain engine type. Acceptable values are ‘Elasticsearch’ and ‘OpenSearch’.

• On success, responds with ListDomainNamesOutput with field(s):
  • domain_names(Option<Vec<DomainInfo>>):

    List of domain names and respective engine types.

• On failure, responds with SdkError<ListDomainNamesError>

pub fn list_domains_for_package(&self) -> ListDomainsForPackage

Constructs a fluent builder for the ListDomainsForPackage operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • package_id(impl Into<String>) / set_package_id(Option<String>):

    The package for which to list associated domains.

  • max_results(i32) / set_max_results(i32):

    Limits the results to a maximum number of domains.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

• On success, responds with ListDomainsForPackageOutput with field(s):
  • domain_package_details_list(Option<Vec<DomainPackageDetails>>):

    List of DomainPackageDetails objects.

  • next_token(Option<String>): (undocumented)
• On failure, responds with SdkError<ListDomainsForPackageError>

pub fn list_instance_type_details(&self) -> ListInstanceTypeDetails

Constructs a fluent builder for the ListInstanceTypeDetails operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • engine_version(impl Into<String>) / set_engine_version(Option<String>): (undocumented)
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • max_results(i32) / set_max_results(i32):

    Set this value to limit the number of results returned.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

• On success, responds with ListInstanceTypeDetailsOutput with field(s):
  • instance_type_details(Option<Vec<InstanceTypeDetails>>): (undocumented)
  • next_token(Option<String>):

    Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

• On failure, responds with SdkError<ListInstanceTypeDetailsError>

pub fn list_packages_for_domain(&self) -> ListPackagesForDomain

Constructs a fluent builder for the ListPackagesForDomain operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

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

  • max_results(i32) / set_max_results(i32):

    Limits results to a maximum number of packages.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

• On success, responds with ListPackagesForDomainOutput with field(s):
  • domain_package_details_list(Option<Vec<DomainPackageDetails>>):

    List of DomainPackageDetails objects.

  • next_token(Option<String>):

    Pagination token to supply to the next call to get the next page of results.

• On failure, responds with SdkError<ListPackagesForDomainError>

pub fn list_tags(&self) -> ListTags

Constructs a fluent builder for the ListTags operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    Specify the ARN of the domain that the tags you want to view are attached to.

• On success, responds with ListTagsOutput with field(s):
  • tag_list(Option<Vec<Tag>>):

    List of Tag for the requested domain.

• On failure, responds with SdkError<ListTagsError>

pub fn list_versions(&self) -> ListVersions

Constructs a fluent builder for the ListVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(i32):

    Set this value to limit the number of results returned. Value must be greater than 10 or it won’t be honored.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

• On success, responds with ListVersionsOutput with field(s):
  • versions(Option<Vec<String>>):

    List of supported OpenSearch versions.

  • next_token(Option<String>):

    Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

• On failure, responds with SdkError<ListVersionsError>

pub fn purchase_reserved_instance_offering(
    &self
) -> PurchaseReservedInstanceOffering

Constructs a fluent builder for the PurchaseReservedInstanceOffering operation.

• The fluent builder is configurable:
  • reserved_instance_offering_id(impl Into<String>) / set_reserved_instance_offering_id(Option<String>):

    The ID of the reserved OpenSearch instance offering to purchase.

  • reservation_name(impl Into<String>) / set_reservation_name(Option<String>):

    A customer-specified identifier to track this reservation.

  • instance_count(i32) / set_instance_count(i32):

    The number of OpenSearch instances to reserve.

• On success, responds with PurchaseReservedInstanceOfferingOutput with field(s):
  • reserved_instance_id(Option<String>):

    Details of the reserved OpenSearch instance which was purchased.

  • reservation_name(Option<String>):

    The customer-specified identifier used to track this reservation.

• On failure, responds with SdkError<PurchaseReservedInstanceOfferingError>

pub fn reject_inbound_connection(&self) -> RejectInboundConnection

Constructs a fluent builder for the RejectInboundConnection operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):

    The ID of the inbound connection to reject.

• On success, responds with RejectInboundConnectionOutput with field(s):
  • connection(Option<InboundConnection>):

    The InboundConnection of the rejected inbound connection.

• On failure, responds with SdkError<RejectInboundConnectionError>

pub fn remove_tags(&self) -> RemoveTags

Constructs a fluent builder for the RemoveTags operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):

    The ARN of the domain from which you want to delete the specified tags.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    The TagKey list you want to remove from the domain.

• On success, responds with RemoveTagsOutput
• On failure, responds with SdkError<RemoveTagsError>

pub fn start_service_software_update(&self) -> StartServiceSoftwareUpdate

Constructs a fluent builder for the StartServiceSoftwareUpdate operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

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

• On success, responds with StartServiceSoftwareUpdateOutput with field(s):
  • service_software_options(Option<ServiceSoftwareOptions>):

    The current status of the OpenSearch service software update.

• On failure, responds with SdkError<StartServiceSoftwareUpdateError>

pub fn update_domain_config(&self) -> UpdateDomainConfig

Constructs a fluent builder for the UpdateDomainConfig operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of the domain you’re updating.

  • cluster_config(ClusterConfig) / set_cluster_config(Option<ClusterConfig>):

    The type and number of instances to instantiate for the domain cluster.

  • ebs_options(EbsOptions) / set_ebs_options(Option<EbsOptions>):

    Specify the type and size of the EBS volume to use.

  • snapshot_options(SnapshotOptions) / set_snapshot_options(Option<SnapshotOptions>):

    Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

  • vpc_options(VpcOptions) / set_vpc_options(Option<VpcOptions>):

    Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

  • cognito_options(CognitoOptions) / set_cognito_options(Option<CognitoOptions>):

    Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

  • advanced_options(HashMap<String, String>) / set_advanced_options(Option<HashMap<String, String>>):

    Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced options for more information.

  • access_policies(impl Into<String>) / set_access_policies(Option<String>):

    IAM access policy as a JSON-formatted string.

  • log_publishing_options(HashMap<LogType, LogPublishingOption>) / set_log_publishing_options(Option<HashMap<LogType, LogPublishingOption>>):

    Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

  • encryption_at_rest_options(EncryptionAtRestOptions) / set_encryption_at_rest_options(Option<EncryptionAtRestOptions>):

    Specifies encryption of data at rest options.

  • domain_endpoint_options(DomainEndpointOptions) / set_domain_endpoint_options(Option<DomainEndpointOptions>):

    Options to specify configuration that will be applied to the domain endpoint.

  • node_to_node_encryption_options(NodeToNodeEncryptionOptions) / set_node_to_node_encryption_options(Option<NodeToNodeEncryptionOptions>):

    Specifies node-to-node encryption options.

  • advanced_security_options(AdvancedSecurityOptionsInput) / set_advanced_security_options(Option<AdvancedSecurityOptionsInput>):

    Specifies advanced security options.

  • auto_tune_options(AutoTuneOptions) / set_auto_tune_options(Option<AutoTuneOptions>):

    Specifies Auto-Tune options.

  • dry_run(bool) / set_dry_run(Option<bool>):

    This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.

• On success, responds with UpdateDomainConfigOutput with field(s):
  • domain_config(Option<DomainConfig>):

    The status of the updated domain.

  • dry_run_results(Option<DryRunResults>):

    Contains result of DryRun.

• On failure, responds with SdkError<UpdateDomainConfigError>

pub fn update_package(&self) -> UpdatePackage

Constructs a fluent builder for the UpdatePackage operation.

• The fluent builder is configurable:
  • package_id(impl Into<String>) / set_package_id(Option<String>):

    The unique identifier for the package.

  • package_source(PackageSource) / set_package_source(Option<PackageSource>):

    The Amazon S3 location for importing the package specified as S3BucketName and S3Key

  • package_description(impl Into<String>) / set_package_description(Option<String>):

    A new description of the package.

  • commit_message(impl Into<String>) / set_commit_message(Option<String>):

    A commit message for the new version which is shown as part of GetPackageVersionHistoryResponse.

• On success, responds with UpdatePackageOutput with field(s):
  • package_details(Option<PackageDetails>):

    Information about the package.

• On failure, responds with SdkError<UpdatePackageError>

pub fn upgrade_domain(&self) -> UpgradeDomain

Constructs a fluent builder for the UpgradeDomain operation.

• The fluent builder is configurable:
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):

    The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • target_version(impl Into<String>) / set_target_version(Option<String>):

    The version of OpenSearch you intend to upgrade the domain to.

  • perform_check_only(bool) / set_perform_check_only(Option<bool>):

    When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

  • advanced_options(HashMap<String, String>) / set_advanced_options(Option<HashMap<String, String>>):

    Exposes select native OpenSearch configuration values from opensearch.yml. Currently, the following advanced options are available:

    • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
    • Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

    For more information, see Advanced cluster parameters.

• On success, responds with UpgradeDomainOutput with field(s):
  • upgrade_id(Option<String>): (undocumented)
  • domain_name(Option<String>):

    The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • target_version(Option<String>):

    The version of OpenSearch that you intend to upgrade the domain to.

  • perform_check_only(Option<bool>):

    When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

  • advanced_options(Option<HashMap<String, String>>):

    Exposes select native OpenSearch configuration values from opensearch.yml. Currently, the following advanced options are available:

    • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
    • Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

    For more information, see Advanced cluster parameters.

  • change_progress_details(Option<ChangeProgressDetails>):

    Specifies change details of the domain configuration change.

• On failure, responds with SdkError<UpgradeDomainError>

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Examples found in repository

src/client.rs (line 4685)

    pub fn new(sdk_config: &aws_types::sdk_config::SdkConfig) -> Self {
        Self::from_conf(sdk_config.into())
    }

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.