pub struct Client { /* private fields */ }
Expand description

Client for Amazon Redshift

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

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_redshift::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_redshift::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_redshift::Client::from_conf(config);

Implementations§

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AcceptReservedNodeExchange operation.

Constructs a fluent builder for the AddPartner operation.

Constructs a fluent builder for the AssociateDataShareConsumer operation.

Constructs a fluent builder for the AuthorizeClusterSecurityGroupIngress operation.

Constructs a fluent builder for the AuthorizeDataShare operation.

Constructs a fluent builder for the AuthorizeEndpointAccess operation.

Constructs a fluent builder for the AuthorizeSnapshotAccess operation.

Constructs a fluent builder for the BatchDeleteClusterSnapshots operation.

Constructs a fluent builder for the BatchModifyClusterSnapshots operation.

Constructs a fluent builder for the CancelResize operation.

Constructs a fluent builder for the CopyClusterSnapshot operation.

Constructs a fluent builder for the CreateAuthenticationProfile operation.

Constructs a fluent builder for the CreateCluster operation.

Constructs a fluent builder for the CreateClusterParameterGroup operation.

Constructs a fluent builder for the CreateClusterSecurityGroup operation.

Constructs a fluent builder for the CreateClusterSnapshot operation.

Constructs a fluent builder for the CreateClusterSubnetGroup operation.

Constructs a fluent builder for the CreateEndpointAccess operation.

Constructs a fluent builder for the CreateEventSubscription operation.

Constructs a fluent builder for the CreateHsmClientCertificate operation.

Constructs a fluent builder for the CreateHsmConfiguration operation.

Constructs a fluent builder for the CreateScheduledAction operation.

Constructs a fluent builder for the CreateSnapshotCopyGrant operation.

Constructs a fluent builder for the CreateSnapshotSchedule operation.

Constructs a fluent builder for the CreateTags operation.

  • The fluent builder is configurable:
    • resource_name(impl Into<String>) / set_resource_name(Option<String>):

      The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

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

      One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, –tags “Key”=“owner”,“Value”=“admin” “Key”=“environment”,“Value”=“test” “Key”=“version”,“Value”=“1.0”.

  • On success, responds with CreateTagsOutput
  • On failure, responds with SdkError<CreateTagsError>

Constructs a fluent builder for the CreateUsageLimit operation.

Constructs a fluent builder for the DeauthorizeDataShare operation.

Constructs a fluent builder for the DeleteAuthenticationProfile operation.

Constructs a fluent builder for the DeleteCluster operation.

Constructs a fluent builder for the DeleteClusterParameterGroup operation.

Constructs a fluent builder for the DeleteClusterSecurityGroup operation.

Constructs a fluent builder for the DeleteClusterSnapshot operation.

Constructs a fluent builder for the DeleteClusterSubnetGroup operation.

Constructs a fluent builder for the DeleteEndpointAccess operation.

Constructs a fluent builder for the DeleteEventSubscription operation.

Constructs a fluent builder for the DeleteHsmClientCertificate operation.

Constructs a fluent builder for the DeleteHsmConfiguration operation.

Constructs a fluent builder for the DeletePartner operation.

Constructs a fluent builder for the DeleteScheduledAction operation.

Constructs a fluent builder for the DeleteSnapshotCopyGrant operation.

Constructs a fluent builder for the DeleteSnapshotSchedule operation.

Constructs a fluent builder for the DeleteTags operation.

Constructs a fluent builder for the DeleteUsageLimit operation.

Constructs a fluent builder for the DescribeAccountAttributes operation.

