RedshiftServerlessClient#
Index > RedshiftServerless > RedshiftServerlessClient
Auto-generated documentation for RedshiftServerless type annotations stubs module types-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 types_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 types_boto3_redshift_serverless.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...Methods#
can_paginate#
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:
    ...generate_presigned_url#
Type annotations and code completion for boto3.client("redshift-serverless").generate_presigned_url method.
 boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...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)
    ...- See Sequence[TagTypeDef]
- See ConvertRecoveryPointToSnapshotResponseTypeDef
# convert_recovery_point_to_snapshot method usage example with argument unpacking
kwargs: ConvertRecoveryPointToSnapshotRequestTypeDef = {  # (1)
    "recoveryPointId": ...,
    "snapshotName": ...,
}
parent.convert_recovery_point_to_snapshot(**kwargs)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)
    ...# create_custom_domain_association method usage example with argument unpacking
kwargs: CreateCustomDomainAssociationRequestTypeDef = {  # (1)
    "customDomainCertificateArn": ...,
    "customDomainName": ...,
    "workgroupName": ...,
}
parent.create_custom_domain_association(**kwargs)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)
    ...# create_endpoint_access method usage example with argument unpacking
kwargs: CreateEndpointAccessRequestTypeDef = {  # (1)
    "endpointName": ...,
    "subnetIds": ...,
    "workgroupName": ...,
}
parent.create_endpoint_access(**kwargs)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)
    ...- See Sequence[LogExportType]
- See Sequence[TagTypeDef]
- See CreateNamespaceResponseTypeDef
# create_namespace method usage example with argument unpacking
kwargs: CreateNamespaceRequestTypeDef = {  # (1)
    "namespaceName": ...,
}
parent.create_namespace(**kwargs)create_reservation#
Creates an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates.
Type annotations and code completion for boto3.client("redshift-serverless").create_reservation method.
 boto3 documentation
# create_reservation method definition
def create_reservation(
    self,
    *,
    capacity: int,
    offeringId: str,
    clientToken: str = ...,
) -> CreateReservationResponseTypeDef:  # (1)
    ...# create_reservation method usage example with argument unpacking
kwargs: CreateReservationRequestTypeDef = {  # (1)
    "capacity": ...,
    "offeringId": ...,
}
parent.create_reservation(**kwargs)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: ScheduleUnionTypeDef,  # (1)
    scheduledActionName: str,
    targetAction: TargetActionUnionTypeDef,  # (2)
    enabled: bool = ...,
    endTime: TimestampTypeDef = ...,
    scheduledActionDescription: str = ...,
    startTime: TimestampTypeDef = ...,
) -> CreateScheduledActionResponseTypeDef:  # (3)
    ...# create_scheduled_action method usage example with argument unpacking
kwargs: CreateScheduledActionRequestTypeDef = {  # (1)
    "namespaceName": ...,
    "roleArn": ...,
    "schedule": ...,
    "scheduledActionName": ...,
    "targetAction": ...,
}
parent.create_scheduled_action(**kwargs)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)
    ...- See Sequence[TagTypeDef]
- See CreateSnapshotResponseTypeDef
# create_snapshot method usage example with argument unpacking
kwargs: CreateSnapshotRequestTypeDef = {  # (1)
    "namespaceName": ...,
    "snapshotName": ...,
}
parent.create_snapshot(**kwargs)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)
    ...# create_snapshot_copy_configuration method usage example with argument unpacking
kwargs: CreateSnapshotCopyConfigurationRequestTypeDef = {  # (1)
    "destinationRegion": ...,
    "namespaceName": ...,
}
parent.create_snapshot_copy_configuration(**kwargs)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)
    ...- See UsageLimitUsageTypeType
- See UsageLimitBreachActionType
- See UsageLimitPeriodType
- See CreateUsageLimitResponseTypeDef
# create_usage_limit method usage example with argument unpacking
kwargs: CreateUsageLimitRequestTypeDef = {  # (1)
    "amount": ...,
    "resourceArn": ...,
    "usageType": ...,
}
parent.create_usage_limit(**kwargs)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 = ...,
    ipAddressType: str = ...,
    maxCapacity: int = ...,
    port: int = ...,
    pricePerformanceTarget: PerformanceTargetTypeDef = ...,  # (2)
    publiclyAccessible: bool = ...,
    securityGroupIds: Sequence[str] = ...,
    subnetIds: Sequence[str] = ...,
    tags: Sequence[TagTypeDef] = ...,  # (3)
    trackName: str = ...,
) -> CreateWorkgroupResponseTypeDef:  # (4)
    ...- See Sequence[ConfigParameterTypeDef]
