Struct Client

pub struct Client { /* private fields */ }

Client for OpenSearch Service Serverless

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

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_opensearchserverless::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_opensearchserverless::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateAccessPolicy operation has a Client::create_access_policy, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_access_policy()
    .r#type("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn batch_get_collection(&self) -> BatchGetCollectionFluentBuilder

Constructs a fluent builder for the BatchGetCollection operation.

• The fluent builder is configurable:
  • ids(impl Into<String>) / set_ids(Option<Vec::<String>>):
    required: false
    

    A list of collection IDs. You can’t provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

    
    
  • names(impl Into<String>) / set_names(Option<Vec::<String>>):
    required: false
    

    A list of collection names. You can’t provide names and IDs in the same request.

    
    
• On success, responds with BatchGetCollectionOutput with field(s):
  • collection_details(Option<Vec::<CollectionDetail>>):

    Details about each collection.

  • collection_error_details(Option<Vec::<CollectionErrorDetail>>):

    Error information for the request.

• On failure, responds with SdkError<BatchGetCollectionError>

impl Client

pub fn batch_get_effective_lifecycle_policy( &self, ) -> BatchGetEffectiveLifecyclePolicyFluentBuilder

Constructs a fluent builder for the BatchGetEffectiveLifecyclePolicy operation.

• The fluent builder is configurable:
  • resource_identifiers(LifecyclePolicyResourceIdentifier) / set_resource_identifiers(Option<Vec::<LifecyclePolicyResourceIdentifier>>):
    required: true
    

    The unique identifiers of policy types and resource names.

    
    
• On success, responds with BatchGetEffectiveLifecyclePolicyOutput with field(s):
  • effective_lifecycle_policy_details(Option<Vec::<EffectiveLifecyclePolicyDetail>>):

    A list of lifecycle policies applied to the OpenSearch Serverless indexes.

  • effective_lifecycle_policy_error_details(Option<Vec::<EffectiveLifecyclePolicyErrorDetail>>):

    A list of resources for which retrieval failed.

• On failure, responds with SdkError<BatchGetEffectiveLifecyclePolicyError>

impl Client

pub fn batch_get_lifecycle_policy(&self) -> BatchGetLifecyclePolicyFluentBuilder

Constructs a fluent builder for the BatchGetLifecyclePolicy operation.

• The fluent builder is configurable:
  • identifiers(LifecyclePolicyIdentifier) / set_identifiers(Option<Vec::<LifecyclePolicyIdentifier>>):
    required: true
    

    The unique identifiers of policy types and policy names.

    
    
• On success, responds with BatchGetLifecyclePolicyOutput with field(s):
  • lifecycle_policy_details(Option<Vec::<LifecyclePolicyDetail>>):

    A list of lifecycle policies matched to the input policy name and policy type.

  • lifecycle_policy_error_details(Option<Vec::<LifecyclePolicyErrorDetail>>):

    A list of lifecycle policy names and policy types for which retrieval failed.

• On failure, responds with SdkError<BatchGetLifecyclePolicyError>

impl Client

pub fn batch_get_vpc_endpoint(&self) -> BatchGetVpcEndpointFluentBuilder

Constructs a fluent builder for the BatchGetVpcEndpoint operation.

• The fluent builder is configurable:
  • ids(impl Into<String>) / set_ids(Option<Vec::<String>>):
    required: true
    

    A list of VPC endpoint identifiers.

    
    
• On success, responds with BatchGetVpcEndpointOutput with field(s):
  • vpc_endpoint_details(Option<Vec::<VpcEndpointDetail>>):

    Details about the specified VPC endpoint.

  • vpc_endpoint_error_details(Option<Vec::<VpcEndpointErrorDetail>>):

    Error information for a failed request.

• On failure, responds with SdkError<BatchGetVpcEndpointError>

impl Client

pub fn create_access_policy(&self) -> CreateAccessPolicyFluentBuilder

Constructs a fluent builder for the CreateAccessPolicy operation.

