This is prerelease documentation for Amazon Redshift Serverless, which is in preview release. The documentation and the feature are both subject to change. We recommend that you use this feature only in test environments, and not in production environments. For preview terms and conditions, see Beta Service Participation in Amazon Web Services Service Terms.
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.
", - "CreateEndpointAccess": "Creates an Amazon Redshift Serverless managed VPC endpoint.
", - "CreateNamespace": "Creates a namespace in Amazon Redshift Serverless.
", - "CreateSnapshot": "Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
", - "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.
", - "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.
", - "DeleteSnapshot": "Deletes a snapshot from Amazon Redshift Serverless.
", - "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> 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.
", - "GetSnapshot": "Returns information about a specific snapshot.
", - "GetUsageLimit": "Returns information about a usage limit.
", - "GetWorkgroup": "Returns information about a specific workgroup.
", - "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.
", - "ListSnapshots": "Returns a list of snapshots.
", - "ListTagsForResource": "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.
", - "TagResource": "Assigns one or more tags to a resource.
", - "UntagResource": "Removes a tag or set of tags from a resource.
", - "UpdateEndpointAccess": "Updates an Amazon Redshift Serverless managed endpoint.
", - "UpdateNamespace": "Updates a namespace with the specified settings.
", - "UpdateSnapshot": "Updates a snapshot.
", - "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.
" - }, - "shapes": { - "AccessDeniedException": { - "base": "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.
" - } - }, - "Boolean": { - "base": null, - "refs": { - "CreateWorkgroupRequest$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 instead of over the internet.
", - "CreateWorkgroupRequest$publiclyAccessible": "A value that specifies whether the workgroup can be accessed from a public network.
", - "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 more control over a serverless database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.
An array of parameters to set for advanced control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.
An array of parameters to set for finer control over a database. The options are datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.
The submitted action has conflicts.
", - "refs": { - } - }, - "ConvertRecoveryPointToSnapshotRequest": { - "base": null, - "refs": { - } - }, - "ConvertRecoveryPointToSnapshotResponse": { - "base": null, - "refs": { - } - }, - "CreateEndpointAccessRequest": { - "base": null, - "refs": { - } - }, - "CreateEndpointAccessResponse": { - "base": null, - "refs": { - } - }, - "CreateNamespaceRequest": { - "base": null, - "refs": { - } - }, - "CreateNamespaceResponse": { - "base": null, - "refs": { - } - }, - "CreateSnapshotRequest": { - "base": null, - "refs": { - } - }, - "CreateSnapshotResponse": { - "base": null, - "refs": { - } - }, - "CreateUsageLimitRequest": { - "base": null, - "refs": { - } - }, - "CreateUsageLimitResponse": { - "base": null, - "refs": { - } - }, - "CreateWorkgroupRequest": { - "base": null, - "refs": { - } - }, - "CreateWorkgroupResponse": { - "base": null, - "refs": { - } - }, - "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 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.
", - "GetCredentialsResponse$dbPassword": "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.
" - } - }, - "DbUser": { - "base": null, - "refs": { - "CreateNamespaceRequest$adminUsername": "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.
" - } - }, - "DeleteEndpointAccessRequest": { - "base": null, - "refs": { - } - }, - "DeleteEndpointAccessResponse": { - "base": null, - "refs": { - } - }, - "DeleteNamespaceRequest": { - "base": null, - "refs": { - } - }, - "DeleteNamespaceResponse": { - "base": null, - "refs": { - } - }, - "DeleteResourcePolicyRequest": { - "base": null, - "refs": { - } - }, - "DeleteResourcePolicyResponse": { - "base": null, - "refs": { - } - }, - "DeleteSnapshotRequest": { - "base": null, - "refs": { - } - }, - "DeleteSnapshotResponse": { - "base": null, - "refs": { - } - }, - "DeleteUsageLimitRequest": { - "base": null, - "refs": { - } - }, - "DeleteUsageLimitResponse": { - "base": null, - "refs": { - } - }, - "DeleteWorkgroupRequest": { - "base": null, - "refs": { - } - }, - "DeleteWorkgroupResponse": { - "base": null, - "refs": { - } - }, - "Double": { - "base": null, - "refs": { - "RecoveryPoint$totalSizeInMegaBytes": "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": { - } - }, - "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": { - } - }, - "GetSnapshotRequest": { - "base": null, - "refs": { - } - }, - "GetSnapshotResponse": { - "base": null, - "refs": { - } - }, - "GetUsageLimitRequest": { - "base": null, - "refs": { - } - }, - "GetUsageLimitResponse": { - "base": null, - "refs": { - } - }, - "GetWorkgroupRequest": { - "base": null, - "refs": { - } - }, - "GetWorkgroupResponse": { - "base": null, - "refs": { - } - }, - "IamRoleArn": { - "base": null, - "refs": { - "IamRoleArnList$member": null - } - }, - "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.
" - } - }, - "InsufficientCapacityException": { - "base": "There is an insufficient capacity to perform the action.
", - "refs": { - } - }, - "Integer": { - "base": null, - "refs": { - "ConvertRecoveryPointToSnapshotRequest$retentionPeriod": "How long to retain the snapshot.
", - "CreateSnapshotRequest$retentionPeriod": "How long to retain the created snapshot.
", - "CreateWorkgroupRequest$baseCapacity": "The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
", - "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.
", - "UpdateSnapshotRequest$retentionPeriod": "The new retention period of the snapshot.
", - "UpdateWorkgroupRequest$baseCapacity": "The new base data warehouse capacity in Redshift Processing Units (RPUs).
", - "Workgroup$baseCapacity": "The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
" - } - }, - "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": { - "Snapshot$kmsKeyId": "The unique identifier of the KMS key used to encrypt the snapshot.
" - } - }, - "ListEndpointAccessRequest": { - "base": null, - "refs": { - } - }, - "ListEndpointAccessRequestMaxResultsInteger": { - "base": null, - "refs": { - "ListEndpointAccessRequest$maxResults": "An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
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 get 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.
", - "UpdateUsageLimitRequest$amount": "The new limit amount. For more information about this parameter.
", - "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.
", - "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.
", - "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.
", - "UpdateNamespaceRequest$namespaceName": "The name of the namespace.
" - } - }, - "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.
" - } - }, - "PaginationToken": { - "base": null, - "refs": { - "ListUsageLimitsRequest$nextToken": "If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in subsequent ListUsageLimits operations, which returns results in the next page.
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 datestyle, enable_user_activity_logging, query_group, search_path, and max_query_execution_time.
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.
" - } - }, - "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": { - } - }, - "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.
" - } - }, - "SnapshotList": { - "base": null, - "refs": { - "ListSnapshotsResponse$snapshots": "All of the returned snapshot objects.
" - } - }, - "SnapshotStatus": { - "base": null, - "refs": { - "Snapshot$status": "The status of the snapshot.
" - } - }, - "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.
", - "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.
", - "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.
", - "GetUsageLimitRequest$usageLimitId": "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 subsequent 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 subsequent 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.
If your initial ListRecoveryPoints operation returns a nextToken, you can include the returned nextToken in subsequent ListRecoveryPoints operations, which returns results in the next page.
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 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 subsequent 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 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$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.
", - "RestoreFromSnapshotRequest$snapshotName": "The name of the snapshot to restore from.
", - "RestoreFromSnapshotResponse$ownerAccount": "The owner Amazon Web Services; account of the snapshot that was restored.
", - "RestoreFromSnapshotResponse$snapshotName": "The name of the snapshot used to restore the namespace.
", - "ServiceQuotaExceededException$message": null, - "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.
", - "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.
", - "UpdateNamespaceRequest$kmsKeyId": "The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
", - "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.
", - "VpcSecurityGroupMembership$status": "The status of the VPC security group.
", - "Workgroup$namespaceName": "The namespace the workgroup is associated with.
", - "Workgroup$workgroupArn": "The Amazon Resource Name (ARN) that links to the workgroup.
", - "Workgroup$workgroupId": "The unique identifier of the workgroup.
" - } - }, - "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": { - "EndpointAccess$endpointCreateTime": "The time that the endpoint was created.
", - "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.
", - "Workgroup$creationDate": "The creation date of the workgroup.
" - } - }, - "Tag": { - "base": "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": { - "CreateNamespaceRequest$tags": "A list of tag instances.
", - "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.
" - } - }, - "ThrottlingException": { - "base": "The request was denied due to request throttling.
", - "refs": { - } - }, - "Timestamp": { - "base": null, - "refs": { - "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.
" - } - }, - "TooManyTagsException": { - "base": "The request exceeded the number of tags allowed for a resource.
", - "refs": { - } - }, - "UntagResourceRequest": { - "base": null, - "refs": { - } - }, - "UntagResourceResponse": { - "base": null, - "refs": { - } - }, - "UpdateEndpointAccessRequest": { - "base": null, - "refs": { - } - }, - "UpdateEndpointAccessResponse": { - "base": null, - "refs": { - } - }, - "UpdateNamespaceRequest": { - "base": null, - "refs": { - } - }, - "UpdateNamespaceResponse": { - "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.
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": { - "CreateWorkgroupRequest$workgroupName": "The name of the created workgroup.
", - "DeleteWorkgroupRequest$workgroupName": "The name of the workgroup to be deleted.
", - "GetCredentialsRequest$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.
", - "UpdateWorkgroupRequest$workgroupName": "The name of the workgroup to update.
", - "Workgroup$workgroupName": "The name of the workgroup.
" - } - }, - "WorkgroupStatus": { - "base": null, - "refs": { - "Workgroup$status": "The status of the workgroup.
" - } - } - } -} diff --git a/apis/redshiftserverless/2021-04-21/examples-1.json b/apis/redshiftserverless/2021-04-21/examples-1.json deleted file mode 100644 index 0ea7e3b0bbe..00000000000 --- a/apis/redshiftserverless/2021-04-21/examples-1.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "version": "1.0", - "examples": { - } -} diff --git a/apis/redshiftserverless/2021-04-21/paginators-1.json b/apis/redshiftserverless/2021-04-21/paginators-1.json deleted file mode 100644 index cf5163d4501..00000000000 --- a/apis/redshiftserverless/2021-04-21/paginators-1.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "pagination": { - "ListEndpointAccess": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "endpoints" - }, - "ListNamespaces": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "namespaces" - }, - "ListRecoveryPoints": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "recoveryPoints" - }, - "ListSnapshots": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "snapshots" - }, - "ListUsageLimits": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "usageLimits" - }, - "ListWorkgroups": { - "input_token": "nextToken", - "output_token": "nextToken", - "limit_key": "maxResults", - "result_key": "workgroups" - } - } -}