- See PerformanceTargetTypeDef
- See Sequence[TagTypeDef]
- See CreateWorkgroupResponseTypeDef
# create_workgroup method usage example with argument unpacking
kwargs: CreateWorkgroupRequestTypeDef = {  # (1)
    "namespaceName": ...,
    "workgroupName": ...,
}
parent.create_workgroup(**kwargs)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]:
    ...# delete_custom_domain_association method usage example with argument unpacking
kwargs: DeleteCustomDomainAssociationRequestTypeDef = {  # (1)
    "customDomainName": ...,
    "workgroupName": ...,
}
parent.delete_custom_domain_association(**kwargs)delete_endpoint_access#
Deletes an Amazon Redshift Serverless managed VPC endpoint.
Type annotations and code completion for boto3.client("redshift-serverless").delete_endpoint_access method.
 boto3 documentation
# delete_endpoint_access method definition
def delete_endpoint_access(
    self,
    *,
    endpointName: str,
) -> DeleteEndpointAccessResponseTypeDef:  # (1)
    ...# delete_endpoint_access method usage example with argument unpacking
kwargs: DeleteEndpointAccessRequestTypeDef = {  # (1)
    "endpointName": ...,
}
parent.delete_endpoint_access(**kwargs)delete_namespace#
Deletes a namespace from Amazon Redshift Serverless.
Type annotations and code completion for boto3.client("redshift-serverless").delete_namespace method.
 boto3 documentation
# delete_namespace method definition
def delete_namespace(
    self,
    *,
    namespaceName: str,
    finalSnapshotName: str = ...,
    finalSnapshotRetentionPeriod: int = ...,
) -> DeleteNamespaceResponseTypeDef:  # (1)
    ...# delete_namespace method usage example with argument unpacking
kwargs: DeleteNamespaceRequestTypeDef = {  # (1)
    "namespaceName": ...,
}
parent.delete_namespace(**kwargs)delete_resource_policy#
Deletes the specified resource policy.
Type annotations and code completion for boto3.client("redshift-serverless").delete_resource_policy method.
 boto3 documentation
# delete_resource_policy method definition
def delete_resource_policy(
    self,
    *,
    resourceArn: str,
) -> Dict[str, Any]:
    ...# delete_resource_policy method usage example with argument unpacking
kwargs: DeleteResourcePolicyRequestTypeDef = {  # (1)
    "resourceArn": ...,
}
parent.delete_resource_policy(**kwargs)delete_scheduled_action#
Deletes a scheduled action.
Type annotations and code completion for boto3.client("redshift-serverless").delete_scheduled_action method.
 boto3 documentation
# delete_scheduled_action method definition
def delete_scheduled_action(
    self,
    *,
    scheduledActionName: str,
) -> DeleteScheduledActionResponseTypeDef:  # (1)
    ...# delete_scheduled_action method usage example with argument unpacking
kwargs: DeleteScheduledActionRequestTypeDef = {  # (1)
    "scheduledActionName": ...,
}
parent.delete_scheduled_action(**kwargs)delete_snapshot#
Deletes a snapshot from Amazon Redshift Serverless.
Type annotations and code completion for boto3.client("redshift-serverless").delete_snapshot method.
 boto3 documentation
# delete_snapshot method definition
def delete_snapshot(
    self,
    *,
    snapshotName: str,
) -> DeleteSnapshotResponseTypeDef:  # (1)
    ...# delete_snapshot method usage example with argument unpacking
kwargs: DeleteSnapshotRequestTypeDef = {  # (1)
    "snapshotName": ...,
}
parent.delete_snapshot(**kwargs)delete_snapshot_copy_configuration#
Deletes a snapshot copy configuration.
Type annotations and code completion for boto3.client("redshift-serverless").delete_snapshot_copy_configuration method.
 boto3 documentation
# delete_snapshot_copy_configuration method definition
def delete_snapshot_copy_configuration(
    self,
    *,
    snapshotCopyConfigurationId: str,
) -> DeleteSnapshotCopyConfigurationResponseTypeDef:  # (1)
    ...# delete_snapshot_copy_configuration method usage example with argument unpacking
kwargs: DeleteSnapshotCopyConfigurationRequestTypeDef = {  # (1)
    "snapshotCopyConfigurationId": ...,
}
parent.delete_snapshot_copy_configuration(**kwargs)delete_usage_limit#
Deletes a usage limit from Amazon Redshift Serverless.
Type annotations and code completion for boto3.client("redshift-serverless").delete_usage_limit method.
 boto3 documentation
# delete_usage_limit method definition
def delete_usage_limit(
    self,
    *,
    usageLimitId: str,
) -> DeleteUsageLimitResponseTypeDef:  # (1)
    ...# delete_usage_limit method usage example with argument unpacking
kwargs: DeleteUsageLimitRequestTypeDef = {  # (1)
    "usageLimitId": ...,
}
parent.delete_usage_limit(**kwargs)delete_workgroup#
Deletes a workgroup.
Type annotations and code completion for boto3.client("redshift-serverless").delete_workgroup method.
 boto3 documentation
