Class: Aws::RedshiftServerless::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb

Overview

An API client for RedshiftServerless. To construct a client, you need to configure a :region and :credentials.

client = Aws::RedshiftServerless::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



358
359
360
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 358

def initialize(*args)
  super
end

Instance Method Details

#convert_recovery_point_to_snapshot(params = {}) ⇒ Types::ConvertRecoveryPointToSnapshotResponse

Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.

Examples:

Request syntax with placeholder values


resp = client.convert_recovery_point_to_snapshot({
  recovery_point_id: "String", # required
  retention_period: 1,
  snapshot_name: "String", # required
})

Response structure


resp.snapshot.accounts_with_provisioned_restore_access #=> Array
resp.snapshot.accounts_with_provisioned_restore_access[0] #=> String
resp.snapshot.accounts_with_restore_access #=> Array
resp.snapshot.accounts_with_restore_access[0] #=> String
resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshot.admin_username #=> String
resp.snapshot.backup_progress_in_mega_bytes #=> Float
resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshot.elapsed_time_in_seconds #=> Integer
resp.snapshot.estimated_seconds_to_completion #=> Integer
resp.snapshot.kms_key_id #=> String
resp.snapshot.namespace_arn #=> String
resp.snapshot.namespace_name #=> String
resp.snapshot. #=> String
resp.snapshot.snapshot_arn #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.snapshot_name #=> String
resp.snapshot.snapshot_remaining_days #=> Integer
resp.snapshot.snapshot_retention_period #=> Integer
resp.snapshot.snapshot_retention_start_time #=> Time
resp.snapshot.status #=> String, one of "AVAILABLE", "CREATING", "DELETED", "CANCELLED", "FAILED", "COPYING"
resp.snapshot.total_backup_size_in_mega_bytes #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :recovery_point_id (required, String)

    The unique identifier of the recovery point.

  • :retention_period (Integer)

    How long to retain the snapshot.

  • :snapshot_name (required, String)

    The name of the snapshot.

Returns:

See Also:



422
423
424
425
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 422

def convert_recovery_point_to_snapshot(params = {}, options = {})
  req = build_request(:convert_recovery_point_to_snapshot, params)
  req.send_request(options)
end

#create_endpoint_access(params = {}) ⇒ Types::CreateEndpointAccessResponse

Creates an Amazon Redshift Serverless managed VPC endpoint.

Examples:

Request syntax with placeholder values


resp = client.create_endpoint_access({
  endpoint_name: "String", # required
  subnet_ids: ["SubnetId"], # required
  vpc_security_group_ids: ["VpcSecurityGroupId"],
  workgroup_name: "String", # required
})

Response structure


resp.endpoint.address #=> String
resp.endpoint.endpoint_arn #=> String
resp.endpoint.endpoint_create_time #=> Time
resp.endpoint.endpoint_name #=> String
resp.endpoint.endpoint_status #=> String
resp.endpoint.port #=> Integer
resp.endpoint.subnet_ids #=> Array
resp.endpoint.subnet_ids[0] #=> String
resp.endpoint.vpc_endpoint.network_interfaces #=> Array
resp.endpoint.vpc_endpoint.network_interfaces[0].availability_zone #=> String
resp.endpoint.vpc_endpoint.network_interfaces[0].network_interface_id #=> String
resp.endpoint.vpc_endpoint.network_interfaces[0].private_ip_address #=> String
resp.endpoint.vpc_endpoint.network_interfaces[0].subnet_id #=> String
resp.endpoint.vpc_endpoint.vpc_endpoint_id #=> String
resp.endpoint.vpc_endpoint.vpc_id #=> String
resp.endpoint.vpc_security_groups #=> Array
resp.endpoint.vpc_security_groups[0].status #=> String
resp.endpoint.vpc_security_groups[0].vpc_security_group_id #=> String
resp.endpoint.workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :endpoint_name (required, String)

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

  • :subnet_ids (required, Array<String>)

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

  • :vpc_security_group_ids (Array<String>)

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

  • :workgroup_name (required, String)

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

Returns:

See Also:



486
487
488
489
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 486

def create_endpoint_access(params = {}, options = {})
  req = build_request(:create_endpoint_access, params)
  req.send_request(options)
end

#create_namespace(params = {}) ⇒ Types::CreateNamespaceResponse

Creates a namespace in Amazon Redshift Serverless.

Examples:

Request syntax with placeholder values