• The fluent builder is configurable:
  • r#type(AccessPolicyType) / set_type(Option<AccessPolicyType>):
    required: true
    

    The type of policy.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the policy.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the policy. Typically used to store information about the permissions defined in the policy.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The JSON policy document to use as the content for the policy.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with CreateAccessPolicyOutput with field(s):
  • access_policy_detail(Option<AccessPolicyDetail>):

    Details about the created access policy.

• On failure, responds with SdkError<CreateAccessPolicyError>

impl Client

pub fn create_collection(&self) -> CreateCollectionFluentBuilder

Constructs a fluent builder for the CreateCollection operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Name of the collection.

    
    
  • r#type(CollectionType) / set_type(Option<CollectionType>):
    required: false
    

    The type of collection.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Description of the collection.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

    
    
  • standby_replicas(StandbyReplicas) / set_standby_replicas(Option<StandbyReplicas>):
    required: false
    

    Indicates whether standby replicas should be used for a collection.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with CreateCollectionOutput with field(s):
  • create_collection_detail(Option<CreateCollectionDetail>):

    Details about the collection.

• On failure, responds with SdkError<CreateCollectionError>

impl Client

pub fn create_lifecycle_policy(&self) -> CreateLifecyclePolicyFluentBuilder

Constructs a fluent builder for the CreateLifecyclePolicy operation.

• The fluent builder is configurable:
  • r#type(LifecyclePolicyType) / set_type(Option<LifecyclePolicyType>):
    required: true
    

    The type of lifecycle policy.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the lifecycle policy.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the lifecycle policy.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The JSON policy document to use as the content for the lifecycle policy.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with CreateLifecyclePolicyOutput with field(s):
  • lifecycle_policy_detail(Option<LifecyclePolicyDetail>):

    Details about the created lifecycle policy.

• On failure, responds with SdkError<CreateLifecyclePolicyError>

impl Client

pub fn create_security_config(&self) -> CreateSecurityConfigFluentBuilder

Constructs a fluent builder for the CreateSecurityConfig operation.

• The fluent builder is configurable:
  • r#type(SecurityConfigType) / set_type(Option<SecurityConfigType>):
    required: true
    

    The type of security configuration.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the security configuration.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the security configuration.

    
    
  • saml_options(SamlConfigOptions) / set_saml_options(Option<SamlConfigOptions>):
    required: false
    

    Describes SAML options in in the form of a key-value map. This field is required if you specify saml for the type parameter.

    
    
  • iam_identity_center_options(CreateIamIdentityCenterConfigOptions) / set_iam_identity_center_options(Option<CreateIamIdentityCenterConfigOptions>):
    required: false
    

    Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with CreateSecurityConfigOutput with field(s):
  • security_config_detail(Option<SecurityConfigDetail>):

    Details about the created security configuration.

• On failure, responds with SdkError<CreateSecurityConfigError>

impl Client

pub fn create_security_policy(&self) -> CreateSecurityPolicyFluentBuilder

Constructs a fluent builder for the CreateSecurityPolicy operation.

• The fluent builder is configurable:
  • r#type(SecurityPolicyType) / set_type(Option<SecurityPolicyType>):
    required: true
    

    The type of security policy.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the policy.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the policy. Typically used to store information about the permissions defined in the policy.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The JSON policy document to use as the content for the new policy.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with CreateSecurityPolicyOutput with field(s):
  • security_policy_detail(Option<SecurityPolicyDetail>):

    Details about the created security policy.

• On failure, responds with SdkError<CreateSecurityPolicyError>

impl Client

pub fn create_vpc_endpoint(&self) -> CreateVpcEndpointFluentBuilder

Constructs a fluent builder for the CreateVpcEndpoint operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the interface endpoint.

    
    
  • vpc_id(impl Into<String>) / set_vpc_id(Option<String>):
    required: true
    

    The ID of the VPC from which you’ll access OpenSearch Serverless.

    
    
  • subnet_ids(impl Into<String>) / set_subnet_ids(Option<Vec::<String>>):
    required: true
    

    The ID of one or more subnets from which you’ll access OpenSearch Serverless.

    
    
  • security_group_ids(impl Into<String>) / set_security_group_ids(Option<Vec::<String>>):
    required: false
    

    The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with CreateVpcEndpointOutput with field(s):
  • create_vpc_endpoint_detail(Option<CreateVpcEndpointDetail>):

    Details about the created interface VPC endpoint.

