Table of Contents
RedshiftServerless.Client¶A low-level client representing Redshift Serverless
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.
import boto3
client = boto3.client('redshift-serverless')
These are the available methods:
can_paginate()close()convert_recovery_point_to_snapshot()create_endpoint_access()create_namespace()create_snapshot()create_usage_limit()create_workgroup()delete_endpoint_access()delete_namespace()delete_resource_policy()delete_snapshot()delete_usage_limit()delete_workgroup()get_credentials()get_endpoint_access()get_namespace()get_paginator()get_recovery_point()get_resource_policy()get_snapshot()get_table_restore_status()get_usage_limit()get_waiter()get_workgroup()list_endpoint_access()list_namespaces()list_recovery_points()list_snapshots()list_table_restore_status()list_tags_for_resource()list_usage_limits()list_workgroups()put_resource_policy()restore_from_recovery_point()restore_from_snapshot()restore_table_from_snapshot()tag_resource()untag_resource()update_endpoint_access()update_namespace()update_snapshot()update_usage_limit()update_workgroup()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
convert_recovery_point_to_snapshot(**kwargs)¶Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.
See also: AWS API Documentation
Request Syntax
response = client.convert_recovery_point_to_snapshot(
recoveryPointId='string',
retentionPeriod=123,
snapshotName='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The unique identifier of the recovery point.
[REQUIRED]
The name of the snapshot.
An array of Tag objects to associate with the created snapshot.
A map of key-value pairs.
The key to use in the tag.
The value of the tag.
dict
Response Syntax
{
'snapshot': {
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminUsername': 'string',
'backupProgressInMegaBytes': 123.0,
'currentBackupRateInMegaBytesPerSecond': 123.0,
'elapsedTimeInSeconds': 123,
'estimatedSecondsToCompletion': 123,
'kmsKeyId': 'string',
'namespaceArn': 'string',
'namespaceName': 'string',
'ownerAccount': 'string',
'snapshotArn': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'snapshotRemainingDays': 123,
'snapshotRetentionPeriod': 123,
'snapshotRetentionStartTime': datetime(2015, 1, 1),
'status': 'AVAILABLE'|'CREATING'|'DELETED'|'CANCELLED'|'FAILED'|'COPYING',
'totalBackupSizeInMegaBytes': 123.0
}
}
Response Structure
(dict) --
snapshot (dict) --
The snapshot converted from the recovery point.
accountsWithProvisionedRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
accountsWithRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
actualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup in megabytes.
adminUsername (string) --
The username of the database within a snapshot.
backupProgressInMegaBytes (float) --
The size in megabytes of the data that has been backed up to a snapshot.
currentBackupRateInMegaBytesPerSecond (float) --
The rate at which data is backed up into a snapshot in megabytes per second.
elapsedTimeInSeconds (integer) --
The amount of time it took to back up data into a snapshot.
estimatedSecondsToCompletion (integer) --
The estimated amount of seconds until the snapshot completes backup.
kmsKeyId (string) --
The unique identifier of the KMS key used to encrypt the snapshot.
namespaceArn (string) --
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
namespaceName (string) --
The name of the namepsace.
ownerAccount (string) --
The owner Amazon Web Services; account of the snapshot.
snapshotArn (string) --
The Amazon Resource Name (ARN) of the snapshot.
snapshotCreateTime (datetime) --
The timestamp of when the snapshot was created.
snapshotName (string) --
The name of the snapshot.
snapshotRemainingDays (integer) --
The amount of days until the snapshot is deleted.
snapshotRetentionPeriod (integer) --
The period of time, in days, of how long the snapshot is retained.
snapshotRetentionStartTime (datetime) --
The timestamp of when data within the snapshot started getting retained.
status (string) --
The status of the snapshot.
totalBackupSizeInMegaBytes (float) --
The total size, in megabytes, of how big the snapshot is.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionRedshiftServerless.Client.exceptions.TooManyTagsExceptionRedshiftServerless.Client.exceptions.ServiceQuotaExceededExceptioncreate_endpoint_access(**kwargs)¶Creates an Amazon Redshift Serverless managed VPC endpoint.
See also: AWS API Documentation
Request Syntax
response = client.create_endpoint_access(
endpointName='string',
subnetIds=[
'string',
],
vpcSecurityGroupIds=[
'string',
],
workgroupName='string'
)
[REQUIRED]
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.
[REQUIRED]
The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.
The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
[REQUIRED]
The name of the workgroup to associate with the VPC endpoint.
dict
Response Syntax
{
'endpoint': {
'address': 'string',
'endpointArn': 'string',
'endpointCreateTime': datetime(2015, 1, 1),
'endpointName': 'string',
'endpointStatus': 'string',
'port': 123,
'subnetIds': [
'string',
],
'vpcEndpoint': {
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
'vpcSecurityGroups': [
{
'status': 'string',
'vpcSecurityGroupId': 'string'
},
],
'workgroupName': 'string'
}
}
Response Structure
(dict) --
endpoint (dict) --
The created VPC endpoint.
address (string) --
The DNS address of the endpoint.
endpointArn (string) --
The Amazon Resource Name (ARN) of the VPC endpoint.
endpointCreateTime (datetime) --
The time that the endpoint was created.
endpointName (string) --
The name of the VPC endpoint.
endpointStatus (string) --
The status of the VPC endpoint.
port (integer) --
The port number on which Amazon Redshift Serverless accepts incoming connections.
subnetIds (list) --
The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
vpcEndpoint (dict) --
The connection endpoint for connecting to Amazon Redshift Serverless.
networkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
availabilityZone (string) --
The availability Zone.
networkInterfaceId (string) --
The unique identifier of the network interface.
privateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
subnetId (string) --
The unique identifier of the subnet.
vpcEndpointId (string) --
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId (string) --
The VPC identifier that the endpoint is associated with.
vpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
status (string) --
The status of the VPC security group.
vpcSecurityGroupId (string) --
The unique identifier of the VPC security group.
workgroupName (string) --
The name of the workgroup associated with the endpoint.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionRedshiftServerless.Client.exceptions.AccessDeniedExceptionRedshiftServerless.Client.exceptions.ServiceQuotaExceededExceptioncreate_namespace(**kwargs)¶Creates a namespace in Amazon Redshift Serverless.
See also: AWS API Documentation
Request Syntax
response = client.create_namespace(
adminUserPassword='string',
adminUsername='string',
dbName='string',
defaultIamRoleArn='string',
iamRoles=[
'string',
],
kmsKeyId='string',
logExports=[
'useractivitylog'|'userlog'|'connectionlog',
],
namespaceName='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
A list of IAM roles to associate with the namespace.
The types of logs the namespace can export. Available export types are userlog , connectionlog , and useractivitylog .
[REQUIRED]
The name of the namespace.
A list of tag instances.
A map of key-value pairs.
The key to use in the tag.
The value of the tag.
dict
Response Syntax
{
'namespace': {
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
}
}
Response Structure
(dict) --
namespace (dict) --
The created namespace object.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
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.
status (string) --
The status of the namespace.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionRedshiftServerless.Client.exceptions.TooManyTagsExceptioncreate_snapshot(**kwargs)¶Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
See also: AWS API Documentation
Request Syntax
response = client.create_snapshot(
namespaceName='string',
retentionPeriod=123,
snapshotName='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The namespace to create a snapshot for.
[REQUIRED]
The name of the snapshot.
An array of Tag objects to associate with the snapshot.
A map of key-value pairs.
The key to use in the tag.
The value of the tag.
dict
Response Syntax
{
'snapshot': {
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminUsername': 'string',
'backupProgressInMegaBytes': 123.0,
'currentBackupRateInMegaBytesPerSecond': 123.0,
'elapsedTimeInSeconds': 123,
'estimatedSecondsToCompletion': 123,
'kmsKeyId': 'string',
'namespaceArn': 'string',
'namespaceName': 'string',
'ownerAccount': 'string',
'snapshotArn': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'snapshotRemainingDays': 123,
'snapshotRetentionPeriod': 123,
'snapshotRetentionStartTime': datetime(2015, 1, 1),
'status': 'AVAILABLE'|'CREATING'|'DELETED'|'CANCELLED'|'FAILED'|'COPYING',
'totalBackupSizeInMegaBytes': 123.0
}
}
Response Structure
(dict) --
snapshot (dict) --
The created snapshot object.
accountsWithProvisionedRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
accountsWithRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
actualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup in megabytes.
adminUsername (string) --
The username of the database within a snapshot.
backupProgressInMegaBytes (float) --
The size in megabytes of the data that has been backed up to a snapshot.
currentBackupRateInMegaBytesPerSecond (float) --
The rate at which data is backed up into a snapshot in megabytes per second.
elapsedTimeInSeconds (integer) --
The amount of time it took to back up data into a snapshot.
estimatedSecondsToCompletion (integer) --
The estimated amount of seconds until the snapshot completes backup.
kmsKeyId (string) --
The unique identifier of the KMS key used to encrypt the snapshot.
namespaceArn (string) --
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
namespaceName (string) --
The name of the namepsace.
ownerAccount (string) --
The owner Amazon Web Services; account of the snapshot.
snapshotArn (string) --
The Amazon Resource Name (ARN) of the snapshot.
snapshotCreateTime (datetime) --
The timestamp of when the snapshot was created.
snapshotName (string) --
The name of the snapshot.
snapshotRemainingDays (integer) --
The amount of days until the snapshot is deleted.
snapshotRetentionPeriod (integer) --
The period of time, in days, of how long the snapshot is retained.
snapshotRetentionStartTime (datetime) --
The timestamp of when data within the snapshot started getting retained.
status (string) --
The status of the snapshot.
totalBackupSizeInMegaBytes (float) --
The total size, in megabytes, of how big the snapshot is.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionRedshiftServerless.Client.exceptions.TooManyTagsExceptionRedshiftServerless.Client.exceptions.ServiceQuotaExceededExceptioncreate_usage_limit(**kwargs)¶Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.
See also: AWS API Documentation
Request Syntax
response = client.create_usage_limit(
amount=123,
breachAction='log'|'emit-metric'|'deactivate',
period='daily'|'weekly'|'monthly',
resourceArn='string',
usageType='serverless-compute'|'cross-region-datasharing'
)
[REQUIRED]
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.
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.
[REQUIRED]
The type of Amazon Redshift Serverless usage to create a usage limit for.
dict
Response Syntax
{
'usageLimit': {
'amount': 123,
'breachAction': 'log'|'emit-metric'|'deactivate',
'period': 'daily'|'weekly'|'monthly',
'resourceArn': 'string',
'usageLimitArn': 'string',
'usageLimitId': 'string',
'usageType': 'serverless-compute'|'cross-region-datasharing'
}
}
Response Structure
(dict) --
usageLimit (dict) --
The returned usage limit object.
amount (integer) --
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.
breachAction (string) --
The action that Amazon Redshift Serverless takes when the limit is reached.
period (string) --
The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
resourceArn (string) --
The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
usageLimitArn (string) --
The Amazon Resource Name (ARN) of the resource associated with the usage limit.
usageLimitId (string) --
The identifier of the usage limit.
usageType (string) --
The Amazon Redshift Serverless feature to limit.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionRedshiftServerless.Client.exceptions.ServiceQuotaExceededExceptioncreate_workgroup(**kwargs)¶Creates an workgroup in Amazon Redshift Serverless.
See also: AWS API Documentation
Request Syntax
response = client.create_workgroup(
baseCapacity=123,
configParameters=[
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
enhancedVpcRouting=True|False,
namespaceName='string',
port=123,
publiclyAccessible=True|False,
securityGroupIds=[
'string',
],
subnetIds=[
'string',
],
tags=[
{
'key': 'string',
'value': 'string'
},
],
workgroupName='string'
)
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 key-value pairs to set for advanced control over Amazon Redshift Serverless.
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.
[REQUIRED]
The name of the namespace to associate with the workgroup.
An array of security group IDs to associate with the workgroup.
An array of VPC subnet IDs to associate with the workgroup.
A array of tag instances.
A map of key-value pairs.
The key to use in the tag.
The value of the tag.
[REQUIRED]
The name of the created workgroup.
dict
Response Syntax
{
'workgroup': {
'baseCapacity': 123,
'configParameters': [
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
'creationDate': datetime(2015, 1, 1),
'endpoint': {
'address': 'string',
'port': 123,
'vpcEndpoints': [
{
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'namespaceName': 'string',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'string',
],
'workgroupArn': 'string',
'workgroupId': 'string',
'workgroupName': 'string'
}
}
Response Structure
(dict) --
workgroup (dict) --
The created workgroup object.
baseCapacity (integer) --
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
configParameters (list) --
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 .
(dict) --
An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.
parameterKey (string) --
The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
parameterValue (string) --
The value of the parameter to set.
creationDate (datetime) --
The creation date of the workgroup.
endpoint (dict) --
The endpoint that is created from the workgroup.
address (string) --
The DNS address of the VPC endpoint.
port (integer) --
The port that Amazon Redshift Serverless listens on.
vpcEndpoints (list) --
An array of VpcEndpoint objects.
(dict) --
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
networkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
availabilityZone (string) --
The availability Zone.
networkInterfaceId (string) --
The unique identifier of the network interface.
privateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
subnetId (string) --
The unique identifier of the subnet.
vpcEndpointId (string) --
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId (string) --
The VPC identifier that the endpoint is associated with.
enhancedVpcRouting (boolean) --
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
namespaceName (string) --
The namespace the workgroup is associated with.
port (integer) --
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
publiclyAccessible (boolean) --
A value that specifies whether the workgroup can be accessible from a public network
securityGroupIds (list) --
An array of security group IDs to associate with the workgroup.
status (string) --
The status of the workgroup.
subnetIds (list) --
An array of subnet IDs the workgroup is associated with.
workgroupArn (string) --
The Amazon Resource Name (ARN) that links to the workgroup.
workgroupId (string) --
The unique identifier of the workgroup.
workgroupName (string) --
The name of the workgroup.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.InsufficientCapacityExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionRedshiftServerless.Client.exceptions.TooManyTagsExceptiondelete_endpoint_access(**kwargs)¶Deletes an Amazon Redshift Serverless managed VPC endpoint.
See also: AWS API Documentation
Request Syntax
response = client.delete_endpoint_access(
endpointName='string'
)
[REQUIRED]
The name of the VPC endpoint to delete.
{
'endpoint': {
'address': 'string',
'endpointArn': 'string',
'endpointCreateTime': datetime(2015, 1, 1),
'endpointName': 'string',
'endpointStatus': 'string',
'port': 123,
'subnetIds': [
'string',
],
'vpcEndpoint': {
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
'vpcSecurityGroups': [
{
'status': 'string',
'vpcSecurityGroupId': 'string'
},
],
'workgroupName': 'string'
}
}
Response Structure
The deleted VPC endpoint.
The DNS address of the endpoint.
The Amazon Resource Name (ARN) of the VPC endpoint.
The time that the endpoint was created.
The name of the VPC endpoint.
The status of the VPC endpoint.
The port number on which Amazon Redshift Serverless accepts incoming connections.
The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
The connection endpoint for connecting to Amazon Redshift Serverless.
One or more network interfaces of the endpoint. Also known as an interface endpoint.
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
The availability Zone.
The unique identifier of the network interface.
The IPv4 address of the network interface within the subnet.
The unique identifier of the subnet.
The connection endpoint ID for connecting to Amazon Redshift Serverless.
The VPC identifier that the endpoint is associated with.
The security groups associated with the endpoint.
Describes the members of a VPC security group.
The status of the VPC security group.
The unique identifier of the VPC security group.
The name of the workgroup associated with the endpoint.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptiondelete_namespace(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_namespace(
finalSnapshotName='string',
finalSnapshotRetentionPeriod=123,
namespaceName='string'
)
[REQUIRED]
The name of the namespace to delete.
dict
Response Syntax
{
'namespace': {
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
}
}
Response Structure
(dict) --
namespace (dict) --
The deleted namespace object.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
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.
status (string) --
The status of the namespace.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptiondelete_resource_policy(**kwargs)¶Deletes the specified resource policy.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_policy(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the policy to delete.
{}
Response Structure
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ValidationExceptiondelete_snapshot(**kwargs)¶Deletes a snapshot from Amazon Redshift Serverless.
See also: AWS API Documentation
Request Syntax
response = client.delete_snapshot(
snapshotName='string'
)
[REQUIRED]
The name of the snapshot to be deleted.
{
'snapshot': {
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminUsername': 'string',
'backupProgressInMegaBytes': 123.0,
'currentBackupRateInMegaBytesPerSecond': 123.0,
'elapsedTimeInSeconds': 123,
'estimatedSecondsToCompletion': 123,
'kmsKeyId': 'string',
'namespaceArn': 'string',
'namespaceName': 'string',
'ownerAccount': 'string',
'snapshotArn': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'snapshotRemainingDays': 123,
'snapshotRetentionPeriod': 123,
'snapshotRetentionStartTime': datetime(2015, 1, 1),
'status': 'AVAILABLE'|'CREATING'|'DELETED'|'CANCELLED'|'FAILED'|'COPYING',
'totalBackupSizeInMegaBytes': 123.0
}
}
Response Structure
The deleted snapshot object.
All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
The size of the incremental backup in megabytes.
The username of the database within a snapshot.
The size in megabytes of the data that has been backed up to a snapshot.
The rate at which data is backed up into a snapshot in megabytes per second.
The amount of time it took to back up data into a snapshot.
The estimated amount of seconds until the snapshot completes backup.
The unique identifier of the KMS key used to encrypt the snapshot.
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
The name of the namepsace.
The owner Amazon Web Services; account of the snapshot.
The Amazon Resource Name (ARN) of the snapshot.
The timestamp of when the snapshot was created.
The name of the snapshot.
The amount of days until the snapshot is deleted.
The period of time, in days, of how long the snapshot is retained.
The timestamp of when data within the snapshot started getting retained.
The status of the snapshot.
The total size, in megabytes, of how big the snapshot is.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptiondelete_usage_limit(**kwargs)¶Deletes a usage limit from Amazon Redshift Serverless.
See also: AWS API Documentation
Request Syntax
response = client.delete_usage_limit(
usageLimitId='string'
)
[REQUIRED]
The unique identifier of the usage limit to delete.
{
'usageLimit': {
'amount': 123,
'breachAction': 'log'|'emit-metric'|'deactivate',
'period': 'daily'|'weekly'|'monthly',
'resourceArn': 'string',
'usageLimitArn': 'string',
'usageLimitId': 'string',
'usageType': 'serverless-compute'|'cross-region-datasharing'
}
}
Response Structure
The deleted usage limit object.
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.
The action that Amazon Redshift Serverless takes when the limit is reached.
The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
The Amazon Resource Name (ARN) of the resource associated with the usage limit.
The identifier of the usage limit.
The Amazon Redshift Serverless feature to limit.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptiondelete_workgroup(**kwargs)¶Deletes a workgroup.
See also: AWS API Documentation
Request Syntax
response = client.delete_workgroup(
workgroupName='string'
)
[REQUIRED]
The name of the workgroup to be deleted.
{
'workgroup': {
'baseCapacity': 123,
'configParameters': [
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
'creationDate': datetime(2015, 1, 1),
'endpoint': {
'address': 'string',
'port': 123,
'vpcEndpoints': [
{
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'namespaceName': 'string',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'string',
],
'workgroupArn': 'string',
'workgroupId': 'string',
'workgroupName': 'string'
}
}
Response Structure
The deleted workgroup object.
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
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 .
An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.
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.
The creation date of the workgroup.
The endpoint that is created from the workgroup.
The DNS address of the VPC endpoint.
The port that Amazon Redshift Serverless listens on.
An array of VpcEndpoint objects.
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
One or more network interfaces of the endpoint. Also known as an interface endpoint.
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
The availability Zone.
The unique identifier of the network interface.
The IPv4 address of the network interface within the subnet.
The unique identifier of the subnet.
The connection endpoint ID for connecting to Amazon Redshift Serverless.
The VPC identifier that the endpoint is associated with.
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
The namespace the workgroup is associated with.
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
A value that specifies whether the workgroup can be accessible from a public network
An array of security group IDs to associate with the workgroup.
The status of the workgroup.
An array of subnet IDs the workgroup is associated with.
The Amazon Resource Name (ARN) that links to the workgroup.
The unique identifier of the workgroup.
The name of the workgroup.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionget_credentials(**kwargs)¶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>
See also: AWS API Documentation
Request Syntax
response = client.get_credentials(
dbName='string',
durationSeconds=123,
workgroupName='string'
)
The name of the database to get temporary authorization to log on to.
Constraints:
[REQUIRED]
The name of the workgroup associated with the database.
dict
Response Syntax
{
'dbPassword': 'string',
'dbUser': 'string',
'expiration': datetime(2015, 1, 1),
'nextRefreshTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
dbPassword (string) --
A temporary password that authorizes the user name returned by DbUser to log on to the database DbName .
dbUser (string) --
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.
expiration (datetime) --
The date and time the password in DbPassword expires.
nextRefreshTime (datetime) --
The date and time of when the DbUser and DbPassword authorization refreshes.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ValidationExceptionget_endpoint_access(**kwargs)¶Returns information, such as the name, about a VPC endpoint.
See also: AWS API Documentation
Request Syntax
response = client.get_endpoint_access(
endpointName='string'
)
[REQUIRED]
The name of the VPC endpoint to return information for.
{
'endpoint': {
'address': 'string',
'endpointArn': 'string',
'endpointCreateTime': datetime(2015, 1, 1),
'endpointName': 'string',
'endpointStatus': 'string',
'port': 123,
'subnetIds': [
'string',
],
'vpcEndpoint': {
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
'vpcSecurityGroups': [
{
'status': 'string',
'vpcSecurityGroupId': 'string'
},
],
'workgroupName': 'string'
}
}
Response Structure
The returned VPC endpoint.
The DNS address of the endpoint.
The Amazon Resource Name (ARN) of the VPC endpoint.
The time that the endpoint was created.
The name of the VPC endpoint.
The status of the VPC endpoint.
The port number on which Amazon Redshift Serverless accepts incoming connections.
The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
The connection endpoint for connecting to Amazon Redshift Serverless.
One or more network interfaces of the endpoint. Also known as an interface endpoint.
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
The availability Zone.
The unique identifier of the network interface.
The IPv4 address of the network interface within the subnet.
The unique identifier of the subnet.
The connection endpoint ID for connecting to Amazon Redshift Serverless.
The VPC identifier that the endpoint is associated with.
The security groups associated with the endpoint.
Describes the members of a VPC security group.
The status of the VPC security group.
The unique identifier of the VPC security group.
The name of the workgroup associated with the endpoint.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionget_namespace(**kwargs)¶Returns information about a namespace in Amazon Redshift Serverless.
See also: AWS API Documentation
Request Syntax
response = client.get_namespace(
namespaceName='string'
)
[REQUIRED]
The name of the namespace to retrieve information for.
{
'namespace': {
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
}
}
Response Structure
The returned namespace object.
The username of the administrator for the first database created in the namespace.
The date of when the namespace was created.
The name of the first database created in the namespace.
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
A list of IAM roles to associate with the namespace.
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
The Amazon Resource Name (ARN) associated with a namespace.
The unique identifier of a namespace.
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.
The status of the namespace.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ValidationExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_recovery_point(**kwargs)¶Returns information about a recovery point.
See also: AWS API Documentation
Request Syntax
response = client.get_recovery_point(
recoveryPointId='string'
)
[REQUIRED]
The unique identifier of the recovery point to return information for.
{
'recoveryPoint': {
'namespaceArn': 'string',
'namespaceName': 'string',
'recoveryPointCreateTime': datetime(2015, 1, 1),
'recoveryPointId': 'string',
'totalSizeInMegaBytes': 123.0,
'workgroupName': 'string'
}
}
Response Structure
The returned recovery point object.
The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.
The name of the namespace the recovery point is associated with.
The time the recovery point is created.
The unique identifier of the recovery point.
The total size of the data in the recovery point in megabytes.
The name of the workgroup the recovery point is associated with.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionget_resource_policy(**kwargs)¶Returns a resource policy.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_policy(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to return.
{
'resourcePolicy': {
'policy': 'string',
'resourceArn': 'string'
}
}
Response Structure
The returned resource policy.
The resource policy.
The Amazon Resource Name (ARN) of the policy.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ValidationExceptionget_snapshot(**kwargs)¶Returns information about a specific snapshot.
See also: AWS API Documentation
Request Syntax
response = client.get_snapshot(
ownerAccount='string',
snapshotArn='string',
snapshotName='string'
)
dict
Response Syntax
{
'snapshot': {
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminUsername': 'string',
'backupProgressInMegaBytes': 123.0,
'currentBackupRateInMegaBytesPerSecond': 123.0,
'elapsedTimeInSeconds': 123,
'estimatedSecondsToCompletion': 123,
'kmsKeyId': 'string',
'namespaceArn': 'string',
'namespaceName': 'string',
'ownerAccount': 'string',
'snapshotArn': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'snapshotRemainingDays': 123,
'snapshotRetentionPeriod': 123,
'snapshotRetentionStartTime': datetime(2015, 1, 1),
'status': 'AVAILABLE'|'CREATING'|'DELETED'|'CANCELLED'|'FAILED'|'COPYING',
'totalBackupSizeInMegaBytes': 123.0
}
}
Response Structure
(dict) --
snapshot (dict) --
The returned snapshot object.
accountsWithProvisionedRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
accountsWithRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
actualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup in megabytes.
adminUsername (string) --
The username of the database within a snapshot.
backupProgressInMegaBytes (float) --
The size in megabytes of the data that has been backed up to a snapshot.
currentBackupRateInMegaBytesPerSecond (float) --
The rate at which data is backed up into a snapshot in megabytes per second.
elapsedTimeInSeconds (integer) --
The amount of time it took to back up data into a snapshot.
estimatedSecondsToCompletion (integer) --
The estimated amount of seconds until the snapshot completes backup.
kmsKeyId (string) --
The unique identifier of the KMS key used to encrypt the snapshot.
namespaceArn (string) --
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
namespaceName (string) --
The name of the namepsace.
ownerAccount (string) --
The owner Amazon Web Services; account of the snapshot.
snapshotArn (string) --
The Amazon Resource Name (ARN) of the snapshot.
snapshotCreateTime (datetime) --
The timestamp of when the snapshot was created.
snapshotName (string) --
The name of the snapshot.
snapshotRemainingDays (integer) --
The amount of days until the snapshot is deleted.
snapshotRetentionPeriod (integer) --
The period of time, in days, of how long the snapshot is retained.
snapshotRetentionStartTime (datetime) --
The timestamp of when data within the snapshot started getting retained.
status (string) --
The status of the snapshot.
totalBackupSizeInMegaBytes (float) --
The total size, in megabytes, of how big the snapshot is.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ValidationExceptionget_table_restore_status(**kwargs)¶Returns information about a TableRestoreStatus object.
See also: AWS API Documentation
Request Syntax
response = client.get_table_restore_status(
tableRestoreRequestId='string'
)
[REQUIRED]
The ID of the RestoreTableFromSnapshot request to return status for.
{
'tableRestoreStatus': {
'message': 'string',
'namespaceName': 'string',
'newTableName': 'string',
'progressInMegaBytes': 123,
'requestTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'sourceDatabaseName': 'string',
'sourceSchemaName': 'string',
'sourceTableName': 'string',
'status': 'string',
'tableRestoreRequestId': 'string',
'targetDatabaseName': 'string',
'targetSchemaName': 'string',
'totalDataInMegaBytes': 123,
'workgroupName': 'string'
}
}
Response Structure
The returned TableRestoreStatus object that contains information about the status of your RestoreTableFromSnapshot request.
A description of the status of the table restore request. Status values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
The namespace of the table being restored from.
The name of the table to create from the restore operation.
The amount of data restored to the new table so far, in megabytes (MB).
The time that the table restore request was made, in Universal Coordinated Time (UTC).
The name of the snapshot being restored from.
The name of the source database being restored from.
The name of the source schema being restored from.
The name of the source table being restored from.
A value that describes the current state of the table restore request. Possible values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
The ID of the RestoreTableFromSnapshot request.
The name of the database to restore to.
The name of the schema to restore to.
The total amount of data to restore to the new table, in megabytes (MB).
The name of the workgroup being restored from.
Exceptions
RedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ValidationExceptionget_usage_limit(**kwargs)¶Returns information about a usage limit.
See also: AWS API Documentation
Request Syntax
response = client.get_usage_limit(
usageLimitId='string'
)
[REQUIRED]
The unique identifier of the usage limit to return information for.
{
'usageLimit': {
'amount': 123,
'breachAction': 'log'|'emit-metric'|'deactivate',
'period': 'daily'|'weekly'|'monthly',
'resourceArn': 'string',
'usageLimitArn': 'string',
'usageLimitId': 'string',
'usageType': 'serverless-compute'|'cross-region-datasharing'
}
}
Response Structure
The returned usage limit object.
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.
The action that Amazon Redshift Serverless takes when the limit is reached.
The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
The Amazon Resource Name (ARN) of the resource associated with the usage limit.
The identifier of the usage limit.
The Amazon Redshift Serverless feature to limit.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
get_workgroup(**kwargs)¶Returns information about a specific workgroup.
See also: AWS API Documentation
Request Syntax
response = client.get_workgroup(
workgroupName='string'
)
[REQUIRED]
The name of the workgroup to return information for.
{
'workgroup': {
'baseCapacity': 123,
'configParameters': [
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
'creationDate': datetime(2015, 1, 1),
'endpoint': {
'address': 'string',
'port': 123,
'vpcEndpoints': [
{
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'namespaceName': 'string',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'string',
],
'workgroupArn': 'string',
'workgroupId': 'string',
'workgroupName': 'string'
}
}
Response Structure
The returned workgroup object.
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
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 .
An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.
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.
The creation date of the workgroup.
The endpoint that is created from the workgroup.
The DNS address of the VPC endpoint.
The port that Amazon Redshift Serverless listens on.
An array of VpcEndpoint objects.
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
One or more network interfaces of the endpoint. Also known as an interface endpoint.
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
The availability Zone.
The unique identifier of the network interface.
The IPv4 address of the network interface within the subnet.
The unique identifier of the subnet.
The connection endpoint ID for connecting to Amazon Redshift Serverless.
The VPC identifier that the endpoint is associated with.
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
The namespace the workgroup is associated with.
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
A value that specifies whether the workgroup can be accessible from a public network
An array of security group IDs to associate with the workgroup.
The status of the workgroup.
An array of subnet IDs the workgroup is associated with.
The Amazon Resource Name (ARN) that links to the workgroup.
The unique identifier of the workgroup.
The name of the workgroup.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ValidationExceptionlist_endpoint_access(**kwargs)¶Returns an array of EndpointAccess objects and relevant information.
See also: AWS API Documentation
Request Syntax
response = client.list_endpoint_access(
maxResults=123,
nextToken='string',
vpcId='string',
workgroupName='string'
)
nextToken to display the next page of results.ListEndpointAccess operation returns a nextToken , you can include the returned nextToken in following ListEndpointAccess operations, which returns results in the next page.dict
Response Syntax
{
'endpoints': [
{
'address': 'string',
'endpointArn': 'string',
'endpointCreateTime': datetime(2015, 1, 1),
'endpointName': 'string',
'endpointStatus': 'string',
'port': 123,
'subnetIds': [
'string',
],
'vpcEndpoint': {
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
'vpcSecurityGroups': [
{
'status': 'string',
'vpcSecurityGroupId': 'string'
},
],
'workgroupName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
endpoints (list) --
The returned VPC endpoints.
(dict) --
Information about an Amazon Redshift Serverless VPC endpoint.
address (string) --
The DNS address of the endpoint.
endpointArn (string) --
The Amazon Resource Name (ARN) of the VPC endpoint.
endpointCreateTime (datetime) --
The time that the endpoint was created.
endpointName (string) --
The name of the VPC endpoint.
endpointStatus (string) --
The status of the VPC endpoint.
port (integer) --
The port number on which Amazon Redshift Serverless accepts incoming connections.
subnetIds (list) --
The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
vpcEndpoint (dict) --
The connection endpoint for connecting to Amazon Redshift Serverless.
networkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
availabilityZone (string) --
The availability Zone.
networkInterfaceId (string) --
The unique identifier of the network interface.
privateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
subnetId (string) --
The unique identifier of the subnet.
vpcEndpointId (string) --
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId (string) --
The VPC identifier that the endpoint is associated with.
vpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
status (string) --
The status of the VPC security group.
vpcSecurityGroupId (string) --
The unique identifier of the VPC security group.
workgroupName (string) --
The name of the workgroup associated with the endpoint.
nextToken (string) --
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.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionlist_namespaces(**kwargs)¶Returns information about a list of specified namespaces.
See also: AWS API Documentation
Request Syntax
response = client.list_namespaces(
maxResults=123,
nextToken='string'
)
nextToken to display the next page of results.ListNamespaces operation returns a nextToken , you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.dict
Response Syntax
{
'namespaces': [
{
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
namespaces (list) --
The list of returned namespaces.
(dict) --
A collection of database objects and users.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
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.
status (string) --
The status of the namespace.
nextToken (string) --
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.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ValidationExceptionlist_recovery_points(**kwargs)¶Returns an array of recovery points.
See also: AWS API Documentation
Request Syntax
response = client.list_recovery_points(
endTime=datetime(2015, 1, 1),
maxResults=123,
namespaceArn='string',
namespaceName='string',
nextToken='string',
startTime=datetime(2015, 1, 1)
)
nextToken to display the next page of results.ListRecoveryPoints operation returns a nextToken , you can include the returned nextToken in following ListRecoveryPoints operations, which returns results in the next page.dict
Response Syntax
{
'nextToken': 'string',
'recoveryPoints': [
{
'namespaceArn': 'string',
'namespaceName': 'string',
'recoveryPointCreateTime': datetime(2015, 1, 1),
'recoveryPointId': 'string',
'totalSizeInMegaBytes': 123.0,
'workgroupName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
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.
recoveryPoints (list) --
The returned recovery point objects.
(dict) --
The automatically created recovery point of a namespace. Recovery points are created every 30 minutes and kept for 24 hours.
namespaceArn (string) --
The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.
namespaceName (string) --
The name of the namespace the recovery point is associated with.
recoveryPointCreateTime (datetime) --
The time the recovery point is created.
recoveryPointId (string) --
The unique identifier of the recovery point.
totalSizeInMegaBytes (float) --
The total size of the data in the recovery point in megabytes.
workgroupName (string) --
The name of the workgroup the recovery point is associated with.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ValidationExceptionlist_snapshots(**kwargs)¶Returns a list of snapshots.
See also: AWS API Documentation
Request Syntax
response = client.list_snapshots(
endTime=datetime(2015, 1, 1),
maxResults=123,
namespaceArn='string',
namespaceName='string',
nextToken='string',
ownerAccount='string',
startTime=datetime(2015, 1, 1)
)
nextToken to display the next page of results.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.dict
Response Syntax
{
'nextToken': 'string',
'snapshots': [
{
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminUsername': 'string',
'backupProgressInMegaBytes': 123.0,
'currentBackupRateInMegaBytesPerSecond': 123.0,
'elapsedTimeInSeconds': 123,
'estimatedSecondsToCompletion': 123,
'kmsKeyId': 'string',
'namespaceArn': 'string',
'namespaceName': 'string',
'ownerAccount': 'string',
'snapshotArn': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'snapshotRemainingDays': 123,
'snapshotRetentionPeriod': 123,
'snapshotRetentionStartTime': datetime(2015, 1, 1),
'status': 'AVAILABLE'|'CREATING'|'DELETED'|'CANCELLED'|'FAILED'|'COPYING',
'totalBackupSizeInMegaBytes': 123.0
},
]
}
Response Structure
(dict) --
nextToken (string) --
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.
snapshots (list) --
All of the returned snapshot objects.
(dict) --
A snapshot object that contains databases.
accountsWithProvisionedRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
accountsWithRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
actualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup in megabytes.
adminUsername (string) --
The username of the database within a snapshot.
backupProgressInMegaBytes (float) --
The size in megabytes of the data that has been backed up to a snapshot.
currentBackupRateInMegaBytesPerSecond (float) --
The rate at which data is backed up into a snapshot in megabytes per second.
elapsedTimeInSeconds (integer) --
The amount of time it took to back up data into a snapshot.
estimatedSecondsToCompletion (integer) --
The estimated amount of seconds until the snapshot completes backup.
kmsKeyId (string) --
The unique identifier of the KMS key used to encrypt the snapshot.
namespaceArn (string) --
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
namespaceName (string) --
The name of the namepsace.
ownerAccount (string) --
The owner Amazon Web Services; account of the snapshot.
snapshotArn (string) --
The Amazon Resource Name (ARN) of the snapshot.
snapshotCreateTime (datetime) --
The timestamp of when the snapshot was created.
snapshotName (string) --
The name of the snapshot.
snapshotRemainingDays (integer) --
The amount of days until the snapshot is deleted.
snapshotRetentionPeriod (integer) --
The period of time, in days, of how long the snapshot is retained.
snapshotRetentionStartTime (datetime) --
The timestamp of when data within the snapshot started getting retained.
status (string) --
The status of the snapshot.
totalBackupSizeInMegaBytes (float) --
The total size, in megabytes, of how big the snapshot is.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ValidationExceptionlist_table_restore_status(**kwargs)¶Returns information about an array of TableRestoreStatus objects.
See also: AWS API Documentation
Request Syntax
response = client.list_table_restore_status(
maxResults=123,
namespaceName='string',
nextToken='string',
workgroupName='string'
)
RestoreTableFromSnapshot operations .ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will return results on the next page.RestoreTableFromSnapshot operations.dict
Response Syntax
{
'nextToken': 'string',
'tableRestoreStatuses': [
{
'message': 'string',
'namespaceName': 'string',
'newTableName': 'string',
'progressInMegaBytes': 123,
'requestTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'sourceDatabaseName': 'string',
'sourceSchemaName': 'string',
'sourceTableName': 'string',
'status': 'string',
'tableRestoreRequestId': 'string',
'targetDatabaseName': 'string',
'targetSchemaName': 'string',
'totalDataInMegaBytes': 123,
'workgroupName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
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.
tableRestoreStatuses (list) --
The array of returned TableRestoreStatus objects.
(dict) --
Contains information about a table restore request.
message (string) --
A description of the status of the table restore request. Status values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
namespaceName (string) --
The namespace of the table being restored from.
newTableName (string) --
The name of the table to create from the restore operation.
progressInMegaBytes (integer) --
The amount of data restored to the new table so far, in megabytes (MB).
requestTime (datetime) --
The time that the table restore request was made, in Universal Coordinated Time (UTC).
snapshotName (string) --
The name of the snapshot being restored from.
sourceDatabaseName (string) --
The name of the source database being restored from.
sourceSchemaName (string) --
The name of the source schema being restored from.
sourceTableName (string) --
The name of the source table being restored from.
status (string) --
A value that describes the current state of the table restore request. Possible values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
tableRestoreRequestId (string) --
The ID of the RestoreTableFromSnapshot request.
targetDatabaseName (string) --
The name of the database to restore to.
targetSchemaName (string) --
The name of the schema to restore to.
totalDataInMegaBytes (integer) --
The total amount of data to restore to the new table, in megabytes (MB).
workgroupName (string) --
The name of the workgroup being restored from.
Exceptions
RedshiftServerless.Client.exceptions.InvalidPaginationExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ValidationExceptionLists the tags assigned to a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to list tags for.
{
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
A map of the key-value pairs assigned to the resource.
A map of key-value pairs.
The key to use in the tag.
The value of the tag.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ValidationExceptionRedshiftServerless.Client.exceptions.ThrottlingExceptionlist_usage_limits(**kwargs)¶Lists all usage limits within Amazon Redshift Serverless.
See also: AWS API Documentation
Request Syntax
response = client.list_usage_limits(
maxResults=123,
nextToken='string',
resourceArn='string',
usageType='serverless-compute'|'cross-region-datasharing'
)
nextToken to get the next page of results. The default is 100.ListUsageLimits operation returns a nextToken , you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.dict
Response Syntax
{
'nextToken': 'string',
'usageLimits': [
{
'amount': 123,
'breachAction': 'log'|'emit-metric'|'deactivate',
'period': 'daily'|'weekly'|'monthly',
'resourceArn': 'string',
'usageLimitArn': 'string',
'usageLimitId': 'string',
'usageType': 'serverless-compute'|'cross-region-datasharing'
},
]
}
Response Structure
(dict) --
nextToken (string) --
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.
usageLimits (list) --
An array of returned usage limit objects.
(dict) --
The usage limit object.
amount (integer) --
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.
breachAction (string) --
The action that Amazon Redshift Serverless takes when the limit is reached.
period (string) --
The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
resourceArn (string) --
The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
usageLimitArn (string) --
The Amazon Resource Name (ARN) of the resource associated with the usage limit.
usageLimitId (string) --
The identifier of the usage limit.
usageType (string) --
The Amazon Redshift Serverless feature to limit.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.InvalidPaginationExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionlist_workgroups(**kwargs)¶Returns information about a list of specified workgroups.
See also: AWS API Documentation
Request Syntax
response = client.list_workgroups(
maxResults=123,
nextToken='string'
)
nextToken to display the next page of results.nextToken , you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.dict
Response Syntax
{
'nextToken': 'string',
'workgroups': [
{
'baseCapacity': 123,
'configParameters': [
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
'creationDate': datetime(2015, 1, 1),
'endpoint': {
'address': 'string',
'port': 123,
'vpcEndpoints': [
{
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'namespaceName': 'string',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'string',
],
'workgroupArn': 'string',
'workgroupId': 'string',
'workgroupName': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
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.
workgroups (list) --
The returned array of workgroups.
(dict) --
The collection of computing resources from which an endpoint is created.
baseCapacity (integer) --
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
configParameters (list) --
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 .
(dict) --
An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.
parameterKey (string) --
The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
parameterValue (string) --
The value of the parameter to set.
creationDate (datetime) --
The creation date of the workgroup.
endpoint (dict) --
The endpoint that is created from the workgroup.
address (string) --
The DNS address of the VPC endpoint.
port (integer) --
The port that Amazon Redshift Serverless listens on.
vpcEndpoints (list) --
An array of VpcEndpoint objects.
(dict) --
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
networkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
availabilityZone (string) --
The availability Zone.
networkInterfaceId (string) --
The unique identifier of the network interface.
privateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
subnetId (string) --
The unique identifier of the subnet.
vpcEndpointId (string) --
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId (string) --
The VPC identifier that the endpoint is associated with.
enhancedVpcRouting (boolean) --
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
namespaceName (string) --
The namespace the workgroup is associated with.
port (integer) --
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
publiclyAccessible (boolean) --
A value that specifies whether the workgroup can be accessible from a public network
securityGroupIds (list) --
An array of security group IDs to associate with the workgroup.
status (string) --
The status of the workgroup.
subnetIds (list) --
An array of subnet IDs the workgroup is associated with.
workgroupArn (string) --
The Amazon Resource Name (ARN) that links to the workgroup.
workgroupId (string) --
The unique identifier of the workgroup.
workgroupName (string) --
The name of the workgroup.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ValidationExceptionput_resource_policy(**kwargs)¶Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
See also: AWS API Documentation
Request Syntax
response = client.put_resource_policy(
policy='string',
resourceArn='string'
)
[REQUIRED]
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\" }]}"
[REQUIRED]
The Amazon Resource Name (ARN) of the account to create or update a resource policy for.
dict
Response Syntax
{
'resourcePolicy': {
'policy': 'string',
'resourceArn': 'string'
}
}
Response Structure
(dict) --
resourcePolicy (dict) --
The policy that was created or updated.
policy (string) --
The resource policy.
resourceArn (string) --
The Amazon Resource Name (ARN) of the policy.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionRedshiftServerless.Client.exceptions.ServiceQuotaExceededExceptionrestore_from_recovery_point(**kwargs)¶Restore the data from a recovery point.
See also: AWS API Documentation
Request Syntax
response = client.restore_from_recovery_point(
namespaceName='string',
recoveryPointId='string',
workgroupName='string'
)
[REQUIRED]
The name of the namespace to restore data into.
[REQUIRED]
The unique identifier of the recovery point to restore from.
[REQUIRED]
The name of the workgroup used to restore data.
dict
Response Syntax
{
'namespace': {
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
},
'recoveryPointId': 'string'
}
Response Structure
(dict) --
namespace (dict) --
The namespace that data was restored into.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
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.
status (string) --
The status of the namespace.
recoveryPointId (string) --
The unique identifier of the recovery point used for the restore.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionrestore_from_snapshot(**kwargs)¶Restores a namespace from a snapshot.
See also: AWS API Documentation
Request Syntax
response = client.restore_from_snapshot(
namespaceName='string',
ownerAccount='string',
snapshotArn='string',
snapshotName='string',
workgroupName='string'
)
[REQUIRED]
The name of the namespace to restore the snapshot to.
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>.
snapshotArn .[REQUIRED]
The name of the workgroup used to restore the snapshot.
dict
Response Syntax
{
'namespace': {
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
},
'ownerAccount': 'string',
'snapshotName': 'string'
}
Response Structure
(dict) --
namespace (dict) --
A collection of database objects and users.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
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.
status (string) --
The status of the namespace.
ownerAccount (string) --
The owner Amazon Web Services; account of the snapshot that was restored.
snapshotName (string) --
The name of the snapshot used to restore the namespace.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionRedshiftServerless.Client.exceptions.ServiceQuotaExceededExceptionrestore_table_from_snapshot(**kwargs)¶Restores a table from a snapshot to your Amazon Redshift Serverless instance.
See also: AWS API Documentation
Request Syntax
response = client.restore_table_from_snapshot(
activateCaseSensitiveIdentifier=True|False,
namespaceName='string',
newTableName='string',
snapshotName='string',
sourceDatabaseName='string',
sourceSchemaName='string',
sourceTableName='string',
targetDatabaseName='string',
targetSchemaName='string',
workgroupName='string'
)
[REQUIRED]
The namespace of the snapshot to restore from.
[REQUIRED]
The name of the table to create from the restore operation.
[REQUIRED]
The name of the snapshot to restore the table from.
[REQUIRED]
The name of the source database that contains the table being restored.
[REQUIRED]
The name of the source table being restored.
[REQUIRED]
The workgroup to restore the table to.
dict
Response Syntax
{
'tableRestoreStatus': {
'message': 'string',
'namespaceName': 'string',
'newTableName': 'string',
'progressInMegaBytes': 123,
'requestTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'sourceDatabaseName': 'string',
'sourceSchemaName': 'string',
'sourceTableName': 'string',
'status': 'string',
'tableRestoreRequestId': 'string',
'targetDatabaseName': 'string',
'targetSchemaName': 'string',
'totalDataInMegaBytes': 123,
'workgroupName': 'string'
}
}
Response Structure
(dict) --
tableRestoreStatus (dict) --
The TableRestoreStatus object that contains the status of the restore operation.
message (string) --
A description of the status of the table restore request. Status values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
namespaceName (string) --
The namespace of the table being restored from.
newTableName (string) --
The name of the table to create from the restore operation.
progressInMegaBytes (integer) --
The amount of data restored to the new table so far, in megabytes (MB).
requestTime (datetime) --
The time that the table restore request was made, in Universal Coordinated Time (UTC).
snapshotName (string) --
The name of the snapshot being restored from.
sourceDatabaseName (string) --
The name of the source database being restored from.
sourceSchemaName (string) --
The name of the source schema being restored from.
sourceTableName (string) --
The name of the source table being restored from.
status (string) --
A value that describes the current state of the table restore request. Possible values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
tableRestoreRequestId (string) --
The ID of the RestoreTableFromSnapshot request.
targetDatabaseName (string) --
The name of the database to restore to.
targetSchemaName (string) --
The name of the schema to restore to.
totalDataInMegaBytes (integer) --
The total amount of data to restore to the new table, in megabytes (MB).
workgroupName (string) --
The name of the workgroup being restored from.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptiontag_resource(**kwargs)¶Assigns one or more tags to a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to tag.
[REQUIRED]
The map of the key-value pairs used to tag the resource.
A map of key-value pairs.
The key to use in the tag.
The value of the tag.
dict
Response Syntax
{}
Response Structure
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ValidationExceptionRedshiftServerless.Client.exceptions.TooManyTagsExceptionRedshiftServerless.Client.exceptions.ThrottlingExceptionuntag_resource(**kwargs)¶Removes a tag or set of tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to remove tags from.
[REQUIRED]
The tag or set of tags to remove from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ValidationExceptionRedshiftServerless.Client.exceptions.ThrottlingExceptionupdate_endpoint_access(**kwargs)¶Updates an Amazon Redshift Serverless managed endpoint.
See also: AWS API Documentation
Request Syntax
response = client.update_endpoint_access(
endpointName='string',
vpcSecurityGroupIds=[
'string',
]
)
[REQUIRED]
The name of the VPC endpoint to update.
The list of VPC security groups associated with the endpoint after the endpoint is modified.
dict
Response Syntax
{
'endpoint': {
'address': 'string',
'endpointArn': 'string',
'endpointCreateTime': datetime(2015, 1, 1),
'endpointName': 'string',
'endpointStatus': 'string',
'port': 123,
'subnetIds': [
'string',
],
'vpcEndpoint': {
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
'vpcSecurityGroups': [
{
'status': 'string',
'vpcSecurityGroupId': 'string'
},
],
'workgroupName': 'string'
}
}
Response Structure
(dict) --
endpoint (dict) --
The updated VPC endpoint.
address (string) --
The DNS address of the endpoint.
endpointArn (string) --
The Amazon Resource Name (ARN) of the VPC endpoint.
endpointCreateTime (datetime) --
The time that the endpoint was created.
endpointName (string) --
The name of the VPC endpoint.
endpointStatus (string) --
The status of the VPC endpoint.
port (integer) --
The port number on which Amazon Redshift Serverless accepts incoming connections.
subnetIds (list) --
The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
vpcEndpoint (dict) --
The connection endpoint for connecting to Amazon Redshift Serverless.
networkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
availabilityZone (string) --
The availability Zone.
networkInterfaceId (string) --
The unique identifier of the network interface.
privateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
subnetId (string) --
The unique identifier of the subnet.
vpcEndpointId (string) --
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId (string) --
The VPC identifier that the endpoint is associated with.
vpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
status (string) --
The status of the VPC security group.
vpcSecurityGroupId (string) --
The unique identifier of the VPC security group.
workgroupName (string) --
The name of the workgroup associated with the endpoint.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionRedshiftServerless.Client.exceptions.AccessDeniedExceptionupdate_namespace(**kwargs)¶Updates a namespace with the specified settings.
See also: AWS API Documentation
Request Syntax
response = client.update_namespace(
adminUserPassword='string',
adminUsername='string',
defaultIamRoleArn='string',
iamRoles=[
'string',
],
kmsKeyId='string',
logExports=[
'useractivitylog'|'userlog'|'connectionlog',
],
namespaceName='string'
)
A list of IAM roles to associate with the namespace.
The types of logs the namespace can export. The export types are userlog , connectionlog , and useractivitylog .
[REQUIRED]
The name of the namespace.
dict
Response Syntax
{
'namespace': {
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
}
}
Response Structure
(dict) --
namespace (dict) --
A list of tag instances.
adminUsername (string) --
The username of the administrator for the first database created in the namespace.
creationDate (datetime) --
The date of when the namespace was created.
dbName (string) --
The name of the first database created in the namespace.
defaultIamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
iamRoles (list) --
A list of IAM roles to associate with the namespace.
kmsKeyId (string) --
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
logExports (list) --
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
namespaceArn (string) --
The Amazon Resource Name (ARN) associated with a namespace.
namespaceId (string) --
The unique identifier of a namespace.
namespaceName (string) --
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.
status (string) --
The status of the namespace.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionupdate_snapshot(**kwargs)¶Updates a snapshot.
See also: AWS API Documentation
Request Syntax
response = client.update_snapshot(
retentionPeriod=123,
snapshotName='string'
)
[REQUIRED]
The name of the snapshot.
dict
Response Syntax
{
'snapshot': {
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminUsername': 'string',
'backupProgressInMegaBytes': 123.0,
'currentBackupRateInMegaBytesPerSecond': 123.0,
'elapsedTimeInSeconds': 123,
'estimatedSecondsToCompletion': 123,
'kmsKeyId': 'string',
'namespaceArn': 'string',
'namespaceName': 'string',
'ownerAccount': 'string',
'snapshotArn': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'snapshotRemainingDays': 123,
'snapshotRetentionPeriod': 123,
'snapshotRetentionStartTime': datetime(2015, 1, 1),
'status': 'AVAILABLE'|'CREATING'|'DELETED'|'CANCELLED'|'FAILED'|'COPYING',
'totalBackupSizeInMegaBytes': 123.0
}
}
Response Structure
(dict) --
snapshot (dict) --
The updated snapshot object.
accountsWithProvisionedRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
accountsWithRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
actualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup in megabytes.
adminUsername (string) --
The username of the database within a snapshot.
backupProgressInMegaBytes (float) --
The size in megabytes of the data that has been backed up to a snapshot.
currentBackupRateInMegaBytesPerSecond (float) --
The rate at which data is backed up into a snapshot in megabytes per second.
elapsedTimeInSeconds (integer) --
The amount of time it took to back up data into a snapshot.
estimatedSecondsToCompletion (integer) --
The estimated amount of seconds until the snapshot completes backup.
kmsKeyId (string) --
The unique identifier of the KMS key used to encrypt the snapshot.
namespaceArn (string) --
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
namespaceName (string) --
The name of the namepsace.
ownerAccount (string) --
The owner Amazon Web Services; account of the snapshot.
snapshotArn (string) --
The Amazon Resource Name (ARN) of the snapshot.
snapshotCreateTime (datetime) --
The timestamp of when the snapshot was created.
snapshotName (string) --
The name of the snapshot.
snapshotRemainingDays (integer) --
The amount of days until the snapshot is deleted.
snapshotRetentionPeriod (integer) --
The period of time, in days, of how long the snapshot is retained.
snapshotRetentionStartTime (datetime) --
The timestamp of when data within the snapshot started getting retained.
status (string) --
The status of the snapshot.
totalBackupSizeInMegaBytes (float) --
The total size, in megabytes, of how big the snapshot is.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionupdate_usage_limit(**kwargs)¶Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.
See also: AWS API Documentation
Request Syntax
response = client.update_usage_limit(
amount=123,
breachAction='log'|'emit-metric'|'deactivate',
usageLimitId='string'
)
[REQUIRED]
The identifier of the usage limit to update.
dict
Response Syntax
{
'usageLimit': {
'amount': 123,
'breachAction': 'log'|'emit-metric'|'deactivate',
'period': 'daily'|'weekly'|'monthly',
'resourceArn': 'string',
'usageLimitArn': 'string',
'usageLimitId': 'string',
'usageType': 'serverless-compute'|'cross-region-datasharing'
}
}
Response Structure
(dict) --
usageLimit (dict) --
The updated usage limit object.
amount (integer) --
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.
breachAction (string) --
The action that Amazon Redshift Serverless takes when the limit is reached.
period (string) --
The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
resourceArn (string) --
The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
usageLimitArn (string) --
The Amazon Resource Name (ARN) of the resource associated with the usage limit.
usageLimitId (string) --
The identifier of the usage limit.
usageType (string) --
The Amazon Redshift Serverless feature to limit.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionupdate_workgroup(**kwargs)¶Updates a workgroup with the specified configuration settings.
See also: AWS API Documentation
Request Syntax
response = client.update_workgroup(
baseCapacity=123,
configParameters=[
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
enhancedVpcRouting=True|False,
port=123,
publiclyAccessible=True|False,
securityGroupIds=[
'string',
],
subnetIds=[
'string',
],
workgroupName='string'
)
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 key-value pairs to set for advanced control over Amazon Redshift Serverless.
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.
An array of security group IDs to associate with the workgroup.
An array of VPC subnet IDs to associate with the workgroup.
[REQUIRED]
The name of the workgroup to update.
dict
Response Syntax
{
'workgroup': {
'baseCapacity': 123,
'configParameters': [
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
'creationDate': datetime(2015, 1, 1),
'endpoint': {
'address': 'string',
'port': 123,
'vpcEndpoints': [
{
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'namespaceName': 'string',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'string',
],
'workgroupArn': 'string',
'workgroupId': 'string',
'workgroupName': 'string'
}
}
Response Structure
(dict) --
workgroup (dict) --
The updated workgroup object.
baseCapacity (integer) --
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
configParameters (list) --
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 .
(dict) --
An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.
parameterKey (string) --
The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .
parameterValue (string) --
The value of the parameter to set.
creationDate (datetime) --
The creation date of the workgroup.
endpoint (dict) --
The endpoint that is created from the workgroup.
address (string) --
The DNS address of the VPC endpoint.
port (integer) --
The port that Amazon Redshift Serverless listens on.
vpcEndpoints (list) --
An array of VpcEndpoint objects.
(dict) --
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
networkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
availabilityZone (string) --
The availability Zone.
networkInterfaceId (string) --
The unique identifier of the network interface.
privateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
subnetId (string) --
The unique identifier of the subnet.
vpcEndpointId (string) --
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId (string) --
The VPC identifier that the endpoint is associated with.
enhancedVpcRouting (boolean) --
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
namespaceName (string) --
The namespace the workgroup is associated with.
port (integer) --
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
publiclyAccessible (boolean) --
A value that specifies whether the workgroup can be accessible from a public network
securityGroupIds (list) --
An array of security group IDs to associate with the workgroup.
status (string) --
The status of the workgroup.
subnetIds (list) --
An array of subnet IDs the workgroup is associated with.
workgroupArn (string) --
The Amazon Resource Name (ARN) that links to the workgroup.
workgroupId (string) --
The unique identifier of the workgroup.
workgroupName (string) --
The name of the workgroup.
Exceptions
RedshiftServerless.Client.exceptions.InternalServerExceptionRedshiftServerless.Client.exceptions.InsufficientCapacityExceptionRedshiftServerless.Client.exceptions.ResourceNotFoundExceptionRedshiftServerless.Client.exceptions.ConflictExceptionRedshiftServerless.Client.exceptions.ValidationExceptionThe available paginators are:
RedshiftServerless.Paginator.ListEndpointAccessRedshiftServerless.Paginator.ListNamespacesRedshiftServerless.Paginator.ListRecoveryPointsRedshiftServerless.Paginator.ListSnapshotsRedshiftServerless.Paginator.ListTableRestoreStatusRedshiftServerless.Paginator.ListUsageLimitsRedshiftServerless.Paginator.ListWorkgroupsRedshiftServerless.Paginator.ListEndpointAccess¶paginator = client.get_paginator('list_endpoint_access')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_endpoint_access().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
vpcId='string',
workgroupName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'endpoints': [
{
'address': 'string',
'endpointArn': 'string',
'endpointCreateTime': datetime(2015, 1, 1),
'endpointName': 'string',
'endpointStatus': 'string',
'port': 123,
'subnetIds': [
'string',
],
'vpcEndpoint': {
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
'vpcSecurityGroups': [
{
'status': 'string',
'vpcSecurityGroupId': 'string'
},
],
'workgroupName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
endpoints (list) --
The returned VPC endpoints.
(dict) --
Information about an Amazon Redshift Serverless VPC endpoint.
address (string) --
The DNS address of the endpoint.
endpointArn (string) --
The Amazon Resource Name (ARN) of the VPC endpoint.
endpointCreateTime (datetime) --
The time that the endpoint was created.
endpointName (string) --
The name of the VPC endpoint.
endpointStatus (string) --
The status of the VPC endpoint.
port (integer) --
The port number on which Amazon Redshift Serverless accepts incoming connections.
subnetIds (list) --
The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
vpcEndpoint (dict) --
The connection endpoint for connecting to Amazon Redshift Serverless.
networkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
availabilityZone (string) --
The availability Zone.
networkInterfaceId (string) --
The unique identifier of the network interface.
privateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
subnetId (string) --
The unique identifier of the subnet.
vpcEndpointId (string) --
The connection endpoint ID for connecting to Amazon Redshift Serverless.
vpcId (string) --
The VPC identifier that the endpoint is associated with.
vpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
status (string) --
The status of the VPC security group.
vpcSecurityGroupId (string) --
The unique identifier of the VPC security group.
workgroupName (string) --
The name of the workgroup associated with the endpoint.
NextToken (string) --
A token to resume pagination.
RedshiftServerless.Paginator.ListNamespaces¶paginator = client.get_paginator('list_namespaces')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_namespaces().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'namespaces': [
{
'adminUsername': 'string',
'creationDate': datetime(2015, 1, 1),
'dbName': 'string',
'defaultIamRoleArn': 'string',
'iamRoles': [
'string',
],
'kmsKeyId': 'string',
'logExports': [
'useractivitylog'|'userlog'|'connectionlog',
],
'namespaceArn': 'string',
'namespaceId': 'string',
'namespaceName': 'string',
'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
},
],
'NextToken': 'string'
}
Response Structure
The list of returned namespaces.
A collection of database objects and users.
The username of the administrator for the first database created in the namespace.
The date of when the namespace was created.
The name of the first database created in the namespace.
The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
A list of IAM roles to associate with the namespace.
The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
The Amazon Resource Name (ARN) associated with a namespace.
The unique identifier of a namespace.
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.
The status of the namespace.
A token to resume pagination.
RedshiftServerless.Paginator.ListRecoveryPoints¶paginator = client.get_paginator('list_recovery_points')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_recovery_points().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
endTime=datetime(2015, 1, 1),
namespaceArn='string',
namespaceName='string',
startTime=datetime(2015, 1, 1),
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'recoveryPoints': [
{
'namespaceArn': 'string',
'namespaceName': 'string',
'recoveryPointCreateTime': datetime(2015, 1, 1),
'recoveryPointId': 'string',
'totalSizeInMegaBytes': 123.0,
'workgroupName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
recoveryPoints (list) --
The returned recovery point objects.
(dict) --
The automatically created recovery point of a namespace. Recovery points are created every 30 minutes and kept for 24 hours.
namespaceArn (string) --
The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.
namespaceName (string) --
The name of the namespace the recovery point is associated with.
recoveryPointCreateTime (datetime) --
The time the recovery point is created.
recoveryPointId (string) --
The unique identifier of the recovery point.
totalSizeInMegaBytes (float) --
The total size of the data in the recovery point in megabytes.
workgroupName (string) --
The name of the workgroup the recovery point is associated with.
NextToken (string) --
A token to resume pagination.
RedshiftServerless.Paginator.ListSnapshots¶paginator = client.get_paginator('list_snapshots')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_snapshots().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
endTime=datetime(2015, 1, 1),
namespaceArn='string',
namespaceName='string',
ownerAccount='string',
startTime=datetime(2015, 1, 1),
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'snapshots': [
{
'accountsWithProvisionedRestoreAccess': [
'string',
],
'accountsWithRestoreAccess': [
'string',
],
'actualIncrementalBackupSizeInMegaBytes': 123.0,
'adminUsername': 'string',
'backupProgressInMegaBytes': 123.0,
'currentBackupRateInMegaBytesPerSecond': 123.0,
'elapsedTimeInSeconds': 123,
'estimatedSecondsToCompletion': 123,
'kmsKeyId': 'string',
'namespaceArn': 'string',
'namespaceName': 'string',
'ownerAccount': 'string',
'snapshotArn': 'string',
'snapshotCreateTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'snapshotRemainingDays': 123,
'snapshotRetentionPeriod': 123,
'snapshotRetentionStartTime': datetime(2015, 1, 1),
'status': 'AVAILABLE'|'CREATING'|'DELETED'|'CANCELLED'|'FAILED'|'COPYING',
'totalBackupSizeInMegaBytes': 123.0
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
snapshots (list) --
All of the returned snapshot objects.
(dict) --
A snapshot object that contains databases.
accountsWithProvisionedRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
accountsWithRestoreAccess (list) --
All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
actualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup in megabytes.
adminUsername (string) --
The username of the database within a snapshot.
backupProgressInMegaBytes (float) --
The size in megabytes of the data that has been backed up to a snapshot.
currentBackupRateInMegaBytesPerSecond (float) --
The rate at which data is backed up into a snapshot in megabytes per second.
elapsedTimeInSeconds (integer) --
The amount of time it took to back up data into a snapshot.
estimatedSecondsToCompletion (integer) --
The estimated amount of seconds until the snapshot completes backup.
kmsKeyId (string) --
The unique identifier of the KMS key used to encrypt the snapshot.
namespaceArn (string) --
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
namespaceName (string) --
The name of the namepsace.
ownerAccount (string) --
The owner Amazon Web Services; account of the snapshot.
snapshotArn (string) --
The Amazon Resource Name (ARN) of the snapshot.
snapshotCreateTime (datetime) --
The timestamp of when the snapshot was created.
snapshotName (string) --
The name of the snapshot.
snapshotRemainingDays (integer) --
The amount of days until the snapshot is deleted.
snapshotRetentionPeriod (integer) --
The period of time, in days, of how long the snapshot is retained.
snapshotRetentionStartTime (datetime) --
The timestamp of when data within the snapshot started getting retained.
status (string) --
The status of the snapshot.
totalBackupSizeInMegaBytes (float) --
The total size, in megabytes, of how big the snapshot is.
NextToken (string) --
A token to resume pagination.
RedshiftServerless.Paginator.ListTableRestoreStatus¶paginator = client.get_paginator('list_table_restore_status')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_table_restore_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
namespaceName='string',
workgroupName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
RestoreTableFromSnapshot operations .RestoreTableFromSnapshot operations.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'tableRestoreStatuses': [
{
'message': 'string',
'namespaceName': 'string',
'newTableName': 'string',
'progressInMegaBytes': 123,
'requestTime': datetime(2015, 1, 1),
'snapshotName': 'string',
'sourceDatabaseName': 'string',
'sourceSchemaName': 'string',
'sourceTableName': 'string',
'status': 'string',
'tableRestoreRequestId': 'string',
'targetDatabaseName': 'string',
'targetSchemaName': 'string',
'totalDataInMegaBytes': 123,
'workgroupName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
tableRestoreStatuses (list) --
The array of returned TableRestoreStatus objects.
(dict) --
Contains information about a table restore request.
message (string) --
A description of the status of the table restore request. Status values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
namespaceName (string) --
The namespace of the table being restored from.
newTableName (string) --
The name of the table to create from the restore operation.
progressInMegaBytes (integer) --
The amount of data restored to the new table so far, in megabytes (MB).
requestTime (datetime) --
The time that the table restore request was made, in Universal Coordinated Time (UTC).
snapshotName (string) --
The name of the snapshot being restored from.
sourceDatabaseName (string) --
The name of the source database being restored from.
sourceSchemaName (string) --
The name of the source schema being restored from.
sourceTableName (string) --
The name of the source table being restored from.
status (string) --
A value that describes the current state of the table restore request. Possible values include SUCCEEDED , FAILED , CANCELED , PENDING , IN_PROGRESS .
tableRestoreRequestId (string) --
The ID of the RestoreTableFromSnapshot request.
targetDatabaseName (string) --
The name of the database to restore to.
targetSchemaName (string) --
The name of the schema to restore to.
totalDataInMegaBytes (integer) --
The total amount of data to restore to the new table, in megabytes (MB).
workgroupName (string) --
The name of the workgroup being restored from.
NextToken (string) --
A token to resume pagination.
RedshiftServerless.Paginator.ListUsageLimits¶paginator = client.get_paginator('list_usage_limits')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_usage_limits().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
resourceArn='string',
usageType='serverless-compute'|'cross-region-datasharing',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'usageLimits': [
{
'amount': 123,
'breachAction': 'log'|'emit-metric'|'deactivate',
'period': 'daily'|'weekly'|'monthly',
'resourceArn': 'string',
'usageLimitArn': 'string',
'usageLimitId': 'string',
'usageType': 'serverless-compute'|'cross-region-datasharing'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
usageLimits (list) --
An array of returned usage limit objects.
(dict) --
The usage limit object.
amount (integer) --
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.
breachAction (string) --
The action that Amazon Redshift Serverless takes when the limit is reached.
period (string) --
The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
resourceArn (string) --
The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
usageLimitArn (string) --
The Amazon Resource Name (ARN) of the resource associated with the usage limit.
usageLimitId (string) --
The identifier of the usage limit.
usageType (string) --
The Amazon Redshift Serverless feature to limit.
NextToken (string) --
A token to resume pagination.
RedshiftServerless.Paginator.ListWorkgroups¶paginator = client.get_paginator('list_workgroups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_workgroups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'workgroups': [
{
'baseCapacity': 123,
'configParameters': [
{
'parameterKey': 'string',
'parameterValue': 'string'
},
],
'creationDate': datetime(2015, 1, 1),
'endpoint': {
'address': 'string',
'port': 123,
'vpcEndpoints': [
{
'networkInterfaces': [
{
'availabilityZone': 'string',
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'subnetId': 'string'
},
],
'vpcEndpointId': 'string',
'vpcId': 'string'
},
]
},
'enhancedVpcRouting': True|False,
'namespaceName': 'string',
'port': 123,
'publiclyAccessible': True|False,
'securityGroupIds': [
'string',
],
'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
'subnetIds': [
'string',
],
'workgroupArn': 'string',
'workgroupId': 'string',
'workgroupName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
The returned array of workgroups.
The collection of computing resources from which an endpoint is created.
The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
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 .
An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.
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.
The creation date of the workgroup.
The endpoint that is created from the workgroup.
The DNS address of the VPC endpoint.
The port that Amazon Redshift Serverless listens on.
An array of VpcEndpoint objects.
The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.
One or more network interfaces of the endpoint. Also known as an interface endpoint.
Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.
The availability Zone.
The unique identifier of the network interface.
The IPv4 address of the network interface within the subnet.
The unique identifier of the subnet.
The connection endpoint ID for connecting to Amazon Redshift Serverless.
The VPC identifier that the endpoint is associated with.
The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
The namespace the workgroup is associated with.
The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
A value that specifies whether the workgroup can be accessible from a public network
An array of security group IDs to associate with the workgroup.
The status of the workgroup.
An array of subnet IDs the workgroup is associated with.
The Amazon Resource Name (ARN) that links to the workgroup.
The unique identifier of the workgroup.
The name of the workgroup.
A token to resume pagination.