resp = client.create_namespace({
  admin_user_password: "DbPassword",
  admin_username: "DbUser",
  db_name: "String",
  default_iam_role_arn: "String",
  iam_roles: ["IamRoleArn"],
  kms_key_id: "String",
  log_exports: ["useractivitylog"], # accepts useractivitylog, userlog, connectionlog
  namespace_name: "NamespaceName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.namespace.admin_username #=> String
resp.namespace.creation_date #=> Time
resp.namespace.db_name #=> String
resp.namespace.default_iam_role_arn #=> String
resp.namespace.iam_roles #=> Array
resp.namespace.iam_roles[0] #=> String
resp.namespace.kms_key_id #=> String
resp.namespace.log_exports #=> Array
resp.namespace.log_exports[0] #=> String, one of "useractivitylog", "userlog", "connectionlog"
resp.namespace.namespace_arn #=> String
resp.namespace.namespace_id #=> String
resp.namespace.namespace_name #=> String
resp.namespace.status #=> String, one of "AVAILABLE", "MODIFYING", "DELETING"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :admin_user_password (String)

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

  • :admin_username (String)

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

  • :db_name (String)

    The name of the first database created in the namespace.

  • :default_iam_role_arn (String)

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

  • :iam_roles (Array<String>)

    A list of IAM roles to associate with the namespace.

  • :kms_key_id (String)

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

  • :log_exports (Array<String>)

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

  • :namespace_name (required, String)

    The name of the namespace.

  • :tags (Array<Types::Tag>)

    A list of tag instances.

Returns:

See Also:



568
569
570
571
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 568

def create_namespace(params = {}, options = {})
  req = build_request(:create_namespace, params)
  req.send_request(options)
end

#create_snapshot(params = {}) ⇒ Types::CreateSnapshotResponse

Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.

Examples:

Request syntax with placeholder values


resp = client.create_snapshot({
  namespace_name: "String", # required
  retention_period: 1,
  snapshot_name: "String", # required
})

Response structure


resp.snapshot.accounts_with_provisioned_restore_access #=> Array
resp.snapshot.accounts_with_provisioned_restore_access[0] #=> String
resp.snapshot.accounts_with_restore_access #=> Array
resp.snapshot.accounts_with_restore_access[0] #=> String
resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshot.admin_username #=> String
resp.snapshot.backup_progress_in_mega_bytes #=> Float
resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshot.elapsed_time_in_seconds #=> Integer
resp.snapshot.estimated_seconds_to_completion #=> Integer
resp.snapshot.kms_key_id #=> String
resp.snapshot.namespace_arn #=> String
resp.snapshot.namespace_name #=> String
resp.snapshot. #=> String
resp.snapshot.snapshot_arn #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.snapshot_name #=> String
resp.snapshot.snapshot_remaining_days #=> Integer
resp.snapshot.snapshot_retention_period #=> Integer
resp.snapshot.snapshot_retention_start_time #=> Time
resp.snapshot.status #=> String, one of "AVAILABLE", "CREATING", "DELETED", "CANCELLED", "FAILED", "COPYING"
resp.snapshot.total_backup_size_in_mega_bytes #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :namespace_name (required, String)

    The namespace to create a snapshot for.

  • :retention_period (Integer)

    How long to retain the created snapshot.

  • :snapshot_name (required, String)

    The name of the snapshot.

Returns:

See Also:



631
632
633
634
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 631

def create_snapshot(params = {}, options = {})
  req = build_request(:create_snapshot, params)
  req.send_request(options)
end

#create_usage_limit(params = {}) ⇒ Types::CreateUsageLimitResponse

Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.

Examples:

Request syntax with placeholder values


resp = client.create_usage_limit({
  amount: 1, # required
  breach_action: "log", # accepts log, emit-metric, deactivate
  period: "daily", # accepts daily, weekly, monthly
  resource_arn: "String", # required
  usage_type: "serverless-compute", # required, accepts serverless-compute, cross-region-datasharing
})

Response structure


resp.usage_limit.amount #=> Integer
resp.usage_limit.breach_action #=> String, one of "log", "emit-metric", "deactivate"
resp.usage_limit.period #=> String, one of "daily", "weekly", "monthly"
resp.usage_limit.resource_arn #=> String
resp.usage_limit.usage_limit_arn #=> String
resp.usage_limit.usage_limit_id #=> String
resp.usage_limit.usage_type #=> String, one of "serverless-compute", "cross-region-datasharing"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :amount (required, Integer)

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

  • :breach_action (String)

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

  • :period (String)

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

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.

  • :usage_type (required, String)

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

Returns:

See Also:



690
691
692
693
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 690

def create_usage_limit(params = {}, options = {})
  req = build_request(:create_usage_limit, params)
  req.send_request(options)
end

#create_workgroup(params = {}) ⇒ Types::CreateWorkgroupResponse

Creates an workgroup in Amazon Redshift Serverless.

Examples:

Request syntax with placeholder values


resp = client.create_workgroup({
  base_capacity: 1,
  config_parameters: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
    },
  ],
  enhanced_vpc_routing: false,
  namespace_name: "NamespaceName", # required
  publicly_accessible: false,
  security_group_ids: ["SecurityGroupId"],
  subnet_ids: ["SubnetId"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  workgroup_name: "WorkgroupName", # required
})

Response structure


resp.workgroup.base_capacity #=> Integer
resp.workgroup.config_parameters #=> Array
resp.workgroup.config_parameters[0].parameter_key #=> String
resp.workgroup.config_parameters[0].parameter_value #=> String
resp.workgroup.creation_date #=> Time
resp.workgroup.endpoint.address #=> String
resp.workgroup.endpoint.port #=> Integer
resp.workgroup.endpoint.vpc_endpoints #=> Array
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.workgroup.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.workgroup.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.workgroup.enhanced_vpc_routing #=> Boolean
resp.workgroup.namespace_name #=> String
resp.workgroup.publicly_accessible #=> Boolean
resp.workgroup.security_group_ids #=> Array
resp.workgroup.security_group_ids[0] #=> String
resp.workgroup.status #=> String, one of "CREATING", "AVAILABLE", "MODIFYING", "DELETING"
resp.workgroup.subnet_ids #=> Array
resp.workgroup.subnet_ids[0] #=> String
resp.workgroup.workgroup_arn #=> String
resp.workgroup.workgroup_id #=> String
resp.workgroup.workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :base_capacity (Integer)

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

  • :config_parameters (Array<Types::ConfigParameter>)

    An array of parameters to set for more control over a serverless database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

  • :enhanced_vpc_routing (Boolean)

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

  • :namespace_name (required, String)

    The name of the namespace to associate with the workgroup.

  • :publicly_accessible (Boolean)

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

  • :security_group_ids (Array<String>)

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

  • :subnet_ids (Array<String>)

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

  • :tags (Array<Types::Tag>)

    A array of tag instances.

  • :workgroup_name (required, String)

    The name of the created workgroup.

Returns:

See Also:



791
792
793
794
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 791

def create_workgroup(params = {}, options = {})
  req = build_request(:create_workgroup, params)
  req.send_request(options)
end

#delete_endpoint_access(params = {}) ⇒ Types::DeleteEndpointAccessResponse

Deletes an Amazon Redshift Serverless managed VPC endpoint.

Examples:

Request syntax with placeholder values


resp = client.delete_endpoint_access({
  endpoint_name: "String", # required
})

Response structure


resp.endpoint.address #=> String
resp.endpoint.endpoint_arn #=> String
resp.endpoint.endpoint_create_time #=> Time
resp.endpoint.endpoint_name #=> String
resp.endpoint.endpoint_status #=> String
resp.endpoint.port #=> Integer
resp.endpoint.subnet_ids #=> Array
resp.endpoint.subnet_ids[0] #=> String
resp.endpoint.vpc_endpoint.network_interfaces #=> Array
resp.endpoint.vpc_endpoint.network_interfaces[0].availability_zone #=> String
resp.endpoint.vpc_endpoint.network_interfaces[0].network_interface_id #=> String
resp.endpoint.vpc_endpoint.network_interfaces[0].private_ip_address #=> String
resp.endpoint.vpc_endpoint.network_interfaces[0].subnet_id #=> String
resp.endpoint.vpc_endpoint.vpc_endpoint_id #=> String
resp.endpoint.vpc_endpoint.vpc_id #=> String
resp.endpoint.vpc_security_groups #=> Array
resp.endpoint.vpc_security_groups[0].status #=> String
resp.endpoint.vpc_security_groups[0].vpc_security_group_id #=> String
resp.endpoint.workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :endpoint_name (required, String)

    The name of the VPC endpoint to delete.

Returns:

See Also:



837
838
839
840
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 837

def delete_endpoint_access(params = {}, options = {})
  req = build_request(:delete_endpoint_access, params)
  req.send_request(options)
end

#delete_namespace(params = {}) ⇒ Types::DeleteNamespaceResponse

Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.

Examples:

Request syntax with placeholder values


resp = client.delete_namespace({
  final_snapshot_name: "String",
  final_snapshot_retention_period: 1,
  namespace_name: "NamespaceName", # required
})

Response structure


resp.namespace.admin_username #=> String
resp.namespace.creation_date #=> Time
resp.namespace.db_name #=> String
resp.namespace.default_iam_role_arn #=> String
resp.namespace.iam_roles #=> Array
resp.namespace.iam_roles[0] #=> String
resp.namespace.kms_key_id #=> String
resp.namespace.log_exports #=> Array
resp.namespace.log_exports[0] #=> String, one of "useractivitylog", "userlog", "connectionlog"
resp.namespace.namespace_arn #=> String
resp.namespace.namespace_id #=> String
resp.namespace.namespace_name #=> String
resp.namespace.status #=> String, one of "AVAILABLE", "MODIFYING", "DELETING"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :final_snapshot_name (String)

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

  • :final_snapshot_retention_period (Integer)

    How long to retain the final snapshot.

  • :namespace_name (required, String)

    The name of the namespace to delete.

Returns:

See Also:



888
889
890
891
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 888

def delete_namespace(params = {}, options = {})
  req = build_request(:delete_namespace, params)
  req.send_request(options)
end

#delete_resource_policy(params = {}) ⇒ Struct

Deletes the specified resource policy.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  resource_arn: "String", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the policy to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



910
911
912
913
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 910

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

#delete_snapshot(params = {}) ⇒ Types::DeleteSnapshotResponse

Deletes a snapshot from Amazon Redshift Serverless.

Examples:

Request syntax with placeholder values


resp = client.delete_snapshot({
  snapshot_name: "String", # required
})

Response structure


resp.snapshot.accounts_with_provisioned_restore_access #=> Array
resp.snapshot.accounts_with_provisioned_restore_access[0] #=> String
resp.snapshot.accounts_with_restore_access #=> Array
resp.snapshot.accounts_with_restore_access[0] #=> String
resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshot.admin_username #=> String
resp.snapshot.backup_progress_in_mega_bytes #=> Float
resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshot.elapsed_time_in_seconds #=> Integer
resp.snapshot.estimated_seconds_to_completion #=> Integer
resp.snapshot.kms_key_id #=> String
resp.snapshot.namespace_arn #=> String
resp.snapshot.namespace_name #=> String
resp.snapshot. #=> String
resp.snapshot.snapshot_arn #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.snapshot_name #=> String
resp.snapshot.snapshot_remaining_days #=> Integer
resp.snapshot.snapshot_retention_period #=> Integer
resp.snapshot.snapshot_retention_start_time #=> Time
resp.snapshot.status #=> String, one of "AVAILABLE", "CREATING", "DELETED", "CANCELLED", "FAILED", "COPYING"
resp.snapshot.total_backup_size_in_mega_bytes #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :snapshot_name (required, String)

    The name of the snapshot to be deleted.

Returns:

See Also:



959
960
961
962
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 959

def delete_snapshot(params = {}, options = {})
  req = build_request(:delete_snapshot, params)
  req.send_request(options)
end

#delete_usage_limit(params = {}) ⇒ Types::DeleteUsageLimitResponse

Deletes a usage limit from Amazon Redshift Serverless.

Examples:

Request syntax with placeholder values


resp = client.delete_usage_limit({
  usage_limit_id: "String", # required
})

Response structure


resp.usage_limit.amount #=> Integer
resp.usage_limit.breach_action #=> String, one of "log", "emit-metric", "deactivate"
resp.usage_limit.period #=> String, one of "daily", "weekly", "monthly"
resp.usage_limit.resource_arn #=> String
resp.usage_limit.usage_limit_arn #=> String
resp.usage_limit.usage_limit_id #=> String
resp.usage_limit.usage_type #=> String, one of "serverless-compute", "cross-region-datasharing"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :usage_limit_id (required, String)

    The unique identifier of the usage limit to delete.

Returns:

See Also:



993
994
995
996
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 993

def delete_usage_limit(params = {}, options = {})
  req = build_request(:delete_usage_limit, params)
  req.send_request(options)
end

#delete_workgroup(params = {}) ⇒ Types::DeleteWorkgroupResponse

Deletes a workgroup.

Examples:

Request syntax with placeholder values


resp = client.delete_workgroup({
  workgroup_name: "WorkgroupName", # required
})

Response structure


resp.workgroup.base_capacity #=> Integer
resp.workgroup.config_parameters #=> Array
resp.workgroup.config_parameters[0].parameter_key #=> String
resp.workgroup.config_parameters[0].parameter_value #=> String
resp.workgroup.creation_date #=> Time
resp.workgroup.endpoint.address #=> String
resp.workgroup.endpoint.port #=> Integer
resp.workgroup.endpoint.vpc_endpoints #=> Array
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.workgroup.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.workgroup.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.workgroup.enhanced_vpc_routing #=> Boolean
resp.workgroup.namespace_name #=> String
resp.workgroup.publicly_accessible #=> Boolean
resp.workgroup.security_group_ids #=> Array
resp.workgroup.security_group_ids[0] #=> String
resp.workgroup.status #=> String, one of "CREATING", "AVAILABLE", "MODIFYING", "DELETING"
resp.workgroup.subnet_ids #=> Array
resp.workgroup.subnet_ids[0] #=> String
resp.workgroup.workgroup_arn #=> String
resp.workgroup.workgroup_id #=> String
resp.workgroup.workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :workgroup_name (required, String)

    The name of the workgroup to be deleted.

Returns:

See Also:



1046
1047
1048
1049
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1046

def delete_workgroup(params = {}, options = {})
  req = build_request(:delete_workgroup, params)
  req.send_request(options)
end

#get_credentials(params = {}) ⇒ Types::GetCredentialsResponse

Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.

By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes).

 <p> The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources. </p> <p> If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.</p>

