pub struct Client { /* private fields */ }
Expand description
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§
Source§impl Client
impl Client
Sourcepub fn convert_recovery_point_to_snapshot(
&self,
) -> ConvertRecoveryPointToSnapshotFluentBuilder
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: trueThe unique identifier of the recovery point.
snapshot_name(impl Into<String>)
/set_snapshot_name(Option<String>)
:
required: trueThe name of the snapshot.
retention_period(i32)
/set_retention_period(Option<i32>)
:
required: falseHow long to retain the snapshot.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn create_custom_domain_association(
&self,
) -> CreateCustomDomainAssociationFluentBuilder
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: trueThe name of the workgroup associated with the database.
custom_domain_name(impl Into<String>)
/set_custom_domain_name(Option<String>)
:
required: trueThe custom domain name to associate with the workgroup.
custom_domain_certificate_arn(impl Into<String>)
/set_custom_domain_certificate_arn(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn create_endpoint_access(&self) -> CreateEndpointAccessFluentBuilder
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: trueThe 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: trueThe 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: trueThe 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: falseThe 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: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn create_namespace(&self) -> CreateNamespaceFluentBuilder
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: trueThe name of the namespace.
admin_username(impl Into<String>)
/set_admin_username(Option<String>)
:
required: falseThe 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: falseThe password of the administrator for the first database created in the namespace.
You can’t use
adminUserPassword
ifmanageAdminPassword
is true.db_name(impl Into<String>)
/set_db_name(Option<String>)
:
required: falseThe name of the first database created in the namespace.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseThe 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: falseThe 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: falseA list of IAM roles to associate with the namespace.
log_exports(LogExport)
/set_log_exports(Option<Vec::<LogExport>>)
:
required: falseThe types of logs the namespace can export. Available export types are
userlog
,connectionlog
, anduseractivitylog
.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of tag instances.
manage_admin_password(bool)
/set_manage_admin_password(Option<bool>)
:
required: falseIf
true
, Amazon Redshift uses Secrets Manager to manage the namespace’s admin credentials. You can’t useadminUserPassword
ifmanageAdminPassword
is true. IfmanageAdminPassword
is false or not set, Amazon Redshift usesadminUserPassword
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: falseThe 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: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn create_reservation(&self) -> CreateReservationFluentBuilder
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: trueThe number of Redshift Processing Units (RPUs) to reserve.
offering_id(impl Into<String>)
/set_offering_id(Option<String>)
:
required: trueThe 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: falseA 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>
Source§impl Client
impl Client
Sourcepub fn create_scheduled_action(&self) -> CreateScheduledActionFluentBuilder
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: trueThe name of the scheduled action.
target_action(TargetAction)
/set_target_action(Option<TargetAction>)
:
required: trueA 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: trueThe 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: trueThe 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: trueThe name of the namespace for which to create a scheduled action.
enabled(bool)
/set_enabled(Option<bool>)
:
required: falseIndicates 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: falseThe description of the scheduled action.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:
required: falseThe 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: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn create_snapshot(&self) -> CreateSnapshotFluentBuilder
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: trueThe namespace to create a snapshot for.
snapshot_name(impl Into<String>)
/set_snapshot_name(Option<String>)
:
required: trueThe name of the snapshot.
retention_period(i32)
/set_retention_period(Option<i32>)
:
required: falseHow long to retain the created snapshot.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn create_snapshot_copy_configuration(
&self,
) -> CreateSnapshotCopyConfigurationFluentBuilder
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: trueThe name of the namespace to copy snapshots from.
destination_region(impl Into<String>)
/set_destination_region(Option<String>)
:
required: trueThe destination Amazon Web Services Region that you want to copy snapshots to.
snapshot_retention_period(i32)
/set_snapshot_retention_period(Option<i32>)
:
required: falseThe 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: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn create_usage_limit(&self) -> CreateUsageLimitFluentBuilder
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: trueThe 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: trueThe type of Amazon Redshift Serverless usage to create a usage limit for.
amount(i64)
/set_amount(Option<i64>)
:
required: trueThe 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: falseThe 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: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn create_workgroup(&self) -> CreateWorkgroupFluentBuilder
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: trueThe name of the created workgroup.
namespace_name(impl Into<String>)
/set_namespace_name(Option<String>)
:
required: trueThe name of the namespace to associate with the workgroup.
base_capacity(i32)
/set_base_capacity(Option<i32>)
:
required: falseThe base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
enhanced_vpc_routing(bool)
/set_enhanced_vpc_routing(Option<bool>)
:
required: falseThe 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: falseAn 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: falseAn array of security group IDs to associate with the workgroup.
subnet_ids(impl Into<String>)
/set_subnet_ids(Option<Vec::<String>>)
:
required: falseAn array of VPC subnet IDs to associate with the workgroup.
publicly_accessible(bool)
/set_publicly_accessible(Option<bool>)
:
required: falseA value that specifies whether the workgroup can be accessed from a public network.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA array of tag instances.
port(i32)
/set_port(Option<i32>)
:
required: falseThe 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: falseThe 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: falseAn object that represents the price performance target settings for the workgroup.
ip_address_type(impl Into<String>)
/set_ip_address_type(Option<String>)
:
required: falseThe IP address type that the workgroup supports. Possible values are
ipv4
anddualstack
.track_name(impl Into<String>)
/set_track_name(Option<String>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn delete_custom_domain_association(
&self,
) -> DeleteCustomDomainAssociationFluentBuilder
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: trueThe name of the workgroup associated with the database.
custom_domain_name(impl Into<String>)
/set_custom_domain_name(Option<String>)
:
required: trueThe custom domain name associated with the workgroup.
- On success, responds with
DeleteCustomDomainAssociationOutput
- On failure, responds with
SdkError<DeleteCustomDomainAssociationError>
Source§impl Client
impl Client
Sourcepub fn delete_endpoint_access(&self) -> DeleteEndpointAccessFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn delete_namespace(&self) -> DeleteNamespaceFluentBuilder
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: trueThe name of the namespace to delete.
final_snapshot_name(impl Into<String>)
/set_final_snapshot_name(Option<String>)
:
required: falseThe 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: falseHow 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>
Source§impl Client
impl Client
Sourcepub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder
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: trueThe Amazon Resource Name (ARN) of the policy to delete.
- On success, responds with
DeleteResourcePolicyOutput
- On failure, responds with
SdkError<DeleteResourcePolicyError>
Source§impl Client
impl Client
Sourcepub fn delete_scheduled_action(&self) -> DeleteScheduledActionFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn delete_snapshot(&self) -> DeleteSnapshotFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn delete_snapshot_copy_configuration(
&self,
) -> DeleteSnapshotCopyConfigurationFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn delete_usage_limit(&self) -> DeleteUsageLimitFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn delete_workgroup(&self) -> DeleteWorkgroupFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_credentials(&self) -> GetCredentialsFluentBuilder
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: falseThe 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: falseThe 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: falseThe name of the workgroup associated with the database.
custom_domain_name(impl Into<String>)
/set_custom_domain_name(Option<String>)
:
required: falseThe 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 passwordDbPassword
. If the specifiedDbUser
exists in the database, the new user name has the same database privileges as the the user named inDbUser
. 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 databaseDbName
.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
andDbPassword
authorization refreshes.
- On failure, responds with
SdkError<GetCredentialsError>
Source§impl Client
impl Client
Sourcepub fn get_custom_domain_association(
&self,
) -> GetCustomDomainAssociationFluentBuilder
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: trueThe custom domain name associated with the workgroup.
workgroup_name(impl Into<String>)
/set_workgroup_name(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_endpoint_access(&self) -> GetEndpointAccessFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_namespace(&self) -> GetNamespaceFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_recovery_point(&self) -> GetRecoveryPointFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_reservation(&self) -> GetReservationFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_reservation_offering(&self) -> GetReservationOfferingFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_scheduled_action(&self) -> GetScheduledActionFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_snapshot(&self) -> GetSnapshotFluentBuilder
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: falseThe name of the snapshot to return.
owner_account(impl Into<String>)
/set_owner_account(Option<String>)
:
required: falseThe owner Amazon Web Services account of a snapshot shared with another user.
snapshot_arn(impl Into<String>)
/set_snapshot_arn(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn get_table_restore_status(&self) -> GetTableRestoreStatusFluentBuilder
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: trueThe 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 yourRestoreTableFromSnapshot
request.
- On failure, responds with
SdkError<GetTableRestoreStatusError>
Source§impl Client
impl Client
Sourcepub fn get_track(&self) -> GetTrackFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_usage_limit(&self) -> GetUsageLimitFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn get_workgroup(&self) -> GetWorkgroupFluentBuilder
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: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn list_custom_domain_associations(
&self,
) -> ListCustomDomainAssociationsFluentBuilder
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: falseWhen
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseAn 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: falseThe custom domain name associated with the workgroup.
custom_domain_certificate_arn(impl Into<String>)
/set_custom_domain_certificate_arn(Option<String>)
:
required: falseThe 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 ofnextToken
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>
Source§impl Client
impl Client
Sourcepub fn list_endpoint_access(&self) -> ListEndpointAccessFluentBuilder
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: falseIf your initial
ListEndpointAccess
operation returns anextToken
, you can include the returnednextToken
in followingListEndpointAccess
operations, which returns results in the next page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseAn 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: falseThe name of the workgroup associated with the VPC endpoint to return.
vpc_id(impl Into<String>)
/set_vpc_id(Option<String>)
:
required: falseThe unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.
owner_account(impl Into<String>)
/set_owner_account(Option<String>)
:
required: falseThe 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 ofnextToken
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>
Source§impl Client
impl Client
Sourcepub fn list_managed_workgroups(&self) -> ListManagedWorkgroupsFluentBuilder
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: falseThe Amazon Resource Name (ARN) for the managed workgroup in the AWS Glue Data Catalog.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf 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: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn list_namespaces(&self) -> ListNamespacesFluentBuilder
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: falseIf your initial
ListNamespaces
operation returns anextToken
, you can include the returnednextToken
in followingListNamespaces
operations, which returns results in the next page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseAn 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 ofnextToken
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>
Source§impl Client
impl Client
Sourcepub fn list_recovery_points(&self) -> ListRecoveryPointsFluentBuilder
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: falseIf your initial
ListRecoveryPoints
operation returns anextToken
, you can include the returnednextToken
in followingListRecoveryPoints
operations, which returns results in the next page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseAn 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: falseThe time when the recovery point’s creation was initiated.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:
required: falseThe time when creation of the recovery point finished.
namespace_name(impl Into<String>)
/set_namespace_name(Option<String>)
:
required: falseThe name of the namespace to list recovery points for.
namespace_arn(impl Into<String>)
/set_namespace_arn(Option<String>)
:
required: falseThe 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 ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
- On failure, responds with
SdkError<ListRecoveryPointsError>
Source§impl Client
impl Client
Sourcepub fn list_reservation_offerings(
&self,
) -> ListReservationOfferingsFluentBuilder
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: falseThe 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: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_reservations(&self) -> ListReservationsFluentBuilder
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: falseThe 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: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_scheduled_actions(&self) -> ListScheduledActionsFluentBuilder
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: falseIf
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseAn 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: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_snapshot_copy_configurations(
&self,
) -> ListSnapshotCopyConfigurationsFluentBuilder
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: falseThe namespace from which to list all snapshot copy configurations.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseAn 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 ofnextToken
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>
Source§impl Client
impl Client
Sourcepub fn list_snapshots(&self) -> ListSnapshotsFluentBuilder
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: falseIf
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseAn 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: falseThe namespace from which to list all snapshots.
namespace_arn(impl Into<String>)
/set_namespace_arn(Option<String>)
:
required: falseThe Amazon Resource Name (ARN) of the namespace from which to list all snapshots.
owner_account(impl Into<String>)
/set_owner_account(Option<String>)
:
required: falseThe owner Amazon Web Services account of the snapshot.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:
required: falseThe time when the creation of the snapshot was initiated.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:
required: falseThe 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 ofnextToken
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>
Source§impl Client
impl Client
Sourcepub fn list_table_restore_status(&self) -> ListTableRestoreStatusFluentBuilder
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: falseIf your initial
ListTableRestoreStatus
operation returns a nextToken, you can include the returnednextToken
in followingListTableRestoreStatus
operations. This will return results on the next page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseAn 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: falseThe namespace from which to list all of the statuses of
RestoreTableFromSnapshot
operations .workgroup_name(impl Into<String>)
/set_workgroup_name(Option<String>)
:
required: falseThe 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 anextToken
, you can include the returnednextToken
in followingListTableRestoreStatus
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>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn list_tracks(&self) -> ListTracksFluentBuilder
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: falseIf your initial
ListTracksRequest
operation returns anextToken
, you can include the returnednextToken
in followingListTracksRequest
operations, which returns results in the next page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe 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 ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
- On failure, responds with
SdkError<ListTracksError>
Source§impl Client
impl Client
Sourcepub fn list_usage_limits(&self) -> ListUsageLimitsFluentBuilder
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: falseThe Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.
usage_type(UsageLimitUsageType)
/set_usage_type(Option<UsageLimitUsageType>)
:
required: falseThe Amazon Redshift Serverless feature whose limits you want to see.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf your initial
ListUsageLimits
operation returns anextToken
, you can include the returnednextToken
in followingListUsageLimits
operations, which returns results in the next page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseAn 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 ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
- On failure, responds with
SdkError<ListUsageLimitsError>
Source§impl Client
impl Client
Sourcepub fn list_workgroups(&self) -> ListWorkgroupsFluentBuilder
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: falseIf your initial ListWorkgroups operation returns a
nextToken
, you can include the returnednextToken
in following ListNamespaces operations, which returns results in the next page.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseAn 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: falseThe 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 ofnextToken
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>
Source§impl Client
impl Client
Sourcepub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder
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: trueThe Amazon Resource Name (ARN) of the account to create or update a resource policy for.
policy(impl Into<String>)
/set_policy(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn restore_from_recovery_point(
&self,
) -> RestoreFromRecoveryPointFluentBuilder
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: trueThe unique identifier of the recovery point to restore from.
namespace_name(impl Into<String>)
/set_namespace_name(Option<String>)
:
required: trueThe name of the namespace to restore data into.
workgroup_name(impl Into<String>)
/set_workgroup_name(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn restore_from_snapshot(&self) -> RestoreFromSnapshotFluentBuilder
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: trueThe name of the namespace to restore the snapshot to.
workgroup_name(impl Into<String>)
/set_workgroup_name(Option<String>)
:
required: trueThe name of the workgroup used to restore the snapshot.
snapshot_name(impl Into<String>)
/set_snapshot_name(Option<String>)
:
required: falseThe 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: falseThe 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: falseThe Amazon Web Services account that owns the snapshot.
manage_admin_password(bool)
/set_manage_admin_password(Option<bool>)
:
required: falseIf
true
, Amazon Redshift uses Secrets Manager to manage the restored snapshot’s admin credentials. IfMmanageAdminPassword
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: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn restore_table_from_recovery_point(
&self,
) -> RestoreTableFromRecoveryPointFluentBuilder
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: trueNamespace of the recovery point to restore from.
workgroup_name(impl Into<String>)
/set_workgroup_name(Option<String>)
:
required: trueThe workgroup to restore the table to.
recovery_point_id(impl Into<String>)
/set_recovery_point_id(Option<String>)
:
required: trueThe ID of the recovery point to restore the table from.
source_database_name(impl Into<String>)
/set_source_database_name(Option<String>)
:
required: trueThe name of the source database that contains the table being restored.
source_schema_name(impl Into<String>)
/set_source_schema_name(Option<String>)
:
required: falseThe name of the source schema that contains the table being restored.
source_table_name(impl Into<String>)
/set_source_table_name(Option<String>)
:
required: trueThe name of the source table being restored.
target_database_name(impl Into<String>)
/set_target_database_name(Option<String>)
:
required: falseThe name of the database to restore the table to.
target_schema_name(impl Into<String>)
/set_target_schema_name(Option<String>)
:
required: falseThe name of the schema to restore the table to.
new_table_name(impl Into<String>)
/set_new_table_name(Option<String>)
:
required: trueThe name of the table to create from the restore operation.
activate_case_sensitive_identifier(bool)
/set_activate_case_sensitive_identifier(Option<bool>)
:
required: falseIndicates 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>
Source§impl Client
impl Client
Sourcepub fn restore_table_from_snapshot(
&self,
) -> RestoreTableFromSnapshotFluentBuilder
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: trueThe namespace of the snapshot to restore from.
workgroup_name(impl Into<String>)
/set_workgroup_name(Option<String>)
:
required: trueThe workgroup to restore the table to.
snapshot_name(impl Into<String>)
/set_snapshot_name(Option<String>)
:
required: trueThe name of the snapshot to restore the table from.
source_database_name(impl Into<String>)
/set_source_database_name(Option<String>)
:
required: trueThe name of the source database that contains the table being restored.
source_schema_name(impl Into<String>)
/set_source_schema_name(Option<String>)
:
required: falseThe name of the source schema that contains the table being restored.
source_table_name(impl Into<String>)
/set_source_table_name(Option<String>)
:
required: trueThe name of the source table being restored.
target_database_name(impl Into<String>)
/set_target_database_name(Option<String>)
:
required: falseThe name of the database to restore the table to.
target_schema_name(impl Into<String>)
/set_target_schema_name(Option<String>)
:
required: falseThe name of the schema to restore the table to.
new_table_name(impl Into<String>)
/set_new_table_name(Option<String>)
:
required: trueThe name of the table to create from the restore operation.
activate_case_sensitive_identifier(bool)
/set_activate_case_sensitive_identifier(Option<bool>)
:
required: falseIndicates 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>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
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: trueThe Amazon Resource Name (ARN) of the resource to tag.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueThe map of the key-value pairs used to tag the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
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: trueThe Amazon Resource Name (ARN) of the resource to remove tags from.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe tag or set of tags to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_custom_domain_association(
&self,
) -> UpdateCustomDomainAssociationFluentBuilder
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: trueThe name of the workgroup associated with the database.
custom_domain_name(impl Into<String>)
/set_custom_domain_name(Option<String>)
:
required: trueThe custom domain name associated with the workgroup.
custom_domain_certificate_arn(impl Into<String>)
/set_custom_domain_certificate_arn(Option<String>)
:
required: trueThe 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>
Source§impl Client
impl Client
Sourcepub fn update_endpoint_access(&self) -> UpdateEndpointAccessFluentBuilder
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: trueThe name of the VPC endpoint to update.
vpc_security_group_ids(impl Into<String>)
/set_vpc_security_group_ids(Option<Vec::<String>>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn update_namespace(&self) -> UpdateNamespaceFluentBuilder
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: trueThe 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: falseThe 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
ifmanageAdminPassword
is true.admin_username(impl Into<String>)
/set_admin_username(Option<String>)
:
required: falseThe 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: falseThe 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: falseThe 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: falseA 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: falseThe types of logs the namespace can export. The export types are
userlog
,connectionlog
, anduseractivitylog
.manage_admin_password(bool)
/set_manage_admin_password(Option<bool>)
:
required: falseIf
true
, Amazon Redshift uses Secrets Manager to manage the namespace’s admin credentials. You can’t useadminUserPassword
ifmanageAdminPassword
is true. IfmanageAdminPassword
is false or not set, Amazon Redshift usesadminUserPassword
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: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn update_scheduled_action(&self) -> UpdateScheduledActionFluentBuilder
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: trueThe name of the scheduled action to update to.
target_action(TargetAction)
/set_target_action(Option<TargetAction>)
:
required: falseA 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: falseThe 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: falseThe 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: falseSpecifies whether to enable the scheduled action.
scheduled_action_description(impl Into<String>)
/set_scheduled_action_description(Option<String>)
:
required: falseThe descripion of the scheduled action to update to.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:
required: falseThe start time in UTC of the scheduled action to update to.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn update_snapshot(&self) -> UpdateSnapshotFluentBuilder
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: trueThe name of the snapshot.
retention_period(i32)
/set_retention_period(Option<i32>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn update_snapshot_copy_configuration(
&self,
) -> UpdateSnapshotCopyConfigurationFluentBuilder
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: trueThe ID of the snapshot copy configuration to update.
snapshot_retention_period(i32)
/set_snapshot_retention_period(Option<i32>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn update_usage_limit(&self) -> UpdateUsageLimitFluentBuilder
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: trueThe identifier of the usage limit to update.
amount(i64)
/set_amount(Option<i64>)
:
required: falseThe 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: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn update_workgroup(&self) -> UpdateWorkgroupFluentBuilder
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: trueThe 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: falseThe new base data warehouse capacity in Redshift Processing Units (RPUs).
enhanced_vpc_routing(bool)
/set_enhanced_vpc_routing(Option<bool>)
:
required: falseThe 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: falseAn 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: falseA 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: falseAn array of VPC subnet IDs to associate with the workgroup.
security_group_ids(impl Into<String>)
/set_security_group_ids(Option<Vec::<String>>)
:
required: falseAn array of security group IDs to associate with the workgroup.
port(i32)
/set_port(Option<i32>)
:
required: falseThe 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: falseThe 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: falseThe IP address type that the workgroup supports. Possible values are
ipv4
anddualstack
.price_performance_target(PerformanceTarget)
/set_price_performance_target(Option<PerformanceTarget>)
:
required: falseAn object that represents the price performance target settings for the workgroup.
track_name(impl Into<String>)
/set_track_name(Option<String>)
:
required: falseAn 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>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);