Constructs a fluent builder for the DescribeAuthenticationProfiles operation.

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

  • The fluent builder is configurable:
    • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):

      A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.

    • max_records(i32) / set_max_records(Option<i32>):

      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 the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

      Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.

  • On success, responds with DescribeClusterDbRevisionsOutput with field(s):
    • marker(Option<String>):

      A string representing the starting point for the next set of revisions. If a value is returned in a response, you can retrieve the next set of revisions by providing the value in the marker parameter and retrying the command. If the marker field is empty, all revisions have already been returned.

    • cluster_db_revisions(Option<Vec<ClusterDbRevision>>):

      A list of revisions.

  • On failure, responds with SdkError<DescribeClusterDbRevisionsError>

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

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

      The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

      A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

    • tag_values(Vec<String>) / set_tag_values(Option<Vec<String>>):

      A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

  • On success, responds with DescribeClusterParameterGroupsOutput with field(s):
    • marker(Option<String>):

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

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

      A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.

  • On failure, responds with SdkError<DescribeClusterParameterGroupsError>

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

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

      The name of a cluster parameter group for which to return details.

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

      The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

      Default: All parameter types returned.

      Valid Values: user | engine-default

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • On success, responds with DescribeClusterParametersOutput with field(s):
    • parameters(Option<Vec<Parameter>>):

      A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.

    • marker(Option<String>):

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • On failure, responds with SdkError<DescribeClusterParametersError>

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

  • The fluent builder is configurable:
    • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):

      The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

      The default is that all clusters defined for an account are returned.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

      Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

    • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

      A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

    • tag_values(Vec<String>) / set_tag_values(Option<Vec<String>>):

      A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

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

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

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

      A list of Cluster objects, where each object describes one cluster.

  • On failure, responds with SdkError<DescribeClustersError>

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

  • The fluent builder is configurable:
    • cluster_security_group_name(impl Into<String>) / set_cluster_security_group_name(Option<String>):

      The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

      Example: securitygroup1

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

      Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.

    • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

      A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.

    • tag_values(Vec<String>) / set_tag_values(Option<Vec<String>>):

      A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

  • On success, responds with DescribeClusterSecurityGroupsOutput with field(s):
    • marker(Option<String>):

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • cluster_security_groups(Option<Vec<ClusterSecurityGroup>>):

      A list of ClusterSecurityGroup instances.

  • On failure, responds with SdkError<DescribeClusterSecurityGroupsError>

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

  • The fluent builder is configurable:
    • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):

      The identifier of the cluster which generated the requested snapshots.

    • snapshot_identifier(impl Into<String>) / set_snapshot_identifier(Option<String>):

      The snapshot identifier of the snapshot about which to return information.

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

      The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.

    • snapshot_type(impl Into<String>) / set_snapshot_type(Option<String>):

      The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

      Valid Values: automated | manual

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

      A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2012-07-16T18:00:00Z

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

      A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2012-07-16T18:00:00Z

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

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

      The Amazon Web Services account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your Amazon Web Services account, or do not specify the parameter.

    • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

      A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

    • tag_values(Vec<String>) / set_tag_values(Option<Vec<String>>):

      A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

    • cluster_exists(bool) / set_cluster_exists(Option<bool>):

      A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

      • If ClusterExists is set to true, ClusterIdentifier is required.

      • If ClusterExists is set to false and ClusterIdentifier isn’t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

      • If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

      • If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

    • sorting_entities(Vec<SnapshotSortingEntity>) / set_sorting_entities(Option<Vec<SnapshotSortingEntity>>):

  • On success, responds with DescribeClusterSnapshotsOutput with field(s):
    • marker(Option<String>):

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

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

      A list of Snapshot instances.

  • On failure, responds with SdkError<DescribeClusterSnapshotsError>

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

  • The fluent builder is configurable:
    • cluster_subnet_group_name(impl Into<String>) / set_cluster_subnet_group_name(Option<String>):

      The name of the cluster subnet group for which information is requested.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

      A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.

    • tag_values(Vec<String>) / set_tag_values(Option<Vec<String>>):

      A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.

  • On success, responds with DescribeClusterSubnetGroupsOutput with field(s):
    • marker(Option<String>):

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • cluster_subnet_groups(Option<Vec<ClusterSubnetGroup>>):

      A list of ClusterSubnetGroup instances.

  • On failure, responds with SdkError<DescribeClusterSubnetGroupsError>

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

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

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

  • The fluent builder is configurable:
    • data_share_arn(impl Into<String>) / set_data_share_arn(Option<String>):

      The identifier of the datashare to describe details of.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • On success, responds with DescribeDataSharesOutput with field(s):
    • data_shares(Option<Vec<DataShare>>):

      The results returned from describing datashares.

    • marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • On failure, responds with SdkError<DescribeDataSharesError>

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

  • The fluent builder is configurable:
    • consumer_arn(impl Into<String>) / set_consumer_arn(Option<String>):

      The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.

    • status(DataShareStatusForConsumer) / set_status(Option<DataShareStatusForConsumer>):

      An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • On success, responds with DescribeDataSharesForConsumerOutput with field(s):
    • data_shares(Option<Vec<DataShare>>):

      Shows the results of datashares available for consumers.

    • marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • On failure, responds with SdkError<DescribeDataSharesForConsumerError>

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

  • The fluent builder is configurable:
    • producer_arn(impl Into<String>) / set_producer_arn(Option<String>):

      The Amazon Resource Name (ARN) of the producer that returns in the list of datashares.

    • status(DataShareStatusForProducer) / set_status(Option<DataShareStatusForProducer>):

      An identifier giving the status of a datashare in the producer. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • On success, responds with DescribeDataSharesForProducerOutput with field(s):
    • data_shares(Option<Vec<DataShare>>):

      Shows the results of datashares available for producers.

    • marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • On failure, responds with SdkError<DescribeDataSharesForProducerError>

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

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

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

