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 .

client = session.create_client('redshift-serverless')

These are the available methods:

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.
close()

Closes underlying endpoint connections.

convert_recovery_point_to_snapshot(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.convert_recovery_point_to_snapshot(
    recoveryPointId='string',
    retentionPeriod=123,
    snapshotName='string'
)
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.

Return type

dict

Returns

Response Syntax

{
    'snapshot': {
        'accountsWithProvisionedRestoreAccess': [
            'string',
        ],
        'accountsWithRestoreAccess': [
            'string',
        ],
        'actualIncrementalBackupSizeInMegaBytes': 123.0,
        'adminUsername': 'string',
        'backupProgressInMegaBytes': 123.0,
        'currentBackupRateInMegaBytesPerSecond': 123.0,
        'elapsedTimeInSeconds': 123,
        'estimatedSecondsToCompletion': 123,
        'kmsKeyId': 'string',
        'namespaceArn': 'string',
        'namespaceName': 'string',
        'ownerAccount': 'string',
        'snapshotArn': 'string',
        'snapshotCreateTime': datetime(2015, 1, 1),
        'snapshotName': 'string',
        'snapshotRemainingDays': 123,
        'snapshotRetentionPeriod': 123,
        'snapshotRetentionStartTime': datetime(2015, 1, 1),
        'status': 'AVAILABLE'|'CREATING'|'DELETED'|'CANCELLED'|'FAILED'|'COPYING',
        'totalBackupSizeInMegaBytes': 123.0
    }
}

Response Structure

  • (dict) --

    • snapshot (dict) --

      The snapshot converted from the recovery point.

      • accountsWithProvisionedRestoreAccess (list) --

        All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

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

      • 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

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',
    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.

  • 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',
                    '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.

            • 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

create_namespace(**kwargs)

Creates a namespace in Amazon Redshift Serverless.

See also: AWS API Documentation

Request Syntax

response = client.create_namespace(
    adminUserPassword='string',
    adminUsername='string',
    dbName='string',
    defaultIamRoleArn='string',
    iamRoles=[
        'string',
    ],
    kmsKeyId='string',
    logExports=[
        'useractivitylog'|'userlog'|'connectionlog',
    ],
    namespaceName='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters
  • adminUserPassword (string) -- The password of the administrator for the first database created in the namespace.
  • 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) --
  • namespaceName (string) --

    [REQUIRED]

    The name of the namespace.

  • 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': {
        'adminUsername': 'string',
        'creationDate': datetime(2015, 1, 1),
        'dbName': 'string',
        'defaultIamRoleArn': 'string',
        'iamRoles': [
            'string',
        ],
        'kmsKeyId': 'string',
        'logExports': [
            'useractivitylog'|'userlog'|'connectionlog',
        ],
        'namespaceArn': 'string',
        'namespaceId': 'string',
        'namespaceName': 'string',
        'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
    }
}

Response Structure

  • (dict) --

    • namespace (dict) --

      The created namespace object.

      • adminUsername (string) --

        The username of the administrator for the first database created in the namespace.

      • creationDate (datetime) --

        The date of when the namespace was created.

      • dbName (string) --

        The name of the first database created in the namespace.

      • defaultIamRoleArn (string) --

        The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

      • iamRoles (list) --

        A list of IAM roles to associate with the namespace.

        • (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

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'
)
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.

Return type

dict

Returns

Response Syntax

{
    'snapshot': {
        'accountsWithProvisionedRestoreAccess': [
            'string',
        ],
        'accountsWithRestoreAccess': [
            'string',
        ],
        'actualIncrementalBackupSizeInMegaBytes': 123.0,
        'adminUsername': 'string',
        'backupProgressInMegaBytes': 123.0,
        'currentBackupRateInMegaBytesPerSecond': 123.0,
        'elapsedTimeInSeconds': 123,
        'estimatedSecondsToCompletion': 123,
        'kmsKeyId': 'string',
        'namespaceArn': 'string',
        'namespaceName': 'string',
        'ownerAccount': 'string',
        'snapshotArn': 'string',
        'snapshotCreateTime': datetime(2015, 1, 1),
        'snapshotName': 'string',
        'snapshotRemainingDays': 123,
        'snapshotRetentionPeriod': 123,
        'snapshotRetentionStartTime': datetime(2015, 1, 1),
        'status': 'AVAILABLE'|'CREATING'|'DELETED'|'CANCELLED'|'FAILED'|'COPYING',
        'totalBackupSizeInMegaBytes': 123.0
    }
}

