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],
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)
- See LogExportType
- 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)
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)
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)
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],
PutResourcePolicyRequestRequestTypeDef#
# PutResourcePolicyRequestRequestTypeDef definition
class PutResourcePolicyRequestRequestTypeDef(TypedDict):
policy: str,
resourceArn: str,
RestoreFromRecoveryPointRequestRequestTypeDef#
# RestoreFromRecoveryPointRequestRequestTypeDef definition
class RestoreFromRecoveryPointRequestRequestTypeDef(TypedDict):
namespaceName: str,
recoveryPointId: str,
workgroupName: str,
RestoreFromSnapshotRequestRequestTypeDef#
# RestoreFromSnapshotRequestRequestTypeDef definition
class RestoreFromSnapshotRequestRequestTypeDef(TypedDict):
namespaceName: str,
workgroupName: str,
adminPasswordSecretKmsKeyId: NotRequired[str],
manageAdminPassword: NotRequired[bool],
ownerAccount: NotRequired[str],
snapshotArn: NotRequired[str],
snapshotName: NotRequired[str],
RestoreTableFromRecoveryPointRequestRequestTypeDef#
# RestoreTableFromRecoveryPointRequestRequestTypeDef definition
class RestoreTableFromRecoveryPointRequestRequestTypeDef(TypedDict):
namespaceName: str,
newTableName: str,
recoveryPointId: str,
sourceDatabaseName: str,
sourceTableName: str,
workgroupName: str,
activateCaseSensitiveIdentifier: NotRequired[bool],
sourceSchemaName: NotRequired[str],
targetDatabaseName: NotRequired[str],
targetSchemaName: NotRequired[str],
RestoreTableFromSnapshotRequestRequestTypeDef#
# RestoreTableFromSnapshotRequestRequestTypeDef definition
class RestoreTableFromSnapshotRequestRequestTypeDef(TypedDict):
namespaceName: str,
newTableName: str,
snapshotName: str,
sourceDatabaseName: str,
sourceTableName: str,
workgroupName: str,
activateCaseSensitiveIdentifier: NotRequired[bool],
sourceSchemaName: NotRequired[str],
targetDatabaseName: NotRequired[str],
targetSchemaName: NotRequired[str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateCustomDomainAssociationRequestRequestTypeDef#
# UpdateCustomDomainAssociationRequestRequestTypeDef definition
class UpdateCustomDomainAssociationRequestRequestTypeDef(TypedDict):
customDomainCertificateArn: str,
customDomainName: str,
workgroupName: str,
UpdateEndpointAccessRequestRequestTypeDef#
# UpdateEndpointAccessRequestRequestTypeDef definition
class UpdateEndpointAccessRequestRequestTypeDef(TypedDict):
endpointName: str,
vpcSecurityGroupIds: NotRequired[Sequence[str]],
UpdateNamespaceRequestRequestTypeDef#
# UpdateNamespaceRequestRequestTypeDef definition
class UpdateNamespaceRequestRequestTypeDef(TypedDict):
namespaceName: str,
adminPasswordSecretKmsKeyId: NotRequired[str],
adminUserPassword: NotRequired[str],
adminUsername: NotRequired[str],
defaultIamRoleArn: NotRequired[str],
iamRoles: NotRequired[Sequence[str]],
kmsKeyId: NotRequired[str],
logExports: NotRequired[Sequence[LogExportType]], # (1)
manageAdminPassword: NotRequired[bool],
- See LogExportType
UpdateSnapshotCopyConfigurationRequestRequestTypeDef#
# UpdateSnapshotCopyConfigurationRequestRequestTypeDef definition
class UpdateSnapshotCopyConfigurationRequestRequestTypeDef(TypedDict):
snapshotCopyConfigurationId: str,
snapshotRetentionPeriod: NotRequired[int],
UpdateSnapshotRequestRequestTypeDef#
# UpdateSnapshotRequestRequestTypeDef definition
class UpdateSnapshotRequestRequestTypeDef(TypedDict):
snapshotName: str,
retentionPeriod: NotRequired[int],
UpdateUsageLimitRequestRequestTypeDef#
# UpdateUsageLimitRequestRequestTypeDef definition
class UpdateUsageLimitRequestRequestTypeDef(TypedDict):
usageLimitId: str,
amount: NotRequired[int],
breachAction: NotRequired[UsageLimitBreachActionType], # (1)
UpdateWorkgroupRequestRequestTypeDef#
# UpdateWorkgroupRequestRequestTypeDef definition
class UpdateWorkgroupRequestRequestTypeDef(TypedDict):
workgroupName: str,
baseCapacity: NotRequired[int],
configParameters: NotRequired[Sequence[ConfigParameterTypeDef]], # (1)
enhancedVpcRouting: NotRequired[bool],
maxCapacity: NotRequired[int],
port: NotRequired[int],
publiclyAccessible: NotRequired[bool],
securityGroupIds: NotRequired[Sequence[str]],
subnetIds: NotRequired[Sequence[str]],
ConvertRecoveryPointToSnapshotRequestRequestTypeDef#
# ConvertRecoveryPointToSnapshotRequestRequestTypeDef definition
class ConvertRecoveryPointToSnapshotRequestRequestTypeDef(TypedDict):
recoveryPointId: str,
snapshotName: str,
retentionPeriod: NotRequired[int],
tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateNamespaceRequestRequestTypeDef#
# CreateNamespaceRequestRequestTypeDef definition
class CreateNamespaceRequestRequestTypeDef(TypedDict):
namespaceName: str,
adminPasswordSecretKmsKeyId: NotRequired[str],
adminUserPassword: NotRequired[str],
adminUsername: NotRequired[str],
dbName: NotRequired[str],
defaultIamRoleArn: NotRequired[str],
iamRoles: NotRequired[Sequence[str]],
kmsKeyId: NotRequired[str],
logExports: NotRequired[Sequence[LogExportType]], # (1)
manageAdminPassword: NotRequired[bool],
redshiftIdcApplicationArn: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See LogExportType
- See TagTypeDef
CreateSnapshotRequestRequestTypeDef#
# CreateSnapshotRequestRequestTypeDef definition
class CreateSnapshotRequestRequestTypeDef(TypedDict):
namespaceName: str,
snapshotName: str,
retentionPeriod: NotRequired[int],
tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateSnapshotScheduleActionParametersTypeDef#
# CreateSnapshotScheduleActionParametersTypeDef definition
class CreateSnapshotScheduleActionParametersTypeDef(TypedDict):
namespaceName: str,
snapshotNamePrefix: str,
retentionPeriod: NotRequired[int],
tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateWorkgroupRequestRequestTypeDef#
# CreateWorkgroupRequestRequestTypeDef definition
class CreateWorkgroupRequestRequestTypeDef(TypedDict):
namespaceName: str,
workgroupName: str,
baseCapacity: NotRequired[int],
configParameters: NotRequired[Sequence[ConfigParameterTypeDef]], # (1)
enhancedVpcRouting: NotRequired[bool],
maxCapacity: NotRequired[int],
port: NotRequired[int],
publiclyAccessible: NotRequired[bool],
securityGroupIds: NotRequired[Sequence[str]],
subnetIds: NotRequired[Sequence[str]],
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See ConfigParameterTypeDef
- See TagTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateCustomDomainAssociationResponseTypeDef#
# CreateCustomDomainAssociationResponseTypeDef definition
class CreateCustomDomainAssociationResponseTypeDef(TypedDict):
customDomainCertificateArn: str,
customDomainCertificateExpiryTime: datetime,
customDomainName: str,
workgroupName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetCredentialsResponseTypeDef#
# GetCredentialsResponseTypeDef definition
class GetCredentialsResponseTypeDef(TypedDict):
dbPassword: str,
dbUser: str,
expiration: datetime,
nextRefreshTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetCustomDomainAssociationResponseTypeDef#
# GetCustomDomainAssociationResponseTypeDef definition
class GetCustomDomainAssociationResponseTypeDef(TypedDict):
customDomainCertificateArn: str,
customDomainCertificateExpiryTime: datetime,
customDomainName: str,
workgroupName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListCustomDomainAssociationsResponseTypeDef#
# ListCustomDomainAssociationsResponseTypeDef definition
class ListCustomDomainAssociationsResponseTypeDef(TypedDict):
associations: List[AssociationTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListScheduledActionsResponseTypeDef#
# ListScheduledActionsResponseTypeDef definition
class ListScheduledActionsResponseTypeDef(TypedDict):
nextToken: str,
scheduledActions: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
UpdateCustomDomainAssociationResponseTypeDef#
# UpdateCustomDomainAssociationResponseTypeDef definition
class UpdateCustomDomainAssociationResponseTypeDef(TypedDict):
customDomainCertificateArn: str,
customDomainCertificateExpiryTime: datetime,
customDomainName: str,
workgroupName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ConvertRecoveryPointToSnapshotResponseTypeDef#
# ConvertRecoveryPointToSnapshotResponseTypeDef definition
class ConvertRecoveryPointToSnapshotResponseTypeDef(TypedDict):
snapshot: SnapshotTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateSnapshotResponseTypeDef#
# CreateSnapshotResponseTypeDef definition
class CreateSnapshotResponseTypeDef(TypedDict):
snapshot: SnapshotTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteSnapshotResponseTypeDef#
# DeleteSnapshotResponseTypeDef definition
class DeleteSnapshotResponseTypeDef(TypedDict):
snapshot: SnapshotTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSnapshotResponseTypeDef#
# GetSnapshotResponseTypeDef definition
class GetSnapshotResponseTypeDef(TypedDict):
snapshot: SnapshotTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSnapshotsResponseTypeDef#
# ListSnapshotsResponseTypeDef definition
class ListSnapshotsResponseTypeDef(TypedDict):
nextToken: str,
snapshots: List[SnapshotTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateSnapshotResponseTypeDef#
# UpdateSnapshotResponseTypeDef definition
class UpdateSnapshotResponseTypeDef(TypedDict):
snapshot: SnapshotTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateNamespaceResponseTypeDef#
# CreateNamespaceResponseTypeDef definition
class CreateNamespaceResponseTypeDef(TypedDict):
namespace: NamespaceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteNamespaceResponseTypeDef#
# DeleteNamespaceResponseTypeDef definition
class DeleteNamespaceResponseTypeDef(TypedDict):
namespace: NamespaceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetNamespaceResponseTypeDef#
# GetNamespaceResponseTypeDef definition
class GetNamespaceResponseTypeDef(TypedDict):
namespace: NamespaceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListNamespacesResponseTypeDef#
# ListNamespacesResponseTypeDef definition
class ListNamespacesResponseTypeDef(TypedDict):
namespaces: List[NamespaceTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RestoreFromRecoveryPointResponseTypeDef#
# RestoreFromRecoveryPointResponseTypeDef definition
class RestoreFromRecoveryPointResponseTypeDef(TypedDict):
namespace: NamespaceTypeDef, # (1)
recoveryPointId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RestoreFromSnapshotResponseTypeDef#
# RestoreFromSnapshotResponseTypeDef definition
class RestoreFromSnapshotResponseTypeDef(TypedDict):
namespace: NamespaceTypeDef, # (1)
ownerAccount: str,
snapshotName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateNamespaceResponseTypeDef#
# UpdateNamespaceResponseTypeDef definition
class UpdateNamespaceResponseTypeDef(TypedDict):
namespace: NamespaceTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListRecoveryPointsRequestRequestTypeDef#
# ListRecoveryPointsRequestRequestTypeDef definition
class ListRecoveryPointsRequestRequestTypeDef(TypedDict):
endTime: NotRequired[Union[datetime, str]],
maxResults: NotRequired[int],
namespaceArn: NotRequired[str],
namespaceName: NotRequired[str],
nextToken: NotRequired[str],
startTime: NotRequired[Union[datetime, str]],
ListSnapshotsRequestRequestTypeDef#
# ListSnapshotsRequestRequestTypeDef definition
class ListSnapshotsRequestRequestTypeDef(TypedDict):
endTime: NotRequired[Union[datetime, str]],
maxResults: NotRequired[int],
namespaceArn: NotRequired[str],
namespaceName: NotRequired[str],
nextToken: NotRequired[str],
ownerAccount: NotRequired[str],
startTime: NotRequired[Union[datetime, str]],
ScheduleTypeDef#
# ScheduleTypeDef definition
class ScheduleTypeDef(TypedDict):
at: NotRequired[Union[datetime, str]],
cron: NotRequired[str],
CreateSnapshotCopyConfigurationResponseTypeDef#
# CreateSnapshotCopyConfigurationResponseTypeDef definition
class CreateSnapshotCopyConfigurationResponseTypeDef(TypedDict):
snapshotCopyConfiguration: SnapshotCopyConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteSnapshotCopyConfigurationResponseTypeDef#
# DeleteSnapshotCopyConfigurationResponseTypeDef definition
class DeleteSnapshotCopyConfigurationResponseTypeDef(TypedDict):
snapshotCopyConfiguration: SnapshotCopyConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSnapshotCopyConfigurationsResponseTypeDef#
# ListSnapshotCopyConfigurationsResponseTypeDef definition
class ListSnapshotCopyConfigurationsResponseTypeDef(TypedDict):
nextToken: str,
snapshotCopyConfigurations: List[SnapshotCopyConfigurationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateSnapshotCopyConfigurationResponseTypeDef#
# UpdateSnapshotCopyConfigurationResponseTypeDef definition
class UpdateSnapshotCopyConfigurationResponseTypeDef(TypedDict):
snapshotCopyConfiguration: SnapshotCopyConfigurationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateUsageLimitResponseTypeDef#
# CreateUsageLimitResponseTypeDef definition
class CreateUsageLimitResponseTypeDef(TypedDict):
usageLimit: UsageLimitTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteUsageLimitResponseTypeDef#
# DeleteUsageLimitResponseTypeDef definition
class DeleteUsageLimitResponseTypeDef(TypedDict):
usageLimit: UsageLimitTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetUsageLimitResponseTypeDef#
# GetUsageLimitResponseTypeDef definition
class GetUsageLimitResponseTypeDef(TypedDict):
usageLimit: UsageLimitTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUsageLimitsResponseTypeDef#
# ListUsageLimitsResponseTypeDef definition
class ListUsageLimitsResponseTypeDef(TypedDict):
nextToken: str,
usageLimits: List[UsageLimitTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateUsageLimitResponseTypeDef#
# UpdateUsageLimitResponseTypeDef definition
class UpdateUsageLimitResponseTypeDef(TypedDict):
usageLimit: UsageLimitTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetRecoveryPointResponseTypeDef#
# GetRecoveryPointResponseTypeDef definition
class GetRecoveryPointResponseTypeDef(TypedDict):
recoveryPoint: RecoveryPointTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListRecoveryPointsResponseTypeDef#
# ListRecoveryPointsResponseTypeDef definition
class ListRecoveryPointsResponseTypeDef(TypedDict):
nextToken: str,
recoveryPoints: List[RecoveryPointTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetResourcePolicyResponseTypeDef#
# GetResourcePolicyResponseTypeDef definition
class GetResourcePolicyResponseTypeDef(TypedDict):
resourcePolicy: ResourcePolicyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutResourcePolicyResponseTypeDef#
# PutResourcePolicyResponseTypeDef definition
class PutResourcePolicyResponseTypeDef(TypedDict):
resourcePolicy: ResourcePolicyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetTableRestoreStatusResponseTypeDef#
# GetTableRestoreStatusResponseTypeDef definition
class GetTableRestoreStatusResponseTypeDef(TypedDict):
tableRestoreStatus: TableRestoreStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTableRestoreStatusResponseTypeDef#
# ListTableRestoreStatusResponseTypeDef definition
class ListTableRestoreStatusResponseTypeDef(TypedDict):
nextToken: str,
tableRestoreStatuses: List[TableRestoreStatusTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RestoreTableFromRecoveryPointResponseTypeDef#
# RestoreTableFromRecoveryPointResponseTypeDef definition
class RestoreTableFromRecoveryPointResponseTypeDef(TypedDict):
tableRestoreStatus: TableRestoreStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RestoreTableFromSnapshotResponseTypeDef#
# RestoreTableFromSnapshotResponseTypeDef definition
class RestoreTableFromSnapshotResponseTypeDef(TypedDict):
tableRestoreStatus: TableRestoreStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListCustomDomainAssociationsRequestListCustomDomainAssociationsPaginateTypeDef#
# ListCustomDomainAssociationsRequestListCustomDomainAssociationsPaginateTypeDef definition
class ListCustomDomainAssociationsRequestListCustomDomainAssociationsPaginateTypeDef(TypedDict):
customDomainCertificateArn: NotRequired[str],
customDomainName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListEndpointAccessRequestListEndpointAccessPaginateTypeDef#
# ListEndpointAccessRequestListEndpointAccessPaginateTypeDef definition
class ListEndpointAccessRequestListEndpointAccessPaginateTypeDef(TypedDict):
ownerAccount: NotRequired[str],
vpcId: NotRequired[str],
workgroupName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListNamespacesRequestListNamespacesPaginateTypeDef#
# ListNamespacesRequestListNamespacesPaginateTypeDef definition
class ListNamespacesRequestListNamespacesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRecoveryPointsRequestListRecoveryPointsPaginateTypeDef#
# ListRecoveryPointsRequestListRecoveryPointsPaginateTypeDef definition
class ListRecoveryPointsRequestListRecoveryPointsPaginateTypeDef(TypedDict):
endTime: NotRequired[Union[datetime, str]],
namespaceArn: NotRequired[str],
namespaceName: NotRequired[str],
startTime: NotRequired[Union[datetime, str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListScheduledActionsRequestListScheduledActionsPaginateTypeDef#
# ListScheduledActionsRequestListScheduledActionsPaginateTypeDef definition
class ListScheduledActionsRequestListScheduledActionsPaginateTypeDef(TypedDict):
namespaceName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListSnapshotCopyConfigurationsRequestListSnapshotCopyConfigurationsPaginateTypeDef#
# ListSnapshotCopyConfigurationsRequestListSnapshotCopyConfigurationsPaginateTypeDef definition
class ListSnapshotCopyConfigurationsRequestListSnapshotCopyConfigurationsPaginateTypeDef(TypedDict):
namespaceName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListSnapshotsRequestListSnapshotsPaginateTypeDef#
# ListSnapshotsRequestListSnapshotsPaginateTypeDef definition
class ListSnapshotsRequestListSnapshotsPaginateTypeDef(TypedDict):
endTime: NotRequired[Union[datetime, str]],
namespaceArn: NotRequired[str],
namespaceName: NotRequired[str],
ownerAccount: NotRequired[str],
startTime: NotRequired[Union[datetime, str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTableRestoreStatusRequestListTableRestoreStatusPaginateTypeDef#
# ListTableRestoreStatusRequestListTableRestoreStatusPaginateTypeDef definition
class ListTableRestoreStatusRequestListTableRestoreStatusPaginateTypeDef(TypedDict):
namespaceName: NotRequired[str],
workgroupName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUsageLimitsRequestListUsageLimitsPaginateTypeDef#
# ListUsageLimitsRequestListUsageLimitsPaginateTypeDef definition
class ListUsageLimitsRequestListUsageLimitsPaginateTypeDef(TypedDict):
resourceArn: NotRequired[str],
usageType: NotRequired[UsageLimitUsageTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListWorkgroupsRequestListWorkgroupsPaginateTypeDef#
# ListWorkgroupsRequestListWorkgroupsPaginateTypeDef definition
class ListWorkgroupsRequestListWorkgroupsPaginateTypeDef(TypedDict):
ownerAccount: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
VpcEndpointTypeDef#
# VpcEndpointTypeDef definition
class VpcEndpointTypeDef(TypedDict):
networkInterfaces: NotRequired[List[NetworkInterfaceTypeDef]], # (1)
vpcEndpointId: NotRequired[str],
vpcId: NotRequired[str],
TargetActionTypeDef#
# TargetActionTypeDef definition
class TargetActionTypeDef(TypedDict):
createSnapshot: NotRequired[CreateSnapshotScheduleActionParametersTypeDef], # (1)
EndpointAccessTypeDef#
# EndpointAccessTypeDef definition
class EndpointAccessTypeDef(TypedDict):
address: NotRequired[str],
endpointArn: NotRequired[str],
endpointCreateTime: NotRequired[datetime],
endpointName: NotRequired[str],
endpointStatus: NotRequired[str],
port: NotRequired[int],
subnetIds: NotRequired[List[str]],
vpcEndpoint: NotRequired[VpcEndpointTypeDef], # (1)
vpcSecurityGroups: NotRequired[List[VpcSecurityGroupMembershipTypeDef]], # (2)
workgroupName: NotRequired[str],
EndpointTypeDef#
# EndpointTypeDef definition
class EndpointTypeDef(TypedDict):
address: NotRequired[str],
port: NotRequired[int],
vpcEndpoints: NotRequired[List[VpcEndpointTypeDef]], # (1)
CreateScheduledActionRequestRequestTypeDef#
# CreateScheduledActionRequestRequestTypeDef definition
class CreateScheduledActionRequestRequestTypeDef(TypedDict):
namespaceName: str,
roleArn: str,
schedule: ScheduleTypeDef, # (1)
scheduledActionName: str,
targetAction: TargetActionTypeDef, # (2)
enabled: NotRequired[bool],
endTime: NotRequired[Union[datetime, str]],
scheduledActionDescription: NotRequired[str],
startTime: NotRequired[Union[datetime, str]],
- See ScheduleTypeDef
- See TargetActionTypeDef
ScheduledActionResponseTypeDef#
# ScheduledActionResponseTypeDef definition
class ScheduledActionResponseTypeDef(TypedDict):
endTime: NotRequired[datetime],
namespaceName: NotRequired[str],
nextInvocations: NotRequired[List[datetime]],
roleArn: NotRequired[str],
schedule: NotRequired[ScheduleTypeDef], # (1)
scheduledActionDescription: NotRequired[str],
scheduledActionName: NotRequired[str],
scheduledActionUuid: NotRequired[str],
startTime: NotRequired[datetime],
state: NotRequired[StateType], # (2)
targetAction: NotRequired[TargetActionTypeDef], # (3)
- See ScheduleTypeDef
- See StateType
- See TargetActionTypeDef
UpdateScheduledActionRequestRequestTypeDef#
# UpdateScheduledActionRequestRequestTypeDef definition
class UpdateScheduledActionRequestRequestTypeDef(TypedDict):
scheduledActionName: str,
enabled: NotRequired[bool],
endTime: NotRequired[Union[datetime, str]],
roleArn: NotRequired[str],
schedule: NotRequired[ScheduleTypeDef], # (1)
scheduledActionDescription: NotRequired[str],
startTime: NotRequired[Union[datetime, str]],
targetAction: NotRequired[TargetActionTypeDef], # (2)
- See ScheduleTypeDef
- See TargetActionTypeDef
CreateEndpointAccessResponseTypeDef#
# CreateEndpointAccessResponseTypeDef definition
class CreateEndpointAccessResponseTypeDef(TypedDict):
endpoint: EndpointAccessTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteEndpointAccessResponseTypeDef#
# DeleteEndpointAccessResponseTypeDef definition
class DeleteEndpointAccessResponseTypeDef(TypedDict):
endpoint: EndpointAccessTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetEndpointAccessResponseTypeDef#
# GetEndpointAccessResponseTypeDef definition
class GetEndpointAccessResponseTypeDef(TypedDict):
endpoint: EndpointAccessTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListEndpointAccessResponseTypeDef#
# ListEndpointAccessResponseTypeDef definition
class ListEndpointAccessResponseTypeDef(TypedDict):
endpoints: List[EndpointAccessTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateEndpointAccessResponseTypeDef#
# UpdateEndpointAccessResponseTypeDef definition
class UpdateEndpointAccessResponseTypeDef(TypedDict):
endpoint: EndpointAccessTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
WorkgroupTypeDef#
# WorkgroupTypeDef definition
class WorkgroupTypeDef(TypedDict):
baseCapacity: NotRequired[int],
configParameters: NotRequired[List[ConfigParameterTypeDef]], # (1)
creationDate: NotRequired[datetime],
crossAccountVpcs: NotRequired[List[str]],
customDomainCertificateArn: NotRequired[str],
customDomainCertificateExpiryTime: NotRequired[datetime],
customDomainName: NotRequired[str],
endpoint: NotRequired[EndpointTypeDef], # (2)
enhancedVpcRouting: NotRequired[bool],
maxCapacity: NotRequired[int],
namespaceName: NotRequired[str],
patchVersion: NotRequired[str],
port: NotRequired[int],
publiclyAccessible: NotRequired[bool],
securityGroupIds: NotRequired[List[str]],
status: NotRequired[WorkgroupStatusType], # (3)
subnetIds: NotRequired[List[str]],
workgroupArn: NotRequired[str],
workgroupId: NotRequired[str],
workgroupName: NotRequired[str],
workgroupVersion: NotRequired[str],
- See ConfigParameterTypeDef
- See EndpointTypeDef
- See WorkgroupStatusType
CreateScheduledActionResponseTypeDef#
# CreateScheduledActionResponseTypeDef definition
class CreateScheduledActionResponseTypeDef(TypedDict):
scheduledAction: ScheduledActionResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteScheduledActionResponseTypeDef#
# DeleteScheduledActionResponseTypeDef definition
class DeleteScheduledActionResponseTypeDef(TypedDict):
scheduledAction: ScheduledActionResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetScheduledActionResponseTypeDef#
# GetScheduledActionResponseTypeDef definition
class GetScheduledActionResponseTypeDef(TypedDict):
scheduledAction: ScheduledActionResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateScheduledActionResponseTypeDef#
# UpdateScheduledActionResponseTypeDef definition
class UpdateScheduledActionResponseTypeDef(TypedDict):
scheduledAction: ScheduledActionResponseTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateWorkgroupResponseTypeDef#
# CreateWorkgroupResponseTypeDef definition
class CreateWorkgroupResponseTypeDef(TypedDict):
workgroup: WorkgroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteWorkgroupResponseTypeDef#
# DeleteWorkgroupResponseTypeDef definition
class DeleteWorkgroupResponseTypeDef(TypedDict):
workgroup: WorkgroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetWorkgroupResponseTypeDef#
# GetWorkgroupResponseTypeDef definition
class GetWorkgroupResponseTypeDef(TypedDict):
workgroup: WorkgroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListWorkgroupsResponseTypeDef#
# ListWorkgroupsResponseTypeDef definition
class ListWorkgroupsResponseTypeDef(TypedDict):
nextToken: str,
workgroups: List[WorkgroupTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateWorkgroupResponseTypeDef#
# UpdateWorkgroupResponseTypeDef definition
class UpdateWorkgroupResponseTypeDef(TypedDict):
workgroup: WorkgroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)