aws-sdk
Version:
AWS SDK for JavaScript
806 lines • 110 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class RedshiftServerless extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: RedshiftServerless.Types.ClientConfiguration)
config: Config & RedshiftServerless.Types.ClientConfiguration;
/**
* Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.
*/
convertRecoveryPointToSnapshot(params: RedshiftServerless.Types.ConvertRecoveryPointToSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ConvertRecoveryPointToSnapshotResponse) => void): Request<RedshiftServerless.Types.ConvertRecoveryPointToSnapshotResponse, AWSError>;
/**
* Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.
*/
convertRecoveryPointToSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.ConvertRecoveryPointToSnapshotResponse) => void): Request<RedshiftServerless.Types.ConvertRecoveryPointToSnapshotResponse, AWSError>;
/**
* Creates a custom domain association for Amazon Redshift Serverless.
*/
createCustomDomainAssociation(params: RedshiftServerless.Types.CreateCustomDomainAssociationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.CreateCustomDomainAssociationResponse, AWSError>;
/**
* Creates a custom domain association for Amazon Redshift Serverless.
*/
createCustomDomainAssociation(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.CreateCustomDomainAssociationResponse, AWSError>;
/**
* Creates an Amazon Redshift Serverless managed VPC endpoint.
*/
createEndpointAccess(params: RedshiftServerless.Types.CreateEndpointAccessRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateEndpointAccessResponse) => void): Request<RedshiftServerless.Types.CreateEndpointAccessResponse, AWSError>;
/**
* Creates an Amazon Redshift Serverless managed VPC endpoint.
*/
createEndpointAccess(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateEndpointAccessResponse) => void): Request<RedshiftServerless.Types.CreateEndpointAccessResponse, AWSError>;
/**
* Creates a namespace in Amazon Redshift Serverless.
*/
createNamespace(params: RedshiftServerless.Types.CreateNamespaceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateNamespaceResponse) => void): Request<RedshiftServerless.Types.CreateNamespaceResponse, AWSError>;
/**
* Creates a namespace in Amazon Redshift Serverless.
*/
createNamespace(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateNamespaceResponse) => void): Request<RedshiftServerless.Types.CreateNamespaceResponse, AWSError>;
/**
* 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.
*/
createScheduledAction(params: RedshiftServerless.Types.CreateScheduledActionRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateScheduledActionResponse) => void): Request<RedshiftServerless.Types.CreateScheduledActionResponse, AWSError>;
/**
* 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.
*/
createScheduledAction(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateScheduledActionResponse) => void): Request<RedshiftServerless.Types.CreateScheduledActionResponse, AWSError>;
/**
* Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
*/
createSnapshot(params: RedshiftServerless.Types.CreateSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateSnapshotResponse) => void): Request<RedshiftServerless.Types.CreateSnapshotResponse, AWSError>;
/**
* Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
*/
createSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateSnapshotResponse) => void): Request<RedshiftServerless.Types.CreateSnapshotResponse, AWSError>;
/**
* Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
*/
createSnapshotCopyConfiguration(params: RedshiftServerless.Types.CreateSnapshotCopyConfigurationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateSnapshotCopyConfigurationResponse) => void): Request<RedshiftServerless.Types.CreateSnapshotCopyConfigurationResponse, AWSError>;
/**
* Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
*/
createSnapshotCopyConfiguration(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateSnapshotCopyConfigurationResponse) => void): Request<RedshiftServerless.Types.CreateSnapshotCopyConfigurationResponse, AWSError>;
/**
* Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.
*/
createUsageLimit(params: RedshiftServerless.Types.CreateUsageLimitRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateUsageLimitResponse) => void): Request<RedshiftServerless.Types.CreateUsageLimitResponse, AWSError>;
/**
* Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.
*/
createUsageLimit(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateUsageLimitResponse) => void): Request<RedshiftServerless.Types.CreateUsageLimitResponse, AWSError>;
/**
* Creates an workgroup in Amazon Redshift Serverless.
*/
createWorkgroup(params: RedshiftServerless.Types.CreateWorkgroupRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateWorkgroupResponse) => void): Request<RedshiftServerless.Types.CreateWorkgroupResponse, AWSError>;
/**
* Creates an workgroup in Amazon Redshift Serverless.
*/
createWorkgroup(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateWorkgroupResponse) => void): Request<RedshiftServerless.Types.CreateWorkgroupResponse, AWSError>;
/**
* Deletes a custom domain association for Amazon Redshift Serverless.
*/
deleteCustomDomainAssociation(params: RedshiftServerless.Types.DeleteCustomDomainAssociationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.DeleteCustomDomainAssociationResponse, AWSError>;
/**
* Deletes a custom domain association for Amazon Redshift Serverless.
*/
deleteCustomDomainAssociation(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.DeleteCustomDomainAssociationResponse, AWSError>;
/**
* Deletes an Amazon Redshift Serverless managed VPC endpoint.
*/
deleteEndpointAccess(params: RedshiftServerless.Types.DeleteEndpointAccessRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteEndpointAccessResponse) => void): Request<RedshiftServerless.Types.DeleteEndpointAccessResponse, AWSError>;
/**
* Deletes an Amazon Redshift Serverless managed VPC endpoint.
*/
deleteEndpointAccess(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteEndpointAccessResponse) => void): Request<RedshiftServerless.Types.DeleteEndpointAccessResponse, AWSError>;
/**
* 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.
*/
deleteNamespace(params: RedshiftServerless.Types.DeleteNamespaceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteNamespaceResponse) => void): Request<RedshiftServerless.Types.DeleteNamespaceResponse, AWSError>;
/**
* 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.
*/
deleteNamespace(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteNamespaceResponse) => void): Request<RedshiftServerless.Types.DeleteNamespaceResponse, AWSError>;
/**
* Deletes the specified resource policy.
*/
deleteResourcePolicy(params: RedshiftServerless.Types.DeleteResourcePolicyRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteResourcePolicyResponse) => void): Request<RedshiftServerless.Types.DeleteResourcePolicyResponse, AWSError>;
/**
* Deletes the specified resource policy.
*/
deleteResourcePolicy(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteResourcePolicyResponse) => void): Request<RedshiftServerless.Types.DeleteResourcePolicyResponse, AWSError>;
/**
* Deletes a scheduled action.
*/
deleteScheduledAction(params: RedshiftServerless.Types.DeleteScheduledActionRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteScheduledActionResponse) => void): Request<RedshiftServerless.Types.DeleteScheduledActionResponse, AWSError>;
/**
* Deletes a scheduled action.
*/
deleteScheduledAction(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteScheduledActionResponse) => void): Request<RedshiftServerless.Types.DeleteScheduledActionResponse, AWSError>;
/**
* Deletes a snapshot from Amazon Redshift Serverless.
*/
deleteSnapshot(params: RedshiftServerless.Types.DeleteSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteSnapshotResponse) => void): Request<RedshiftServerless.Types.DeleteSnapshotResponse, AWSError>;
/**
* Deletes a snapshot from Amazon Redshift Serverless.
*/
deleteSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteSnapshotResponse) => void): Request<RedshiftServerless.Types.DeleteSnapshotResponse, AWSError>;
/**
* Deletes a snapshot copy configuration
*/
deleteSnapshotCopyConfiguration(params: RedshiftServerless.Types.DeleteSnapshotCopyConfigurationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteSnapshotCopyConfigurationResponse) => void): Request<RedshiftServerless.Types.DeleteSnapshotCopyConfigurationResponse, AWSError>;
/**
* Deletes a snapshot copy configuration
*/
deleteSnapshotCopyConfiguration(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteSnapshotCopyConfigurationResponse) => void): Request<RedshiftServerless.Types.DeleteSnapshotCopyConfigurationResponse, AWSError>;
/**
* Deletes a usage limit from Amazon Redshift Serverless.
*/
deleteUsageLimit(params: RedshiftServerless.Types.DeleteUsageLimitRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteUsageLimitResponse) => void): Request<RedshiftServerless.Types.DeleteUsageLimitResponse, AWSError>;
/**
* Deletes a usage limit from Amazon Redshift Serverless.
*/
deleteUsageLimit(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteUsageLimitResponse) => void): Request<RedshiftServerless.Types.DeleteUsageLimitResponse, AWSError>;
/**
* Deletes a workgroup.
*/
deleteWorkgroup(params: RedshiftServerless.Types.DeleteWorkgroupRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteWorkgroupResponse) => void): Request<RedshiftServerless.Types.DeleteWorkgroupResponse, AWSError>;
/**
* Deletes a workgroup.
*/
deleteWorkgroup(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteWorkgroupResponse) => void): Request<RedshiftServerless.Types.DeleteWorkgroupResponse, AWSError>;
/**
* Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). <p>The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.</p> <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.</p>
*/
getCredentials(params: RedshiftServerless.Types.GetCredentialsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetCredentialsResponse) => void): Request<RedshiftServerless.Types.GetCredentialsResponse, AWSError>;
/**
* Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). <p>The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.</p> <p>If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.</p>
*/
getCredentials(callback?: (err: AWSError, data: RedshiftServerless.Types.GetCredentialsResponse) => void): Request<RedshiftServerless.Types.GetCredentialsResponse, AWSError>;
/**
* Gets information about a specific custom domain association.
*/
getCustomDomainAssociation(params: RedshiftServerless.Types.GetCustomDomainAssociationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.GetCustomDomainAssociationResponse, AWSError>;
/**
* Gets information about a specific custom domain association.
*/
getCustomDomainAssociation(callback?: (err: AWSError, data: RedshiftServerless.Types.GetCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.GetCustomDomainAssociationResponse, AWSError>;
/**
* Returns information, such as the name, about a VPC endpoint.
*/
getEndpointAccess(params: RedshiftServerless.Types.GetEndpointAccessRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetEndpointAccessResponse) => void): Request<RedshiftServerless.Types.GetEndpointAccessResponse, AWSError>;
/**
* Returns information, such as the name, about a VPC endpoint.
*/
getEndpointAccess(callback?: (err: AWSError, data: RedshiftServerless.Types.GetEndpointAccessResponse) => void): Request<RedshiftServerless.Types.GetEndpointAccessResponse, AWSError>;
/**
* Returns information about a namespace in Amazon Redshift Serverless.
*/
getNamespace(params: RedshiftServerless.Types.GetNamespaceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetNamespaceResponse) => void): Request<RedshiftServerless.Types.GetNamespaceResponse, AWSError>;
/**
* Returns information about a namespace in Amazon Redshift Serverless.
*/
getNamespace(callback?: (err: AWSError, data: RedshiftServerless.Types.GetNamespaceResponse) => void): Request<RedshiftServerless.Types.GetNamespaceResponse, AWSError>;
/**
* Returns information about a recovery point.
*/
getRecoveryPoint(params: RedshiftServerless.Types.GetRecoveryPointRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetRecoveryPointResponse) => void): Request<RedshiftServerless.Types.GetRecoveryPointResponse, AWSError>;
/**
* Returns information about a recovery point.
*/
getRecoveryPoint(callback?: (err: AWSError, data: RedshiftServerless.Types.GetRecoveryPointResponse) => void): Request<RedshiftServerless.Types.GetRecoveryPointResponse, AWSError>;
/**
* Returns a resource policy.
*/
getResourcePolicy(params: RedshiftServerless.Types.GetResourcePolicyRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetResourcePolicyResponse) => void): Request<RedshiftServerless.Types.GetResourcePolicyResponse, AWSError>;
/**
* Returns a resource policy.
*/
getResourcePolicy(callback?: (err: AWSError, data: RedshiftServerless.Types.GetResourcePolicyResponse) => void): Request<RedshiftServerless.Types.GetResourcePolicyResponse, AWSError>;
/**
* Returns information about a scheduled action.
*/
getScheduledAction(params: RedshiftServerless.Types.GetScheduledActionRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetScheduledActionResponse) => void): Request<RedshiftServerless.Types.GetScheduledActionResponse, AWSError>;
/**
* Returns information about a scheduled action.
*/
getScheduledAction(callback?: (err: AWSError, data: RedshiftServerless.Types.GetScheduledActionResponse) => void): Request<RedshiftServerless.Types.GetScheduledActionResponse, AWSError>;
/**
* Returns information about a specific snapshot.
*/
getSnapshot(params: RedshiftServerless.Types.GetSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetSnapshotResponse) => void): Request<RedshiftServerless.Types.GetSnapshotResponse, AWSError>;
/**
* Returns information about a specific snapshot.
*/
getSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.GetSnapshotResponse) => void): Request<RedshiftServerless.Types.GetSnapshotResponse, AWSError>;
/**
* Returns information about a TableRestoreStatus object.
*/
getTableRestoreStatus(params: RedshiftServerless.Types.GetTableRestoreStatusRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetTableRestoreStatusResponse) => void): Request<RedshiftServerless.Types.GetTableRestoreStatusResponse, AWSError>;
/**
* Returns information about a TableRestoreStatus object.
*/
getTableRestoreStatus(callback?: (err: AWSError, data: RedshiftServerless.Types.GetTableRestoreStatusResponse) => void): Request<RedshiftServerless.Types.GetTableRestoreStatusResponse, AWSError>;
/**
* Returns information about a usage limit.
*/
getUsageLimit(params: RedshiftServerless.Types.GetUsageLimitRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetUsageLimitResponse) => void): Request<RedshiftServerless.Types.GetUsageLimitResponse, AWSError>;
/**
* Returns information about a usage limit.
*/
getUsageLimit(callback?: (err: AWSError, data: RedshiftServerless.Types.GetUsageLimitResponse) => void): Request<RedshiftServerless.Types.GetUsageLimitResponse, AWSError>;
/**
* Returns information about a specific workgroup.
*/
getWorkgroup(params: RedshiftServerless.Types.GetWorkgroupRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetWorkgroupResponse) => void): Request<RedshiftServerless.Types.GetWorkgroupResponse, AWSError>;
/**
* Returns information about a specific workgroup.
*/
getWorkgroup(callback?: (err: AWSError, data: RedshiftServerless.Types.GetWorkgroupResponse) => void): Request<RedshiftServerless.Types.GetWorkgroupResponse, AWSError>;
/**
* Lists custom domain associations for Amazon Redshift Serverless.
*/
listCustomDomainAssociations(params: RedshiftServerless.Types.ListCustomDomainAssociationsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListCustomDomainAssociationsResponse) => void): Request<RedshiftServerless.Types.ListCustomDomainAssociationsResponse, AWSError>;
/**
* Lists custom domain associations for Amazon Redshift Serverless.
*/
listCustomDomainAssociations(callback?: (err: AWSError, data: RedshiftServerless.Types.ListCustomDomainAssociationsResponse) => void): Request<RedshiftServerless.Types.ListCustomDomainAssociationsResponse, AWSError>;
/**
* Returns an array of EndpointAccess objects and relevant information.
*/
listEndpointAccess(params: RedshiftServerless.Types.ListEndpointAccessRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListEndpointAccessResponse) => void): Request<RedshiftServerless.Types.ListEndpointAccessResponse, AWSError>;
/**
* Returns an array of EndpointAccess objects and relevant information.
*/
listEndpointAccess(callback?: (err: AWSError, data: RedshiftServerless.Types.ListEndpointAccessResponse) => void): Request<RedshiftServerless.Types.ListEndpointAccessResponse, AWSError>;
/**
* Returns information about a list of specified namespaces.
*/
listNamespaces(params: RedshiftServerless.Types.ListNamespacesRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListNamespacesResponse) => void): Request<RedshiftServerless.Types.ListNamespacesResponse, AWSError>;
/**
* Returns information about a list of specified namespaces.
*/
listNamespaces(callback?: (err: AWSError, data: RedshiftServerless.Types.ListNamespacesResponse) => void): Request<RedshiftServerless.Types.ListNamespacesResponse, AWSError>;
/**
* Returns an array of recovery points.
*/
listRecoveryPoints(params: RedshiftServerless.Types.ListRecoveryPointsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListRecoveryPointsResponse) => void): Request<RedshiftServerless.Types.ListRecoveryPointsResponse, AWSError>;
/**
* Returns an array of recovery points.
*/
listRecoveryPoints(callback?: (err: AWSError, data: RedshiftServerless.Types.ListRecoveryPointsResponse) => void): Request<RedshiftServerless.Types.ListRecoveryPointsResponse, AWSError>;
/**
* Returns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.
*/
listScheduledActions(params: RedshiftServerless.Types.ListScheduledActionsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListScheduledActionsResponse) => void): Request<RedshiftServerless.Types.ListScheduledActionsResponse, AWSError>;
/**
* Returns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.
*/
listScheduledActions(callback?: (err: AWSError, data: RedshiftServerless.Types.ListScheduledActionsResponse) => void): Request<RedshiftServerless.Types.ListScheduledActionsResponse, AWSError>;
/**
* Returns a list of snapshot copy configurations.
*/
listSnapshotCopyConfigurations(params: RedshiftServerless.Types.ListSnapshotCopyConfigurationsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListSnapshotCopyConfigurationsResponse) => void): Request<RedshiftServerless.Types.ListSnapshotCopyConfigurationsResponse, AWSError>;
/**
* Returns a list of snapshot copy configurations.
*/
listSnapshotCopyConfigurations(callback?: (err: AWSError, data: RedshiftServerless.Types.ListSnapshotCopyConfigurationsResponse) => void): Request<RedshiftServerless.Types.ListSnapshotCopyConfigurationsResponse, AWSError>;
/**
* Returns a list of snapshots.
*/
listSnapshots(params: RedshiftServerless.Types.ListSnapshotsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListSnapshotsResponse) => void): Request<RedshiftServerless.Types.ListSnapshotsResponse, AWSError>;
/**
* Returns a list of snapshots.
*/
listSnapshots(callback?: (err: AWSError, data: RedshiftServerless.Types.ListSnapshotsResponse) => void): Request<RedshiftServerless.Types.ListSnapshotsResponse, AWSError>;
/**
* Returns information about an array of TableRestoreStatus objects.
*/
listTableRestoreStatus(params: RedshiftServerless.Types.ListTableRestoreStatusRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListTableRestoreStatusResponse) => void): Request<RedshiftServerless.Types.ListTableRestoreStatusResponse, AWSError>;
/**
* Returns information about an array of TableRestoreStatus objects.
*/
listTableRestoreStatus(callback?: (err: AWSError, data: RedshiftServerless.Types.ListTableRestoreStatusResponse) => void): Request<RedshiftServerless.Types.ListTableRestoreStatusResponse, AWSError>;
/**
* Lists the tags assigned to a resource.
*/
listTagsForResource(params: RedshiftServerless.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListTagsForResourceResponse) => void): Request<RedshiftServerless.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags assigned to a resource.
*/
listTagsForResource(callback?: (err: AWSError, data: RedshiftServerless.Types.ListTagsForResourceResponse) => void): Request<RedshiftServerless.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists all usage limits within Amazon Redshift Serverless.
*/
listUsageLimits(params: RedshiftServerless.Types.ListUsageLimitsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListUsageLimitsResponse) => void): Request<RedshiftServerless.Types.ListUsageLimitsResponse, AWSError>;
/**
* Lists all usage limits within Amazon Redshift Serverless.
*/
listUsageLimits(callback?: (err: AWSError, data: RedshiftServerless.Types.ListUsageLimitsResponse) => void): Request<RedshiftServerless.Types.ListUsageLimitsResponse, AWSError>;
/**
* Returns information about a list of specified workgroups.
*/
listWorkgroups(params: RedshiftServerless.Types.ListWorkgroupsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListWorkgroupsResponse) => void): Request<RedshiftServerless.Types.ListWorkgroupsResponse, AWSError>;
/**
* Returns information about a list of specified workgroups.
*/
listWorkgroups(callback?: (err: AWSError, data: RedshiftServerless.Types.ListWorkgroupsResponse) => void): Request<RedshiftServerless.Types.ListWorkgroupsResponse, AWSError>;
/**
* Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
*/
putResourcePolicy(params: RedshiftServerless.Types.PutResourcePolicyRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.PutResourcePolicyResponse) => void): Request<RedshiftServerless.Types.PutResourcePolicyResponse, AWSError>;
/**
* Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
*/
putResourcePolicy(callback?: (err: AWSError, data: RedshiftServerless.Types.PutResourcePolicyResponse) => void): Request<RedshiftServerless.Types.PutResourcePolicyResponse, AWSError>;
/**
* Restore the data from a recovery point.
*/
restoreFromRecoveryPoint(params: RedshiftServerless.Types.RestoreFromRecoveryPointRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreFromRecoveryPointResponse) => void): Request<RedshiftServerless.Types.RestoreFromRecoveryPointResponse, AWSError>;
/**
* Restore the data from a recovery point.
*/
restoreFromRecoveryPoint(callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreFromRecoveryPointResponse) => void): Request<RedshiftServerless.Types.RestoreFromRecoveryPointResponse, AWSError>;
/**
* Restores a namespace from a snapshot.
*/
restoreFromSnapshot(params: RedshiftServerless.Types.RestoreFromSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreFromSnapshotResponse) => void): Request<RedshiftServerless.Types.RestoreFromSnapshotResponse, AWSError>;
/**
* Restores a namespace from a snapshot.
*/
restoreFromSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreFromSnapshotResponse) => void): Request<RedshiftServerless.Types.RestoreFromSnapshotResponse, AWSError>;
/**
* Restores a table from a recovery point to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
*/
restoreTableFromRecoveryPoint(params: RedshiftServerless.Types.RestoreTableFromRecoveryPointRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreTableFromRecoveryPointResponse) => void): Request<RedshiftServerless.Types.RestoreTableFromRecoveryPointResponse, AWSError>;
/**
* Restores a table from a recovery point to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
*/
restoreTableFromRecoveryPoint(callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreTableFromRecoveryPointResponse) => void): Request<RedshiftServerless.Types.RestoreTableFromRecoveryPointResponse, AWSError>;
/**
* Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
*/
restoreTableFromSnapshot(params: RedshiftServerless.Types.RestoreTableFromSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreTableFromSnapshotResponse) => void): Request<RedshiftServerless.Types.RestoreTableFromSnapshotResponse, AWSError>;
/**
* Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
*/
restoreTableFromSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreTableFromSnapshotResponse) => void): Request<RedshiftServerless.Types.RestoreTableFromSnapshotResponse, AWSError>;
/**
* Assigns one or more tags to a resource.
*/
tagResource(params: RedshiftServerless.Types.TagResourceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.TagResourceResponse) => void): Request<RedshiftServerless.Types.TagResourceResponse, AWSError>;
/**
* Assigns one or more tags to a resource.
*/
tagResource(callback?: (err: AWSError, data: RedshiftServerless.Types.TagResourceResponse) => void): Request<RedshiftServerless.Types.TagResourceResponse, AWSError>;
/**
* Removes a tag or set of tags from a resource.
*/
untagResource(params: RedshiftServerless.Types.UntagResourceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UntagResourceResponse) => void): Request<RedshiftServerless.Types.UntagResourceResponse, AWSError>;
/**
* Removes a tag or set of tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: RedshiftServerless.Types.UntagResourceResponse) => void): Request<RedshiftServerless.Types.UntagResourceResponse, AWSError>;
/**
* Updates an Amazon Redshift Serverless certificate associated with a custom domain.
*/
updateCustomDomainAssociation(params: RedshiftServerless.Types.UpdateCustomDomainAssociationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.UpdateCustomDomainAssociationResponse, AWSError>;
/**
* Updates an Amazon Redshift Serverless certificate associated with a custom domain.
*/
updateCustomDomainAssociation(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.UpdateCustomDomainAssociationResponse, AWSError>;
/**
* Updates an Amazon Redshift Serverless managed endpoint.
*/
updateEndpointAccess(params: RedshiftServerless.Types.UpdateEndpointAccessRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateEndpointAccessResponse) => void): Request<RedshiftServerless.Types.UpdateEndpointAccessResponse, AWSError>;
/**
* Updates an Amazon Redshift Serverless managed endpoint.
*/
updateEndpointAccess(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateEndpointAccessResponse) => void): Request<RedshiftServerless.Types.UpdateEndpointAccessResponse, AWSError>;
/**
* Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request.
*/
updateNamespace(params: RedshiftServerless.Types.UpdateNamespaceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateNamespaceResponse) => void): Request<RedshiftServerless.Types.UpdateNamespaceResponse, AWSError>;
/**
* Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request.
*/
updateNamespace(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateNamespaceResponse) => void): Request<RedshiftServerless.Types.UpdateNamespaceResponse, AWSError>;
/**
* Updates a scheduled action.
*/
updateScheduledAction(params: RedshiftServerless.Types.UpdateScheduledActionRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateScheduledActionResponse) => void): Request<RedshiftServerless.Types.UpdateScheduledActionResponse, AWSError>;
/**
* Updates a scheduled action.
*/
updateScheduledAction(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateScheduledActionResponse) => void): Request<RedshiftServerless.Types.UpdateScheduledActionResponse, AWSError>;
/**
* Updates a snapshot.
*/
updateSnapshot(params: RedshiftServerless.Types.UpdateSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateSnapshotResponse) => void): Request<RedshiftServerless.Types.UpdateSnapshotResponse, AWSError>;
/**
* Updates a snapshot.
*/
updateSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateSnapshotResponse) => void): Request<RedshiftServerless.Types.UpdateSnapshotResponse, AWSError>;
/**
* Updates a snapshot copy configuration.
*/
updateSnapshotCopyConfiguration(params: RedshiftServerless.Types.UpdateSnapshotCopyConfigurationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateSnapshotCopyConfigurationResponse) => void): Request<RedshiftServerless.Types.UpdateSnapshotCopyConfigurationResponse, AWSError>;
/**
* Updates a snapshot copy configuration.
*/
updateSnapshotCopyConfiguration(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateSnapshotCopyConfigurationResponse) => void): Request<RedshiftServerless.Types.UpdateSnapshotCopyConfigurationResponse, AWSError>;
/**
* Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.
*/
updateUsageLimit(params: RedshiftServerless.Types.UpdateUsageLimitRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateUsageLimitResponse) => void): Request<RedshiftServerless.Types.UpdateUsageLimitResponse, AWSError>;
/**
* Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.
*/
updateUsageLimit(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateUsageLimitResponse) => void): Request<RedshiftServerless.Types.UpdateUsageLimitResponse, AWSError>;
/**
* Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.
*/
updateWorkgroup(params: RedshiftServerless.Types.UpdateWorkgroupRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateWorkgroupResponse) => void): Request<RedshiftServerless.Types.UpdateWorkgroupResponse, AWSError>;
/**
* Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.
*/
updateWorkgroup(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateWorkgroupResponse) => void): Request<RedshiftServerless.Types.UpdateWorkgroupResponse, AWSError>;
}
declare namespace RedshiftServerless {
export type AccountIdList = String[];
export type AmazonResourceName = string;
export interface Association {
/**
* The custom domain name’s certificate Amazon resource name (ARN).
*/
customDomainCertificateArn?: CustomDomainCertificateArnString;
/**
* The expiration time for the certificate.
*/
customDomainCertificateExpiryTime?: SyntheticTimestamp_date_time;
/**
* The custom domain name associated with the workgroup.
*/
customDomainName?: CustomDomainName;
/**
* The name of the workgroup associated with the database.
*/
workgroupName?: WorkgroupName;
}
export type AssociationList = Association[];
export type Boolean = boolean;
export interface ConfigParameter {
/**
* 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.
*/
parameterKey?: ParameterKey;
/**
* The value of the parameter to set.
*/
parameterValue?: ParameterValue;
}
export type ConfigParameterList = ConfigParameter[];
export interface ConvertRecoveryPointToSnapshotRequest {
/**
* The unique identifier of the recovery point.
*/
recoveryPointId: String;
/**
* How long to retain the snapshot.
*/
retentionPeriod?: Integer;
/**
* The name of the snapshot.
*/
snapshotName: String;
/**
* An array of Tag objects to associate with the created snapshot.
*/
tags?: TagList;
}
export interface ConvertRecoveryPointToSnapshotResponse {
/**
* The snapshot converted from the recovery point.
*/
snapshot?: Snapshot;
}
export interface CreateCustomDomainAssociationRequest {
/**
* The custom domain name’s certificate Amazon resource name (ARN).
*/
customDomainCertificateArn: CustomDomainCertificateArnString;
/**
* The custom domain name to associate with the workgroup.
*/
customDomainName: CustomDomainName;
/**
* The name of the workgroup associated with the database.
*/
workgroupName: WorkgroupName;
}
export interface CreateCustomDomainAssociationResponse {
/**
* The custom domain name’s certificate Amazon resource name (ARN).
*/
customDomainCertificateArn?: CustomDomainCertificateArnString;
/**
* The expiration time for the certificate.
*/
customDomainCertificateExpiryTime?: SyntheticTimestamp_date_time;
/**
* The custom domain name to associate with the workgroup.
*/
customDomainName?: CustomDomainName;
/**
* The name of the workgroup associated with the database.
*/
workgroupName?: WorkgroupName;
}
export interface CreateEndpointAccessRequest {
/**
* 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.
*/
endpointName: String;
/**
* The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
*/
ownerAccount?: OwnerAccount;
/**
* The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.
*/
subnetIds: SubnetIdList;
/**
* The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
*/
vpcSecurityGroupIds?: VpcSecurityGroupIdList;
/**
* The name of the workgroup to associate with the VPC endpoint.
*/
workgroupName: String;
}
export interface CreateEndpointAccessResponse {
/**
* The created VPC endpoint.
*/
endpoint?: EndpointAccess;
}
export interface CreateNamespaceRequest {
/**
* 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.
*/
adminPasswordSecretKmsKeyId?: KmsKeyId;
/**
* The password of the administrator for the first database created in the namespace. You can't use adminUserPassword if manageAdminPassword is true.
*/
adminUserPassword?: DbPassword;
/**
* The username of the administrator for the first database created in the namespace.
*/
adminUsername?: DbUser;
/**
* The name of the first database created in the namespace.
*/
dbName?: String;
/**
* The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
*/
defaultIamRoleArn?: String;
/**
* A list of IAM roles to associate with the namespace.
*/
iamRoles?: IamRoleArnList;
/**
* The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
*/
kmsKeyId?: String;
/**
* The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.
*/
logExports?: LogExportList;
/**
* 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.
*/
manageAdminPassword?: Boolean;
/**
* The name of the namespace.
*/
namespaceName: NamespaceName;
/**
* The ARN for the Redshift application that integrates with IAM Identity Center.
*/
redshiftIdcApplicationArn?: RedshiftIdcApplicationArn;
/**
* A list of tag instances.
*/
tags?: TagList;
}
export interface CreateNamespaceResponse {
/**
* The created namespace object.
*/
namespace?: Namespace;
}
export interface CreateScheduledActionRequest {
/**
* 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.
*/
enabled?: Boolean;
/**
* The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
*/
endTime?: Timestamp;
/**
* The name of the namespace for which to create a scheduled action.
*/
namespaceName: NamespaceName;
/**
* 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
*/
roleArn: IamRoleArn;
/**
* 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.
*/
schedule: Schedule;
/**
* The description of the scheduled action.
*/
scheduledActionDescription?: String;
/**
* The name of the scheduled action.
*/
scheduledActionName: ScheduledActionName;
/**
* The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
*/
startTime?: Timestamp;
targetAction: TargetAction;
}
export interface CreateScheduledActionResponse {
/**
* The returned ScheduledAction object that describes the properties of a scheduled action.
*/
scheduledAction?: ScheduledActionResponse;
}
export interface CreateSnapshotCopyConfigurationRequest {
/**
* The KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
*/
destinationKmsKeyId?: KmsKeyId;
/**
* The destination Amazon Web Services Region that you want to copy snapshots to.
*/
destinationRegion: String;
/**
* The name of the namespace to copy snapshots from.
*/
namespaceName: NamespaceName;
/**
* The retention period of the snapshots that you copy to the destination Amazon Web Services Region.
*/
snapshotRetentionPeriod?: Integer;
}
export interface CreateSnapshotCopyConfigurationResponse {
/**
* The snapshot copy configuration object that is returned.
*/
snapshotCopyConfiguration: SnapshotCopyConfiguration;
}
export interface CreateSnapshotRequest {
/**
* The namespace to create a snapshot for.
*/
namespaceName: String;
/**
* How long to retain the created snapshot.
*/
retentionPeriod?: Integer;
/**
* The name of the snapshot.
*/
snapshotName: String;
/**
* An array of Tag objects to associate with the snapshot.
*/
tags?: TagList;
}
export interface CreateSnapshotResponse {
/**
* The created snapshot object.
*/
snapshot?: Snapshot;
}
export interface CreateSnapshotScheduleActionParameters {
/**
* The name of the namespace for which you want to configure a scheduled action to create a snapshot.
*/
namespaceName: NamespaceName;
/**
* The retention period of the snapshot created by the scheduled action.
*/
retentionPeriod?: Integer;
/**
* 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.
*/
snapshotNamePrefix: SnapshotNamePrefix;
/**
* An array of Tag objects to associate with the snapshot.
*/
tags?: TagList;
}
export interface CreateUsageLimitRequest {
/**
* 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.
*/
amount: Long;
/**
* The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.
*/
breachAction?: UsageLimitBreachAction;
/**
* The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
*/
period?: UsageLimitPeriod;
/**
* The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.
*/
resourceArn: String;
/**
* The type of Amazon Redshift Serverless usage to create a usage limit for.
*/
usageType: UsageLimitUsageType;
}
export interface CreateUsageLimitResponse {
/**
* The returned usage limit object.
*/
usageLimit?: UsageLimit;
}
export interface CreateWorkgroupRequest {
/**
* The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
*/
baseCapacity?: Integer;
/**
* 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.
*/
configParameters?: ConfigParameterList;
/**
* 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.
*/
enhancedVpcRouting?: Boolean;
/**
* The IP address type that the workgroup supports. Possible values are ipv4 and dualstack.
*/
ipAddressType?: IpAddressType;
/**
* The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
*/
maxCapacity?: Integer;
/**
* The name of the namespace to associate with the workgroup.
*/
namespaceName: NamespaceName;
/**
* The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
*/
port?: Integer;
/**
* A value that specifies whether the workgroup can be accessed from a public network.
*/
publiclyAccessible?: Boolean;
/**
* An array of security group IDs to associate with the workgroup.
*/
securityGroupIds?: SecurityGroupIdList;
/**
* An array of VPC subnet IDs to associate with the workgroup.
*/
subnetIds?: SubnetIdList;
/**
*