You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.RedshiftServerless

Inherits:
AWS.Service show all
Identifier:
redshiftserverless
API Version:
2021-04-21
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This is an interface reference for Amazon Redshift Serverless. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless.

Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you focus on using your data to acquire new insights for your business and customers.

To learn more about Amazon Redshift Serverless, see What is Amazon Redshift Serverless.

Sending a Request Using RedshiftServerless

var redshiftserverless = new AWS.RedshiftServerless();
redshiftserverless.convertRecoveryPointToSnapshot(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the RedshiftServerless object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var redshiftserverless = new AWS.RedshiftServerless({apiVersion: '2021-04-21'});

You can also set the API version globally in AWS.config.apiVersions using the redshiftserverless service identifier:

AWS.config.apiVersions = {
  redshiftserverless: '2021-04-21',
  // other service API versions
};

var redshiftserverless = new AWS.RedshiftServerless();

Version:

  • 2021-04-21

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.RedshiftServerless(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a RedshiftServerless object

var redshiftserverless = new AWS.RedshiftServerless({apiVersion: '2021-04-21'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.RedshiftServerless.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.RedshiftServerless.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.RedshiftServerless.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

convertRecoveryPointToSnapshot(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the convertRecoveryPointToSnapshot operation

var params = {
  recoveryPointId: 'STRING_VALUE', /* required */
  snapshotName: 'STRING_VALUE', /* required */
  retentionPeriod: 'NUMBER_VALUE'
};
redshiftserverless.convertRecoveryPointToSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • recoveryPointId — (String)

      The unique identifier of the recovery point.

    • retentionPeriod — (Integer)

      How long to retain the snapshot.

    • snapshotName — (String)

      The name of the snapshot.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • snapshot — (map)

        The snapshot converted from the recovery point.

        • accountsWithProvisionedRestoreAccess — (Array<String>)

          All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

        • accountsWithRestoreAccess — (Array<String>)

          All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

        • actualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup in megabytes.

        • adminUsername — (String)

          The username of the database within a snapshot.

        • backupProgressInMegaBytes — (Float)

          The size in megabytes of the data that has been backed up to a snapshot.

        • currentBackupRateInMegaBytesPerSecond — (Float)

          The rate at which data is backed up into a snapshot in megabytes per second.

        • elapsedTimeInSeconds — (Integer)

          The amount of time it took to back up data into a snapshot.

        • estimatedSecondsToCompletion — (Integer)

          The estimated amount of seconds until the snapshot completes backup.

        • kmsKeyId — (String)

          The unique identifier of the KMS key used to encrypt the snapshot.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

        • namespaceName — (String)

          The name of the namepsace.

        • ownerAccount — (String)

          The owner Amazon Web Services; account of the snapshot.

        • snapshotArn — (String)

          The Amazon Resource Name (ARN) of the snapshot.

        • snapshotCreateTime — (Date)

          The timestamp of when the snapshot was created.

        • snapshotName — (String)

          The name of the snapshot.

        • snapshotRemainingDays — (Integer)

          The amount of days until the snapshot is deleted.

        • snapshotRetentionPeriod — (Integer)

          The period of time, in days, of how long the snapshot is retained.

        • snapshotRetentionStartTime — (Date)

          The timestamp of when data within the snapshot started getting retained.

        • status — (String)

          The status of the snapshot.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "DELETED"
          • "CANCELLED"
          • "FAILED"
          • "COPYING"
        • totalBackupSizeInMegaBytes — (Float)

          The total size, in megabytes, of how big the snapshot is.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createEndpointAccess(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Redshift Serverless managed VPC endpoint.

Service Reference:

Examples:

Calling the createEndpointAccess operation

var params = {
  endpointName: 'STRING_VALUE', /* required */
  subnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  workgroupName: 'STRING_VALUE', /* required */
  vpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshiftserverless.createEndpointAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • endpointName — (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.

    • subnetIds — (Array<String>)

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

    • vpcSecurityGroupIds — (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.

    • workgroupName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • endpoint — (map)

        The created VPC endpoint.

        • address — (String)

          The DNS address of the endpoint.

        • endpointArn — (String)

          The Amazon Resource Name (ARN) of the VPC endpoint.

        • endpointCreateTime — (Date)

          The time that the endpoint was created.

        • endpointName — (String)

          The name of the VPC endpoint.

        • endpointStatus — (String)

          The status of the VPC endpoint.

        • port — (Integer)

          The port number on which Amazon Redshift Serverless accepts incoming connections.

        • subnetIds — (Array<String>)

          The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.

        • vpcEndpoint — (map)

          The connection endpoint for connecting to Amazon Redshift Serverless.

          • networkInterfaces — (Array<map>)

            One or more network interfaces of the endpoint. Also known as an interface endpoint.

            • availabilityZone — (String)

              The availability Zone.

            • networkInterfaceId — (String)

              The unique identifier of the network interface.

            • privateIpAddress — (String)

              The IPv4 address of the network interface within the subnet.

            • subnetId — (String)

              The unique identifier of the subnet.

          • vpcEndpointId — (String)

            The connection endpoint ID for connecting to Amazon Redshift Serverless.

          • vpcId — (String)

            The VPC identifier that the endpoint is associated with.

        • vpcSecurityGroups — (Array<map>)

          The security groups associated with the endpoint.

          • status — (String)

            The status of the VPC security group.

          • vpcSecurityGroupId — (String)

            The unique identifier of the VPC security group.

        • workgroupName — (String)

          The name of the workgroup associated with the endpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createNamespace(params = {}, callback) ⇒ AWS.Request

Creates a namespace in Amazon Redshift Serverless.

Service Reference:

Examples:

Calling the createNamespace operation

var params = {
  namespaceName: 'STRING_VALUE', /* required */
  adminUserPassword: 'STRING_VALUE',
  adminUsername: 'STRING_VALUE',
  dbName: 'STRING_VALUE',
  defaultIamRoleArn: 'STRING_VALUE',
  iamRoles: [
    'STRING_VALUE',
    /* more items */
  ],
  kmsKeyId: 'STRING_VALUE',
  logExports: [
    useractivitylog | userlog | connectionlog,
    /* more items */
  ],
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
redshiftserverless.createNamespace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • adminUserPassword — (String)

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

    • adminUsername — (String)

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

    • dbName — (String)

      The name of the first database created in the namespace.

    • defaultIamRoleArn — (String)

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

    • iamRoles — (Array<String>)

      A list of IAM roles to associate with the namespace.

    • kmsKeyId — (String)

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

    • logExports — (Array<String>)

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

    • namespaceName — (String)

      The name of the namespace.

    • tags — (Array<map>)

      A list of tag instances.

      • keyrequired — (String)

        The key to use in the tag.

      • valuerequired — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • namespace — (map)

        The created namespace object.

        • adminUsername — (String)

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

        • creationDate — (Date)

          The date of when the namespace was created.

        • dbName — (String)

          The name of the first database created in the namespace.

        • defaultIamRoleArn — (String)

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

        • iamRoles — (Array<String>)

          A list of IAM roles to associate with the namespace.

        • kmsKeyId — (String)

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

        • logExports — (Array<String>)

          The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) associated with a namespace.

        • namespaceId — (String)

          The unique identifier of a namespace.

        • namespaceName — (String)

          The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

        • status — (String)

          The status of the namespace.

          Possible values include:
          • "AVAILABLE"
          • "MODIFYING"
          • "DELETING"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSnapshot(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createSnapshot operation

var params = {
  namespaceName: 'STRING_VALUE', /* required */
  snapshotName: 'STRING_VALUE', /* required */
  retentionPeriod: 'NUMBER_VALUE'
};
redshiftserverless.createSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • namespaceName — (String)

      The namespace to create a snapshot for.

    • retentionPeriod — (Integer)

      How long to retain the created snapshot.

    • snapshotName — (String)

      The name of the snapshot.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • snapshot — (map)

        The created snapshot object.

        • accountsWithProvisionedRestoreAccess — (Array<String>)

          All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

        • accountsWithRestoreAccess — (Array<String>)

          All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

        • actualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup in megabytes.

        • adminUsername — (String)

          The username of the database within a snapshot.

        • backupProgressInMegaBytes — (Float)

          The size in megabytes of the data that has been backed up to a snapshot.

        • currentBackupRateInMegaBytesPerSecond — (Float)

          The rate at which data is backed up into a snapshot in megabytes per second.

        • elapsedTimeInSeconds — (Integer)

          The amount of time it took to back up data into a snapshot.

        • estimatedSecondsToCompletion — (Integer)

          The estimated amount of seconds until the snapshot completes backup.

        • kmsKeyId — (String)

          The unique identifier of the KMS key used to encrypt the snapshot.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

        • namespaceName — (String)

          The name of the namepsace.

        • ownerAccount — (String)

          The owner Amazon Web Services; account of the snapshot.

        • snapshotArn — (String)

          The Amazon Resource Name (ARN) of the snapshot.

        • snapshotCreateTime — (Date)

          The timestamp of when the snapshot was created.

        • snapshotName — (String)

          The name of the snapshot.

        • snapshotRemainingDays — (Integer)

          The amount of days until the snapshot is deleted.

        • snapshotRetentionPeriod — (Integer)

          The period of time, in days, of how long the snapshot is retained.

        • snapshotRetentionStartTime — (Date)

          The timestamp of when data within the snapshot started getting retained.

        • status — (String)

          The status of the snapshot.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "DELETED"
          • "CANCELLED"
          • "FAILED"
          • "COPYING"
        • totalBackupSizeInMegaBytes — (Float)

          The total size, in megabytes, of how big the snapshot is.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createUsageLimit(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createUsageLimit operation

var params = {
  amount: 'NUMBER_VALUE', /* required */
  resourceArn: 'STRING_VALUE', /* required */
  usageType: serverless-compute | cross-region-datasharing, /* required */
  breachAction: log | emit-metric | deactivate,
  period: daily | weekly | monthly
};
redshiftserverless.createUsageLimit(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • amount — (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.

    • breachAction — (String)

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

      Possible values include:
      • "log"
      • "emit-metric"
      • "deactivate"
    • period — (String)

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

      Possible values include:
      • "daily"
      • "weekly"
      • "monthly"
    • resourceArn — (String)

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

    • usageType — (String)

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

      Possible values include:
      • "serverless-compute"
      • "cross-region-datasharing"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • usageLimit — (map)

        The returned usage limit object.

        • amount — (Integer)

          The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

        • breachAction — (String)

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

          Possible values include:
          • "log"
          • "emit-metric"
          • "deactivate"
        • period — (String)

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

          Possible values include:
          • "daily"
          • "weekly"
          • "monthly"
        • resourceArn — (String)

          The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

        • usageLimitArn — (String)

          The Amazon Resource Name (ARN) of the resource associated with the usage limit.

        • usageLimitId — (String)

          The identifier of the usage limit.

        • usageType — (String)

          The Amazon Redshift Serverless feature to limit.

          Possible values include:
          • "serverless-compute"
          • "cross-region-datasharing"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createWorkgroup(params = {}, callback) ⇒ AWS.Request

Creates an workgroup in Amazon Redshift Serverless.

Service Reference:

Examples:

Calling the createWorkgroup operation

var params = {
  namespaceName: 'STRING_VALUE', /* required */
  workgroupName: 'STRING_VALUE', /* required */
  baseCapacity: 'NUMBER_VALUE',
  configParameters: [
    {
      parameterKey: 'STRING_VALUE',
      parameterValue: 'STRING_VALUE'
    },
    /* more items */
  ],
  enhancedVpcRouting: true || false,
  publiclyAccessible: true || false,
  securityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  subnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
redshiftserverless.createWorkgroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • baseCapacity — (Integer)

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

    • configParameters — (Array<map>)

      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.

      • parameterKey — (String)

        The key of the parameter. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

      • parameterValue — (String)

        The value of the parameter to set.

    • enhancedVpcRouting — (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.

    • namespaceName — (String)

      The name of the namespace to associate with the workgroup.

    • publiclyAccessible — (Boolean)

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

    • securityGroupIds — (Array<String>)

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

    • subnetIds — (Array<String>)

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

    • tags — (Array<map>)

      A array of tag instances.

      • keyrequired — (String)

        The key to use in the tag.

      • valuerequired — (String)

        The value of the tag.

    • workgroupName — (String)

      The name of the created workgroup.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • workgroup — (map)

        The created workgroup object.

        • baseCapacity — (Integer)

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

        • configParameters — (Array<map>)

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

          • parameterKey — (String)

            The key of the parameter. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

          • parameterValue — (String)

            The value of the parameter to set.

        • creationDate — (Date)

          The creation date of the workgroup.

        • endpoint — (map)

          The endpoint that is created from the workgroup.

          • address — (String)

            The DNS address of the VPC endpoint.

          • port — (Integer)

            The port that Amazon Redshift Serverless listens on.

          • vpcEndpoints — (Array<map>)

            An array of VpcEndpoint objects.

            • networkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • availabilityZone — (String)

                The availability Zone.

              • networkInterfaceId — (String)

                The unique identifier of the network interface.

              • privateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • subnetId — (String)

                The unique identifier of the subnet.

            • vpcEndpointId — (String)

              The connection endpoint ID for connecting to Amazon Redshift Serverless.

            • vpcId — (String)

              The VPC identifier that the endpoint is associated with.

        • enhancedVpcRouting — (Boolean)

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

        • namespaceName — (String)

          The namespace the workgroup is associated with.

        • publiclyAccessible — (Boolean)

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

        • securityGroupIds — (Array<String>)

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

        • status — (String)

          The status of the workgroup.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "MODIFYING"
          • "DELETING"
        • subnetIds — (Array<String>)

          An array of subnet IDs the workgroup is associated with.

        • workgroupArn — (String)

          The Amazon Resource Name (ARN) that links to the workgroup.

        • workgroupId — (String)

          The unique identifier of the workgroup.

        • workgroupName — (String)

          The name of the workgroup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteEndpointAccess(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Redshift Serverless managed VPC endpoint.

Service Reference:

Examples:

Calling the deleteEndpointAccess operation

var params = {
  endpointName: 'STRING_VALUE' /* required */
};
redshiftserverless.deleteEndpointAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • endpointName — (String)

      The name of the VPC endpoint to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • endpoint — (map)

        The deleted VPC endpoint.

        • address — (String)

          The DNS address of the endpoint.

        • endpointArn — (String)

          The Amazon Resource Name (ARN) of the VPC endpoint.

        • endpointCreateTime — (Date)

          The time that the endpoint was created.

        • endpointName — (String)

          The name of the VPC endpoint.

        • endpointStatus — (String)

          The status of the VPC endpoint.

        • port — (Integer)

          The port number on which Amazon Redshift Serverless accepts incoming connections.

        • subnetIds — (Array<String>)

          The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.

        • vpcEndpoint — (map)

          The connection endpoint for connecting to Amazon Redshift Serverless.

          • networkInterfaces — (Array<map>)

            One or more network interfaces of the endpoint. Also known as an interface endpoint.

            • availabilityZone — (String)

              The availability Zone.

            • networkInterfaceId — (String)

              The unique identifier of the network interface.

            • privateIpAddress — (String)

              The IPv4 address of the network interface within the subnet.

            • subnetId — (String)

              The unique identifier of the subnet.

          • vpcEndpointId — (String)

            The connection endpoint ID for connecting to Amazon Redshift Serverless.

          • vpcId — (String)

            The VPC identifier that the endpoint is associated with.

        • vpcSecurityGroups — (Array<map>)

          The security groups associated with the endpoint.

          • status — (String)

            The status of the VPC security group.

          • vpcSecurityGroupId — (String)

            The unique identifier of the VPC security group.

        • workgroupName — (String)

          The name of the workgroup associated with the endpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteNamespace(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteNamespace operation

var params = {
  namespaceName: 'STRING_VALUE', /* required */
  finalSnapshotName: 'STRING_VALUE',
  finalSnapshotRetentionPeriod: 'NUMBER_VALUE'
};
redshiftserverless.deleteNamespace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • finalSnapshotName — (String)

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

    • finalSnapshotRetentionPeriod — (Integer)

      How long to retain the final snapshot.

    • namespaceName — (String)

      The name of the namespace to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • namespace — (map)

        The deleted namespace object.

        • adminUsername — (String)

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

        • creationDate — (Date)

          The date of when the namespace was created.

        • dbName — (String)

          The name of the first database created in the namespace.

        • defaultIamRoleArn — (String)

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

        • iamRoles — (Array<String>)

          A list of IAM roles to associate with the namespace.

        • kmsKeyId — (String)

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

        • logExports — (Array<String>)

          The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) associated with a namespace.

        • namespaceId — (String)

          The unique identifier of a namespace.

        • namespaceName — (String)

          The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

        • status — (String)

          The status of the namespace.

          Possible values include:
          • "AVAILABLE"
          • "MODIFYING"
          • "DELETING"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request

Deletes the specified resource policy.

Service Reference:

Examples:

Calling the deleteResourcePolicy operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
redshiftserverless.deleteResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSnapshot(params = {}, callback) ⇒ AWS.Request

Deletes a snapshot from Amazon Redshift Serverless.

Service Reference:

Examples:

Calling the deleteSnapshot operation

var params = {
  snapshotName: 'STRING_VALUE' /* required */
};
redshiftserverless.deleteSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • snapshotName — (String)

      The name of the snapshot to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • snapshot — (map)

        The deleted snapshot object.

        • accountsWithProvisionedRestoreAccess — (Array<String>)

          All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

        • accountsWithRestoreAccess — (Array<String>)

          All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

        • actualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup in megabytes.

        • adminUsername — (String)

          The username of the database within a snapshot.

        • backupProgressInMegaBytes — (Float)

          The size in megabytes of the data that has been backed up to a snapshot.

        • currentBackupRateInMegaBytesPerSecond — (Float)

          The rate at which data is backed up into a snapshot in megabytes per second.

        • elapsedTimeInSeconds — (Integer)

          The amount of time it took to back up data into a snapshot.

        • estimatedSecondsToCompletion — (Integer)

          The estimated amount of seconds until the snapshot completes backup.

        • kmsKeyId — (String)

          The unique identifier of the KMS key used to encrypt the snapshot.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

        • namespaceName — (String)

          The name of the namepsace.

        • ownerAccount — (String)

          The owner Amazon Web Services; account of the snapshot.

        • snapshotArn — (String)

          The Amazon Resource Name (ARN) of the snapshot.

        • snapshotCreateTime — (Date)

          The timestamp of when the snapshot was created.

        • snapshotName — (String)

          The name of the snapshot.

        • snapshotRemainingDays — (Integer)

          The amount of days until the snapshot is deleted.

        • snapshotRetentionPeriod — (Integer)

          The period of time, in days, of how long the snapshot is retained.

        • snapshotRetentionStartTime — (Date)

          The timestamp of when data within the snapshot started getting retained.

        • status — (String)

          The status of the snapshot.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "DELETED"
          • "CANCELLED"
          • "FAILED"
          • "COPYING"
        • totalBackupSizeInMegaBytes — (Float)

          The total size, in megabytes, of how big the snapshot is.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteUsageLimit(params = {}, callback) ⇒ AWS.Request

Deletes a usage limit from Amazon Redshift Serverless.

Service Reference:

Examples:

Calling the deleteUsageLimit operation

var params = {
  usageLimitId: 'STRING_VALUE' /* required */
};
redshiftserverless.deleteUsageLimit(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • usageLimitId — (String)

      The unique identifier of the usage limit to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • usageLimit — (map)

        The deleted usage limit object.

        • amount — (Integer)

          The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

        • breachAction — (String)

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

          Possible values include:
          • "log"
          • "emit-metric"
          • "deactivate"
        • period — (String)

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

          Possible values include:
          • "daily"
          • "weekly"
          • "monthly"
        • resourceArn — (String)

          The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

        • usageLimitArn — (String)

          The Amazon Resource Name (ARN) of the resource associated with the usage limit.

        • usageLimitId — (String)

          The identifier of the usage limit.

        • usageType — (String)

          The Amazon Redshift Serverless feature to limit.

          Possible values include:
          • "serverless-compute"
          • "cross-region-datasharing"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteWorkgroup(params = {}, callback) ⇒ AWS.Request

Deletes a workgroup.

Service Reference:

Examples:

Calling the deleteWorkgroup operation

var params = {
  workgroupName: 'STRING_VALUE' /* required */
};
redshiftserverless.deleteWorkgroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workgroupName — (String)

      The name of the workgroup to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • workgroup — (map)

        The deleted workgroup object.

        • baseCapacity — (Integer)

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

        • configParameters — (Array<map>)

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

          • parameterKey — (String)

            The key of the parameter. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

          • parameterValue — (String)

            The value of the parameter to set.

        • creationDate — (Date)

          The creation date of the workgroup.

        • endpoint — (map)

          The endpoint that is created from the workgroup.

          • address — (String)

            The DNS address of the VPC endpoint.

          • port — (Integer)

            The port that Amazon Redshift Serverless listens on.

          • vpcEndpoints — (Array<map>)

            An array of VpcEndpoint objects.

            • networkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • availabilityZone — (String)

                The availability Zone.

              • networkInterfaceId — (String)

                The unique identifier of the network interface.

              • privateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • subnetId — (String)

                The unique identifier of the subnet.

            • vpcEndpointId — (String)

              The connection endpoint ID for connecting to Amazon Redshift Serverless.

            • vpcId — (String)

              The VPC identifier that the endpoint is associated with.

        • enhancedVpcRouting — (Boolean)

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

        • namespaceName — (String)

          The namespace the workgroup is associated with.

        • publiclyAccessible — (Boolean)

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

        • securityGroupIds — (Array<String>)

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

        • status — (String)

          The status of the workgroup.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "MODIFYING"
          • "DELETING"
        • subnetIds — (Array<String>)

          An array of subnet IDs the workgroup is associated with.

        • workgroupArn — (String)

          The Amazon Resource Name (ARN) that links to the workgroup.

        • workgroupId — (String)

          The unique identifier of the workgroup.

        • workgroupName — (String)

          The name of the workgroup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getCredentials(params = {}, callback) ⇒ AWS.Request

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> 

Service Reference:

Examples:

Calling the getCredentials operation

var params = {
  workgroupName: 'STRING_VALUE', /* required */
  dbName: 'STRING_VALUE',
  durationSeconds: 'NUMBER_VALUE'
};
redshiftserverless.getCredentials(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • dbName — (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

    • durationSeconds — (Integer)

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

    • workgroupName — (String)

      The name of the workgroup associated with the database.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • dbPassword — (String)

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

      • dbUser — (String)

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

      • expiration — (Date)

        The date and time the password in DbPassword expires.

      • nextRefreshTime — (Date)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getEndpointAccess(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getEndpointAccess operation

var params = {
  endpointName: 'STRING_VALUE' /* required */
};
redshiftserverless.getEndpointAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • endpointName — (String)

      The name of the VPC endpoint to return information for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • endpoint — (map)

        The returned VPC endpoint.

        • address — (String)

          The DNS address of the endpoint.

        • endpointArn — (String)

          The Amazon Resource Name (ARN) of the VPC endpoint.

        • endpointCreateTime — (Date)

          The time that the endpoint was created.

        • endpointName — (String)

          The name of the VPC endpoint.

        • endpointStatus — (String)

          The status of the VPC endpoint.

        • port — (Integer)

          The port number on which Amazon Redshift Serverless accepts incoming connections.

        • subnetIds — (Array<String>)

          The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.

        • vpcEndpoint — (map)

          The connection endpoint for connecting to Amazon Redshift Serverless.

          • networkInterfaces — (Array<map>)

            One or more network interfaces of the endpoint. Also known as an interface endpoint.

            • availabilityZone — (String)

              The availability Zone.

            • networkInterfaceId — (String)

              The unique identifier of the network interface.

            • privateIpAddress — (String)

              The IPv4 address of the network interface within the subnet.

            • subnetId — (String)

              The unique identifier of the subnet.

          • vpcEndpointId — (String)

            The connection endpoint ID for connecting to Amazon Redshift Serverless.

          • vpcId — (String)

            The VPC identifier that the endpoint is associated with.

        • vpcSecurityGroups — (Array<map>)

          The security groups associated with the endpoint.

          • status — (String)

            The status of the VPC security group.

          • vpcSecurityGroupId — (String)

            The unique identifier of the VPC security group.

        • workgroupName — (String)

          The name of the workgroup associated with the endpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getNamespace(params = {}, callback) ⇒ AWS.Request

Returns information about a namespace in Amazon Redshift Serverless.

Service Reference:

Examples:

Calling the getNamespace operation

var params = {
  namespaceName: 'STRING_VALUE' /* required */
};
redshiftserverless.getNamespace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • namespaceName — (String)

      The name of the namespace to retrieve information for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • namespace — (map)

        The returned namespace object.

        • adminUsername — (String)

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

        • creationDate — (Date)

          The date of when the namespace was created.

        • dbName — (String)

          The name of the first database created in the namespace.

        • defaultIamRoleArn — (String)

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

        • iamRoles — (Array<String>)

          A list of IAM roles to associate with the namespace.

        • kmsKeyId — (String)

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

        • logExports — (Array<String>)

          The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) associated with a namespace.

        • namespaceId — (String)

          The unique identifier of a namespace.

        • namespaceName — (String)

          The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

        • status — (String)

          The status of the namespace.

          Possible values include:
          • "AVAILABLE"
          • "MODIFYING"
          • "DELETING"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRecoveryPoint(params = {}, callback) ⇒ AWS.Request

Returns information about a recovery point.

Service Reference:

Examples:

Calling the getRecoveryPoint operation

var params = {
  recoveryPointId: 'STRING_VALUE' /* required */
};
redshiftserverless.getRecoveryPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • recoveryPointId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • recoveryPoint — (map)

        The returned recovery point object.

        • namespaceName — (String)

          The name of the namespace the recovery point is associated with.

        • recoveryPointCreateTime — (Date)

          The time the recovery point is created.

        • recoveryPointId — (String)

          The unique identifier of the recovery point.

        • totalSizeInMegaBytes — (Float)

          The total size of the data in the recovery point in megabytes.

        • workgroupName — (String)

          The name of the workgroup the recovery point is associated with.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getResourcePolicy(params = {}, callback) ⇒ AWS.Request

Returns a resource policy.

Service Reference:

Examples:

Calling the getResourcePolicy operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
redshiftserverless.getResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • resourcePolicy — (map)

        The returned resource policy.

        • policy — (String)

          The resource policy.

        • resourceArn — (String)

          The Amazon Resource Name (ARN) of the policy.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSnapshot(params = {}, callback) ⇒ AWS.Request

Returns information about a specific snapshot.

Service Reference:

Examples:

Calling the getSnapshot operation

var params = {
  ownerAccount: 'STRING_VALUE',
  snapshotArn: 'STRING_VALUE',
  snapshotName: 'STRING_VALUE'
};
redshiftserverless.getSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ownerAccount — (String)

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

    • snapshotArn — (String)

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

    • snapshotName — (String)

      The name of the snapshot to return.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • snapshot — (map)

        The returned snapshot object.

        • accountsWithProvisionedRestoreAccess — (Array<String>)

          All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

        • accountsWithRestoreAccess — (Array<String>)

          All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

        • actualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup in megabytes.

        • adminUsername — (String)

          The username of the database within a snapshot.

        • backupProgressInMegaBytes — (Float)

          The size in megabytes of the data that has been backed up to a snapshot.

        • currentBackupRateInMegaBytesPerSecond — (Float)

          The rate at which data is backed up into a snapshot in megabytes per second.

        • elapsedTimeInSeconds — (Integer)

          The amount of time it took to back up data into a snapshot.

        • estimatedSecondsToCompletion — (Integer)

          The estimated amount of seconds until the snapshot completes backup.

        • kmsKeyId — (String)

          The unique identifier of the KMS key used to encrypt the snapshot.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

        • namespaceName — (String)

          The name of the namepsace.

        • ownerAccount — (String)

          The owner Amazon Web Services; account of the snapshot.

        • snapshotArn — (String)

          The Amazon Resource Name (ARN) of the snapshot.

        • snapshotCreateTime — (Date)

          The timestamp of when the snapshot was created.

        • snapshotName — (String)

          The name of the snapshot.

        • snapshotRemainingDays — (Integer)

          The amount of days until the snapshot is deleted.

        • snapshotRetentionPeriod — (Integer)

          The period of time, in days, of how long the snapshot is retained.

        • snapshotRetentionStartTime — (Date)

          The timestamp of when data within the snapshot started getting retained.

        • status — (String)

          The status of the snapshot.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "DELETED"
          • "CANCELLED"
          • "FAILED"
          • "COPYING"
        • totalBackupSizeInMegaBytes — (Float)

          The total size, in megabytes, of how big the snapshot is.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getUsageLimit(params = {}, callback) ⇒ AWS.Request

Returns information about a usage limit.

Service Reference:

Examples:

Calling the getUsageLimit operation

var params = {
  usageLimitId: 'STRING_VALUE' /* required */
};
redshiftserverless.getUsageLimit(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • usageLimitId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • usageLimit — (map)

        The returned usage limit object.

        • amount — (Integer)

          The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

        • breachAction — (String)

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

          Possible values include:
          • "log"
          • "emit-metric"
          • "deactivate"
        • period — (String)

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

          Possible values include:
          • "daily"
          • "weekly"
          • "monthly"
        • resourceArn — (String)

          The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

        • usageLimitArn — (String)

          The Amazon Resource Name (ARN) of the resource associated with the usage limit.

        • usageLimitId — (String)

          The identifier of the usage limit.

        • usageType — (String)

          The Amazon Redshift Serverless feature to limit.

          Possible values include:
          • "serverless-compute"
          • "cross-region-datasharing"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getWorkgroup(params = {}, callback) ⇒ AWS.Request

Returns information about a specific workgroup.

Service Reference:

Examples:

Calling the getWorkgroup operation

var params = {
  workgroupName: 'STRING_VALUE' /* required */
};
redshiftserverless.getWorkgroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • workgroupName — (String)

      The name of the workgroup to return information for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • workgroup — (map)

        The returned workgroup object.

        • baseCapacity — (Integer)

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

        • configParameters — (Array<map>)

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

          • parameterKey — (String)

            The key of the parameter. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

          • parameterValue — (String)

            The value of the parameter to set.

        • creationDate — (Date)

          The creation date of the workgroup.

        • endpoint — (map)

          The endpoint that is created from the workgroup.

          • address — (String)

            The DNS address of the VPC endpoint.

          • port — (Integer)

            The port that Amazon Redshift Serverless listens on.

          • vpcEndpoints — (Array<map>)

            An array of VpcEndpoint objects.

            • networkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • availabilityZone — (String)

                The availability Zone.

              • networkInterfaceId — (String)

                The unique identifier of the network interface.

              • privateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • subnetId — (String)

                The unique identifier of the subnet.

            • vpcEndpointId — (String)

              The connection endpoint ID for connecting to Amazon Redshift Serverless.

            • vpcId — (String)

              The VPC identifier that the endpoint is associated with.

        • enhancedVpcRouting — (Boolean)

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

        • namespaceName — (String)

          The namespace the workgroup is associated with.

        • publiclyAccessible — (Boolean)

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

        • securityGroupIds — (Array<String>)

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

        • status — (String)

          The status of the workgroup.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "MODIFYING"
          • "DELETING"
        • subnetIds — (Array<String>)

          An array of subnet IDs the workgroup is associated with.

        • workgroupArn — (String)

          The Amazon Resource Name (ARN) that links to the workgroup.

        • workgroupId — (String)

          The unique identifier of the workgroup.

        • workgroupName — (String)

          The name of the workgroup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listEndpointAccess(params = {}, callback) ⇒ AWS.Request

Returns an array of EndpointAccess objects and relevant information.

Service Reference:

Examples:

Calling the listEndpointAccess operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  vpcId: 'STRING_VALUE',
  workgroupName: 'STRING_VALUE'
};
redshiftserverless.listEndpointAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

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

    • nextToken — (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.

    • vpcId — (String)

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

    • workgroupName — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • endpoints — (Array<map>)

        The returned VPC endpoints.

        • address — (String)

          The DNS address of the endpoint.

        • endpointArn — (String)

          The Amazon Resource Name (ARN) of the VPC endpoint.

        • endpointCreateTime — (Date)

          The time that the endpoint was created.

        • endpointName — (String)

          The name of the VPC endpoint.

        • endpointStatus — (String)

          The status of the VPC endpoint.

        • port — (Integer)

          The port number on which Amazon Redshift Serverless accepts incoming connections.

        • subnetIds — (Array<String>)

          The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.

        • vpcEndpoint — (map)

          The connection endpoint for connecting to Amazon Redshift Serverless.

          • networkInterfaces — (Array<map>)

            One or more network interfaces of the endpoint. Also known as an interface endpoint.

            • availabilityZone — (String)

              The availability Zone.

            • networkInterfaceId — (String)

              The unique identifier of the network interface.

            • privateIpAddress — (String)

              The IPv4 address of the network interface within the subnet.

            • subnetId — (String)

              The unique identifier of the subnet.

          • vpcEndpointId — (String)

            The connection endpoint ID for connecting to Amazon Redshift Serverless.

          • vpcId — (String)

            The VPC identifier that the endpoint is associated with.

        • vpcSecurityGroups — (Array<map>)

          The security groups associated with the endpoint.

          • status — (String)

            The status of the VPC security group.

          • vpcSecurityGroupId — (String)

            The unique identifier of the VPC security group.

        • workgroupName — (String)

          The name of the workgroup associated with the endpoint.

      • nextToken — (String)

        When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listNamespaces(params = {}, callback) ⇒ AWS.Request

Returns information about a list of specified namespaces.

Service Reference:

Examples:

Calling the listNamespaces operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
redshiftserverless.listNamespaces(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

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

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • namespaces — (Array<map>)

        The list of returned namespaces.

        • adminUsername — (String)

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

        • creationDate — (Date)

          The date of when the namespace was created.

        • dbName — (String)

          The name of the first database created in the namespace.

        • defaultIamRoleArn — (String)

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

        • iamRoles — (Array<String>)

          A list of IAM roles to associate with the namespace.

        • kmsKeyId — (String)

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

        • logExports — (Array<String>)

          The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) associated with a namespace.

        • namespaceId — (String)

          The unique identifier of a namespace.

        • namespaceName — (String)

          The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

        • status — (String)

          The status of the namespace.

          Possible values include:
          • "AVAILABLE"
          • "MODIFYING"
          • "DELETING"
      • nextToken — (String)

        When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listRecoveryPoints(params = {}, callback) ⇒ AWS.Request

Returns an array of recovery points.

Service Reference:

Examples:

Calling the listRecoveryPoints operation

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  namespaceName: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
redshiftserverless.listRecoveryPoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • endTime — (Date)

      The time when creation of the recovery point finished.

    • maxResults — (Integer)

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

    • namespaceName — (String)

      The name of the namespace to list recovery points for.

    • nextToken — (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.

    • startTime — (Date)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (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.

      • recoveryPoints — (Array<map>)

        The returned recovery point objects.

        • namespaceName — (String)

          The name of the namespace the recovery point is associated with.

        • recoveryPointCreateTime — (Date)

          The time the recovery point is created.

        • recoveryPointId — (String)

          The unique identifier of the recovery point.

        • totalSizeInMegaBytes — (Float)

          The total size of the data in the recovery point in megabytes.

        • workgroupName — (String)

          The name of the workgroup the recovery point is associated with.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSnapshots(params = {}, callback) ⇒ AWS.Request

Returns a list of snapshots.

Service Reference:

Examples:

Calling the listSnapshots operation

var params = {
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  namespaceArn: 'STRING_VALUE',
  namespaceName: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  ownerAccount: 'STRING_VALUE',
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
redshiftserverless.listSnapshots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • endTime — (Date)

      The timestamp showing when the snapshot creation finished.

    • maxResults — (Integer)

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

    • namespaceArn — (String)

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

    • namespaceName — (String)

      The namespace from which to list all snapshots.

    • nextToken — (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.

    • ownerAccount — (String)

      The owner Amazon Web Services account of the snapshot.

    • startTime — (Date)

      The time when the creation of the snapshot was initiated.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

      • snapshots — (Array<map>)

        All of the returned snapshot objects.

        • accountsWithProvisionedRestoreAccess — (Array<String>)

          All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

        • accountsWithRestoreAccess — (Array<String>)

          All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

        • actualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup in megabytes.

        • adminUsername — (String)

          The username of the database within a snapshot.

        • backupProgressInMegaBytes — (Float)

          The size in megabytes of the data that has been backed up to a snapshot.

        • currentBackupRateInMegaBytesPerSecond — (Float)

          The rate at which data is backed up into a snapshot in megabytes per second.

        • elapsedTimeInSeconds — (Integer)

          The amount of time it took to back up data into a snapshot.

        • estimatedSecondsToCompletion — (Integer)

          The estimated amount of seconds until the snapshot completes backup.

        • kmsKeyId — (String)

          The unique identifier of the KMS key used to encrypt the snapshot.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

        • namespaceName — (String)

          The name of the namepsace.

        • ownerAccount — (String)

          The owner Amazon Web Services; account of the snapshot.

        • snapshotArn — (String)

          The Amazon Resource Name (ARN) of the snapshot.

        • snapshotCreateTime — (Date)

          The timestamp of when the snapshot was created.

        • snapshotName — (String)

          The name of the snapshot.

        • snapshotRemainingDays — (Integer)

          The amount of days until the snapshot is deleted.

        • snapshotRetentionPeriod — (Integer)

          The period of time, in days, of how long the snapshot is retained.

        • snapshotRetentionStartTime — (Date)

          The timestamp of when data within the snapshot started getting retained.

        • status — (String)

          The status of the snapshot.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "DELETED"
          • "CANCELLED"
          • "FAILED"
          • "COPYING"
        • totalBackupSizeInMegaBytes — (Float)

          The total size, in megabytes, of how big the snapshot is.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags assigned to a resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
redshiftserverless.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (Array<map>)

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

        • keyrequired — (String)

          The key to use in the tag.

        • valuerequired — (String)

          The value of the tag.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listUsageLimits(params = {}, callback) ⇒ AWS.Request

Lists all usage limits within Amazon Redshift Serverless.

Service Reference:

Examples:

Calling the listUsageLimits operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resourceArn: 'STRING_VALUE',
  usageType: serverless-compute | cross-region-datasharing
};
redshiftserverless.listUsageLimits(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (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.

    • nextToken — (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.

    • resourceArn — (String)

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

    • usageType — (String)

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

      Possible values include:
      • "serverless-compute"
      • "cross-region-datasharing"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

      • usageLimits — (Array<map>)

        An array of returned usage limit objects.

        • amount — (Integer)

          The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

        • breachAction — (String)

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

          Possible values include:
          • "log"
          • "emit-metric"
          • "deactivate"
        • period — (String)

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

          Possible values include:
          • "daily"
          • "weekly"
          • "monthly"
        • resourceArn — (String)

          The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

        • usageLimitArn — (String)

          The Amazon Resource Name (ARN) of the resource associated with the usage limit.

        • usageLimitId — (String)

          The identifier of the usage limit.

        • usageType — (String)

          The Amazon Redshift Serverless feature to limit.

          Possible values include:
          • "serverless-compute"
          • "cross-region-datasharing"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listWorkgroups(params = {}, callback) ⇒ AWS.Request

Returns information about a list of specified workgroups.

Service Reference:

Examples:

Calling the listWorkgroups operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
redshiftserverless.listWorkgroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (Integer)

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

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.

      • workgroups — (Array<map>)

        The returned array of workgroups.

        • baseCapacity — (Integer)

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

        • configParameters — (Array<map>)

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

          • parameterKey — (String)

            The key of the parameter. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

          • parameterValue — (String)

            The value of the parameter to set.

        • creationDate — (Date)

          The creation date of the workgroup.

        • endpoint — (map)

          The endpoint that is created from the workgroup.

          • address — (String)

            The DNS address of the VPC endpoint.

          • port — (Integer)

            The port that Amazon Redshift Serverless listens on.

          • vpcEndpoints — (Array<map>)

            An array of VpcEndpoint objects.

            • networkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • availabilityZone — (String)

                The availability Zone.

              • networkInterfaceId — (String)

                The unique identifier of the network interface.

              • privateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • subnetId — (String)

                The unique identifier of the subnet.

            • vpcEndpointId — (String)

              The connection endpoint ID for connecting to Amazon Redshift Serverless.

            • vpcId — (String)

              The VPC identifier that the endpoint is associated with.

        • enhancedVpcRouting — (Boolean)

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

        • namespaceName — (String)

          The namespace the workgroup is associated with.

        • publiclyAccessible — (Boolean)

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

        • securityGroupIds — (Array<String>)

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

        • status — (String)

          The status of the workgroup.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "MODIFYING"
          • "DELETING"
        • subnetIds — (Array<String>)

          An array of subnet IDs the workgroup is associated with.

        • workgroupArn — (String)

          The Amazon Resource Name (ARN) that links to the workgroup.

        • workgroupId — (String)

          The unique identifier of the workgroup.

        • workgroupName — (String)

          The name of the workgroup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putResourcePolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the putResourcePolicy operation

var params = {
  policy: 'STRING_VALUE', /* required */
  resourceArn: 'STRING_VALUE' /* required */
};
redshiftserverless.putResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • policy — (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\" }]}"

    • resourceArn — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • resourcePolicy — (map)

        The policy that was created or updated.

        • policy — (String)

          The resource policy.

        • resourceArn — (String)

          The Amazon Resource Name (ARN) of the policy.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

restoreFromRecoveryPoint(params = {}, callback) ⇒ AWS.Request

Restore the data from a recovery point.

Service Reference:

Examples:

Calling the restoreFromRecoveryPoint operation

var params = {
  namespaceName: 'STRING_VALUE', /* required */
  recoveryPointId: 'STRING_VALUE', /* required */
  workgroupName: 'STRING_VALUE' /* required */
};
redshiftserverless.restoreFromRecoveryPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • namespaceName — (String)

      The name of the namespace to restore data into.

    • recoveryPointId — (String)

      The unique identifier of the recovery point to restore from.

    • workgroupName — (String)

      The name of the workgroup used to restore data.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • namespace — (map)

        The namespace that data was restored into.

        • adminUsername — (String)

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

        • creationDate — (Date)

          The date of when the namespace was created.

        • dbName — (String)

          The name of the first database created in the namespace.

        • defaultIamRoleArn — (String)

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

        • iamRoles — (Array<String>)

          A list of IAM roles to associate with the namespace.

        • kmsKeyId — (String)

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

        • logExports — (Array<String>)

          The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) associated with a namespace.

        • namespaceId — (String)

          The unique identifier of a namespace.

        • namespaceName — (String)

          The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

        • status — (String)

          The status of the namespace.

          Possible values include:
          • "AVAILABLE"
          • "MODIFYING"
          • "DELETING"
      • recoveryPointId — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

restoreFromSnapshot(params = {}, callback) ⇒ AWS.Request

Restores a namespace from a snapshot.

Service Reference:

Examples:

Calling the restoreFromSnapshot operation

var params = {
  namespaceName: 'STRING_VALUE', /* required */
  workgroupName: 'STRING_VALUE', /* required */
  ownerAccount: 'STRING_VALUE',
  snapshotArn: 'STRING_VALUE',
  snapshotName: 'STRING_VALUE'
};
redshiftserverless.restoreFromSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • namespaceName — (String)

      The name of the namespace to restore the snapshot to.

    • ownerAccount — (String)

      The Amazon Web Services account that owns the snapshot.

    • snapshotArn — (String)

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

    • snapshotName — (String)

      The name of the snapshot to restore from.

    • workgroupName — (String)

      The name of the workgroup used to restore the snapshot.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • namespace — (map)

        A collection of database objects and users.

        • adminUsername — (String)

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

        • creationDate — (Date)

          The date of when the namespace was created.

        • dbName — (String)

          The name of the first database created in the namespace.

        • defaultIamRoleArn — (String)

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

        • iamRoles — (Array<String>)

          A list of IAM roles to associate with the namespace.

        • kmsKeyId — (String)

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

        • logExports — (Array<String>)

          The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) associated with a namespace.

        • namespaceId — (String)

          The unique identifier of a namespace.

        • namespaceName — (String)

          The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

        • status — (String)

          The status of the namespace.

          Possible values include:
          • "AVAILABLE"
          • "MODIFYING"
          • "DELETING"
      • ownerAccount — (String)

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

      • snapshotName — (String)

        The name of the snapshot used to restore the namespace.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Assigns one or more tags to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
redshiftserverless.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

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

    • tags — (Array<map>)

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

      • keyrequired — (String)

        The key to use in the tag.

      • valuerequired — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag or set of tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
redshiftserverless.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

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

    • tagKeys — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateEndpointAccess(params = {}, callback) ⇒ AWS.Request

Updates an Amazon Redshift Serverless managed endpoint.

Service Reference:

Examples:

Calling the updateEndpointAccess operation

var params = {
  endpointName: 'STRING_VALUE', /* required */
  vpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshiftserverless.updateEndpointAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • endpointName — (String)

      The name of the VPC endpoint to update.

    • vpcSecurityGroupIds — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • endpoint — (map)

        The updated VPC endpoint.

        • address — (String)

          The DNS address of the endpoint.

        • endpointArn — (String)

          The Amazon Resource Name (ARN) of the VPC endpoint.

        • endpointCreateTime — (Date)

          The time that the endpoint was created.

        • endpointName — (String)

          The name of the VPC endpoint.

        • endpointStatus — (String)

          The status of the VPC endpoint.

        • port — (Integer)

          The port number on which Amazon Redshift Serverless accepts incoming connections.

        • subnetIds — (Array<String>)

          The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.

        • vpcEndpoint — (map)

          The connection endpoint for connecting to Amazon Redshift Serverless.

          • networkInterfaces — (Array<map>)

            One or more network interfaces of the endpoint. Also known as an interface endpoint.

            • availabilityZone — (String)

              The availability Zone.

            • networkInterfaceId — (String)

              The unique identifier of the network interface.

            • privateIpAddress — (String)

              The IPv4 address of the network interface within the subnet.

            • subnetId — (String)

              The unique identifier of the subnet.

          • vpcEndpointId — (String)

            The connection endpoint ID for connecting to Amazon Redshift Serverless.

          • vpcId — (String)

            The VPC identifier that the endpoint is associated with.

        • vpcSecurityGroups — (Array<map>)

          The security groups associated with the endpoint.

          • status — (String)

            The status of the VPC security group.

          • vpcSecurityGroupId — (String)

            The unique identifier of the VPC security group.

        • workgroupName — (String)

          The name of the workgroup associated with the endpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateNamespace(params = {}, callback) ⇒ AWS.Request

Updates a namespace with the specified settings.

Service Reference:

Examples:

Calling the updateNamespace operation

var params = {
  namespaceName: 'STRING_VALUE', /* required */
  adminUserPassword: 'STRING_VALUE',
  adminUsername: 'STRING_VALUE',
  defaultIamRoleArn: 'STRING_VALUE',
  iamRoles: [
    'STRING_VALUE',
    /* more items */
  ],
  kmsKeyId: 'STRING_VALUE',
  logExports: [
    useractivitylog | userlog | connectionlog,
    /* more items */
  ]
};
redshiftserverless.updateNamespace(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • adminUserPassword — (String)

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

    • adminUsername — (String)

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

    • defaultIamRoleArn — (String)

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

    • iamRoles — (Array<String>)

      A list of IAM roles to associate with the namespace.

    • kmsKeyId — (String)

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

    • logExports — (Array<String>)

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

    • namespaceName — (String)

      The name of the namespace.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • namespace — (map)

        A list of tag instances.

        • adminUsername — (String)

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

        • creationDate — (Date)

          The date of when the namespace was created.

        • dbName — (String)

          The name of the first database created in the namespace.

        • defaultIamRoleArn — (String)

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

        • iamRoles — (Array<String>)

          A list of IAM roles to associate with the namespace.

        • kmsKeyId — (String)

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

        • logExports — (Array<String>)

          The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) associated with a namespace.

        • namespaceId — (String)

          The unique identifier of a namespace.

        • namespaceName — (String)

          The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

        • status — (String)

          The status of the namespace.

          Possible values include:
          • "AVAILABLE"
          • "MODIFYING"
          • "DELETING"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSnapshot(params = {}, callback) ⇒ AWS.Request

Updates a snapshot.

Service Reference:

Examples:

Calling the updateSnapshot operation

var params = {
  snapshotName: 'STRING_VALUE', /* required */
  retentionPeriod: 'NUMBER_VALUE'
};
redshiftserverless.updateSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • retentionPeriod — (Integer)

      The new retention period of the snapshot.

    • snapshotName — (String)

      The name of the snapshot.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • snapshot — (map)

        The updated snapshot object.

        • accountsWithProvisionedRestoreAccess — (Array<String>)

          All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

        • accountsWithRestoreAccess — (Array<String>)

          All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.

        • actualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup in megabytes.

        • adminUsername — (String)

          The username of the database within a snapshot.

        • backupProgressInMegaBytes — (Float)

          The size in megabytes of the data that has been backed up to a snapshot.

        • currentBackupRateInMegaBytesPerSecond — (Float)

          The rate at which data is backed up into a snapshot in megabytes per second.

        • elapsedTimeInSeconds — (Integer)

          The amount of time it took to back up data into a snapshot.

        • estimatedSecondsToCompletion — (Integer)

          The estimated amount of seconds until the snapshot completes backup.

        • kmsKeyId — (String)

          The unique identifier of the KMS key used to encrypt the snapshot.

        • namespaceArn — (String)

          The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

        • namespaceName — (String)

          The name of the namepsace.

        • ownerAccount — (String)

          The owner Amazon Web Services; account of the snapshot.

        • snapshotArn — (String)

          The Amazon Resource Name (ARN) of the snapshot.

        • snapshotCreateTime — (Date)

          The timestamp of when the snapshot was created.

        • snapshotName — (String)

          The name of the snapshot.

        • snapshotRemainingDays — (Integer)

          The amount of days until the snapshot is deleted.

        • snapshotRetentionPeriod — (Integer)

          The period of time, in days, of how long the snapshot is retained.

        • snapshotRetentionStartTime — (Date)

          The timestamp of when data within the snapshot started getting retained.

        • status — (String)

          The status of the snapshot.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "DELETED"
          • "CANCELLED"
          • "FAILED"
          • "COPYING"
        • totalBackupSizeInMegaBytes — (Float)

          The total size, in megabytes, of how big the snapshot is.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateUsageLimit(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateUsageLimit operation

var params = {
  usageLimitId: 'STRING_VALUE', /* required */
  amount: 'NUMBER_VALUE',
  breachAction: log | emit-metric | deactivate
};
redshiftserverless.updateUsageLimit(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • amount — (Integer)

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

    • breachAction — (String)

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

      Possible values include:
      • "log"
      • "emit-metric"
      • "deactivate"
    • usageLimitId — (String)

      The identifier of the usage limit to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • usageLimit — (map)

        The updated usage limit object.

        • amount — (Integer)

          The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.

        • breachAction — (String)

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

          Possible values include:
          • "log"
          • "emit-metric"
          • "deactivate"
        • period — (String)

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

          Possible values include:
          • "daily"
          • "weekly"
          • "monthly"
        • resourceArn — (String)

          The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.

        • usageLimitArn — (String)

          The Amazon Resource Name (ARN) of the resource associated with the usage limit.

        • usageLimitId — (String)

          The identifier of the usage limit.

        • usageType — (String)

          The Amazon Redshift Serverless feature to limit.

          Possible values include:
          • "serverless-compute"
          • "cross-region-datasharing"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateWorkgroup(params = {}, callback) ⇒ AWS.Request

Updates a workgroup with the specified configuration settings.

Service Reference:

Examples:

Calling the updateWorkgroup operation

var params = {
  workgroupName: 'STRING_VALUE', /* required */
  baseCapacity: 'NUMBER_VALUE',
  configParameters: [
    {
      parameterKey: 'STRING_VALUE',
      parameterValue: 'STRING_VALUE'
    },
    /* more items */
  ],
  enhancedVpcRouting: true || false,
  publiclyAccessible: true || false,
  securityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  subnetIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshiftserverless.updateWorkgroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • baseCapacity — (Integer)

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

    • configParameters — (Array<map>)

      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.

      • parameterKey — (String)

        The key of the parameter. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

      • parameterValue — (String)

        The value of the parameter to set.

    • enhancedVpcRouting — (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.

    • publiclyAccessible — (Boolean)

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

    • securityGroupIds — (Array<String>)

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

    • subnetIds — (Array<String>)

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

    • workgroupName — (String)

      The name of the workgroup to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • workgroup — (map)

        The updated workgroup object.

        • baseCapacity — (Integer)

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

        • configParameters — (Array<map>)

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

          • parameterKey — (String)

            The key of the parameter. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.

          • parameterValue — (String)

            The value of the parameter to set.

        • creationDate — (Date)

          The creation date of the workgroup.

        • endpoint — (map)

          The endpoint that is created from the workgroup.

          • address — (String)

            The DNS address of the VPC endpoint.

          • port — (Integer)

            The port that Amazon Redshift Serverless listens on.

          • vpcEndpoints — (Array<map>)

            An array of VpcEndpoint objects.

            • networkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • availabilityZone — (String)

                The availability Zone.

              • networkInterfaceId — (String)

                The unique identifier of the network interface.

              • privateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • subnetId — (String)

                The unique identifier of the subnet.

            • vpcEndpointId — (String)

              The connection endpoint ID for connecting to Amazon Redshift Serverless.

            • vpcId — (String)

              The VPC identifier that the endpoint is associated with.

        • enhancedVpcRouting — (Boolean)

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

        • namespaceName — (String)

          The namespace the workgroup is associated with.

        • publiclyAccessible — (Boolean)

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

        • securityGroupIds — (Array<String>)

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

        • status — (String)

          The status of the workgroup.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "MODIFYING"
          • "DELETING"
        • subnetIds — (Array<String>)

          An array of subnet IDs the workgroup is associated with.

        • workgroupArn — (String)

          The Amazon Resource Name (ARN) that links to the workgroup.

        • workgroupId — (String)

          The unique identifier of the workgroup.

        • workgroupName — (String)

          The name of the workgroup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.