Class: AWS.RedshiftServerless
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.RedshiftServerless
- Identifier:
- redshiftserverless
- API Version:
- 2021-04-21
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
This is an interface reference for Amazon Redshift Serverless. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless.
Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you focus on using your data to acquire new insights for your business and customers.
To learn more about Amazon Redshift Serverless, see What is Amazon Redshift Serverless.
Sending a Request Using RedshiftServerless
var redshiftserverless = new AWS.RedshiftServerless();
redshiftserverless.convertRecoveryPointToSnapshot(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the RedshiftServerless object uses this specific API, you can
construct the object by passing the apiVersion option to the constructor:
var redshiftserverless = new AWS.RedshiftServerless({apiVersion: '2021-04-21'});
You can also set the API version globally in AWS.config.apiVersions using
the redshiftserverless service identifier:
AWS.config.apiVersions = {
redshiftserverless: '2021-04-21',
// other service API versions
};
var redshiftserverless = new AWS.RedshiftServerless();
Constructor Summary collapse
-
new AWS.RedshiftServerless(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
convertRecoveryPointToSnapshot(params = {}, callback) ⇒ AWS.Request
Converts a recovery point to a snapshot.
-
createCustomDomainAssociation(params = {}, callback) ⇒ AWS.Request
Creates a custom domain association for Amazon Redshift Serverless.
.
-
createEndpointAccess(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Redshift Serverless managed VPC endpoint.
.
-
createNamespace(params = {}, callback) ⇒ AWS.Request
Creates a namespace in Amazon Redshift Serverless.
.
-
createScheduledAction(params = {}, callback) ⇒ AWS.Request
Creates a scheduled action.
-
createSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a snapshot of all databases in a namespace.
-
createSnapshotCopyConfiguration(params = {}, callback) ⇒ AWS.Request
Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
.
-
createUsageLimit(params = {}, callback) ⇒ AWS.Request
Creates a usage limit for a specified Amazon Redshift Serverless usage type.
-
createWorkgroup(params = {}, callback) ⇒ AWS.Request
Creates an workgroup in Amazon Redshift Serverless.
.
-
deleteCustomDomainAssociation(params = {}, callback) ⇒ AWS.Request
Deletes a custom domain association for Amazon Redshift Serverless.
.
-
deleteEndpointAccess(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Redshift Serverless managed VPC endpoint.
.
-
deleteNamespace(params = {}, callback) ⇒ AWS.Request
Deletes a namespace from Amazon Redshift Serverless.
-
deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request
Deletes the specified resource policy.
.
-
deleteScheduledAction(params = {}, callback) ⇒ AWS.Request
Deletes a scheduled action.
.
-
deleteSnapshot(params = {}, callback) ⇒ AWS.Request
Deletes a snapshot from Amazon Redshift Serverless.
.
-
deleteSnapshotCopyConfiguration(params = {}, callback) ⇒ AWS.Request
Deletes a snapshot copy configuration
.
-
deleteUsageLimit(params = {}, callback) ⇒ AWS.Request
Deletes a usage limit from Amazon Redshift Serverless.
.
-
deleteWorkgroup(params = {}, callback) ⇒ AWS.Request
Deletes a workgroup.
.
-
getCredentials(params = {}, callback) ⇒ AWS.Request
Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.
By default, the temporary credentials expire in 900 seconds.
-
getCustomDomainAssociation(params = {}, callback) ⇒ AWS.Request
Gets information about a specific custom domain association.
.
-
getEndpointAccess(params = {}, callback) ⇒ AWS.Request
Returns information, such as the name, about a VPC endpoint.
.
-
getNamespace(params = {}, callback) ⇒ AWS.Request
Returns information about a namespace in Amazon Redshift Serverless.
.
-
getRecoveryPoint(params = {}, callback) ⇒ AWS.Request
Returns information about a recovery point.
.
-
getResourcePolicy(params = {}, callback) ⇒ AWS.Request
Returns a resource policy.
.
-
getScheduledAction(params = {}, callback) ⇒ AWS.Request
Returns information about a scheduled action.
.
-
getSnapshot(params = {}, callback) ⇒ AWS.Request
Returns information about a specific snapshot.
.
-
getTableRestoreStatus(params = {}, callback) ⇒ AWS.Request
Returns information about a
TableRestoreStatusobject..
-
getUsageLimit(params = {}, callback) ⇒ AWS.Request
Returns information about a usage limit.
.
-
getWorkgroup(params = {}, callback) ⇒ AWS.Request
Returns information about a specific workgroup.
.
-
listCustomDomainAssociations(params = {}, callback) ⇒ AWS.Request
Lists custom domain associations for Amazon Redshift Serverless.
.
-
listEndpointAccess(params = {}, callback) ⇒ AWS.Request
Returns an array of
EndpointAccessobjects and relevant information..
-
listNamespaces(params = {}, callback) ⇒ AWS.Request
Returns information about a list of specified namespaces.
.
-
listRecoveryPoints(params = {}, callback) ⇒ AWS.Request
Returns an array of recovery points.
.
-
listScheduledActions(params = {}, callback) ⇒ AWS.Request
Returns a list of scheduled actions.
-
listSnapshotCopyConfigurations(params = {}, callback) ⇒ AWS.Request
Returns a list of snapshot copy configurations.
.
-
listSnapshots(params = {}, callback) ⇒ AWS.Request
Returns a list of snapshots.
.
-
listTableRestoreStatus(params = {}, callback) ⇒ AWS.Request
Returns information about an array of
TableRestoreStatusobjects..
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags assigned to a resource.
.
-
listUsageLimits(params = {}, callback) ⇒ AWS.Request
Lists all usage limits within Amazon Redshift Serverless.
.
-
listWorkgroups(params = {}, callback) ⇒ AWS.Request
Returns information about a list of specified workgroups.
.
-
putResourcePolicy(params = {}, callback) ⇒ AWS.Request
Creates or updates a resource policy.
-
restoreFromRecoveryPoint(params = {}, callback) ⇒ AWS.Request
Restore the data from a recovery point.
.
-
restoreFromSnapshot(params = {}, callback) ⇒ AWS.Request
Restores a namespace from a snapshot.
.
-
restoreTableFromRecoveryPoint(params = {}, callback) ⇒ AWS.Request
Restores a table from a recovery point to your Amazon Redshift Serverless instance.
-
restoreTableFromSnapshot(params = {}, callback) ⇒ AWS.Request
Restores a table from a snapshot to your Amazon Redshift Serverless instance.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Assigns one or more tags to a resource.
.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Removes a tag or set of tags from a resource.
.
-
updateCustomDomainAssociation(params = {}, callback) ⇒ AWS.Request
Updates an Amazon Redshift Serverless certificate associated with a custom domain.
.
-
updateEndpointAccess(params = {}, callback) ⇒ AWS.Request
Updates an Amazon Redshift Serverless managed endpoint.
.
-
updateNamespace(params = {}, callback) ⇒ AWS.Request
Updates a namespace with the specified settings.
-
updateScheduledAction(params = {}, callback) ⇒ AWS.Request
Updates a scheduled action.
.
-
updateSnapshot(params = {}, callback) ⇒ AWS.Request
Updates a snapshot.
.
-
updateSnapshotCopyConfiguration(params = {}, callback) ⇒ AWS.Request
Updates a snapshot copy configuration.
.
-
updateUsageLimit(params = {}, callback) ⇒ AWS.Request
Update a usage limit in Amazon Redshift Serverless.
-
updateWorkgroup(params = {}, callback) ⇒ AWS.Request
Updates a workgroup with the specified configuration settings.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.RedshiftServerless(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
convertRecoveryPointToSnapshot(params = {}, callback) ⇒ AWS.Request
Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.
createCustomDomainAssociation(params = {}, callback) ⇒ AWS.Request
Creates a custom domain association for Amazon Redshift Serverless.
createEndpointAccess(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Redshift Serverless managed VPC endpoint.
createNamespace(params = {}, callback) ⇒ AWS.Request
Creates a namespace in Amazon Redshift Serverless.
createScheduledAction(params = {}, callback) ⇒ AWS.Request
Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the CreateSnapshot API operation.
createSnapshot(params = {}, callback) ⇒ AWS.Request
Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
createSnapshotCopyConfiguration(params = {}, callback) ⇒ AWS.Request
Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
createUsageLimit(params = {}, callback) ⇒ AWS.Request
Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.
createWorkgroup(params = {}, callback) ⇒ AWS.Request
Creates an workgroup in Amazon Redshift Serverless.
deleteCustomDomainAssociation(params = {}, callback) ⇒ AWS.Request
Deletes a custom domain association for Amazon Redshift Serverless.
deleteEndpointAccess(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Redshift Serverless managed VPC endpoint.
deleteNamespace(params = {}, callback) ⇒ AWS.Request
Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.