Examples:

Request syntax with placeholder values


resp = client.get_credentials({
  db_name: "DbName",
  duration_seconds: 1,
  workgroup_name: "WorkgroupName", # required
})

Response structure


resp.db_password #=> String
resp.db_user #=> String
resp.expiration #=> Time
resp.next_refresh_time #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :db_name (String)

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

    Constraints:

    • Must be 1 to 64 alphanumeric characters or hyphens.

    • Must contain only 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 (Integer)

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

  • :workgroup_name (required, String)

    The name of the workgroup associated with the database.

Returns:

See Also:



1114
1115
1116
1117
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1114

def get_credentials(params = {}, options = {})
  req = build_request(:get_credentials, params)
  req.send_request(options)
end

#get_endpoint_access(params = {}) ⇒ Types::GetEndpointAccessResponse

Returns information, such as the name, about a VPC endpoint.

Examples:

Request syntax with placeholder values


resp = client.get_endpoint_access({
  endpoint_name: "String", # required
})

Response structure


resp.endpoint.address #=> String
resp.endpoint.endpoint_arn #=> String
resp.endpoint.endpoint_create_time #=> Time
resp.endpoint.endpoint_name #=> String
resp.endpoint.endpoint_status #=> String
resp.endpoint.port #=> Integer
resp.endpoint.subnet_ids #=> Array
resp.endpoint.subnet_ids[0] #=> String
resp.endpoint.vpc_endpoint.network_interfaces #=> Array
resp.endpoint.vpc_endpoint.network_interfaces[0].availability_zone #=> String
resp.endpoint.vpc_endpoint.network_interfaces[0].network_interface_id #=> String
resp.endpoint.vpc_endpoint.network_interfaces[0].private_ip_address #=> String
resp.endpoint.vpc_endpoint.network_interfaces[0].subnet_id #=> String
resp.endpoint.vpc_endpoint.vpc_endpoint_id #=> String
resp.endpoint.vpc_endpoint.vpc_id #=> String
resp.endpoint.vpc_security_groups #=> Array
resp.endpoint.vpc_security_groups[0].status #=> String
resp.endpoint.vpc_security_groups[0].vpc_security_group_id #=> String
resp.endpoint.workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :endpoint_name (required, String)

    The name of the VPC endpoint to return information for.