Constructs a fluent builder for the DescribeEventCategories operation.

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

  • The fluent builder is configurable:
    • source_identifier(impl Into<String>) / set_source_identifier(Option<String>):

      The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

      Constraints:

      If SourceIdentifier is supplied, SourceType must also be provided.

      • Specify a cluster identifier when SourceType is cluster.

      • Specify a cluster security group name when SourceType is cluster-security-group.

      • Specify a cluster parameter group name when SourceType is cluster-parameter-group.

      • Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

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

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

      Constraints:

      If SourceType is supplied, SourceIdentifier must also be provided.

      • Specify cluster when SourceIdentifier is a cluster identifier.

      • Specify cluster-security-group when SourceIdentifier is a cluster security group name.

      • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

      • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

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

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2009-07-08T18:00Z

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

      The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2009-07-08T18:00Z

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

      The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

      Default: 60

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

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

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

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

      A list of Event instances.

  • On failure, responds with SdkError<DescribeEventsError>

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

  • The fluent builder is configurable:
    • subscription_name(impl Into<String>) / set_subscription_name(Option<String>):

      The name of the Amazon Redshift event notification subscription to be described.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

      A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them.

    • tag_values(Vec<String>) / set_tag_values(Option<Vec<String>>):

      A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them.

  • On success, responds with DescribeEventSubscriptionsOutput with field(s):
    • marker(Option<String>):

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • event_subscriptions_list(Option<Vec<EventSubscription>>):

      A list of event subscriptions.

  • On failure, responds with SdkError<DescribeEventSubscriptionsError>

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

  • The fluent builder is configurable:
    • hsm_client_certificate_identifier(impl Into<String>) / set_hsm_client_certificate_identifier(Option<String>):

      The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your Amazon Web Services account.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

      A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.

    • tag_values(Vec<String>) / set_tag_values(Option<Vec<String>>):

      A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.

  • On success, responds with DescribeHsmClientCertificatesOutput with field(s):
    • marker(Option<String>):

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • hsm_client_certificates(Option<Vec<HsmClientCertificate>>):

      A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.

  • On failure, responds with SdkError<DescribeHsmClientCertificatesError>

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

  • The fluent builder is configurable:
    • hsm_configuration_identifier(impl Into<String>) / set_hsm_configuration_identifier(Option<String>):

      The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your Amazon Web Services account.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

      A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.

    • tag_values(Vec<String>) / set_tag_values(Option<Vec<String>>):

      A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.

  • On success, responds with DescribeHsmConfigurationsOutput with field(s):
    • marker(Option<String>):

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • hsm_configurations(Option<Vec<HsmConfiguration>>):

      A list of HsmConfiguration objects.

  • On failure, responds with SdkError<DescribeHsmConfigurationsError>

