Struct aws_sdk_opensearchserverless::Client
source · pub struct Client { /* private fields */ }
Expand description
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.
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_opensearchserverless::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_opensearchserverless::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_opensearchserverless::Client::from_conf(config);
Implementations§
source§impl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
source§impl Client
impl Client
sourcepub fn batch_get_collection(&self) -> BatchGetCollection
pub fn batch_get_collection(&self) -> BatchGetCollection
Constructs a fluent builder for the BatchGetCollection
operation.
- The fluent builder is configurable:
ids(Vec<String>)
/set_ids(Option<Vec<String>>)
: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(Vec<String>)
/set_names(Option<Vec<String>>)
: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>
sourcepub fn batch_get_vpc_endpoint(&self) -> BatchGetVpcEndpoint
pub fn batch_get_vpc_endpoint(&self) -> BatchGetVpcEndpoint
Constructs a fluent builder for the BatchGetVpcEndpoint
operation.
- The fluent builder is configurable:
ids(Vec<String>)
/set_ids(Option<Vec<String>>)
: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>
sourcepub fn create_access_policy(&self) -> CreateAccessPolicy
pub fn create_access_policy(&self) -> CreateAccessPolicy
Constructs a fluent builder for the CreateAccessPolicy
operation.
- The fluent builder is configurable:
r#type(AccessPolicyType)
/set_type(Option<AccessPolicyType>)
:The type of policy.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the policy.
description(impl Into<String>)
/set_description(Option<String>)
: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>)
:The JSON policy document to use as the content for the policy.
client_token(impl Into<String>)
/set_client_token(Option<String>)
: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>
sourcepub fn create_collection(&self) -> CreateCollection
pub fn create_collection(&self) -> CreateCollection
Constructs a fluent builder for the CreateCollection
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:Name of the collection.
r#type(CollectionType)
/set_type(Option<CollectionType>)
:The type of collection.
description(impl Into<String>)
/set_description(Option<String>)
:Description of the collection.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
client_token(impl Into<String>)
/set_client_token(Option<String>)
: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>
sourcepub fn create_security_config(&self) -> CreateSecurityConfig
pub fn create_security_config(&self) -> CreateSecurityConfig
Constructs a fluent builder for the CreateSecurityConfig
operation.
- The fluent builder is configurable:
r#type(SecurityConfigType)
/set_type(Option<SecurityConfigType>)
:The type of security configuration.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the security configuration.
description(impl Into<String>)
/set_description(Option<String>)
:A description of the security configuration.
saml_options(SamlConfigOptions)
/set_saml_options(Option<SamlConfigOptions>)
:Describes SAML options in in the form of a key-value map.
client_token(impl Into<String>)
/set_client_token(Option<String>)
: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>
sourcepub fn create_security_policy(&self) -> CreateSecurityPolicy
pub fn create_security_policy(&self) -> CreateSecurityPolicy
Constructs a fluent builder for the CreateSecurityPolicy
operation.
- The fluent builder is configurable:
r#type(SecurityPolicyType)
/set_type(Option<SecurityPolicyType>)
:The type of security policy.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the policy.
description(impl Into<String>)
/set_description(Option<String>)
: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>)
:The JSON policy document to use as the content for the new policy.
client_token(impl Into<String>)
/set_client_token(Option<String>)
: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>
sourcepub fn create_vpc_endpoint(&self) -> CreateVpcEndpoint
pub fn create_vpc_endpoint(&self) -> CreateVpcEndpoint
Constructs a fluent builder for the CreateVpcEndpoint
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the interface endpoint.
vpc_id(impl Into<String>)
/set_vpc_id(Option<String>)
:The ID of the VPC from which you’ll access OpenSearch Serverless.
subnet_ids(Vec<String>)
/set_subnet_ids(Option<Vec<String>>)
:The ID of one or more subnets from which you’ll access OpenSearch Serverless.
security_group_ids(Vec<String>)
/set_security_group_ids(Option<Vec<String>>)
: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>)
: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>
sourcepub fn delete_access_policy(&self) -> DeleteAccessPolicy
pub fn delete_access_policy(&self) -> DeleteAccessPolicy
Constructs a fluent builder for the DeleteAccessPolicy
operation.
- The fluent builder is configurable:
r#type(AccessPolicyType)
/set_type(Option<AccessPolicyType>)
:The type of policy.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the policy to delete.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:Unique, case-sensitive identifier to ensure idempotency of the request.
- On success, responds with
DeleteAccessPolicyOutput
- On failure, responds with
SdkError<DeleteAccessPolicyError>
sourcepub fn delete_collection(&self) -> DeleteCollection
pub fn delete_collection(&self) -> DeleteCollection
Constructs a fluent builder for the DeleteCollection
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
: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>)
: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>
sourcepub fn delete_security_config(&self) -> DeleteSecurityConfig
pub fn delete_security_config(&self) -> DeleteSecurityConfig
Constructs a fluent builder for the DeleteSecurityConfig
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
: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>)
:Unique, case-sensitive identifier to ensure idempotency of the request.
- On success, responds with
DeleteSecurityConfigOutput
- On failure, responds with
SdkError<DeleteSecurityConfigError>
sourcepub fn delete_security_policy(&self) -> DeleteSecurityPolicy
pub fn delete_security_policy(&self) -> DeleteSecurityPolicy
Constructs a fluent builder for the DeleteSecurityPolicy
operation.
- The fluent builder is configurable:
r#type(SecurityPolicyType)
/set_type(Option<SecurityPolicyType>)
:The type of policy.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the policy to delete.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:Unique, case-sensitive identifier to ensure idempotency of the request.
- On success, responds with
DeleteSecurityPolicyOutput
- On failure, responds with
SdkError<DeleteSecurityPolicyError>
sourcepub fn delete_vpc_endpoint(&self) -> DeleteVpcEndpoint
pub fn delete_vpc_endpoint(&self) -> DeleteVpcEndpoint
Constructs a fluent builder for the DeleteVpcEndpoint
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The VPC endpoint identifier.
client_token(impl Into<String>)
/set_client_token(Option<String>)
: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>
sourcepub fn get_access_policy(&self) -> GetAccessPolicy
pub fn get_access_policy(&self) -> GetAccessPolicy
Constructs a fluent builder for the GetAccessPolicy
operation.
- The fluent builder is configurable:
r#type(AccessPolicyType)
/set_type(Option<AccessPolicyType>)
:Tye type of policy. Currently the only supported value is
data
.name(impl Into<String>)
/set_name(Option<String>)
: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>
sourcepub fn get_account_settings(&self) -> GetAccountSettings
pub fn get_account_settings(&self) -> GetAccountSettings
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>
sourcepub fn get_policies_stats(&self) -> GetPoliciesStats
pub fn get_policies_stats(&self) -> GetPoliciesStats
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.
total_policy_count(Option<i64>)
:The total number of OpenSearch Serverless security policies and configurations in your account.
- On failure, responds with
SdkError<GetPoliciesStatsError>
sourcepub fn get_security_config(&self) -> GetSecurityConfig
pub fn get_security_config(&self) -> GetSecurityConfig
Constructs a fluent builder for the GetSecurityConfig
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
: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>
sourcepub fn get_security_policy(&self) -> GetSecurityPolicy
pub fn get_security_policy(&self) -> GetSecurityPolicy
Constructs a fluent builder for the GetSecurityPolicy
operation.
- The fluent builder is configurable:
r#type(SecurityPolicyType)
/set_type(Option<SecurityPolicyType>)
:The type of security policy.
name(impl Into<String>)
/set_name(Option<String>)
: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>
sourcepub fn list_access_policies(&self) -> ListAccessPolicies
pub fn list_access_policies(&self) -> ListAccessPolicies
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>)
:The type of access policy.
resource(Vec<String>)
/set_resource(Option<Vec<String>>)
:Resource filters (can be collection or indexes) that policies can apply to.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If your initial
ListAccessPolicies
operation returns anextToken
, you can include the returnednextToken
in subsequentListAccessPolicies
operations, which returns results in the next page.max_results(i32)
/set_max_results(Option<i32>)
: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 ofnextToken
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>
sourcepub fn list_collections(&self) -> ListCollections
pub fn list_collections(&self) -> ListCollections
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>)
:List of filter names and values that you can use for requests.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If your initial
ListCollections
operation returns anextToken
, you can include the returnednextToken
in subsequentListCollections
operations, which returns results in the next page.max_results(i32)
/set_max_results(Option<i32>)
: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 ofnextToken
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>
sourcepub fn list_security_configs(&self) -> ListSecurityConfigs
pub fn list_security_configs(&self) -> ListSecurityConfigs
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>)
:The type of security configuration.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If your initial
ListSecurityConfigs
operation returns anextToken
, you can include the returnednextToken
in subsequentListSecurityConfigs
operations, which returns results in the next page.max_results(i32)
/set_max_results(Option<i32>)
: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 ofnextToken
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>
sourcepub fn list_security_policies(&self) -> ListSecurityPolicies
pub fn list_security_policies(&self) -> ListSecurityPolicies
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>)
:The type of policy.
resource(Vec<String>)
/set_resource(Option<Vec<String>>)
:Resource filters (can be collection or indexes) that policies can apply to.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:If your initial
ListSecurityPolicies
operation returns anextToken
, you can include the returnednextToken
in subsequentListSecurityPolicies
operations, which returns results in the next page.max_results(i32)
/set_max_results(Option<i32>)
: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 ofnextToken
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>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
: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>
sourcepub fn list_vpc_endpoints(&self) -> ListVpcEndpoints
pub fn list_vpc_endpoints(&self) -> ListVpcEndpoints
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>)
:Filter the results according to the current status of the VPC endpoint. Possible statuses are
CREATING
,DELETING
,UPDATING
,ACTIVE
, andFAILED
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:If your initial
ListVpcEndpoints
operation returns anextToken
, you can include the returnednextToken
in subsequentListVpcEndpoints
operations, which returns results in the next page.max_results(i32)
/set_max_results(Option<i32>)
: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 ofnextToken
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>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
: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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
: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(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
: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>
sourcepub fn update_access_policy(&self) -> UpdateAccessPolicy
pub fn update_access_policy(&self) -> UpdateAccessPolicy
Constructs a fluent builder for the UpdateAccessPolicy
operation.
- The fluent builder is configurable:
r#type(AccessPolicyType)
/set_type(Option<AccessPolicyType>)
:The type of policy.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the policy.
policy_version(impl Into<String>)
/set_policy_version(Option<String>)
:The version of the policy being updated.
description(impl Into<String>)
/set_description(Option<String>)
: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>)
:The JSON policy document to use as the content for the policy.
client_token(impl Into<String>)
/set_client_token(Option<String>)
: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>
sourcepub fn update_account_settings(&self) -> UpdateAccountSettings
pub fn update_account_settings(&self) -> UpdateAccountSettings
Constructs a fluent builder for the UpdateAccountSettings
operation.
- The fluent builder is configurable:
capacity_limits(CapacityLimits)
/set_capacity_limits(Option<CapacityLimits>)
: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 Autoscaling.
- 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>
sourcepub fn update_collection(&self) -> UpdateCollection
pub fn update_collection(&self) -> UpdateCollection
Constructs a fluent builder for the UpdateCollection
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The unique identifier of the collection.
description(impl Into<String>)
/set_description(Option<String>)
:A description of the collection.
client_token(impl Into<String>)
/set_client_token(Option<String>)
: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>
sourcepub fn update_security_config(&self) -> UpdateSecurityConfig
pub fn update_security_config(&self) -> UpdateSecurityConfig
Constructs a fluent builder for the UpdateSecurityConfig
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
: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>)
: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>)
:A description of the security configuration.
saml_options(SamlConfigOptions)
/set_saml_options(Option<SamlConfigOptions>)
:SAML options in in the form of a key-value map.
client_token(impl Into<String>)
/set_client_token(Option<String>)
: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>
sourcepub fn update_security_policy(&self) -> UpdateSecurityPolicy
pub fn update_security_policy(&self) -> UpdateSecurityPolicy
Constructs a fluent builder for the UpdateSecurityPolicy
operation.
- The fluent builder is configurable:
r#type(SecurityPolicyType)
/set_type(Option<SecurityPolicyType>)
:The type of access policy.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the policy.
policy_version(impl Into<String>)
/set_policy_version(Option<String>)
:The version of the policy being updated.
description(impl Into<String>)
/set_description(Option<String>)
: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>)
:The JSON policy document to use as the content for the new policy.
client_token(impl Into<String>)
/set_client_token(Option<String>)
: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>
sourcepub fn update_vpc_endpoint(&self) -> UpdateVpcEndpoint
pub fn update_vpc_endpoint(&self) -> UpdateVpcEndpoint
Constructs a fluent builder for the UpdateVpcEndpoint
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The unique identifier of the interface endpoint to update.
add_subnet_ids(Vec<String>)
/set_add_subnet_ids(Option<Vec<String>>)
:The ID of one or more subnets to add to the endpoint.
remove_subnet_ids(Vec<String>)
/set_remove_subnet_ids(Option<Vec<String>>)
:The unique identifiers of the subnets to remove from the endpoint.
add_security_group_ids(Vec<String>)
/set_add_security_group_ids(Option<Vec<String>>)
: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(Vec<String>)
/set_remove_security_group_ids(Option<Vec<String>>)
:The unique identifiers of the security groups to remove from the endpoint.
client_token(impl Into<String>)
/set_client_token(Option<String>)
: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>
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_connector
on the Config passed into this function to fix it.
sourcepub fn from_conf(conf: Config) -> Self
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 thesleep_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 thehttp_connector
on the Config passed into this function to fix it.