• On failure, responds with SdkError<CreateVpcEndpointError>

impl Client

pub fn delete_access_policy(&self) -> DeleteAccessPolicyFluentBuilder

Constructs a fluent builder for the DeleteAccessPolicy operation.

• The fluent builder is configurable:
  • r#type(AccessPolicyType) / set_type(Option<AccessPolicyType>):
    required: true
    

    The type of policy.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the policy to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with DeleteAccessPolicyOutput
• On failure, responds with SdkError<DeleteAccessPolicyError>

impl Client

pub fn delete_collection(&self) -> DeleteCollectionFluentBuilder

Constructs a fluent builder for the DeleteCollection operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The unique identifier of the collection. For example, 1iu5usc406kd. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with DeleteCollectionOutput with field(s):
  • delete_collection_detail(Option<DeleteCollectionDetail>):

    Details of the deleted collection.

• On failure, responds with SdkError<DeleteCollectionError>

impl Client

pub fn delete_lifecycle_policy(&self) -> DeleteLifecyclePolicyFluentBuilder

Constructs a fluent builder for the DeleteLifecyclePolicy operation.

• The fluent builder is configurable:
  • r#type(LifecyclePolicyType) / set_type(Option<LifecyclePolicyType>):
    required: true
    

    The type of lifecycle policy.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the policy to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with DeleteLifecyclePolicyOutput
• On failure, responds with SdkError<DeleteLifecyclePolicyError>

impl Client

pub fn delete_security_config(&self) -> DeleteSecurityConfigFluentBuilder

Constructs a fluent builder for the DeleteSecurityConfig operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with DeleteSecurityConfigOutput
• On failure, responds with SdkError<DeleteSecurityConfigError>

impl Client

pub fn delete_security_policy(&self) -> DeleteSecurityPolicyFluentBuilder

Constructs a fluent builder for the DeleteSecurityPolicy operation.

• The fluent builder is configurable:
  • r#type(SecurityPolicyType) / set_type(Option<SecurityPolicyType>):
    required: true
    

    The type of policy.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the policy to delete.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with DeleteSecurityPolicyOutput
• On failure, responds with SdkError<DeleteSecurityPolicyError>

impl Client

pub fn delete_vpc_endpoint(&self) -> DeleteVpcEndpointFluentBuilder

Constructs a fluent builder for the DeleteVpcEndpoint operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The VPC endpoint identifier.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with DeleteVpcEndpointOutput with field(s):
  • delete_vpc_endpoint_detail(Option<DeleteVpcEndpointDetail>):

    Details about the deleted endpoint.

• On failure, responds with SdkError<DeleteVpcEndpointError>

impl Client

pub fn get_access_policy(&self) -> GetAccessPolicyFluentBuilder

Constructs a fluent builder for the GetAccessPolicy operation.

• The fluent builder is configurable:
  • r#type(AccessPolicyType) / set_type(Option<AccessPolicyType>):
    required: true
    

    Tye type of policy. Currently, the only supported value is data.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the access policy.

    
    
• On success, responds with GetAccessPolicyOutput with field(s):
  • access_policy_detail(Option<AccessPolicyDetail>):

    Details about the requested access policy.

• On failure, responds with SdkError<GetAccessPolicyError>

impl Client

pub fn get_account_settings(&self) -> GetAccountSettingsFluentBuilder

Constructs a fluent builder for the GetAccountSettings operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetAccountSettingsOutput with field(s):
  • account_settings_detail(Option<AccountSettingsDetail>):

    OpenSearch Serverless-related details for the current account.

• On failure, responds with SdkError<GetAccountSettingsError>

impl Client

pub fn get_policies_stats(&self) -> GetPoliciesStatsFluentBuilder