Returns:

See Also:



1160
1161
1162
1163
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1160

def get_endpoint_access(params = {}, options = {})
  req = build_request(:get_endpoint_access, params)
  req.send_request(options)
end

#get_namespace(params = {}) ⇒ Types::GetNamespaceResponse

Returns information about a namespace in Amazon Redshift Serverless.

Examples:

Request syntax with placeholder values


resp = client.get_namespace({
  namespace_name: "NamespaceName", # required
})

Response structure


resp.namespace.admin_username #=> String
resp.namespace.creation_date #=> Time
resp.namespace.db_name #=> String
resp.namespace.default_iam_role_arn #=> String
resp.namespace.iam_roles #=> Array
resp.namespace.iam_roles[0] #=> String
resp.namespace.kms_key_id #=> String
resp.namespace.log_exports #=> Array
resp.namespace.log_exports[0] #=> String, one of "useractivitylog", "userlog", "connectionlog"
resp.namespace.namespace_arn #=> String
resp.namespace.namespace_id #=> String
resp.namespace.namespace_name #=> String
resp.namespace.status #=> String, one of "AVAILABLE", "MODIFYING", "DELETING"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :namespace_name (required, String)

    The name of the namespace to retrieve information for.

Returns:

See Also:



1200
1201
1202
1203
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1200

def get_namespace(params = {}, options = {})
  req = build_request(:get_namespace, params)
  req.send_request(options)
end

#get_recovery_point(params = {}) ⇒ Types::GetRecoveryPointResponse

Returns information about a recovery point.

Examples:

Request syntax with placeholder values


resp = client.get_recovery_point({
  recovery_point_id: "String", # required
})

Response structure


resp.recovery_point.namespace_name #=> String
resp.recovery_point.recovery_point_create_time #=> Time
resp.recovery_point.recovery_point_id #=> String
resp.recovery_point.total_size_in_mega_bytes #=> Float
resp.recovery_point.workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :recovery_point_id (required, String)

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

Returns:

See Also:



1232
1233
1234
1235
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1232

def get_recovery_point(params = {}, options = {})
  req = build_request(:get_recovery_point, params)
  req.send_request(options)
end

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse

Returns a resource policy.

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  resource_arn: "String", # required
})

Response structure


resp.resource_policy.policy #=> String
resp.resource_policy.resource_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

Returns:

See Also:



1261
1262
1263
1264
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1261

def get_resource_policy(params = {}, options = {})
  req = build_request(:get_resource_policy, params)
  req.send_request(options)
end

#get_snapshot(params = {}) ⇒ Types::GetSnapshotResponse

Returns information about a specific snapshot.

Examples:

Request syntax with placeholder values


resp = client.get_snapshot({
  owner_account: "String",
  snapshot_arn: "String",
  snapshot_name: "String",
})

Response structure


resp.snapshot.accounts_with_provisioned_restore_access #=> Array
resp.snapshot.accounts_with_provisioned_restore_access[0] #=> String
resp.snapshot.accounts_with_restore_access #=> Array
resp.snapshot.accounts_with_restore_access[0] #=> String
resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshot.admin_username #=> String
resp.snapshot.backup_progress_in_mega_bytes #=> Float
resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshot.elapsed_time_in_seconds #=> Integer
resp.snapshot.estimated_seconds_to_completion #=> Integer
resp.snapshot.kms_key_id #=> String
resp.snapshot.namespace_arn #=> String
resp.snapshot.namespace_name #=> String
resp.snapshot. #=> String
resp.snapshot.snapshot_arn #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.snapshot_name #=> String
resp.snapshot.snapshot_remaining_days #=> Integer
resp.snapshot.snapshot_retention_period #=> Integer
resp.snapshot.snapshot_retention_start_time #=> Time
resp.snapshot.status #=> String, one of "AVAILABLE", "CREATING", "DELETED", "CANCELLED", "FAILED", "COPYING"
resp.snapshot.total_backup_size_in_mega_bytes #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :owner_account (String)

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

  • :snapshot_arn (String)

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

  • :snapshot_name (String)

    The name of the snapshot to return.