# delete_workgroup method definition
def delete_workgroup(
    self,
    *,
    workgroupName: str,
) -> DeleteWorkgroupResponseTypeDef:  # (1)
    ...# delete_workgroup method usage example with argument unpacking
kwargs: DeleteWorkgroupRequestTypeDef = {  # (1)
    "workgroupName": ...,
}
parent.delete_workgroup(**kwargs)get_credentials#
Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.
Type annotations and code completion for boto3.client("redshift-serverless").get_credentials method.
 boto3 documentation
# get_credentials method definition
def get_credentials(
    self,
    *,
    customDomainName: str = ...,
    dbName: str = ...,
    durationSeconds: int = ...,
    workgroupName: str = ...,
) -> GetCredentialsResponseTypeDef:  # (1)
    ...# get_credentials method usage example with argument unpacking
kwargs: GetCredentialsRequestTypeDef = {  # (1)
    "customDomainName": ...,
}
parent.get_credentials(**kwargs)get_custom_domain_association#
Gets information about a specific custom domain association.
Type annotations and code completion for boto3.client("redshift-serverless").get_custom_domain_association method.
 boto3 documentation
# get_custom_domain_association method definition
def get_custom_domain_association(
    self,
    *,
    customDomainName: str,
    workgroupName: str,
) -> GetCustomDomainAssociationResponseTypeDef:  # (1)
    ...# get_custom_domain_association method usage example with argument unpacking
kwargs: GetCustomDomainAssociationRequestTypeDef = {  # (1)
    "customDomainName": ...,
    "workgroupName": ...,
}
parent.get_custom_domain_association(**kwargs)get_endpoint_access#
Returns information, such as the name, about a VPC endpoint.
Type annotations and code completion for boto3.client("redshift-serverless").get_endpoint_access method.
 boto3 documentation
# get_endpoint_access method definition
def get_endpoint_access(
    self,
    *,
    endpointName: str,
) -> GetEndpointAccessResponseTypeDef:  # (1)
    ...# get_endpoint_access method usage example with argument unpacking
kwargs: GetEndpointAccessRequestTypeDef = {  # (1)
    "endpointName": ...,
}
parent.get_endpoint_access(**kwargs)get_namespace#
Returns information about a namespace in Amazon Redshift Serverless.
Type annotations and code completion for boto3.client("redshift-serverless").get_namespace method.
 boto3 documentation
# get_namespace method definition
def get_namespace(
    self,
    *,
    namespaceName: str,
) -> GetNamespaceResponseTypeDef:  # (1)
    ...# get_namespace method usage example with argument unpacking
kwargs: GetNamespaceRequestTypeDef = {  # (1)
    "namespaceName": ...,
}
parent.get_namespace(**kwargs)get_recovery_point#
Returns information about a recovery point.
Type annotations and code completion for boto3.client("redshift-serverless").get_recovery_point method.
 boto3 documentation
# get_recovery_point method definition
def get_recovery_point(
    self,
    *,
    recoveryPointId: str,
) -> GetRecoveryPointResponseTypeDef:  # (1)
    ...# get_recovery_point method usage example with argument unpacking
kwargs: GetRecoveryPointRequestTypeDef = {  # (1)
    "recoveryPointId": ...,
}
parent.get_recovery_point(**kwargs)get_reservation#
Gets an Amazon Redshift Serverless reservation.
Type annotations and code completion for boto3.client("redshift-serverless").get_reservation method.
 boto3 documentation
# get_reservation method definition
def get_reservation(
    self,
    *,
    reservationId: str,
) -> GetReservationResponseTypeDef:  # (1)
    ...# get_reservation method usage example with argument unpacking
kwargs: GetReservationRequestTypeDef = {  # (1)
    "reservationId": ...,
}
parent.get_reservation(**kwargs)get_reservation_offering#
Returns the reservation offering.
Type annotations and code completion for boto3.client("redshift-serverless").get_reservation_offering method.
 boto3 documentation
# get_reservation_offering method definition
def get_reservation_offering(
    self,
    *,
    offeringId: str,
) -> GetReservationOfferingResponseTypeDef:  # (1)
    ...# get_reservation_offering method usage example with argument unpacking
kwargs: GetReservationOfferingRequestTypeDef = {  # (1)
    "offeringId": ...,
}
parent.get_reservation_offering(**kwargs)get_resource_policy#
Returns a resource policy.
Type annotations and code completion for boto3.client("redshift-serverless").get_resource_policy method.
 boto3 documentation
# get_resource_policy method definition
def get_resource_policy(
    self,
    *,
    resourceArn: str,
) -> GetResourcePolicyResponseTypeDef:  # (1)
    ...# get_resource_policy method usage example with argument unpacking