Constructs a fluent builder for the GetPoliciesStats operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetPoliciesStatsOutput with field(s):
  • access_policy_stats(Option<AccessPolicyStats>):

    Information about the data access policies in your account.

  • security_policy_stats(Option<SecurityPolicyStats>):

    Information about the security policies in your account.

  • security_config_stats(Option<SecurityConfigStats>):

    Information about the security configurations in your account.

  • lifecycle_policy_stats(Option<LifecyclePolicyStats>):

    Information about the lifecycle policies in your account.

  • total_policy_count(Option<i64>):

    The total number of OpenSearch Serverless security policies and configurations in your account.

• On failure, responds with SdkError<GetPoliciesStatsError>

impl Client

pub fn get_security_config(&self) -> GetSecurityConfigFluentBuilder

Constructs a fluent builder for the GetSecurityConfig operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The unique identifier of the security configuration.

    
    
• On success, responds with GetSecurityConfigOutput with field(s):
  • security_config_detail(Option<SecurityConfigDetail>):

    Details of the requested security configuration.

• On failure, responds with SdkError<GetSecurityConfigError>

impl Client

pub fn get_security_policy(&self) -> GetSecurityPolicyFluentBuilder

Constructs a fluent builder for the GetSecurityPolicy operation.

• The fluent builder is configurable:
  • r#type(SecurityPolicyType) / set_type(Option<SecurityPolicyType>):
    required: true
    

    The type of security policy.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the security policy.

    
    
• On success, responds with GetSecurityPolicyOutput with field(s):
  • security_policy_detail(Option<SecurityPolicyDetail>):

    Details about the requested security policy.

• On failure, responds with SdkError<GetSecurityPolicyError>

impl Client

pub fn list_access_policies(&self) -> ListAccessPoliciesFluentBuilder

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

• The fluent builder is configurable:
  • r#type(AccessPolicyType) / set_type(Option<AccessPolicyType>):
    required: true
    

    The type of access policy.

    
    
  • resource(impl Into<String>) / set_resource(Option<Vec::<String>>):
    required: false
    

    Resource filters (can be collections or indexes) that policies can apply to.

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

    If your initial ListAccessPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListAccessPolicies operations, which returns results in the next page.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

    
    
• On success, responds with ListAccessPoliciesOutput with field(s):
  • access_policy_summaries(Option<Vec::<AccessPolicySummary>>):

    Details about the requested access policies.

  • next_token(Option<String>):

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

• On failure, responds with SdkError<ListAccessPoliciesError>

impl Client

pub fn list_collections(&self) -> ListCollectionsFluentBuilder

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

• The fluent builder is configurable:
  • collection_filters(CollectionFilters) / set_collection_filters(Option<CollectionFilters>):
    required: false
    

    A list of filter names and values that you can use for requests.

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

    If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

    
    
• On success, responds with ListCollectionsOutput with field(s):
  • collection_summaries(Option<Vec::<CollectionSummary>>):

    Details about each collection.

  • next_token(Option<String>):

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

• On failure, responds with SdkError<ListCollectionsError>

impl Client

pub fn list_lifecycle_policies(&self) -> ListLifecyclePoliciesFluentBuilder

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

• The fluent builder is configurable:
  • r#type(LifecyclePolicyType) / set_type(Option<LifecyclePolicyType>):
    required: true
    

    The type of lifecycle policy.

    
    
  • resources(impl Into<String>) / set_resources(Option<Vec::<String>>):
    required: false
    

    Resource filters that policies can apply to. Currently, the only supported resource type is index.

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

    If your initial ListLifecyclePolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListLifecyclePolicies operations, which returns results in the next page.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional parameter that specifies the maximum number of results to return. You can use use nextToken to get the next page of results. The default is 10.

    
    
• On success, responds with ListLifecyclePoliciesOutput with field(s):
  • lifecycle_policy_summaries(Option<Vec::<LifecyclePolicySummary>>):

    Details about the requested lifecycle policies.

  • next_token(Option<String>):

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

• On failure, responds with SdkError<ListLifecyclePoliciesError>