Response Structure

  • (dict) --

    • snapshot (dict) --

      The created snapshot object.

      • accountsWithProvisionedRestoreAccess (list) --

        All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.

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

      • 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

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

create_workgroup(**kwargs)

Creates an workgroup in Amazon Redshift Serverless.

See also: AWS API Documentation

Request Syntax

response = client.create_workgroup(
    baseCapacity=123,
    configParameters=[
        {
            'parameterKey': 'string',
            'parameterValue': 'string'
        },
    ],
    enhancedVpcRouting=True|False,
    namespaceName='string',
    publiclyAccessible=True|False,
    securityGroupIds=[
        'string',
    ],
    subnetIds=[
        'string',
    ],
    tags=[
        {
            'key': 'string',
            'value': '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 more control over a serverless database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

    • (dict) --

      An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

      • parameterKey (string) --

        The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

      • parameterValue (string) --

        The value of the parameter to set.

  • 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.
  • namespaceName (string) --

    [REQUIRED]

    The name of the namespace to associate with 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.

  • 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),
        'endpoint': {
            'address': 'string',
            'port': 123,
            'vpcEndpoints': [
                {
                    'networkInterfaces': [
                        {
                            'availabilityZone': 'string',
                            'networkInterfaceId': 'string',
                            'privateIpAddress': 'string',
                            'subnetId': 'string'
                        },
                    ],
                    'vpcEndpointId': 'string',
                    'vpcId': 'string'
                },
            ]
        },
        'enhancedVpcRouting': True|False,
        'namespaceName': 'string',
        'publiclyAccessible': True|False,
        'securityGroupIds': [
            'string',
        ],
        'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
        'subnetIds': [
            'string',
        ],
        'workgroupArn': 'string',
        'workgroupId': 'string',
        'workgroupName': 'string'
    }
}

Response Structure

  • (dict) --

    • workgroup (dict) --

      The created workgroup object.

      • baseCapacity (integer) --

        The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

      • configParameters (list) --

        An array of parameters to set for finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

        • (dict) --

          An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

          • parameterKey (string) --

            The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

          • parameterValue (string) --

            The value of the parameter to set.

      • creationDate (datetime) --

        The creation date of the workgroup.

      • endpoint (dict) --

        The endpoint that is created from the workgroup.

        • address (string) --

          The DNS address of the VPC endpoint.

        • port (integer) --

          The port that Amazon Redshift Serverless listens on.

        • vpcEndpoints (list) --

          An array of VpcEndpoint objects.

          • (dict) --

            The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.

            • networkInterfaces (list) --

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • (dict) --

                Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

                • availabilityZone (string) --

                  The availability Zone.

                • networkInterfaceId (string) --

                  The unique identifier of the network interface.

                • privateIpAddress (string) --

                  The IPv4 address of the network interface within the subnet.

                • subnetId (string) --

                  The unique identifier of the subnet.

            • vpcEndpointId (string) --

              The connection endpoint ID for connecting to Amazon Redshift Serverless.

            • vpcId (string) --

              The VPC identifier that the endpoint is associated with.

      • enhancedVpcRouting (boolean) --

        The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

      • namespaceName (string) --

        The namespace the workgroup is associated with.

      • 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) --
      • workgroupArn (string) --

        The Amazon Resource Name (ARN) that links to the workgroup.

      • workgroupId (string) --

        The unique identifier of the workgroup.

      • workgroupName (string) --

        The name of the workgroup.