Returns:

See Also:



1319
1320
1321
1322
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1319

def get_snapshot(params = {}, options = {})
  req = build_request(:get_snapshot, params)
  req.send_request(options)
end

#get_usage_limit(params = {}) ⇒ Types::GetUsageLimitResponse

Returns information about a usage limit.

Examples:

Request syntax with placeholder values


resp = client.get_usage_limit({
  usage_limit_id: "String", # required
})

Response structure


resp.usage_limit.amount #=> Integer
resp.usage_limit.breach_action #=> String, one of "log", "emit-metric", "deactivate"
resp.usage_limit.period #=> String, one of "daily", "weekly", "monthly"
resp.usage_limit.resource_arn #=> String
resp.usage_limit.usage_limit_arn #=> String
resp.usage_limit.usage_limit_id #=> String
resp.usage_limit.usage_type #=> String, one of "serverless-compute", "cross-region-datasharing"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :usage_limit_id (required, String)

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

Returns:

See Also:



1353
1354
1355
1356
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1353

def get_usage_limit(params = {}, options = {})
  req = build_request(:get_usage_limit, params)
  req.send_request(options)
end

#get_workgroup(params = {}) ⇒ Types::GetWorkgroupResponse

Returns information about a specific workgroup.

Examples:

Request syntax with placeholder values


resp = client.get_workgroup({
  workgroup_name: "WorkgroupName", # required
})

Response structure


resp.workgroup.base_capacity #=> Integer
resp.workgroup.config_parameters #=> Array
resp.workgroup.config_parameters[0].parameter_key #=> String
resp.workgroup.config_parameters[0].parameter_value #=> String
resp.workgroup.creation_date #=> Time
resp.workgroup.endpoint.address #=> String
resp.workgroup.endpoint.port #=> Integer
resp.workgroup.endpoint.vpc_endpoints #=> Array
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.workgroup.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.workgroup.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.workgroup.enhanced_vpc_routing #=> Boolean
resp.workgroup.namespace_name #=> String
resp.workgroup.publicly_accessible #=> Boolean
resp.workgroup.security_group_ids #=> Array
resp.workgroup.security_group_ids[0] #=> String
resp.workgroup.status #=> String, one of "CREATING", "AVAILABLE", "MODIFYING", "DELETING"
resp.workgroup.subnet_ids #=> Array
resp.workgroup.subnet_ids[0] #=> String
resp.workgroup.workgroup_arn #=> String
resp.workgroup.workgroup_id #=> String
resp.workgroup.workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :workgroup_name (required, String)

    The name of the workgroup to return information for.

Returns:

See Also:



1406
1407
1408
1409
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1406

def get_workgroup(params = {}, options = {})
  req = build_request(:get_workgroup, params)
  req.send_request(options)
end

#list_endpoint_access(params = {}) ⇒ Types::ListEndpointAccessResponse

Returns an array of EndpointAccess objects and relevant information.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_endpoint_access({
  max_results: 1,
  next_token: "String",
  vpc_id: "String",
  workgroup_name: "String",
})

Response structure


resp.endpoints #=> Array
resp.endpoints[0].address #=> String
resp.endpoints[0].endpoint_arn #=> String
resp.endpoints[0].endpoint_create_time #=> Time
resp.endpoints[0].endpoint_name #=> String
resp.endpoints[0].endpoint_status #=> String
resp.endpoints[0].port #=> Integer
resp.endpoints[0].subnet_ids #=> Array
resp.endpoints[0].subnet_ids[0] #=> String
resp.endpoints[0].vpc_endpoint.network_interfaces #=> Array
resp.endpoints[0].vpc_endpoint.network_interfaces[0].availability_zone #=> String
resp.endpoints[0].vpc_endpoint.network_interfaces[0].network_interface_id #=> String
resp.endpoints[0].vpc_endpoint.network_interfaces[0].private_ip_address #=> String
resp.endpoints[0].vpc_endpoint.network_interfaces[0].subnet_id #=> String
resp.endpoints[0].vpc_endpoint.vpc_endpoint_id #=> String
resp.endpoints[0].vpc_endpoint.vpc_id #=> String
resp.endpoints[0].vpc_security_groups #=> Array
resp.endpoints[0].vpc_security_groups[0].status #=> String
resp.endpoints[0].vpc_security_groups[0].vpc_security_group_id #=> String
resp.endpoints[0].workgroup_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String)

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

  • :vpc_id (String)

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

  • :workgroup_name (String)

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

Returns:

See Also:



1474
1475
1476
1477
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1474

def list_endpoint_access(params = {}, options = {})
  req = build_request(:list_endpoint_access, params)
  req.send_request(options)
end

#list_namespaces(params = {}) ⇒ Types::ListNamespacesResponse