kwargs: GetResourcePolicyRequestTypeDef = {  # (1)
    "resourceArn": ...,
}
parent.get_resource_policy(**kwargs)get_scheduled_action#
Returns information about a scheduled action.
Type annotations and code completion for boto3.client("redshift-serverless").get_scheduled_action method.
 boto3 documentation
# get_scheduled_action method definition
def get_scheduled_action(
    self,
    *,
    scheduledActionName: str,
) -> GetScheduledActionResponseTypeDef:  # (1)
    ...# get_scheduled_action method usage example with argument unpacking
kwargs: GetScheduledActionRequestTypeDef = {  # (1)
    "scheduledActionName": ...,
}
parent.get_scheduled_action(**kwargs)get_snapshot#
Returns information about a specific snapshot.
Type annotations and code completion for boto3.client("redshift-serverless").get_snapshot method.
 boto3 documentation
# get_snapshot method definition
def get_snapshot(
    self,
    *,
    ownerAccount: str = ...,
    snapshotArn: str = ...,
    snapshotName: str = ...,
) -> GetSnapshotResponseTypeDef:  # (1)
    ...# get_snapshot method usage example with argument unpacking
kwargs: GetSnapshotRequestTypeDef = {  # (1)
    "ownerAccount": ...,
}
parent.get_snapshot(**kwargs)get_table_restore_status#
Returns information about a TableRestoreStatus object.
Type annotations and code completion for boto3.client("redshift-serverless").get_table_restore_status method.
 boto3 documentation
# get_table_restore_status method definition
def get_table_restore_status(
    self,
    *,
    tableRestoreRequestId: str,
) -> GetTableRestoreStatusResponseTypeDef:  # (1)
    ...# get_table_restore_status method usage example with argument unpacking
kwargs: GetTableRestoreStatusRequestTypeDef = {  # (1)
    "tableRestoreRequestId": ...,
}
parent.get_table_restore_status(**kwargs)get_track#
Get the Redshift Serverless version for a specified track.
Type annotations and code completion for boto3.client("redshift-serverless").get_track method.
 boto3 documentation
# get_track method definition
def get_track(
    self,
    *,
    trackName: str,
) -> GetTrackResponseTypeDef:  # (1)
    ...# get_track method usage example with argument unpacking
kwargs: GetTrackRequestTypeDef = {  # (1)
    "trackName": ...,
}
parent.get_track(**kwargs)get_usage_limit#
Returns information about a usage limit.
Type annotations and code completion for boto3.client("redshift-serverless").get_usage_limit method.
 boto3 documentation
# get_usage_limit method definition
def get_usage_limit(
    self,
    *,
    usageLimitId: str,
) -> GetUsageLimitResponseTypeDef:  # (1)
    ...# get_usage_limit method usage example with argument unpacking
kwargs: GetUsageLimitRequestTypeDef = {  # (1)
    "usageLimitId": ...,
}
parent.get_usage_limit(**kwargs)get_workgroup#
Returns information about a specific workgroup.
Type annotations and code completion for boto3.client("redshift-serverless").get_workgroup method.
 boto3 documentation
# get_workgroup method definition
def get_workgroup(
    self,
    *,
    workgroupName: str,
) -> GetWorkgroupResponseTypeDef:  # (1)
    ...# get_workgroup method usage example with argument unpacking
kwargs: GetWorkgroupRequestTypeDef = {  # (1)
    "workgroupName": ...,
}
parent.get_workgroup(**kwargs)list_custom_domain_associations#
Lists custom domain associations for Amazon Redshift Serverless.
Type annotations and code completion for boto3.client("redshift-serverless").list_custom_domain_associations method.
 boto3 documentation
