Class: AWS.RedshiftServerless

var params = {
  customDomainCertificateArn: 'STRING_VALUE', /* required */
  customDomainName: 'STRING_VALUE', /* required */
  workgroupName: 'STRING_VALUE' /* required */
};
redshiftserverless.createCustomDomainAssociation(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: {}) —
  • customDomainCertificateArn — (String)

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

  • customDomainName — (String)

    The custom domain name to associate with the workgroup.

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

    • customDomainCertificateArn — (String)

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

    • customDomainCertificateExpiryTime — (Date)

      The expiration time for the certificate.

    • customDomainName — (String)

      The custom domain name to associate with the workgroup.

    • workgroupName — (String)

      The name of the workgroup associated with the database.

Returns:

• (AWS.Request) —

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

var params = {
  endpointName: 'STRING_VALUE', /* required */
  subnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  workgroupName: 'STRING_VALUE', /* required */
  ownerAccount: 'STRING_VALUE',
  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.

  • ownerAccount — (String)

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

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

          • ipv6Address — (String)

            The IPv6 address of the network interface within the subnet.

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

var params = {
  namespaceName: 'STRING_VALUE', /* required */
  adminPasswordSecretKmsKeyId: 'STRING_VALUE',
  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 */
  ],
  manageAdminPassword: true || false,
  redshiftIdcApplicationArn: 'STRING_VALUE',
  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: {}) —
  • adminPasswordSecretKmsKeyId — (String)

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

  • adminUserPassword — (String)

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

    You can't use adminUserPassword if manageAdminPassword is true.

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

  • manageAdminPassword — (Boolean)

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

  • namespaceName — (String)

    The name of the namespace.

  • redshiftIdcApplicationArn — (String)

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

  • tags — (Array<map>)

    A list of tag instances.

    • key — required — (String)

      The key to use in the tag.

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

      • adminPasswordSecretArn — (String)

        The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

      • adminPasswordSecretKmsKeyId — (String)

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

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