impl Client

pub fn list_security_configs(&self) -> ListSecurityConfigsFluentBuilder

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

• The fluent builder is configurable:
  • r#type(SecurityConfigType) / set_type(Option<SecurityConfigType>):
    required: true
    

    The type of security configuration.

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

    If your initial ListSecurityConfigs operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityConfigs operations, which returns results in the next page.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

    
    
• On success, responds with ListSecurityConfigsOutput with field(s):
  • security_config_summaries(Option<Vec::<SecurityConfigSummary>>):

    Details about the security configurations in your account.

  • next_token(Option<String>):

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

• On failure, responds with SdkError<ListSecurityConfigsError>

impl Client

pub fn list_security_policies(&self) -> ListSecurityPoliciesFluentBuilder

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

• The fluent builder is configurable:
  • r#type(SecurityPolicyType) / set_type(Option<SecurityPolicyType>):
    required: true
    

    The type of policy.

    
    
  • resource(impl Into<String>) / set_resource(Option<Vec::<String>>):
    required: false
    

    Resource filters (can be collection or indexes) that policies can apply to.

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

    If your initial ListSecurityPolicies operation returns a nextToken, you can include the returned nextToken in subsequent ListSecurityPolicies operations, which returns results in the next page.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

    
    
• On success, responds with ListSecurityPoliciesOutput with field(s):
  • security_policy_summaries(Option<Vec::<SecurityPolicySummary>>):

    Details about the security policies in your account.

  • next_token(Option<String>):

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

• On failure, responds with SdkError<ListSecurityPoliciesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

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

    The tags associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_vpc_endpoints(&self) -> ListVpcEndpointsFluentBuilder

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

• The fluent builder is configurable:
  • vpc_endpoint_filters(VpcEndpointFilters) / set_vpc_endpoint_filters(Option<VpcEndpointFilters>):
    required: false
    

    Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.

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

    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.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.

    
    
• On success, responds with ListVpcEndpointsOutput with field(s):
  • vpc_endpoint_summaries(Option<Vec::<VpcEndpointSummary>>):

    Details about each VPC endpoint, including the name and current status.

  • next_token(Option<String>):

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

• On failure, responds with SdkError<ListVpcEndpointsError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag or set of tags to remove from the resource. All tag keys in the request must be unique.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_access_policy(&self) -> UpdateAccessPolicyFluentBuilder

Constructs a fluent builder for the UpdateAccessPolicy operation.

• The fluent builder is configurable:
  • r#type(AccessPolicyType) / set_type(Option<AccessPolicyType>):
    required: true
    

    The type of policy.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the policy.

    
    
  • policy_version(impl Into<String>) / set_policy_version(Option<String>):
    required: true
    

    The version of the policy being updated.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the policy. Typically used to store information about the permissions defined in the policy.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: false
    

    The JSON policy document to use as the content for the policy.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with UpdateAccessPolicyOutput with field(s):
  • access_policy_detail(Option<AccessPolicyDetail>):

    Details about the updated access policy.

• On failure, responds with SdkError<UpdateAccessPolicyError>

impl Client

pub fn update_account_settings(&self) -> UpdateAccountSettingsFluentBuilder

Constructs a fluent builder for the UpdateAccountSettings operation.

• The fluent builder is configurable:
  • capacity_limits(CapacityLimits) / set_capacity_limits(Option<CapacityLimits>):
    required: false
    

    The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

    
    
• On success, responds with UpdateAccountSettingsOutput with field(s):
  • account_settings_detail(Option<AccountSettingsDetail>):

    OpenSearch Serverless-related settings for the current Amazon Web Services account.

• On failure, responds with SdkError<UpdateAccountSettingsError>

impl Client

pub fn update_collection(&self) -> UpdateCollectionFluentBuilder

Constructs a fluent builder for the UpdateCollection operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The unique identifier of the collection.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the collection.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with UpdateCollectionOutput with field(s):
  • update_collection_detail(Option<UpdateCollectionDetail>):

    Details about the updated collection.

