Redshift Serverless

convert_recovery_point_to_snapshot(recovery_point_id, snapshot_name)
convert_recovery_point_to_snapshot(recovery_point_id, snapshot_name, params::Dict{String,<:Any})

Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.

Arguments

• recovery_point_id: The unique identifier of the recovery point.
• snapshot_name: The name of the snapshot.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "retentionPeriod": How long to retain the snapshot.
• "tags": An array of Tag objects to associate with the created snapshot.

create_endpoint_access(endpoint_name, subnet_ids, workgroup_name)
create_endpoint_access(endpoint_name, subnet_ids, workgroup_name, params::Dict{String,<:Any})

Creates an Amazon Redshift Serverless managed VPC endpoint.

Arguments

• endpoint_name: 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.
• subnet_ids: The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.
• workgroup_name: The name of the workgroup to associate with the VPC endpoint.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

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

create_namespace(namespace_name)
create_namespace(namespace_name, params::Dict{String,<:Any})

Creates a namespace in Amazon Redshift Serverless.

Arguments

• namespace_name: The name of the namespace.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "adminUserPassword": The password of the administrator for the first database created in the namespace.
• "adminUsername": The username of the administrator for the first database created in the namespace.
• "dbName": The name of the first database created in the namespace.
• "defaultIamRoleArn": The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
• "iamRoles": A list of IAM roles to associate with the namespace.
• "kmsKeyId": The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
• "logExports": The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.
• "tags": A list of tag instances.

create_snapshot(namespace_name, snapshot_name)
create_snapshot(namespace_name, snapshot_name, params::Dict{String,<:Any})

Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.

Arguments

• namespace_name: The namespace to create a snapshot for.
• snapshot_name: The name of the snapshot.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "retentionPeriod": How long to retain the created snapshot.
• "tags": An array of Tag objects to associate with the snapshot.

create_usage_limit(amount, resource_arn, usage_type)
create_usage_limit(amount, resource_arn, usage_type, params::Dict{String,<:Any})

Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.

Arguments

• amount: 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.
• resource_arn: The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.
• usage_type: The type of Amazon Redshift Serverless usage to create a usage limit for.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "breachAction": The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.
• "period": The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

create_workgroup(namespace_name, workgroup_name)
create_workgroup(namespace_name, workgroup_name, params::Dict{String,<:Any})

Creates an workgroup in Amazon Redshift Serverless.

Arguments

• namespace_name: The name of the namespace to associate with the workgroup.
• workgroup_name: The name of the created workgroup.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "baseCapacity": The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
• "configParameters": An array of parameters to set for advanced control over a database. The options are automv, datestyle, enablecasesensitivityidentifier, enableuseractivitylogging, querygroup, search_path, 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.
• "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.
• "port": The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
• "publiclyAccessible": A value that specifies whether the workgroup can be accessed from a public network.
• "securityGroupIds": An array of security group IDs to associate with the workgroup.
• "subnetIds": An array of VPC subnet IDs to associate with the workgroup.
• "tags": A array of tag instances.

delete_endpoint_access(endpoint_name)
delete_endpoint_access(endpoint_name, params::Dict{String,<:Any})

Deletes an Amazon Redshift Serverless managed VPC endpoint.

Arguments

• endpoint_name: The name of the VPC endpoint to delete.

delete_namespace(namespace_name)
delete_namespace(namespace_name, params::Dict{String,<:Any})

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.

Arguments

• namespace_name: The name of the namespace to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "finalSnapshotName": The name of the snapshot to be created before the namespace is deleted.
• "finalSnapshotRetentionPeriod": How long to retain the final snapshot.

delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})

Deletes the specified resource policy.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the policy to delete.

delete_snapshot(snapshot_name)
delete_snapshot(snapshot_name, params::Dict{String,<:Any})

Deletes a snapshot from Amazon Redshift Serverless.

Arguments

• snapshot_name: The name of the snapshot to be deleted.

delete_usage_limit(usage_limit_id)
delete_usage_limit(usage_limit_id, params::Dict{String,<:Any})

Deletes a usage limit from Amazon Redshift Serverless.

Arguments

• usage_limit_id: The unique identifier of the usage limit to delete.

delete_workgroup(workgroup_name)
delete_workgroup(workgroup_name, params::Dict{String,<:Any})

