RedshiftServerless ****************** Client ====== class 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_custom_domain_association * create_endpoint_access * create_namespace * create_reservation * create_scheduled_action * create_snapshot * create_snapshot_copy_configuration * create_usage_limit * create_workgroup * delete_custom_domain_association * delete_endpoint_access * delete_namespace * delete_resource_policy * delete_scheduled_action * delete_snapshot * delete_snapshot_copy_configuration * delete_usage_limit * delete_workgroup * get_credentials * get_custom_domain_association * get_endpoint_access * get_namespace * get_paginator * get_recovery_point * get_reservation * get_reservation_offering * get_resource_policy * get_scheduled_action * get_snapshot * get_table_restore_status * get_track * get_usage_limit * get_waiter * get_workgroup * list_custom_domain_associations * list_endpoint_access * list_managed_workgroups * list_namespaces * list_recovery_points * list_reservation_offerings * list_reservations * list_scheduled_actions * list_snapshot_copy_configurations * list_snapshots * list_table_restore_status * list_tags_for_resource * list_tracks * list_usage_limits * list_workgroups * put_resource_policy * restore_from_recovery_point * restore_from_snapshot * restore_table_from_recovery_point * restore_table_from_snapshot * tag_resource * untag_resource * update_custom_domain_association * update_endpoint_access * update_namespace * update_scheduled_action * update_snapshot * update_snapshot_copy_configuration * update_usage_limit * update_workgroup Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListCustomDomainAssociations * ListEndpointAccess * ListManagedWorkgroups * ListNamespaces * ListRecoveryPoints * ListReservationOfferings * ListReservations * ListScheduledActions * ListSnapshotCopyConfigurations * ListSnapshots * ListTableRestoreStatus * ListTracks * ListUsageLimits * ListWorkgroups RedshiftServerless / Paginator / ListNamespaces ListNamespaces ************** class 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' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'namespaces': [ { 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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. * *(string) --* * **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. * *(string) --* * **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) --* A token to resume pagination. RedshiftServerless / Paginator / ListRecoveryPoints ListRecoveryPoints ****************** class 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' } ) Parameters: * **endTime** (*datetime*) -- The time when creation of the recovery point finished. * **namespaceArn** (*string*) -- The Amazon Resource Name (ARN) of the namespace from which to list recovery points. * **namespaceName** (*string*) -- The name of the namespace to list recovery points for. * **startTime** (*datetime*) -- The time when the recovery point's creation was initiated. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 ListSnapshots ************* class 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' } ) Parameters: * **endTime** (*datetime*) -- The timestamp showing when the snapshot creation finished. * **namespaceArn** (*string*) -- The Amazon Resource Name (ARN) of the namespace from which to list all snapshots. * **namespaceName** (*string*) -- The namespace from which to list all snapshots. * **ownerAccount** (*string*) -- The owner Amazon Web Services account of the snapshot. * **startTime** (*datetime*) -- The time when the creation of the snapshot was initiated. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'snapshots': [ { 'accountsWithProvisionedRestoreAccess': [ 'string', ], 'accountsWithRestoreAccess': [ 'string', ], 'actualIncrementalBackupSizeInMegaBytes': 123.0, 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * *(string) --* * **accountsWithRestoreAccess** *(list) --* All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace. * *(string) --* * **actualIncrementalBackupSizeInMegaBytes** *(float) --* The size of the incremental backup in megabytes. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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 / ListManagedWorkgroups ListManagedWorkgroups ********************* class RedshiftServerless.Paginator.ListManagedWorkgroups paginator = client.get_paginator('list_managed_workgroups') paginate(**kwargs) Creates an iterator that will paginate through responses from "RedshiftServerless.Client.list_managed_workgroups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( sourceArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **sourceArn** (*string*) -- The Amazon Resource Name (ARN) for the managed workgroup in the AWS Glue Data Catalog. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'managedWorkgroups': [ { 'creationDate': datetime(2015, 1, 1), 'managedWorkgroupId': 'string', 'managedWorkgroupName': 'string', 'sourceArn': 'string', 'status': 'CREATING'|'DELETING'|'MODIFYING'|'AVAILABLE'|'NOT_AVAILABLE' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **managedWorkgroups** *(list) --* The returned array of managed workgroups. * *(dict) --* A collection of Amazon Redshift compute resources managed by AWS Glue. * **creationDate** *(datetime) --* The creation date of the managed workgroup. * **managedWorkgroupId** *(string) --* The unique identifier of the managed workgroup. * **managedWorkgroupName** *(string) --* The name of the managed workgroup. * **sourceArn** *(string) --* The Amazon Resource Name (ARN) for the managed workgroup in the AWS Glue Data Catalog. * **status** *(string) --* The status of the managed workgroup. * **NextToken** *(string) --* A token to resume pagination. RedshiftServerless / Paginator / ListWorkgroups ListWorkgroups ************** class 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( ownerAccount='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ownerAccount** (*string*) -- The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'workgroups': [ { 'baseCapacity': 123, 'configParameters': [ { 'parameterKey': 'string', 'parameterValue': 'string' }, ], 'creationDate': datetime(2015, 1, 1), 'crossAccountVpcs': [ 'string', ], 'customDomainCertificateArn': 'string', 'customDomainCertificateExpiryTime': datetime(2015, 1, 1), 'customDomainName': 'string', 'endpoint': { 'address': 'string', 'port': 123, 'vpcEndpoints': [ { 'networkInterfaces': [ { 'availabilityZone': 'string', 'ipv6Address': 'string', 'networkInterfaceId': 'string', 'privateIpAddress': 'string', 'subnetId': 'string' }, ], 'vpcEndpointId': 'string', 'vpcId': 'string' }, ] }, 'enhancedVpcRouting': True|False, 'ipAddressType': 'string', 'maxCapacity': 123, 'namespaceName': 'string', 'patchVersion': 'string', 'pendingTrackName': 'string', 'port': 123, 'pricePerformanceTarget': { 'level': 123, 'status': 'ENABLED'|'DISABLED' }, 'publiclyAccessible': True|False, 'securityGroupIds': [ 'string', ], 'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING', 'subnetIds': [ 'string', ], 'trackName': 'string', 'workgroupArn': 'string', 'workgroupId': 'string', 'workgroupName': 'string', 'workgroupVersion': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **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 advanced control over a database. The options are "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * *(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 "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * **parameterValue** *(string) --* The value of the parameter to set. * **creationDate** *(datetime) --* The creation date of the workgroup. * **crossAccountVpcs** *(list) --* A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk. * *(string) --* * **customDomainCertificateArn** *(string) --* The custom domain name’s certificate Amazon resource name (ARN). * **customDomainCertificateExpiryTime** *(datetime) --* The expiration time for the certificate. * **customDomainName** *(string) --* The custom domain name associated with 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. * **ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **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. * **ipAddressType** *(string) --* The IP address type that the workgroup supports. Possible values are "ipv4" and "dualstack". * **maxCapacity** *(integer) --* The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs. * **namespaceName** *(string) --* The namespace the workgroup is associated with. * **patchVersion** *(string) --* The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift. * **pendingTrackName** *(string) --* The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied. * **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. * **pricePerformanceTarget** *(dict) --* An object that represents the price performance target settings for the workgroup. * **level** *(integer) --* The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE. * **status** *(string) --* Whether the price performance target is enabled for the workgroup. * **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. * *(string) --* * **status** *(string) --* The status of the workgroup. * **subnetIds** *(list) --* An array of subnet IDs the workgroup is associated with. * *(string) --* * **trackName** *(string) --* The name of the track for the workgroup. * **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. * **workgroupVersion** *(string) --* The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see Cluster versions for Amazon Redshift. * **NextToken** *(string) --* A token to resume pagination. RedshiftServerless / Paginator / ListSnapshotCopyConfigurations ListSnapshotCopyConfigurations ****************************** class RedshiftServerless.Paginator.ListSnapshotCopyConfigurations paginator = client.get_paginator('list_snapshot_copy_configurations') paginate(**kwargs) Creates an iterator that will paginate through responses from "RedshiftServerless.Client.list_snapshot_copy_configurations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( namespaceName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **namespaceName** (*string*) -- The namespace from which to list all snapshot copy configurations. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'snapshotCopyConfigurations': [ { 'destinationKmsKeyId': 'string', 'destinationRegion': 'string', 'namespaceName': 'string', 'snapshotCopyConfigurationArn': 'string', 'snapshotCopyConfigurationId': 'string', 'snapshotRetentionPeriod': 123 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **snapshotCopyConfigurations** *(list) --* All of the returned snapshot copy configurations. * *(dict) --* The object that you configure to copy snapshots from one namespace to a namespace in another Amazon Web Services Region. * **destinationKmsKeyId** *(string) --* The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region. * **destinationRegion** *(string) --* The destination Amazon Web Services Region to copy snapshots to. * **namespaceName** *(string) --* The name of the namespace to copy snapshots from in the source Amazon Web Services Region. * **snapshotCopyConfigurationArn** *(string) --* The ARN of the snapshot copy configuration object. * **snapshotCopyConfigurationId** *(string) --* The ID of the snapshot copy configuration object. * **snapshotRetentionPeriod** *(integer) --* The retention period of snapshots that are copied to the destination Amazon Web Services Region. * **NextToken** *(string) --* A token to resume pagination. RedshiftServerless / Paginator / ListCustomDomainAssociations ListCustomDomainAssociations **************************** class RedshiftServerless.Paginator.ListCustomDomainAssociations paginator = client.get_paginator('list_custom_domain_associations') paginate(**kwargs) Creates an iterator that will paginate through responses from "RedshiftServerless.Client.list_custom_domain_associations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( customDomainCertificateArn='string', customDomainName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **customDomainCertificateArn** (*string*) -- The custom domain name’s certificate Amazon resource name (ARN). * **customDomainName** (*string*) -- The custom domain name associated with the workgroup. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'associations': [ { 'customDomainCertificateArn': 'string', 'customDomainCertificateExpiryTime': datetime(2015, 1, 1), 'customDomainName': 'string', 'workgroupName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **associations** *(list) --* A list of Association objects. * *(dict) --* An object that represents the custom domain name association. * **customDomainCertificateArn** *(string) --* The custom domain name’s certificate Amazon resource name (ARN). * **customDomainCertificateExpiryTime** *(datetime) --* The expiration time for the certificate. * **customDomainName** *(string) --* The custom domain name associated with the workgroup. * **workgroupName** *(string) --* The name of the workgroup associated with the database. * **NextToken** *(string) --* A token to resume pagination. RedshiftServerless / Paginator / ListEndpointAccess ListEndpointAccess ****************** class RedshiftServerless.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( ownerAccount='string', vpcId='string', workgroupName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ownerAccount** (*string*) -- The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup. * **vpcId** (*string*) -- The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless. * **workgroupName** (*string*) -- The name of the workgroup associated with the VPC endpoint to return. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'endpoints': [ { 'address': 'string', 'endpointArn': 'string', 'endpointCreateTime': datetime(2015, 1, 1), 'endpointName': 'string', 'endpointStatus': 'string', 'port': 123, 'subnetIds': [ 'string', ], 'vpcEndpoint': { 'networkInterfaces': [ { 'availabilityZone': 'string', 'ipv6Address': '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. * *(string) --* * **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. * **ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **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 / ListUsageLimits ListUsageLimits *************** class 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' } ) Parameters: * **resourceArn** (*string*) -- The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list. * **usageType** (*string*) -- The Amazon Redshift Serverless feature whose limits you want to see. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 / ListTableRestoreStatus ListTableRestoreStatus ********************** class 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' } ) Parameters: * **namespaceName** (*string*) -- The namespace from which to list all of the statuses of "RestoreTableFromSnapshot" operations . * **workgroupName** (*string*) -- The workgroup from which to list all of the statuses of "RestoreTableFromSnapshot" operations. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'tableRestoreStatuses': [ { 'message': 'string', 'namespaceName': 'string', 'newTableName': 'string', 'progressInMegaBytes': 123, 'recoveryPointId': 'string', '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 message that explains the returned status. For example, if the status of the operation is "FAILED", the message explains why the operation failed. * **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). * **recoveryPointId** *(string) --* The ID of the recovery point being restored from. * **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 are "SUCCEEDED", "FAILED", "CANCELED", "PENDING", and "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 / ListReservations ListReservations **************** class RedshiftServerless.Paginator.ListReservations paginator = client.get_paginator('list_reservations') paginate(**kwargs) Creates an iterator that will paginate through responses from "RedshiftServerless.Client.list_reservations()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'reservationsList': [ { 'capacity': 123, 'endDate': datetime(2015, 1, 1), 'offering': { 'currencyCode': 'string', 'duration': 123, 'hourlyCharge': 123.0, 'offeringId': 'string', 'offeringType': 'ALL_UPFRONT'|'NO_UPFRONT', 'upfrontCharge': 123.0 }, 'reservationArn': 'string', 'reservationId': 'string', 'startDate': datetime(2015, 1, 1), 'status': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **reservationsList** *(list) --* The serverless reservations returned by the request. * *(dict) --* Represents an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates. * **capacity** *(integer) --* The number of Redshift Processing Units (RPUs) to reserve. * **endDate** *(datetime) --* The end date for the serverless reservation. This date is one year after the start date that you specify. * **offering** *(dict) --* The type of offering for the reservation. The offering class determines the payment schedule for the reservation. * **currencyCode** *(string) --* The currency code for the offering. * **duration** *(integer) --* The duration, in seconds, for which the reservation reserves the RPUs. * **hourlyCharge** *(float) --* The rate you are charged for each hour the reservation is active. * **offeringId** *(string) --* The offering identifier. * **offeringType** *(string) --* Determines the payment schedule for the reservation. * **upfrontCharge** *(float) --* The up-front price you are charged for the reservation. * **reservationArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies the serverless reservation. * **reservationId** *(string) --* The identifier that uniquely identifies the serverless reservation. * **startDate** *(datetime) --* The start date for the serverless reservation. This is the date you specified for the reservation to start when you created the reservation. * **status** *(string) --* The status of the reservation. Possible values include the following: * "payment-pending" * "active" * "payment-failed" * "retired" * **NextToken** *(string) --* A token to resume pagination. RedshiftServerless / Paginator / ListScheduledActions ListScheduledActions ******************** class RedshiftServerless.Paginator.ListScheduledActions paginator = client.get_paginator('list_scheduled_actions') paginate(**kwargs) Creates an iterator that will paginate through responses from "RedshiftServerless.Client.list_scheduled_actions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( namespaceName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **namespaceName** (*string*) -- The name of namespace associated with the scheduled action to retrieve. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'scheduledActions': [ { 'namespaceName': 'string', 'scheduledActionName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **scheduledActions** *(list) --* All of the returned scheduled action association objects. * *(dict) --* Contains names of objects associated with a scheduled action. * **namespaceName** *(string) --* Name of associated Amazon Redshift Serverless namespace. * **scheduledActionName** *(string) --* Name of associated scheduled action. * **NextToken** *(string) --* A token to resume pagination. RedshiftServerless / Paginator / ListTracks ListTracks ********** class RedshiftServerless.Paginator.ListTracks paginator = client.get_paginator('list_tracks') paginate(**kwargs) Creates an iterator that will paginate through responses from "RedshiftServerless.Client.list_tracks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'tracks': [ { 'trackName': 'string', 'updateTargets': [ { 'trackName': 'string', 'workgroupVersion': 'string' }, ], 'workgroupVersion': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **tracks** *(list) --* The returned tracks. * *(dict) --* Defines a track that determines which Amazon Redshift version to apply after a new version is released. If the value for "ServerlessTrack" is "current", the workgroup is updated to the most recently certified release. If the value is "trailing", the workgroup is updated to the previously certified release. * **trackName** *(string) --* The name of the track. Valid values are "current" and "trailing". * **updateTargets** *(list) --* An array of "UpdateTarget" objects to update with the track. * *(dict) --* A track that you can switch the current track to. * **trackName** *(string) --* The name of the new track. * **workgroupVersion** *(string) --* The workgroup version for the new track. * **workgroupVersion** *(string) --* The workgroup version number for the workgroup release. * **NextToken** *(string) --* A token to resume pagination. RedshiftServerless / Paginator / ListReservationOfferings ListReservationOfferings ************************ class RedshiftServerless.Paginator.ListReservationOfferings paginator = client.get_paginator('list_reservation_offerings') paginate(**kwargs) Creates an iterator that will paginate through responses from "RedshiftServerless.Client.list_reservation_offerings()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'reservationOfferingsList': [ { 'currencyCode': 'string', 'duration': 123, 'hourlyCharge': 123.0, 'offeringId': 'string', 'offeringType': 'ALL_UPFRONT'|'NO_UPFRONT', 'upfrontCharge': 123.0 }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **reservationOfferingsList** *(list) --* The returned list of reservation offerings. * *(dict) --* The class of offering for the reservation. The offering class determines the payment schedule for the reservation. * **currencyCode** *(string) --* The currency code for the offering. * **duration** *(integer) --* The duration, in seconds, for which the reservation reserves the RPUs. * **hourlyCharge** *(float) --* The rate you are charged for each hour the reservation is active. * **offeringId** *(string) --* The offering identifier. * **offeringType** *(string) --* Determines the payment schedule for the reservation. * **upfrontCharge** *(float) --* The up-front price you are charged for the reservation. * **NextToken** *(string) --* A token to resume pagination. RedshiftServerless / Client / create_snapshot create_snapshot *************** RedshiftServerless.Client.create_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' }, ] ) Parameters: * **namespaceName** (*string*) -- **[REQUIRED]** The namespace to create a snapshot for. * **retentionPeriod** (*integer*) -- How long to retain the created snapshot. * **snapshotName** (*string*) -- **[REQUIRED]** The name of the snapshot. * **tags** (*list*) -- An array of Tag objects to associate with the snapshot. * *(dict) --* A map of key-value pairs. * **key** *(string) --* **[REQUIRED]** The key to use in the tag. * **value** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **Response Syntax** { 'snapshot': { 'accountsWithProvisionedRestoreAccess': [ 'string', ], 'accountsWithRestoreAccess': [ 'string', ], 'actualIncrementalBackupSizeInMegaBytes': 123.0, 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * *(string) --* * **accountsWithRestoreAccess** *(list) --* All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace. * *(string) --* * **actualIncrementalBackupSizeInMegaBytes** *(float) --* The size of the incremental backup in megabytes. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.TooManyTagsException" * "RedshiftServerless.Client.exceptions.ServiceQuotaExceededExcept ion" RedshiftServerless / Client / get_paginator get_paginator ************* RedshiftServerless.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. RedshiftServerless / Client / update_snapshot_copy_configuration update_snapshot_copy_configuration ********************************** RedshiftServerless.Client.update_snapshot_copy_configuration(**kwargs) Updates a snapshot copy configuration. See also: AWS API Documentation **Request Syntax** response = client.update_snapshot_copy_configuration( snapshotCopyConfigurationId='string', snapshotRetentionPeriod=123 ) Parameters: * **snapshotCopyConfigurationId** (*string*) -- **[REQUIRED]** The ID of the snapshot copy configuration to update. * **snapshotRetentionPeriod** (*integer*) -- The new retention period of how long to keep a snapshot in the destination Amazon Web Services Region. Return type: dict Returns: **Response Syntax** { 'snapshotCopyConfiguration': { 'destinationKmsKeyId': 'string', 'destinationRegion': 'string', 'namespaceName': 'string', 'snapshotCopyConfigurationArn': 'string', 'snapshotCopyConfigurationId': 'string', 'snapshotRetentionPeriod': 123 } } **Response Structure** * *(dict) --* * **snapshotCopyConfiguration** *(dict) --* The updated snapshot copy configuration object. * **destinationKmsKeyId** *(string) --* The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region. * **destinationRegion** *(string) --* The destination Amazon Web Services Region to copy snapshots to. * **namespaceName** *(string) --* The name of the namespace to copy snapshots from in the source Amazon Web Services Region. * **snapshotCopyConfigurationArn** *(string) --* The ARN of the snapshot copy configuration object. * **snapshotCopyConfigurationId** *(string) --* The ID of the snapshot copy configuration object. * **snapshotRetentionPeriod** *(integer) --* The retention period of snapshots that are copied to the destination Amazon Web Services Region. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" RedshiftServerless / Client / list_scheduled_actions list_scheduled_actions ********************** RedshiftServerless.Client.list_scheduled_actions(**kwargs) Returns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions. See also: AWS API Documentation **Request Syntax** response = client.list_scheduled_actions( maxResults=123, namespaceName='string', nextToken='string' ) Parameters: * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. Use "nextToken" to display the next page of results. * **namespaceName** (*string*) -- The name of namespace associated with the scheduled action to retrieve. * **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. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'scheduledActions': [ { 'namespaceName': 'string', 'scheduledActionName': '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. * **scheduledActions** *(list) --* All of the returned scheduled action association objects. * *(dict) --* Contains names of objects associated with a scheduled action. * **namespaceName** *(string) --* Name of associated Amazon Redshift Serverless namespace. * **scheduledActionName** *(string) --* Name of associated scheduled action. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.InvalidPaginationException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / list_reservations list_reservations ***************** RedshiftServerless.Client.list_reservations(**kwargs) Returns a list of Reservation objects. See also: AWS API Documentation **Request Syntax** response = client.list_reservations( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. * **nextToken** (*string*) -- The token for the next set of items to return. (You received this token from a previous call.) Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'reservationsList': [ { 'capacity': 123, 'endDate': datetime(2015, 1, 1), 'offering': { 'currencyCode': 'string', 'duration': 123, 'hourlyCharge': 123.0, 'offeringId': 'string', 'offeringType': 'ALL_UPFRONT'|'NO_UPFRONT', 'upfrontCharge': 123.0 }, 'reservationArn': 'string', 'reservationId': 'string', 'startDate': datetime(2015, 1, 1), 'status': 'string' }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The token to use when requesting the next set of items. * **reservationsList** *(list) --* The serverless reservations returned by the request. * *(dict) --* Represents an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates. * **capacity** *(integer) --* The number of Redshift Processing Units (RPUs) to reserve. * **endDate** *(datetime) --* The end date for the serverless reservation. This date is one year after the start date that you specify. * **offering** *(dict) --* The type of offering for the reservation. The offering class determines the payment schedule for the reservation. * **currencyCode** *(string) --* The currency code for the offering. * **duration** *(integer) --* The duration, in seconds, for which the reservation reserves the RPUs. * **hourlyCharge** *(float) --* The rate you are charged for each hour the reservation is active. * **offeringId** *(string) --* The offering identifier. * **offeringType** *(string) --* Determines the payment schedule for the reservation. * **upfrontCharge** *(float) --* The up-front price you are charged for the reservation. * **reservationArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies the serverless reservation. * **reservationId** *(string) --* The identifier that uniquely identifies the serverless reservation. * **startDate** *(datetime) --* The start date for the serverless reservation. This is the date you specified for the reservation to start when you created the reservation. * **status** *(string) --* The status of the reservation. Possible values include the following: * "payment-pending" * "active" * "payment-failed" * "retired" **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / can_paginate can_paginate ************ RedshiftServerless.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Returns: "True" if the operation can be paginated, "False" otherwise. RedshiftServerless / Client / list_namespaces list_namespaces *************** RedshiftServerless.Client.list_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' ) Parameters: * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to display the next page of results. * **nextToken** (*string*) -- If your initial "ListNamespaces" operation returns a "nextToken", you can include the returned "nextToken" in following "ListNamespaces" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'namespaces': [ { 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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. * *(string) --* * **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. * *(string) --* * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / update_snapshot update_snapshot *************** RedshiftServerless.Client.update_snapshot(**kwargs) Updates a snapshot. See also: AWS API Documentation **Request Syntax** response = client.update_snapshot( retentionPeriod=123, snapshotName='string' ) Parameters: * **retentionPeriod** (*integer*) -- The new retention period of the snapshot. * **snapshotName** (*string*) -- **[REQUIRED]** The name of the snapshot. Return type: dict Returns: **Response Syntax** { 'snapshot': { 'accountsWithProvisionedRestoreAccess': [ 'string', ], 'accountsWithRestoreAccess': [ 'string', ], 'actualIncrementalBackupSizeInMegaBytes': 123.0, 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * *(string) --* * **accountsWithRestoreAccess** *(list) --* All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace. * *(string) --* * **actualIncrementalBackupSizeInMegaBytes** *(float) --* The size of the incremental backup in megabytes. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / delete_workgroup delete_workgroup **************** RedshiftServerless.Client.delete_workgroup(**kwargs) Deletes a workgroup. See also: AWS API Documentation **Request Syntax** response = client.delete_workgroup( workgroupName='string' ) Parameters: **workgroupName** (*string*) -- **[REQUIRED]** The name of the workgroup to be deleted. Return type: dict Returns: **Response Syntax** { 'workgroup': { 'baseCapacity': 123, 'configParameters': [ { 'parameterKey': 'string', 'parameterValue': 'string' }, ], 'creationDate': datetime(2015, 1, 1), 'crossAccountVpcs': [ 'string', ], 'customDomainCertificateArn': 'string', 'customDomainCertificateExpiryTime': datetime(2015, 1, 1), 'customDomainName': 'string', 'endpoint': { 'address': 'string', 'port': 123, 'vpcEndpoints': [ { 'networkInterfaces': [ { 'availabilityZone': 'string', 'ipv6Address': 'string', 'networkInterfaceId': 'string', 'privateIpAddress': 'string', 'subnetId': 'string' }, ], 'vpcEndpointId': 'string', 'vpcId': 'string' }, ] }, 'enhancedVpcRouting': True|False, 'ipAddressType': 'string', 'maxCapacity': 123, 'namespaceName': 'string', 'patchVersion': 'string', 'pendingTrackName': 'string', 'port': 123, 'pricePerformanceTarget': { 'level': 123, 'status': 'ENABLED'|'DISABLED' }, 'publiclyAccessible': True|False, 'securityGroupIds': [ 'string', ], 'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING', 'subnetIds': [ 'string', ], 'trackName': 'string', 'workgroupArn': 'string', 'workgroupId': 'string', 'workgroupName': 'string', 'workgroupVersion': 'string' } } **Response Structure** * *(dict) --* * **workgroup** *(dict) --* The deleted 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 advanced control over a database. The options are "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * *(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 "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * **parameterValue** *(string) --* The value of the parameter to set. * **creationDate** *(datetime) --* The creation date of the workgroup. * **crossAccountVpcs** *(list) --* A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk. * *(string) --* * **customDomainCertificateArn** *(string) --* The custom domain name’s certificate Amazon resource name (ARN). * **customDomainCertificateExpiryTime** *(datetime) --* The expiration time for the certificate. * **customDomainName** *(string) --* The custom domain name associated with 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. * **ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **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. * **ipAddressType** *(string) --* The IP address type that the workgroup supports. Possible values are "ipv4" and "dualstack". * **maxCapacity** *(integer) --* The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs. * **namespaceName** *(string) --* The namespace the workgroup is associated with. * **patchVersion** *(string) --* The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift. * **pendingTrackName** *(string) --* The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied. * **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. * **pricePerformanceTarget** *(dict) --* An object that represents the price performance target settings for the workgroup. * **level** *(integer) --* The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE. * **status** *(string) --* Whether the price performance target is enabled for the workgroup. * **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. * *(string) --* * **status** *(string) --* The status of the workgroup. * **subnetIds** *(list) --* An array of subnet IDs the workgroup is associated with. * *(string) --* * **trackName** *(string) --* The name of the track for the workgroup. * **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. * **workgroupVersion** *(string) --* The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see Cluster versions for Amazon Redshift. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / delete_namespace delete_namespace **************** RedshiftServerless.Client.delete_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' ) Parameters: * **finalSnapshotName** (*string*) -- The name of the snapshot to be created before the namespace is deleted. * **finalSnapshotRetentionPeriod** (*integer*) -- How long to retain the final snapshot. * **namespaceName** (*string*) -- **[REQUIRED]** The name of the namespace to delete. Return type: dict Returns: **Response Syntax** { 'namespace': { 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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. * *(string) --* * **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. * *(string) --* * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / create_namespace create_namespace **************** RedshiftServerless.Client.create_namespace(**kwargs) Creates a namespace in Amazon Redshift Serverless. See also: AWS API Documentation **Request Syntax** response = client.create_namespace( adminPasswordSecretKmsKeyId='string', adminUserPassword='string', adminUsername='string', dbName='string', defaultIamRoleArn='string', iamRoles=[ 'string', ], kmsKeyId='string', logExports=[ 'useractivitylog'|'userlog'|'connectionlog', ], manageAdminPassword=True|False, namespaceName='string', redshiftIdcApplicationArn='string', tags=[ { 'key': 'string', 'value': 'string' }, ] ) Parameters: * **adminPasswordSecretKmsKeyId** (*string*) -- The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if "manageAdminPassword" is true. * **adminUserPassword** (*string*) -- The password of the administrator for the first database created in the namespace. You can't use "adminUserPassword" if "manageAdminPassword" is true. * **adminUsername** (*string*) -- The username of the administrator for the first database created in the namespace. * **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. * *(string) --* * **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 "userlog", "connectionlog", and "useractivitylog". * *(string) --* * **manageAdminPassword** (*boolean*) -- If "true", Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use "adminUserPassword" if "manageAdminPassword" is true. If "manageAdminPassword" is false or not set, Amazon Redshift uses "adminUserPassword" for the admin user account's password. * **namespaceName** (*string*) -- **[REQUIRED]** The name of the namespace. * **redshiftIdcApplicationArn** (*string*) -- The ARN for the Redshift application that integrates with IAM Identity Center. * **tags** (*list*) -- A list of tag instances. * *(dict) --* A map of key-value pairs. * **key** *(string) --* **[REQUIRED]** The key to use in the tag. * **value** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **Response Syntax** { 'namespace': { 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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. * *(string) --* * **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. * *(string) --* * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.TooManyTagsException" RedshiftServerless / Client / create_workgroup create_workgroup **************** RedshiftServerless.Client.create_workgroup(**kwargs) Creates an workgroup in Amazon Redshift Serverless. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA turned on, the following capabilities are blocked: * Creating a public access workgroup * Modifying a private workgroup to public * Adding a subnet with VPC BPA turned on to the workgroup when the workgroup is public For more information about VPC BPA, see Block public access to VPCs and subnets in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_workgroup( baseCapacity=123, configParameters=[ { 'parameterKey': 'string', 'parameterValue': 'string' }, ], enhancedVpcRouting=True|False, ipAddressType='string', maxCapacity=123, namespaceName='string', port=123, pricePerformanceTarget={ 'level': 123, 'status': 'ENABLED'|'DISABLED' }, publiclyAccessible=True|False, securityGroupIds=[ 'string', ], subnetIds=[ 'string', ], tags=[ { 'key': 'string', 'value': 'string' }, ], trackName='string', workgroupName='string' ) Parameters: * **baseCapacity** (*integer*) -- The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs). * **configParameters** (*list*) -- An array of parameters to set for advanced control over a database. The options are "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * *(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 "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * **parameterValue** *(string) --* The value of the parameter to set. * **enhancedVpcRouting** (*boolean*) -- The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet. * **ipAddressType** (*string*) -- The IP address type that the workgroup supports. Possible values are "ipv4" and "dualstack". * **maxCapacity** (*integer*) -- The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs. * **namespaceName** (*string*) -- **[REQUIRED]** The name of the namespace to associate with the workgroup. * **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. * **pricePerformanceTarget** (*dict*) -- An object that represents the price performance target settings for the workgroup. * **level** *(integer) --* The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE. * **status** *(string) --* Whether the price performance target is enabled for the workgroup. * **publiclyAccessible** (*boolean*) -- A value that specifies whether the workgroup can be accessed from a public network. * **securityGroupIds** (*list*) -- An array of security group IDs to associate with the workgroup. * *(string) --* * **subnetIds** (*list*) -- An array of VPC subnet IDs to associate with the workgroup. * *(string) --* * **tags** (*list*) -- A array of tag instances. * *(dict) --* A map of key-value pairs. * **key** *(string) --* **[REQUIRED]** The key to use in the tag. * **value** *(string) --* **[REQUIRED]** The value of the tag. * **trackName** (*string*) -- An optional parameter for the name of the track for the workgroup. If you don't provide a track name, the workgroup is assigned to the "current" track. * **workgroupName** (*string*) -- **[REQUIRED]** The name of the created workgroup. Return type: dict Returns: **Response Syntax** { 'workgroup': { 'baseCapacity': 123, 'configParameters': [ { 'parameterKey': 'string', 'parameterValue': 'string' }, ], 'creationDate': datetime(2015, 1, 1), 'crossAccountVpcs': [ 'string', ], 'customDomainCertificateArn': 'string', 'customDomainCertificateExpiryTime': datetime(2015, 1, 1), 'customDomainName': 'string', 'endpoint': { 'address': 'string', 'port': 123, 'vpcEndpoints': [ { 'networkInterfaces': [ { 'availabilityZone': 'string', 'ipv6Address': 'string', 'networkInterfaceId': 'string', 'privateIpAddress': 'string', 'subnetId': 'string' }, ], 'vpcEndpointId': 'string', 'vpcId': 'string' }, ] }, 'enhancedVpcRouting': True|False, 'ipAddressType': 'string', 'maxCapacity': 123, 'namespaceName': 'string', 'patchVersion': 'string', 'pendingTrackName': 'string', 'port': 123, 'pricePerformanceTarget': { 'level': 123, 'status': 'ENABLED'|'DISABLED' }, 'publiclyAccessible': True|False, 'securityGroupIds': [ 'string', ], 'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING', 'subnetIds': [ 'string', ], 'trackName': 'string', 'workgroupArn': 'string', 'workgroupId': 'string', 'workgroupName': 'string', 'workgroupVersion': '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 advanced control over a database. The options are "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * *(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 "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * **parameterValue** *(string) --* The value of the parameter to set. * **creationDate** *(datetime) --* The creation date of the workgroup. * **crossAccountVpcs** *(list) --* A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk. * *(string) --* * **customDomainCertificateArn** *(string) --* The custom domain name’s certificate Amazon resource name (ARN). * **customDomainCertificateExpiryTime** *(datetime) --* The expiration time for the certificate. * **customDomainName** *(string) --* The custom domain name associated with 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. * **ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **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. * **ipAddressType** *(string) --* The IP address type that the workgroup supports. Possible values are "ipv4" and "dualstack". * **maxCapacity** *(integer) --* The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs. * **namespaceName** *(string) --* The namespace the workgroup is associated with. * **patchVersion** *(string) --* The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift. * **pendingTrackName** *(string) --* The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied. * **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. * **pricePerformanceTarget** *(dict) --* An object that represents the price performance target settings for the workgroup. * **level** *(integer) --* The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE. * **status** *(string) --* Whether the price performance target is enabled for the workgroup. * **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. * *(string) --* * **status** *(string) --* The status of the workgroup. * **subnetIds** *(list) --* An array of subnet IDs the workgroup is associated with. * *(string) --* * **trackName** *(string) --* The name of the track for the workgroup. * **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. * **workgroupVersion** *(string) --* The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see Cluster versions for Amazon Redshift. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.InsufficientCapacityExcept ion" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.TooManyTagsException" * "RedshiftServerless.Client.exceptions.Ipv6CidrBlockNotFoundExcep tion" RedshiftServerless / Client / list_reservation_offerings list_reservation_offerings ************************** RedshiftServerless.Client.list_reservation_offerings(**kwargs) Returns the current reservation offerings in your account. See also: AWS API Documentation **Request Syntax** response = client.list_reservation_offerings( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. * **nextToken** (*string*) -- The token for the next set of items to return. (You received this token from a previous call.) Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'reservationOfferingsList': [ { 'currencyCode': 'string', 'duration': 123, 'hourlyCharge': 123.0, 'offeringId': 'string', 'offeringType': 'ALL_UPFRONT'|'NO_UPFRONT', 'upfrontCharge': 123.0 }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* The token to use when requesting the next set of items. * **reservationOfferingsList** *(list) --* The returned list of reservation offerings. * *(dict) --* The class of offering for the reservation. The offering class determines the payment schedule for the reservation. * **currencyCode** *(string) --* The currency code for the offering. * **duration** *(integer) --* The duration, in seconds, for which the reservation reserves the RPUs. * **hourlyCharge** *(float) --* The rate you are charged for each hour the reservation is active. * **offeringId** *(string) --* The offering identifier. * **offeringType** *(string) --* Determines the payment schedule for the reservation. * **upfrontCharge** *(float) --* The up-front price you are charged for the reservation. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / get_table_restore_status get_table_restore_status ************************ RedshiftServerless.Client.get_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' ) Parameters: **tableRestoreRequestId** (*string*) -- **[REQUIRED]** The ID of the "RestoreTableFromSnapshot" request to return status for. Return type: dict Returns: **Response Syntax** { 'tableRestoreStatus': { 'message': 'string', 'namespaceName': 'string', 'newTableName': 'string', 'progressInMegaBytes': 123, 'recoveryPointId': 'string', '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 returned "TableRestoreStatus" object that contains information about the status of your "RestoreTableFromSnapshot" request. * **message** *(string) --* A message that explains the returned status. For example, if the status of the operation is "FAILED", the message explains why the operation failed. * **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). * **recoveryPointId** *(string) --* The ID of the recovery point being restored from. * **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 are "SUCCEEDED", "FAILED", "CANCELED", "PENDING", and "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.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / list_tags_for_resource list_tags_for_resource ********************** RedshiftServerless.Client.list_tags_for_resource(**kwargs) Lists the tags assigned to a resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to list tags for. Return type: dict Returns: **Response Syntax** { 'tags': [ { 'key': 'string', 'value': 'string' }, ] } **Response Structure** * *(dict) --* * **tags** *(list) --* A map of the key-value pairs assigned to the resource. * *(dict) --* A map of key-value pairs. * **key** *(string) --* The key to use in the tag. * **value** *(string) --* The value of the tag. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / restore_table_from_snapshot restore_table_from_snapshot *************************** RedshiftServerless.Client.restore_table_from_snapshot(**kwargs) Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys. 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' ) Parameters: * **activateCaseSensitiveIdentifier** (*boolean*) -- Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false. * **namespaceName** (*string*) -- **[REQUIRED]** The namespace of the snapshot to restore from. * **newTableName** (*string*) -- **[REQUIRED]** The name of the table to create from the restore operation. * **snapshotName** (*string*) -- **[REQUIRED]** The name of the snapshot to restore the table from. * **sourceDatabaseName** (*string*) -- **[REQUIRED]** The name of the source database that contains the table being restored. * **sourceSchemaName** (*string*) -- The name of the source schema that contains the table being restored. * **sourceTableName** (*string*) -- **[REQUIRED]** The name of the source table being restored. * **targetDatabaseName** (*string*) -- The name of the database to restore the table to. * **targetSchemaName** (*string*) -- The name of the schema to restore the table to. * **workgroupName** (*string*) -- **[REQUIRED]** The workgroup to restore the table to. Return type: dict Returns: **Response Syntax** { 'tableRestoreStatus': { 'message': 'string', 'namespaceName': 'string', 'newTableName': 'string', 'progressInMegaBytes': 123, 'recoveryPointId': 'string', '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 message that explains the returned status. For example, if the status of the operation is "FAILED", the message explains why the operation failed. * **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). * **recoveryPointId** *(string) --* The ID of the recovery point being restored from. * **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 are "SUCCEEDED", "FAILED", "CANCELED", "PENDING", and "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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / create_custom_domain_association create_custom_domain_association ******************************** RedshiftServerless.Client.create_custom_domain_association(**kwargs) Creates a custom domain association for Amazon Redshift Serverless. See also: AWS API Documentation **Request Syntax** response = client.create_custom_domain_association( customDomainCertificateArn='string', customDomainName='string', workgroupName='string' ) Parameters: * **customDomainCertificateArn** (*string*) -- **[REQUIRED]** The custom domain name’s certificate Amazon resource name (ARN). * **customDomainName** (*string*) -- **[REQUIRED]** The custom domain name to associate with the workgroup. * **workgroupName** (*string*) -- **[REQUIRED]** The name of the workgroup associated with the database. Return type: dict Returns: **Response Syntax** { 'customDomainCertificateArn': 'string', 'customDomainCertificateExpiryTime': datetime(2015, 1, 1), 'customDomainName': 'string', 'workgroupName': 'string' } **Response Structure** * *(dict) --* * **customDomainCertificateArn** *(string) --* The custom domain name’s certificate Amazon resource name (ARN). * **customDomainCertificateExpiryTime** *(datetime) --* The expiration time for the certificate. * **customDomainName** *(string) --* The custom domain name to associate with the workgroup. * **workgroupName** *(string) --* The name of the workgroup associated with the database. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / get_reservation get_reservation *************** RedshiftServerless.Client.get_reservation(**kwargs) Gets an Amazon Redshift Serverless reservation. A reservation gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates. See also: AWS API Documentation **Request Syntax** response = client.get_reservation( reservationId='string' ) Parameters: **reservationId** (*string*) -- **[REQUIRED]** The ID of the reservation to retrieve. Return type: dict Returns: **Response Syntax** { 'reservation': { 'capacity': 123, 'endDate': datetime(2015, 1, 1), 'offering': { 'currencyCode': 'string', 'duration': 123, 'hourlyCharge': 123.0, 'offeringId': 'string', 'offeringType': 'ALL_UPFRONT'|'NO_UPFRONT', 'upfrontCharge': 123.0 }, 'reservationArn': 'string', 'reservationId': 'string', 'startDate': datetime(2015, 1, 1), 'status': 'string' } } **Response Structure** * *(dict) --* * **reservation** *(dict) --* The returned reservation object. * **capacity** *(integer) --* The number of Redshift Processing Units (RPUs) to reserve. * **endDate** *(datetime) --* The end date for the serverless reservation. This date is one year after the start date that you specify. * **offering** *(dict) --* The type of offering for the reservation. The offering class determines the payment schedule for the reservation. * **currencyCode** *(string) --* The currency code for the offering. * **duration** *(integer) --* The duration, in seconds, for which the reservation reserves the RPUs. * **hourlyCharge** *(float) --* The rate you are charged for each hour the reservation is active. * **offeringId** *(string) --* The offering identifier. * **offeringType** *(string) --* Determines the payment schedule for the reservation. * **upfrontCharge** *(float) --* The up-front price you are charged for the reservation. * **reservationArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies the serverless reservation. * **reservationId** *(string) --* The identifier that uniquely identifies the serverless reservation. * **startDate** *(datetime) --* The start date for the serverless reservation. This is the date you specified for the reservation to start when you created the reservation. * **status** *(string) --* The status of the reservation. Possible values include the following: * "payment-pending" * "active" * "payment-failed" * "retired" **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / list_workgroups list_workgroups *************** RedshiftServerless.Client.list_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', ownerAccount='string' ) Parameters: * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to display the next page of results. * **nextToken** (*string*) -- If your initial ListWorkgroups operation returns a "nextToken", you can include the returned "nextToken" in following ListNamespaces operations, which returns results in the next page. * **ownerAccount** (*string*) -- The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'workgroups': [ { 'baseCapacity': 123, 'configParameters': [ { 'parameterKey': 'string', 'parameterValue': 'string' }, ], 'creationDate': datetime(2015, 1, 1), 'crossAccountVpcs': [ 'string', ], 'customDomainCertificateArn': 'string', 'customDomainCertificateExpiryTime': datetime(2015, 1, 1), 'customDomainName': 'string', 'endpoint': { 'address': 'string', 'port': 123, 'vpcEndpoints': [ { 'networkInterfaces': [ { 'availabilityZone': 'string', 'ipv6Address': 'string', 'networkInterfaceId': 'string', 'privateIpAddress': 'string', 'subnetId': 'string' }, ], 'vpcEndpointId': 'string', 'vpcId': 'string' }, ] }, 'enhancedVpcRouting': True|False, 'ipAddressType': 'string', 'maxCapacity': 123, 'namespaceName': 'string', 'patchVersion': 'string', 'pendingTrackName': 'string', 'port': 123, 'pricePerformanceTarget': { 'level': 123, 'status': 'ENABLED'|'DISABLED' }, 'publiclyAccessible': True|False, 'securityGroupIds': [ 'string', ], 'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING', 'subnetIds': [ 'string', ], 'trackName': 'string', 'workgroupArn': 'string', 'workgroupId': 'string', 'workgroupName': 'string', 'workgroupVersion': '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 advanced control over a database. The options are "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * *(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 "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * **parameterValue** *(string) --* The value of the parameter to set. * **creationDate** *(datetime) --* The creation date of the workgroup. * **crossAccountVpcs** *(list) --* A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk. * *(string) --* * **customDomainCertificateArn** *(string) --* The custom domain name’s certificate Amazon resource name (ARN). * **customDomainCertificateExpiryTime** *(datetime) --* The expiration time for the certificate. * **customDomainName** *(string) --* The custom domain name associated with 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. * **ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **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. * **ipAddressType** *(string) --* The IP address type that the workgroup supports. Possible values are "ipv4" and "dualstack". * **maxCapacity** *(integer) --* The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs. * **namespaceName** *(string) --* The namespace the workgroup is associated with. * **patchVersion** *(string) --* The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift. * **pendingTrackName** *(string) --* The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied. * **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. * **pricePerformanceTarget** *(dict) --* An object that represents the price performance target settings for the workgroup. * **level** *(integer) --* The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE. * **status** *(string) --* Whether the price performance target is enabled for the workgroup. * **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. * *(string) --* * **status** *(string) --* The status of the workgroup. * **subnetIds** *(list) --* An array of subnet IDs the workgroup is associated with. * *(string) --* * **trackName** *(string) --* The name of the track for the workgroup. * **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. * **workgroupVersion** *(string) --* The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see Cluster versions for Amazon Redshift. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / untag_resource untag_resource ************** RedshiftServerless.Client.untag_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', ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to remove tags from. * **tagKeys** (*list*) -- **[REQUIRED]** The tag or set of tags to remove from the resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / get_waiter get_waiter ********** RedshiftServerless.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" RedshiftServerless / Client / restore_from_recovery_point restore_from_recovery_point *************************** RedshiftServerless.Client.restore_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' ) Parameters: * **namespaceName** (*string*) -- **[REQUIRED]** The name of the namespace to restore data into. * **recoveryPointId** (*string*) -- **[REQUIRED]** The unique identifier of the recovery point to restore from. * **workgroupName** (*string*) -- **[REQUIRED]** The name of the workgroup used to restore data. Return type: dict Returns: **Response Syntax** { 'namespace': { 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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. * *(string) --* * **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. * *(string) --* * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / create_reservation create_reservation ****************** RedshiftServerless.Client.create_reservation(**kwargs) Creates an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates. See also: AWS API Documentation **Request Syntax** response = client.create_reservation( capacity=123, clientToken='string', offeringId='string' ) Parameters: * **capacity** (*integer*) -- **[REQUIRED]** The number of Redshift Processing Units (RPUs) to reserve. * **clientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. This token must be a valid UUIDv4 value. For more information about idempotency, see Making retries safe with idempotent APIs. This field is autopopulated if not provided. * **offeringId** (*string*) -- **[REQUIRED]** The ID of the offering associated with the reservation. The offering determines the payment schedule for the reservation. Return type: dict Returns: **Response Syntax** { 'reservation': { 'capacity': 123, 'endDate': datetime(2015, 1, 1), 'offering': { 'currencyCode': 'string', 'duration': 123, 'hourlyCharge': 123.0, 'offeringId': 'string', 'offeringType': 'ALL_UPFRONT'|'NO_UPFRONT', 'upfrontCharge': 123.0 }, 'reservationArn': 'string', 'reservationId': 'string', 'startDate': datetime(2015, 1, 1), 'status': 'string' } } **Response Structure** * *(dict) --* * **reservation** *(dict) --* The reservation object that the "CreateReservation" action created. * **capacity** *(integer) --* The number of Redshift Processing Units (RPUs) to reserve. * **endDate** *(datetime) --* The end date for the serverless reservation. This date is one year after the start date that you specify. * **offering** *(dict) --* The type of offering for the reservation. The offering class determines the payment schedule for the reservation. * **currencyCode** *(string) --* The currency code for the offering. * **duration** *(integer) --* The duration, in seconds, for which the reservation reserves the RPUs. * **hourlyCharge** *(float) --* The rate you are charged for each hour the reservation is active. * **offeringId** *(string) --* The offering identifier. * **offeringType** *(string) --* Determines the payment schedule for the reservation. * **upfrontCharge** *(float) --* The up-front price you are charged for the reservation. * **reservationArn** *(string) --* The Amazon Resource Name (ARN) that uniquely identifies the serverless reservation. * **reservationId** *(string) --* The identifier that uniquely identifies the serverless reservation. * **startDate** *(datetime) --* The start date for the serverless reservation. This is the date you specified for the reservation to start when you created the reservation. * **status** *(string) --* The status of the reservation. Possible values include the following: * "payment-pending" * "active" * "payment-failed" * "retired" **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.TooManyTagsException" * "RedshiftServerless.Client.exceptions.ServiceQuotaExceededExcept ion" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / list_custom_domain_associations list_custom_domain_associations ******************************* RedshiftServerless.Client.list_custom_domain_associations(**kwargs) Lists custom domain associations for Amazon Redshift Serverless. See also: AWS API Documentation **Request Syntax** response = client.list_custom_domain_associations( customDomainCertificateArn='string', customDomainName='string', maxResults=123, nextToken='string' ) Parameters: * **customDomainCertificateArn** (*string*) -- The custom domain name’s certificate Amazon resource name (ARN). * **customDomainName** (*string*) -- The custom domain name associated with the workgroup. * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to display the next page of results. * **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. Return type: dict Returns: **Response Syntax** { 'associations': [ { 'customDomainCertificateArn': 'string', 'customDomainCertificateExpiryTime': datetime(2015, 1, 1), 'customDomainName': 'string', 'workgroupName': 'string' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **associations** *(list) --* A list of Association objects. * *(dict) --* An object that represents the custom domain name association. * **customDomainCertificateArn** *(string) --* The custom domain name’s certificate Amazon resource name (ARN). * **customDomainCertificateExpiryTime** *(datetime) --* The expiration time for the certificate. * **customDomainName** *(string) --* The custom domain name associated with the workgroup. * **workgroupName** *(string) --* The name of the workgroup associated with the database. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.InvalidPaginationException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / list_managed_workgroups list_managed_workgroups *********************** RedshiftServerless.Client.list_managed_workgroups(**kwargs) Returns information about a list of specified managed workgroups in your account. See also: AWS API Documentation **Request Syntax** response = client.list_managed_workgroups( maxResults=123, nextToken='string', sourceArn='string' ) Parameters: * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results. * **nextToken** (*string*) -- If your initial ListManagedWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListManagedWorkgroups operations, which returns results in the next page. * **sourceArn** (*string*) -- The Amazon Resource Name (ARN) for the managed workgroup in the AWS Glue Data Catalog. Return type: dict Returns: **Response Syntax** { 'managedWorkgroups': [ { 'creationDate': datetime(2015, 1, 1), 'managedWorkgroupId': 'string', 'managedWorkgroupName': 'string', 'sourceArn': 'string', 'status': 'CREATING'|'DELETING'|'MODIFYING'|'AVAILABLE'|'NOT_AVAILABLE' }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **managedWorkgroups** *(list) --* The returned array of managed workgroups. * *(dict) --* A collection of Amazon Redshift compute resources managed by AWS Glue. * **creationDate** *(datetime) --* The creation date of the managed workgroup. * **managedWorkgroupId** *(string) --* The unique identifier of the managed workgroup. * **managedWorkgroupName** *(string) --* The name of the managed workgroup. * **sourceArn** *(string) --* The Amazon Resource Name (ARN) for the managed workgroup in the AWS Glue Data Catalog. * **status** *(string) --* The status of the managed workgroup. * **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. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" RedshiftServerless / Client / get_endpoint_access get_endpoint_access ******************* RedshiftServerless.Client.get_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' ) Parameters: **endpointName** (*string*) -- **[REQUIRED]** The name of the VPC endpoint to return information for. Return type: dict Returns: **Response Syntax** { 'endpoint': { 'address': 'string', 'endpointArn': 'string', 'endpointCreateTime': datetime(2015, 1, 1), 'endpointName': 'string', 'endpointStatus': 'string', 'port': 123, 'subnetIds': [ 'string', ], 'vpcEndpoint': { 'networkInterfaces': [ { 'availabilityZone': 'string', 'ipv6Address': 'string', 'networkInterfaceId': 'string', 'privateIpAddress': 'string', 'subnetId': 'string' }, ], 'vpcEndpointId': 'string', 'vpcId': 'string' }, 'vpcSecurityGroups': [ { 'status': 'string', 'vpcSecurityGroupId': 'string' }, ], 'workgroupName': 'string' } } **Response Structure** * *(dict) --* * **endpoint** *(dict) --* The returned 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. * *(string) --* * **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. * **ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / delete_snapshot delete_snapshot *************** RedshiftServerless.Client.delete_snapshot(**kwargs) Deletes a snapshot from Amazon Redshift Serverless. See also: AWS API Documentation **Request Syntax** response = client.delete_snapshot( snapshotName='string' ) Parameters: **snapshotName** (*string*) -- **[REQUIRED]** The name of the snapshot to be deleted. Return type: dict Returns: **Response Syntax** { 'snapshot': { 'accountsWithProvisionedRestoreAccess': [ 'string', ], 'accountsWithRestoreAccess': [ 'string', ], 'actualIncrementalBackupSizeInMegaBytes': 123.0, 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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 deleted snapshot object. * **accountsWithProvisionedRestoreAccess** *(list) --* All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster. * *(string) --* * **accountsWithRestoreAccess** *(list) --* All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace. * *(string) --* * **actualIncrementalBackupSizeInMegaBytes** *(float) --* The size of the incremental backup in megabytes. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / get_workgroup get_workgroup ************* RedshiftServerless.Client.get_workgroup(**kwargs) Returns information about a specific workgroup. See also: AWS API Documentation **Request Syntax** response = client.get_workgroup( workgroupName='string' ) Parameters: **workgroupName** (*string*) -- **[REQUIRED]** The name of the workgroup to return information for. Return type: dict Returns: **Response Syntax** { 'workgroup': { 'baseCapacity': 123, 'configParameters': [ { 'parameterKey': 'string', 'parameterValue': 'string' }, ], 'creationDate': datetime(2015, 1, 1), 'crossAccountVpcs': [ 'string', ], 'customDomainCertificateArn': 'string', 'customDomainCertificateExpiryTime': datetime(2015, 1, 1), 'customDomainName': 'string', 'endpoint': { 'address': 'string', 'port': 123, 'vpcEndpoints': [ { 'networkInterfaces': [ { 'availabilityZone': 'string', 'ipv6Address': 'string', 'networkInterfaceId': 'string', 'privateIpAddress': 'string', 'subnetId': 'string' }, ], 'vpcEndpointId': 'string', 'vpcId': 'string' }, ] }, 'enhancedVpcRouting': True|False, 'ipAddressType': 'string', 'maxCapacity': 123, 'namespaceName': 'string', 'patchVersion': 'string', 'pendingTrackName': 'string', 'port': 123, 'pricePerformanceTarget': { 'level': 123, 'status': 'ENABLED'|'DISABLED' }, 'publiclyAccessible': True|False, 'securityGroupIds': [ 'string', ], 'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING', 'subnetIds': [ 'string', ], 'trackName': 'string', 'workgroupArn': 'string', 'workgroupId': 'string', 'workgroupName': 'string', 'workgroupVersion': 'string' } } **Response Structure** * *(dict) --* * **workgroup** *(dict) --* The returned 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 advanced control over a database. The options are "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * *(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 "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * **parameterValue** *(string) --* The value of the parameter to set. * **creationDate** *(datetime) --* The creation date of the workgroup. * **crossAccountVpcs** *(list) --* A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk. * *(string) --* * **customDomainCertificateArn** *(string) --* The custom domain name’s certificate Amazon resource name (ARN). * **customDomainCertificateExpiryTime** *(datetime) --* The expiration time for the certificate. * **customDomainName** *(string) --* The custom domain name associated with 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. * **ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **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. * **ipAddressType** *(string) --* The IP address type that the workgroup supports. Possible values are "ipv4" and "dualstack". * **maxCapacity** *(integer) --* The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs. * **namespaceName** *(string) --* The namespace the workgroup is associated with. * **patchVersion** *(string) --* The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift. * **pendingTrackName** *(string) --* The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied. * **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. * **pricePerformanceTarget** *(dict) --* An object that represents the price performance target settings for the workgroup. * **level** *(integer) --* The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE. * **status** *(string) --* Whether the price performance target is enabled for the workgroup. * **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. * *(string) --* * **status** *(string) --* The status of the workgroup. * **subnetIds** *(list) --* An array of subnet IDs the workgroup is associated with. * *(string) --* * **trackName** *(string) --* The name of the track for the workgroup. * **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. * **workgroupVersion** *(string) --* The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see Cluster versions for Amazon Redshift. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / list_table_restore_status list_table_restore_status ************************* RedshiftServerless.Client.list_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' ) Parameters: * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results. * **namespaceName** (*string*) -- The namespace from which to list all of the statuses of "RestoreTableFromSnapshot" operations . * **nextToken** (*string*) -- If your initial "ListTableRestoreStatus" operation returns a nextToken, you can include the returned "nextToken" in following "ListTableRestoreStatus" operations. This will return results on the next page. * **workgroupName** (*string*) -- The workgroup from which to list all of the statuses of "RestoreTableFromSnapshot" operations. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'tableRestoreStatuses': [ { 'message': 'string', 'namespaceName': 'string', 'newTableName': 'string', 'progressInMegaBytes': 123, 'recoveryPointId': 'string', '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 message that explains the returned status. For example, if the status of the operation is "FAILED", the message explains why the operation failed. * **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). * **recoveryPointId** *(string) --* The ID of the recovery point being restored from. * **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 are "SUCCEEDED", "FAILED", "CANCELED", "PENDING", and "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.InvalidPaginationException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / update_usage_limit update_usage_limit ****************** RedshiftServerless.Client.update_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' ) Parameters: * **amount** (*integer*) -- The new limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number. * **breachAction** (*string*) -- The new action that Amazon Redshift Serverless takes when the limit is reached. * **usageLimitId** (*string*) -- **[REQUIRED]** The identifier of the usage limit to update. Return type: dict Returns: **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / list_endpoint_access list_endpoint_access ******************** RedshiftServerless.Client.list_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', ownerAccount='string', vpcId='string', workgroupName='string' ) Parameters: * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to display the next page of results. * **nextToken** (*string*) -- If your initial "ListEndpointAccess" operation returns a "nextToken", you can include the returned "nextToken" in following "ListEndpointAccess" operations, which returns results in the next page. * **ownerAccount** (*string*) -- The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup. * **vpcId** (*string*) -- The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless. * **workgroupName** (*string*) -- The name of the workgroup associated with the VPC endpoint to return. Return type: dict Returns: **Response Syntax** { 'endpoints': [ { 'address': 'string', 'endpointArn': 'string', 'endpointCreateTime': datetime(2015, 1, 1), 'endpointName': 'string', 'endpointStatus': 'string', 'port': 123, 'subnetIds': [ 'string', ], 'vpcEndpoint': { 'networkInterfaces': [ { 'availabilityZone': 'string', 'ipv6Address': '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. * *(string) --* * **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. * **ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / get_recovery_point get_recovery_point ****************** RedshiftServerless.Client.get_recovery_point(**kwargs) Returns information about a recovery point. See also: AWS API Documentation **Request Syntax** response = client.get_recovery_point( recoveryPointId='string' ) Parameters: **recoveryPointId** (*string*) -- **[REQUIRED]** The unique identifier of the recovery point to return information for. Return type: dict Returns: **Response Syntax** { 'recoveryPoint': { 'namespaceArn': 'string', 'namespaceName': 'string', 'recoveryPointCreateTime': datetime(2015, 1, 1), 'recoveryPointId': 'string', 'totalSizeInMegaBytes': 123.0, 'workgroupName': 'string' } } **Response Structure** * *(dict) --* * **recoveryPoint** *(dict) --* The returned recovery point object. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / list_usage_limits list_usage_limits ***************** RedshiftServerless.Client.list_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' ) Parameters: * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. The default is 100. * **nextToken** (*string*) -- If your initial "ListUsageLimits" operation returns a "nextToken", you can include the returned "nextToken" in following "ListUsageLimits" operations, which returns results in the next page. * **resourceArn** (*string*) -- The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list. * **usageType** (*string*) -- The Amazon Redshift Serverless feature whose limits you want to see. Return type: dict Returns: **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.InternalServerException" * "RedshiftServerless.Client.exceptions.InvalidPaginationException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / get_namespace get_namespace ************* RedshiftServerless.Client.get_namespace(**kwargs) Returns information about a namespace in Amazon Redshift Serverless. See also: AWS API Documentation **Request Syntax** response = client.get_namespace( namespaceName='string' ) Parameters: **namespaceName** (*string*) -- **[REQUIRED]** The name of the namespace to retrieve information for. Return type: dict Returns: **Response Syntax** { 'namespace': { 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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 returned namespace object. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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. * *(string) --* * **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. * *(string) --* * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / restore_from_snapshot restore_from_snapshot ********************* RedshiftServerless.Client.restore_from_snapshot(**kwargs) Restores a namespace from a snapshot. See also: AWS API Documentation **Request Syntax** response = client.restore_from_snapshot( adminPasswordSecretKmsKeyId='string', manageAdminPassword=True|False, namespaceName='string', ownerAccount='string', snapshotArn='string', snapshotName='string', workgroupName='string' ) Parameters: * **adminPasswordSecretKmsKeyId** (*string*) -- The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **manageAdminPassword** (*boolean*) -- If "true", Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If "MmanageAdminPassword" is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken. * **namespaceName** (*string*) -- **[REQUIRED]** The name of the namespace to restore the snapshot to. * **ownerAccount** (*string*) -- The Amazon Web Services account that owns the snapshot. * **snapshotArn** (*string*) -- The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from a provisioned cluster to Amazon Redshift Serverless. Must not be specified at the same time as "snapshotName". The format of the ARN is arn:aws:redshift:::snapshot:/. * **snapshotName** (*string*) -- The name of the snapshot to restore from. Must not be specified at the same time as "snapshotArn". * **workgroupName** (*string*) -- **[REQUIRED]** The name of the workgroup used to restore the snapshot. Return type: dict Returns: **Response Syntax** { 'namespace': { 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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. * *(string) --* * **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. * *(string) --* * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.ServiceQuotaExceededExcept ion" RedshiftServerless / Client / get_scheduled_action get_scheduled_action ******************** RedshiftServerless.Client.get_scheduled_action(**kwargs) Returns information about a scheduled action. See also: AWS API Documentation **Request Syntax** response = client.get_scheduled_action( scheduledActionName='string' ) Parameters: **scheduledActionName** (*string*) -- **[REQUIRED]** The name of the scheduled action. Return type: dict Returns: **Response Syntax** { 'scheduledAction': { 'endTime': datetime(2015, 1, 1), 'namespaceName': 'string', 'nextInvocations': [ datetime(2015, 1, 1), ], 'roleArn': 'string', 'schedule': { 'at': datetime(2015, 1, 1), 'cron': 'string' }, 'scheduledActionDescription': 'string', 'scheduledActionName': 'string', 'scheduledActionUuid': 'string', 'startTime': datetime(2015, 1, 1), 'state': 'ACTIVE'|'DISABLED', 'targetAction': { 'createSnapshot': { 'namespaceName': 'string', 'retentionPeriod': 123, 'snapshotNamePrefix': 'string', 'tags': [ { 'key': 'string', 'value': 'string' }, ] } } } } **Response Structure** * *(dict) --* * **scheduledAction** *(dict) --* The returned scheduled action object. * **endTime** *(datetime) --* The end time of * **namespaceName** *(string) --* The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger. * **nextInvocations** *(list) --* An array of timestamps of when the next scheduled actions will trigger. * *(datetime) --* * **roleArn** *(string) --* The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide * **schedule** *(dict) --* The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. * Format of at timestamp is "yyyy-mm-ddThh:mm:ss". For example, "2016-03-04T17:27:00". * Format of cron expression is "(Minutes Hours Day-of- month Month Day-of-week Year)". For example, ""(0 10 ? * MON *)"". For more information, see Cron Expressions in the *Amazon CloudWatch Events User Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "at", "cron". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **at** *(datetime) --* The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is "yyyy-mm-ddThh:mm:ss". For example, "2016-03-04T17:27:00". * **cron** *(string) --* The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. Format of cron expressions is "(Minutes Hours Day-of- month Month Day-of-week Year)". For example, ""(0 10 ? * MON *)"". For more information, see Cron Expressions in the *Amazon CloudWatch Events User Guide*. * **scheduledActionDescription** *(string) --* The description of the scheduled action. * **scheduledActionName** *(string) --* The name of the scheduled action. * **scheduledActionUuid** *(string) --* The uuid of the scheduled action. * **startTime** *(datetime) --* The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger. * **state** *(string) --* The state of the scheduled action. * **targetAction** *(dict) --* A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action. ""{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"" Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "createSnapshot". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **createSnapshot** *(dict) --* The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction. * **namespaceName** *(string) --* The name of the namespace for which you want to configure a scheduled action to create a snapshot. * **retentionPeriod** *(integer) --* The retention period of the snapshot created by the scheduled action. * **snapshotNamePrefix** *(string) --* A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created. * **tags** *(list) --* An array of Tag objects to associate with the snapshot. * *(dict) --* A map of key-value pairs. * **key** *(string) --* The key to use in the tag. * **value** *(string) --* The value of the tag. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / update_namespace update_namespace **************** RedshiftServerless.Client.update_namespace(**kwargs) Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both "adminUsername" and "adminUserPassword" to update either field, but you can't update both "kmsKeyId" and "logExports" in a single request. See also: AWS API Documentation **Request Syntax** response = client.update_namespace( adminPasswordSecretKmsKeyId='string', adminUserPassword='string', adminUsername='string', defaultIamRoleArn='string', iamRoles=[ 'string', ], kmsKeyId='string', logExports=[ 'useractivitylog'|'userlog'|'connectionlog', ], manageAdminPassword=True|False, namespaceName='string' ) Parameters: * **adminPasswordSecretKmsKeyId** (*string*) -- The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if "manageAdminPassword" is true. * **adminUserPassword** (*string*) -- The password of the administrator for the first database created in the namespace. This parameter must be updated together with "adminUsername". You can't use "adminUserPassword" if "manageAdminPassword" is true. * **adminUsername** (*string*) -- The username of the administrator for the first database created in the namespace. This parameter must be updated together with "adminUserPassword". * **defaultIamRoleArn** (*string*) -- The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together with "iamRoles". * **iamRoles** (*list*) -- A list of IAM roles to associate with the namespace. This parameter must be updated together with "defaultIamRoleArn". * *(string) --* * **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. The export types are "userlog", "connectionlog", and "useractivitylog". * *(string) --* * **manageAdminPassword** (*boolean*) -- If "true", Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use "adminUserPassword" if "manageAdminPassword" is true. If "manageAdminPassword" is false or not set, Amazon Redshift uses "adminUserPassword" for the admin user account's password. * **namespaceName** (*string*) -- **[REQUIRED]** The name of the namespace to update. You can't update the name of a namespace once it is created. Return type: dict Returns: **Response Syntax** { 'namespace': { 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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. * *(string) --* * **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. * *(string) --* * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / update_workgroup update_workgroup **************** RedshiftServerless.Client.update_workgroup(**kwargs) Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update "baseCapacity" or "port" in a single request, but you can't update both in the same request. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a workgroup is in an account with VPC BPA turned on, the following capabilities are blocked: * Creating a public access workgroup * Modifying a private workgroup to public * Adding a subnet with VPC BPA turned on to the workgroup when the workgroup is public For more information about VPC BPA, see Block public access to VPCs and subnets in the *Amazon VPC User Guide*. See also: AWS API Documentation **Request Syntax** response = client.update_workgroup( baseCapacity=123, configParameters=[ { 'parameterKey': 'string', 'parameterValue': 'string' }, ], enhancedVpcRouting=True|False, ipAddressType='string', maxCapacity=123, port=123, pricePerformanceTarget={ 'level': 123, 'status': 'ENABLED'|'DISABLED' }, publiclyAccessible=True|False, securityGroupIds=[ 'string', ], subnetIds=[ 'string', ], trackName='string', workgroupName='string' ) Parameters: * **baseCapacity** (*integer*) -- The new base data warehouse capacity in Redshift Processing Units (RPUs). * **configParameters** (*list*) -- An array of parameters to set for advanced control over a database. The options are "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * *(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 "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * **parameterValue** *(string) --* The value of the parameter to set. * **enhancedVpcRouting** (*boolean*) -- The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC. * **ipAddressType** (*string*) -- The IP address type that the workgroup supports. Possible values are "ipv4" and "dualstack". * **maxCapacity** (*integer*) -- The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs. * **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. * **pricePerformanceTarget** (*dict*) -- An object that represents the price performance target settings for the workgroup. * **level** *(integer) --* The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE. * **status** *(string) --* Whether the price performance target is enabled for the workgroup. * **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. * *(string) --* * **subnetIds** (*list*) -- An array of VPC subnet IDs to associate with the workgroup. * *(string) --* * **trackName** (*string*) -- An optional parameter for the name of the track for the workgroup. If you don't provide a track name, the workgroup is assigned to the "current" track. * **workgroupName** (*string*) -- **[REQUIRED]** The name of the workgroup to update. You can't update the name of a workgroup once it is created. Return type: dict Returns: **Response Syntax** { 'workgroup': { 'baseCapacity': 123, 'configParameters': [ { 'parameterKey': 'string', 'parameterValue': 'string' }, ], 'creationDate': datetime(2015, 1, 1), 'crossAccountVpcs': [ 'string', ], 'customDomainCertificateArn': 'string', 'customDomainCertificateExpiryTime': datetime(2015, 1, 1), 'customDomainName': 'string', 'endpoint': { 'address': 'string', 'port': 123, 'vpcEndpoints': [ { 'networkInterfaces': [ { 'availabilityZone': 'string', 'ipv6Address': 'string', 'networkInterfaceId': 'string', 'privateIpAddress': 'string', 'subnetId': 'string' }, ], 'vpcEndpointId': 'string', 'vpcId': 'string' }, ] }, 'enhancedVpcRouting': True|False, 'ipAddressType': 'string', 'maxCapacity': 123, 'namespaceName': 'string', 'patchVersion': 'string', 'pendingTrackName': 'string', 'port': 123, 'pricePerformanceTarget': { 'level': 123, 'status': 'ENABLED'|'DISABLED' }, 'publiclyAccessible': True|False, 'securityGroupIds': [ 'string', ], 'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING', 'subnetIds': [ 'string', ], 'trackName': 'string', 'workgroupArn': 'string', 'workgroupId': 'string', 'workgroupName': 'string', 'workgroupVersion': '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 advanced control over a database. The options are "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * *(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 "auto_mv", "datestyle", "enable_case_sensitive_identifier", "enable_user_activity_logging", "query_group", "search_path", "require_ssl", "use_fips_ssl", and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless. * **parameterValue** *(string) --* The value of the parameter to set. * **creationDate** *(datetime) --* The creation date of the workgroup. * **crossAccountVpcs** *(list) --* A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk. * *(string) --* * **customDomainCertificateArn** *(string) --* The custom domain name’s certificate Amazon resource name (ARN). * **customDomainCertificateExpiryTime** *(datetime) --* The expiration time for the certificate. * **customDomainName** *(string) --* The custom domain name associated with 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. * **ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **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. * **ipAddressType** *(string) --* The IP address type that the workgroup supports. Possible values are "ipv4" and "dualstack". * **maxCapacity** *(integer) --* The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs. * **namespaceName** *(string) --* The namespace the workgroup is associated with. * **patchVersion** *(string) --* The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift. * **pendingTrackName** *(string) --* The name for the track that you want to assign to the workgroup. When the track changes, the workgroup is switched to the latest workgroup release available for the track. At this point, the track name is applied. * **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. * **pricePerformanceTarget** *(dict) --* An object that represents the price performance target settings for the workgroup. * **level** *(integer) --* The target price performance level for the workgroup. Valid values include 1, 25, 50, 75, and 100. These correspond to the price performance levels LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL, and HIGH_PERFORMANCE. * **status** *(string) --* Whether the price performance target is enabled for the workgroup. * **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. * *(string) --* * **status** *(string) --* The status of the workgroup. * **subnetIds** *(list) --* An array of subnet IDs the workgroup is associated with. * *(string) --* * **trackName** *(string) --* The name of the track for the workgroup. * **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. * **workgroupVersion** *(string) --* The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, see Cluster versions for Amazon Redshift. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.InsufficientCapacityExcept ion" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.Ipv6CidrBlockNotFoundExcep tion" RedshiftServerless / Client / update_endpoint_access update_endpoint_access ********************** RedshiftServerless.Client.update_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', ] ) Parameters: * **endpointName** (*string*) -- **[REQUIRED]** The name of the VPC endpoint to update. * **vpcSecurityGroupIds** (*list*) -- The list of VPC security groups associated with the endpoint after the endpoint is modified. * *(string) --* Return type: dict Returns: **Response Syntax** { 'endpoint': { 'address': 'string', 'endpointArn': 'string', 'endpointCreateTime': datetime(2015, 1, 1), 'endpointName': 'string', 'endpointStatus': 'string', 'port': 123, 'subnetIds': [ 'string', ], 'vpcEndpoint': { 'networkInterfaces': [ { 'availabilityZone': 'string', 'ipv6Address': '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. * *(string) --* * **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. * **ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" RedshiftServerless / Client / close close ***** RedshiftServerless.Client.close() Closes underlying endpoint connections. RedshiftServerless / Client / put_resource_policy put_resource_policy ******************* RedshiftServerless.Client.put_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' ) Parameters: * **policy** (*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\" }]}"" * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the account to create or update a resource policy for. Return type: dict Returns: **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.ServiceQuotaExceededExcept ion" RedshiftServerless / Client / get_resource_policy get_resource_policy ******************* RedshiftServerless.Client.get_resource_policy(**kwargs) Returns a resource policy. See also: AWS API Documentation **Request Syntax** response = client.get_resource_policy( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to return. Return type: dict Returns: **Response Syntax** { 'resourcePolicy': { 'policy': 'string', 'resourceArn': 'string' } } **Response Structure** * *(dict) --* * **resourcePolicy** *(dict) --* The returned resource policy. * **policy** *(string) --* The resource policy. * **resourceArn** *(string) --* The Amazon Resource Name (ARN) of the policy. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / list_snapshots list_snapshots ************** RedshiftServerless.Client.list_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) ) Parameters: * **endTime** (*datetime*) -- The timestamp showing when the snapshot creation finished. * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to display the next page of results. * **namespaceArn** (*string*) -- The Amazon Resource Name (ARN) of the namespace from which to list all snapshots. * **namespaceName** (*string*) -- The namespace from which to list all snapshots. * **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. * **ownerAccount** (*string*) -- The owner Amazon Web Services account of the snapshot. * **startTime** (*datetime*) -- The time when the creation of the snapshot was initiated. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'snapshots': [ { 'accountsWithProvisionedRestoreAccess': [ 'string', ], 'accountsWithRestoreAccess': [ 'string', ], 'actualIncrementalBackupSizeInMegaBytes': 123.0, 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * *(string) --* * **accountsWithRestoreAccess** *(list) --* All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace. * *(string) --* * **actualIncrementalBackupSizeInMegaBytes** *(float) --* The size of the incremental backup in megabytes. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / get_credentials get_credentials *************** RedshiftServerless.Client.get_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). 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. If the "DbName" parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name. See also: AWS API Documentation **Request Syntax** response = client.get_credentials( customDomainName='string', dbName='string', durationSeconds=123, workgroupName='string' ) Parameters: * **customDomainName** (*string*) -- The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request. * **dbName** (*string*) -- The name of the database to get temporary authorization to log on to. Constraints: * Must be 1 to 64 alphanumeric characters or hyphens. * Must contain only uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. * The first character must be a letter. * Must not contain a colon ( : ) or slash ( / ). * Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide * **durationSeconds** (*integer*) -- The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds. * **workgroupName** (*string*) -- The name of the workgroup associated with the database. Return type: dict Returns: **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / list_tracks list_tracks *********** RedshiftServerless.Client.list_tracks(**kwargs) List the Amazon Redshift Serverless versions. See also: AWS API Documentation **Request Syntax** response = client.list_tracks( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. * **nextToken** (*string*) -- If your initial "ListTracksRequest" operation returns a "nextToken", you can include the returned "nextToken" in following "ListTracksRequest" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'tracks': [ { 'trackName': 'string', 'updateTargets': [ { 'trackName': 'string', 'workgroupVersion': 'string' }, ], 'workgroupVersion': 'string' }, ] } **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. * **tracks** *(list) --* The returned tracks. * *(dict) --* Defines a track that determines which Amazon Redshift version to apply after a new version is released. If the value for "ServerlessTrack" is "current", the workgroup is updated to the most recently certified release. If the value is "trailing", the workgroup is updated to the previously certified release. * **trackName** *(string) --* The name of the track. Valid values are "current" and "trailing". * **updateTargets** *(list) --* An array of "UpdateTarget" objects to update with the track. * *(dict) --* A track that you can switch the current track to. * **trackName** *(string) --* The name of the new track. * **workgroupVersion** *(string) --* The workgroup version for the new track. * **workgroupVersion** *(string) --* The workgroup version number for the workgroup release. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.InvalidPaginationException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / delete_scheduled_action delete_scheduled_action *********************** RedshiftServerless.Client.delete_scheduled_action(**kwargs) Deletes a scheduled action. See also: AWS API Documentation **Request Syntax** response = client.delete_scheduled_action( scheduledActionName='string' ) Parameters: **scheduledActionName** (*string*) -- **[REQUIRED]** The name of the scheduled action to delete. Return type: dict Returns: **Response Syntax** { 'scheduledAction': { 'endTime': datetime(2015, 1, 1), 'namespaceName': 'string', 'nextInvocations': [ datetime(2015, 1, 1), ], 'roleArn': 'string', 'schedule': { 'at': datetime(2015, 1, 1), 'cron': 'string' }, 'scheduledActionDescription': 'string', 'scheduledActionName': 'string', 'scheduledActionUuid': 'string', 'startTime': datetime(2015, 1, 1), 'state': 'ACTIVE'|'DISABLED', 'targetAction': { 'createSnapshot': { 'namespaceName': 'string', 'retentionPeriod': 123, 'snapshotNamePrefix': 'string', 'tags': [ { 'key': 'string', 'value': 'string' }, ] } } } } **Response Structure** * *(dict) --* * **scheduledAction** *(dict) --* The deleted scheduled action object. * **endTime** *(datetime) --* The end time of * **namespaceName** *(string) --* The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger. * **nextInvocations** *(list) --* An array of timestamps of when the next scheduled actions will trigger. * *(datetime) --* * **roleArn** *(string) --* The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide * **schedule** *(dict) --* The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. * Format of at timestamp is "yyyy-mm-ddThh:mm:ss". For example, "2016-03-04T17:27:00". * Format of cron expression is "(Minutes Hours Day-of- month Month Day-of-week Year)". For example, ""(0 10 ? * MON *)"". For more information, see Cron Expressions in the *Amazon CloudWatch Events User Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "at", "cron". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **at** *(datetime) --* The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is "yyyy-mm-ddThh:mm:ss". For example, "2016-03-04T17:27:00". * **cron** *(string) --* The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. Format of cron expressions is "(Minutes Hours Day-of- month Month Day-of-week Year)". For example, ""(0 10 ? * MON *)"". For more information, see Cron Expressions in the *Amazon CloudWatch Events User Guide*. * **scheduledActionDescription** *(string) --* The description of the scheduled action. * **scheduledActionName** *(string) --* The name of the scheduled action. * **scheduledActionUuid** *(string) --* The uuid of the scheduled action. * **startTime** *(datetime) --* The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger. * **state** *(string) --* The state of the scheduled action. * **targetAction** *(dict) --* A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action. ""{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"" Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "createSnapshot". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **createSnapshot** *(dict) --* The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction. * **namespaceName** *(string) --* The name of the namespace for which you want to configure a scheduled action to create a snapshot. * **retentionPeriod** *(integer) --* The retention period of the snapshot created by the scheduled action. * **snapshotNamePrefix** *(string) --* A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created. * **tags** *(list) --* An array of Tag objects to associate with the snapshot. * *(dict) --* A map of key-value pairs. * **key** *(string) --* The key to use in the tag. * **value** *(string) --* The value of the tag. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / delete_endpoint_access delete_endpoint_access ********************** RedshiftServerless.Client.delete_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' ) Parameters: **endpointName** (*string*) -- **[REQUIRED]** The name of the VPC endpoint to delete. Return type: dict Returns: **Response Syntax** { 'endpoint': { 'address': 'string', 'endpointArn': 'string', 'endpointCreateTime': datetime(2015, 1, 1), 'endpointName': 'string', 'endpointStatus': 'string', 'port': 123, 'subnetIds': [ 'string', ], 'vpcEndpoint': { 'networkInterfaces': [ { 'availabilityZone': 'string', 'ipv6Address': 'string', 'networkInterfaceId': 'string', 'privateIpAddress': 'string', 'subnetId': 'string' }, ], 'vpcEndpointId': 'string', 'vpcId': 'string' }, 'vpcSecurityGroups': [ { 'status': 'string', 'vpcSecurityGroupId': 'string' }, ], 'workgroupName': 'string' } } **Response Structure** * *(dict) --* * **endpoint** *(dict) --* The deleted 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. * *(string) --* * **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. * **ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / get_usage_limit get_usage_limit *************** RedshiftServerless.Client.get_usage_limit(**kwargs) Returns information about a usage limit. See also: AWS API Documentation **Request Syntax** response = client.get_usage_limit( usageLimitId='string' ) Parameters: **usageLimitId** (*string*) -- **[REQUIRED]** The unique identifier of the usage limit to return information for. Return type: dict Returns: **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / delete_snapshot_copy_configuration delete_snapshot_copy_configuration ********************************** RedshiftServerless.Client.delete_snapshot_copy_configuration(**kwargs) Deletes a snapshot copy configuration See also: AWS API Documentation **Request Syntax** response = client.delete_snapshot_copy_configuration( snapshotCopyConfigurationId='string' ) Parameters: **snapshotCopyConfigurationId** (*string*) -- **[REQUIRED]** The ID of the snapshot copy configuration to delete. Return type: dict Returns: **Response Syntax** { 'snapshotCopyConfiguration': { 'destinationKmsKeyId': 'string', 'destinationRegion': 'string', 'namespaceName': 'string', 'snapshotCopyConfigurationArn': 'string', 'snapshotCopyConfigurationId': 'string', 'snapshotRetentionPeriod': 123 } } **Response Structure** * *(dict) --* * **snapshotCopyConfiguration** *(dict) --* The deleted snapshot copy configuration object. * **destinationKmsKeyId** *(string) --* The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region. * **destinationRegion** *(string) --* The destination Amazon Web Services Region to copy snapshots to. * **namespaceName** *(string) --* The name of the namespace to copy snapshots from in the source Amazon Web Services Region. * **snapshotCopyConfigurationArn** *(string) --* The ARN of the snapshot copy configuration object. * **snapshotCopyConfigurationId** *(string) --* The ID of the snapshot copy configuration object. * **snapshotRetentionPeriod** *(integer) --* The retention period of snapshots that are copied to the destination Amazon Web Services Region. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" RedshiftServerless / Client / convert_recovery_point_to_snapshot convert_recovery_point_to_snapshot ********************************** RedshiftServerless.Client.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' }, ] ) Parameters: * **recoveryPointId** (*string*) -- **[REQUIRED]** The unique identifier of the recovery point. * **retentionPeriod** (*integer*) -- How long to retain the snapshot. * **snapshotName** (*string*) -- **[REQUIRED]** The name of the snapshot. * **tags** (*list*) -- An array of Tag objects to associate with the created snapshot. * *(dict) --* A map of key-value pairs. * **key** *(string) --* **[REQUIRED]** The key to use in the tag. * **value** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **Response Syntax** { 'snapshot': { 'accountsWithProvisionedRestoreAccess': [ 'string', ], 'accountsWithRestoreAccess': [ 'string', ], 'actualIncrementalBackupSizeInMegaBytes': 123.0, 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * *(string) --* * **accountsWithRestoreAccess** *(list) --* All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace. * *(string) --* * **actualIncrementalBackupSizeInMegaBytes** *(float) --* The size of the incremental backup in megabytes. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.TooManyTagsException" * "RedshiftServerless.Client.exceptions.ServiceQuotaExceededExcept ion" RedshiftServerless / Client / create_scheduled_action create_scheduled_action *********************** RedshiftServerless.Client.create_scheduled_action(**kwargs) Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the "CreateSnapshot" API operation. See also: AWS API Documentation **Request Syntax** response = client.create_scheduled_action( enabled=True|False, endTime=datetime(2015, 1, 1), namespaceName='string', roleArn='string', schedule={ 'at': datetime(2015, 1, 1), 'cron': 'string' }, scheduledActionDescription='string', scheduledActionName='string', startTime=datetime(2015, 1, 1), targetAction={ 'createSnapshot': { 'namespaceName': 'string', 'retentionPeriod': 123, 'snapshotNamePrefix': 'string', 'tags': [ { 'key': 'string', 'value': 'string' }, ] } } ) Parameters: * **enabled** (*boolean*) -- Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about "state" of the scheduled action, see ScheduledAction. * **endTime** (*datetime*) -- The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger. * **namespaceName** (*string*) -- **[REQUIRED]** The name of the namespace for which to create a scheduled action. * **roleArn** (*string*) -- **[REQUIRED]** The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide * **schedule** (*dict*) -- **[REQUIRED]** The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. * Format of at timestamp is "yyyy-mm-ddThh:mm:ss". For example, "2016-03-04T17:27:00". * Format of cron expression is "(Minutes Hours Day-of-month Month Day-of-week Year)". For example, ""(0 10 ? * MON *)"". For more information, see Cron Expressions in the *Amazon CloudWatch Events User Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "at", "cron". * **at** *(datetime) --* The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is "yyyy-mm-ddThh:mm:ss". For example, "2016-03-04T17:27:00". * **cron** *(string) --* The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. Format of cron expressions is "(Minutes Hours Day-of-month Month Day-of-week Year)". For example, ""(0 10 ? * MON *)"". For more information, see Cron Expressions in the *Amazon CloudWatch Events User Guide*. * **scheduledActionDescription** (*string*) -- The description of the scheduled action. * **scheduledActionName** (*string*) -- **[REQUIRED]** The name of the scheduled action. * **startTime** (*datetime*) -- The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger. * **targetAction** (*dict*) -- **[REQUIRED]** A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action. ""{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"" Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "createSnapshot". * **createSnapshot** *(dict) --* The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction. * **namespaceName** *(string) --* **[REQUIRED]** The name of the namespace for which you want to configure a scheduled action to create a snapshot. * **retentionPeriod** *(integer) --* The retention period of the snapshot created by the scheduled action. * **snapshotNamePrefix** *(string) --* **[REQUIRED]** A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created. * **tags** *(list) --* An array of Tag objects to associate with the snapshot. * *(dict) --* A map of key-value pairs. * **key** *(string) --* **[REQUIRED]** The key to use in the tag. * **value** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **Response Syntax** { 'scheduledAction': { 'endTime': datetime(2015, 1, 1), 'namespaceName': 'string', 'nextInvocations': [ datetime(2015, 1, 1), ], 'roleArn': 'string', 'schedule': { 'at': datetime(2015, 1, 1), 'cron': 'string' }, 'scheduledActionDescription': 'string', 'scheduledActionName': 'string', 'scheduledActionUuid': 'string', 'startTime': datetime(2015, 1, 1), 'state': 'ACTIVE'|'DISABLED', 'targetAction': { 'createSnapshot': { 'namespaceName': 'string', 'retentionPeriod': 123, 'snapshotNamePrefix': 'string', 'tags': [ { 'key': 'string', 'value': 'string' }, ] } } } } **Response Structure** * *(dict) --* * **scheduledAction** *(dict) --* The returned "ScheduledAction" object that describes the properties of a scheduled action. * **endTime** *(datetime) --* The end time of * **namespaceName** *(string) --* The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger. * **nextInvocations** *(list) --* An array of timestamps of when the next scheduled actions will trigger. * *(datetime) --* * **roleArn** *(string) --* The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide * **schedule** *(dict) --* The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. * Format of at timestamp is "yyyy-mm-ddThh:mm:ss". For example, "2016-03-04T17:27:00". * Format of cron expression is "(Minutes Hours Day-of- month Month Day-of-week Year)". For example, ""(0 10 ? * MON *)"". For more information, see Cron Expressions in the *Amazon CloudWatch Events User Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "at", "cron". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **at** *(datetime) --* The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is "yyyy-mm-ddThh:mm:ss". For example, "2016-03-04T17:27:00". * **cron** *(string) --* The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. Format of cron expressions is "(Minutes Hours Day-of- month Month Day-of-week Year)". For example, ""(0 10 ? * MON *)"". For more information, see Cron Expressions in the *Amazon CloudWatch Events User Guide*. * **scheduledActionDescription** *(string) --* The description of the scheduled action. * **scheduledActionName** *(string) --* The name of the scheduled action. * **scheduledActionUuid** *(string) --* The uuid of the scheduled action. * **startTime** *(datetime) --* The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger. * **state** *(string) --* The state of the scheduled action. * **targetAction** *(dict) --* A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action. ""{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"" Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "createSnapshot". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **createSnapshot** *(dict) --* The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction. * **namespaceName** *(string) --* The name of the namespace for which you want to configure a scheduled action to create a snapshot. * **retentionPeriod** *(integer) --* The retention period of the snapshot created by the scheduled action. * **snapshotNamePrefix** *(string) --* A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created. * **tags** *(list) --* An array of Tag objects to associate with the snapshot. * *(dict) --* A map of key-value pairs. * **key** *(string) --* The key to use in the tag. * **value** *(string) --* The value of the tag. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / list_recovery_points list_recovery_points ******************** RedshiftServerless.Client.list_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) ) Parameters: * **endTime** (*datetime*) -- The time when creation of the recovery point finished. * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to display the next page of results. * **namespaceArn** (*string*) -- The Amazon Resource Name (ARN) of the namespace from which to list recovery points. * **namespaceName** (*string*) -- The name of the namespace to list recovery points for. * **nextToken** (*string*) -- If your initial "ListRecoveryPoints" operation returns a "nextToken", you can include the returned "nextToken" in following "ListRecoveryPoints" operations, which returns results in the next page. * **startTime** (*datetime*) -- The time when the recovery point's creation was initiated. Return type: dict Returns: **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / update_scheduled_action update_scheduled_action *********************** RedshiftServerless.Client.update_scheduled_action(**kwargs) Updates a scheduled action. See also: AWS API Documentation **Request Syntax** response = client.update_scheduled_action( enabled=True|False, endTime=datetime(2015, 1, 1), roleArn='string', schedule={ 'at': datetime(2015, 1, 1), 'cron': 'string' }, scheduledActionDescription='string', scheduledActionName='string', startTime=datetime(2015, 1, 1), targetAction={ 'createSnapshot': { 'namespaceName': 'string', 'retentionPeriod': 123, 'snapshotNamePrefix': 'string', 'tags': [ { 'key': 'string', 'value': 'string' }, ] } } ) Parameters: * **enabled** (*boolean*) -- Specifies whether to enable the scheduled action. * **endTime** (*datetime*) -- The end time in UTC of the scheduled action to update. * **roleArn** (*string*) -- The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide * **schedule** (*dict*) -- The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. * Format of at timestamp is "yyyy-mm-ddThh:mm:ss". For example, "2016-03-04T17:27:00". * Format of cron expression is "(Minutes Hours Day-of-month Month Day-of-week Year)". For example, ""(0 10 ? * MON *)"". For more information, see Cron Expressions in the *Amazon CloudWatch Events User Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "at", "cron". * **at** *(datetime) --* The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is "yyyy-mm-ddThh:mm:ss". For example, "2016-03-04T17:27:00". * **cron** *(string) --* The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. Format of cron expressions is "(Minutes Hours Day-of-month Month Day-of-week Year)". For example, ""(0 10 ? * MON *)"". For more information, see Cron Expressions in the *Amazon CloudWatch Events User Guide*. * **scheduledActionDescription** (*string*) -- The descripion of the scheduled action to update to. * **scheduledActionName** (*string*) -- **[REQUIRED]** The name of the scheduled action to update to. * **startTime** (*datetime*) -- The start time in UTC of the scheduled action to update to. * **targetAction** (*dict*) -- A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action. ""{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"" Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "createSnapshot". * **createSnapshot** *(dict) --* The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction. * **namespaceName** *(string) --* **[REQUIRED]** The name of the namespace for which you want to configure a scheduled action to create a snapshot. * **retentionPeriod** *(integer) --* The retention period of the snapshot created by the scheduled action. * **snapshotNamePrefix** *(string) --* **[REQUIRED]** A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created. * **tags** *(list) --* An array of Tag objects to associate with the snapshot. * *(dict) --* A map of key-value pairs. * **key** *(string) --* **[REQUIRED]** The key to use in the tag. * **value** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **Response Syntax** { 'scheduledAction': { 'endTime': datetime(2015, 1, 1), 'namespaceName': 'string', 'nextInvocations': [ datetime(2015, 1, 1), ], 'roleArn': 'string', 'schedule': { 'at': datetime(2015, 1, 1), 'cron': 'string' }, 'scheduledActionDescription': 'string', 'scheduledActionName': 'string', 'scheduledActionUuid': 'string', 'startTime': datetime(2015, 1, 1), 'state': 'ACTIVE'|'DISABLED', 'targetAction': { 'createSnapshot': { 'namespaceName': 'string', 'retentionPeriod': 123, 'snapshotNamePrefix': 'string', 'tags': [ { 'key': 'string', 'value': 'string' }, ] } } } } **Response Structure** * *(dict) --* * **scheduledAction** *(dict) --* The ScheduledAction object that was updated. * **endTime** *(datetime) --* The end time of * **namespaceName** *(string) --* The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger. * **nextInvocations** *(list) --* An array of timestamps of when the next scheduled actions will trigger. * *(datetime) --* * **roleArn** *(string) --* The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide * **schedule** *(dict) --* The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. * Format of at timestamp is "yyyy-mm-ddThh:mm:ss". For example, "2016-03-04T17:27:00". * Format of cron expression is "(Minutes Hours Day-of- month Month Day-of-week Year)". For example, ""(0 10 ? * MON *)"". For more information, see Cron Expressions in the *Amazon CloudWatch Events User Guide*. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "at", "cron". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **at** *(datetime) --* The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is "yyyy-mm-ddThh:mm:ss". For example, "2016-03-04T17:27:00". * **cron** *(string) --* The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. Format of cron expressions is "(Minutes Hours Day-of- month Month Day-of-week Year)". For example, ""(0 10 ? * MON *)"". For more information, see Cron Expressions in the *Amazon CloudWatch Events User Guide*. * **scheduledActionDescription** *(string) --* The description of the scheduled action. * **scheduledActionName** *(string) --* The name of the scheduled action. * **scheduledActionUuid** *(string) --* The uuid of the scheduled action. * **startTime** *(datetime) --* The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger. * **state** *(string) --* The state of the scheduled action. * **targetAction** *(dict) --* A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action. ""{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"" Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "createSnapshot". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **createSnapshot** *(dict) --* The parameters that you can use to configure a scheduled action to create a snapshot. For more information about creating a scheduled action, see CreateScheduledAction. * **namespaceName** *(string) --* The name of the namespace for which you want to configure a scheduled action to create a snapshot. * **retentionPeriod** *(integer) --* The retention period of the snapshot created by the scheduled action. * **snapshotNamePrefix** *(string) --* A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created. * **tags** *(list) --* An array of Tag objects to associate with the snapshot. * *(dict) --* A map of key-value pairs. * **key** *(string) --* The key to use in the tag. * **value** *(string) --* The value of the tag. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / list_snapshot_copy_configurations list_snapshot_copy_configurations ********************************* RedshiftServerless.Client.list_snapshot_copy_configurations(**kwargs) Returns a list of snapshot copy configurations. See also: AWS API Documentation **Request Syntax** response = client.list_snapshot_copy_configurations( maxResults=123, namespaceName='string', nextToken='string' ) Parameters: * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to display the next page of results. * **namespaceName** (*string*) -- The namespace from which to list all snapshot copy configurations. * **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. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'snapshotCopyConfigurations': [ { 'destinationKmsKeyId': 'string', 'destinationRegion': 'string', 'namespaceName': 'string', 'snapshotCopyConfigurationArn': 'string', 'snapshotCopyConfigurationId': 'string', 'snapshotRetentionPeriod': 123 }, ] } **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. * **snapshotCopyConfigurations** *(list) --* All of the returned snapshot copy configurations. * *(dict) --* The object that you configure to copy snapshots from one namespace to a namespace in another Amazon Web Services Region. * **destinationKmsKeyId** *(string) --* The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region. * **destinationRegion** *(string) --* The destination Amazon Web Services Region to copy snapshots to. * **namespaceName** *(string) --* The name of the namespace to copy snapshots from in the source Amazon Web Services Region. * **snapshotCopyConfigurationArn** *(string) --* The ARN of the snapshot copy configuration object. * **snapshotCopyConfigurationId** *(string) --* The ID of the snapshot copy configuration object. * **snapshotRetentionPeriod** *(integer) --* The retention period of snapshots that are copied to the destination Amazon Web Services Region. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.InvalidPaginationException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / get_custom_domain_association get_custom_domain_association ***************************** RedshiftServerless.Client.get_custom_domain_association(**kwargs) Gets information about a specific custom domain association. See also: AWS API Documentation **Request Syntax** response = client.get_custom_domain_association( customDomainName='string', workgroupName='string' ) Parameters: * **customDomainName** (*string*) -- **[REQUIRED]** The custom domain name associated with the workgroup. * **workgroupName** (*string*) -- **[REQUIRED]** The name of the workgroup associated with the database. Return type: dict Returns: **Response Syntax** { 'customDomainCertificateArn': 'string', 'customDomainCertificateExpiryTime': datetime(2015, 1, 1), 'customDomainName': 'string', 'workgroupName': 'string' } **Response Structure** * *(dict) --* * **customDomainCertificateArn** *(string) --* The custom domain name’s certificate Amazon resource name (ARN). * **customDomainCertificateExpiryTime** *(datetime) --* The expiration time for the certificate. * **customDomainName** *(string) --* The custom domain name associated with the workgroup. * **workgroupName** *(string) --* The name of the workgroup associated with the database. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / restore_table_from_recovery_point restore_table_from_recovery_point ********************************* RedshiftServerless.Client.restore_table_from_recovery_point(**kwargs) Restores a table from a recovery point to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys. See also: AWS API Documentation **Request Syntax** response = client.restore_table_from_recovery_point( activateCaseSensitiveIdentifier=True|False, namespaceName='string', newTableName='string', recoveryPointId='string', sourceDatabaseName='string', sourceSchemaName='string', sourceTableName='string', targetDatabaseName='string', targetSchemaName='string', workgroupName='string' ) Parameters: * **activateCaseSensitiveIdentifier** (*boolean*) -- Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false. * **namespaceName** (*string*) -- **[REQUIRED]** Namespace of the recovery point to restore from. * **newTableName** (*string*) -- **[REQUIRED]** The name of the table to create from the restore operation. * **recoveryPointId** (*string*) -- **[REQUIRED]** The ID of the recovery point to restore the table from. * **sourceDatabaseName** (*string*) -- **[REQUIRED]** The name of the source database that contains the table being restored. * **sourceSchemaName** (*string*) -- The name of the source schema that contains the table being restored. * **sourceTableName** (*string*) -- **[REQUIRED]** The name of the source table being restored. * **targetDatabaseName** (*string*) -- The name of the database to restore the table to. * **targetSchemaName** (*string*) -- The name of the schema to restore the table to. * **workgroupName** (*string*) -- **[REQUIRED]** The workgroup to restore the table to. Return type: dict Returns: **Response Syntax** { 'tableRestoreStatus': { 'message': 'string', 'namespaceName': 'string', 'newTableName': 'string', 'progressInMegaBytes': 123, 'recoveryPointId': 'string', '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) --* Contains information about a table restore request. * **message** *(string) --* A message that explains the returned status. For example, if the status of the operation is "FAILED", the message explains why the operation failed. * **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). * **recoveryPointId** *(string) --* The ID of the recovery point being restored from. * **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 are "SUCCEEDED", "FAILED", "CANCELED", "PENDING", and "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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / update_custom_domain_association update_custom_domain_association ******************************** RedshiftServerless.Client.update_custom_domain_association(**kwargs) Updates an Amazon Redshift Serverless certificate associated with a custom domain. See also: AWS API Documentation **Request Syntax** response = client.update_custom_domain_association( customDomainCertificateArn='string', customDomainName='string', workgroupName='string' ) Parameters: * **customDomainCertificateArn** (*string*) -- **[REQUIRED]** The custom domain name’s certificate Amazon resource name (ARN). This is optional. * **customDomainName** (*string*) -- **[REQUIRED]** The custom domain name associated with the workgroup. * **workgroupName** (*string*) -- **[REQUIRED]** The name of the workgroup associated with the database. Return type: dict Returns: **Response Syntax** { 'customDomainCertificateArn': 'string', 'customDomainCertificateExpiryTime': datetime(2015, 1, 1), 'customDomainName': 'string', 'workgroupName': 'string' } **Response Structure** * *(dict) --* * **customDomainCertificateArn** *(string) --* The custom domain name’s certificate Amazon resource name (ARN). * **customDomainCertificateExpiryTime** *(datetime) --* The expiration time for the certificate. * **customDomainName** *(string) --* The custom domain name associated with the workgroup. * **workgroupName** *(string) --* The name of the workgroup associated with the database. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / get_track get_track ********* RedshiftServerless.Client.get_track(**kwargs) Get the Redshift Serverless version for a specified track. See also: AWS API Documentation **Request Syntax** response = client.get_track( trackName='string' ) Parameters: **trackName** (*string*) -- **[REQUIRED]** The name of the track of which its version is fetched. Return type: dict Returns: **Response Syntax** { 'track': { 'trackName': 'string', 'updateTargets': [ { 'trackName': 'string', 'workgroupVersion': 'string' }, ], 'workgroupVersion': 'string' } } **Response Structure** * *(dict) --* * **track** *(dict) --* The version of the specified track. * **trackName** *(string) --* The name of the track. Valid values are "current" and "trailing". * **updateTargets** *(list) --* An array of "UpdateTarget" objects to update with the track. * *(dict) --* A track that you can switch the current track to. * **trackName** *(string) --* The name of the new track. * **workgroupVersion** *(string) --* The workgroup version for the new track. * **workgroupVersion** *(string) --* The workgroup version number for the workgroup release. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / delete_usage_limit delete_usage_limit ****************** RedshiftServerless.Client.delete_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' ) Parameters: **usageLimitId** (*string*) -- **[REQUIRED]** The unique identifier of the usage limit to delete. Return type: dict Returns: **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 deleted 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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / get_snapshot get_snapshot ************ RedshiftServerless.Client.get_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' ) Parameters: * **ownerAccount** (*string*) -- The owner Amazon Web Services account of a snapshot shared with another user. * **snapshotArn** (*string*) -- The Amazon Resource Name (ARN) of the snapshot to return. * **snapshotName** (*string*) -- The name of the snapshot to return. Return type: dict Returns: **Response Syntax** { 'snapshot': { 'accountsWithProvisionedRestoreAccess': [ 'string', ], 'accountsWithRestoreAccess': [ 'string', ], 'actualIncrementalBackupSizeInMegaBytes': 123.0, 'adminPasswordSecretArn': 'string', 'adminPasswordSecretKmsKeyId': 'string', '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. * *(string) --* * **accountsWithRestoreAccess** *(list) --* All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace. * *(string) --* * **actualIncrementalBackupSizeInMegaBytes** *(float) --* The size of the incremental backup in megabytes. * **adminPasswordSecretArn** *(string) --* The Amazon Resource Name (ARN) for the namespace's admin user credentials secret. * **adminPasswordSecretKmsKeyId** *(string) --* The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / tag_resource tag_resource ************ RedshiftServerless.Client.tag_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' }, ] ) Parameters: * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to tag. * **tags** (*list*) -- **[REQUIRED]** The map of the key-value pairs used to tag the resource. * *(dict) --* A map of key-value pairs. * **key** *(string) --* **[REQUIRED]** The key to use in the tag. * **value** *(string) --* **[REQUIRED]** The value of the tag. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.TooManyTagsException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / create_snapshot_copy_configuration create_snapshot_copy_configuration ********************************** RedshiftServerless.Client.create_snapshot_copy_configuration(**kwargs) Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = client.create_snapshot_copy_configuration( destinationKmsKeyId='string', destinationRegion='string', namespaceName='string', snapshotRetentionPeriod=123 ) Parameters: * **destinationKmsKeyId** (*string*) -- The KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region. * **destinationRegion** (*string*) -- **[REQUIRED]** The destination Amazon Web Services Region that you want to copy snapshots to. * **namespaceName** (*string*) -- **[REQUIRED]** The name of the namespace to copy snapshots from. * **snapshotRetentionPeriod** (*integer*) -- The retention period of the snapshots that you copy to the destination Amazon Web Services Region. Return type: dict Returns: **Response Syntax** { 'snapshotCopyConfiguration': { 'destinationKmsKeyId': 'string', 'destinationRegion': 'string', 'namespaceName': 'string', 'snapshotCopyConfigurationArn': 'string', 'snapshotCopyConfigurationId': 'string', 'snapshotRetentionPeriod': 123 } } **Response Structure** * *(dict) --* * **snapshotCopyConfiguration** *(dict) --* The snapshot copy configuration object that is returned. * **destinationKmsKeyId** *(string) --* The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region. * **destinationRegion** *(string) --* The destination Amazon Web Services Region to copy snapshots to. * **namespaceName** *(string) --* The name of the namespace to copy snapshots from in the source Amazon Web Services Region. * **snapshotCopyConfigurationArn** *(string) --* The ARN of the snapshot copy configuration object. * **snapshotCopyConfigurationId** *(string) --* The ID of the snapshot copy configuration object. * **snapshotRetentionPeriod** *(integer) --* The retention period of snapshots that are copied to the destination Amazon Web Services Region. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" * "RedshiftServerless.Client.exceptions.ServiceQuotaExceededExcept ion" RedshiftServerless / Client / create_usage_limit create_usage_limit ****************** RedshiftServerless.Client.create_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' ) Parameters: * **amount** (*integer*) -- **[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. * **breachAction** (*string*) -- The action that Amazon Redshift Serverless takes when the limit is reached. The default is log. * **period** (*string*) -- The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly. * **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for. * **usageType** (*string*) -- **[REQUIRED]** The type of Amazon Redshift Serverless usage to create a usage limit for. Return type: dict Returns: **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.ServiceQuotaExceededExcept ion" RedshiftServerless / Client / create_endpoint_access create_endpoint_access ********************** RedshiftServerless.Client.create_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', ownerAccount='string', subnetIds=[ 'string', ], vpcSecurityGroupIds=[ 'string', ], workgroupName='string' ) Parameters: * **endpointName** (*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. * **ownerAccount** (*string*) -- The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup. * **subnetIds** (*list*) -- **[REQUIRED]** The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint. * *(string) --* * **vpcSecurityGroupIds** (*list*) -- The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint. * *(string) --* * **workgroupName** (*string*) -- **[REQUIRED]** The name of the workgroup to associate with the VPC endpoint. Return type: dict Returns: **Response Syntax** { 'endpoint': { 'address': 'string', 'endpointArn': 'string', 'endpointCreateTime': datetime(2015, 1, 1), 'endpointName': 'string', 'endpointStatus': 'string', 'port': 123, 'subnetIds': [ 'string', ], 'vpcEndpoint': { 'networkInterfaces': [ { 'availabilityZone': 'string', 'ipv6Address': '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. * *(string) --* * **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. * **ipv6Address** *(string) --* The IPv6 address of the network interface within the subnet. * **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.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" * "RedshiftServerless.Client.exceptions.ServiceQuotaExceededExcept ion" RedshiftServerless / Client / delete_resource_policy delete_resource_policy ********************** RedshiftServerless.Client.delete_resource_policy(**kwargs) Deletes the specified resource policy. See also: AWS API Documentation **Request Syntax** response = client.delete_resource_policy( resourceArn='string' ) Parameters: **resourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the policy to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" RedshiftServerless / Client / get_reservation_offering get_reservation_offering ************************ RedshiftServerless.Client.get_reservation_offering(**kwargs) Returns the reservation offering. The offering determines the payment schedule for the reservation. See also: AWS API Documentation **Request Syntax** response = client.get_reservation_offering( offeringId='string' ) Parameters: **offeringId** (*string*) -- **[REQUIRED]** The identifier for the offering.. Return type: dict Returns: **Response Syntax** { 'reservationOffering': { 'currencyCode': 'string', 'duration': 123, 'hourlyCharge': 123.0, 'offeringId': 'string', 'offeringType': 'ALL_UPFRONT'|'NO_UPFRONT', 'upfrontCharge': 123.0 } } **Response Structure** * *(dict) --* * **reservationOffering** *(dict) --* The returned reservation offering. The offering determines the payment schedule for the reservation. * **currencyCode** *(string) --* The currency code for the offering. * **duration** *(integer) --* The duration, in seconds, for which the reservation reserves the RPUs. * **hourlyCharge** *(float) --* The rate you are charged for each hour the reservation is active. * **offeringId** *(string) --* The offering identifier. * **offeringType** *(string) --* Determines the payment schedule for the reservation. * **upfrontCharge** *(float) --* The up-front price you are charged for the reservation. **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.ThrottlingException" RedshiftServerless / Client / delete_custom_domain_association delete_custom_domain_association ******************************** RedshiftServerless.Client.delete_custom_domain_association(**kwargs) Deletes a custom domain association for Amazon Redshift Serverless. See also: AWS API Documentation **Request Syntax** response = client.delete_custom_domain_association( customDomainName='string', workgroupName='string' ) Parameters: * **customDomainName** (*string*) -- **[REQUIRED]** The custom domain name associated with the workgroup. * **workgroupName** (*string*) -- **[REQUIRED]** The name of the workgroup associated with the database. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "RedshiftServerless.Client.exceptions.InternalServerException" * "RedshiftServerless.Client.exceptions.ResourceNotFoundException" * "RedshiftServerless.Client.exceptions.ConflictException" * "RedshiftServerless.Client.exceptions.ValidationException" * "RedshiftServerless.Client.exceptions.AccessDeniedException" * "RedshiftServerless.Client.exceptions.ThrottlingException"