Constructs a fluent builder for the DescribeLoggingStatus operation.

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

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

  • The fluent builder is configurable:
    • cluster_version(impl Into<String>) / set_cluster_version(Option<String>):

      The version filter value. Specify this parameter to show only the available offerings matching the specified version.

      Default: All versions.

      Constraints: Must be one of the version returned from DescribeClusterVersions.

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

      The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • On success, responds with DescribeOrderableClusterOptionsOutput with field(s):
    • orderable_cluster_options(Option<Vec<OrderableClusterOption>>):

      An OrderableClusterOption structure containing information about orderable options for the cluster.

    • marker(Option<String>):

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • On failure, responds with SdkError<DescribeOrderableClusterOptionsError>

Constructs a fluent builder for the DescribePartners operation.

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

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

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

  • The fluent builder is configurable:
    • reserved_node_id(impl Into<String>) / set_reserved_node_id(Option<String>):

      Identifier for the node reservation.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

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

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

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

      The list of ReservedNode objects.

  • On failure, responds with SdkError<DescribeReservedNodesError>

Constructs a fluent builder for the DescribeResize operation.

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

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

  • The fluent builder is configurable:
    • snapshot_copy_grant_name(impl Into<String>) / set_snapshot_copy_grant_name(Option<String>):

      The name of the snapshot copy grant.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

      Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

    • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

      A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

    • tag_values(Vec<String>) / set_tag_values(Option<Vec<String>>):

      A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

  • On success, responds with DescribeSnapshotCopyGrantsOutput with field(s):
    • marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

      Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

    • snapshot_copy_grants(Option<Vec<SnapshotCopyGrant>>):

      The list of SnapshotCopyGrant objects.

  • On failure, responds with SdkError<DescribeSnapshotCopyGrantsError>

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

Constructs a fluent builder for the DescribeStorage operation.

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

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

  • The fluent builder is configurable:
    • resource_name(impl Into<String>) / set_resource_name(Option<String>):

      The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

    • resource_type(impl Into<String>) / set_resource_type(Option<String>):

      The type of resource with which you want to view tags. Valid resource types are:

      • Cluster

      • CIDR/IP

      • EC2 security group

      • Snapshot

      • Cluster security group

      • Subnet group

      • HSM connection

      • HSM certificate

      • Parameter group

      • Snapshot copy grant

      For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.

    • max_records(i32) / set_max_records(Option<i32>):

      The maximum number or 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.

    • marker(impl Into<String>) / set_marker(Option<String>):

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

    • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

      A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

    • tag_values(Vec<String>) / set_tag_values(Option<Vec<String>>):

      A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

  • On success, responds with DescribeTagsOutput with field(s):
    • tagged_resources(Option<Vec<TaggedResource>>):

      A list of tags with their associated resources.

    • marker(Option<String>):

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • On failure, responds with SdkError<DescribeTagsError>

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

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

      The identifier of the usage limit to describe.

    • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):

      The identifier of the cluster for which you want to describe usage limits.

    • feature_type(UsageLimitFeatureType) / set_feature_type(Option<UsageLimitFeatureType>):

      The feature type for which you want to describe usage limits.

    • max_records(i32) / set_max_records(Option<i32>):

      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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • marker(impl Into<String>) / set_marker(Option<String>):

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

      A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.

    • tag_values(Vec<String>) / set_tag_values(Option<Vec<String>>):

      A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.

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

      Contains the output from the DescribeUsageLimits action.

    • marker(Option<String>):

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

  • On failure, responds with SdkError<DescribeUsageLimitsError>

Constructs a fluent builder for the DisableLogging operation.

Constructs a fluent builder for the DisableSnapshotCopy operation.

Constructs a fluent builder for the DisassociateDataShareConsumer operation.

Constructs a fluent builder for the EnableLogging operation.

Constructs a fluent builder for the EnableSnapshotCopy operation.

