Struct aws_sdk_memorydb::client::Client

pub struct Client { /* private fields */ }

Client for Amazon MemoryDB

Client for invoking operations on Amazon MemoryDB. Each operation on Amazon MemoryDB 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_memorydb::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config 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_memorydb::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 CopySnapshot operation has a Client::copy_snapshot, 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.copy_snapshot()
    .source_snapshot_name("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_update_cluster(&self) -> BatchUpdateClusterFluentBuilder

Constructs a fluent builder for the BatchUpdateCluster operation.

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

    The cluster names to apply the updates.

    
    
  • service_update(ServiceUpdateRequest) / set_service_update(Option<ServiceUpdateRequest>):
    required: false
    

    The unique ID of the service update

    
    
• On success, responds with BatchUpdateClusterOutput with field(s):
  • processed_clusters(Option<Vec::<Cluster>>):

    The list of clusters that have been updated.

  • unprocessed_clusters(Option<Vec::<UnprocessedCluster>>):

    The list of clusters where updates have not been applied.

• On failure, responds with SdkError<BatchUpdateClusterError>

impl Client

pub fn copy_snapshot(&self) -> CopySnapshotFluentBuilder

Constructs a fluent builder for the CopySnapshot operation.

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

    The name of an existing snapshot from which to make a copy.

    
    
  • target_snapshot_name(impl Into<String>) / set_target_snapshot_name(Option<String>):
    required: true
    

    A name for the snapshot copy. MemoryDB does not permit overwriting a snapshot, therefore this name must be unique within its context - MemoryDB or an Amazon S3 bucket if exporting.

    
    
  • target_bucket(impl Into<String>) / set_target_bucket(Option<String>):
    required: false
    

    The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access. When using this parameter to export a snapshot, be sure MemoryDB has the needed permissions to this S3 bucket. For more information, see Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The ID of the KMS key used to encrypt the target snapshot.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with CopySnapshotOutput with field(s):
  • snapshot(Option<Snapshot>):

    Represents a copy of an entire cluster as of the time when the snapshot was taken.

• On failure, responds with SdkError<CopySnapshotError>

impl Client

pub fn create_acl(&self) -> CreateACLFluentBuilder

Constructs a fluent builder for the CreateACL operation.

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

    The name of the Access Control List.

    
    
  • user_names(impl Into<String>) / set_user_names(Option<Vec::<String>>):
    required: false
    

    The list of users that belong to the Access Control List.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with CreateAclOutput with field(s):
  • acl(Option<Acl>):

    The newly-created Access Control List.

• On failure, responds with SdkError<CreateACLError>

impl Client

pub fn create_cluster(&self) -> CreateClusterFluentBuilder

Constructs a fluent builder for the CreateCluster operation.

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

    The name of the cluster. This value must be unique as it also serves as the cluster identifier.

    
    
  • node_type(impl Into<String>) / set_node_type(Option<String>):
    required: true
    

    The compute and memory capacity of the nodes in the cluster.

    
    
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: false
    

    The name of the parameter group associated with the cluster.

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

    An optional description of the cluster.

    
    
  • num_shards(i32) / set_num_shards(Option<i32>):
    required: false
    

    The number of shards the cluster will contain. The default value is 1.

    
    
  • num_replicas_per_shard(i32) / set_num_replicas_per_shard(Option<i32>):
    required: false
    

    The number of replicas to apply to each shard. The default value is 1. The maximum is 5.

    
    
  • subnet_group_name(impl Into<String>) / set_subnet_group_name(Option<String>):
    required: false
    

    The name of the subnet group to be used for the cluster.

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

    A list of security group names to associate with this cluster.

    
    
  • maintenance_window(impl Into<String>) / set_maintenance_window(Option<String>):
    required: false
    

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

    Valid values for ddd are:

    • sun

    • mon

    • tue

    • wed

    • thu

    • fri

    • sat

    Example: sun:23:00-mon:01:30

    
    
  • port(i32) / set_port(Option<i32>):
    required: false
    

    The port number on which each of the nodes accepts connections.

    
    
  • sns_topic_arn(impl Into<String>) / set_sns_topic_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

    
    
  • tls_enabled(bool) / set_tls_enabled(Option<bool>):
    required: false
    

    A flag to enable in-transit encryption on the cluster.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The ID of the KMS key used to encrypt the cluster.

    
    
  • snapshot_arns(impl Into<String>) / set_snapshot_arns(Option<Vec::<String>>):
    required: false
    

    A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.

    
    
  • snapshot_name(impl Into<String>) / set_snapshot_name(Option<String>):
    required: false
    

    The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.

    
    
  • snapshot_retention_limit(i32) / set_snapshot_retention_limit(Option<i32>):
    required: false
    

    The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

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

    A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

    
    
  • snapshot_window(impl Into<String>) / set_snapshot_window(Option<String>):
    required: false
    

    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

    Example: 05:00-09:00

    If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

    
    
  • acl_name(impl Into<String>) / set_acl_name(Option<String>):
    required: true
    

    The name of the Access Control List to associate with the cluster.

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

    The version number of the Redis engine to be used for the cluster.

    
    
  • auto_minor_version_upgrade(bool) / set_auto_minor_version_upgrade(Option<bool>):
    required: false
    

    When set to true, the cluster will automatically receive minor engine version upgrades after launch.

    
    
  • data_tiering(bool) / set_data_tiering(Option<bool>):
    required: false
    

    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.

    
    
• On success, responds with CreateClusterOutput with field(s):
  • cluster(Option<Cluster>):

    The newly-created cluster.

• On failure, responds with SdkError<CreateClusterError>

impl Client

pub fn create_parameter_group(&self) -> CreateParameterGroupFluentBuilder

Constructs a fluent builder for the CreateParameterGroup operation.

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

    The name of the parameter group.

    
    
  • family(impl Into<String>) / set_family(Option<String>):
    required: true
    

    The name of the parameter group family that the parameter group can be used with.

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

    An optional description of the parameter group.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with CreateParameterGroupOutput with field(s):
  • parameter_group(Option<ParameterGroup>):

    The newly-created parameter group.

• On failure, responds with SdkError<CreateParameterGroupError>

impl Client

pub fn create_snapshot(&self) -> CreateSnapshotFluentBuilder

Constructs a fluent builder for the CreateSnapshot operation.

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

    The snapshot is created from this cluster.

    
    
  • snapshot_name(impl Into<String>) / set_snapshot_name(Option<String>):
    required: true
    

    A name for the snapshot being created.

    
    
  • kms_key_id(impl Into<String>) / set_kms_key_id(Option<String>):
    required: false
    

    The ID of the KMS key used to encrypt the snapshot.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with CreateSnapshotOutput with field(s):
  • snapshot(Option<Snapshot>):

    The newly-created snapshot.

• On failure, responds with SdkError<CreateSnapshotError>

impl Client

pub fn create_subnet_group(&self) -> CreateSubnetGroupFluentBuilder

Constructs a fluent builder for the CreateSubnetGroup operation.

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

    The name of the subnet group.

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

    A description for the subnet group.

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

    A list of VPC subnet IDs for the subnet group.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with CreateSubnetGroupOutput with field(s):
  • subnet_group(Option<SubnetGroup>):

    The newly-created subnet group

• On failure, responds with SdkError<CreateSubnetGroupError>

impl Client

pub fn create_user(&self) -> CreateUserFluentBuilder

Constructs a fluent builder for the CreateUser operation.

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

    The name of the user. This value must be unique as it also serves as the user identifier.

    
    
  • authentication_mode(AuthenticationMode) / set_authentication_mode(Option<AuthenticationMode>):
    required: true
    

    Denotes the user’s authentication properties, such as whether it requires a password to authenticate.

    
    
  • access_string(impl Into<String>) / set_access_string(Option<String>):
    required: true
    

    Access permissions string used for this user.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with CreateUserOutput with field(s):
  • user(Option<User>):

    The newly-created user.

• On failure, responds with SdkError<CreateUserError>

impl Client

pub fn delete_acl(&self) -> DeleteACLFluentBuilder

Constructs a fluent builder for the DeleteACL operation.

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

    The name of the Access Control List to delete

    
    
• On success, responds with DeleteAclOutput with field(s):
  • acl(Option<Acl>):

    The Access Control List object that has been deleted.

• On failure, responds with SdkError<DeleteACLError>

impl Client

pub fn delete_cluster(&self) -> DeleteClusterFluentBuilder

Constructs a fluent builder for the DeleteCluster operation.

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

    The name of the cluster to be deleted

    
    
  • final_snapshot_name(impl Into<String>) / set_final_snapshot_name(Option<String>):
    required: false
    

    The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.

    
    
• On success, responds with DeleteClusterOutput with field(s):
  • cluster(Option<Cluster>):

    The cluster object that has been deleted

• On failure, responds with SdkError<DeleteClusterError>

impl Client

pub fn delete_parameter_group(&self) -> DeleteParameterGroupFluentBuilder

Constructs a fluent builder for the DeleteParameterGroup operation.

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

    The name of the parameter group to delete.

    
    
• On success, responds with DeleteParameterGroupOutput with field(s):
  • parameter_group(Option<ParameterGroup>):

    The parameter group that has been deleted.

• On failure, responds with SdkError<DeleteParameterGroupError>

impl Client

pub fn delete_snapshot(&self) -> DeleteSnapshotFluentBuilder

Constructs a fluent builder for the DeleteSnapshot operation.

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

    The name of the snapshot to delete

    
    
• On success, responds with DeleteSnapshotOutput with field(s):
  • snapshot(Option<Snapshot>):

    The snapshot object that has been deleted.

• On failure, responds with SdkError<DeleteSnapshotError>

impl Client

pub fn delete_subnet_group(&self) -> DeleteSubnetGroupFluentBuilder

Constructs a fluent builder for the DeleteSubnetGroup operation.

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

    The name of the subnet group to delete

    
    
• On success, responds with DeleteSubnetGroupOutput with field(s):
  • subnet_group(Option<SubnetGroup>):

    The subnet group object that has been deleted.

• On failure, responds with SdkError<DeleteSubnetGroupError>

impl Client

pub fn delete_user(&self) -> DeleteUserFluentBuilder

Constructs a fluent builder for the DeleteUser operation.

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

    The name of the user to delete

    
    
• On success, responds with DeleteUserOutput with field(s):
  • user(Option<User>):

    The user object that has been deleted.

• On failure, responds with SdkError<DeleteUserError>

impl Client

pub fn describe_acls(&self) -> DescribeACLsFluentBuilder

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

• The fluent builder is configurable:
  • acl_name(impl Into<String>) / set_acl_name(Option<String>):
    required: false
    

    The name of the ACL

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

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

    
    
• On success, responds with DescribeAcLsOutput with field(s):
  • acls(Option<Vec::<Acl>>):

    The list of ACLs

  • next_token(Option<String>):

    If 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. Keep all other arguments unchanged.

• On failure, responds with SdkError<DescribeACLsError>

impl Client

pub fn describe_clusters(&self) -> DescribeClustersFluentBuilder

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

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: false
    

    The name of the cluster

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

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

    
    
  • show_shard_details(bool) / set_show_shard_details(Option<bool>):
    required: false
    

    An optional flag that can be included in the request to retrieve information about the individual shard(s).

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

  • clusters(Option<Vec::<Cluster>>):

    A list of clusters

• On failure, responds with SdkError<DescribeClustersError>

impl Client

pub fn describe_engine_versions(&self) -> DescribeEngineVersionsFluentBuilder

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

• The fluent builder is configurable:
  • engine_version(impl Into<String>) / set_engine_version(Option<String>):
    required: false
    

    The Redis engine version

    
    
  • parameter_group_family(impl Into<String>) / set_parameter_group_family(Option<String>):
    required: false
    

    The name of a specific parameter group family to return details for.

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

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

    
    
  • default_only(bool) / set_default_only(Option<bool>):
    required: false
    

    If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

  • engine_versions(Option<Vec::<EngineVersionInfo>>):

    A list of engine version details. Each element in the list contains detailed information about one engine version.

• On failure, responds with SdkError<DescribeEngineVersionsError>

impl Client

pub fn describe_events(&self) -> DescribeEventsFluentBuilder

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

• The fluent builder is configurable:
  • source_name(impl Into<String>) / set_source_name(Option<String>):
    required: false
    

    The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

    
    
  • source_type(SourceType) / set_source_type(Option<SourceType>):
    required: false
    

    The event source to retrieve events for. If no value is specified, all events are returned.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. Example: 2017-03-30T07:03:49.555Z

    
    
  • duration(i32) / set_duration(Option<i32>):
    required: false
    

    The number of minutes worth of events to retrieve.

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

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

  • events(Option<Vec::<Event>>):

    A list of events. Each element in the list contains detailed information about one event.

• On failure, responds with SdkError<DescribeEventsError>

impl Client

pub fn describe_parameter_groups(&self) -> DescribeParameterGroupsFluentBuilder

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

• The fluent builder is configurable:
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: false
    

    The name of a specific parameter group to return details for.

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

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

  • parameter_groups(Option<Vec::<ParameterGroup>>):

    A list of parameter groups. Each element in the list contains detailed information about one parameter group.

• On failure, responds with SdkError<DescribeParameterGroupsError>

impl Client

pub fn describe_parameters(&self) -> DescribeParametersFluentBuilder

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

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

    he name of a specific parameter group to return details for.

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

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

  • parameters(Option<Vec::<Parameter>>):

    A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.

• On failure, responds with SdkError<DescribeParametersError>

impl Client

pub fn describe_reserved_nodes(&self) -> DescribeReservedNodesFluentBuilder

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

• The fluent builder is configurable:
  • reservation_id(impl Into<String>) / set_reservation_id(Option<String>):
    required: false
    

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

    
    
  • reserved_nodes_offering_id(impl Into<String>) / set_reserved_nodes_offering_id(Option<String>):
    required: false
    

    The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

    
    
  • node_type(impl Into<String>) / set_node_type(Option<String>):
    required: false
    

    The node type filter value. Use this parameter to show only those reservations matching the specified node type. For more information, see Supported node types.

    
    
  • duration(impl Into<String>) / set_duration(Option<String>):
    required: false
    

    The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

    
    
  • offering_type(impl Into<String>) / set_offering_type(Option<String>):
    required: false
    

    The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: “All Upfront”|“Partial Upfront”| “No Upfront”

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

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

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

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • reserved_nodes(Option<Vec::<ReservedNode>>):

    Returns information about reserved nodes for this account, or about a specified reserved node.

• On failure, responds with SdkError<DescribeReservedNodesError>

impl Client

pub fn describe_reserved_nodes_offerings( &self ) -> DescribeReservedNodesOfferingsFluentBuilder

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

• The fluent builder is configurable:
  • reserved_nodes_offering_id(impl Into<String>) / set_reserved_nodes_offering_id(Option<String>):
    required: false
    

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

    
    
  • node_type(impl Into<String>) / set_node_type(Option<String>):
    required: false
    

    The node type for the reserved nodes. For more information, see Supported node types.

    
    
  • duration(impl Into<String>) / set_duration(Option<String>):
    required: false
    

    Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

    
    
  • offering_type(impl Into<String>) / set_offering_type(Option<String>):
    required: false
    

    The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: “All Upfront”|“Partial Upfront”| “No Upfront”

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

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

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

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • reserved_nodes_offerings(Option<Vec::<ReservedNodesOffering>>):

    Lists available reserved node offerings.

• On failure, responds with SdkError<DescribeReservedNodesOfferingsError>

impl Client

pub fn describe_service_updates(&self) -> DescribeServiceUpdatesFluentBuilder

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

• The fluent builder is configurable:
  • service_update_name(impl Into<String>) / set_service_update_name(Option<String>):
    required: false
    

    The unique ID of the service update to describe.

    
    
  • cluster_names(impl Into<String>) / set_cluster_names(Option<Vec::<String>>):
    required: false
    

    The list of cluster names to identify service updates to apply

    
    
  • status(ServiceUpdateStatus) / set_status(Option<Vec::<ServiceUpdateStatus>>):
    required: false
    

    The status(es) of the service updates to filter on

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

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

  • service_updates(Option<Vec::<ServiceUpdate>>):

    A list of service updates

• On failure, responds with SdkError<DescribeServiceUpdatesError>

impl Client

pub fn describe_snapshots(&self) -> DescribeSnapshotsFluentBuilder

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

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: false
    

    A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

    
    
  • snapshot_name(impl Into<String>) / set_snapshot_name(Option<String>):
    required: false
    

    A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.

    
    
  • source(impl Into<String>) / set_source(Option<String>):
    required: false
    

    If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

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

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
  • show_detail(bool) / set_show_detail(Option<bool>):
    required: false
    

    A Boolean value which if true, the shard configuration is included in the snapshot description.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

  • snapshots(Option<Vec::<Snapshot>>):

    A list of snapshots. Each item in the list contains detailed information about one snapshot.

• On failure, responds with SdkError<DescribeSnapshotsError>

impl Client

pub fn describe_subnet_groups(&self) -> DescribeSubnetGroupsFluentBuilder

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

• The fluent builder is configurable:
  • subnet_group_name(impl Into<String>) / set_subnet_group_name(Option<String>):
    required: false
    

    The name of the subnet group to return details for.

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

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

  • subnet_groups(Option<Vec::<SubnetGroup>>):

    A list of subnet groups. Each element in the list contains detailed information about one group.

• On failure, responds with SdkError<DescribeSubnetGroupsError>

impl Client

pub fn describe_users(&self) -> DescribeUsersFluentBuilder

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

• The fluent builder is configurable:
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: false
    

    The name of the user

    
    
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    Filter to determine the list of users to return.

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

    The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

    
    
• On success, responds with DescribeUsersOutput with field(s):
  • users(Option<Vec::<User>>):

    A list of users.

  • next_token(Option<String>):

    An optional argument to pass in case the total number of records exceeds the value of MaxResults. If 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. Keep all other arguments unchanged.

• On failure, responds with SdkError<DescribeUsersError>

impl Client

pub fn failover_shard(&self) -> FailoverShardFluentBuilder

Constructs a fluent builder for the FailoverShard operation.

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

    The cluster being failed over

    
    
  • shard_name(impl Into<String>) / set_shard_name(Option<String>):
    required: true
    

    The name of the shard

    
    
• On success, responds with FailoverShardOutput with field(s):
  • cluster(Option<Cluster>):

    The cluster being failed over

• On failure, responds with SdkError<FailoverShardError>

impl Client

pub fn list_allowed_node_type_updates( &self ) -> ListAllowedNodeTypeUpdatesFluentBuilder

Constructs a fluent builder for the ListAllowedNodeTypeUpdates operation.

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

    The name of the cluster you want to scale. MemoryDB uses the cluster name to identify the current node type being used by this cluster, and from that to create a list of node types you can scale up to.

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

    A list node types which you can use to scale up your cluster.

  • scale_down_node_types(Option<Vec::<String>>):

    A list node types which you can use to scale down your cluster.

• On failure, responds with SdkError<ListAllowedNodeTypeUpdatesError>

impl Client

pub fn list_tags(&self) -> ListTagsFluentBuilder

Constructs a fluent builder for the ListTags 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 for which you want the list of tags

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

    A list of tags as key-value pairs.

• On failure, responds with SdkError<ListTagsError>

impl Client

pub fn purchase_reserved_nodes_offering( &self ) -> PurchaseReservedNodesOfferingFluentBuilder

Constructs a fluent builder for the PurchaseReservedNodesOffering operation.

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

    The ID of the reserved node offering to purchase.

    
    
  • reservation_id(impl Into<String>) / set_reservation_id(Option<String>):
    required: false
    

    A customer-specified identifier to track this reservation.

    
    
  • node_count(i32) / set_node_count(Option<i32>):
    required: false
    

    The number of node instances to reserve.

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

    
    
• On success, responds with PurchaseReservedNodesOfferingOutput with field(s):
  • reserved_node(Option<ReservedNode>):

    Represents the output of a PurchaseReservedNodesOffering operation.

• On failure, responds with SdkError<PurchaseReservedNodesOfferingError>

impl Client

pub fn reset_parameter_group(&self) -> ResetParameterGroupFluentBuilder

Constructs a fluent builder for the ResetParameterGroup operation.

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

    The name of the parameter group to reset.

    
    
  • all_parameters(bool) / set_all_parameters(Option<bool>):
    required: false
    

    If true, all parameters in the parameter group are reset to their default values. If false, only the parameters listed by ParameterNames are reset to their default values.

    
    
  • parameter_names(impl Into<String>) / set_parameter_names(Option<Vec::<String>>):
    required: false
    

    An array of parameter names to reset to their default values. If AllParameters is true, do not use ParameterNames. If AllParameters is false, you must specify the name of at least one parameter to reset.

    
    
• On success, responds with ResetParameterGroupOutput with field(s):
  • parameter_group(Option<ParameterGroup>):

    The parameter group being reset.

• On failure, responds with SdkError<ResetParameterGroupError>

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 to which the tags are to be added

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

    A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

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

    A list of tags as key-value pairs.

• 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 which the tags are to be removed

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

    The list of keys of the tags that are to be removed

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

    The list of tags removed

• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_acl(&self) -> UpdateACLFluentBuilder

Constructs a fluent builder for the UpdateACL operation.

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

    The name of the Access Control List

    
    
  • user_names_to_add(impl Into<String>) / set_user_names_to_add(Option<Vec::<String>>):
    required: false
    

    The list of users to add to the Access Control List

    
    
  • user_names_to_remove(impl Into<String>) / set_user_names_to_remove(Option<Vec::<String>>):
    required: false
    

    The list of users to remove from the Access Control List

    
    
• On success, responds with UpdateAclOutput with field(s):
  • acl(Option<Acl>):

    The updated Access Control List

• On failure, responds with SdkError<UpdateACLError>

impl Client

pub fn update_cluster(&self) -> UpdateClusterFluentBuilder

Constructs a fluent builder for the UpdateCluster operation.

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

    The name of the cluster to update

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

    The description of the cluster to update

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

    The SecurityGroupIds to update

    
    
  • maintenance_window(impl Into<String>) / set_maintenance_window(Option<String>):
    required: false
    

    Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

    Valid values for ddd are:

    • sun

    • mon

    • tue

    • wed

    • thu

    • fri

    • sat

    Example: sun:23:00-mon:01:30

    
    
  • sns_topic_arn(impl Into<String>) / set_sns_topic_arn(Option<String>):
    required: false
    

    The SNS topic ARN to update

    
    
  • sns_topic_status(impl Into<String>) / set_sns_topic_status(Option<String>):
    required: false
    

    The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

    
    
  • parameter_group_name(impl Into<String>) / set_parameter_group_name(Option<String>):
    required: false
    

    The name of the parameter group to update

    
    
  • snapshot_window(impl Into<String>) / set_snapshot_window(Option<String>):
    required: false
    

    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

    
    
  • snapshot_retention_limit(i32) / set_snapshot_retention_limit(Option<i32>):
    required: false
    

    The number of days for which MemoryDB retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

    
    
  • node_type(impl Into<String>) / set_node_type(Option<String>):
    required: false
    

    A valid node type that you want to scale this cluster up or down to.

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

    The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

    
    
  • replica_configuration(ReplicaConfigurationRequest) / set_replica_configuration(Option<ReplicaConfigurationRequest>):
    required: false
    

    The number of replicas that will reside in each shard

    
    
  • shard_configuration(ShardConfigurationRequest) / set_shard_configuration(Option<ShardConfigurationRequest>):
    required: false
    

    The number of shards in the cluster

    
    
  • acl_name(impl Into<String>) / set_acl_name(Option<String>):
    required: false
    

    The Access Control List that is associated with the cluster

    
    
• On success, responds with UpdateClusterOutput with field(s):
  • cluster(Option<Cluster>):

    The updated cluster

• On failure, responds with SdkError<UpdateClusterError>

impl Client

pub fn update_parameter_group(&self) -> UpdateParameterGroupFluentBuilder

Constructs a fluent builder for the UpdateParameterGroup operation.

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

    The name of the parameter group to update.

    
    
  • parameter_name_values(ParameterNameValue) / set_parameter_name_values(Option<Vec::<ParameterNameValue>>):
    required: true
    

    An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be updated per request.

    
    
• On success, responds with UpdateParameterGroupOutput with field(s):
  • parameter_group(Option<ParameterGroup>):

    The updated parameter group

• On failure, responds with SdkError<UpdateParameterGroupError>

impl Client

pub fn update_subnet_group(&self) -> UpdateSubnetGroupFluentBuilder

Constructs a fluent builder for the UpdateSubnetGroup operation.

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

    The name of the subnet group

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

    A description of the subnet group

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

    The EC2 subnet IDs for the subnet group.

    
    
• On success, responds with UpdateSubnetGroupOutput with field(s):
  • subnet_group(Option<SubnetGroup>):

    The updated subnet group

• On failure, responds with SdkError<UpdateSubnetGroupError>

impl Client

pub fn update_user(&self) -> UpdateUserFluentBuilder

Constructs a fluent builder for the UpdateUser operation.

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

    The name of the user

    
    
  • authentication_mode(AuthenticationMode) / set_authentication_mode(Option<AuthenticationMode>):
    required: false
    

    Denotes the user’s authentication properties, such as whether it requires a password to authenticate.

    
    
  • access_string(impl Into<String>) / set_access_string(Option<String>):
    required: false
    

    Access permissions string used for this user.

    
    
• On success, responds with UpdateUserOutput with field(s):
  • user(Option<User>):

    The updated user

• On failure, responds with SdkError<UpdateUserError>

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.