Returns information about a list of specified namespaces.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_namespaces({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.namespaces #=> Array
resp.namespaces[0].admin_username #=> String
resp.namespaces[0].creation_date #=> Time
resp.namespaces[0].db_name #=> String
resp.namespaces[0].default_iam_role_arn #=> String
resp.namespaces[0].iam_roles #=> Array
resp.namespaces[0].iam_roles[0] #=> String
resp.namespaces[0].kms_key_id #=> String
resp.namespaces[0].log_exports #=> Array
resp.namespaces[0].log_exports[0] #=> String, one of "useractivitylog", "userlog", "connectionlog"
resp.namespaces[0].namespace_arn #=> String
resp.namespaces[0].namespace_id #=> String
resp.namespaces[0].namespace_name #=> String
resp.namespaces[0].status #=> String, one of "AVAILABLE", "MODIFYING", "DELETING"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String)

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

Returns:

See Also:



1526
1527
1528
1529
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1526

def list_namespaces(params = {}, options = {})
  req = build_request(:list_namespaces, params)
  req.send_request(options)
end

#list_recovery_points(params = {}) ⇒ Types::ListRecoveryPointsResponse

Returns an array of recovery points.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_recovery_points({
  end_time: Time.now,
  max_results: 1,
  namespace_name: "NamespaceName",
  next_token: "String",
  start_time: Time.now,
})

Response structure


resp.next_token #=> String
resp.recovery_points #=> Array
resp.recovery_points[0].namespace_name #=> String
resp.recovery_points[0].recovery_point_create_time #=> Time
resp.recovery_points[0].recovery_point_id #=> String
resp.recovery_points[0].total_size_in_mega_bytes #=> Float
resp.recovery_points[0].workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :end_time (Time, DateTime, Date, Integer, String)

    The time when creation of the recovery point finished.

  • :max_results (Integer)

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :namespace_name (String)

    The name of the namespace to list recovery points for.

  • :next_token (String)

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

  • :start_time (Time, DateTime, Date, Integer, String)

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

Returns:

See Also:



1583
1584
1585
1586
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1583

def list_recovery_points(params = {}, options = {})
  req = build_request(:list_recovery_points, params)
  req.send_request(options)
end

#list_snapshots(params = {}) ⇒ Types::ListSnapshotsResponse

Returns a list of snapshots.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_snapshots({
  end_time: Time.now,
  max_results: 1,
  namespace_arn: "String",
  namespace_name: "String",
  next_token: "String",
  owner_account: "String",
  start_time: Time.now,
})

Response structure


resp.next_token #=> String
resp.snapshots #=> Array
resp.snapshots[0].accounts_with_provisioned_restore_access #=> Array
resp.snapshots[0].accounts_with_provisioned_restore_access[0] #=> String
resp.snapshots[0].accounts_with_restore_access #=> Array
resp.snapshots[0].accounts_with_restore_access[0] #=> String
resp.snapshots[0].actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshots[0].admin_username #=> String
resp.snapshots[0].backup_progress_in_mega_bytes #=> Float
resp.snapshots[0].current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshots[0].elapsed_time_in_seconds #=> Integer
resp.snapshots[0].estimated_seconds_to_completion #=> Integer
resp.snapshots[0].kms_key_id #=> String
resp.snapshots[0].namespace_arn #=> String
resp.snapshots[0].namespace_name #=> String
resp.snapshots[0]. #=> String
resp.snapshots[0].snapshot_arn #=> String
resp.snapshots[0].snapshot_create_time #=> Time
resp.snapshots[0].snapshot_name #=> String
resp.snapshots[0].snapshot_remaining_days #=> Integer
resp.snapshots[0].snapshot_retention_period #=> Integer
resp.snapshots[0].snapshot_retention_start_time #=> Time
resp.snapshots[0].status #=> String, one of "AVAILABLE", "CREATING", "DELETED", "CANCELLED", "FAILED", "COPYING"
resp.snapshots[0].total_backup_size_in_mega_bytes #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :end_time (Time, DateTime, Date, Integer, String)

    The timestamp showing when the snapshot creation finished.

  • :max_results (Integer)

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :namespace_arn (String)

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

  • :namespace_name (String)

    The namespace from which to list all snapshots.

  • :next_token (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.

  • :owner_account (String)

    The owner Amazon Web Services account of the snapshot.

  • :start_time (Time, DateTime, Date, Integer, String)

    The time when the creation of the snapshot was initiated.

Returns:

See Also:



1665
1666
1667
1668
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1665

def list_snapshots(params = {}, options = {})
  req = build_request(:list_snapshots, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags assigned to a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource to list tags for.

Returns:

See Also:



1695
1696
1697
1698
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1695

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_usage_limits(params = {}) ⇒ Types::ListUsageLimitsResponse

Lists all usage limits within Amazon Redshift Serverless.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_usage_limits({
  max_results: 1,
  next_token: "PaginationToken",
  resource_arn: "String",
  usage_type: "serverless-compute", # accepts serverless-compute, cross-region-datasharing
})

Response structure


resp.next_token #=> String
resp.usage_limits #=> Array
resp.usage_limits[0].amount #=> Integer
resp.usage_limits[0].breach_action #=> String, one of "log", "emit-metric", "deactivate"
resp.usage_limits[0].period #=> String, one of "daily", "weekly", "monthly"
resp.usage_limits[0].resource_arn #=> String
resp.usage_limits[0].usage_limit_arn #=> String
resp.usage_limits[0].usage_limit_id #=> String
resp.usage_limits[0].usage_type #=> String, one of "serverless-compute", "cross-region-datasharing"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 100.

  • :next_token (String)

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

  • :resource_arn (String)

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

  • :usage_type (String)

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

Returns:

See Also:



1751
1752
1753
1754
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1751

def list_usage_limits(params = {}, options = {})
  req = build_request(:list_usage_limits, params)
  req.send_request(options)
end

#list_workgroups(params = {}) ⇒ Types::ListWorkgroupsResponse

Returns information about a list of specified workgroups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_workgroups({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.next_token #=> String
resp.workgroups #=> Array
resp.workgroups[0].base_capacity #=> Integer
resp.workgroups[0].config_parameters #=> Array
resp.workgroups[0].config_parameters[0].parameter_key #=> String
resp.workgroups[0].config_parameters[0].parameter_value #=> String
resp.workgroups[0].creation_date #=> Time
resp.workgroups[0].endpoint.address #=> String
resp.workgroups[0].endpoint.port #=> Integer
resp.workgroups[0].endpoint.vpc_endpoints #=> Array
resp.workgroups[0].endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.workgroups[0].endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.workgroups[0].endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.workgroups[0].endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.workgroups[0].endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.workgroups[0].endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.workgroups[0].endpoint.vpc_endpoints[0].vpc_id #=> String
resp.workgroups[0].enhanced_vpc_routing #=> Boolean
resp.workgroups[0].namespace_name #=> String
resp.workgroups[0].publicly_accessible #=> Boolean
resp.workgroups[0].security_group_ids #=> Array
resp.workgroups[0].security_group_ids[0] #=> String
resp.workgroups[0].status #=> String, one of "CREATING", "AVAILABLE", "MODIFYING", "DELETING"
resp.workgroups[0].subnet_ids #=> Array
resp.workgroups[0].subnet_ids[0] #=> String
resp.workgroups[0].workgroup_arn #=> String
resp.workgroups[0].workgroup_id #=> String
resp.workgroups[0].workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String)

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

Returns:

See Also:



1816
1817
1818
1819
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1816

def list_workgroups(params = {}, options = {})
  req = build_request(:list_workgroups, params)
  req.send_request(options)
end

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse

Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  policy: "String", # required
  resource_arn: "String", # required
})

Response structure


resp.resource_policy.policy #=> String
resp.resource_policy.resource_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :policy (required, String)

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

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

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the account to create or update a resource policy for.

Returns:

See Also:



1858
1859
1860
1861
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1858

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
end

#restore_from_recovery_point(params = {}) ⇒ Types::RestoreFromRecoveryPointResponse

Restore the data from a recovery point.

Examples:

Request syntax with placeholder values


resp = client.restore_from_recovery_point({
  namespace_name: "NamespaceName", # required
  recovery_point_id: "String", # required
  workgroup_name: "WorkgroupName", # required
})

Response structure


resp.namespace.admin_username #=> String
resp.namespace.creation_date #=> Time
resp.namespace.db_name #=> String
resp.namespace.default_iam_role_arn #=> String
resp.namespace.iam_roles #=> Array
resp.namespace.iam_roles[0] #=> String
resp.namespace.kms_key_id #=> String
resp.namespace.log_exports #=> Array
resp.namespace.log_exports[0] #=> String, one of "useractivitylog", "userlog", "connectionlog"
resp.namespace.namespace_arn #=> String
resp.namespace.namespace_id #=> String
resp.namespace.namespace_name #=> String
resp.namespace.status #=> String, one of "AVAILABLE", "MODIFYING", "DELETING"
resp.recovery_point_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :namespace_name (required, String)

    The name of the namespace to restore data into.

  • :recovery_point_id (required, String)

    The unique identifier of the recovery point to restore from.

  • :workgroup_name (required, String)

    The name of the workgroup used to restore data.

Returns:

See Also:



1908
1909
1910
1911
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1908

def restore_from_recovery_point(params = {}, options = {})
  req = build_request(:restore_from_recovery_point, params)
  req.send_request(options)
end

#restore_from_snapshot(params = {}) ⇒ Types::RestoreFromSnapshotResponse

Restores a namespace from a snapshot.

Examples:

Request syntax with placeholder values


resp = client.restore_from_snapshot({
  namespace_name: "NamespaceName", # required
  owner_account: "String",
  snapshot_arn: "String",
  snapshot_name: "String",
  workgroup_name: "WorkgroupName", # required
})

Response structure


resp.namespace.admin_username #=> String
resp.namespace.creation_date #=> Time
resp.namespace.db_name #=> String
resp.namespace.default_iam_role_arn #=> String
resp.namespace.iam_roles #=> Array
resp.namespace.iam_roles[0] #=> String
resp.namespace.kms_key_id #=> String
resp.namespace.log_exports #=> Array
resp.namespace.log_exports[0] #=> String, one of "useractivitylog", "userlog", "connectionlog"
resp.namespace.namespace_arn #=> String
resp.namespace.namespace_id #=> String
resp.namespace.namespace_name #=> String
resp.namespace.status #=> String, one of "AVAILABLE", "MODIFYING", "DELETING"
resp. #=> String
resp.snapshot_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :namespace_name (required, String)

    The name of the namespace to restore the snapshot to.

  • :owner_account (String)

    The Amazon Web Services account that owns the snapshot.

  • :snapshot_arn (String)

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

  • :snapshot_name (String)

    The name of the snapshot to restore from.

  • :workgroup_name (required, String)

    The name of the workgroup used to restore the snapshot.

Returns:

See Also:



1968
1969
1970
1971
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1968

def restore_from_snapshot(params = {}, options = {})
  req = build_request(:restore_from_snapshot, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Assigns one or more tags to a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource to tag.

  • :tags (required, Array<Types::Tag>)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1999
2000
2001
2002
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 1999

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes a tag or set of tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the resource to remove tags from.

  • :tag_keys (required, Array<String>)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2025
2026
2027
2028
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 2025

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_endpoint_access(params = {}) ⇒ Types::UpdateEndpointAccessResponse

Updates an Amazon Redshift Serverless managed endpoint.

Examples:

Request syntax with placeholder values


resp = client.update_endpoint_access({
  endpoint_name: "String", # required
  vpc_security_group_ids: ["VpcSecurityGroupId"],
})

Response structure


resp.endpoint.address #=> String
resp.endpoint.endpoint_arn #=> String
resp.endpoint.endpoint_create_time #=> Time
resp.endpoint.endpoint_name #=> String
resp.endpoint.endpoint_status #=> String
resp.endpoint.port #=> Integer
resp.endpoint.subnet_ids #=> Array
resp.endpoint.subnet_ids[0] #=> String
resp.endpoint.vpc_endpoint.network_interfaces #=> Array
resp.endpoint.vpc_endpoint.network_interfaces[0].availability_zone #=> String
resp.endpoint.vpc_endpoint.network_interfaces[0].network_interface_id #=> String
resp.endpoint.vpc_endpoint.network_interfaces[0].private_ip_address #=> String
resp.endpoint.vpc_endpoint.network_interfaces[0].subnet_id #=> String
resp.endpoint.vpc_endpoint.vpc_endpoint_id #=> String
resp.endpoint.vpc_endpoint.vpc_id #=> String
resp.endpoint.vpc_security_groups #=> Array
resp.endpoint.vpc_security_groups[0].status #=> String
resp.endpoint.vpc_security_groups[0].vpc_security_group_id #=> String
resp.endpoint.workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :endpoint_name (required, String)

    The name of the VPC endpoint to update.

  • :vpc_security_group_ids (Array<String>)

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

Returns:

See Also:



2076
2077
2078
2079
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 2076

def update_endpoint_access(params = {}, options = {})
  req = build_request(:update_endpoint_access, params)
  req.send_request(options)
end

#update_namespace(params = {}) ⇒ Types::UpdateNamespaceResponse

Updates a namespace with the specified settings.

Examples:

Request syntax with placeholder values


resp = client.update_namespace({
  admin_user_password: "DbPassword",
  admin_username: "DbUser",
  default_iam_role_arn: "String",
  iam_roles: ["IamRoleArn"],
  kms_key_id: "String",
  log_exports: ["useractivitylog"], # accepts useractivitylog, userlog, connectionlog
  namespace_name: "NamespaceName", # required
})

Response structure


resp.namespace.admin_username #=> String
resp.namespace.creation_date #=> Time
resp.namespace.db_name #=> String
resp.namespace.default_iam_role_arn #=> String
resp.namespace.iam_roles #=> Array
resp.namespace.iam_roles[0] #=> String
resp.namespace.kms_key_id #=> String
resp.namespace.log_exports #=> Array
resp.namespace.log_exports[0] #=> String, one of "useractivitylog", "userlog", "connectionlog"
resp.namespace.namespace_arn #=> String
resp.namespace.namespace_id #=> String
resp.namespace.namespace_name #=> String
resp.namespace.status #=> String, one of "AVAILABLE", "MODIFYING", "DELETING"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :admin_user_password (String)

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

  • :admin_username (String)

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

  • :default_iam_role_arn (String)

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

  • :iam_roles (Array<String>)

    A list of IAM roles to associate with the namespace.

  • :kms_key_id (String)

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

  • :log_exports (Array<String>)

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

  • :namespace_name (required, String)

    The name of the namespace.

Returns:

See Also:



2145
2146
2147
2148
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 2145

def update_namespace(params = {}, options = {})
  req = build_request(:update_namespace, params)
  req.send_request(options)
end

#update_snapshot(params = {}) ⇒ Types::UpdateSnapshotResponse

Updates a snapshot.

Examples:

Request syntax with placeholder values


resp = client.update_snapshot({
  retention_period: 1,
  snapshot_name: "String", # required
})

Response structure


resp.snapshot.accounts_with_provisioned_restore_access #=> Array
resp.snapshot.accounts_with_provisioned_restore_access[0] #=> String
resp.snapshot.accounts_with_restore_access #=> Array
resp.snapshot.accounts_with_restore_access[0] #=> String
resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshot.admin_username #=> String
resp.snapshot.backup_progress_in_mega_bytes #=> Float
resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshot.elapsed_time_in_seconds #=> Integer
resp.snapshot.estimated_seconds_to_completion #=> Integer
resp.snapshot.kms_key_id #=> String
resp.snapshot.namespace_arn #=> String
resp.snapshot.namespace_name #=> String
resp.snapshot. #=> String
resp.snapshot.snapshot_arn #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.snapshot_name #=> String
resp.snapshot.snapshot_remaining_days #=> Integer
resp.snapshot.snapshot_retention_period #=> Integer
resp.snapshot.snapshot_retention_start_time #=> Time
resp.snapshot.status #=> String, one of "AVAILABLE", "CREATING", "DELETED", "CANCELLED", "FAILED", "COPYING"
resp.snapshot.total_backup_size_in_mega_bytes #=> Float

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :retention_period (Integer)

    The new retention period of the snapshot.

  • :snapshot_name (required, String)

    The name of the snapshot.

Returns:

See Also:



2198
2199
2200
2201
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 2198

def update_snapshot(params = {}, options = {})
  req = build_request(:update_snapshot, params)
  req.send_request(options)
end

#update_usage_limit(params = {}) ⇒ Types::UpdateUsageLimitResponse

Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.

Examples:

Request syntax with placeholder values


resp = client.update_usage_limit({
  amount: 1,
  breach_action: "log", # accepts log, emit-metric, deactivate
  usage_limit_id: "String", # required
})

Response structure


resp.usage_limit.amount #=> Integer
resp.usage_limit.breach_action #=> String, one of "log", "emit-metric", "deactivate"
resp.usage_limit.period #=> String, one of "daily", "weekly", "monthly"
resp.usage_limit.resource_arn #=> String
resp.usage_limit.usage_limit_arn #=> String
resp.usage_limit.usage_limit_id #=> String
resp.usage_limit.usage_type #=> String, one of "serverless-compute", "cross-region-datasharing"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :amount (Integer)

    The new limit amount. For more information about this parameter.

  • :breach_action (String)

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

  • :usage_limit_id (required, String)

    The identifier of the usage limit to update.

Returns:

See Also:



2242
2243
2244
2245
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 2242

def update_usage_limit(params = {}, options = {})
  req = build_request(:update_usage_limit, params)
  req.send_request(options)
end

#update_workgroup(params = {}) ⇒ Types::UpdateWorkgroupResponse

Updates a workgroup with the specified configuration settings.

Examples:

Request syntax with placeholder values


resp = client.update_workgroup({
  base_capacity: 1,
  config_parameters: [
    {
      parameter_key: "ParameterKey",
      parameter_value: "ParameterValue",
    },
  ],
  enhanced_vpc_routing: false,
  publicly_accessible: false,
  security_group_ids: ["SecurityGroupId"],
  subnet_ids: ["SubnetId"],
  workgroup_name: "WorkgroupName", # required
})

Response structure


resp.workgroup.base_capacity #=> Integer
resp.workgroup.config_parameters #=> Array
resp.workgroup.config_parameters[0].parameter_key #=> String
resp.workgroup.config_parameters[0].parameter_value #=> String
resp.workgroup.creation_date #=> Time
resp.workgroup.endpoint.address #=> String
resp.workgroup.endpoint.port #=> Integer
resp.workgroup.endpoint.vpc_endpoints #=> Array
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.workgroup.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.workgroup.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.workgroup.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.workgroup.enhanced_vpc_routing #=> Boolean
resp.workgroup.namespace_name #=> String
resp.workgroup.publicly_accessible #=> Boolean
resp.workgroup.security_group_ids #=> Array
resp.workgroup.security_group_ids[0] #=> String
resp.workgroup.status #=> String, one of "CREATING", "AVAILABLE", "MODIFYING", "DELETING"
resp.workgroup.subnet_ids #=> Array
resp.workgroup.subnet_ids[0] #=> String
resp.workgroup.workgroup_arn #=> String
resp.workgroup.workgroup_id #=> String
resp.workgroup.workgroup_name #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :base_capacity (Integer)

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

  • :config_parameters (Array<Types::ConfigParameter>)

    An array of parameters to set for advanced control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

  • :enhanced_vpc_routing (Boolean)

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

  • :publicly_accessible (Boolean)

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

  • :security_group_ids (Array<String>)

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

  • :subnet_ids (Array<String>)

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

  • :workgroup_name (required, String)

    The name of the workgroup to update.

Returns:

See Also:



2330
2331
2332
2333
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/client.rb', line 2330

def update_workgroup(params = {}, options = {})
  req = build_request(:update_workgroup, params)
  req.send_request(options)
end