Constructs a fluent builder for the GetClusterCredentials operation.

  • The fluent builder is configurable:
    • db_user(impl Into<String>) / set_db_user(Option<String>):

      The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn’t exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn’t exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn’t exist in the database.

      For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.

      Constraints:

      • Must be 1 to 64 alphanumeric characters or hyphens. The user name can’t be PUBLIC.

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

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

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

      The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log on to any existing database.

      Constraints:

      • Must be 1 to 64 alphanumeric characters or hyphens

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

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

    • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):

      The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive.

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

      The number of seconds until the returned temporary password expires.

      Constraint: minimum 900, maximum 3600.

      Default: 900

    • auto_create(bool) / set_auto_create(Option<bool>):

      Create a database user with the name specified for the user named in DbUser if one does not exist.

    • db_groups(Vec<String>) / set_db_groups(Option<Vec<String>>):

      A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.

      Database group name constraints

      • Must be 1 to 64 alphanumeric characters or hyphens

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

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

  • On success, responds with GetClusterCredentialsOutput 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 permissions as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter is specifed, DbUser is added to the listed groups for any sessions created using these credentials.

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

  • On failure, responds with SdkError<GetClusterCredentialsError>

Constructs a fluent builder for the GetClusterCredentialsWithIAM operation.

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

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

Constructs a fluent builder for the ModifyAquaConfiguration operation.

Constructs a fluent builder for the ModifyAuthenticationProfile operation.

Constructs a fluent builder for the ModifyCluster operation.

Constructs a fluent builder for the ModifyClusterDbRevision operation.

Constructs a fluent builder for the ModifyClusterIamRoles operation.

Constructs a fluent builder for the ModifyClusterMaintenance operation.

Constructs a fluent builder for the ModifyClusterParameterGroup operation.

Constructs a fluent builder for the ModifyClusterSnapshot operation.

Constructs a fluent builder for the ModifyClusterSnapshotSchedule operation.

Constructs a fluent builder for the ModifyClusterSubnetGroup operation.

Constructs a fluent builder for the ModifyEndpointAccess operation.

Constructs a fluent builder for the ModifyEventSubscription operation.

Constructs a fluent builder for the ModifyScheduledAction operation.

Constructs a fluent builder for the ModifySnapshotCopyRetentionPeriod operation.

  • The fluent builder is configurable:
    • cluster_identifier(impl Into<String>) / set_cluster_identifier(Option<String>):

      The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination Amazon Web Services Region.

      Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

    • retention_period(i32) / set_retention_period(i32):

      The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.

      By default, this only changes the retention period of copied automated snapshots.

      If you decrease the retention period for automated snapshots that are copied to a destination Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services Region and that fall outside of the new retention period.

      Constraints: Must be at least 1 and no more than 35 for automated snapshots.

      If you specify the manual option, only newly copied manual snapshots will have the new retention period.

      If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

      Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

    • manual(bool) / set_manual(bool):

      Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

  • On success, responds with ModifySnapshotCopyRetentionPeriodOutput with field(s):
  • On failure, responds with SdkError<ModifySnapshotCopyRetentionPeriodError>

Constructs a fluent builder for the ModifySnapshotSchedule operation.

Constructs a fluent builder for the ModifyUsageLimit operation.

Constructs a fluent builder for the PauseCluster operation.

Constructs a fluent builder for the PurchaseReservedNodeOffering operation.

Constructs a fluent builder for the RebootCluster operation.

Constructs a fluent builder for the RejectDataShare operation.

Constructs a fluent builder for the ResetClusterParameterGroup operation.

Constructs a fluent builder for the ResizeCluster operation.

Constructs a fluent builder for the RestoreFromClusterSnapshot operation.

Constructs a fluent builder for the RestoreTableFromClusterSnapshot operation.

Constructs a fluent builder for the ResumeCluster operation.

Constructs a fluent builder for the RevokeClusterSecurityGroupIngress operation.

Constructs a fluent builder for the RevokeEndpointAccess operation.

Constructs a fluent builder for the RevokeSnapshotAccess operation.

Constructs a fluent builder for the RotateEncryptionKey operation.

Constructs a fluent builder for the UpdatePartnerStatus operation.

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.

Creates a new client from the service Config.

Panics
  • This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more