var params = {
  namespaceName: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  schedule: { /* required */
    at: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    cron: 'STRING_VALUE'
  },
  scheduledActionName: 'STRING_VALUE', /* required */
  targetAction: { /* required */
    createSnapshot: {
      namespaceName: 'STRING_VALUE', /* required */
      snapshotNamePrefix: 'STRING_VALUE', /* required */
      retentionPeriod: 'NUMBER_VALUE',
      tags: [
        {
          key: 'STRING_VALUE', /* required */
          value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    }
  },
  enabled: true || false,
  endTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  scheduledActionDescription: 'STRING_VALUE',
  startTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
redshiftserverless.createScheduledAction(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: {}) —
  • enabled — (Boolean)

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

  • endTime — (Date)

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

  • namespaceName — (String)

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

  • roleArn — (String)

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

  • schedule — (map)

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

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

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

    • at — (Date)

      The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

    • cron — (String)

      The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

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

  • scheduledActionDescription — (String)

    The description of the scheduled action.

  • scheduledActionName — (String)

    The name of the scheduled action.

  • startTime — (Date)

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

  • targetAction — (map)

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

    "{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"

    • createSnapshot — (map)

      The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction.

      • namespaceName — required — (String)

        The name of the namespace for which you want to configure a scheduled action to create a snapshot.

      • retentionPeriod — (Integer)

        The retention period of the snapshot created by the scheduled action.

      • snapshotNamePrefix — required — (String)

        A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.

      • tags — (Array<map>)

        An array of Tag objects to associate with the snapshot.

        • key — required — (String)

          The key to use in the tag.

        • value — required — (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:

    • scheduledAction — (map)

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

      • endTime — (Date)

        The end time of

      • namespaceName — (String)

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

      • nextInvocations — (Array<Date>)

        An array of timestamps of when the next scheduled actions will trigger.

      • roleArn — (String)

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

      • schedule — (map)

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

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

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

        • at — (Date)

          The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

        • cron — (String)

          The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

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

      • scheduledActionDescription — (String)

        The description of the scheduled action.

      • scheduledActionName — (String)

        The name of the scheduled action.

      • scheduledActionUuid — (String)

        The uuid of the scheduled action.

      • startTime — (Date)

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

      • state — (String)

        The state of the scheduled action.

        Possible values include:
        • "ACTIVE"
        • "DISABLED"
      • targetAction — (map)

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

        "{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"

        • createSnapshot — (map)

          The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction.

          • namespaceName — required — (String)

            The name of the namespace for which you want to configure a scheduled action to create a snapshot.

          • retentionPeriod — (Integer)

            The retention period of the snapshot created by the scheduled action.

          • snapshotNamePrefix — required — (String)

            A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.

          • tags — (Array<map>)

            An array of Tag objects to associate with the snapshot.

            • key — required — (String)

              The key to use in the tag.

            • value — required — (String)

              The value of the tag.

Returns:

• (AWS.Request) —

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

var params = {
  namespaceName: 'STRING_VALUE', /* required */
  snapshotName: 'STRING_VALUE', /* required */
  retentionPeriod: 'NUMBER_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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.

  • tags — (Array<map>)

    An array of Tag objects to associate with the snapshot.

    • key — required — (String)

      The key to use in the tag.

    • value — required — (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:

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

      • adminPasswordSecretArn — (String)

        The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

      • adminPasswordSecretKmsKeyId — (String)

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

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

var params = {
  destinationRegion: 'STRING_VALUE', /* required */
  namespaceName: 'STRING_VALUE', /* required */
  destinationKmsKeyId: 'STRING_VALUE',
  snapshotRetentionPeriod: 'NUMBER_VALUE'
};
redshiftserverless.createSnapshotCopyConfiguration(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: {}) —
  • destinationKmsKeyId — (String)

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

  • destinationRegion — (String)

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

  • namespaceName — (String)

    The name of the namespace to copy snapshots from.

  • snapshotRetentionPeriod — (Integer)

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

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:

    • snapshotCopyConfiguration — (map)

      The snapshot copy configuration object that is returned.

      • destinationKmsKeyId — (String)

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

      • destinationRegion — (String)

        The destination Amazon Web Services Region to copy snapshots to.

      • namespaceName — (String)

        The name of the namespace to copy snapshots from in the source Amazon Web Services Region.

      • snapshotCopyConfigurationArn — (String)

        The ARN of the snapshot copy configuration object.

      • snapshotCopyConfigurationId — (String)

        The ID of the snapshot copy configuration object.

      • snapshotRetentionPeriod — (Integer)

        The retention period of snapshots that are copied to the destination Amazon Web Services Region.

Returns:

• (AWS.Request) —

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

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.

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,
  ipAddressType: 'STRING_VALUE',
  maxCapacity: 'NUMBER_VALUE',
  port: 'NUMBER_VALUE',
  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 advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

    • parameterKey — (String)

      The key of the parameter. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

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

  • ipAddressType — (String)

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

  • maxCapacity — (Integer)

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

  • namespaceName — (String)

    The name of the namespace to associate with the workgroup.

  • port — (Integer)

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

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

    • key — required — (String)

      The key to use in the tag.

    • value — required — (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 advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

        • parameterKey — (String)

          The key of the parameter. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

        • parameterValue — (String)

          The value of the parameter to set.

      • creationDate — (Date)

        The creation date of the workgroup.

      • crossAccountVpcs — (Array<String>)

        A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.

      • customDomainCertificateArn — (String)

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

      • customDomainCertificateExpiryTime — (Date)

        The expiration time for the certificate.

      • customDomainName — (String)

        The custom domain name associated with 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.

            • ipv6Address — (String)

              The IPv6 address of the network interface within the subnet.

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

      • ipAddressType — (String)

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

      • maxCapacity — (Integer)

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

      • namespaceName — (String)

        The namespace the workgroup is associated with.

      • patchVersion — (String)

        The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.

      • port — (Integer)

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

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

      • workgroupVersion — (String)

        The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.

Returns:

• (AWS.Request) —

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

var params = {
  customDomainName: 'STRING_VALUE', /* required */
  workgroupName: 'STRING_VALUE' /* required */
};
redshiftserverless.deleteCustomDomainAssociation(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: {}) —
  • customDomainName — (String)

    The custom domain name associated with the workgroup.

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

Returns:

• (AWS.Request) —

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

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.

          • ipv6Address — (String)

            The IPv6 address of the network interface within the subnet.

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

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.

      • adminPasswordSecretArn — (String)

        The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

      • adminPasswordSecretKmsKeyId — (String)

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

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

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.

var params = {
  scheduledActionName: 'STRING_VALUE' /* required */
};
redshiftserverless.deleteScheduledAction(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: {}) —
  • scheduledActionName — (String)

    The name of the scheduled action 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:

    • scheduledAction — (map)

      The deleted scheduled action object.

      • endTime — (Date)

        The end time of

      • namespaceName — (String)

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

      • nextInvocations — (Array<Date>)

        An array of timestamps of when the next scheduled actions will trigger.

      • roleArn — (String)

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

      • schedule — (map)

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

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

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

        • at — (Date)

          The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

        • cron — (String)

          The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

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

      • scheduledActionDescription — (String)

        The description of the scheduled action.

      • scheduledActionName — (String)

        The name of the scheduled action.

      • scheduledActionUuid — (String)

        The uuid of the scheduled action.

      • startTime — (Date)

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

      • state — (String)

        The state of the scheduled action.

        Possible values include:
        • "ACTIVE"
        • "DISABLED"
      • targetAction — (map)

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

        "{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"

        • createSnapshot — (map)

          The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction.

          • namespaceName — required — (String)

            The name of the namespace for which you want to configure a scheduled action to create a snapshot.

          • retentionPeriod — (Integer)

            The retention period of the snapshot created by the scheduled action.

          • snapshotNamePrefix — required — (String)

            A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.

          • tags — (Array<map>)

            An array of Tag objects to associate with the snapshot.

            • key — required — (String)

              The key to use in the tag.

            • value — required — (String)

              The value of the tag.

Returns:

• (AWS.Request) —

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

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.

      • adminPasswordSecretArn — (String)

        The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

      • adminPasswordSecretKmsKeyId — (String)

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

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

var params = {
  snapshotCopyConfigurationId: 'STRING_VALUE' /* required */
};
redshiftserverless.deleteSnapshotCopyConfiguration(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: {}) —
  • snapshotCopyConfigurationId — (String)

    The ID of the snapshot copy configuration 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:

    • snapshotCopyConfiguration — (map)

      The deleted snapshot copy configuration object.

      • destinationKmsKeyId — (String)

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

      • destinationRegion — (String)

        The destination Amazon Web Services Region to copy snapshots to.

      • namespaceName — (String)

        The name of the namespace to copy snapshots from in the source Amazon Web Services Region.

      • snapshotCopyConfigurationArn — (String)

        The ARN of the snapshot copy configuration object.

      • snapshotCopyConfigurationId — (String)

        The ID of the snapshot copy configuration object.

      • snapshotRetentionPeriod — (Integer)

        The retention period of snapshots that are copied to the destination Amazon Web Services Region.

Returns:

• (AWS.Request) —

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

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.

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 advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

        • parameterKey — (String)

          The key of the parameter. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

        • parameterValue — (String)

          The value of the parameter to set.

      • creationDate — (Date)

        The creation date of the workgroup.

      • crossAccountVpcs — (Array<String>)

        A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.

      • customDomainCertificateArn — (String)

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

      • customDomainCertificateExpiryTime — (Date)

        The expiration time for the certificate.

      • customDomainName — (String)

        The custom domain name associated with 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.

            • ipv6Address — (String)

              The IPv6 address of the network interface within the subnet.

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

      • ipAddressType — (String)

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

      • maxCapacity — (Integer)

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

      • namespaceName — (String)

        The namespace the workgroup is associated with.

      • patchVersion — (String)

        The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.

      • port — (Integer)

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

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

      • workgroupVersion — (String)

        The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.

Returns:

• (AWS.Request) —

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

var params = {
  customDomainName: 'STRING_VALUE',
  dbName: 'STRING_VALUE',
  durationSeconds: 'NUMBER_VALUE',
  workgroupName: 'STRING_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: {}) —
  • customDomainName — (String)

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

  • 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 uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    • The first character must be a letter.

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

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

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

var params = {
  customDomainName: 'STRING_VALUE', /* required */
  workgroupName: 'STRING_VALUE' /* required */
};
redshiftserverless.getCustomDomainAssociation(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: {}) —
  • customDomainName — (String)

    The custom domain name associated with the workgroup.

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

    • customDomainCertificateArn — (String)

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

    • customDomainCertificateExpiryTime — (Date)

      The expiration time for the certificate.

    • customDomainName — (String)

      The custom domain name associated with the workgroup.

    • workgroupName — (String)

      The name of the workgroup associated with the database.

Returns:

• (AWS.Request) —

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

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.

          • ipv6Address — (String)

            The IPv6 address of the network interface within the subnet.

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

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.

      • adminPasswordSecretArn — (String)

        The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

      • adminPasswordSecretKmsKeyId — (String)

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

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

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.

      • namespaceArn — (String)

        The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.

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

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.

var params = {
  scheduledActionName: 'STRING_VALUE' /* required */
};
redshiftserverless.getScheduledAction(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: {}) —
  • scheduledActionName — (String)

    The name of the scheduled action.

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:

    • scheduledAction — (map)

      The returned scheduled action object.

      • endTime — (Date)

        The end time of

      • namespaceName — (String)

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

      • nextInvocations — (Array<Date>)

        An array of timestamps of when the next scheduled actions will trigger.

      • roleArn — (String)

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

      • schedule — (map)

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

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

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

        • at — (Date)

          The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

        • cron — (String)

          The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

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

      • scheduledActionDescription — (String)

        The description of the scheduled action.

      • scheduledActionName — (String)

        The name of the scheduled action.

      • scheduledActionUuid — (String)

        The uuid of the scheduled action.

      • startTime — (Date)

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

      • state — (String)

        The state of the scheduled action.

        Possible values include:
        • "ACTIVE"
        • "DISABLED"
      • targetAction — (map)

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

        "{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"

        • createSnapshot — (map)

          The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction.

          • namespaceName — required — (String)

            The name of the namespace for which you want to configure a scheduled action to create a snapshot.

          • retentionPeriod — (Integer)

            The retention period of the snapshot created by the scheduled action.

          • snapshotNamePrefix — required — (String)

            A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.

          • tags — (Array<map>)

            An array of Tag objects to associate with the snapshot.

            • key — required — (String)

              The key to use in the tag.

            • value — required — (String)

              The value of the tag.

Returns:

• (AWS.Request) —

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

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.

      • adminPasswordSecretArn — (String)

        The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

      • adminPasswordSecretKmsKeyId — (String)

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

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

var params = {
  tableRestoreRequestId: 'STRING_VALUE' /* required */
};
redshiftserverless.getTableRestoreStatus(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: {}) —
  • tableRestoreRequestId — (String)

    The ID of the RestoreTableFromSnapshot request to return status 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:

    • tableRestoreStatus — (map)

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

      • message — (String)

        A message that explains the returned status. For example, if the status of the operation is FAILED, the message explains why the operation failed.

      • namespaceName — (String)

        The namespace of the table being restored from.

      • newTableName — (String)

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

      • progressInMegaBytes — (Integer)

        The amount of data restored to the new table so far, in megabytes (MB).

      • recoveryPointId — (String)

        The ID of the recovery point being restored from.

      • requestTime — (Date)

        The time that the table restore request was made, in Universal Coordinated Time (UTC).

      • snapshotName — (String)

        The name of the snapshot being restored from.

      • sourceDatabaseName — (String)

        The name of the source database being restored from.

      • sourceSchemaName — (String)

        The name of the source schema being restored from.

      • sourceTableName — (String)

        The name of the source table being restored from.

      • status — (String)

        A value that describes the current state of the table restore request. Possible values are SUCCEEDED, FAILED, CANCELED, PENDING, and IN_PROGRESS.

      • tableRestoreRequestId — (String)

        The ID of the RestoreTableFromSnapshot request.

      • targetDatabaseName — (String)

        The name of the database to restore to.

      • targetSchemaName — (String)

        The name of the schema to restore to.

      • totalDataInMegaBytes — (Integer)

        The total amount of data to restore to the new table, in megabytes (MB).

      • workgroupName — (String)

        The name of the workgroup being restored from.

Returns:

• (AWS.Request) —

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

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.

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 advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

        • parameterKey — (String)

          The key of the parameter. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

        • parameterValue — (String)

          The value of the parameter to set.

      • creationDate — (Date)

        The creation date of the workgroup.

      • crossAccountVpcs — (Array<String>)

        A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.

      • customDomainCertificateArn — (String)

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

      • customDomainCertificateExpiryTime — (Date)

        The expiration time for the certificate.

      • customDomainName — (String)

        The custom domain name associated with 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.

            • ipv6Address — (String)

              The IPv6 address of the network interface within the subnet.

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

      • ipAddressType — (String)

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

      • maxCapacity — (Integer)

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

      • namespaceName — (String)

        The namespace the workgroup is associated with.

      • patchVersion — (String)

        The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.

      • port — (Integer)

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

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

      • workgroupVersion — (String)

        The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.

Returns:

• (AWS.Request) —

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

var params = {
  customDomainCertificateArn: 'STRING_VALUE',
  customDomainName: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
redshiftserverless.listCustomDomainAssociations(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: {}) —
  • customDomainCertificateArn — (String)

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

  • customDomainName — (String)

    The custom domain name associated with the workgroup.

  • maxResults — (Integer)

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

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

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:

    • associations — (Array<map>)

      A list of Association objects.

      • customDomainCertificateArn — (String)

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

      • customDomainCertificateExpiryTime — (Date)

        The expiration time for the certificate.

      • customDomainName — (String)

        The custom domain name associated with the workgroup.

      • workgroupName — (String)

        The name of the workgroup associated with the database.

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  ownerAccount: '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 display the next page of results.

  • nextToken — (String)

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

  • ownerAccount — (String)

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

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

          • ipv6Address — (String)

            The IPv6 address of the network interface within the subnet.

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

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

  • nextToken — (String)

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

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.

      • adminPasswordSecretArn — (String)

        The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

      • adminPasswordSecretKmsKeyId — (String)

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

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

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

  • namespaceArn — (String)

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

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

      • namespaceArn — (String)

        The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.

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

var params = {
  maxResults: 'NUMBER_VALUE',
  namespaceName: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
redshiftserverless.listScheduledActions(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. Use nextToken to display the next page of results.

  • namespaceName — (String)

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

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

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.

    • scheduledActions — (Array<map>)

      All of the returned scheduled action association objects.

      • namespaceName — (String)

        Name of associated Amazon Redshift Serverless namespace.

      • scheduledActionName — (String)

        Name of associated scheduled action.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  namespaceName: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
redshiftserverless.listSnapshotCopyConfigurations(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 display the next page of results.

  • namespaceName — (String)

    The namespace from which to list all snapshot copy configurations.

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

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.

    • snapshotCopyConfigurations — (Array<map>)

      All of the returned snapshot copy configurations.

      • destinationKmsKeyId — (String)

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

      • destinationRegion — (String)

        The destination Amazon Web Services Region to copy snapshots to.

      • namespaceName — (String)

        The name of the namespace to copy snapshots from in the source Amazon Web Services Region.

      • snapshotCopyConfigurationArn — (String)

        The ARN of the snapshot copy configuration object.

      • snapshotCopyConfigurationId — (String)

        The ID of the snapshot copy configuration object.

      • snapshotRetentionPeriod — (Integer)

        The retention period of snapshots that are copied to the destination Amazon Web Services Region.

Returns:

• (AWS.Request) —

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

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

      • adminPasswordSecretArn — (String)

        The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.

      • adminPasswordSecretKmsKeyId — (String)

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

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

var params = {
  maxResults: 'NUMBER_VALUE',
  namespaceName: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  workgroupName: 'STRING_VALUE'
};
redshiftserverless.listTableRestoreStatus(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 display the next page of results.

  • namespaceName — (String)

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

  • nextToken — (String)

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

  • workgroupName — (String)

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

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

    • tableRestoreStatuses — (Array<map>)

      The array of returned TableRestoreStatus objects.

      • message — (String)

        A message that explains the returned status. For example, if the status of the operation is FAILED, the message explains why the operation failed.

      • namespaceName — (String)

        The namespace of the table being restored from.

      • newTableName — (String)

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

      • progressInMegaBytes — (Integer)

        The amount of data restored to the new table so far, in megabytes (MB).

      • recoveryPointId — (String)

        The ID of the recovery point being restored from.

      • requestTime — (Date)

        The time that the table restore request was made, in Universal Coordinated Time (UTC).

      • snapshotName — (String)

        The name of the snapshot being restored from.

      • sourceDatabaseName — (String)

        The name of the source database being restored from.

      • sourceSchemaName — (String)

        The name of the source schema being restored from.

      • sourceTableName — (String)

        The name of the source table being restored from.

      • status — (String)

        A value that describes the current state of the table restore request. Possible values are SUCCEEDED, FAILED, CANCELED, PENDING, and IN_PROGRESS.

      • tableRestoreRequestId — (String)

        The ID of the RestoreTableFromSnapshot request.

      • targetDatabaseName — (String)

        The name of the database to restore to.

      • targetSchemaName — (String)

        The name of the schema to restore to.

      • totalDataInMegaBytes — (Integer)

        The total amount of data to restore to the new table, in megabytes (MB).

      • workgroupName — (String)

        The name of the workgroup being restored from.

Returns:

• (AWS.Request) —

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

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.

      • key — required — (String)

        The key to use in the tag.

      • value — required — (String)

        The value of the tag.

Returns:

• (AWS.Request) —

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

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  ownerAccount: '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 display the next page of results.

  • nextToken — (String)

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

  • ownerAccount — (String)

    The owner Amazon Web Services account for the Amazon Redshift Serverless 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:

    • 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 advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

        • parameterKey — (String)

          The key of the parameter. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.

        • parameterValue — (String)

          The value of the parameter to set.

      • creationDate — (Date)

        The creation date of the workgroup.

      • crossAccountVpcs — (Array<String>)

        A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.

      • customDomainCertificateArn — (String)

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

      • customDomainCertificateExpiryTime — (Date)

        The expiration time for the certificate.

      • customDomainName — (String)

        The custom domain name associated with 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.

            • ipv6Address — (String)

              The IPv6 address of the network interface within the subnet.

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

      • ipAddressType — (String)

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

      • maxCapacity — (Integer)

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

      • namespaceName — (String)

        The namespace the workgroup is associated with.

      • patchVersion — (String)

        The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.

      • port — (Integer)

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

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

      • workgroupVersion — (String)

        The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.