Exceptions

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',
                    '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.

            • 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

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': {
        'adminUsername': 'string',
        'creationDate': datetime(2015, 1, 1),
        'dbName': 'string',
        'defaultIamRoleArn': 'string',
        'iamRoles': [
            'string',
        ],
        'kmsKeyId': 'string',
        'logExports': [
            'useractivitylog'|'userlog'|'connectionlog',
        ],
        'namespaceArn': 'string',
        'namespaceId': 'string',
        'namespaceName': 'string',
        'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
    }
}

Response Structure

  • (dict) --

    • namespace (dict) --

      The deleted namespace object.

      • adminUsername (string) --

        The username of the administrator for the first database created in the namespace.

      • creationDate (datetime) --

        The date of when the namespace was created.

      • dbName (string) --

        The name of the first database created in the namespace.

      • defaultIamRoleArn (string) --

        The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

      • iamRoles (list) --

        A list of IAM roles to associate with the namespace.

        • (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

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

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,
        '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.

      • 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

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

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),
        'endpoint': {
            'address': 'string',
            'port': 123,
            'vpcEndpoints': [
                {
                    'networkInterfaces': [
                        {
                            'availabilityZone': 'string',
                            'networkInterfaceId': 'string',
                            'privateIpAddress': 'string',
                            'subnetId': 'string'
                        },
                    ],
                    'vpcEndpointId': 'string',
                    'vpcId': 'string'
                },
            ]
        },
        'enhancedVpcRouting': True|False,
        'namespaceName': 'string',
        'publiclyAccessible': True|False,
        'securityGroupIds': [
            'string',
        ],
        'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
        'subnetIds': [
            'string',
        ],
        'workgroupArn': 'string',
        'workgroupId': 'string',
        'workgroupName': '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 finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

        • (dict) --

          An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

          • parameterKey (string) --

            The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

          • parameterValue (string) --

            The value of the parameter to set.

      • creationDate (datetime) --

        The creation date of the workgroup.

      • endpoint (dict) --

        The endpoint that is created from the workgroup.

        • address (string) --

          The DNS address of the VPC endpoint.

        • port (integer) --

          The port that Amazon Redshift Serverless listens on.

        • vpcEndpoints (list) --

          An array of VpcEndpoint objects.

          • (dict) --

            The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.

            • networkInterfaces (list) --

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • (dict) --

                Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

                • availabilityZone (string) --

                  The availability Zone.

                • networkInterfaceId (string) --

                  The unique identifier of the network interface.

                • privateIpAddress (string) --

                  The IPv4 address of the network interface within the subnet.

                • subnetId (string) --

                  The unique identifier of the subnet.

            • vpcEndpointId (string) --

              The connection endpoint ID for connecting to Amazon Redshift Serverless.

            • vpcId (string) --

              The VPC identifier that the endpoint is associated with.

      • enhancedVpcRouting (boolean) --

        The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

      • namespaceName (string) --

        The namespace the workgroup is associated with.

      • 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) --
      • workgroupArn (string) --

        The Amazon Resource Name (ARN) that links to the workgroup.

      • workgroupId (string) --

        The unique identifier of the workgroup.

      • workgroupName (string) --

        The name of the workgroup.

Exceptions

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).

<p> The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources. </p> <p> If the <code>DbName</code> parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.</p>

See also: AWS API Documentation

Request Syntax

response = client.get_credentials(
    dbName='string',
    durationSeconds=123,
    workgroupName='string'
)
Parameters
  • 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 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) --

    [REQUIRED]

    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

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',
                    '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.

            • 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

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': {
        '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.

      • 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

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
L{botocore.paginate.Paginator}
Returns
A paginator object.
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': {
        'namespaceName': 'string',
        'recoveryPointCreateTime': datetime(2015, 1, 1),
        'recoveryPointId': 'string',
        'totalSizeInMegaBytes': 123.0,
        'workgroupName': 'string'
    }
}