# list_custom_domain_associations method definition
def list_custom_domain_associations(
    self,
    *,
    customDomainCertificateArn: str = ...,
    customDomainName: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCustomDomainAssociationsResponseTypeDef:  # (1)
    ...# list_custom_domain_associations method usage example with argument unpacking
kwargs: ListCustomDomainAssociationsRequestTypeDef = {  # (1)
    "customDomainCertificateArn": ...,
}
parent.list_custom_domain_associations(**kwargs)list_endpoint_access#
Returns an array of EndpointAccess objects and relevant
information.
Type annotations and code completion for boto3.client("redshift-serverless").list_endpoint_access method.
 boto3 documentation
# list_endpoint_access method definition
def list_endpoint_access(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    ownerAccount: str = ...,
    vpcId: str = ...,
    workgroupName: str = ...,
) -> ListEndpointAccessResponseTypeDef:  # (1)
    ...# list_endpoint_access method usage example with argument unpacking
kwargs: ListEndpointAccessRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_endpoint_access(**kwargs)list_managed_workgroups#
Returns information about a list of specified managed workgroups in your account.
Type annotations and code completion for boto3.client("redshift-serverless").list_managed_workgroups method.
 boto3 documentation
# list_managed_workgroups method definition
def list_managed_workgroups(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    sourceArn: str = ...,
) -> ListManagedWorkgroupsResponseTypeDef:  # (1)
    ...# list_managed_workgroups method usage example with argument unpacking
kwargs: ListManagedWorkgroupsRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_managed_workgroups(**kwargs)list_namespaces#
Returns information about a list of specified namespaces.
Type annotations and code completion for boto3.client("redshift-serverless").list_namespaces method.
 boto3 documentation
# list_namespaces method definition
def list_namespaces(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListNamespacesResponseTypeDef:  # (1)
    ...# list_namespaces method usage example with argument unpacking
kwargs: ListNamespacesRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_namespaces(**kwargs)list_recovery_points#
Returns an array of recovery points.
Type annotations and code completion for boto3.client("redshift-serverless").list_recovery_points method.
 boto3 documentation
# list_recovery_points method definition
def list_recovery_points(
    self,
    *,
    endTime: TimestampTypeDef = ...,
    maxResults: int = ...,
    namespaceArn: str = ...,
    namespaceName: str = ...,
    nextToken: str = ...,
    startTime: TimestampTypeDef = ...,
) -> ListRecoveryPointsResponseTypeDef:  # (1)
    ...# list_recovery_points method usage example with argument unpacking
kwargs: ListRecoveryPointsRequestTypeDef = {  # (1)
    "endTime": ...,
}
parent.list_recovery_points(**kwargs)list_reservation_offerings#
Returns the current reservation offerings in your account.
Type annotations and code completion for boto3.client("redshift-serverless").list_reservation_offerings method.
 boto3 documentation
# list_reservation_offerings method definition
def list_reservation_offerings(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReservationOfferingsResponseTypeDef:  # (1)
    ...# list_reservation_offerings method usage example with argument unpacking
kwargs: ListReservationOfferingsRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_reservation_offerings(**kwargs)list_reservations#
Returns a list of Reservation objects.
Type annotations and code completion for boto3.client("redshift-serverless").list_reservations method.
 boto3 documentation
# list_reservations method definition
def list_reservations(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListReservationsResponseTypeDef:  # (1)
    ...# list_reservations method usage example with argument unpacking
kwargs: ListReservationsRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_reservations(**kwargs)list_scheduled_actions#
Returns a list of scheduled actions.
Type annotations and code completion for boto3.client("redshift-serverless").list_scheduled_actions method.
 boto3 documentation
# list_scheduled_actions method definition
def list_scheduled_actions(
    self,
    *,
    maxResults: int = ...,
    namespaceName: str = ...,
    nextToken: str = ...,
) -> ListScheduledActionsResponseTypeDef:  # (1)
    ...# list_scheduled_actions method usage example with argument unpacking
kwargs: ListScheduledActionsRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_scheduled_actions(**kwargs)list_snapshot_copy_configurations#
Returns a list of snapshot copy configurations.
Type annotations and code completion for boto3.client("redshift-serverless").list_snapshot_copy_configurations method.
 boto3 documentation
# list_snapshot_copy_configurations method definition
def list_snapshot_copy_configurations(
    self,
    *,
    maxResults: int = ...,
    namespaceName: str = ...,
    nextToken: str = ...,
) -> ListSnapshotCopyConfigurationsResponseTypeDef:  # (1)
    ...# list_snapshot_copy_configurations method usage example with argument unpacking
kwargs: ListSnapshotCopyConfigurationsRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_snapshot_copy_configurations(**kwargs)list_snapshots#
Returns a list of snapshots.
Type annotations and code completion for boto3.client("redshift-serverless").list_snapshots method.
 boto3 documentation
# list_snapshots method definition
def list_snapshots(
    self,
    *,
    endTime: TimestampTypeDef = ...,
    maxResults: int = ...,
    namespaceArn: str = ...,
    namespaceName: str = ...,
    nextToken: str = ...,
    ownerAccount: str = ...,
    startTime: TimestampTypeDef = ...,
) -> ListSnapshotsResponseTypeDef:  # (1)
    ...# list_snapshots method usage example with argument unpacking
kwargs: ListSnapshotsRequestTypeDef = {  # (1)
    "endTime": ...,
}
parent.list_snapshots(**kwargs)list_table_restore_status#
Returns information about an array of TableRestoreStatus objects.
Type annotations and code completion for boto3.client("redshift-serverless").list_table_restore_status method.
 boto3 documentation
# list_table_restore_status method definition
def list_table_restore_status(
    self,
    *,
    maxResults: int = ...,
    namespaceName: str = ...,
    nextToken: str = ...,
    workgroupName: str = ...,
) -> ListTableRestoreStatusResponseTypeDef:  # (1)
    ...# list_table_restore_status method usage example with argument unpacking
kwargs: ListTableRestoreStatusRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_table_restore_status(**kwargs)list_tags_for_resource#
Lists the tags assigned to a resource.
Type annotations and code completion for boto3.client("redshift-serverless").list_tags_for_resource method.
 boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)list_tracks#
List the Amazon Redshift Serverless versions.
Type annotations and code completion for boto3.client("redshift-serverless").list_tracks method.
 boto3 documentation
# list_tracks method definition
def list_tracks(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTracksResponseTypeDef:  # (1)
    ...# list_tracks method usage example with argument unpacking
kwargs: ListTracksRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_tracks(**kwargs)list_usage_limits#
Lists all usage limits within Amazon Redshift Serverless.
Type annotations and code completion for boto3.client("redshift-serverless").list_usage_limits method.
 boto3 documentation
# list_usage_limits method definition
def list_usage_limits(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    resourceArn: str = ...,
    usageType: UsageLimitUsageTypeType = ...,  # (1)
) -> ListUsageLimitsResponseTypeDef:  # (2)
    ...# list_usage_limits method usage example with argument unpacking
kwargs: ListUsageLimitsRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_usage_limits(**kwargs)list_workgroups#
Returns information about a list of specified workgroups.
Type annotations and code completion for boto3.client("redshift-serverless").list_workgroups method.
 boto3 documentation
# list_workgroups method definition
def list_workgroups(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    ownerAccount: str = ...,
) -> ListWorkgroupsResponseTypeDef:  # (1)
    ...# list_workgroups method usage example with argument unpacking
kwargs: ListWorkgroupsRequestTypeDef = {  # (1)
    "maxResults": ...,
}
parent.list_workgroups(**kwargs)put_resource_policy#
Creates or updates a resource policy.
Type annotations and code completion for boto3.client("redshift-serverless").put_resource_policy method.
 boto3 documentation
# put_resource_policy method definition
def put_resource_policy(
    self,
    *,
    policy: str,
    resourceArn: str,
) -> PutResourcePolicyResponseTypeDef:  # (1)
    ...# put_resource_policy method usage example with argument unpacking
kwargs: PutResourcePolicyRequestTypeDef = {  # (1)
    "policy": ...,
    "resourceArn": ...,
}
parent.put_resource_policy(**kwargs)restore_from_recovery_point#
Restore the data from a recovery point.
Type annotations and code completion for boto3.client("redshift-serverless").restore_from_recovery_point method.
 boto3 documentation
# restore_from_recovery_point method definition
def restore_from_recovery_point(
    self,
    *,
    namespaceName: str,
    recoveryPointId: str,
    workgroupName: str,
) -> RestoreFromRecoveryPointResponseTypeDef:  # (1)
    ...# restore_from_recovery_point method usage example with argument unpacking
kwargs: RestoreFromRecoveryPointRequestTypeDef = {  # (1)
    "namespaceName": ...,
    "recoveryPointId": ...,
    "workgroupName": ...,
}
parent.restore_from_recovery_point(**kwargs)restore_from_snapshot#
Restores a namespace from a snapshot.
Type annotations and code completion for boto3.client("redshift-serverless").restore_from_snapshot method.
 boto3 documentation
# restore_from_snapshot method definition
def restore_from_snapshot(
    self,
    *,
    namespaceName: str,
    workgroupName: str,
    adminPasswordSecretKmsKeyId: str = ...,
    manageAdminPassword: bool = ...,
    ownerAccount: str = ...,
    snapshotArn: str = ...,
    snapshotName: str = ...,
) -> RestoreFromSnapshotResponseTypeDef:  # (1)
    ...# restore_from_snapshot method usage example with argument unpacking
kwargs: RestoreFromSnapshotRequestTypeDef = {  # (1)
    "namespaceName": ...,
    "workgroupName": ...,
}
parent.restore_from_snapshot(**kwargs)restore_table_from_recovery_point#
Restores a table from a recovery point to your Amazon Redshift Serverless instance.
Type annotations and code completion for boto3.client("redshift-serverless").restore_table_from_recovery_point method.
 boto3 documentation
# restore_table_from_recovery_point method definition
def restore_table_from_recovery_point(
    self,
    *,
    namespaceName: str,
    newTableName: str,
    recoveryPointId: str,
    sourceDatabaseName: str,
    sourceTableName: str,
    workgroupName: str,
    activateCaseSensitiveIdentifier: bool = ...,
    sourceSchemaName: str = ...,
    targetDatabaseName: str = ...,
    targetSchemaName: str = ...,
) -> RestoreTableFromRecoveryPointResponseTypeDef:  # (1)
    ...# restore_table_from_recovery_point method usage example with argument unpacking
kwargs: RestoreTableFromRecoveryPointRequestTypeDef = {  # (1)
    "namespaceName": ...,
    "newTableName": ...,
    "recoveryPointId": ...,
    "sourceDatabaseName": ...,
    "sourceTableName": ...,
    "workgroupName": ...,
}
parent.restore_table_from_recovery_point(**kwargs)restore_table_from_snapshot#
Restores a table from a snapshot to your Amazon Redshift Serverless instance.
Type annotations and code completion for boto3.client("redshift-serverless").restore_table_from_snapshot method.
 boto3 documentation
# restore_table_from_snapshot method definition
def restore_table_from_snapshot(
    self,
    *,
    namespaceName: str,
    newTableName: str,
    snapshotName: str,
    sourceDatabaseName: str,
    sourceTableName: str,
    workgroupName: str,
    activateCaseSensitiveIdentifier: bool = ...,
    sourceSchemaName: str = ...,
    targetDatabaseName: str = ...,
    targetSchemaName: str = ...,
) -> RestoreTableFromSnapshotResponseTypeDef:  # (1)
    ...# restore_table_from_snapshot method usage example with argument unpacking
kwargs: RestoreTableFromSnapshotRequestTypeDef = {  # (1)
    "namespaceName": ...,
    "newTableName": ...,
    "snapshotName": ...,
    "sourceDatabaseName": ...,
    "sourceTableName": ...,
    "workgroupName": ...,
}
parent.restore_table_from_snapshot(**kwargs)tag_resource#
Assigns one or more tags to a resource.
Type annotations and code completion for boto3.client("redshift-serverless").tag_resource method.
 boto3 documentation
# tag_resource method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...- See Sequence[TagTypeDef]
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Removes a tag or set of tags from a resource.
Type annotations and code completion for boto3.client("redshift-serverless").untag_resource method.
 boto3 documentation
# untag_resource method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}
parent.untag_resource(**kwargs)update_custom_domain_association#
Updates an Amazon Redshift Serverless certificate associated with a custom domain.
Type annotations and code completion for boto3.client("redshift-serverless").update_custom_domain_association method.
 boto3 documentation
# update_custom_domain_association method definition
def update_custom_domain_association(
    self,
    *,
    customDomainCertificateArn: str,
    customDomainName: str,
    workgroupName: str,
) -> UpdateCustomDomainAssociationResponseTypeDef:  # (1)
    ...# update_custom_domain_association method usage example with argument unpacking
kwargs: UpdateCustomDomainAssociationRequestTypeDef = {  # (1)
    "customDomainCertificateArn": ...,
    "customDomainName": ...,
    "workgroupName": ...,
}
parent.update_custom_domain_association(**kwargs)update_endpoint_access#
Updates an Amazon Redshift Serverless managed endpoint.
Type annotations and code completion for boto3.client("redshift-serverless").update_endpoint_access method.
 boto3 documentation
# update_endpoint_access method definition
def update_endpoint_access(
    self,
    *,
    endpointName: str,
    vpcSecurityGroupIds: Sequence[str] = ...,
) -> UpdateEndpointAccessResponseTypeDef:  # (1)
    ...# update_endpoint_access method usage example with argument unpacking
kwargs: UpdateEndpointAccessRequestTypeDef = {  # (1)
    "endpointName": ...,
}
parent.update_endpoint_access(**kwargs)update_namespace#
Updates a namespace with the specified settings.
Type annotations and code completion for boto3.client("redshift-serverless").update_namespace method.
 boto3 documentation
# update_namespace method definition
def update_namespace(
    self,
    *,
    namespaceName: str,
    adminPasswordSecretKmsKeyId: str = ...,
    adminUserPassword: str = ...,
    adminUsername: str = ...,
    defaultIamRoleArn: str = ...,
    iamRoles: Sequence[str] = ...,
    kmsKeyId: str = ...,
    logExports: Sequence[LogExportType] = ...,  # (1)
    manageAdminPassword: bool = ...,
) -> UpdateNamespaceResponseTypeDef:  # (2)
    ...- See Sequence[LogExportType]
- See UpdateNamespaceResponseTypeDef
# update_namespace method usage example with argument unpacking
kwargs: UpdateNamespaceRequestTypeDef = {  # (1)
    "namespaceName": ...,
}
parent.update_namespace(**kwargs)update_scheduled_action#
Updates a scheduled action.
Type annotations and code completion for boto3.client("redshift-serverless").update_scheduled_action method.
 boto3 documentation
# update_scheduled_action method definition
def update_scheduled_action(
    self,
    *,
    scheduledActionName: str,
    enabled: bool = ...,
    endTime: TimestampTypeDef = ...,
    roleArn: str = ...,
    schedule: ScheduleUnionTypeDef = ...,  # (1)
    scheduledActionDescription: str = ...,
    startTime: TimestampTypeDef = ...,
    targetAction: TargetActionUnionTypeDef = ...,  # (2)
) -> UpdateScheduledActionResponseTypeDef:  # (3)
    ...# update_scheduled_action method usage example with argument unpacking
kwargs: UpdateScheduledActionRequestTypeDef = {  # (1)
    "scheduledActionName": ...,
}
parent.update_scheduled_action(**kwargs)update_snapshot#
Updates a snapshot.
Type annotations and code completion for boto3.client("redshift-serverless").update_snapshot method.
 boto3 documentation
# update_snapshot method definition
def update_snapshot(
    self,
    *,
    snapshotName: str,
    retentionPeriod: int = ...,
) -> UpdateSnapshotResponseTypeDef:  # (1)
    ...# update_snapshot method usage example with argument unpacking
kwargs: UpdateSnapshotRequestTypeDef = {  # (1)
    "snapshotName": ...,
}
parent.update_snapshot(**kwargs)update_snapshot_copy_configuration#
Updates a snapshot copy configuration.
Type annotations and code completion for boto3.client("redshift-serverless").update_snapshot_copy_configuration method.
 boto3 documentation
# update_snapshot_copy_configuration method definition
def update_snapshot_copy_configuration(
    self,
    *,
    snapshotCopyConfigurationId: str,
    snapshotRetentionPeriod: int = ...,
) -> UpdateSnapshotCopyConfigurationResponseTypeDef:  # (1)
    ...# update_snapshot_copy_configuration method usage example with argument unpacking
kwargs: UpdateSnapshotCopyConfigurationRequestTypeDef = {  # (1)
    "snapshotCopyConfigurationId": ...,
}
parent.update_snapshot_copy_configuration(**kwargs)update_usage_limit#
Update a usage limit in Amazon Redshift Serverless.
Type annotations and code completion for boto3.client("redshift-serverless").update_usage_limit method.
 boto3 documentation
# update_usage_limit method definition
def update_usage_limit(
    self,
    *,
    usageLimitId: str,
    amount: int = ...,
    breachAction: UsageLimitBreachActionType = ...,  # (1)
) -> UpdateUsageLimitResponseTypeDef:  # (2)
    ...# update_usage_limit method usage example with argument unpacking
kwargs: UpdateUsageLimitRequestTypeDef = {  # (1)
    "usageLimitId": ...,
}
parent.update_usage_limit(**kwargs)update_workgroup#
Updates a workgroup with the specified configuration settings.
Type annotations and code completion for boto3.client("redshift-serverless").update_workgroup method.
 boto3 documentation
# update_workgroup method definition
def update_workgroup(
    self,
    *,
    workgroupName: str,
    baseCapacity: int = ...,
    configParameters: Sequence[ConfigParameterTypeDef] = ...,  # (1)
    enhancedVpcRouting: bool = ...,
    ipAddressType: str = ...,
    maxCapacity: int = ...,
    port: int = ...,
    pricePerformanceTarget: PerformanceTargetTypeDef = ...,  # (2)
    publiclyAccessible: bool = ...,
    securityGroupIds: Sequence[str] = ...,
    subnetIds: Sequence[str] = ...,
    trackName: str = ...,
) -> UpdateWorkgroupResponseTypeDef:  # (3)
    ...- See Sequence[ConfigParameterTypeDef]
- See PerformanceTargetTypeDef
- See UpdateWorkgroupResponseTypeDef
# update_workgroup method usage example with argument unpacking
kwargs: UpdateWorkgroupRequestTypeDef = {  # (1)
    "workgroupName": ...,
}
parent.update_workgroup(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("redshift-serverless").get_paginator method with overloads.
- client.get_paginator("list_custom_domain_associations")-> ListCustomDomainAssociationsPaginator
- client.get_paginator("list_endpoint_access")-> ListEndpointAccessPaginator
- client.get_paginator("list_managed_workgroups")-> ListManagedWorkgroupsPaginator
- client.get_paginator("list_namespaces")-> ListNamespacesPaginator
- client.get_paginator("list_recovery_points")-> ListRecoveryPointsPaginator
- client.get_paginator("list_reservation_offerings")-> ListReservationOfferingsPaginator
- client.get_paginator("list_reservations")-> ListReservationsPaginator
- client.get_paginator("list_scheduled_actions")-> ListScheduledActionsPaginator
- client.get_paginator("list_snapshot_copy_configurations")-> ListSnapshotCopyConfigurationsPaginator
- client.get_paginator("list_snapshots")-> ListSnapshotsPaginator
- client.get_paginator("list_table_restore_status")-> ListTableRestoreStatusPaginator
- client.get_paginator("list_tracks")-> ListTracksPaginator
- client.get_paginator("list_usage_limits")-> ListUsageLimitsPaginator
- client.get_paginator("list_workgroups")-> ListWorkgroupsPaginator