Deletes a workgroup.

Arguments

• workgroup_name: The name of the workgroup to be deleted.

get_credentials(workgroup_name)
get_credentials(workgroup_name, params::Dict{String,<:Any})

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>

Arguments

• workgroup_name: The name of the workgroup associated with the database.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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
• "durationSeconds": The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.

get_endpoint_access(endpoint_name)
get_endpoint_access(endpoint_name, params::Dict{String,<:Any})

Returns information, such as the name, about a VPC endpoint.

Arguments

• endpoint_name: The name of the VPC endpoint to return information for.

get_namespace(namespace_name)
get_namespace(namespace_name, params::Dict{String,<:Any})

Returns information about a namespace in Amazon Redshift Serverless.

Arguments

• namespace_name: The name of the namespace to retrieve information for.

get_recovery_point(recovery_point_id)
get_recovery_point(recovery_point_id, params::Dict{String,<:Any})

Returns information about a recovery point.

Arguments

• recovery_point_id: The unique identifier of the recovery point to return information for.

get_resource_policy(resource_arn)
get_resource_policy(resource_arn, params::Dict{String,<:Any})

Returns a resource policy.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource to return.

get_snapshot()
get_snapshot(params::Dict{String,<:Any})

Returns information about a specific snapshot.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ownerAccount": The owner Amazon Web Services account of a snapshot shared with another user.
• "snapshotArn": The Amazon Resource Name (ARN) of the snapshot to return.
• "snapshotName": The name of the snapshot to return.

get_table_restore_status(table_restore_request_id)
get_table_restore_status(table_restore_request_id, params::Dict{String,<:Any})

Returns information about a TableRestoreStatus object.

Arguments

• table_restore_request_id: The ID of the RestoreTableFromSnapshot request to return status for.

get_usage_limit(usage_limit_id)
get_usage_limit(usage_limit_id, params::Dict{String,<:Any})

Returns information about a usage limit.

Arguments

• usage_limit_id: The unique identifier of the usage limit to return information for.

get_workgroup(workgroup_name)
get_workgroup(workgroup_name, params::Dict{String,<:Any})

Returns information about a specific workgroup.

Arguments

• workgroup_name: The name of the workgroup to return information for.

list_endpoint_access()
list_endpoint_access(params::Dict{String,<:Any})

Returns an array of EndpointAccess objects and relevant information.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
• "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.
• "vpcId": The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.
• "workgroupName": The name of the workgroup associated with the VPC endpoint to return.

list_namespaces()
list_namespaces(params::Dict{String,<:Any})

Returns information about a list of specified namespaces.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
• "nextToken": 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.

list_recovery_points()
list_recovery_points(params::Dict{String,<:Any})

Returns an array of recovery points.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "endTime": The time when creation of the recovery point finished.
• "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
• "namespaceArn": The Amazon Resource Name (ARN) of the namespace from which to list recovery points.
• "namespaceName": The name of the namespace to list recovery points for.
• "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.
• "startTime": The time when the recovery point's creation was initiated.

list_snapshots()
list_snapshots(params::Dict{String,<:Any})

Returns a list of snapshots.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "endTime": The timestamp showing when the snapshot creation finished.
• "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
• "namespaceArn": The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.
• "namespaceName": The namespace from which to list all snapshots.
• "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.
• "ownerAccount": The owner Amazon Web Services account of the snapshot.
• "startTime": The time when the creation of the snapshot was initiated.

list_table_restore_status()
list_table_restore_status(params::Dict{String,<:Any})

Returns information about an array of TableRestoreStatus objects.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
• "namespaceName": The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .
• "nextToken": If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will return results on the next page.
• "workgroupName": The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists the tags assigned to a resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource to list tags for.

list_usage_limits()
list_usage_limits(params::Dict{String,<:Any})

Lists all usage limits within Amazon Redshift Serverless.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
• "nextToken": If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.
• "resourceArn": The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.
• "usageType": The Amazon Redshift Serverless feature whose limits you want to see.

list_workgroups()
list_workgroups(params::Dict{String,<:Any})

Returns information about a list of specified workgroups.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "maxResults": An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
• "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.

put_resource_policy(policy, resource_arn)
put_resource_policy(policy, resource_arn, params::Dict{String,<:Any})

Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.

Arguments