Response Structure

  • (dict) --
    • recoveryPoint (dict) --

      The returned recovery point object.

      • 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

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

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,
        '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.

      • 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

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

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
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),
        'endpoint': {
            'address': 'string',
            'port': 123,
            'vpcEndpoints': [
                {
                    'networkInterfaces': [
                        {
                            'availabilityZone': 'string',
                            'networkInterfaceId': 'string',
                            'privateIpAddress': 'string',
                            'subnetId': 'string'
                        },
                    ],
                    'vpcEndpointId': 'string',
                    'vpcId': 'string'
                },
            ]
        },
        'enhancedVpcRouting': True|False,
        'namespaceName': 'string',
        'publiclyAccessible': True|False,
        'securityGroupIds': [
            'string',
        ],
        'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
        'subnetIds': [
            'string',
        ],
        'workgroupArn': 'string',
        'workgroupId': 'string',
        'workgroupName': '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 finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

        • (dict) --

          An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

          • parameterKey (string) --

            The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

          • parameterValue (string) --

            The value of the parameter to set.

      • creationDate (datetime) --

        The creation date of the workgroup.

      • endpoint (dict) --

        The endpoint that is created from the workgroup.

        • address (string) --

          The DNS address of the VPC endpoint.

        • port (integer) --

          The port that Amazon Redshift Serverless listens on.

        • vpcEndpoints (list) --

          An array of VpcEndpoint objects.

          • (dict) --

            The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.

            • networkInterfaces (list) --

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • (dict) --

                Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

                • availabilityZone (string) --

                  The availability Zone.

                • networkInterfaceId (string) --

                  The unique identifier of the network interface.

                • privateIpAddress (string) --

                  The IPv4 address of the network interface within the subnet.

                • subnetId (string) --

                  The unique identifier of the subnet.

            • vpcEndpointId (string) --

              The connection endpoint ID for connecting to Amazon Redshift Serverless.

            • vpcId (string) --

              The VPC identifier that the endpoint is associated with.

      • enhancedVpcRouting (boolean) --

        The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

      • namespaceName (string) --

        The namespace the workgroup is associated with.

      • 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) --
      • workgroupArn (string) --

        The Amazon Resource Name (ARN) that links to the workgroup.

      • workgroupId (string) --

        The unique identifier of the workgroup.

      • workgroupName (string) --

        The name of the workgroup.

Exceptions

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',
    vpcId='string',
    workgroupName='string'
)
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.
  • nextToken (string) -- If your initial ListEndpointAccess operation returns a nextToken , you can include the returned nextToken in subsequent ListEndpointAccess operations, which returns results in the next page.
  • 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',
                        '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.

              • 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

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 get the next page of results.
  • nextToken (string) -- If your initial ListNamespaces operation returns a nextToken , you can include the returned nextToken in subsequent ListNamespaces operations, which returns results in the next page.
Return type

dict

Returns

Response Syntax

