Struct Client 

pub struct Client { /* private fields */ }

Client for Redshift Serverless

Client for invoking operations on Redshift Serverless. Each operation on Redshift 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_redshiftserverless::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_redshiftserverless::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 ConvertRecoveryPointToSnapshot operation has a Client::convert_recovery_point_to_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.convert_recovery_point_to_snapshot()
    .recovery_point_id("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 convert_recovery_point_to_snapshot( &self, ) -> ConvertRecoveryPointToSnapshotFluentBuilder

Constructs a fluent builder for the ConvertRecoveryPointToSnapshot operation.

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

    The unique identifier of the recovery point.

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

    The name of the snapshot.

    
    
  • retention_period(i32) / set_retention_period(Option<i32>):
    required: false
    

    How long to retain the snapshot.

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

    An array of Tag objects to associate with the created snapshot.

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

    The snapshot converted from the recovery point.

• On failure, responds with SdkError<ConvertRecoveryPointToSnapshotError>

impl Client

pub fn create_custom_domain_association( &self, ) -> CreateCustomDomainAssociationFluentBuilder

Constructs a fluent builder for the CreateCustomDomainAssociation operation.

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

    The name of the workgroup associated with the database.

    
    
  • custom_domain_name(impl Into<String>) / set_custom_domain_name(Option<String>):
    required: true
    

    The custom domain name to associate with the workgroup.

    
    
  • custom_domain_certificate_arn(impl Into<String>) / set_custom_domain_certificate_arn(Option<String>):
    required: true
    

    The custom domain name’s certificate Amazon resource name (ARN).

    
    
• On success, responds with CreateCustomDomainAssociationOutput with field(s):
  • custom_domain_name(Option<String>):

    The custom domain name to associate with the workgroup.

  • workgroup_name(Option<String>):

    The name of the workgroup associated with the database.

  • custom_domain_certificate_arn(Option<String>):

    The custom domain name’s certificate Amazon resource name (ARN).

  • custom_domain_certificate_expiry_time(Option<DateTime>):

    The expiration time for the certificate.

• On failure, responds with SdkError<CreateCustomDomainAssociationError>

impl Client

pub fn create_endpoint_access(&self) -> CreateEndpointAccessFluentBuilder

Constructs a fluent builder for the CreateEndpointAccess operation.

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

    The name of the VPC endpoint. An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can’t contain two consecutive hyphens or end with a hyphen.

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

    The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: true
    

    The name of the workgroup to associate with the VPC endpoint.

    
    
  • vpc_security_group_ids(impl Into<String>) / set_vpc_security_group_ids(Option<Vec::<String>>):
    required: false
    

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

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: false
    

    The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.

    
    
• On success, responds with CreateEndpointAccessOutput with field(s):
  • endpoint(Option<EndpointAccess>):

    The created VPC endpoint.

• On failure, responds with SdkError<CreateEndpointAccessError>

impl Client

pub fn create_namespace(&self) -> CreateNamespaceFluentBuilder

Constructs a fluent builder for the CreateNamespace operation.

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

    The name of the namespace.

    
    
  • admin_username(impl Into<String>) / set_admin_username(Option<String>):
    required: false
    

    The username of the administrator for the first database created in the namespace.

    
    
  • admin_user_password(impl Into<String>) / set_admin_user_password(Option<String>):
    required: false
    

    The password of the administrator for the first database created in the namespace.

    You can’t use adminUserPassword if manageAdminPassword is true.

    
    
  • db_name(impl Into<String>) / set_db_name(Option<String>):
    required: false
    

    The name of the first database created in the namespace.

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

    The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

    
    
  • default_iam_role_arn(impl Into<String>) / set_default_iam_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

    
    
  • iam_roles(impl Into<String>) / set_iam_roles(Option<Vec::<String>>):
    required: false
    

    A list of IAM roles to associate with the namespace.

    
    
  • log_exports(LogExport) / set_log_exports(Option<Vec::<LogExport>>):
    required: false
    

    The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.

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

    A list of tag instances.

    
    
  • manage_admin_password(bool) / set_manage_admin_password(Option<bool>):
    required: false
    

    If true, Amazon Redshift uses Secrets Manager to manage the namespace’s admin credentials. You can’t use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account’s password.

    
    
  • admin_password_secret_kms_key_id(impl Into<String>) / set_admin_password_secret_kms_key_id(Option<String>):
    required: false
    

    The ID of the Key Management Service (KMS) key used to encrypt and store the namespace’s admin credentials secret. You can only use this parameter if manageAdminPassword is true.

    
    
  • redshift_idc_application_arn(impl Into<String>) / set_redshift_idc_application_arn(Option<String>):
    required: false
    

    The ARN for the Redshift application that integrates with IAM Identity Center.

    
    
• On success, responds with CreateNamespaceOutput with field(s):
  • namespace(Option<Namespace>):

    The created namespace object.

• On failure, responds with SdkError<CreateNamespaceError>

impl Client

pub fn create_reservation(&self) -> CreateReservationFluentBuilder

Constructs a fluent builder for the CreateReservation operation.

• The fluent builder is configurable:
  • capacity(i32) / set_capacity(Option<i32>):
    required: true
    

    The number of Redshift Processing Units (RPUs) to reserve.

    
    
  • offering_id(impl Into<String>) / set_offering_id(Option<String>):
    required: true
    

    The ID of the offering associated with the reservation. The offering determines the payment schedule for the reservation.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. This token must be a valid UUIDv4 value. For more information about idempotency, see Making retries safe with idempotent APIs .

    
    
• On success, responds with CreateReservationOutput with field(s):
  • reservation(Option<Reservation>):

    The reservation object that the CreateReservation action created.

• On failure, responds with SdkError<CreateReservationError>

impl Client

pub fn create_scheduled_action(&self) -> CreateScheduledActionFluentBuilder

Constructs a fluent builder for the CreateScheduledAction operation.

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

    The name of the scheduled action.

    
    
  • target_action(TargetAction) / set_target_action(Option<TargetAction>):
    required: true
    

    A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.

    “{“CreateSnapshot”: {“NamespaceName”: “sampleNamespace”,“SnapshotName”: “sampleSnapshot”, “retentionPeriod”: “1”}}“

    
    
  • schedule(Schedule) / set_schedule(Option<Schedule>):
    required: true
    

    The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

    • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

    • Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, “(0 10 ? * MON *)”. For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide

    
    
  • namespace_name(impl Into<String>) / set_namespace_name(Option<String>):
    required: true
    

    The name of the namespace for which to create a scheduled action.

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: false
    

    Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.

    
    
  • scheduled_action_description(impl Into<String>) / set_scheduled_action_description(Option<String>):
    required: false
    

    The description of the scheduled action.

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

    The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

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

    The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

    
    
• On success, responds with CreateScheduledActionOutput with field(s):
  • scheduled_action(Option<ScheduledActionResponse>):

    The returned ScheduledAction object that describes the properties of a scheduled action.

• On failure, responds with SdkError<CreateScheduledActionError>

impl Client

pub fn create_snapshot(&self) -> CreateSnapshotFluentBuilder

Constructs a fluent builder for the CreateSnapshot operation.

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

    The namespace to create a snapshot for.

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

    The name of the snapshot.

    
    
  • retention_period(i32) / set_retention_period(Option<i32>):
    required: false
    

    How long to retain the created snapshot.

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

    An array of Tag objects to associate with the snapshot.

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

    The created snapshot object.

• On failure, responds with SdkError<CreateSnapshotError>

impl Client

pub fn create_snapshot_copy_configuration( &self, ) -> CreateSnapshotCopyConfigurationFluentBuilder

Constructs a fluent builder for the CreateSnapshotCopyConfiguration operation.

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

    The name of the namespace to copy snapshots from.

    
    
  • destination_region(impl Into<String>) / set_destination_region(Option<String>):
    required: true
    

    The destination Amazon Web Services Region that you want to copy snapshots to.

    
    
  • snapshot_retention_period(i32) / set_snapshot_retention_period(Option<i32>):
    required: false
    

    The retention period of the snapshots that you copy to the destination Amazon Web Services Region.

    
    
  • destination_kms_key_id(impl Into<String>) / set_destination_kms_key_id(Option<String>):
    required: false
    

    The KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.

    
    
• On success, responds with CreateSnapshotCopyConfigurationOutput with field(s):
  • snapshot_copy_configuration(Option<SnapshotCopyConfiguration>):

    The snapshot copy configuration object that is returned.

• On failure, responds with SdkError<CreateSnapshotCopyConfigurationError>

impl Client

pub fn create_usage_limit(&self) -> CreateUsageLimitFluentBuilder

Constructs a fluent builder for the CreateUsageLimit 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 Amazon Redshift Serverless resource to create the usage limit for.

    
    
  • usage_type(UsageLimitUsageType) / set_usage_type(Option<UsageLimitUsageType>):
    required: true
    

    The type of Amazon Redshift Serverless usage to create a usage limit for.

    
    
  • amount(i64) / set_amount(Option<i64>):
    required: true
    

    The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.

    
    
  • period(UsageLimitPeriod) / set_period(Option<UsageLimitPeriod>):
    required: false
    

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

    
    
  • breach_action(UsageLimitBreachAction) / set_breach_action(Option<UsageLimitBreachAction>):
    required: false
    

    The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.

    
    
• On success, responds with CreateUsageLimitOutput with field(s):
  • usage_limit(Option<UsageLimit>):

    The returned usage limit object.

• On failure, responds with SdkError<CreateUsageLimitError>

impl Client

pub fn create_workgroup(&self) -> CreateWorkgroupFluentBuilder

Constructs a fluent builder for the CreateWorkgroup operation.

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

    The name of the created workgroup.

    
    
  • namespace_name(impl Into<String>) / set_namespace_name(Option<String>):
    required: true
    

    The name of the namespace to associate with the workgroup.

    
    
  • base_capacity(i32) / set_base_capacity(Option<i32>):
    required: false
    

    The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

    
    
  • enhanced_vpc_routing(bool) / set_enhanced_vpc_routing(Option<bool>):
    required: false
    

    The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.

    
    
  • config_parameters(ConfigParameter) / set_config_parameters(Option<Vec::<ConfigParameter>>):
    required: false
    

    An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

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

    An array of security group IDs to associate with the workgroup.

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

    An array of VPC subnet IDs to associate with the workgroup.

    
    
  • publicly_accessible(bool) / set_publicly_accessible(Option<bool>):
    required: false
    

    A value that specifies whether the workgroup can be accessed from a public network.

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

    A array of tag instances.

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

    The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

    
    
  • max_capacity(i32) / set_max_capacity(Option<i32>):
    required: false
    

    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

    
    
  • price_performance_target(PerformanceTarget) / set_price_performance_target(Option<PerformanceTarget>):
    required: false
    

    An object that represents the price performance target settings for the workgroup.

    
    
  • ip_address_type(impl Into<String>) / set_ip_address_type(Option<String>):
    required: false
    

    The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.

    
    
  • track_name(impl Into<String>) / set_track_name(Option<String>):
    required: false
    

    An optional parameter for the name of the track for the workgroup. If you don’t provide a track name, the workgroup is assigned to the current track.

    
    
• On success, responds with CreateWorkgroupOutput with field(s):
  • workgroup(Option<Workgroup>):

    The created workgroup object.

• On failure, responds with SdkError<CreateWorkgroupError>

impl Client

pub fn delete_custom_domain_association( &self, ) -> DeleteCustomDomainAssociationFluentBuilder

Constructs a fluent builder for the DeleteCustomDomainAssociation operation.

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

    The name of the workgroup associated with the database.

    
    
  • custom_domain_name(impl Into<String>) / set_custom_domain_name(Option<String>):
    required: true
    

    The custom domain name associated with the workgroup.

    
    
• On success, responds with DeleteCustomDomainAssociationOutput
• On failure, responds with SdkError<DeleteCustomDomainAssociationError>

impl Client

pub fn delete_endpoint_access(&self) -> DeleteEndpointAccessFluentBuilder

Constructs a fluent builder for the DeleteEndpointAccess operation.

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

    The name of the VPC endpoint to delete.

    
    
• On success, responds with DeleteEndpointAccessOutput with field(s):
  • endpoint(Option<EndpointAccess>):

    The deleted VPC endpoint.

• On failure, responds with SdkError<DeleteEndpointAccessError>

impl Client

pub fn delete_namespace(&self) -> DeleteNamespaceFluentBuilder

Constructs a fluent builder for the DeleteNamespace operation.

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

    The name of the namespace to delete.

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

    The name of the snapshot to be created before the namespace is deleted.

    
    
  • final_snapshot_retention_period(i32) / set_final_snapshot_retention_period(Option<i32>):
    required: false
    

    How long to retain the final snapshot.

    
    
• On success, responds with DeleteNamespaceOutput with field(s):
  • namespace(Option<Namespace>):

    The deleted namespace object.

• On failure, responds with SdkError<DeleteNamespaceError>

impl Client

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy 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 policy to delete.

    
    
• On success, responds with DeleteResourcePolicyOutput
• On failure, responds with SdkError<DeleteResourcePolicyError>

impl Client

pub fn delete_scheduled_action(&self) -> DeleteScheduledActionFluentBuilder

Constructs a fluent builder for the DeleteScheduledAction operation.

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

    The name of the scheduled action to delete.

    
    
• On success, responds with DeleteScheduledActionOutput with field(s):
  • scheduled_action(Option<ScheduledActionResponse>):

    The deleted scheduled action object.

• On failure, responds with SdkError<DeleteScheduledActionError>

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 be deleted.

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

    The deleted snapshot object.

• On failure, responds with SdkError<DeleteSnapshotError>

impl Client

pub fn delete_snapshot_copy_configuration( &self, ) -> DeleteSnapshotCopyConfigurationFluentBuilder

Constructs a fluent builder for the DeleteSnapshotCopyConfiguration operation.

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

    The ID of the snapshot copy configuration to delete.

    
    
• On success, responds with DeleteSnapshotCopyConfigurationOutput with field(s):
  • snapshot_copy_configuration(Option<SnapshotCopyConfiguration>):

    The deleted snapshot copy configuration object.

• On failure, responds with SdkError<DeleteSnapshotCopyConfigurationError>

impl Client

pub fn delete_usage_limit(&self) -> DeleteUsageLimitFluentBuilder

Constructs a fluent builder for the DeleteUsageLimit operation.

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

    The unique identifier of the usage limit to delete.

    
    
• On success, responds with DeleteUsageLimitOutput with field(s):
  • usage_limit(Option<UsageLimit>):

    The deleted usage limit object.

• On failure, responds with SdkError<DeleteUsageLimitError>

impl Client

pub fn delete_workgroup(&self) -> DeleteWorkgroupFluentBuilder

Constructs a fluent builder for the DeleteWorkgroup operation.

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

    The name of the workgroup to be deleted.

    
    
• On success, responds with DeleteWorkgroupOutput with field(s):
  • workgroup(Option<Workgroup>):

    The deleted workgroup object.

• On failure, responds with SdkError<DeleteWorkgroupError>

impl Client

pub fn get_credentials(&self) -> GetCredentialsFluentBuilder

Constructs a fluent builder for the GetCredentials operation.

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

    The name of the database to get temporary authorization to log on to.

    Constraints:

    • Must be 1 to 64 alphanumeric characters or hyphens.

    • Must contain only uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    • The first character must be a letter.

    • Must not contain a colon ( : ) or slash ( / ).

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide

    
    
  • duration_seconds(i32) / set_duration_seconds(Option<i32>):
    required: false
    

    The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: false
    

    The name of the workgroup associated with the database.

    
    
  • custom_domain_name(impl Into<String>) / set_custom_domain_name(Option<String>):
    required: false
    

    The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.

    
    
• On success, responds with GetCredentialsOutput with field(s):
  • db_user(Option<String>):

    A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC.

  • db_password(Option<String>):

    A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.

  • expiration(Option<DateTime>):

    The date and time the password in DbPassword expires.

  • next_refresh_time(Option<DateTime>):

    The date and time of when the DbUser and DbPassword authorization refreshes.

• On failure, responds with SdkError<GetCredentialsError>

impl Client

pub fn get_custom_domain_association( &self, ) -> GetCustomDomainAssociationFluentBuilder

Constructs a fluent builder for the GetCustomDomainAssociation operation.

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

    The custom domain name associated with the workgroup.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: true
    

    The name of the workgroup associated with the database.

    
    
• On success, responds with GetCustomDomainAssociationOutput with field(s):
  • custom_domain_name(Option<String>):

    The custom domain name associated with the workgroup.

  • workgroup_name(Option<String>):

    The name of the workgroup associated with the database.

  • custom_domain_certificate_arn(Option<String>):

    The custom domain name’s certificate Amazon resource name (ARN).

  • custom_domain_certificate_expiry_time(Option<DateTime>):

    The expiration time for the certificate.

• On failure, responds with SdkError<GetCustomDomainAssociationError>

impl Client

pub fn get_endpoint_access(&self) -> GetEndpointAccessFluentBuilder

Constructs a fluent builder for the GetEndpointAccess operation.

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

    The name of the VPC endpoint to return information for.

    
    
• On success, responds with GetEndpointAccessOutput with field(s):
  • endpoint(Option<EndpointAccess>):

    The returned VPC endpoint.

• On failure, responds with SdkError<GetEndpointAccessError>

impl Client

pub fn get_identity_center_auth_token( &self, ) -> GetIdentityCenterAuthTokenFluentBuilder

Constructs a fluent builder for the GetIdentityCenterAuthToken operation.

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

    A list of workgroup names for which to generate the Identity Center authentication token.

    Constraints:

    • Must contain between 1 and 20 workgroup names.

    • Each workgroup name must be a valid Amazon Redshift Serverless workgroup identifier.

    • All specified workgroups must have Identity Center integration enabled.

    
    
• On success, responds with GetIdentityCenterAuthTokenOutput with field(s):
  • token(Option<String>):

    The Identity Center authentication token that can be used to access data in the specified workgroups.

    This token contains the Identity Center identity information and is encrypted for secure transmission.

  • expiration_time(Option<DateTime>):

    The date and time when the Identity Center authentication token expires.

    After this time, a new token must be requested for continued access.

• On failure, responds with SdkError<GetIdentityCenterAuthTokenError>

impl Client

pub fn get_namespace(&self) -> GetNamespaceFluentBuilder

Constructs a fluent builder for the GetNamespace operation.

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

    The name of the namespace to retrieve information for.

    
    
• On success, responds with GetNamespaceOutput with field(s):
  • namespace(Option<Namespace>):

    The returned namespace object.

• On failure, responds with SdkError<GetNamespaceError>

impl Client

pub fn get_recovery_point(&self) -> GetRecoveryPointFluentBuilder

Constructs a fluent builder for the GetRecoveryPoint operation.

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

    The unique identifier of the recovery point to return information for.

    
    
• On success, responds with GetRecoveryPointOutput with field(s):
  • recovery_point(Option<RecoveryPoint>):

    The returned recovery point object.

• On failure, responds with SdkError<GetRecoveryPointError>

impl Client

pub fn get_reservation(&self) -> GetReservationFluentBuilder

Constructs a fluent builder for the GetReservation operation.

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

    The ID of the reservation to retrieve.

    
    
• On success, responds with GetReservationOutput with field(s):
  • reservation(Option<Reservation>):

    The returned reservation object.

• On failure, responds with SdkError<GetReservationError>

impl Client

pub fn get_reservation_offering(&self) -> GetReservationOfferingFluentBuilder

Constructs a fluent builder for the GetReservationOffering operation.

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

    The identifier for the offering..

    
    
• On success, responds with GetReservationOfferingOutput with field(s):
  • reservation_offering(Option<ReservationOffering>):

    The returned reservation offering. The offering determines the payment schedule for the reservation.

• On failure, responds with SdkError<GetReservationOfferingError>

impl Client

pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder

Constructs a fluent builder for the GetResourcePolicy 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 return.

    
    
• On success, responds with GetResourcePolicyOutput with field(s):
  • resource_policy(Option<ResourcePolicy>):

    The returned resource policy.

• On failure, responds with SdkError<GetResourcePolicyError>

impl Client

pub fn get_scheduled_action(&self) -> GetScheduledActionFluentBuilder

Constructs a fluent builder for the GetScheduledAction operation.

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

    The name of the scheduled action.

    
    
• On success, responds with GetScheduledActionOutput with field(s):
  • scheduled_action(Option<ScheduledActionResponse>):

    The returned scheduled action object.

• On failure, responds with SdkError<GetScheduledActionError>

impl Client

pub fn get_snapshot(&self) -> GetSnapshotFluentBuilder

Constructs a fluent builder for the GetSnapshot operation.

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

    The name of the snapshot to return.

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: false
    

    The owner Amazon Web Services account of a snapshot shared with another user.

    
    
  • snapshot_arn(impl Into<String>) / set_snapshot_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the snapshot to return.

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

    The returned snapshot object.

• On failure, responds with SdkError<GetSnapshotError>

impl Client

pub fn get_table_restore_status(&self) -> GetTableRestoreStatusFluentBuilder

Constructs a fluent builder for the GetTableRestoreStatus operation.

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

    The ID of the RestoreTableFromSnapshot request to return status for.

    
    
• On success, responds with GetTableRestoreStatusOutput with field(s):
  • table_restore_status(Option<TableRestoreStatus>):

    The returned TableRestoreStatus object that contains information about the status of your RestoreTableFromSnapshot request.

• On failure, responds with SdkError<GetTableRestoreStatusError>

impl Client

pub fn get_track(&self) -> GetTrackFluentBuilder

Constructs a fluent builder for the GetTrack operation.

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

    The name of the track of which its version is fetched.

    
    
• On success, responds with GetTrackOutput with field(s):
  • track(Option<ServerlessTrack>):

    The version of the specified track.

• On failure, responds with SdkError<GetTrackError>

impl Client

pub fn get_usage_limit(&self) -> GetUsageLimitFluentBuilder

Constructs a fluent builder for the GetUsageLimit operation.

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

    The unique identifier of the usage limit to return information for.

    
    
• On success, responds with GetUsageLimitOutput with field(s):
  • usage_limit(Option<UsageLimit>):

    The returned usage limit object.

• On failure, responds with SdkError<GetUsageLimitError>

impl Client

pub fn get_workgroup(&self) -> GetWorkgroupFluentBuilder

Constructs a fluent builder for the GetWorkgroup operation.

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

    The name of the workgroup to return information for.

    
    
• On success, responds with GetWorkgroupOutput with field(s):
  • workgroup(Option<Workgroup>):

    The returned workgroup object.

• On failure, responds with SdkError<GetWorkgroupError>

impl Client

pub fn list_custom_domain_associations( &self, ) -> ListCustomDomainAssociationsFluentBuilder

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

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

    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.

    
    
  • 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 display the next page of results.

    
    
  • custom_domain_name(impl Into<String>) / set_custom_domain_name(Option<String>):
    required: false
    

    The custom domain name associated with the workgroup.

    
    
  • custom_domain_certificate_arn(impl Into<String>) / set_custom_domain_certificate_arn(Option<String>):
    required: false
    

    The custom domain name’s certificate Amazon resource name (ARN).

    
    
• On success, responds with ListCustomDomainAssociationsOutput with field(s):
  • 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.

  • associations(Option<Vec::<Association>>):

    A list of Association objects.

• On failure, responds with SdkError<ListCustomDomainAssociationsError>

impl Client

pub fn list_endpoint_access(&self) -> ListEndpointAccessFluentBuilder

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

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

    If your initial ListEndpointAccess operation returns a nextToken, you can include the returned nextToken in following ListEndpointAccess 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 display the next page of results.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: false
    

    The name of the workgroup associated with the VPC endpoint to return.

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

    The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: false
    

    The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.

    
    
• On success, responds with ListEndpointAccessOutput with field(s):
  • 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.

  • endpoints(Vec::<EndpointAccess>):

    The returned VPC endpoints.

• On failure, responds with SdkError<ListEndpointAccessError>

impl Client

pub fn list_managed_workgroups(&self) -> ListManagedWorkgroupsFluentBuilder

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

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

    The Amazon Resource Name (ARN) for the managed workgroup in the Glue Data Catalog.

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

    If your initial ListManagedWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListManagedWorkgroups 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 display the next page of results.

    
    
• On success, responds with ListManagedWorkgroupsOutput with field(s):
  • 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. To retrieve the next page, make the call again using the returned token.

  • managed_workgroups(Option<Vec::<ManagedWorkgroupListItem>>):

    The returned array of managed workgroups.

• On failure, responds with SdkError<ListManagedWorkgroupsError>

impl Client

pub fn list_namespaces(&self) -> ListNamespacesFluentBuilder

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

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

    If your initial ListNamespaces operation returns a nextToken, you can include the returned nextToken in following ListNamespaces 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 display the next page of results.

    
    
• On success, responds with ListNamespacesOutput with field(s):
  • 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.

  • namespaces(Vec::<Namespace>):

    The list of returned namespaces.

• On failure, responds with SdkError<ListNamespacesError>

impl Client

pub fn list_recovery_points(&self) -> ListRecoveryPointsFluentBuilder

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

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

    If your initial ListRecoveryPoints operation returns a nextToken, you can include the returned nextToken in following ListRecoveryPoints 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 display the next page of results.

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

    The time when the recovery point’s creation was initiated.

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

    The time when creation of the recovery point finished.

    
    
  • namespace_name(impl Into<String>) / set_namespace_name(Option<String>):
    required: false
    

    The name of the namespace to list recovery points for.

    
    
  • namespace_arn(impl Into<String>) / set_namespace_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the namespace from which to list recovery points.

    
    
• On success, responds with ListRecoveryPointsOutput with field(s):
  • recovery_points(Option<Vec::<RecoveryPoint>>):

    The returned recovery point objects.

  • 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.

• On failure, responds with SdkError<ListRecoveryPointsError>

impl Client

pub fn list_reservation_offerings( &self, ) -> ListReservationOfferingsFluentBuilder

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

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

    The token for the next set of items to return. (You received this token from a previous call.)

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

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with ListReservationOfferingsOutput with field(s):
  • reservation_offerings_list(Vec::<ReservationOffering>):

    The returned list of reservation offerings.

  • next_token(Option<String>):

    The token to use when requesting the next set of items.

• On failure, responds with SdkError<ListReservationOfferingsError>

impl Client

pub fn list_reservations(&self) -> ListReservationsFluentBuilder

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

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

    The token for the next set of items to return. (You received this token from a previous call.)

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

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    
    
• On success, responds with ListReservationsOutput with field(s):
  • reservations_list(Vec::<Reservation>):

    The serverless reservations returned by the request.

  • next_token(Option<String>):

    The token to use when requesting the next set of items.

• On failure, responds with SdkError<ListReservationsError>

impl Client

pub fn list_scheduled_actions(&self) -> ListScheduledActionsFluentBuilder

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

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

    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.

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

    An optional parameter that specifies the maximum number of results to return. Use nextToken to display the next page of results.

    
    
  • namespace_name(impl Into<String>) / set_namespace_name(Option<String>):
    required: false
    

    The name of namespace associated with the scheduled action to retrieve.

    
    
• On success, responds with ListScheduledActionsOutput with field(s):
  • 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.

  • scheduled_actions(Option<Vec::<ScheduledActionAssociation>>):

    All of the returned scheduled action association objects.

• On failure, responds with SdkError<ListScheduledActionsError>

impl Client

pub fn list_snapshot_copy_configurations( &self, ) -> ListSnapshotCopyConfigurationsFluentBuilder

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

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

    The namespace from which to list all snapshot copy configurations.

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

    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.

    
    
  • 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 display the next page of results.

    
    
• On success, responds with ListSnapshotCopyConfigurationsOutput with field(s):
  • 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.

  • snapshot_copy_configurations(Vec::<SnapshotCopyConfiguration>):

    All of the returned snapshot copy configurations.

• On failure, responds with SdkError<ListSnapshotCopyConfigurationsError>

impl Client

pub fn list_snapshots(&self) -> ListSnapshotsFluentBuilder

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

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

    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.

    
    
  • 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 display the next page of results.

    
    
  • namespace_name(impl Into<String>) / set_namespace_name(Option<String>):
    required: false
    

    The namespace from which to list all snapshots.

    
    
  • namespace_arn(impl Into<String>) / set_namespace_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: false
    

    The owner Amazon Web Services account of the snapshot.

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

    The time when the creation of the snapshot was initiated.

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

    The timestamp showing when the snapshot creation finished.

    
    
• On success, responds with ListSnapshotsOutput with field(s):
  • 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.

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

    All of the returned snapshot objects.

• On failure, responds with SdkError<ListSnapshotsError>

impl Client

pub fn list_table_restore_status(&self) -> ListTableRestoreStatusFluentBuilder

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

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

    If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will return results on 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 display the next page of results.

    
    
  • namespace_name(impl Into<String>) / set_namespace_name(Option<String>):
    required: false
    

    The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: false
    

    The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.

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

    If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will returns results on the next page.

  • table_restore_statuses(Option<Vec::<TableRestoreStatus>>):

    The array of returned TableRestoreStatus objects.

• On failure, responds with SdkError<ListTableRestoreStatusError>

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 to list tags for.

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

    A map of the key-value pairs assigned to the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_tracks(&self) -> ListTracksFluentBuilder

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

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

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

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

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    
    
• On success, responds with ListTracksOutput with field(s):
  • tracks(Option<Vec::<ServerlessTrack>>):

    The returned tracks.

  • 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<ListTracksError>

impl Client

pub fn list_usage_limits(&self) -> ListUsageLimitsFluentBuilder

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

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

    The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.

    
    
  • usage_type(UsageLimitUsageType) / set_usage_type(Option<UsageLimitUsageType>):
    required: false
    

    The Amazon Redshift Serverless feature whose limits you want to see.

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

    If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in following ListUsageLimits 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 100.

    
    
• On success, responds with ListUsageLimitsOutput with field(s):
  • usage_limits(Option<Vec::<UsageLimit>>):

    An array of returned usage limit objects.

  • 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<ListUsageLimitsError>

impl Client

pub fn list_workgroups(&self) -> ListWorkgroupsFluentBuilder

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

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

    If your initial ListWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListNamespaces 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 display the next page of results.

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: false
    

    The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.

    
    
• On success, responds with ListWorkgroupsOutput with field(s):
  • 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. To retrieve the next page, make the call again using the returned token.

  • workgroups(Vec::<Workgroup>):

    The returned array of workgroups.

• On failure, responds with SdkError<ListWorkgroupsError>

impl Client

pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder

Constructs a fluent builder for the PutResourcePolicy 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 account to create or update a resource policy for.

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

    The policy to create or update. For example, the following policy grants a user authorization to restore a snapshot.

    “{"Version": "2012-10-17", "Statement" : [{ "Sid": "AllowUserRestoreFromSnapshot", "Principal":{"AWS": ["739247239426"]}, "Action": ["redshift-serverless:RestoreFromSnapshot"] , "Effect": "Allow" }]}”

    
    
• On success, responds with PutResourcePolicyOutput with field(s):
  • resource_policy(Option<ResourcePolicy>):

    The policy that was created or updated.

• On failure, responds with SdkError<PutResourcePolicyError>

impl Client

pub fn restore_from_recovery_point( &self, ) -> RestoreFromRecoveryPointFluentBuilder

Constructs a fluent builder for the RestoreFromRecoveryPoint operation.

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

    The unique identifier of the recovery point to restore from.

    
    
  • namespace_name(impl Into<String>) / set_namespace_name(Option<String>):
    required: true
    

    The name of the namespace to restore data into.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: true
    

    The name of the workgroup used to restore data.

    
    
• On success, responds with RestoreFromRecoveryPointOutput with field(s):
  • recovery_point_id(Option<String>):

    The unique identifier of the recovery point used for the restore.

  • namespace(Option<Namespace>):

    The namespace that data was restored into.

• On failure, responds with SdkError<RestoreFromRecoveryPointError>

impl Client

pub fn restore_from_snapshot(&self) -> RestoreFromSnapshotFluentBuilder

Constructs a fluent builder for the RestoreFromSnapshot operation.

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

    The name of the namespace to restore the snapshot to.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: true
    

    The name of the workgroup used to restore the snapshot.

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

    The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.

    
    
  • snapshot_arn(impl Into<String>) / set_snapshot_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from a provisioned cluster to Amazon Redshift Serverless. Must not be specified at the same time as snapshotName.

    The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: false
    

    The Amazon Web Services account that owns the snapshot.

    
    
  • manage_admin_password(bool) / set_manage_admin_password(Option<bool>):
    required: false
    

    If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot’s admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.

    
    
  • admin_password_secret_kms_key_id(impl Into<String>) / set_admin_password_secret_kms_key_id(Option<String>):
    required: false
    

    The ID of the Key Management Service (KMS) key used to encrypt and store the namespace’s admin credentials secret.

    
    
• On success, responds with RestoreFromSnapshotOutput with field(s):
  • snapshot_name(Option<String>):

    The name of the snapshot used to restore the namespace.

  • owner_account(Option<String>):

    The owner Amazon Web Services; account of the snapshot that was restored.

  • namespace(Option<Namespace>):

    A collection of database objects and users.

• On failure, responds with SdkError<RestoreFromSnapshotError>

impl Client

pub fn restore_table_from_recovery_point( &self, ) -> RestoreTableFromRecoveryPointFluentBuilder

Constructs a fluent builder for the RestoreTableFromRecoveryPoint operation.

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

    Namespace of the recovery point to restore from.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: true
    

    The workgroup to restore the table to.

    
    
  • recovery_point_id(impl Into<String>) / set_recovery_point_id(Option<String>):
    required: true
    

    The ID of the recovery point to restore the table from.

    
    
  • source_database_name(impl Into<String>) / set_source_database_name(Option<String>):
    required: true
    

    The name of the source database that contains the table being restored.

    
    
  • source_schema_name(impl Into<String>) / set_source_schema_name(Option<String>):
    required: false
    

    The name of the source schema that contains the table being restored.

    
    
  • source_table_name(impl Into<String>) / set_source_table_name(Option<String>):
    required: true
    

    The name of the source table being restored.

    
    
  • target_database_name(impl Into<String>) / set_target_database_name(Option<String>):
    required: false
    

    The name of the database to restore the table to.

    
    
  • target_schema_name(impl Into<String>) / set_target_schema_name(Option<String>):
    required: false
    

    The name of the schema to restore the table to.

    
    
  • new_table_name(impl Into<String>) / set_new_table_name(Option<String>):
    required: true
    

    The name of the table to create from the restore operation.

    
    
  • activate_case_sensitive_identifier(bool) / set_activate_case_sensitive_identifier(Option<bool>):
    required: false
    

    Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.

    
    
• On success, responds with RestoreTableFromRecoveryPointOutput with field(s):
  • table_restore_status(Option<TableRestoreStatus>):

    Contains information about a table restore request.

• On failure, responds with SdkError<RestoreTableFromRecoveryPointError>

impl Client

pub fn restore_table_from_snapshot( &self, ) -> RestoreTableFromSnapshotFluentBuilder

Constructs a fluent builder for the RestoreTableFromSnapshot operation.

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

    The namespace of the snapshot to restore from.

    
    
  • workgroup_name(impl Into<String>) / set_workgroup_name(Option<String>):
    required: true
    

    The workgroup to restore the table to.

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

    The name of the snapshot to restore the table from.

    
    
  • source_database_name(impl Into<String>) / set_source_database_name(Option<String>):
    required: true
    

    The name of the source database that contains the table being restored.

    
    
  • source_schema_name(impl Into<String>) / set_source_schema_name(Option<String>):
    required: false
    

    The name of the source schema that contains the table being restored.

    
    
  • source_table_name(impl Into<String>) / set_source_table_name(Option<String>):
    required: true
    

    The name of the source table being restored.

    
    
  • target_database_name(impl Into<String>) / set_target_database_name(Option<String>):
    required: false
    

    The name of the database to restore the table to.

    
    
  • target_schema_name(impl Into<String>) / set_target_schema_name(Option<String>):
    required: false
    

    The name of the schema to restore the table to.

    
    
  • new_table_name(impl Into<String>) / set_new_table_name(Option<String>):
    required: true
    

    The name of the table to create from the restore operation.

    
    
  • activate_case_sensitive_identifier(bool) / set_activate_case_sensitive_identifier(Option<bool>):
    required: false
    

    Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.

    
    
• On success, responds with RestoreTableFromSnapshotOutput with field(s):
  • table_restore_status(Option<TableRestoreStatus>):

    The TableRestoreStatus object that contains the status of the restore operation.

• On failure, responds with SdkError<RestoreTableFromSnapshotError>

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 tag.

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

    The map of the key-value pairs used to tag the resource.

    
    
• 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.

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

    The tag or set of tags to remove from the resource.

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

impl Client

pub fn update_custom_domain_association( &self, ) -> UpdateCustomDomainAssociationFluentBuilder

Constructs a fluent builder for the UpdateCustomDomainAssociation operation.

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

    The name of the workgroup associated with the database.

    
    
  • custom_domain_name(impl Into<String>) / set_custom_domain_name(Option<String>):
    required: true
    

    The custom domain name associated with the workgroup.

    
    
  • custom_domain_certificate_arn(impl Into<String>) / set_custom_domain_certificate_arn(Option<String>):
    required: true
    

    The custom domain name’s certificate Amazon resource name (ARN). This is optional.

    
    
• On success, responds with UpdateCustomDomainAssociationOutput with field(s):
  • custom_domain_name(Option<String>):

    The custom domain name associated with the workgroup.

  • workgroup_name(Option<String>):

    The name of the workgroup associated with the database.

  • custom_domain_certificate_arn(Option<String>):

    The custom domain name’s certificate Amazon resource name (ARN).

  • custom_domain_certificate_expiry_time(Option<DateTime>):

    The expiration time for the certificate.

• On failure, responds with SdkError<UpdateCustomDomainAssociationError>

impl Client

pub fn update_endpoint_access(&self) -> UpdateEndpointAccessFluentBuilder

Constructs a fluent builder for the UpdateEndpointAccess operation.

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

    The name of the VPC endpoint to update.

    
    
  • vpc_security_group_ids(impl Into<String>) / set_vpc_security_group_ids(Option<Vec::<String>>):
    required: false
    

    The list of VPC security groups associated with the endpoint after the endpoint is modified.

    
    
• On success, responds with UpdateEndpointAccessOutput with field(s):
  • endpoint(Option<EndpointAccess>):

    The updated VPC endpoint.

• On failure, responds with SdkError<UpdateEndpointAccessError>

impl Client

pub fn update_lakehouse_configuration( &self, ) -> UpdateLakehouseConfigurationFluentBuilder

Constructs a fluent builder for the UpdateLakehouseConfiguration operation.

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

    The name of the namespace whose lakehouse configuration you want to modify.

    
    
  • lakehouse_registration(LakehouseRegistration) / set_lakehouse_registration(Option<LakehouseRegistration>):
    required: false
    

    Specifies whether to register or deregister the namespace with Amazon Redshift federated permissions. Valid values are Register or Deregister.

    
    
  • catalog_name(impl Into<String>) / set_catalog_name(Option<String>):
    required: false
    

    The name of the Glue Data Catalog that will be associated with the namespace enabled with Amazon Redshift federated permissions.

    Pattern: ^[a-z0-9_-][a-z]+[a-z0-9_-]$

    
    
  • lakehouse_idc_registration(LakehouseIdcRegistration) / set_lakehouse_idc_registration(Option<LakehouseIdcRegistration>):
    required: false
    

    Modifies the Amazon Web Services IAM Identity Center trusted identity propagation on a namespace enabled with Amazon Redshift federated permissions. Valid values are Associate or Disassociate.

    
    
  • lakehouse_idc_application_arn(impl Into<String>) / set_lakehouse_idc_application_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation on a namespace enabled with Amazon Redshift federated permissions.

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

    A boolean value that, if true, validates the request without actually updating the lakehouse configuration. Use this to check for errors before making changes.

    
    
• On success, responds with UpdateLakehouseConfigurationOutput with field(s):
  • namespace_name(Option<String>):

    The name of the namespace.

  • lakehouse_idc_application_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation.

  • lakehouse_registration_status(Option<String>):

    The current status of the lakehouse registration. Indicates whether the namespace is successfully registered with Amazon Redshift federated permissions.

  • catalog_arn(Option<String>):

    The Amazon Resource Name (ARN) of the Glue Data Catalog associated with the lakehouse configuration.

• On failure, responds with SdkError<UpdateLakehouseConfigurationError>

impl Client

pub fn update_namespace(&self) -> UpdateNamespaceFluentBuilder

Constructs a fluent builder for the UpdateNamespace operation.

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

    The name of the namespace to update. You can’t update the name of a namespace once it is created.

    
    
  • admin_user_password(impl Into<String>) / set_admin_user_password(Option<String>):
    required: false
    

    The password of the administrator for the first database created in the namespace. This parameter must be updated together with adminUsername.

    You can’t use adminUserPassword if manageAdminPassword is true.

    
    
  • admin_username(impl Into<String>) / set_admin_username(Option<String>):
    required: false
    

    The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.

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

    The ID of the Amazon Web Services Key Management Service key used to encrypt your data.

    
    
  • default_iam_role_arn(impl Into<String>) / set_default_iam_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together with iamRoles.

    
    
  • iam_roles(impl Into<String>) / set_iam_roles(Option<Vec::<String>>):
    required: false
    

    A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.

    
    
  • log_exports(LogExport) / set_log_exports(Option<Vec::<LogExport>>):
    required: false
    

    The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.

    
    
  • manage_admin_password(bool) / set_manage_admin_password(Option<bool>):
    required: false
    

    If true, Amazon Redshift uses Secrets Manager to manage the namespace’s admin credentials. You can’t use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account’s password.

    
    
  • admin_password_secret_kms_key_id(impl Into<String>) / set_admin_password_secret_kms_key_id(Option<String>):
    required: false
    

    The ID of the Key Management Service (KMS) key used to encrypt and store the namespace’s admin credentials secret. You can only use this parameter if manageAdminPassword is true.

    
    
• On success, responds with UpdateNamespaceOutput with field(s):
  • namespace(Option<Namespace>):

    A list of tag instances.

• On failure, responds with SdkError<UpdateNamespaceError>

impl Client

pub fn update_scheduled_action(&self) -> UpdateScheduledActionFluentBuilder

Constructs a fluent builder for the UpdateScheduledAction operation.

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

    The name of the scheduled action to update to.

    
    
  • target_action(TargetAction) / set_target_action(Option<TargetAction>):
    required: false
    

    A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.

    “{“CreateSnapshot”: {“NamespaceName”: “sampleNamespace”,“SnapshotName”: “sampleSnapshot”, “retentionPeriod”: “1”}}“

    
    
  • schedule(Schedule) / set_schedule(Option<Schedule>):
    required: false
    

    The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

    • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

    • Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, “(0 10 ? * MON *)”. For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: false
    

    Specifies whether to enable the scheduled action.

    
    
  • scheduled_action_description(impl Into<String>) / set_scheduled_action_description(Option<String>):
    required: false
    

    The descripion of the scheduled action to update to.

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

    The start time in UTC of the scheduled action to update to.

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

    The end time in UTC of the scheduled action to update.

    
    
• On success, responds with UpdateScheduledActionOutput with field(s):
  • scheduled_action(Option<ScheduledActionResponse>):

    The ScheduledAction object that was updated.

• On failure, responds with SdkError<UpdateScheduledActionError>

impl Client

pub fn update_snapshot(&self) -> UpdateSnapshotFluentBuilder

Constructs a fluent builder for the UpdateSnapshot operation.

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

    The name of the snapshot.

    
    
  • retention_period(i32) / set_retention_period(Option<i32>):
    required: false
    

    The new retention period of the snapshot.

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

    The updated snapshot object.

• On failure, responds with SdkError<UpdateSnapshotError>

impl Client

pub fn update_snapshot_copy_configuration( &self, ) -> UpdateSnapshotCopyConfigurationFluentBuilder

Constructs a fluent builder for the UpdateSnapshotCopyConfiguration operation.

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

    The ID of the snapshot copy configuration to update.

    
    
  • snapshot_retention_period(i32) / set_snapshot_retention_period(Option<i32>):
    required: false
    

    The new retention period of how long to keep a snapshot in the destination Amazon Web Services Region.

    
    
• On success, responds with UpdateSnapshotCopyConfigurationOutput with field(s):
  • snapshot_copy_configuration(Option<SnapshotCopyConfiguration>):

    The updated snapshot copy configuration object.

• On failure, responds with SdkError<UpdateSnapshotCopyConfigurationError>

impl Client

pub fn update_usage_limit(&self) -> UpdateUsageLimitFluentBuilder

Constructs a fluent builder for the UpdateUsageLimit operation.

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

    The identifier of the usage limit to update.

    
    
  • amount(i64) / set_amount(Option<i64>):
    required: false
    

    The new limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.

    
    
  • breach_action(UsageLimitBreachAction) / set_breach_action(Option<UsageLimitBreachAction>):
    required: false
    

    The new action that Amazon Redshift Serverless takes when the limit is reached.

    
    
• On success, responds with UpdateUsageLimitOutput with field(s):
  • usage_limit(Option<UsageLimit>):

    The updated usage limit object.

• On failure, responds with SdkError<UpdateUsageLimitError>

impl Client

pub fn update_workgroup(&self) -> UpdateWorkgroupFluentBuilder

Constructs a fluent builder for the UpdateWorkgroup operation.

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

    The name of the workgroup to update. You can’t update the name of a workgroup once it is created.

    
    
  • base_capacity(i32) / set_base_capacity(Option<i32>):
    required: false
    

    The new base data warehouse capacity in Redshift Processing Units (RPUs).

    
    
  • enhanced_vpc_routing(bool) / set_enhanced_vpc_routing(Option<bool>):
    required: false
    

    The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

    
    
  • config_parameters(ConfigParameter) / set_config_parameters(Option<Vec::<ConfigParameter>>):
    required: false
    

    An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

    
    
  • publicly_accessible(bool) / set_publicly_accessible(Option<bool>):
    required: false
    

    A value that specifies whether the workgroup can be accessible from a public network.

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

    An array of VPC subnet IDs to associate with the workgroup.

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

    An array of security group IDs to associate with the workgroup.

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

    The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.

    
    
  • max_capacity(i32) / set_max_capacity(Option<i32>):
    required: false
    

    The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.

    
    
  • ip_address_type(impl Into<String>) / set_ip_address_type(Option<String>):
    required: false
    

    The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.

    
    
  • price_performance_target(PerformanceTarget) / set_price_performance_target(Option<PerformanceTarget>):
    required: false
    

    An object that represents the price performance target settings for the workgroup.

    
    
  • track_name(impl Into<String>) / set_track_name(Option<String>):
    required: false
    

    An optional parameter for the name of the track for the workgroup. If you don’t provide a track name, the workgroup is assigned to the current track.

    
    
• On success, responds with UpdateWorkgroupOutput with field(s):
  • workgroup(Option<Workgroup>):

    The updated workgroup object.

• On failure, responds with SdkError<UpdateWorkgroupError>

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 duplicate 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.