Redshift module#
Index > Redshift
Auto-generated documentation for Redshift type annotations stubs module mypy-boto3-redshift.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Redshift
.
From PyPI with pip#
Install boto3-stubs
for Redshift
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[redshift]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[redshift]'
# standalone installation
python -m pip install mypy-boto3-redshift
How to uninstall#
python -m pip uninstall -y mypy-boto3-redshift
Usage#
Code samples can be found in Examples.
RedshiftClient#
Type annotations and code completion for boto3.client("redshift")
as RedshiftClient
boto3 documentation
# RedshiftClient usage example
from boto3.session import Session
from mypy_boto3_redshift.client import RedshiftClient
def get_client() -> RedshiftClient:
return Session().client("redshift")
Paginators#
Type annotations and code completion for paginators
from boto3.client("redshift").get_paginator("...")
.
# DescribeClusterDbRevisionsPaginator usage example
from boto3.session import Session
from mypy_boto3_redshift.paginator import DescribeClusterDbRevisionsPaginator
def get_describe_cluster_db_revisions_paginator() -> DescribeClusterDbRevisionsPaginator:
return Session().client("redshift").get_paginator("describe_cluster_db_revisions"))
- DescribeClusterDbRevisionsPaginator
- DescribeClusterParameterGroupsPaginator
- DescribeClusterParametersPaginator
- DescribeClusterSecurityGroupsPaginator
- DescribeClusterSnapshotsPaginator
- DescribeClusterSubnetGroupsPaginator
- DescribeClusterTracksPaginator
- DescribeClusterVersionsPaginator
- DescribeClustersPaginator
- DescribeDataSharesPaginator
- DescribeDataSharesForConsumerPaginator
- DescribeDataSharesForProducerPaginator
- DescribeDefaultClusterParametersPaginator
- DescribeEndpointAccessPaginator
- DescribeEndpointAuthorizationPaginator
- DescribeEventSubscriptionsPaginator
- DescribeEventsPaginator
- DescribeHsmClientCertificatesPaginator
- DescribeHsmConfigurationsPaginator
- DescribeNodeConfigurationOptionsPaginator
- DescribeOrderableClusterOptionsPaginator
- DescribeReservedNodeExchangeStatusPaginator
- DescribeReservedNodeOfferingsPaginator
- DescribeReservedNodesPaginator
- DescribeScheduledActionsPaginator
- DescribeSnapshotCopyGrantsPaginator
- DescribeSnapshotSchedulesPaginator
- DescribeTableRestoreStatusPaginator
- DescribeTagsPaginator
- DescribeUsageLimitsPaginator
- GetReservedNodeExchangeConfigurationOptionsPaginator
- GetReservedNodeExchangeOfferingsPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("redshift").get_waiter("...")
.
# ClusterAvailableWaiter usage example
from boto3.session import Session
from mypy_boto3_redshift.waiter import ClusterAvailableWaiter
def get_cluster_available_waiter() -> ClusterAvailableWaiter:
return Session().client("redshift").get_waiter("cluster_available")
Literals#
Type annotations for literals used in methods and schemas.
# ActionTypeType usage example
from mypy_boto3_redshift.literals import ActionTypeType
def get_value() -> ActionTypeType:
return "recommend-node-config"
- ActionTypeType
- AquaConfigurationStatusType
- AquaStatusType
- AuthorizationStatusType
- ClusterAvailableWaiterName
- ClusterDeletedWaiterName
- ClusterRestoredWaiterName
- DataShareStatusForConsumerType
- DataShareStatusForProducerType
- DataShareStatusType
- DescribeClusterDbRevisionsPaginatorName
- DescribeClusterParameterGroupsPaginatorName
- DescribeClusterParametersPaginatorName
- DescribeClusterSecurityGroupsPaginatorName
- DescribeClusterSnapshotsPaginatorName
- DescribeClusterSubnetGroupsPaginatorName
- DescribeClusterTracksPaginatorName
- DescribeClusterVersionsPaginatorName
- DescribeClustersPaginatorName
- DescribeDataSharesForConsumerPaginatorName
- DescribeDataSharesForProducerPaginatorName
- DescribeDataSharesPaginatorName
- DescribeDefaultClusterParametersPaginatorName
- DescribeEndpointAccessPaginatorName
- DescribeEndpointAuthorizationPaginatorName
- DescribeEventSubscriptionsPaginatorName
- DescribeEventsPaginatorName
- DescribeHsmClientCertificatesPaginatorName
- DescribeHsmConfigurationsPaginatorName
- DescribeNodeConfigurationOptionsPaginatorName
- DescribeOrderableClusterOptionsPaginatorName
- DescribeReservedNodeExchangeStatusPaginatorName
- DescribeReservedNodeOfferingsPaginatorName
- DescribeReservedNodesPaginatorName
- DescribeScheduledActionsPaginatorName
- DescribeSnapshotCopyGrantsPaginatorName
- DescribeSnapshotSchedulesPaginatorName
- DescribeTableRestoreStatusPaginatorName
- DescribeTagsPaginatorName
- DescribeUsageLimitsPaginatorName
- GetReservedNodeExchangeConfigurationOptionsPaginatorName
- GetReservedNodeExchangeOfferingsPaginatorName
- LogDestinationTypeType
- ModeType
- NodeConfigurationOptionsFilterNameType
- OperatorTypeType
- ParameterApplyTypeType
- PartnerIntegrationStatusType
- ReservedNodeExchangeActionTypeType
- ReservedNodeExchangeStatusTypeType
- ReservedNodeOfferingTypeType
- ScheduleStateType
- ScheduledActionFilterNameType
- ScheduledActionStateType
- ScheduledActionTypeValuesType
- SnapshotAttributeToSortByType
- SnapshotAvailableWaiterName
- SortByOrderType
- SourceTypeType
- TableRestoreStatusTypeType
- UsageLimitBreachActionType
- UsageLimitFeatureTypeType
- UsageLimitLimitTypeType
- UsageLimitPeriodType
- RedshiftServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AcceptReservedNodeExchangeInputMessageRequestTypeDef usage example
from mypy_boto3_redshift.type_defs import AcceptReservedNodeExchangeInputMessageRequestTypeDef
def get_value() -> AcceptReservedNodeExchangeInputMessageRequestTypeDef:
return {
"ReservedNodeId": ...,
"TargetReservedNodeOfferingId": ...,
}
- AcceptReservedNodeExchangeInputMessageRequestTypeDef
- AttributeValueTargetTypeDef
- AccountWithRestoreAccessTypeDef
- AquaConfigurationTypeDef
- AssociateDataShareConsumerMessageRequestTypeDef
- AuthenticationProfileTypeDef
- AuthorizeClusterSecurityGroupIngressMessageRequestTypeDef
- AuthorizeDataShareMessageRequestTypeDef
- AuthorizeEndpointAccessMessageRequestTypeDef
- AuthorizeSnapshotAccessMessageRequestTypeDef
- SupportedPlatformTypeDef
- DeleteClusterSnapshotMessageTypeDef
- SnapshotErrorMessageTypeDef
- BatchModifyClusterSnapshotsMessageRequestTypeDef
- CancelResizeMessageRequestTypeDef
- ClusterAssociatedToScheduleTypeDef
- ClusterCredentialsTypeDef
- RevisionTargetTypeDef
- ClusterExtendedCredentialsTypeDef
- ClusterIamRoleTypeDef
- ClusterNodeTypeDef
- ParameterTypeDef
- ClusterParameterGroupNameMessageTypeDef
- ClusterParameterStatusTypeDef
- TagTypeDef
- ClusterSecurityGroupMembershipTypeDef
- ClusterSnapshotCopyStatusTypeDef
- DataTransferProgressTypeDef
- DeferredMaintenanceWindowTypeDef
- ElasticIpStatusTypeDef
- HsmStatusTypeDef
- PendingModifiedValuesTypeDef
- ReservedNodeExchangeStatusTypeDef
- ResizeInfoTypeDef
- RestoreStatusTypeDef
- VpcSecurityGroupMembershipTypeDef
- ClusterVersionTypeDef
- CopyClusterSnapshotMessageRequestTypeDef
- CreateAuthenticationProfileMessageRequestTypeDef
- CreateAuthenticationProfileResultTypeDef
- CreateEndpointAccessMessageRequestTypeDef
- CustomerStorageMessageTypeDef
- DataShareAssociationTypeDef
- DeauthorizeDataShareMessageRequestTypeDef
- DeleteAuthenticationProfileMessageRequestTypeDef
- DeleteAuthenticationProfileResultTypeDef
- DeleteClusterMessageRequestTypeDef
- DeleteClusterParameterGroupMessageRequestTypeDef
- DeleteClusterSecurityGroupMessageRequestTypeDef
- DeleteClusterSnapshotMessageRequestTypeDef
- DeleteClusterSubnetGroupMessageRequestTypeDef
- DeleteEndpointAccessMessageRequestTypeDef
- DeleteEventSubscriptionMessageRequestTypeDef
- DeleteHsmClientCertificateMessageRequestTypeDef
- DeleteHsmConfigurationMessageRequestTypeDef
- DeleteScheduledActionMessageRequestTypeDef
- DeleteSnapshotCopyGrantMessageRequestTypeDef
- DeleteSnapshotScheduleMessageRequestTypeDef
- DeleteTagsMessageRequestTypeDef
- DeleteUsageLimitMessageRequestTypeDef
- DescribeAccountAttributesMessageRequestTypeDef
- DescribeAuthenticationProfilesMessageRequestTypeDef
- DescribeClusterDbRevisionsMessageDescribeClusterDbRevisionsPaginateTypeDef
- DescribeClusterDbRevisionsMessageRequestTypeDef
- DescribeClusterParameterGroupsMessageDescribeClusterParameterGroupsPaginateTypeDef
- DescribeClusterParameterGroupsMessageRequestTypeDef
- DescribeClusterParametersMessageDescribeClusterParametersPaginateTypeDef
- DescribeClusterParametersMessageRequestTypeDef
- DescribeClusterSecurityGroupsMessageDescribeClusterSecurityGroupsPaginateTypeDef
- DescribeClusterSecurityGroupsMessageRequestTypeDef
- SnapshotSortingEntityTypeDef
- WaiterConfigTypeDef
- DescribeClusterSubnetGroupsMessageDescribeClusterSubnetGroupsPaginateTypeDef
- DescribeClusterSubnetGroupsMessageRequestTypeDef
- DescribeClusterTracksMessageDescribeClusterTracksPaginateTypeDef
- DescribeClusterTracksMessageRequestTypeDef
- DescribeClusterVersionsMessageDescribeClusterVersionsPaginateTypeDef
- DescribeClusterVersionsMessageRequestTypeDef
- DescribeClustersMessageDescribeClustersPaginateTypeDef
- DescribeClustersMessageRequestTypeDef
- DescribeDataSharesForConsumerMessageDescribeDataSharesForConsumerPaginateTypeDef
- DescribeDataSharesForConsumerMessageRequestTypeDef
- DescribeDataSharesForProducerMessageDescribeDataSharesForProducerPaginateTypeDef
- DescribeDataSharesForProducerMessageRequestTypeDef
- DescribeDataSharesMessageDescribeDataSharesPaginateTypeDef
- DescribeDataSharesMessageRequestTypeDef
- DescribeDefaultClusterParametersMessageDescribeDefaultClusterParametersPaginateTypeDef
- DescribeDefaultClusterParametersMessageRequestTypeDef
- DescribeEndpointAccessMessageDescribeEndpointAccessPaginateTypeDef
- DescribeEndpointAccessMessageRequestTypeDef
- DescribeEndpointAuthorizationMessageDescribeEndpointAuthorizationPaginateTypeDef
- DescribeEndpointAuthorizationMessageRequestTypeDef
- DescribeEventCategoriesMessageRequestTypeDef
- DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef
- DescribeEventSubscriptionsMessageRequestTypeDef
- DescribeEventsMessageDescribeEventsPaginateTypeDef
- DescribeEventsMessageRequestTypeDef
- DescribeHsmClientCertificatesMessageDescribeHsmClientCertificatesPaginateTypeDef
- DescribeHsmClientCertificatesMessageRequestTypeDef
- DescribeHsmConfigurationsMessageDescribeHsmConfigurationsPaginateTypeDef
- DescribeHsmConfigurationsMessageRequestTypeDef
- DescribeLoggingStatusMessageRequestTypeDef
- NodeConfigurationOptionsFilterTypeDef
- DescribeOrderableClusterOptionsMessageDescribeOrderableClusterOptionsPaginateTypeDef
- DescribeOrderableClusterOptionsMessageRequestTypeDef
- DescribePartnersInputMessageRequestTypeDef
- PartnerIntegrationInfoTypeDef
- DescribeReservedNodeExchangeStatusInputMessageDescribeReservedNodeExchangeStatusPaginateTypeDef
- DescribeReservedNodeExchangeStatusInputMessageRequestTypeDef
- DescribeReservedNodeOfferingsMessageDescribeReservedNodeOfferingsPaginateTypeDef
- DescribeReservedNodeOfferingsMessageRequestTypeDef
- DescribeReservedNodesMessageDescribeReservedNodesPaginateTypeDef
- DescribeReservedNodesMessageRequestTypeDef
- DescribeResizeMessageRequestTypeDef
- ScheduledActionFilterTypeDef
- DescribeSnapshotCopyGrantsMessageDescribeSnapshotCopyGrantsPaginateTypeDef
- DescribeSnapshotCopyGrantsMessageRequestTypeDef
- DescribeSnapshotSchedulesMessageDescribeSnapshotSchedulesPaginateTypeDef
- DescribeSnapshotSchedulesMessageRequestTypeDef
- DescribeTableRestoreStatusMessageDescribeTableRestoreStatusPaginateTypeDef
- DescribeTableRestoreStatusMessageRequestTypeDef
- DescribeTagsMessageDescribeTagsPaginateTypeDef
- DescribeTagsMessageRequestTypeDef
- DescribeUsageLimitsMessageDescribeUsageLimitsPaginateTypeDef
- DescribeUsageLimitsMessageRequestTypeDef
- DisableLoggingMessageRequestTypeDef
- DisableSnapshotCopyMessageRequestTypeDef
- DisassociateDataShareConsumerMessageRequestTypeDef
- EmptyResponseMetadataTypeDef
- EnableLoggingMessageRequestTypeDef
- EnableSnapshotCopyMessageRequestTypeDef
- EndpointAuthorizationTypeDef
- EndpointAuthorizationResponseMetadataTypeDef
- EventInfoMapTypeDef
- EventTypeDef
- GetClusterCredentialsMessageRequestTypeDef
- GetClusterCredentialsWithIAMMessageRequestTypeDef
- GetReservedNodeExchangeConfigurationOptionsInputMessageGetReservedNodeExchangeConfigurationOptionsPaginateTypeDef
- GetReservedNodeExchangeConfigurationOptionsInputMessageRequestTypeDef
- GetReservedNodeExchangeOfferingsInputMessageGetReservedNodeExchangeOfferingsPaginateTypeDef
- GetReservedNodeExchangeOfferingsInputMessageRequestTypeDef
- LoggingStatusTypeDef
- ModifyAquaInputMessageRequestTypeDef
- ModifyAuthenticationProfileMessageRequestTypeDef
- ModifyAuthenticationProfileResultTypeDef
- ModifyClusterDbRevisionMessageRequestTypeDef
- ModifyClusterIamRolesMessageRequestTypeDef
- ModifyClusterMaintenanceMessageRequestTypeDef
- ModifyClusterMessageRequestTypeDef
- ModifyClusterSnapshotMessageRequestTypeDef
- ModifyClusterSnapshotScheduleMessageRequestTypeDef
- ModifyClusterSubnetGroupMessageRequestTypeDef
- ModifyEndpointAccessMessageRequestTypeDef
- ModifyEventSubscriptionMessageRequestTypeDef
- ModifySnapshotCopyRetentionPeriodMessageRequestTypeDef
- ModifySnapshotScheduleMessageRequestTypeDef
- ModifyUsageLimitMessageRequestTypeDef
- NetworkInterfaceTypeDef
- NodeConfigurationOptionTypeDef
- PaginatorConfigTypeDef
- PartnerIntegrationInputMessageRequestTypeDef
- PartnerIntegrationOutputMessageTypeDef
- PauseClusterMessageRequestTypeDef
- PauseClusterMessageTypeDef
- PurchaseReservedNodeOfferingMessageRequestTypeDef
- RebootClusterMessageRequestTypeDef
- RecurringChargeTypeDef
- RejectDataShareMessageRequestTypeDef
- ResizeClusterMessageRequestTypeDef
- ResizeClusterMessageTypeDef
- ResizeProgressMessageTypeDef
- ResponseMetadataTypeDef
- RestoreFromClusterSnapshotMessageRequestTypeDef
- RestoreTableFromClusterSnapshotMessageRequestTypeDef
- TableRestoreStatusTypeDef
- ResumeClusterMessageRequestTypeDef
- ResumeClusterMessageTypeDef
- RevokeClusterSecurityGroupIngressMessageRequestTypeDef
- RevokeEndpointAccessMessageRequestTypeDef
- RevokeSnapshotAccessMessageRequestTypeDef
- RotateEncryptionKeyMessageRequestTypeDef
- SupportedOperationTypeDef
- UpdatePartnerStatusInputMessageRequestTypeDef
- AccountAttributeTypeDef
- ModifyAquaOutputMessageTypeDef
- DescribeAuthenticationProfilesResultTypeDef
- AvailabilityZoneTypeDef
- BatchDeleteClusterSnapshotsRequestRequestTypeDef
- BatchDeleteClusterSnapshotsResultTypeDef
- BatchModifyClusterSnapshotsOutputMessageTypeDef
- ClusterDbRevisionTypeDef
- ClusterParameterGroupDetailsTypeDef
- DefaultClusterParametersTypeDef
- ModifyClusterParameterGroupMessageRequestTypeDef
- ResetClusterParameterGroupMessageRequestTypeDef
- ClusterParameterGroupStatusTypeDef
- ClusterParameterGroupTypeDef
- CreateClusterMessageRequestTypeDef
- CreateClusterParameterGroupMessageRequestTypeDef
- CreateClusterSecurityGroupMessageRequestTypeDef
- CreateClusterSnapshotMessageRequestTypeDef
- CreateClusterSubnetGroupMessageRequestTypeDef
- CreateEventSubscriptionMessageRequestTypeDef
- CreateHsmClientCertificateMessageRequestTypeDef
- CreateHsmConfigurationMessageRequestTypeDef
- CreateSnapshotCopyGrantMessageRequestTypeDef
- CreateSnapshotScheduleMessageRequestTypeDef
- CreateTagsMessageRequestTypeDef
- CreateUsageLimitMessageRequestTypeDef
- EC2SecurityGroupTypeDef
- EventSubscriptionTypeDef
- HsmClientCertificateTypeDef
- HsmConfigurationTypeDef
- IPRangeTypeDef
- SnapshotCopyGrantTypeDef
- SnapshotScheduleResponseMetadataTypeDef
- SnapshotScheduleTypeDef
- SnapshotTypeDef
- TaggedResourceTypeDef
- UsageLimitResponseMetadataTypeDef
- UsageLimitTypeDef
- DescribeReservedNodeExchangeStatusOutputMessageTypeDef
- ClusterVersionsMessageTypeDef
- DataShareResponseMetadataTypeDef
- DataShareTypeDef
- DescribeClusterSnapshotsMessageDescribeClusterSnapshotsPaginateTypeDef
- DescribeClusterSnapshotsMessageRequestTypeDef
- DescribeClusterSnapshotsMessageSnapshotAvailableWaitTypeDef
- DescribeClustersMessageClusterAvailableWaitTypeDef
- DescribeClustersMessageClusterDeletedWaitTypeDef
- DescribeClustersMessageClusterRestoredWaitTypeDef
- DescribeNodeConfigurationOptionsMessageDescribeNodeConfigurationOptionsPaginateTypeDef
- DescribeNodeConfigurationOptionsMessageRequestTypeDef
- DescribePartnersOutputMessageTypeDef
- DescribeScheduledActionsMessageDescribeScheduledActionsPaginateTypeDef
- DescribeScheduledActionsMessageRequestTypeDef
- EndpointAuthorizationListTypeDef
- EventCategoriesMapTypeDef
- EventsMessageTypeDef
- VpcEndpointTypeDef
- NodeConfigurationOptionsMessageTypeDef
- ReservedNodeOfferingTypeDef
- ReservedNodeTypeDef
- RestoreTableFromClusterSnapshotResultTypeDef
- TableRestoreStatusMessageTypeDef
- ScheduledActionTypeTypeDef
- UpdateTargetTypeDef
- AccountAttributeListTypeDef
- OrderableClusterOptionTypeDef
- SubnetTypeDef
- ClusterDbRevisionsMessageTypeDef
- DescribeDefaultClusterParametersResultTypeDef
- ClusterParameterGroupsMessageTypeDef
- CreateClusterParameterGroupResultTypeDef
- CreateEventSubscriptionResultTypeDef
- EventSubscriptionsMessageTypeDef
- ModifyEventSubscriptionResultTypeDef
- CreateHsmClientCertificateResultTypeDef
- HsmClientCertificateMessageTypeDef
- CreateHsmConfigurationResultTypeDef
- HsmConfigurationMessageTypeDef
- ClusterSecurityGroupTypeDef
- CreateSnapshotCopyGrantResultTypeDef
- SnapshotCopyGrantMessageTypeDef
- DescribeSnapshotSchedulesOutputMessageTypeDef
- AuthorizeSnapshotAccessResultTypeDef
- CopyClusterSnapshotResultTypeDef
- CreateClusterSnapshotResultTypeDef
- DeleteClusterSnapshotResultTypeDef
- ModifyClusterSnapshotResultTypeDef
- RevokeSnapshotAccessResultTypeDef
- SnapshotMessageTypeDef
- TaggedResourceListMessageTypeDef
- UsageLimitListTypeDef
- DescribeDataSharesForConsumerResultTypeDef
- DescribeDataSharesForProducerResultTypeDef
- DescribeDataSharesResultTypeDef
- EventCategoriesMessageTypeDef
- EndpointAccessResponseMetadataTypeDef
- EndpointAccessTypeDef
- EndpointTypeDef
- GetReservedNodeExchangeOfferingsOutputMessageTypeDef
- ReservedNodeOfferingsMessageTypeDef
- AcceptReservedNodeExchangeOutputMessageTypeDef
- PurchaseReservedNodeOfferingResultTypeDef
- ReservedNodeConfigurationOptionTypeDef
- ReservedNodesMessageTypeDef
- CreateScheduledActionMessageRequestTypeDef
- ModifyScheduledActionMessageRequestTypeDef
- ScheduledActionResponseMetadataTypeDef
- ScheduledActionTypeDef
- MaintenanceTrackTypeDef
- OrderableClusterOptionsMessageTypeDef
- ClusterSubnetGroupTypeDef
- AuthorizeClusterSecurityGroupIngressResultTypeDef
- ClusterSecurityGroupMessageTypeDef
- CreateClusterSecurityGroupResultTypeDef
- RevokeClusterSecurityGroupIngressResultTypeDef
- EndpointAccessListTypeDef
- ClusterTypeDef
- GetReservedNodeExchangeConfigurationOptionsOutputMessageTypeDef
- ScheduledActionsMessageTypeDef
- TrackListMessageTypeDef
- ClusterSubnetGroupMessageTypeDef
- CreateClusterSubnetGroupResultTypeDef
- ModifyClusterSubnetGroupResultTypeDef
- ClustersMessageTypeDef
- CreateClusterResultTypeDef
- DeleteClusterResultTypeDef
- DisableSnapshotCopyResultTypeDef
- EnableSnapshotCopyResultTypeDef
- ModifyClusterDbRevisionResultTypeDef
- ModifyClusterIamRolesResultTypeDef
- ModifyClusterMaintenanceResultTypeDef
- ModifyClusterResultTypeDef
- ModifySnapshotCopyRetentionPeriodResultTypeDef
- PauseClusterResultTypeDef
- RebootClusterResultTypeDef
- ResizeClusterResultTypeDef
- RestoreFromClusterSnapshotResultTypeDef
- ResumeClusterResultTypeDef
- RotateEncryptionKeyResultTypeDef