{
    'namespaces': [
        {
            'adminUsername': 'string',
            'creationDate': datetime(2015, 1, 1),
            'dbName': 'string',
            'defaultIamRoleArn': 'string',
            'iamRoles': [
                'string',
            ],
            'kmsKeyId': 'string',
            'logExports': [
                'useractivitylog'|'userlog'|'connectionlog',
            ],
            'namespaceArn': 'string',
            'namespaceId': 'string',
            'namespaceName': 'string',
            'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • namespaces (list) --

      The list of returned namespaces.

      • (dict) --

        A collection of database objects and users.

        • adminUsername (string) --

          The username of the administrator for the first database created in the namespace.

        • creationDate (datetime) --

          The date of when the namespace was created.

        • dbName (string) --

          The name of the first database created in the namespace.

        • defaultIamRoleArn (string) --

          The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

        • iamRoles (list) --

          A list of IAM roles to associate with the namespace.

          • (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

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,
    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 get the next page of results.
  • 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 subsequent 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': [
        {
            '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.

        • 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

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 get 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,
            '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.

        • 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

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

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 subsequent 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

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'
)
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.
  • nextToken (string) -- If your initial ListWorkgroups operation returns a nextToken , you can include the returned nextToken in subsequent ListNamespaces operations, which returns results in the next page.
Return type

dict

Returns

Response Syntax

{
    'nextToken': 'string',
    'workgroups': [
        {
            'baseCapacity': 123,
            'configParameters': [
                {
                    'parameterKey': 'string',
                    'parameterValue': 'string'
                },
            ],
            'creationDate': datetime(2015, 1, 1),
            'endpoint': {
                'address': 'string',
                'port': 123,
                'vpcEndpoints': [
                    {
                        'networkInterfaces': [
                            {
                                'availabilityZone': 'string',
                                'networkInterfaceId': 'string',
                                'privateIpAddress': 'string',
                                'subnetId': 'string'
                            },
                        ],
                        'vpcEndpointId': 'string',
                        'vpcId': 'string'
                    },
                ]
            },
            'enhancedVpcRouting': True|False,
            'namespaceName': 'string',
            'publiclyAccessible': True|False,
            'securityGroupIds': [
                'string',
            ],
            'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
            'subnetIds': [
                'string',
            ],
            'workgroupArn': 'string',
            'workgroupId': 'string',
            'workgroupName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.

    • workgroups (list) --

      The returned array of workgroups.

      • (dict) --

        The collection of computing resources from which an endpoint is created.

        • baseCapacity (integer) --

          The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

        • configParameters (list) --

          An array of parameters to set for finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

          • (dict) --

            An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

            • parameterKey (string) --

              The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

            • parameterValue (string) --

              The value of the parameter to set.

        • creationDate (datetime) --

          The creation date of the workgroup.

        • endpoint (dict) --

          The endpoint that is created from the workgroup.

          • address (string) --

            The DNS address of the VPC endpoint.

          • port (integer) --

            The port that Amazon Redshift Serverless listens on.

          • vpcEndpoints (list) --

            An array of VpcEndpoint objects.

            • (dict) --

              The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.

              • networkInterfaces (list) --

                One or more network interfaces of the endpoint. Also known as an interface endpoint.

                • (dict) --

                  Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

                  • availabilityZone (string) --

                    The availability Zone.

                  • networkInterfaceId (string) --

                    The unique identifier of the network interface.

                  • privateIpAddress (string) --

                    The IPv4 address of the network interface within the subnet.

                  • subnetId (string) --

                    The unique identifier of the subnet.

              • vpcEndpointId (string) --

                The connection endpoint ID for connecting to Amazon Redshift Serverless.

              • vpcId (string) --

                The VPC identifier that the endpoint is associated with.

        • enhancedVpcRouting (boolean) --

          The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

        • namespaceName (string) --

          The namespace the workgroup is associated with.

        • 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) --
        • workgroupArn (string) --

          The Amazon Resource Name (ARN) that links to the workgroup.

        • workgroupId (string) --

          The unique identifier of the workgroup.

        • workgroupName (string) --

          The name of the workgroup.

Exceptions

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

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': {
        'adminUsername': 'string',
        'creationDate': datetime(2015, 1, 1),
        'dbName': 'string',
        'defaultIamRoleArn': 'string',
        'iamRoles': [
            'string',
        ],
        'kmsKeyId': 'string',
        'logExports': [
            'useractivitylog'|'userlog'|'connectionlog',
        ],
        'namespaceArn': 'string',
        'namespaceId': 'string',
        'namespaceName': 'string',
        'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
    },
    'recoveryPointId': 'string'
}

Response Structure

  • (dict) --

    • namespace (dict) --

      The namespace that data was restored into.

      • adminUsername (string) --

        The username of the administrator for the first database created in the namespace.

      • creationDate (datetime) --

        The date of when the namespace was created.

      • dbName (string) --

        The name of the first database created in the namespace.

      • defaultIamRoleArn (string) --

        The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

      • iamRoles (list) --

        A list of IAM roles to associate with the namespace.

        • (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

restore_from_snapshot(**kwargs)

Restores a namespace from a snapshot.

See also: AWS API Documentation

Request Syntax

response = client.restore_from_snapshot(
    namespaceName='string',
    ownerAccount='string',
    snapshotArn='string',
    snapshotName='string',
    workgroupName='string'
)
Parameters
  • 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.
  • snapshotName (string) -- The name of the snapshot to restore from.
  • workgroupName (string) --

    [REQUIRED]

    The name of the workgroup used to restore the snapshot.

Return type

dict

Returns

Response Syntax

{
    'namespace': {
        'adminUsername': 'string',
        'creationDate': datetime(2015, 1, 1),
        'dbName': 'string',
        'defaultIamRoleArn': 'string',
        'iamRoles': [
            'string',
        ],
        'kmsKeyId': 'string',
        'logExports': [
            'useractivitylog'|'userlog'|'connectionlog',
        ],
        'namespaceArn': 'string',
        'namespaceId': 'string',
        'namespaceName': 'string',
        'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
    },
    'ownerAccount': 'string',
    'snapshotName': 'string'
}

Response Structure

  • (dict) --

    • namespace (dict) --

      A collection of database objects and users.

      • adminUsername (string) --

        The username of the administrator for the first database created in the namespace.

      • creationDate (datetime) --

        The date of when the namespace was created.

      • dbName (string) --

        The name of the first database created in the namespace.

      • defaultIamRoleArn (string) --

        The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

      • iamRoles (list) --

        A list of IAM roles to associate with the namespace.

        • (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

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

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

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',
                    '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.

            • 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

update_namespace(**kwargs)

Updates a namespace with the specified settings.

See also: AWS API Documentation

Request Syntax

response = client.update_namespace(
    adminUserPassword='string',
    adminUsername='string',
    defaultIamRoleArn='string',
    iamRoles=[
        'string',
    ],
    kmsKeyId='string',
    logExports=[
        'useractivitylog'|'userlog'|'connectionlog',
    ],
    namespaceName='string'
)
Parameters
  • adminUserPassword (string) -- The password of the administrator for the first database created in the namespace.
  • adminUsername (string) -- The username of the administrator for 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. The export types are userlog , connectionlog , and useractivitylog .

    • (string) --
  • namespaceName (string) --

    [REQUIRED]

    The name of the namespace.

Return type

dict

Returns

Response Syntax

{
    'namespace': {
        'adminUsername': 'string',
        'creationDate': datetime(2015, 1, 1),
        'dbName': 'string',
        'defaultIamRoleArn': 'string',
        'iamRoles': [
            'string',
        ],
        'kmsKeyId': 'string',
        'logExports': [
            'useractivitylog'|'userlog'|'connectionlog',
        ],
        'namespaceArn': 'string',
        'namespaceId': 'string',
        'namespaceName': 'string',
        'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
    }
}

Response Structure

  • (dict) --

    • namespace (dict) --

      A list of tag instances.

      • adminUsername (string) --

        The username of the administrator for the first database created in the namespace.

      • creationDate (datetime) --

        The date of when the namespace was created.

      • dbName (string) --

        The name of the first database created in the namespace.

      • defaultIamRoleArn (string) --

        The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

      • iamRoles (list) --

        A list of IAM roles to associate with the namespace.

        • (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

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,
        '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.

      • 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

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. For more information about this parameter.
  • 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

update_workgroup(**kwargs)

Updates a workgroup with the specified configuration settings.

See also: AWS API Documentation

Request Syntax

response = client.update_workgroup(
    baseCapacity=123,
    configParameters=[
        {
            'parameterKey': 'string',
            'parameterValue': 'string'
        },
    ],
    enhancedVpcRouting=True|False,
    publiclyAccessible=True|False,
    securityGroupIds=[
        'string',
    ],
    subnetIds=[
        '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 datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

    • (dict) --

      An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

      • parameterKey (string) --

        The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

      • parameterValue (string) --

        The value of the parameter to set.

  • 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.
  • 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) --
  • workgroupName (string) --

    [REQUIRED]

    The name of the workgroup to update.

Return type

dict

Returns

Response Syntax

{
    'workgroup': {
        'baseCapacity': 123,
        'configParameters': [
            {
                'parameterKey': 'string',
                'parameterValue': 'string'
            },
        ],
        'creationDate': datetime(2015, 1, 1),
        'endpoint': {
            'address': 'string',
            'port': 123,
            'vpcEndpoints': [
                {
                    'networkInterfaces': [
                        {
                            'availabilityZone': 'string',
                            'networkInterfaceId': 'string',
                            'privateIpAddress': 'string',
                            'subnetId': 'string'
                        },
                    ],
                    'vpcEndpointId': 'string',
                    'vpcId': 'string'
                },
            ]
        },
        'enhancedVpcRouting': True|False,
        'namespaceName': 'string',
        'publiclyAccessible': True|False,
        'securityGroupIds': [
            'string',
        ],
        'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
        'subnetIds': [
            'string',
        ],
        'workgroupArn': 'string',
        'workgroupId': 'string',
        'workgroupName': 'string'
    }
}

Response Structure

  • (dict) --

    • workgroup (dict) --

      The updated workgroup object.

      • baseCapacity (integer) --

        The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).

      • configParameters (list) --

        An array of parameters to set for finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

        • (dict) --

          An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

          • parameterKey (string) --

            The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

          • parameterValue (string) --

            The value of the parameter to set.

      • creationDate (datetime) --

        The creation date of the workgroup.

      • endpoint (dict) --

        The endpoint that is created from the workgroup.

        • address (string) --

          The DNS address of the VPC endpoint.

        • port (integer) --

          The port that Amazon Redshift Serverless listens on.

        • vpcEndpoints (list) --

          An array of VpcEndpoint objects.

          • (dict) --

            The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.

            • networkInterfaces (list) --

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • (dict) --

                Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

                • availabilityZone (string) --

                  The availability Zone.

                • networkInterfaceId (string) --

                  The unique identifier of the network interface.

                • privateIpAddress (string) --

                  The IPv4 address of the network interface within the subnet.

                • subnetId (string) --

                  The unique identifier of the subnet.

            • vpcEndpointId (string) --

              The connection endpoint ID for connecting to Amazon Redshift Serverless.

            • vpcId (string) --

              The VPC identifier that the endpoint is associated with.

      • enhancedVpcRouting (boolean) --

        The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

      • namespaceName (string) --

        The namespace the workgroup is associated with.

      • 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) --
      • workgroupArn (string) --

        The Amazon Resource Name (ARN) that links to the workgroup.

      • workgroupId (string) --

        The unique identifier of the workgroup.

      • workgroupName (string) --

        The name of the workgroup.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class RedshiftServerless.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'code': 'string',
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • code (string) --
    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RedshiftServerless.Client.exceptions.ConflictException

The submitted action has conflicts.

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The submitted action has conflicts.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RedshiftServerless.Client.exceptions.InsufficientCapacityException

There is an insufficient capacity to perform the action.

Example

try:
  ...
except client.exceptions.InsufficientCapacityException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    There is an insufficient capacity to perform the action.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RedshiftServerless.Client.exceptions.InternalServerException

The request processing has failed because of an unknown error, exception or failure.

Example

try:
  ...
except client.exceptions.InternalServerException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request processing has failed because of an unknown error, exception or failure.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RedshiftServerless.Client.exceptions.InvalidPaginationException

The provided pagination token is invalid.

Example

try:
  ...
except client.exceptions.InvalidPaginationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The provided pagination token is invalid.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RedshiftServerless.Client.exceptions.ResourceNotFoundException

The resource could not be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceName': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource could not be found.

    • message (string) --

    • resourceName (string) --

      The name of the resource that could not be found.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RedshiftServerless.Client.exceptions.ServiceQuotaExceededException

The service limit was exceeded.

Example

try:
  ...
except client.exceptions.ServiceQuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The service limit was exceeded.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RedshiftServerless.Client.exceptions.ThrottlingException

The request was denied due to request throttling.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'code': 'string',
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request was denied due to request throttling.

    • code (string) --
    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RedshiftServerless.Client.exceptions.TooManyTagsException

The request exceeded the number of tags allowed for a resource.

Example

try:
  ...
except client.exceptions.TooManyTagsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceName': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request exceeded the number of tags allowed for a resource.

    • message (string) --

    • resourceName (string) --

      The name of the resource that exceeded the number of tags allowed for a resource.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class RedshiftServerless.Client.exceptions.ValidationException

The input failed to satisfy the constraints specified by an AWS service.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The input failed to satisfy the constraints specified by an AWS service.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

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(
    vpcId='string',
    workgroupName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • 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',
                        '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.

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

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': [
        {
            'adminUsername': 'string',
            'creationDate': datetime(2015, 1, 1),
            'dbName': 'string',
            'defaultIamRoleArn': 'string',
            'iamRoles': [
                'string',
            ],
            'kmsKeyId': 'string',
            'logExports': [
                'useractivitylog'|'userlog'|'connectionlog',
            ],
            'namespaceArn': 'string',
            'namespaceId': 'string',
            'namespaceName': 'string',
            'status': 'AVAILABLE'|'MODIFYING'|'DELETING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • namespaces (list) --

      The list of returned namespaces.

      • (dict) --

        A collection of database objects and users.

        • adminUsername (string) --

          The username of the administrator for the first database created in the namespace.

        • creationDate (datetime) --

          The date of when the namespace was created.

        • dbName (string) --

          The name of the first database created in the namespace.

        • defaultIamRoleArn (string) --

          The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.

        • iamRoles (list) --

          A list of IAM roles to associate with the namespace.

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

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),
    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.
  • 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': [
        {
            '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.

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

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,
            '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.

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

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.

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(
    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
{
    'workgroups': [
        {
            'baseCapacity': 123,
            'configParameters': [
                {
                    'parameterKey': 'string',
                    'parameterValue': 'string'
                },
            ],
            'creationDate': datetime(2015, 1, 1),
            'endpoint': {
                'address': 'string',
                'port': 123,
                'vpcEndpoints': [
                    {
                        'networkInterfaces': [
                            {
                                'availabilityZone': 'string',
                                'networkInterfaceId': 'string',
                                'privateIpAddress': 'string',
                                'subnetId': 'string'
                            },
                        ],
                        'vpcEndpointId': 'string',
                        'vpcId': 'string'
                    },
                ]
            },
            'enhancedVpcRouting': True|False,
            'namespaceName': 'string',
            'publiclyAccessible': True|False,
            'securityGroupIds': [
                'string',
            ],
            'status': 'CREATING'|'AVAILABLE'|'MODIFYING'|'DELETING',
            'subnetIds': [
                'string',
            ],
            'workgroupArn': 'string',
            'workgroupId': 'string',
            'workgroupName': '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 finer control over a database. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

          • (dict) --

            An array of key-value pairs to set for advanced control over Amazon Redshift Serverless.

            • parameterKey (string) --

              The key of the parameter. The options are datestyle , enable_user_activity_logging , query_group , search_path , and max_query_execution_time .

            • parameterValue (string) --

              The value of the parameter to set.

        • creationDate (datetime) --

          The creation date of the workgroup.

        • endpoint (dict) --

          The endpoint that is created from the workgroup.

          • address (string) --

            The DNS address of the VPC endpoint.

          • port (integer) --

            The port that Amazon Redshift Serverless listens on.

          • vpcEndpoints (list) --

            An array of VpcEndpoint objects.

            • (dict) --

              The connection endpoint for connecting to Amazon Redshift Serverless through the proxy.

              • networkInterfaces (list) --

                One or more network interfaces of the endpoint. Also known as an interface endpoint.

                • (dict) --

                  Contains information about a network interface in an Amazon Redshift Serverless managed VPC endpoint.

                  • availabilityZone (string) --

                    The availability Zone.

                  • networkInterfaceId (string) --

                    The unique identifier of the network interface.

                  • privateIpAddress (string) --

                    The IPv4 address of the network interface within the subnet.

                  • subnetId (string) --

                    The unique identifier of the subnet.

              • vpcEndpointId (string) --

                The connection endpoint ID for connecting to Amazon Redshift Serverless.

              • vpcId (string) --

                The VPC identifier that the endpoint is associated with.

        • enhancedVpcRouting (boolean) --

          The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.

        • namespaceName (string) --

          The namespace the workgroup is associated with.

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

    • NextToken (string) --

      A token to resume pagination.