Skip to content

RedshiftServerlessClient#

Index > RedshiftServerless > RedshiftServerlessClient

Auto-generated documentation for RedshiftServerless type annotations stubs module mypy-boto3-redshift-serverless.

RedshiftServerlessClient#

Type annotations and code completion for boto3.client("redshift-serverless"). boto3 documentation

# RedshiftServerlessClient usage example

from boto3.session import Session
from mypy_boto3_redshift_serverless.client import RedshiftServerlessClient

def get_redshift-serverless_client() -> RedshiftServerlessClient:
    return Session().client("redshift-serverless")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("redshift-serverless").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("redshift-serverless")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InsufficientCapacityException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidPaginationException,
    client.exceptions.Ipv6CidrBlockNotFoundException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyTagsException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_redshift_serverless.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("redshift-serverless").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("redshift-serverless").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

convert_recovery_point_to_snapshot#

Converts a recovery point to a snapshot.

Type annotations and code completion for boto3.client("redshift-serverless").convert_recovery_point_to_snapshot method. boto3 documentation

# convert_recovery_point_to_snapshot method definition

def convert_recovery_point_to_snapshot(
    self,
    *,
    recoveryPointId: str,
    snapshotName: str,
    retentionPeriod: int = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> ConvertRecoveryPointToSnapshotResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See ConvertRecoveryPointToSnapshotResponseTypeDef 
# convert_recovery_point_to_snapshot method usage example with argument unpacking

kwargs: ConvertRecoveryPointToSnapshotRequestRequestTypeDef = {  # (1)
    "recoveryPointId": ...,
    "snapshotName": ...,
}

parent.convert_recovery_point_to_snapshot(**kwargs)
  1. See ConvertRecoveryPointToSnapshotRequestRequestTypeDef

create_custom_domain_association#

Creates a custom domain association for Amazon Redshift Serverless.

Type annotations and code completion for boto3.client("redshift-serverless").create_custom_domain_association method. boto3 documentation

# create_custom_domain_association method definition

def create_custom_domain_association(
    self,
    *,
    customDomainCertificateArn: str,
    customDomainName: str,
    workgroupName: str,
) -> CreateCustomDomainAssociationResponseTypeDef:  # (1)
    ...
  1. See CreateCustomDomainAssociationResponseTypeDef 
# create_custom_domain_association method usage example with argument unpacking

kwargs: CreateCustomDomainAssociationRequestRequestTypeDef = {  # (1)
    "customDomainCertificateArn": ...,
    "customDomainName": ...,
    "workgroupName": ...,
}

parent.create_custom_domain_association(**kwargs)
  1. See CreateCustomDomainAssociationRequestRequestTypeDef

create_endpoint_access#

Creates an Amazon Redshift Serverless managed VPC endpoint.

Type annotations and code completion for boto3.client("redshift-serverless").create_endpoint_access method.