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.
", "operations": { "ConvertRecoveryPointToSnapshot": "Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.
", "CreateCustomDomainAssociation": "Creates a custom domain association for Amazon Redshift Serverless.
", "CreateEndpointAccess": "Creates an Amazon Redshift Serverless managed VPC endpoint.
", "CreateNamespace": "Creates a namespace in Amazon Redshift Serverless.
", "CreateScheduledAction": "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.
Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
", "CreateSnapshotCopyConfiguration": "Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
", "CreateUsageLimit": "Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.
", "CreateWorkgroup": "Creates an workgroup in Amazon Redshift Serverless.
", "DeleteCustomDomainAssociation": "Deletes a custom domain association for Amazon Redshift Serverless.
", "DeleteEndpointAccess": "Deletes an Amazon Redshift Serverless managed VPC endpoint.
", "DeleteNamespace": "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.
", "DeleteResourcePolicy": "Deletes the specified resource policy.
", "DeleteScheduledAction": "Deletes a scheduled action.
", "DeleteSnapshot": "Deletes a snapshot from Amazon Redshift Serverless.
", "DeleteSnapshotCopyConfiguration": "Deletes a snapshot copy configuration
", "DeleteUsageLimit": "Deletes a usage limit from Amazon Redshift Serverless.
", "DeleteWorkgroup": "Deletes a workgroup.
", "GetCredentials": "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> Gets information about a specific custom domain association.
", "GetEndpointAccess": "Returns information, such as the name, about a VPC endpoint.
", "GetNamespace": "Returns information about a namespace in Amazon Redshift Serverless.
", "GetRecoveryPoint": "Returns information about a recovery point.
", "GetResourcePolicy": "Returns a resource policy.
", "GetScheduledAction": "Returns information about a scheduled action.
", "GetSnapshot": "Returns information about a specific snapshot.
", "GetTableRestoreStatus": "Returns information about a TableRestoreStatus object.
Returns information about a usage limit.
", "GetWorkgroup": "Returns information about a specific workgroup.
", "ListCustomDomainAssociations": "Lists custom domain associations for Amazon Redshift Serverless.
", "ListEndpointAccess": "Returns an array of EndpointAccess objects and relevant information.
Returns information about a list of specified namespaces.
", "ListRecoveryPoints": "Returns an array of recovery points.
", "ListScheduledActions": "Returns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.
", "ListSnapshotCopyConfigurations": "Returns a list of snapshot copy configurations.
", "ListSnapshots": "Returns a list of snapshots.
", "ListTableRestoreStatus": "Returns information about an array of TableRestoreStatus objects.
Lists the tags assigned to a resource.
", "ListUsageLimits": "Lists all usage limits within Amazon Redshift Serverless.
", "ListWorkgroups": "Returns information about a list of specified workgroups.
", "PutResourcePolicy": "Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
", "RestoreFromRecoveryPoint": "Restore the data from a recovery point.
", "RestoreFromSnapshot": "Restores a namespace from a snapshot.
", "RestoreTableFromRecoveryPoint": "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.
", "RestoreTableFromSnapshot": "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.
", "TagResource": "Assigns one or more tags to a resource.
", "UntagResource": "Removes a tag or set of tags from a resource.
", "UpdateCustomDomainAssociation": "Updates an Amazon Redshift Serverless certificate associated with a custom domain.
", "UpdateEndpointAccess": "Updates an Amazon Redshift Serverless managed endpoint.
", "UpdateNamespace": "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.
Updates a scheduled action.
", "UpdateSnapshot": "Updates a snapshot.
", "UpdateSnapshotCopyConfiguration": "Updates a snapshot copy configuration.
", "UpdateUsageLimit": "Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.
", "UpdateWorkgroup": "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.
You do not have sufficient access to perform this action.
", "refs": { } }, "AccountIdList": { "base": null, "refs": { "Snapshot$accountsWithProvisionedRestoreAccess": "All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
", "Snapshot$accountsWithRestoreAccess": "All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
" } }, "AmazonResourceName": { "base": null, "refs": { "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource to list tags for.
", "ResourceNotFoundException$resourceName": "The name of the resource that could not be found.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource to tag.
", "TooManyTagsException$resourceName": "The name of the resource that exceeded the number of tags allowed for a resource.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource to remove tags from.
" } }, "Association": { "base": "An object that represents the custom domain name association.
", "refs": { "AssociationList$member": null } }, "AssociationList": { "base": null, "refs": { "ListCustomDomainAssociationsResponse$associations": "A list of Association objects.
" } }, "Boolean": { "base": null, "refs": { "CreateNamespaceRequest$manageAdminPassword": "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.
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.
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.
", "CreateWorkgroupRequest$publiclyAccessible": "A value that specifies whether the workgroup can be accessed from a public network.
", "RestoreFromSnapshotRequest$manageAdminPassword": "If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.
Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.
", "RestoreTableFromSnapshotRequest$activateCaseSensitiveIdentifier": "Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.
", "UpdateNamespaceRequest$manageAdminPassword": "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.
Specifies whether to enable the scheduled action.
", "UpdateWorkgroupRequest$enhancedVpcRouting": "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.
", "UpdateWorkgroupRequest$publiclyAccessible": "A value that specifies whether the workgroup can be accessible from a public network.
", "Workgroup$enhancedVpcRouting": "The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
", "Workgroup$publiclyAccessible": "A value that specifies whether the workgroup can be accessible from a public network
" } }, "ConfigParameter": { "base": "An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.
", "refs": { "ConfigParameterList$member": null } }, "ConfigParameterList": { "base": null, "refs": { "CreateWorkgroupRequest$configParameters": "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, 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.
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, 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.
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, 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.
The submitted action has conflicts.
", "refs": { } }, "ConvertRecoveryPointToSnapshotRequest": { "base": null, "refs": { } }, "ConvertRecoveryPointToSnapshotResponse": { "base": null, "refs": { } }, "CreateCustomDomainAssociationRequest": { "base": null, "refs": { } }, "CreateCustomDomainAssociationResponse": { "base": null, "refs": { } }, "CreateEndpointAccessRequest": { "base": null, "refs": { } }, "CreateEndpointAccessResponse": { "base": null, "refs": { } }, "CreateNamespaceRequest": { "base": null, "refs": { } }, "CreateNamespaceResponse": { "base": null, "refs": { } }, "CreateScheduledActionRequest": { "base": null, "refs": { } }, "CreateScheduledActionResponse": { "base": null, "refs": { } }, "CreateSnapshotCopyConfigurationRequest": { "base": null, "refs": { } }, "CreateSnapshotCopyConfigurationResponse": { "base": null, "refs": { } }, "CreateSnapshotRequest": { "base": null, "refs": { } }, "CreateSnapshotResponse": { "base": null, "refs": { } }, "CreateSnapshotScheduleActionParameters": { "base": "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.
", "refs": { "TargetAction$createSnapshot": null } }, "CreateUsageLimitRequest": { "base": null, "refs": { } }, "CreateUsageLimitResponse": { "base": null, "refs": { } }, "CreateWorkgroupRequest": { "base": null, "refs": { } }, "CreateWorkgroupResponse": { "base": null, "refs": { } }, "CustomDomainCertificateArnString": { "base": null, "refs": { "Association$customDomainCertificateArn": "The custom domain name’s certificate Amazon resource name (ARN).
", "CreateCustomDomainAssociationRequest$customDomainCertificateArn": "The custom domain name’s certificate Amazon resource name (ARN).
", "CreateCustomDomainAssociationResponse$customDomainCertificateArn": "The custom domain name’s certificate Amazon resource name (ARN).
", "GetCustomDomainAssociationResponse$customDomainCertificateArn": "The custom domain name’s certificate Amazon resource name (ARN).
", "ListCustomDomainAssociationsRequest$customDomainCertificateArn": "The custom domain name’s certificate Amazon resource name (ARN).
", "UpdateCustomDomainAssociationRequest$customDomainCertificateArn": "The custom domain name’s certificate Amazon resource name (ARN). This is optional.
", "UpdateCustomDomainAssociationResponse$customDomainCertificateArn": "The custom domain name’s certificate Amazon resource name (ARN).
", "Workgroup$customDomainCertificateArn": "The custom domain name’s certificate Amazon resource name (ARN).
" } }, "CustomDomainName": { "base": null, "refs": { "Association$customDomainName": "The custom domain name associated with the workgroup.
", "CreateCustomDomainAssociationRequest$customDomainName": "The custom domain name to associate with the workgroup.
", "CreateCustomDomainAssociationResponse$customDomainName": "The custom domain name to associate with the workgroup.
", "DeleteCustomDomainAssociationRequest$customDomainName": "The custom domain name associated with the workgroup.
", "GetCredentialsRequest$customDomainName": "The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.
", "GetCustomDomainAssociationRequest$customDomainName": "The custom domain name associated with the workgroup.
", "GetCustomDomainAssociationResponse$customDomainName": "The custom domain name associated with the workgroup.
", "ListCustomDomainAssociationsRequest$customDomainName": "The custom domain name associated with the workgroup.
", "UpdateCustomDomainAssociationRequest$customDomainName": "The custom domain name associated with the workgroup.
", "UpdateCustomDomainAssociationResponse$customDomainName": "The custom domain name associated with the workgroup.
", "Workgroup$customDomainName": "The custom domain name associated with the workgroup.
" } }, "DbName": { "base": null, "refs": { "GetCredentialsRequest$dbName": "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
The password of the administrator for the first database created in the namespace.
You can't use adminUserPassword if manageAdminPassword is true.
A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.
The password of the administrator for the first database created in the namespace. This parameter must be updated together with adminUsername.
You can't use adminUserPassword if manageAdminPassword is true.
The username of the administrator for the first database created in the namespace.
", "GetCredentialsResponse$dbUser": "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.
The username of the administrator for the first database created in the namespace.
", "UpdateNamespaceRequest$adminUsername": "The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.
The total size of the data in the recovery point in megabytes.
", "Snapshot$actualIncrementalBackupSizeInMegaBytes": "The size of the incremental backup in megabytes.
", "Snapshot$backupProgressInMegaBytes": "The size in megabytes of the data that has been backed up to a snapshot.
", "Snapshot$currentBackupRateInMegaBytesPerSecond": "The rate at which data is backed up into a snapshot in megabytes per second.
", "Snapshot$totalBackupSizeInMegaBytes": "The total size, in megabytes, of how big the snapshot is.
" } }, "Endpoint": { "base": "The VPC endpoint object.
", "refs": { "Workgroup$endpoint": "The endpoint that is created from the workgroup.
" } }, "EndpointAccess": { "base": "Information about an Amazon Redshift Serverless VPC endpoint.
", "refs": { "CreateEndpointAccessResponse$endpoint": "The created VPC endpoint.
", "DeleteEndpointAccessResponse$endpoint": "The deleted VPC endpoint.
", "EndpointAccessList$member": null, "GetEndpointAccessResponse$endpoint": "The returned VPC endpoint.
", "UpdateEndpointAccessResponse$endpoint": "The updated VPC endpoint.
" } }, "EndpointAccessList": { "base": null, "refs": { "ListEndpointAccessResponse$endpoints": "The returned VPC endpoints.
" } }, "GetCredentialsRequest": { "base": null, "refs": { } }, "GetCredentialsResponse": { "base": null, "refs": { } }, "GetCustomDomainAssociationRequest": { "base": null, "refs": { } }, "GetCustomDomainAssociationResponse": { "base": null, "refs": { } }, "GetEndpointAccessRequest": { "base": null, "refs": { } }, "GetEndpointAccessResponse": { "base": null, "refs": { } }, "GetNamespaceRequest": { "base": null, "refs": { } }, "GetNamespaceResponse": { "base": null, "refs": { } }, "GetRecoveryPointRequest": { "base": null, "refs": { } }, "GetRecoveryPointResponse": { "base": null, "refs": { } }, "GetResourcePolicyRequest": { "base": null, "refs": { } }, "GetResourcePolicyResponse": { "base": null, "refs": { } }, "GetScheduledActionRequest": { "base": null, "refs": { } }, "GetScheduledActionResponse": { "base": null, "refs": { } }, "GetSnapshotRequest": { "base": null, "refs": { } }, "GetSnapshotResponse": { "base": null, "refs": { } }, "GetTableRestoreStatusRequest": { "base": null, "refs": { } }, "GetTableRestoreStatusResponse": { "base": null, "refs": { } }, "GetUsageLimitRequest": { "base": null, "refs": { } }, "GetUsageLimitResponse": { "base": null, "refs": { } }, "GetWorkgroupRequest": { "base": null, "refs": { } }, "GetWorkgroupResponse": { "base": null, "refs": { } }, "IamRoleArn": { "base": null, "refs": { "CreateScheduledActionRequest$roleArn": "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 Cluster Management Guide
", "IamRoleArnList$member": null, "ScheduledActionResponse$roleArn": "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 Cluster Management Guide
", "UpdateScheduledActionRequest$roleArn": "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 Cluster Management Guide
" } }, "IamRoleArnList": { "base": null, "refs": { "CreateNamespaceRequest$iamRoles": "A list of IAM roles to associate with the namespace.
", "Namespace$iamRoles": "A list of IAM roles to associate with the namespace.
", "UpdateNamespaceRequest$iamRoles": "A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.
There is an insufficient capacity to perform the action.
", "refs": { } }, "Integer": { "base": null, "refs": { "ConvertRecoveryPointToSnapshotRequest$retentionPeriod": "How long to retain the snapshot.
", "CreateSnapshotCopyConfigurationRequest$snapshotRetentionPeriod": "The retention period of the snapshots that you copy to the destination Amazon Web Services Region.
", "CreateSnapshotRequest$retentionPeriod": "How long to retain the created snapshot.
", "CreateSnapshotScheduleActionParameters$retentionPeriod": "The retention period of the snapshot created by the scheduled action.
", "CreateWorkgroupRequest$baseCapacity": "The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
", "CreateWorkgroupRequest$maxCapacity": "The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
", "CreateWorkgroupRequest$port": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
", "DeleteNamespaceRequest$finalSnapshotRetentionPeriod": "How long to retain the final snapshot.
", "Endpoint$port": "The port that Amazon Redshift Serverless listens on.
", "EndpointAccess$port": "The port number on which Amazon Redshift Serverless accepts incoming connections.
", "GetCredentialsRequest$durationSeconds": "The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.
", "Snapshot$snapshotRemainingDays": "The amount of days until the snapshot is deleted.
", "Snapshot$snapshotRetentionPeriod": "The period of time, in days, of how long the snapshot is retained.
", "SnapshotCopyConfiguration$snapshotRetentionPeriod": "The retention period of snapshots that are copied to the destination Amazon Web Services Region.
", "UpdateSnapshotCopyConfigurationRequest$snapshotRetentionPeriod": "The new retention period of how long to keep a snapshot in the destination Amazon Web Services Region.
", "UpdateSnapshotRequest$retentionPeriod": "The new retention period of the snapshot.
", "UpdateWorkgroupRequest$baseCapacity": "The new base data warehouse capacity in Redshift Processing Units (RPUs).
", "UpdateWorkgroupRequest$maxCapacity": "The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
", "UpdateWorkgroupRequest$port": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
", "Workgroup$baseCapacity": "The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
", "Workgroup$maxCapacity": "The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
", "Workgroup$port": "The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
" } }, "InternalServerException": { "base": "The request processing has failed because of an unknown error, exception or failure.
", "refs": { } }, "InvalidPaginationException": { "base": "The provided pagination token is invalid.
", "refs": { } }, "KmsKeyId": { "base": null, "refs": { "CreateNamespaceRequest$adminPasswordSecretKmsKeyId": "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.
The KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
", "Namespace$adminPasswordSecretKmsKeyId": "The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
", "RestoreFromSnapshotRequest$adminPasswordSecretKmsKeyId": "The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
", "Snapshot$adminPasswordSecretKmsKeyId": "The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
", "Snapshot$kmsKeyId": "The unique identifier of the KMS key used to encrypt the snapshot.
", "SnapshotCopyConfiguration$destinationKmsKeyId": "The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
", "UpdateNamespaceRequest$adminPasswordSecretKmsKeyId": "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.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
An optional parameter that specifies the maximum number of results to return. Use nextToken to display the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
" } }, "ListTableRestoreStatusResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "ListUsageLimitsRequest": { "base": null, "refs": { } }, "ListUsageLimitsRequestMaxResultsInteger": { "base": null, "refs": { "ListUsageLimitsRequest$maxResults": "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.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
", "UpdateNamespaceRequest$logExports": "The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.
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.
", "Snapshot$elapsedTimeInSeconds": "The amount of time it took to back up data into a snapshot.
", "Snapshot$estimatedSecondsToCompletion": "The estimated amount of seconds until the snapshot completes backup.
", "TableRestoreStatus$progressInMegaBytes": "The amount of data restored to the new table so far, in megabytes (MB).
", "TableRestoreStatus$totalDataInMegaBytes": "The total amount of data to restore to the new table, in megabytes (MB).
", "UpdateUsageLimitRequest$amount": "The new 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.
", "UsageLimit$amount": "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.
" } }, "Namespace": { "base": "A collection of database objects and users.
", "refs": { "CreateNamespaceResponse$namespace": "The created namespace object.
", "DeleteNamespaceResponse$namespace": "The deleted namespace object.
", "GetNamespaceResponse$namespace": "The returned namespace object.
", "NamespaceList$member": null, "RestoreFromRecoveryPointResponse$namespace": "The namespace that data was restored into.
", "RestoreFromSnapshotResponse$namespace": null, "UpdateNamespaceResponse$namespace": "A list of tag instances.
" } }, "NamespaceList": { "base": null, "refs": { "ListNamespacesResponse$namespaces": "The list of returned namespaces.
" } }, "NamespaceName": { "base": null, "refs": { "CreateNamespaceRequest$namespaceName": "The name of the namespace.
", "CreateScheduledActionRequest$namespaceName": "The name of the namespace for which to create a scheduled action.
", "CreateSnapshotCopyConfigurationRequest$namespaceName": "The name of the namespace to copy snapshots from.
", "CreateSnapshotScheduleActionParameters$namespaceName": "The name of the namespace for which you want to configure a scheduled action to create a snapshot.
", "CreateWorkgroupRequest$namespaceName": "The name of the namespace to associate with the workgroup.
", "DeleteNamespaceRequest$namespaceName": "The name of the namespace to delete.
", "GetNamespaceRequest$namespaceName": "The name of the namespace to retrieve information for.
", "ListRecoveryPointsRequest$namespaceName": "The name of the namespace to list recovery points for.
", "ListScheduledActionsRequest$namespaceName": "The name of namespace associated with the scheduled action to retrieve.
", "ListSnapshotCopyConfigurationsRequest$namespaceName": "The namespace from which to list all snapshot copy configurations.
", "Namespace$namespaceName": "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.
", "RecoveryPoint$namespaceName": "The name of the namespace the recovery point is associated with.
", "RestoreFromRecoveryPointRequest$namespaceName": "The name of the namespace to restore data into.
", "RestoreFromSnapshotRequest$namespaceName": "The name of the namespace to restore the snapshot to.
", "ScheduledActionResponse$namespaceName": "The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
", "SnapshotCopyConfiguration$namespaceName": "The name of the namespace to copy snapshots from in the source Amazon Web Services Region.
", "UpdateNamespaceRequest$namespaceName": "The name of the namespace to update. You can't update the name of a namespace once it is created.
" } }, "NamespaceStatus": { "base": null, "refs": { "Namespace$status": "The status of the namespace.
" } }, "NetworkInterface": { "base": "Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
", "refs": { "NetworkInterfaceList$member": null } }, "NetworkInterfaceList": { "base": null, "refs": { "VpcEndpoint$networkInterfaces": "One or more network interfaces of the endpoint. Also known as an interface endpoint.
" } }, "NextInvocationsList": { "base": null, "refs": { "ScheduledActionResponse$nextInvocations": "An array of timestamps of when the next scheduled actions will trigger.
" } }, "OwnerAccount": { "base": null, "refs": { "CreateEndpointAccessRequest$ownerAccount": "The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
", "ListEndpointAccessRequest$ownerAccount": "The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
", "ListWorkgroupsRequest$ownerAccount": "The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
" } }, "PaginationToken": { "base": null, "refs": { "ListCustomDomainAssociationsRequest$nextToken": "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.
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.
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.
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.
", "ListSnapshotCopyConfigurationsRequest$nextToken": "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.
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.
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.
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.
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.
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.
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, 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.
The value of the parameter to set.
" } }, "PutResourcePolicyRequest": { "base": null, "refs": { } }, "PutResourcePolicyResponse": { "base": null, "refs": { } }, "RecoveryPoint": { "base": "The automatically created recovery point of a namespace. Recovery points are created every 30 minutes and kept for 24 hours.
", "refs": { "GetRecoveryPointResponse$recoveryPoint": "The returned recovery point object.
", "RecoveryPointList$member": null } }, "RecoveryPointList": { "base": null, "refs": { "ListRecoveryPointsResponse$recoveryPoints": "The returned recovery point objects.
" } }, "RedshiftIdcApplicationArn": { "base": null, "refs": { "CreateNamespaceRequest$redshiftIdcApplicationArn": "The ARN for the Redshift application that integrates with IAM Identity Center.
" } }, "ResourceNotFoundException": { "base": "The resource could not be found.
", "refs": { } }, "ResourcePolicy": { "base": "The resource policy object. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
", "refs": { "GetResourcePolicyResponse$resourcePolicy": "The returned resource policy.
", "PutResourcePolicyResponse$resourcePolicy": "The policy that was created or updated.
" } }, "RestoreFromRecoveryPointRequest": { "base": null, "refs": { } }, "RestoreFromRecoveryPointResponse": { "base": null, "refs": { } }, "RestoreFromSnapshotRequest": { "base": null, "refs": { } }, "RestoreFromSnapshotResponse": { "base": null, "refs": { } }, "RestoreTableFromRecoveryPointRequest": { "base": null, "refs": { } }, "RestoreTableFromRecoveryPointResponse": { "base": null, "refs": { } }, "RestoreTableFromSnapshotRequest": { "base": null, "refs": { } }, "RestoreTableFromSnapshotResponse": { "base": null, "refs": { } }, "Schedule": { "base": "The schedule of when Amazon Redshift Serverless should run the scheduled action.
", "refs": { "CreateScheduledActionRequest$schedule": "The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The name of the scheduled action.
", "DeleteScheduledActionRequest$scheduledActionName": "The name of the scheduled action to delete.
", "GetScheduledActionRequest$scheduledActionName": "The name of the scheduled action.
", "ScheduledActionResponse$scheduledActionName": "The name of the scheduled action.
", "ScheduledActionsList$member": null, "UpdateScheduledActionRequest$scheduledActionName": "The name of the scheduled action to update to.
" } }, "ScheduledActionResponse": { "base": "The returned scheduled action object.
", "refs": { "CreateScheduledActionResponse$scheduledAction": "The returned ScheduledAction object that describes the properties of a scheduled action.
The deleted scheduled action object.
", "GetScheduledActionResponse$scheduledAction": "The returned scheduled action object.
", "UpdateScheduledActionResponse$scheduledAction": "The ScheduledAction object that was updated.
" } }, "ScheduledActionsList": { "base": null, "refs": { "ListScheduledActionsResponse$scheduledActions": "All of the returned scheduled action objects.
" } }, "SecurityGroupId": { "base": null, "refs": { "SecurityGroupIdList$member": null } }, "SecurityGroupIdList": { "base": null, "refs": { "CreateWorkgroupRequest$securityGroupIds": "An array of security group IDs to associate with the workgroup.
", "UpdateWorkgroupRequest$securityGroupIds": "An array of security group IDs to associate with the workgroup.
", "Workgroup$securityGroupIds": "An array of security group IDs to associate with the workgroup.
" } }, "ServiceQuotaExceededException": { "base": "The service limit was exceeded.
", "refs": { } }, "Snapshot": { "base": "A snapshot object that contains databases.
", "refs": { "ConvertRecoveryPointToSnapshotResponse$snapshot": "The snapshot converted from the recovery point.
", "CreateSnapshotResponse$snapshot": "The created snapshot object.
", "DeleteSnapshotResponse$snapshot": "The deleted snapshot object.
", "GetSnapshotResponse$snapshot": "The returned snapshot object.
", "SnapshotList$member": null, "UpdateSnapshotResponse$snapshot": "The updated snapshot object.
" } }, "SnapshotCopyConfiguration": { "base": "The object that you configure to copy snapshots from one namespace to a namespace in another Amazon Web Services Region.
", "refs": { "CreateSnapshotCopyConfigurationResponse$snapshotCopyConfiguration": "The snapshot copy configuration object that is returned.
", "DeleteSnapshotCopyConfigurationResponse$snapshotCopyConfiguration": "The deleted snapshot copy configuration object.
", "SnapshotCopyConfigurations$member": null, "UpdateSnapshotCopyConfigurationResponse$snapshotCopyConfiguration": "The updated snapshot copy configuration object.
" } }, "SnapshotCopyConfigurations": { "base": null, "refs": { "ListSnapshotCopyConfigurationsResponse$snapshotCopyConfigurations": "All of the returned snapshot copy configurations.
" } }, "SnapshotList": { "base": null, "refs": { "ListSnapshotsResponse$snapshots": "All of the returned snapshot objects.
" } }, "SnapshotNamePrefix": { "base": null, "refs": { "CreateSnapshotScheduleActionParameters$snapshotNamePrefix": "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.
" } }, "SnapshotStatus": { "base": null, "refs": { "Snapshot$status": "The status of the snapshot.
" } }, "State": { "base": null, "refs": { "ScheduledActionResponse$state": "The state of the scheduled action.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$code": null, "AccessDeniedException$message": null, "AccountIdList$member": null, "ConflictException$message": null, "ConvertRecoveryPointToSnapshotRequest$recoveryPointId": "The unique identifier of the recovery point.
", "ConvertRecoveryPointToSnapshotRequest$snapshotName": "The name of the snapshot.
", "CreateEndpointAccessRequest$endpointName": "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.
", "CreateEndpointAccessRequest$workgroupName": "The name of the workgroup to associate with the VPC endpoint.
", "CreateNamespaceRequest$dbName": "The name of the first database created in the namespace.
", "CreateNamespaceRequest$defaultIamRoleArn": "The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
", "CreateNamespaceRequest$kmsKeyId": "The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
", "CreateScheduledActionRequest$scheduledActionDescription": "The description of the scheduled action.
", "CreateSnapshotCopyConfigurationRequest$destinationRegion": "The destination Amazon Web Services Region that you want to copy snapshots to.
", "CreateSnapshotRequest$namespaceName": "The namespace to create a snapshot for.
", "CreateSnapshotRequest$snapshotName": "The name of the snapshot.
", "CreateUsageLimitRequest$resourceArn": "The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.
", "DeleteEndpointAccessRequest$endpointName": "The name of the VPC endpoint to delete.
", "DeleteNamespaceRequest$finalSnapshotName": "The name of the snapshot to be created before the namespace is deleted.
", "DeleteResourcePolicyRequest$resourceArn": "The Amazon Resource Name (ARN) of the policy to delete.
", "DeleteSnapshotCopyConfigurationRequest$snapshotCopyConfigurationId": "The ID of the snapshot copy configuration to delete.
", "DeleteSnapshotRequest$snapshotName": "The name of the snapshot to be deleted.
", "DeleteUsageLimitRequest$usageLimitId": "The unique identifier of the usage limit to delete.
", "Endpoint$address": "The DNS address of the VPC endpoint.
", "EndpointAccess$address": "The DNS address of the endpoint.
", "EndpointAccess$endpointArn": "The Amazon Resource Name (ARN) of the VPC endpoint.
", "EndpointAccess$endpointName": "The name of the VPC endpoint.
", "EndpointAccess$endpointStatus": "The status of the VPC endpoint.
", "EndpointAccess$workgroupName": "The name of the workgroup associated with the endpoint.
", "GetEndpointAccessRequest$endpointName": "The name of the VPC endpoint to return information for.
", "GetRecoveryPointRequest$recoveryPointId": "The unique identifier of the recovery point to return information for.
", "GetResourcePolicyRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource to return.
", "GetSnapshotRequest$ownerAccount": "The owner Amazon Web Services account of a snapshot shared with another user.
", "GetSnapshotRequest$snapshotArn": "The Amazon Resource Name (ARN) of the snapshot to return.
", "GetSnapshotRequest$snapshotName": "The name of the snapshot to return.
", "GetTableRestoreStatusRequest$tableRestoreRequestId": "The ID of the RestoreTableFromSnapshot request to return status for.
The unique identifier of the usage limit to return information for.
", "InsufficientCapacityException$message": null, "InternalServerException$message": null, "InvalidPaginationException$message": null, "ListEndpointAccessRequest$nextToken": "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.
The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.
", "ListEndpointAccessRequest$workgroupName": "The name of the workgroup associated with the VPC endpoint to return.
", "ListEndpointAccessResponse$nextToken": "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.
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.
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.
The Amazon Resource Name (ARN) of the namespace from which to list recovery points.
", "ListRecoveryPointsRequest$nextToken": "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.
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.
The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.
", "ListSnapshotsRequest$namespaceName": "The namespace from which to list all snapshots.
", "ListSnapshotsRequest$nextToken": "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.
The owner Amazon Web Services account of the snapshot.
", "ListSnapshotsResponse$nextToken": "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.
The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .
The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.
The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.
", "ListWorkgroupsRequest$nextToken": "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.
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.
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
", "Namespace$dbName": "The name of the first database created in the namespace.
", "Namespace$defaultIamRoleArn": "The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
", "Namespace$kmsKeyId": "The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
", "Namespace$namespaceArn": "The Amazon Resource Name (ARN) associated with a namespace.
", "Namespace$namespaceId": "The unique identifier of a namespace.
", "NetworkInterface$availabilityZone": "The availability Zone.
", "NetworkInterface$networkInterfaceId": "The unique identifier of the network interface.
", "NetworkInterface$privateIpAddress": "The IPv4 address of the network interface within the subnet.
", "NetworkInterface$subnetId": "The unique identifier of the subnet.
", "PutResourcePolicyRequest$policy": "The policy to create or update. For example, the following policy grants a user authorization to restore a snapshot.
\"{\\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\" : [{ \\\"Sid\\\": \\\"AllowUserRestoreFromSnapshot\\\", \\\"Principal\\\":{\\\"AWS\\\": [\\\"739247239426\\\"]}, \\\"Action\\\": [\\\"redshift-serverless:RestoreFromSnapshot\\\"] , \\\"Effect\\\": \\\"Allow\\\" }]}\"
The Amazon Resource Name (ARN) of the account to create or update a resource policy for.
", "RecoveryPoint$namespaceArn": "The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.
", "RecoveryPoint$recoveryPointId": "The unique identifier of the recovery point.
", "ResourceNotFoundException$message": null, "ResourcePolicy$policy": "The resource policy.
", "ResourcePolicy$resourceArn": "The Amazon Resource Name (ARN) of the policy.
", "RestoreFromRecoveryPointRequest$recoveryPointId": "The unique identifier of the recovery point to restore from.
", "RestoreFromRecoveryPointResponse$recoveryPointId": "The unique identifier of the recovery point used for the restore.
", "RestoreFromSnapshotRequest$ownerAccount": "The Amazon Web Services account that owns the snapshot.
", "RestoreFromSnapshotRequest$snapshotArn": "The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as snapshotName.
The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.
", "RestoreFromSnapshotRequest$snapshotName": "The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
The owner Amazon Web Services; account of the snapshot that was restored.
", "RestoreFromSnapshotResponse$snapshotName": "The name of the snapshot used to restore the namespace.
", "RestoreTableFromRecoveryPointRequest$namespaceName": "Namespace of the recovery point to restore from.
", "RestoreTableFromRecoveryPointRequest$newTableName": "The name of the table to create from the restore operation.
", "RestoreTableFromRecoveryPointRequest$recoveryPointId": "The ID of the recovery point to restore the table from.
", "RestoreTableFromRecoveryPointRequest$sourceDatabaseName": "The name of the source database that contains the table being restored.
", "RestoreTableFromRecoveryPointRequest$sourceSchemaName": "The name of the source schema that contains the table being restored.
", "RestoreTableFromRecoveryPointRequest$sourceTableName": "The name of the source table being restored.
", "RestoreTableFromRecoveryPointRequest$targetDatabaseName": "The name of the database to restore the table to.
", "RestoreTableFromRecoveryPointRequest$targetSchemaName": "The name of the schema to restore the table to.
", "RestoreTableFromRecoveryPointRequest$workgroupName": "The workgroup to restore the table to.
", "RestoreTableFromSnapshotRequest$namespaceName": "The namespace of the snapshot to restore from.
", "RestoreTableFromSnapshotRequest$newTableName": "The name of the table to create from the restore operation.
", "RestoreTableFromSnapshotRequest$snapshotName": "The name of the snapshot to restore the table from.
", "RestoreTableFromSnapshotRequest$sourceDatabaseName": "The name of the source database that contains the table being restored.
", "RestoreTableFromSnapshotRequest$sourceSchemaName": "The name of the source schema that contains the table being restored.
", "RestoreTableFromSnapshotRequest$sourceTableName": "The name of the source table being restored.
", "RestoreTableFromSnapshotRequest$targetDatabaseName": "The name of the database to restore the table to.
", "RestoreTableFromSnapshotRequest$targetSchemaName": "The name of the schema to restore the table to.
", "RestoreTableFromSnapshotRequest$workgroupName": "The workgroup to restore the table to.
", "Schedule$cron": "The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour.
Format of cron expressions is \"cron(Minutes Hours Day-of-month Month Day-of-week Year)\". For example, \"cron(0 10 ? * MON *)\". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
The description of the scheduled action.
", "ScheduledActionResponse$scheduledActionUuid": "The uuid of the scheduled action.
", "ServiceQuotaExceededException$message": null, "Snapshot$adminPasswordSecretArn": "The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
", "Snapshot$adminUsername": "The username of the database within a snapshot.
", "Snapshot$namespaceArn": "The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
", "Snapshot$namespaceName": "The name of the namepsace.
", "Snapshot$ownerAccount": "The owner Amazon Web Services; account of the snapshot.
", "Snapshot$snapshotArn": "The Amazon Resource Name (ARN) of the snapshot.
", "Snapshot$snapshotName": "The name of the snapshot.
", "SnapshotCopyConfiguration$destinationRegion": "The destination Amazon Web Services Region to copy snapshots to.
", "SnapshotCopyConfiguration$snapshotCopyConfigurationArn": "The ARN of the snapshot copy configuration object.
", "SnapshotCopyConfiguration$snapshotCopyConfigurationId": "The ID of the snapshot copy configuration object.
", "TableRestoreStatus$message": "A message that explains the returned status. For example, if the status of the operation is FAILED, the message explains why the operation failed.
The namespace of the table being restored from.
", "TableRestoreStatus$newTableName": "The name of the table to create from the restore operation.
", "TableRestoreStatus$recoveryPointId": "The ID of the recovery point being restored from.
", "TableRestoreStatus$snapshotName": "The name of the snapshot being restored from.
", "TableRestoreStatus$sourceDatabaseName": "The name of the source database being restored from.
", "TableRestoreStatus$sourceSchemaName": "The name of the source schema being restored from.
", "TableRestoreStatus$sourceTableName": "The name of the source table being restored from.
", "TableRestoreStatus$status": "A value that describes the current state of the table restore request. Possible values are SUCCEEDED, FAILED, CANCELED, PENDING, and IN_PROGRESS.
The ID of the RestoreTableFromSnapshot request.
", "TableRestoreStatus$targetDatabaseName": "The name of the database to restore to.
", "TableRestoreStatus$targetSchemaName": "The name of the schema to restore to.
", "TableRestoreStatus$workgroupName": "The name of the workgroup being restored from.
", "ThrottlingException$code": null, "ThrottlingException$message": null, "TooManyTagsException$message": null, "UpdateEndpointAccessRequest$endpointName": "The name of the VPC endpoint to update.
", "UpdateNamespaceRequest$defaultIamRoleArn": "The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together with iamRoles.
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
", "UpdateScheduledActionRequest$scheduledActionDescription": "The descripion of the scheduled action to update to.
", "UpdateSnapshotCopyConfigurationRequest$snapshotCopyConfigurationId": "The ID of the snapshot copy configuration to update.
", "UpdateSnapshotRequest$snapshotName": "The name of the snapshot.
", "UpdateUsageLimitRequest$usageLimitId": "The identifier of the usage limit to update.
", "UsageLimit$resourceArn": "The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
", "UsageLimit$usageLimitArn": "The Amazon Resource Name (ARN) of the resource associated with the usage limit.
", "UsageLimit$usageLimitId": "The identifier of the usage limit.
", "ValidationException$message": null, "VpcEndpoint$vpcEndpointId": "The connection endpoint ID for connecting to Amazon Redshift Serverless.
", "VpcEndpoint$vpcId": "The VPC identifier that the endpoint is associated with.
", "VpcIds$member": null, "VpcSecurityGroupMembership$status": "The status of the VPC security group.
", "Workgroup$namespaceName": "The namespace the workgroup is associated with.
", "Workgroup$patchVersion": "The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.
", "Workgroup$workgroupArn": "The Amazon Resource Name (ARN) that links to the workgroup.
", "Workgroup$workgroupId": "The unique identifier of the workgroup.
", "Workgroup$workgroupVersion": "The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.
" } }, "SubnetId": { "base": null, "refs": { "SubnetIdList$member": null } }, "SubnetIdList": { "base": null, "refs": { "CreateEndpointAccessRequest$subnetIds": "The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.
", "CreateWorkgroupRequest$subnetIds": "An array of VPC subnet IDs to associate with the workgroup.
", "EndpointAccess$subnetIds": "The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
", "UpdateWorkgroupRequest$subnetIds": "An array of VPC subnet IDs to associate with the workgroup.
", "Workgroup$subnetIds": "An array of subnet IDs the workgroup is associated with.
" } }, "SyntheticTimestamp_date_time": { "base": null, "refs": { "Association$customDomainCertificateExpiryTime": "The expiration time for the certificate.
", "CreateCustomDomainAssociationResponse$customDomainCertificateExpiryTime": "The expiration time for the certificate.
", "EndpointAccess$endpointCreateTime": "The time that the endpoint was created.
", "GetCustomDomainAssociationResponse$customDomainCertificateExpiryTime": "The expiration time for the certificate.
", "Namespace$creationDate": "The date of when the namespace was created.
", "RecoveryPoint$recoveryPointCreateTime": "The time the recovery point is created.
", "Snapshot$snapshotCreateTime": "The timestamp of when the snapshot was created.
", "Snapshot$snapshotRetentionStartTime": "The timestamp of when data within the snapshot started getting retained.
", "UpdateCustomDomainAssociationResponse$customDomainCertificateExpiryTime": "The expiration time for the certificate.
", "Workgroup$creationDate": "The creation date of the workgroup.
", "Workgroup$customDomainCertificateExpiryTime": "The expiration time for the certificate.
" } }, "TableRestoreStatus": { "base": "Contains information about a table restore request.
", "refs": { "GetTableRestoreStatusResponse$tableRestoreStatus": "The returned TableRestoreStatus object that contains information about the status of your RestoreTableFromSnapshot request.
The TableRestoreStatus object that contains the status of the restore operation.
", "TableRestoreStatusList$member": null } }, "TableRestoreStatusList": { "base": null, "refs": { "ListTableRestoreStatusResponse$tableRestoreStatuses": "The array of returned TableRestoreStatus objects.
A map of key-value pairs.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$key": "The key to use in the tag.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "The tag or set of tags to remove from the resource.
" } }, "TagList": { "base": null, "refs": { "ConvertRecoveryPointToSnapshotRequest$tags": "An array of Tag objects to associate with the created snapshot.
", "CreateNamespaceRequest$tags": "A list of tag instances.
", "CreateSnapshotRequest$tags": "An array of Tag objects to associate with the snapshot.
", "CreateSnapshotScheduleActionParameters$tags": "An array of Tag objects to associate with the snapshot.
", "CreateWorkgroupRequest$tags": "A array of tag instances.
", "ListTagsForResourceResponse$tags": "A map of the key-value pairs assigned to the resource.
", "TagResourceRequest$tags": "The map of the key-value pairs used to tag the resource.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$value": "The value of the tag.
" } }, "TargetAction": { "base": "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\"}}\"
The request was denied due to request throttling.
", "refs": { } }, "Timestamp": { "base": null, "refs": { "CreateScheduledActionRequest$endTime": "The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
", "CreateScheduledActionRequest$startTime": "The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
", "GetCredentialsResponse$expiration": "The date and time the password in DbPassword expires.
The date and time of when the DbUser and DbPassword authorization refreshes.
The time when creation of the recovery point finished.
", "ListRecoveryPointsRequest$startTime": "The time when the recovery point's creation was initiated.
", "ListSnapshotsRequest$endTime": "The timestamp showing when the snapshot creation finished.
", "ListSnapshotsRequest$startTime": "The time when the creation of the snapshot was initiated.
", "NextInvocationsList$member": null, "Schedule$at": "The timestamp of when Amazon Redshift Serverless should run the scheduled action. Format of at expressions is \"at(yyyy-mm-ddThh:mm:ss)\". For example, \"at(2016-03-04T17:27:00)\".
The end time of
", "ScheduledActionResponse$startTime": "The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
", "TableRestoreStatus$requestTime": "The time that the table restore request was made, in Universal Coordinated Time (UTC).
", "UpdateScheduledActionRequest$endTime": "The end time in UTC of the scheduled action to update.
", "UpdateScheduledActionRequest$startTime": "The start time in UTC of the scheduled action to update to.
" } }, "TooManyTagsException": { "base": "The request exceeded the number of tags allowed for a resource.
", "refs": { } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateCustomDomainAssociationRequest": { "base": null, "refs": { } }, "UpdateCustomDomainAssociationResponse": { "base": null, "refs": { } }, "UpdateEndpointAccessRequest": { "base": null, "refs": { } }, "UpdateEndpointAccessResponse": { "base": null, "refs": { } }, "UpdateNamespaceRequest": { "base": null, "refs": { } }, "UpdateNamespaceResponse": { "base": null, "refs": { } }, "UpdateScheduledActionRequest": { "base": null, "refs": { } }, "UpdateScheduledActionResponse": { "base": null, "refs": { } }, "UpdateSnapshotCopyConfigurationRequest": { "base": null, "refs": { } }, "UpdateSnapshotCopyConfigurationResponse": { "base": null, "refs": { } }, "UpdateSnapshotRequest": { "base": null, "refs": { } }, "UpdateSnapshotResponse": { "base": null, "refs": { } }, "UpdateUsageLimitRequest": { "base": null, "refs": { } }, "UpdateUsageLimitResponse": { "base": null, "refs": { } }, "UpdateWorkgroupRequest": { "base": null, "refs": { } }, "UpdateWorkgroupResponse": { "base": null, "refs": { } }, "UsageLimit": { "base": "The usage limit object.
", "refs": { "CreateUsageLimitResponse$usageLimit": "The returned usage limit object.
", "DeleteUsageLimitResponse$usageLimit": "The deleted usage limit object.
", "GetUsageLimitResponse$usageLimit": "The returned usage limit object.
", "UpdateUsageLimitResponse$usageLimit": "The updated usage limit object.
", "UsageLimits$member": null } }, "UsageLimitBreachAction": { "base": null, "refs": { "CreateUsageLimitRequest$breachAction": "The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.
", "UpdateUsageLimitRequest$breachAction": "The new action that Amazon Redshift Serverless takes when the limit is reached.
", "UsageLimit$breachAction": "The action that Amazon Redshift Serverless takes when the limit is reached.
" } }, "UsageLimitPeriod": { "base": null, "refs": { "CreateUsageLimitRequest$period": "The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
", "UsageLimit$period": "The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
" } }, "UsageLimitUsageType": { "base": null, "refs": { "CreateUsageLimitRequest$usageType": "The type of Amazon Redshift Serverless usage to create a usage limit for.
", "ListUsageLimitsRequest$usageType": "The Amazon Redshift Serverless feature whose limits you want to see.
", "UsageLimit$usageType": "The Amazon Redshift Serverless feature to limit.
" } }, "UsageLimits": { "base": null, "refs": { "ListUsageLimitsResponse$usageLimits": "An array of returned usage limit objects.
" } }, "ValidationException": { "base": "The input failed to satisfy the constraints specified by an AWS service.
", "refs": { } }, "VpcEndpoint": { "base": "The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
", "refs": { "EndpointAccess$vpcEndpoint": "The connection endpoint for connecting to Amazon Redshift Serverless.
", "VpcEndpointList$member": null } }, "VpcEndpointList": { "base": null, "refs": { "Endpoint$vpcEndpoints": "An array of VpcEndpoint objects.
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.
" } }, "VpcSecurityGroupId": { "base": null, "refs": { "VpcSecurityGroupIdList$member": null, "VpcSecurityGroupMembership$vpcSecurityGroupId": "The unique identifier of the VPC security group.
" } }, "VpcSecurityGroupIdList": { "base": null, "refs": { "CreateEndpointAccessRequest$vpcSecurityGroupIds": "The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
", "UpdateEndpointAccessRequest$vpcSecurityGroupIds": "The list of VPC security groups associated with the endpoint after the endpoint is modified.
" } }, "VpcSecurityGroupMembership": { "base": "Describes the members of a VPC security group.
", "refs": { "VpcSecurityGroupMembershipList$member": null } }, "VpcSecurityGroupMembershipList": { "base": null, "refs": { "EndpointAccess$vpcSecurityGroups": "The security groups associated with the endpoint.
" } }, "Workgroup": { "base": "The collection of computing resources from which an endpoint is created.
", "refs": { "CreateWorkgroupResponse$workgroup": "The created workgroup object.
", "DeleteWorkgroupResponse$workgroup": "The deleted workgroup object.
", "GetWorkgroupResponse$workgroup": "The returned workgroup object.
", "UpdateWorkgroupResponse$workgroup": "The updated workgroup object.
", "WorkgroupList$member": null } }, "WorkgroupList": { "base": null, "refs": { "ListWorkgroupsResponse$workgroups": "The returned array of workgroups.
" } }, "WorkgroupName": { "base": null, "refs": { "Association$workgroupName": "The name of the workgroup associated with the database.
", "CreateCustomDomainAssociationRequest$workgroupName": "The name of the workgroup associated with the database.
", "CreateCustomDomainAssociationResponse$workgroupName": "The name of the workgroup associated with the database.
", "CreateWorkgroupRequest$workgroupName": "The name of the created workgroup.
", "DeleteCustomDomainAssociationRequest$workgroupName": "The name of the workgroup associated with the database.
", "DeleteWorkgroupRequest$workgroupName": "The name of the workgroup to be deleted.
", "GetCredentialsRequest$workgroupName": "The name of the workgroup associated with the database.
", "GetCustomDomainAssociationRequest$workgroupName": "The name of the workgroup associated with the database.
", "GetCustomDomainAssociationResponse$workgroupName": "The name of the workgroup associated with the database.
", "GetWorkgroupRequest$workgroupName": "The name of the workgroup to return information for.
", "RecoveryPoint$workgroupName": "The name of the workgroup the recovery point is associated with.
", "RestoreFromRecoveryPointRequest$workgroupName": "The name of the workgroup used to restore data.
", "RestoreFromSnapshotRequest$workgroupName": "The name of the workgroup used to restore the snapshot.
", "UpdateCustomDomainAssociationRequest$workgroupName": "The name of the workgroup associated with the database.
", "UpdateCustomDomainAssociationResponse$workgroupName": "The name of the workgroup associated with the database.
", "UpdateWorkgroupRequest$workgroupName": "The name of the workgroup to update. You can't update the name of a workgroup once it is created.
", "Workgroup$workgroupName": "The name of the workgroup.
" } }, "WorkgroupStatus": { "base": null, "refs": { "Workgroup$status": "The status of the workgroup.
" } } } }