• On failure, responds with SdkError<UpdateCollectionError>

impl Client

pub fn update_lifecycle_policy(&self) -> UpdateLifecyclePolicyFluentBuilder

Constructs a fluent builder for the UpdateLifecyclePolicy operation.

• The fluent builder is configurable:
  • r#type(LifecyclePolicyType) / set_type(Option<LifecyclePolicyType>):
    required: true
    

    The type of lifecycle policy.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the policy.

    
    
  • policy_version(impl Into<String>) / set_policy_version(Option<String>):
    required: true
    

    The version of the policy being updated.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the lifecycle policy.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: false
    

    The JSON policy document to use as the content for the lifecycle policy.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with UpdateLifecyclePolicyOutput with field(s):
  • lifecycle_policy_detail(Option<LifecyclePolicyDetail>):

    Details about the updated lifecycle policy.

• On failure, responds with SdkError<UpdateLifecyclePolicyError>

impl Client

pub fn update_security_config(&self) -> UpdateSecurityConfigFluentBuilder

Constructs a fluent builder for the UpdateSecurityConfig operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

    
    
  • config_version(impl Into<String>) / set_config_version(Option<String>):
    required: true
    

    The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the security configuration.

    
    
  • saml_options(SamlConfigOptions) / set_saml_options(Option<SamlConfigOptions>):
    required: false
    

    SAML options in in the form of a key-value map.

    
    
  • iam_identity_center_options_updates(UpdateIamIdentityCenterConfigOptions) / set_iam_identity_center_options_updates(Option<UpdateIamIdentityCenterConfigOptions>):
    required: false
    

    Describes IAM Identity Center options in the form of a key-value map.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with UpdateSecurityConfigOutput with field(s):
  • security_config_detail(Option<SecurityConfigDetail>):

    Details about the updated security configuration.

• On failure, responds with SdkError<UpdateSecurityConfigError>

impl Client

pub fn update_security_policy(&self) -> UpdateSecurityPolicyFluentBuilder

Constructs a fluent builder for the UpdateSecurityPolicy operation.

• The fluent builder is configurable:
  • r#type(SecurityPolicyType) / set_type(Option<SecurityPolicyType>):
    required: true
    

    The type of access policy.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the policy.

    
    
  • policy_version(impl Into<String>) / set_policy_version(Option<String>):
    required: true
    

    The version of the policy being updated.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the policy. Typically used to store information about the permissions defined in the policy.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: false
    

    The JSON policy document to use as the content for the new policy.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with UpdateSecurityPolicyOutput with field(s):
  • security_policy_detail(Option<SecurityPolicyDetail>):

    Details about the updated security policy.

• On failure, responds with SdkError<UpdateSecurityPolicyError>

impl Client

pub fn update_vpc_endpoint(&self) -> UpdateVpcEndpointFluentBuilder

Constructs a fluent builder for the UpdateVpcEndpoint operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The unique identifier of the interface endpoint to update.

    
    
  • add_subnet_ids(impl Into<String>) / set_add_subnet_ids(Option<Vec::<String>>):
    required: false
    

    The ID of one or more subnets to add to the endpoint.

    
    
  • remove_subnet_ids(impl Into<String>) / set_remove_subnet_ids(Option<Vec::<String>>):
    required: false
    

    The unique identifiers of the subnets to remove from the endpoint.

    
    
  • add_security_group_ids(impl Into<String>) / set_add_security_group_ids(Option<Vec::<String>>):
    required: false
    

    The unique identifiers of the security groups to add to the endpoint. Security groups define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

    
    
  • remove_security_group_ids(impl Into<String>) / set_remove_security_group_ids(Option<Vec::<String>>):
    required: false
    

    The unique identifiers of the security groups to remove from the endpoint.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure idempotency of the request.

    
    
• On success, responds with UpdateVpcEndpointOutput with field(s):
  • update_vpc_endpoint_detail(Option<UpdateVpcEndpointDetail>):

    Details about the updated VPC endpoint.

• On failure, responds with SdkError<UpdateVpcEndpointError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

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.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

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.