• 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" }]}"
• resource_arn: The Amazon Resource Name (ARN) of the account to create or update a resource policy for.

restore_from_recovery_point(namespace_name, recovery_point_id, workgroup_name)
restore_from_recovery_point(namespace_name, recovery_point_id, workgroup_name, params::Dict{String,<:Any})

Restore the data from a recovery point.

Arguments

• namespace_name: The name of the namespace to restore data into.
• recovery_point_id: The unique identifier of the recovery point to restore from.
• workgroup_name: The name of the workgroup used to restore data.

restore_from_snapshot(namespace_name, workgroup_name)
restore_from_snapshot(namespace_name, workgroup_name, params::Dict{String,<:Any})

Restores a namespace from a snapshot.

Arguments

• namespace_name: The name of the namespace to restore the snapshot to.
• workgroup_name: The name of the workgroup used to restore the snapshot.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ownerAccount": The Amazon Web Services account that owns the snapshot.
• "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>:<accountid>:snapshot:<clusteridentifier>/<s napshot_identifier>.
• "snapshotName": The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.

restore_table_from_snapshot(namespace_name, new_table_name, snapshot_name, source_database_name, source_table_name, workgroup_name)
restore_table_from_snapshot(namespace_name, new_table_name, snapshot_name, source_database_name, source_table_name, workgroup_name, params::Dict{String,<:Any})

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.

Arguments

• namespace_name: The namespace of the snapshot to restore from.
• new_table_name: The name of the table to create from the restore operation.
• snapshot_name: The name of the snapshot to restore the table from.
• source_database_name: The name of the source database that contains the table being restored.
• source_table_name: The name of the source table being restored.
• workgroup_name: The workgroup to restore the table to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
• "sourceSchemaName": The name of the source schema that contains the table being restored.
• "targetDatabaseName": The name of the database to restore the table to.
• "targetSchemaName": The name of the schema to restore the table to.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Assigns one or more tags to a resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource to tag.
• tags: The map of the key-value pairs used to tag the resource.

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes a tag or set of tags from a resource.

Arguments

• resource_arn: The Amazon Resource Name (ARN) of the resource to remove tags from.
• tag_keys: The tag or set of tags to remove from the resource.

update_endpoint_access(endpoint_name)
update_endpoint_access(endpoint_name, params::Dict{String,<:Any})

Updates an Amazon Redshift Serverless managed endpoint.

Arguments

• endpoint_name: The name of the VPC endpoint to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "vpcSecurityGroupIds": The list of VPC security groups associated with the endpoint after the endpoint is modified.

update_namespace(namespace_name)
update_namespace(namespace_name, params::Dict{String,<:Any})

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.

Arguments

• namespace_name: The name of the namespace to update. You can't update the name of a namespace once it is created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "adminUserPassword": The password of the administrator for the first database created in the namespace. This parameter must be updated together with adminUsername.
• "adminUsername": The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.
• "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.
• "iamRoles": A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.
• "kmsKeyId": The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
• "logExports": The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.

update_snapshot(snapshot_name)
update_snapshot(snapshot_name, params::Dict{String,<:Any})

Updates a snapshot.

Arguments

• snapshot_name: The name of the snapshot.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "retentionPeriod": The new retention period of the snapshot.

update_usage_limit(usage_limit_id)
update_usage_limit(usage_limit_id, params::Dict{String,<:Any})

Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.

Arguments

• usage_limit_id: The identifier of the usage limit to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.
• "breachAction": The new action that Amazon Redshift Serverless takes when the limit is reached.

update_workgroup(workgroup_name)
update_workgroup(workgroup_name, params::Dict{String,<:Any})

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.

Arguments

• workgroup_name: The name of the workgroup to update. You can't update the name of a workgroup once it is created.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "baseCapacity": The new base data warehouse capacity in Redshift Processing Units (RPUs).
• "configParameters": An array of parameters to set for advanced control over a database. The options are automv, datestyle, enablecasesensitivityidentifier, enableuseractivitylogging, querygroup, search_path, 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.
• "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.
• "port": The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
• "publiclyAccessible": A value that specifies whether the workgroup can be accessible from a public network.
• "securityGroupIds": An array of security group IDs to associate with the workgroup.
• "subnetIds": An array of VPC subnet IDs to associate with the workgroup.