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.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. boto3 documentation

# create_endpoint_access method definition

def create_endpoint_access(
    self,
    *,
    endpointName: str,
    subnetIds: Sequence[str],
    workgroupName: str,
    ownerAccount: str = ...,
    vpcSecurityGroupIds: Sequence[str] = ...,
) -> CreateEndpointAccessResponseTypeDef:  # (1)
    ...
  1. See CreateEndpointAccessResponseTypeDef
# create_endpoint_access method usage example with argument unpacking

kwargs: CreateEndpointAccessRequestRequestTypeDef = {  # (1)
    "endpointName": ...,
    "subnetIds": ...,
    "workgroupName": ...,
}

parent.create_endpoint_access(**kwargs)
  1. See CreateEndpointAccessRequestRequestTypeDef

create_namespace#

Creates a namespace in Amazon Redshift Serverless.

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

# create_namespace method definition

def create_namespace(
    self,
    *,
    namespaceName: str,
    adminPasswordSecretKmsKeyId: str = ...,
    adminUserPassword: str = ...,
    adminUsername: str = ...,
    dbName: str = ...,
    defaultIamRoleArn: str = ...,
    iamRoles: Sequence[str] = ...,
    kmsKeyId: str = ...,
    logExports: Sequence[LogExportType] = ...,  # (1)
    manageAdminPassword: bool = ...,
    redshiftIdcApplicationArn: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateNamespaceResponseTypeDef:  # (3)
    ...
  1. See LogExportType
  2. See TagTypeDef
  3. See CreateNamespaceResponseTypeDef
# create_namespace method usage example with argument unpacking

kwargs: CreateNamespaceRequestRequestTypeDef = {  # (1)
    "namespaceName": ...,
}

parent.create_namespace(**kwargs)
  1. See CreateNamespaceRequestRequestTypeDef

create_scheduled_action#

Creates a scheduled action.

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

# create_scheduled_action method definition

def create_scheduled_action(
    self,
    *,
    namespaceName: str,
    roleArn: str,
    schedule: ScheduleTypeDef,  # (1)
    scheduledActionName: str,
    targetAction: TargetActionTypeDef,  # (2)
    enabled: bool = ...,
    endTime: Union[datetime, str] = ...,
    scheduledActionDescription: str = ...,
    startTime: Union[datetime, str] = ...,
) -> CreateScheduledActionResponseTypeDef:  # (3)
    ...
  1. See ScheduleTypeDef
  2. See TargetActionTypeDef
  3. See CreateScheduledActionResponseTypeDef
# create_scheduled_action method usage example with argument unpacking

kwargs: CreateScheduledActionRequestRequestTypeDef = {  # (1)
    "namespaceName": ...,
    "roleArn": ...,
    "schedule": ...,
    "scheduledActionName": ...,
    "targetAction": ...,
}

parent.create_scheduled_action(**kwargs)
  1. See CreateScheduledActionRequestRequestTypeDef

create_snapshot#

Creates a snapshot of all databases in a namespace.

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

# create_snapshot method definition

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

kwargs: CreateSnapshotRequestRequestTypeDef = {  # (1)
    "namespaceName": ...,
    "snapshotName": ...,
}

parent.create_snapshot(**kwargs)
  1. See CreateSnapshotRequestRequestTypeDef

create_snapshot_copy_configuration#

Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.

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

# create_snapshot_copy_configuration method definition

def create_snapshot_copy_configuration(
    self,
    *,
    destinationRegion: str,
    namespaceName: str,
    destinationKmsKeyId: str = ...,
    snapshotRetentionPeriod: int = ...,
) -> CreateSnapshotCopyConfigurationResponseTypeDef:  # (1)
    ...
  1. See CreateSnapshotCopyConfigurationResponseTypeDef
# create_snapshot_copy_configuration method usage example with argument unpacking

kwargs: CreateSnapshotCopyConfigurationRequestRequestTypeDef = {  # (1)
    "destinationRegion": ...,
    "namespaceName": ...,
}

parent.create_snapshot_copy_configuration(**kwargs)
  1. See CreateSnapshotCopyConfigurationRequestRequestTypeDef

create_usage_limit#

Creates a usage limit for a specified Amazon Redshift Serverless usage type.

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

# create_usage_limit method definition

def create_usage_limit(
    self,
    *,
    amount: int,
    resourceArn: str,
    usageType: UsageLimitUsageTypeType,  # (1)
    breachAction: UsageLimitBreachActionType = ...,  # (2)
    period: UsageLimitPeriodType = ...,  # (3)
) -> CreateUsageLimitResponseTypeDef:  # (4)
    ...
  1. See UsageLimitUsageTypeType
  2. See UsageLimitBreachActionType
  3. See UsageLimitPeriodType
  4. See CreateUsageLimitResponseTypeDef
# create_usage_limit method usage example with argument unpacking

kwargs: CreateUsageLimitRequestRequestTypeDef = {  # (1)
    "amount": ...,
    "resourceArn": ...,
    "usageType": ...,
}

parent.create_usage_limit(**kwargs)
  1. See CreateUsageLimitRequestRequestTypeDef

create_workgroup#

Creates an workgroup in Amazon Redshift Serverless.

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

# create_workgroup method definition

def create_workgroup(
    self,
    *,
    namespaceName: str,
    workgroupName: str,
    baseCapacity: int = ...,
    configParameters: Sequence[ConfigParameterTypeDef] = ...,  # (1)
    enhancedVpcRouting: bool = ...,
    maxCapacity: int = ...,
    port: int = ...,
    publiclyAccessible: bool = ...,
    securityGroupIds: Sequence[str] = ...,
    subnetIds: Sequence[str] = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateWorkgroupResponseTypeDef:  # (3)
    ...
  1. See ConfigParameterTypeDef
  2. See TagTypeDef
  3. See CreateWorkgroupResponseTypeDef
# create_workgroup method usage example with argument unpacking

kwargs: CreateWorkgroupRequestRequestTypeDef = {  # (1)
    "namespaceName": ...,
    "workgroupName": ...,
}

parent.create_workgroup(**kwargs)
  1. See CreateWorkgroupRequestRequestTypeDef

delete_custom_domain_association#

Deletes a custom domain association for Amazon Redshift Serverless.

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

# delete_custom_domain_association method definition

def delete_custom_domain_association(
    self,
    *,
    customDomainName: str,
    workgroupName: str,
) -> Dict[str, Any]: