Skip to content

Type definitions#

Index > RedshiftServerless > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AssociationTypeDef#

# AssociationTypeDef definition

class AssociationTypeDef(TypedDict):
    customDomainCertificateArn: NotRequired[str],
    customDomainCertificateExpiryTime: NotRequired[datetime],
    customDomainName: NotRequired[str],
    workgroupName: NotRequired[str],

ConfigParameterTypeDef#

# ConfigParameterTypeDef definition

class ConfigParameterTypeDef(TypedDict):
    parameterKey: NotRequired[str],
    parameterValue: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

SnapshotTypeDef#

# SnapshotTypeDef definition

class SnapshotTypeDef(TypedDict):
    accountsWithProvisionedRestoreAccess: NotRequired[List[str]],
    accountsWithRestoreAccess: NotRequired[List[str]],
    actualIncrementalBackupSizeInMegaBytes: NotRequired[float],
    adminPasswordSecretArn: NotRequired[str],
    adminPasswordSecretKmsKeyId: NotRequired[str],
    adminUsername: NotRequired[str],
    backupProgressInMegaBytes: NotRequired[float],
    currentBackupRateInMegaBytesPerSecond: NotRequired[float],
    elapsedTimeInSeconds: NotRequired[int],
    estimatedSecondsToCompletion: NotRequired[int],
    kmsKeyId: NotRequired[str],
    namespaceArn: NotRequired[str],
    namespaceName: NotRequired[str],
    ownerAccount: NotRequired[str],
    snapshotArn: NotRequired[str],
    snapshotCreateTime: NotRequired[datetime],
    snapshotName: NotRequired[str],
    snapshotRemainingDays: NotRequired[int],
    snapshotRetentionPeriod: NotRequired[int],
    snapshotRetentionStartTime: NotRequired[datetime],
    status: NotRequired[SnapshotStatusType],  # (1)
    totalBackupSizeInMegaBytes: NotRequired[float],
  1. See SnapshotStatusType

CreateCustomDomainAssociationRequestRequestTypeDef#

# CreateCustomDomainAssociationRequestRequestTypeDef definition

class CreateCustomDomainAssociationRequestRequestTypeDef(TypedDict):
    customDomainCertificateArn: str,
    customDomainName: str,
    workgroupName: str,

CreateEndpointAccessRequestRequestTypeDef#

# CreateEndpointAccessRequestRequestTypeDef definition

class CreateEndpointAccessRequestRequestTypeDef(TypedDict):
    endpointName: str,
    subnetIds: Sequence[str],
    workgroupName: str,
    ownerAccount: NotRequired[str],
    vpcSecurityGroupIds: NotRequired[Sequence[str]],

NamespaceTypeDef#

# NamespaceTypeDef definition

class NamespaceTypeDef(TypedDict):
    adminPasswordSecretArn: NotRequired[str],
    adminPasswordSecretKmsKeyId: NotRequired[str],
    adminUsername: NotRequired[str],
    creationDate: NotRequired[datetime],
    dbName: NotRequired[str],
    defaultIamRoleArn: NotRequired[str],
    iamRoles: NotRequired[List[str]],
    kmsKeyId: NotRequired[str],
    logExports: NotRequired[List[LogExportType]],  # (1)
    namespaceArn: NotRequired[str],
    namespaceId: NotRequired[str],
    namespaceName: NotRequired[str],
    status: NotRequired[NamespaceStatusType],  # (2)
  1. See LogExportType
  2. See NamespaceStatusType

CreateSnapshotCopyConfigurationRequestRequestTypeDef#

# CreateSnapshotCopyConfigurationRequestRequestTypeDef definition

class CreateSnapshotCopyConfigurationRequestRequestTypeDef(TypedDict):
    destinationRegion: str,
    namespaceName: str,
    destinationKmsKeyId: NotRequired[str],
    snapshotRetentionPeriod: NotRequired[int],

SnapshotCopyConfigurationTypeDef#

# SnapshotCopyConfigurationTypeDef definition

class SnapshotCopyConfigurationTypeDef(TypedDict):
    destinationKmsKeyId: NotRequired[str],
    destinationRegion: NotRequired[str],
    namespaceName: NotRequired[str],
    snapshotCopyConfigurationArn: NotRequired[str],
    snapshotCopyConfigurationId: NotRequired[str],
    snapshotRetentionPeriod: NotRequired[int],

CreateUsageLimitRequestRequestTypeDef#

# CreateUsageLimitRequestRequestTypeDef definition

class CreateUsageLimitRequestRequestTypeDef(TypedDict):
    amount: int,
    resourceArn: str,
    usageType: UsageLimitUsageTypeType,  # (1)
    breachAction: NotRequired[UsageLimitBreachActionType],  # (2)
    period: NotRequired[UsageLimitPeriodType],  # (3)
  1. See UsageLimitUsageTypeType
  2. See UsageLimitBreachActionType
  3. See UsageLimitPeriodType

UsageLimitTypeDef#

# UsageLimitTypeDef definition

class UsageLimitTypeDef(TypedDict):
    amount: NotRequired[int],
    breachAction: NotRequired[UsageLimitBreachActionType],  # (1)
    period: NotRequired[UsageLimitPeriodType],  # (2)
    resourceArn: NotRequired[str],
    usageLimitArn: NotRequired[str],
    usageLimitId: NotRequired[str],
    usageType: NotRequired[UsageLimitUsageTypeType],  # (3)
  1. See UsageLimitBreachActionType
  2. See UsageLimitPeriodType
  3. See UsageLimitUsageTypeType

DeleteCustomDomainAssociationRequestRequestTypeDef#

# DeleteCustomDomainAssociationRequestRequestTypeDef definition

class DeleteCustomDomainAssociationRequestRequestTypeDef(TypedDict):
    customDomainName: str,
    workgroupName: str,

DeleteEndpointAccessRequestRequestTypeDef#

# DeleteEndpointAccessRequestRequestTypeDef definition

class DeleteEndpointAccessRequestRequestTypeDef(TypedDict):
    endpointName: str,

DeleteNamespaceRequestRequestTypeDef#

# DeleteNamespaceRequestRequestTypeDef definition

class DeleteNamespaceRequestRequestTypeDef(TypedDict):
    namespaceName: str,
    finalSnapshotName: NotRequired[str],
    finalSnapshotRetentionPeriod: NotRequired[int],

DeleteResourcePolicyRequestRequestTypeDef#

# DeleteResourcePolicyRequestRequestTypeDef definition

class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
    resourceArn: str,

DeleteScheduledActionRequestRequestTypeDef#

# DeleteScheduledActionRequestRequestTypeDef definition

class DeleteScheduledActionRequestRequestTypeDef(TypedDict):
    scheduledActionName: str,

DeleteSnapshotCopyConfigurationRequestRequestTypeDef#

# DeleteSnapshotCopyConfigurationRequestRequestTypeDef definition

class DeleteSnapshotCopyConfigurationRequestRequestTypeDef(TypedDict):
    snapshotCopyConfigurationId: str,

DeleteSnapshotRequestRequestTypeDef#

# DeleteSnapshotRequestRequestTypeDef definition

class DeleteSnapshotRequestRequestTypeDef(TypedDict):
    snapshotName: str,

DeleteUsageLimitRequestRequestTypeDef#

# DeleteUsageLimitRequestRequestTypeDef definition

class DeleteUsageLimitRequestRequestTypeDef(TypedDict):
    usageLimitId: str,

DeleteWorkgroupRequestRequestTypeDef#

# DeleteWorkgroupRequestRequestTypeDef definition

class DeleteWorkgroupRequestRequestTypeDef(TypedDict):
    workgroupName: str,

VpcSecurityGroupMembershipTypeDef#

# VpcSecurityGroupMembershipTypeDef definition

class VpcSecurityGroupMembershipTypeDef(TypedDict):
    status: NotRequired[str],
    vpcSecurityGroupId: NotRequired[str],

GetCredentialsRequestRequestTypeDef#

# GetCredentialsRequestRequestTypeDef definition

class GetCredentialsRequestRequestTypeDef(TypedDict):
    customDomainName: NotRequired[str],
    dbName: NotRequired[str],
    durationSeconds: NotRequired[int],
    workgroupName: NotRequired[str],

GetCustomDomainAssociationRequestRequestTypeDef#

# GetCustomDomainAssociationRequestRequestTypeDef definition

class GetCustomDomainAssociationRequestRequestTypeDef(TypedDict):
    customDomainName: str,
    workgroupName: str,

GetEndpointAccessRequestRequestTypeDef#

# GetEndpointAccessRequestRequestTypeDef definition

class GetEndpointAccessRequestRequestTypeDef(TypedDict):
    endpointName: str,

GetNamespaceRequestRequestTypeDef#

# GetNamespaceRequestRequestTypeDef definition

class GetNamespaceRequestRequestTypeDef(TypedDict):
    namespaceName: str,

GetRecoveryPointRequestRequestTypeDef#

# GetRecoveryPointRequestRequestTypeDef definition

class GetRecoveryPointRequestRequestTypeDef(TypedDict):
    recoveryPointId: str,

RecoveryPointTypeDef#

# RecoveryPointTypeDef definition

class RecoveryPointTypeDef(TypedDict):
    namespaceArn: NotRequired[str],
    namespaceName: NotRequired[str],
    recoveryPointCreateTime: NotRequired[datetime],
    recoveryPointId: NotRequired[str],
    totalSizeInMegaBytes: NotRequired[float],
    workgroupName: NotRequired[str],

GetResourcePolicyRequestRequestTypeDef#

# GetResourcePolicyRequestRequestTypeDef definition

class GetResourcePolicyRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ResourcePolicyTypeDef#

# ResourcePolicyTypeDef definition

class ResourcePolicyTypeDef(TypedDict):
    policy: NotRequired[str],
    resourceArn: NotRequired[str],

GetScheduledActionRequestRequestTypeDef#

# GetScheduledActionRequestRequestTypeDef definition

class GetScheduledActionRequestRequestTypeDef(TypedDict):
    scheduledActionName: str,

GetSnapshotRequestRequestTypeDef#

# GetSnapshotRequestRequestTypeDef definition

class GetSnapshotRequestRequestTypeDef(TypedDict):
    ownerAccount: NotRequired[str],
    snapshotArn: NotRequired[str],
    snapshotName: NotRequired[str],

GetTableRestoreStatusRequestRequestTypeDef#

# GetTableRestoreStatusRequestRequestTypeDef definition

class GetTableRestoreStatusRequestRequestTypeDef(TypedDict):
    tableRestoreRequestId: str,

TableRestoreStatusTypeDef#

# TableRestoreStatusTypeDef definition

class TableRestoreStatusTypeDef(TypedDict):
    message: NotRequired[str],
    namespaceName: NotRequired[str],
    newTableName: NotRequired[str],
    progressInMegaBytes: NotRequired[int],
    recoveryPointId: NotRequired[str],
    requestTime: NotRequired[datetime],
    snapshotName: NotRequired[str],
    sourceDatabaseName: NotRequired[str],
    sourceSchemaName: NotRequired[str],
    sourceTableName: NotRequired[str],
    status: NotRequired[str],
    tableRestoreRequestId: NotRequired[str],
    targetDatabaseName: NotRequired[str],
    targetSchemaName: NotRequired[str],
    totalDataInMegaBytes: NotRequired[int],
    workgroupName: NotRequired[str],

GetUsageLimitRequestRequestTypeDef#

# GetUsageLimitRequestRequestTypeDef definition

class GetUsageLimitRequestRequestTypeDef(TypedDict):
    usageLimitId: str,

GetWorkgroupRequestRequestTypeDef#

# GetWorkgroupRequestRequestTypeDef definition

class GetWorkgroupRequestRequestTypeDef(TypedDict):
    workgroupName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListCustomDomainAssociationsRequestRequestTypeDef#

# ListCustomDomainAssociationsRequestRequestTypeDef definition

class ListCustomDomainAssociationsRequestRequestTypeDef(TypedDict):
    customDomainCertificateArn: NotRequired[str],
    customDomainName: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListEndpointAccessRequestRequestTypeDef#

# ListEndpointAccessRequestRequestTypeDef definition

class ListEndpointAccessRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    ownerAccount: NotRequired[str],
    vpcId: NotRequired[str],
    workgroupName: NotRequired[str],

ListNamespacesRequestRequestTypeDef#

# ListNamespacesRequestRequestTypeDef definition

class ListNamespacesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListScheduledActionsRequestRequestTypeDef#

# ListScheduledActionsRequestRequestTypeDef definition

class ListScheduledActionsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    namespaceName: NotRequired[str],
    nextToken: NotRequired[str],

ListSnapshotCopyConfigurationsRequestRequestTypeDef#

# ListSnapshotCopyConfigurationsRequestRequestTypeDef definition

class ListSnapshotCopyConfigurationsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    namespaceName: NotRequired[str],
    nextToken: NotRequired[str],

ListTableRestoreStatusRequestRequestTypeDef#

# ListTableRestoreStatusRequestRequestTypeDef definition

class ListTableRestoreStatusRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    namespaceName: NotRequired[str],
    nextToken: NotRequired[str],
    workgroupName: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListUsageLimitsRequestRequestTypeDef#

# ListUsageLimitsRequestRequestTypeDef definition

class ListUsageLimitsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    resourceArn: NotRequired[str],
    usageType: NotRequired[UsageLimitUsageTypeType],  # (1)
  1. See UsageLimitUsageTypeType

ListWorkgroupsRequestRequestTypeDef#

# ListWorkgroupsRequestRequestTypeDef definition

class ListWorkgroupsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    ownerAccount: NotRequired[str],

NetworkInterfaceTypeDef#

# NetworkInterfaceTypeDef definition

class NetworkInterfaceTypeDef(TypedDict):
    availabilityZone: NotRequired[str],
    networkInterfaceId: NotRequired[str],
    privateIpAddress: NotRequired[str],
    subnetId: NotRequired[str],

PutResourcePolicyRequestRequestT