Skip to content

RedshiftClient

Index > Redshift > RedshiftClient

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

RedshiftClient

Type annotations and code completion for boto3.client("redshift"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_redshift.client import RedshiftClient

def get_redshift_client() -> RedshiftClient:
    return Session().client("redshift")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("redshift").exceptions structure.

Usage example
client = boto3.client("redshift")

try:
    do_something(client)
except (
    client.AccessToClusterDeniedFault,
    client.AccessToSnapshotDeniedFault,
    client.AuthenticationProfileAlreadyExistsFault,
    client.AuthenticationProfileNotFoundFault,
    client.AuthenticationProfileQuotaExceededFault,
    client.AuthorizationAlreadyExistsFault,
    client.AuthorizationNotFoundFault,
    client.AuthorizationQuotaExceededFault,
    client.BatchDeleteRequestSizeExceededFault,
    client.BatchModifyClusterSnapshotsLimitExceededFault,
    client.BucketNotFoundFault,
    client.ClientError,
    client.ClusterAlreadyExistsFault,
    client.ClusterNotFoundFault,
    client.ClusterOnLatestRevisionFault,
    client.ClusterParameterGroupAlreadyExistsFault,
    client.ClusterParameterGroupNotFoundFault,
    client.ClusterParameterGroupQuotaExceededFault,
    client.ClusterQuotaExceededFault,
    client.ClusterSecurityGroupAlreadyExistsFault,
    client.ClusterSecurityGroupNotFoundFault,
    client.ClusterSecurityGroupQuotaExceededFault,
    client.ClusterSnapshotAlreadyExistsFault,
    client.ClusterSnapshotNotFoundFault,
    client.ClusterSnapshotQuotaExceededFault,
    client.ClusterSubnetGroupAlreadyExistsFault,
    client.ClusterSubnetGroupNotFoundFault,
    client.ClusterSubnetGroupQuotaExceededFault,
    client.ClusterSubnetQuotaExceededFault,
    client.CopyToRegionDisabledFault,
    client.DependentServiceRequestThrottlingFault,
    client.DependentServiceUnavailableFault,
    client.EndpointAlreadyExistsFault,
    client.EndpointAuthorizationAlreadyExistsFault,
    client.EndpointAuthorizationNotFoundFault,
    client.EndpointAuthorizationsPerClusterLimitExceededFault,
    client.EndpointNotFoundFault,
    client.EndpointsPerAuthorizationLimitExceededFault,
    client.EndpointsPerClusterLimitExceededFault,
    client.EventSubscriptionQuotaExceededFault,
    client.HsmClientCertificateAlreadyExistsFault,
    client.HsmClientCertificateNotFoundFault,
    client.HsmClientCertificateQuotaExceededFault,
    client.HsmConfigurationAlreadyExistsFault,
    client.HsmConfigurationNotFoundFault,
    client.HsmConfigurationQuotaExceededFault,
    client.InProgressTableRestoreQuotaExceededFault,
    client.IncompatibleOrderableOptions,
    client.InsufficientClusterCapacityFault,
    client.InsufficientS3BucketPolicyFault,
    client.InvalidAuthenticationProfileRequestFault,
    client.InvalidAuthorizationStateFault,
    client.InvalidClusterParameterGroupStateFault,
    client.InvalidClusterSecurityGroupStateFault,
    client.InvalidClusterSnapshotScheduleStateFault,
    client.InvalidClusterSnapshotStateFault,
    client.InvalidClusterStateFault,
    client.InvalidClusterSubnetGroupStateFault,
    client.InvalidClusterSubnetStateFault,
    client.InvalidClusterTrackFault,
    client.InvalidDataShareFault,
    client.InvalidElasticIpFault,
    client.InvalidEndpointStateFault,
    client.InvalidHsmClientCertificateStateFault,
    client.InvalidHsmConfigurationStateFault,
    client.InvalidNamespaceFault,
    client.InvalidReservedNodeStateFault,
    client.InvalidRestoreFault,
    client.InvalidRetentionPeriodFault,
    client.InvalidS3BucketNameFault,
    client.InvalidS3KeyPrefixFault,
    client.InvalidScheduleFault,
    client.InvalidScheduledActionFault,
    client.InvalidSnapshotCopyGrantStateFault,
    client.InvalidSubnet,
    client.InvalidSubscriptionStateFault,
    client.InvalidTableRestoreArgumentFault,
    client.InvalidTagFault,
    client.InvalidUsageLimitFault,
    client.InvalidVPCNetworkStateFault,
    client.LimitExceededFault,
    client.NumberOfNodesPerClusterLimitExceededFault,
    client.NumberOfNodesQuotaExceededFault,
    client.PartnerNotFoundFault,
    client.ReservedNodeAlreadyExistsFault,
    client.ReservedNodeAlreadyMigratedFault,
    client.ReservedNodeExchangeNotFoundFault,
    client.ReservedNodeNotFoundFault,
    client.ReservedNodeOfferingNotFoundFault,
    client.ReservedNodeQuotaExceededFault,
    client.ResizeNotFoundFault,
    client.ResourceNotFoundFault,
    client.SNSInvalidTopicFault,
    client.SNSNoAuthorizationFault,
    client.SNSTopicArnNotFoundFault,
    client.ScheduleDefinitionTypeUnsupportedFault,
    client.ScheduledActionAlreadyExistsFault,
    client.ScheduledActionNotFoundFault,
    client.ScheduledActionQuotaExceededFault,
    client.ScheduledActionTypeUnsupportedFault,
    client.SnapshotCopyAlreadyDisabledFault,
    client.SnapshotCopyAlreadyEnabledFault,
    client.SnapshotCopyDisabledFault,
    client.SnapshotCopyGrantAlreadyExistsFault,
    client.SnapshotCopyGrantNotFoundFault,
    client.SnapshotCopyGrantQuotaExceededFault,
    client.SnapshotScheduleAlreadyExistsFault,
    client.SnapshotScheduleNotFoundFault,
    client.SnapshotScheduleQuotaExceededFault,
    client.SnapshotScheduleUpdateInProgressFault,
    client.SourceNotFoundFault,
    client.SubnetAlreadyInUse,
    client.SubscriptionAlreadyExistFault,
    client.SubscriptionCategoryNotFoundFault,
    client.SubscriptionEventIdNotFoundFault,
    client.SubscriptionNotFoundFault,
    client.SubscriptionSeverityNotFoundFault,
    client.TableLimitExceededFault,
    client.TableRestoreNotFoundFault,
    client.TagLimitExceededFault,
    client.UnauthorizedOperation,
    client.UnauthorizedPartnerIntegrationFault,
    client.UnknownSnapshotCopyRegionFault,
    client.UnsupportedOperationFault,
    client.UnsupportedOptionFault,
    client.UsageLimitAlreadyExistsFault,
    client.UsageLimitNotFoundFault,
) as e:
    print(e)
Type checking example
from mypy_boto3_redshift.client import Exceptions

def handle_error(exc: Exceptions.AccessToClusterDeniedFault) -> None:
    ...

Methods

accept_reserved_node_exchange

Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.

Type annotations and code completion for boto3.client("redshift").accept_reserved_node_exchange method. boto3 documentation

Method definition
def accept_reserved_node_exchange(
    self,
    *,
    ReservedNodeId: str,
    TargetReservedNodeOfferingId: str,
) -> AcceptReservedNodeExchangeOutputMessageTypeDef:  # (1)
    ...
  1. See AcceptReservedNodeExchangeOutputMessageTypeDef
Usage example with kwargs
kwargs: AcceptReservedNodeExchangeInputMessageRequestTypeDef = {  # (1)
    "ReservedNodeId": ...,
    "TargetReservedNodeOfferingId": ...,
}

parent.accept_reserved_node_exchange(**kwargs)
  1. See AcceptReservedNodeExchangeInputMessageRequestTypeDef

add_partner

Adds a partner integration to a cluster.

Type annotations and code completion for boto3.client("redshift").add_partner method. boto3 documentation

Method definition
def add_partner(
    self,
    *,
    AccountId: str,
    ClusterIdentifier: str,
    DatabaseName: str,
    PartnerName: str,
) -> PartnerIntegrationOutputMessageTypeDef:  # (1)
    ...
  1. See PartnerIntegrationOutputMessageTypeDef
Usage example with kwargs
kwargs: PartnerIntegrationInputMessageRequestTypeDef = {  # (1)
    "AccountId": ...,
    "ClusterIdentifier": ...,
    "DatabaseName": ...,
    "PartnerName": ...,
}

parent.add_partner(**kwargs)
  1. See PartnerIntegrationInputMessageRequestTypeDef

associate_data_share_consumer

From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn).

Type annotations and code completion for boto3.client("redshift").associate_data_share_consumer method. boto3 documentation

Method definition
def associate_data_share_consumer(
    self,
    *,
    DataShareArn: str,
    AssociateEntireAccount: bool = ...,
    ConsumerArn: str = ...,
    ConsumerRegion: str = ...,
) -> DataShareResponseMetadataTypeDef:  # (1)
    ...
  1. See DataShareResponseMetadataTypeDef
Usage example with kwargs
kwargs: AssociateDataShareConsumerMessageRequestTypeDef = {  # (1)
    "DataShareArn": ...,
}

parent.associate_data_share_consumer(**kwargs)
  1. See AssociateDataShareConsumerMessageRequestTypeDef

authorize_cluster_security_group_ingress

Adds an inbound (ingress) rule to an Amazon Redshift security group.

Type annotations and code completion for boto3.client("redshift").authorize_cluster_security_group_ingress method. boto3 documentation

Method definition
def authorize_cluster_security_group_ingress(
    self,
    *,
    ClusterSecurityGroupName: str,
    CIDRIP: str = ...,
    EC2SecurityGroupName: str = ...,
    EC2SecurityGroupOwnerId: str = ...,
) -> AuthorizeClusterSecurityGroupIngressResultTypeDef:  # (1)
    ...
  1. See AuthorizeClusterSecurityGroupIngressResultTypeDef
Usage example with kwargs
kwargs: AuthorizeClusterSecurityGroupIngressMessageRequestTypeDef = {  # (1)
    "ClusterSecurityGroupName": ...,
}

parent.authorize_cluster_security_group_ingress(**kwargs)
  1. See AuthorizeClusterSecurityGroupIngressMessageRequestTypeDef

authorize_data_share

From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities.

Type annotations and code completion for boto3.client("redshift").authorize_data_share method. boto3 documentation

Method definition
def authorize_data_share(
    self,
    *,
    DataShareArn: str,
    ConsumerIdentifier: str,
) -> DataShareResponseMetadataTypeDef:  # (1)
    ...
  1. See DataShareResponseMetadataTypeDef
Usage example with kwargs
kwargs: AuthorizeDataShareMessageRequestTypeDef = {  # (1)
    "DataShareArn": ...,
    "ConsumerIdentifier": ...,
}

parent.authorize_data_share(**kwargs)
  1. See AuthorizeDataShareMessageRequestTypeDef

authorize_endpoint_access

Grants access to a cluster.

Type annotations and code completion for boto3.client("redshift").authorize_endpoint_access method. boto3 documentation

Method definition
def authorize_endpoint_access(
    self,
    *,
    Account: str,
    ClusterIdentifier: str = ...,
    VpcIds: Sequence[str] = ...,
) -> EndpointAuthorizationResponseMetadataTypeDef:  # (1)
    ...
  1. See EndpointAuthorizationResponseMetadataTypeDef
Usage example with kwargs
kwargs: AuthorizeEndpointAccessMessageRequestTypeDef = {  # (1)
    "Account": ...,
}

parent.authorize_endpoint_access(**kwargs)
  1. See AuthorizeEndpointAccessMessageRequestTypeDef

authorize_snapshot_access

Authorizes the specified Amazon Web Services account to restore the specified snapshot.

Type annotations and code completion for boto3.client("redshift").authorize_snapshot_access method. boto3 documentation

Method definition
def authorize_snapshot_access(
    self,
    *,
    AccountWithRestoreAccess: str,
    SnapshotIdentifier: str = ...,
    SnapshotArn: str = ...,
    SnapshotClusterIdentifier: str = ...,
) -> AuthorizeSnapshotAccessResultTypeDef:  # (1)
    ...
  1. See AuthorizeSnapshotAccessResultTypeDef
Usage example with kwargs
kwargs: AuthorizeSnapshotAccessMessageRequestTypeDef = {  # (1)
    "AccountWithRestoreAccess": ...,
}

parent.authorize_snapshot_access(**kwargs)
  1. See AuthorizeSnapshotAccessMessageRequestTypeDef

batch_delete_cluster_snapshots

Deletes a set of cluster snapshots.

Type annotations and code completion for boto3.client("redshift").batch_delete_cluster_snapshots method. boto3 documentation

Method definition
def batch_delete_cluster_snapshots(
    self,
    *,
    Identifiers: Sequence[DeleteClusterSnapshotMessageTypeDef],  # (1)
) -> BatchDeleteClusterSnapshotsResultTypeDef:  # (2)
    ...
  1. See DeleteClusterSnapshotMessageTypeDef
  2. See BatchDeleteClusterSnapshotsResultTypeDef
Usage example with kwargs
kwargs: BatchDeleteClusterSnapshotsRequestRequestTypeDef = {  # (1)
    "Identifiers": ...,
}

parent.batch_delete_cluster_snapshots(**kwargs)
  1. See BatchDeleteClusterSnapshotsRequestRequestTypeDef

batch_modify_cluster_snapshots

Modifies the settings for a set of cluster snapshots.

Type annotations and code completion for boto3.client("redshift").batch_modify_cluster_snapshots method. boto3 documentation

Method definition
def batch_modify_cluster_snapshots(
    self,
    *,
    SnapshotIdentifierList: Sequence[str],
    ManualSnapshotRetentionPeriod: int = ...,
    Force: bool = ...,
) -> BatchModifyClusterSnapshotsOutputMessageTypeDef:  # (1)
    ...
  1. See BatchModifyClusterSnapshotsOutputMessageTypeDef
Usage example with kwargs
kwargs: BatchModifyClusterSnapshotsMessageRequestTypeDef = {  # (1)
    "SnapshotIdentifierList": ...,
}

parent.batch_modify_cluster_snapshots(**kwargs)
  1. See BatchModifyClusterSnapshotsMessageRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("redshift").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_resize

Cancels a resize operation for a cluster.

Type annotations and code completion for boto3.client("redshift").cancel_resize method. boto3 documentation

Method definition
def cancel_resize(
    self,
    *,
    ClusterIdentifier: str,
) -> ResizeProgressMessageTypeDef:  # (1)
    ...
  1. See ResizeProgressMessageTypeDef
Usage example with kwargs
kwargs: CancelResizeMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.cancel_resize(**kwargs)
  1. See CancelResizeMessageRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("redshift").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

copy_cluster_snapshot

Copies the specified automated cluster snapshot to a new manual cluster snapshot.

Type annotations and code completion for boto3.client("redshift").copy_cluster_snapshot method. boto3 documentation

Method definition
def copy_cluster_snapshot(
    self,
    *,
    SourceSnapshotIdentifier: str,
    TargetSnapshotIdentifier: str,
    SourceSnapshotClusterIdentifier: str = ...,
    ManualSnapshotRetentionPeriod: int = ...,
) -> CopyClusterSnapshotResultTypeDef:  # (1)
    ...
  1. See CopyClusterSnapshotResultTypeDef
Usage example with kwargs
kwargs: CopyClusterSnapshotMessageRequestTypeDef = {  # (1)
    "SourceSnapshotIdentifier": ...,
    "TargetSnapshotIdentifier": ...,
}

parent.copy_cluster_snapshot(**kwargs)
  1. See CopyClusterSnapshotMessageRequestTypeDef

create_authentication_profile

Creates an authentication profile with the specified parameters.

Type annotations and code completion for boto3.client("redshift").create_authentication_profile method. boto3 documentation

Method definition
def create_authentication_profile(
    self,
    *,
    AuthenticationProfileName: str,
    AuthenticationProfileContent: str,
) -> CreateAuthenticationProfileResultTypeDef:  # (1)
    ...
  1. See CreateAuthenticationProfileResultTypeDef
Usage example with kwargs
kwargs: CreateAuthenticationProfileMessageRequestTypeDef = {  # (1)
    "AuthenticationProfileName": ...,
    "AuthenticationProfileContent": ...,
}

parent.create_authentication_profile(**kwargs)
  1. See CreateAuthenticationProfileMessageRequestTypeDef

create_cluster

Creates a new cluster with the specified parameters.

Type annotations and code completion for boto3.client("redshift").create_cluster method. boto3 documentation

Method definition
def create_cluster(
    self,
    *,
    ClusterIdentifier: str,
    NodeType: str,
    MasterUsername: str,
    MasterUserPassword: str,
    DBName: str = ...,
    ClusterType: str = ...,
    ClusterSecurityGroups: Sequence[str] = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    ClusterSubnetGroupName: str = ...,
    AvailabilityZone: str = ...,
    PreferredMaintenanceWindow: str = ...,
    ClusterParameterGroupName: str = ...,
    AutomatedSnapshotRetentionPeriod: int = ...,
    ManualSnapshotRetentionPeriod: int = ...,
    Port: int = ...,
    ClusterVersion: str = ...,
    AllowVersionUpgrade: bool = ...,
    NumberOfNodes: int = ...,
    PubliclyAccessible: bool = ...,
    Encrypted: bool = ...,
    HsmClientCertificateIdentifier: str = ...,
    HsmConfigurationIdentifier: str = ...,
    ElasticIp: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    KmsKeyId: str = ...,
    EnhancedVpcRouting: bool = ...,
    AdditionalInfo: str = ...,
    IamRoles: Sequence[str] = ...,
    MaintenanceTrackName: str = ...,
    SnapshotScheduleIdentifier: str = ...,
    AvailabilityZoneRelocation: bool = ...,
    AquaConfigurationStatus: AquaConfigurationStatusType = ...,  # (2)
    DefaultIamRoleArn: str = ...,
    LoadSampleData: str = ...,
) -> CreateClusterResultTypeDef:  # (3)
    ...
  1. See TagTypeDef
  2. See AquaConfigurationStatusType
  3. See CreateClusterResultTypeDef
Usage example with kwargs
kwargs: CreateClusterMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
    "NodeType": ...,
    "MasterUsername": ...,
    "MasterUserPassword": ...,
}

parent.create_cluster(**kwargs)
  1. See CreateClusterMessageRequestTypeDef

create_cluster_parameter_group

Creates an Amazon Redshift parameter group.

Type annotations and code completion for boto3.client("redshift").create_cluster_parameter_group method. boto3 documentation

Method definition
def create_cluster_parameter_group(
    self,
    *,
    ParameterGroupName: str,
    ParameterGroupFamily: str,
    Description: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateClusterParameterGroupResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateClusterParameterGroupResultTypeDef
Usage example with kwargs
kwargs: CreateClusterParameterGroupMessageRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
    "ParameterGroupFamily": ...,
    "Description": ...,
}

parent.create_cluster_parameter_group(**kwargs)
  1. See CreateClusterParameterGroupMessageRequestTypeDef

create_cluster_security_group

Creates a new Amazon Redshift security group.

Type annotations and code completion for boto3.client("redshift").create_cluster_security_group method. boto3 documentation

Method definition
def create_cluster_security_group(
    self,
    *,
    ClusterSecurityGroupName: str,
    Description: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateClusterSecurityGroupResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateClusterSecurityGroupResultTypeDef
Usage example with kwargs
kwargs: CreateClusterSecurityGroupMessageRequestTypeDef = {  # (1)
    "ClusterSecurityGroupName": ...,
    "Description": ...,
}

parent.create_cluster_security_group(**kwargs)
  1. See CreateClusterSecurityGroupMessageRequestTypeDef

create_cluster_snapshot

Creates a manual snapshot of the specified cluster.

Type annotations and code completion for boto3.client("redshift").create_cluster_snapshot method. boto3 documentation

Method definition
def create_cluster_snapshot(
    self,
    *,
    SnapshotIdentifier: str,
    ClusterIdentifier: str,
    ManualSnapshotRetentionPeriod: int = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateClusterSnapshotResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateClusterSnapshotResultTypeDef
Usage example with kwargs
kwargs: CreateClusterSnapshotMessageRequestTypeDef = {  # (1)
    "SnapshotIdentifier": ...,
    "ClusterIdentifier": ...,
}

parent.create_cluster_snapshot(**kwargs)
  1. See CreateClusterSnapshotMessageRequestTypeDef

create_cluster_subnet_group

Creates a new Amazon Redshift subnet group.

Type annotations and code completion for boto3.client("redshift").create_cluster_subnet_group method. boto3 documentation

Method definition
def create_cluster_subnet_group(
    self,
    *,
    ClusterSubnetGroupName: str,
    Description: str,
    SubnetIds: Sequence[str],
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateClusterSubnetGroupResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateClusterSubnetGroupResultTypeDef
Usage example with kwargs
kwargs: CreateClusterSubnetGroupMessageRequestTypeDef = {  # (1)
    "ClusterSubnetGroupName": ...,
    "Description": ...,
    "SubnetIds": ...,
}

parent.create_cluster_subnet_group(**kwargs)
  1. See CreateClusterSubnetGroupMessageRequestTypeDef

create_endpoint_access

Creates a Redshift-managed VPC endpoint.

Type annotations and code completion for boto3.client("redshift").create_endpoint_access method. boto3 documentation

Method definition
def create_endpoint_access(
    self,
    *,
    EndpointName: str,
    SubnetGroupName: str,
    ClusterIdentifier: str = ...,
    ResourceOwner: str = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
) -> EndpointAccessResponseMetadataTypeDef:  # (1)
    ...
  1. See EndpointAccessResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateEndpointAccessMessageRequestTypeDef = {  # (1)
    "EndpointName": ...,
    "SubnetGroupName": ...,
}

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

create_event_subscription

Creates an Amazon Redshift event notification subscription.

Type annotations and code completion for boto3.client("redshift").create_event_subscription method. boto3 documentation

Method definition
def create_event_subscription(
    self,
    *,
    SubscriptionName: str,
    SnsTopicArn: str,
    SourceType: str = ...,
    SourceIds: Sequence[str] = ...,
    EventCategories: Sequence[str] = ...,
    Severity: str = ...,
    Enabled: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateEventSubscriptionResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateEventSubscriptionResultTypeDef
Usage example with kwargs
kwargs: CreateEventSubscriptionMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
    "SnsTopicArn": ...,
}

parent.create_event_subscription(**kwargs)
  1. See CreateEventSubscriptionMessageRequestTypeDef

create_hsm_client_certificate

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.

Type annotations and code completion for boto3.client("redshift").create_hsm_client_certificate method. boto3 documentation

Method definition
def create_hsm_client_certificate(
    self,
    *,
    HsmClientCertificateIdentifier: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateHsmClientCertificateResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateHsmClientCertificateResultTypeDef
Usage example with kwargs
kwargs: CreateHsmClientCertificateMessageRequestTypeDef = {  # (1)
    "HsmClientCertificateIdentifier": ...,
}

parent.create_hsm_client_certificate(**kwargs)
  1. See CreateHsmClientCertificateMessageRequestTypeDef

create_hsm_configuration

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM).

Type annotations and code completion for boto3.client("redshift").create_hsm_configuration method. boto3 documentation

Method definition
def create_hsm_configuration(
    self,
    *,
    HsmConfigurationIdentifier: str,
    Description: str,
    HsmIpAddress: str,
    HsmPartitionName: str,
    HsmPartitionPassword: str,
    HsmServerPublicCertificate: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateHsmConfigurationResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateHsmConfigurationResultTypeDef
Usage example with kwargs
kwargs: CreateHsmConfigurationMessageRequestTypeDef = {  # (1)
    "HsmConfigurationIdentifier": ...,
    "Description": ...,
    "HsmIpAddress": ...,
    "HsmPartitionName": ...,
    "HsmPartitionPassword": ...,
    "HsmServerPublicCertificate": ...,
}

parent.create_hsm_configuration(**kwargs)
  1. See CreateHsmConfigurationMessageRequestTypeDef

create_scheduled_action

Creates a scheduled action.

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

Method definition
def create_scheduled_action(
    self,
    *,
    ScheduledActionName: str,
    TargetAction: ScheduledActionTypeTypeDef,  # (1)
    Schedule: str,
    IamRole: str,
    ScheduledActionDescription: str = ...,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    Enable: bool = ...,
) -> ScheduledActionResponseMetadataTypeDef:  # (2)
    ...
  1. See ScheduledActionTypeTypeDef
  2. See ScheduledActionResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateScheduledActionMessageRequestTypeDef = {  # (1)
    "ScheduledActionName": ...,
    "TargetAction": ...,
    "Schedule": ...,
    "IamRole": ...,
}

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

create_snapshot_copy_grant

Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in a destination region.

Type annotations and code completion for boto3.client("redshift").create_snapshot_copy_grant method. boto3 documentation

Method definition
def create_snapshot_copy_grant(
    self,
    *,
    SnapshotCopyGrantName: str,
    KmsKeyId: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateSnapshotCopyGrantResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateSnapshotCopyGrantResultTypeDef
Usage example with kwargs
kwargs: CreateSnapshotCopyGrantMessageRequestTypeDef = {  # (1)
    "SnapshotCopyGrantName": ...,
}

parent.create_snapshot_copy_grant(**kwargs)
  1. See CreateSnapshotCopyGrantMessageRequestTypeDef

create_snapshot_schedule

Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.

Type annotations and code completion for boto3.client("redshift").create_snapshot_schedule method. boto3 documentation

Method definition
def create_snapshot_schedule(
    self,
    *,
    ScheduleDefinitions: Sequence[str] = ...,
    ScheduleIdentifier: str = ...,
    ScheduleDescription: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    DryRun: bool = ...,
    NextInvocations: int = ...,
) -> SnapshotScheduleResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See SnapshotScheduleResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateSnapshotScheduleMessageRequestTypeDef = {  # (1)
    "ScheduleDefinitions": ...,
}

parent.create_snapshot_schedule(**kwargs)
  1. See CreateSnapshotScheduleMessageRequestTypeDef

create_tags

Adds tags to a cluster.

Type annotations and code completion for boto3.client("redshift").create_tags method. boto3 documentation

Method definition
def create_tags(
    self,
    *,
    ResourceName: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateTagsMessageRequestTypeDef = {  # (1)
    "ResourceName": ...,
    "Tags": ...,
}

parent.create_tags(**kwargs)
  1. See CreateTagsMessageRequestTypeDef

create_usage_limit

Creates a usage limit for a specified Amazon Redshift feature on a cluster.

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

Method definition
def create_usage_limit(
    self,
    *,
    ClusterIdentifier: str,
    FeatureType: UsageLimitFeatureTypeType,  # (1)
    LimitType: UsageLimitLimitTypeType,  # (2)
    Amount: int,
    Period: UsageLimitPeriodType = ...,  # (3)
    BreachAction: UsageLimitBreachActionType = ...,  # (4)
    Tags: Sequence[TagTypeDef] = ...,  # (5)
) -> UsageLimitResponseMetadataTypeDef:  # (6)
    ...
  1. See UsageLimitFeatureTypeType
  2. See UsageLimitLimitTypeType
  3. See UsageLimitPeriodType
  4. See UsageLimitBreachActionType
  5. See TagTypeDef
  6. See UsageLimitResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateUsageLimitMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
    "FeatureType": ...,
    "LimitType": ...,
    "Amount": ...,
}

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

deauthorize_data_share

From a datashare producer account, removes authorization from the specified datashare.

Type annotations and code completion for boto3.client("redshift").deauthorize_data_share method. boto3 documentation

Method definition
def deauthorize_data_share(
    self,
    *,
    DataShareArn: str,
    ConsumerIdentifier: str,
) -> DataShareResponseMetadataTypeDef:  # (1)
    ...
  1. See DataShareResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeauthorizeDataShareMessageRequestTypeDef = {  # (1)
    "DataShareArn": ...,
    "ConsumerIdentifier": ...,
}

parent.deauthorize_data_share(**kwargs)
  1. See DeauthorizeDataShareMessageRequestTypeDef

delete_authentication_profile

Deletes an authentication profile.

Type annotations and code completion for boto3.client("redshift").delete_authentication_profile method. boto3 documentation

Method definition
def delete_authentication_profile(
    self,
    *,
    AuthenticationProfileName: str,
) -> DeleteAuthenticationProfileResultTypeDef:  # (1)
    ...
  1. See DeleteAuthenticationProfileResultTypeDef
Usage example with kwargs
kwargs: DeleteAuthenticationProfileMessageRequestTypeDef = {  # (1)
    "AuthenticationProfileName": ...,
}

parent.delete_authentication_profile(**kwargs)
  1. See DeleteAuthenticationProfileMessageRequestTypeDef

delete_cluster

Deletes a previously provisioned cluster without its final snapshot being created.

Type annotations and code completion for boto3.client("redshift").delete_cluster method. boto3 documentation

Method definition
def delete_cluster(
    self,
    *,
    ClusterIdentifier: str,
    SkipFinalClusterSnapshot: bool = ...,
    FinalClusterSnapshotIdentifier: str = ...,
    FinalClusterSnapshotRetentionPeriod: int = ...,
) -> DeleteClusterResultTypeDef:  # (1)
    ...
  1. See DeleteClusterResultTypeDef
Usage example with kwargs
kwargs: DeleteClusterMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.delete_cluster(**kwargs)
  1. See DeleteClusterMessageRequestTypeDef

delete_cluster_parameter_group

Deletes a specified Amazon Redshift parameter group.

Type annotations and code completion for boto3.client("redshift").delete_cluster_parameter_group method. boto3 documentation

Method definition
def delete_cluster_parameter_group(
    self,
    *,
    ParameterGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteClusterParameterGroupMessageRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
}

parent.delete_cluster_parameter_group(**kwargs)
  1. See DeleteClusterParameterGroupMessageRequestTypeDef

delete_cluster_security_group

Deletes an Amazon Redshift security group.

Type annotations and code completion for boto3.client("redshift").delete_cluster_security_group method. boto3 documentation

Method definition
def delete_cluster_security_group(
    self,
    *,
    ClusterSecurityGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteClusterSecurityGroupMessageRequestTypeDef = {  # (1)
    "ClusterSecurityGroupName": ...,
}

parent.delete_cluster_security_group(**kwargs)
  1. See DeleteClusterSecurityGroupMessageRequestTypeDef

delete_cluster_snapshot

Deletes the specified manual snapshot.

Type annotations and code completion for boto3.client("redshift").delete_cluster_snapshot method. boto3 documentation

Method definition
def delete_cluster_snapshot(
    self,
    *,
    SnapshotIdentifier: str,
    SnapshotClusterIdentifier: str = ...,
) -> DeleteClusterSnapshotResultTypeDef:  # (1)
    ...
  1. See DeleteClusterSnapshotResultTypeDef
Usage example with kwargs
kwargs: DeleteClusterSnapshotMessageRequestTypeDef = {  # (1)
    "SnapshotIdentifier": ...,
}

parent.delete_cluster_snapshot(**kwargs)
  1. See DeleteClusterSnapshotMessageRequestTypeDef

delete_cluster_subnet_group

Deletes the specified cluster subnet group.

Type annotations and code completion for boto3.client("redshift").delete_cluster_subnet_group method. boto3 documentation

Method definition
def delete_cluster_subnet_group(
    self,
    *,
    ClusterSubnetGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteClusterSubnetGroupMessageRequestTypeDef = {  # (1)
    "ClusterSubnetGroupName": ...,
}

parent.delete_cluster_subnet_group(**kwargs)
  1. See DeleteClusterSubnetGroupMessageRequestTypeDef

delete_endpoint_access

Deletes a Redshift-managed VPC endpoint.

Type annotations and code completion for boto3.client("redshift").delete_endpoint_access method. boto3 documentation

Method definition
def delete_endpoint_access(
    self,
    *,
    EndpointName: str,
) -> EndpointAccessResponseMetadataTypeDef:  # (1)
    ...
  1. See EndpointAccessResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteEndpointAccessMessageRequestTypeDef = {  # (1)
    "EndpointName": ...,
}

parent.delete_endpoint_access(**kwargs)
  1. See DeleteEndpointAccessMessageRequestTypeDef

delete_event_subscription

Deletes an Amazon Redshift event notification subscription.

Type annotations and code completion for boto3.client("redshift").delete_event_subscription method. boto3 documentation

Method definition
def delete_event_subscription(
    self,
    *,
    SubscriptionName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteEventSubscriptionMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
}

parent.delete_event_subscription(**kwargs)
  1. See DeleteEventSubscriptionMessageRequestTypeDef

delete_hsm_client_certificate

Deletes the specified HSM client certificate.

Type annotations and code completion for boto3.client("redshift").delete_hsm_client_certificate method. boto3 documentation

Method definition
def delete_hsm_client_certificate(
    self,
    *,
    HsmClientCertificateIdentifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteHsmClientCertificateMessageRequestTypeDef = {  # (1)
    "HsmClientCertificateIdentifier": ...,
}

parent.delete_hsm_client_certificate(**kwargs)
  1. See DeleteHsmClientCertificateMessageRequestTypeDef

delete_hsm_configuration

Deletes the specified Amazon Redshift HSM configuration.

Type annotations and code completion for boto3.client("redshift").delete_hsm_configuration method. boto3 documentation

Method definition
def delete_hsm_configuration(
    self,
    *,
    HsmConfigurationIdentifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteHsmConfigurationMessageRequestTypeDef = {  # (1)
    "HsmConfigurationIdentifier": ...,
}

parent.delete_hsm_configuration(**kwargs)
  1. See DeleteHsmConfigurationMessageRequestTypeDef

delete_partner

Deletes a partner integration from a cluster.

Type annotations and code completion for boto3.client("redshift").delete_partner method. boto3 documentation

Method definition
def delete_partner(
    self,
    *,
    AccountId: str,
    ClusterIdentifier: str,
    DatabaseName: str,
    PartnerName: str,
) -> PartnerIntegrationOutputMessageTypeDef:  # (1)
    ...
  1. See PartnerIntegrationOutputMessageTypeDef
Usage example with kwargs
kwargs: PartnerIntegrationInputMessageRequestTypeDef = {  # (1)
    "AccountId": ...,
    "ClusterIdentifier": ...,
    "DatabaseName": ...,
    "PartnerName": ...,
}

parent.delete_partner(**kwargs)
  1. See PartnerIntegrationInputMessageRequestTypeDef

delete_scheduled_action

Deletes a scheduled action.

Type annotations and code completion for boto3.client("redshift").delete_scheduled_action method. boto3 documentation

Method definition
def delete_scheduled_action(
    self,
    *,
    ScheduledActionName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteScheduledActionMessageRequestTypeDef = {  # (1)
    "ScheduledActionName": ...,
}

parent.delete_scheduled_action(**kwargs)
  1. See DeleteScheduledActionMessageRequestTypeDef

delete_snapshot_copy_grant

Deletes the specified snapshot copy grant.

Type annotations and code completion for boto3.client("redshift").delete_snapshot_copy_grant method. boto3 documentation

Method definition
def delete_snapshot_copy_grant(
    self,
    *,
    SnapshotCopyGrantName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteSnapshotCopyGrantMessageRequestTypeDef = {  # (1)
    "SnapshotCopyGrantName": ...,
}

parent.delete_snapshot_copy_grant(**kwargs)
  1. See DeleteSnapshotCopyGrantMessageRequestTypeDef

delete_snapshot_schedule

Deletes a snapshot schedule.

Type annotations and code completion for boto3.client("redshift").delete_snapshot_schedule method. boto3 documentation

Method definition
def delete_snapshot_schedule(
    self,
    *,
    ScheduleIdentifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteSnapshotScheduleMessageRequestTypeDef = {  # (1)
    "ScheduleIdentifier": ...,
}

parent.delete_snapshot_schedule(**kwargs)
  1. See DeleteSnapshotScheduleMessageRequestTypeDef

delete_tags

Deletes tags from a resource.

Type annotations and code completion for boto3.client("redshift").delete_tags method. boto3 documentation

Method definition
def delete_tags(
    self,
    *,
    ResourceName: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteTagsMessageRequestTypeDef = {  # (1)
    "ResourceName": ...,
    "TagKeys": ...,
}

parent.delete_tags(**kwargs)
  1. See DeleteTagsMessageRequestTypeDef

delete_usage_limit

Deletes a usage limit from a cluster.

Type annotations and code completion for boto3.client("redshift").delete_usage_limit method. boto3 documentation

Method definition
def delete_usage_limit(
    self,
    *,
    UsageLimitId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteUsageLimitMessageRequestTypeDef = {  # (1)
    "UsageLimitId": ...,
}

parent.delete_usage_limit(**kwargs)
  1. See DeleteUsageLimitMessageRequestTypeDef

describe_account_attributes

Returns a list of attributes attached to an account See also: AWS API Documentation.

Type annotations and code completion for boto3.client("redshift").describe_account_attributes method. boto3 documentation

Method definition
def describe_account_attributes(
    self,
    *,
    AttributeNames: Sequence[str] = ...,
) -> AccountAttributeListTypeDef:  # (1)
    ...
  1. See AccountAttributeListTypeDef
Usage example with kwargs
kwargs: DescribeAccountAttributesMessageRequestTypeDef = {  # (1)
    "AttributeNames": ...,
}

parent.describe_account_attributes(**kwargs)
  1. See DescribeAccountAttributesMessageRequestTypeDef

describe_authentication_profiles

Describes an authentication profile.

Type annotations and code completion for boto3.client("redshift").describe_authentication_profiles method. boto3 documentation

Method definition
def describe_authentication_profiles(
    self,
    *,
    AuthenticationProfileName: str = ...,
) -> DescribeAuthenticationProfilesResultTypeDef:  # (1)
    ...
  1. See DescribeAuthenticationProfilesResultTypeDef
Usage example with kwargs
kwargs: DescribeAuthenticationProfilesMessageRequestTypeDef = {  # (1)
    "AuthenticationProfileName": ...,
}

parent.describe_authentication_profiles(**kwargs)
  1. See DescribeAuthenticationProfilesMessageRequestTypeDef

describe_cluster_db_revisions

Returns an array of ClusterDbRevision objects.

Type annotations and code completion for boto3.client("redshift").describe_cluster_db_revisions method. boto3 documentation

Method definition
def describe_cluster_db_revisions(
    self,
    *,
    ClusterIdentifier: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> ClusterDbRevisionsMessageTypeDef:  # (1)
    ...
  1. See ClusterDbRevisionsMessageTypeDef
Usage example with kwargs
kwargs: DescribeClusterDbRevisionsMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.describe_cluster_db_revisions(**kwargs)
  1. See DescribeClusterDbRevisionsMessageRequestTypeDef

describe_cluster_parameter_groups

Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group.

Type annotations and code completion for boto3.client("redshift").describe_cluster_parameter_groups method. boto3 documentation

Method definition
def describe_cluster_parameter_groups(
    self,
    *,
    ParameterGroupName: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
) -> ClusterParameterGroupsMessageTypeDef:  # (1)
    ...
  1. See ClusterParameterGroupsMessageTypeDef
Usage example with kwargs
kwargs: DescribeClusterParameterGroupsMessageRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
}

parent.describe_cluster_parameter_groups(**kwargs)
  1. See DescribeClusterParameterGroupsMessageRequestTypeDef

describe_cluster_parameters

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group.

Type annotations and code completion for boto3.client("redshift").describe_cluster_parameters method. boto3 documentation

Method definition
def describe_cluster_parameters(
    self,
    *,
    ParameterGroupName: str,
    Source: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> ClusterParameterGroupDetailsTypeDef:  # (1)
    ...
  1. See ClusterParameterGroupDetailsTypeDef
Usage example with kwargs
kwargs: DescribeClusterParametersMessageRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
}

parent.describe_cluster_parameters(**kwargs)
  1. See DescribeClusterParametersMessageRequestTypeDef

describe_cluster_security_groups

Returns information about Amazon Redshift security groups.

Type annotations and code completion for boto3.client("redshift").describe_cluster_security_groups method. boto3 documentation

Method definition
def describe_cluster_security_groups(
    self,
    *,
    ClusterSecurityGroupName: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
) -> ClusterSecurityGroupMessageTypeDef:  # (1)
    ...
  1. See ClusterSecurityGroupMessageTypeDef
Usage example with kwargs
kwargs: DescribeClusterSecurityGroupsMessageRequestTypeDef = {  # (1)
    "ClusterSecurityGroupName": ...,
}

parent.describe_cluster_security_groups(**kwargs)
  1. See DescribeClusterSecurityGroupsMessageRequestTypeDef

describe_cluster_snapshots

Returns one or more snapshot objects, which contain metadata about your cluster snapshots.

Type annotations and code completion for boto3.client("redshift").describe_cluster_snapshots method. boto3 documentation

Method definition
def describe_cluster_snapshots(
    self,
    *,
    ClusterIdentifier: str = ...,
    SnapshotIdentifier: str = ...,
    SnapshotArn: str = ...,
    SnapshotType: str = ...,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    OwnerAccount: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
    ClusterExists: bool = ...,
    SortingEntities: Sequence[SnapshotSortingEntityTypeDef] = ...,  # (1)
) -> SnapshotMessageTypeDef:  # (2)
    ...
  1. See SnapshotSortingEntityTypeDef
  2. See SnapshotMessageTypeDef
Usage example with kwargs
kwargs: DescribeClusterSnapshotsMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.describe_cluster_snapshots(**kwargs)
  1. See DescribeClusterSnapshotsMessageRequestTypeDef

describe_cluster_subnet_groups

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups.

Type annotations and code completion for boto3.client("redshift").describe_cluster_subnet_groups method. boto3 documentation

Method definition
def describe_cluster_subnet_groups(
    self,
    *,
    ClusterSubnetGroupName: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
) -> ClusterSubnetGroupMessageTypeDef:  # (1)
    ...
  1. See ClusterSubnetGroupMessageTypeDef
Usage example with kwargs
kwargs: DescribeClusterSubnetGroupsMessageRequestTypeDef = {  # (1)
    "ClusterSubnetGroupName": ...,
}

parent.describe_cluster_subnet_groups(**kwargs)
  1. See DescribeClusterSubnetGroupsMessageRequestTypeDef

describe_cluster_tracks

Returns a list of all the available maintenance tracks.

Type annotations and code completion for boto3.client("redshift").describe_cluster_tracks method. boto3 documentation

Method definition
def describe_cluster_tracks(
    self,
    *,
    MaintenanceTrackName: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> TrackListMessageTypeDef:  # (1)
    ...
  1. See TrackListMessageTypeDef
Usage example with kwargs
kwargs: DescribeClusterTracksMessageRequestTypeDef = {  # (1)
    "MaintenanceTrackName": ...,
}

parent.describe_cluster_tracks(**kwargs)
  1. See DescribeClusterTracksMessageRequestTypeDef

describe_cluster_versions

Returns descriptions of the available Amazon Redshift cluster versions.

Type annotations and code completion for boto3.client("redshift").describe_cluster_versions method. boto3 documentation

Method definition
def describe_cluster_versions(
    self,
    *,
    ClusterVersion: str = ...,
    ClusterParameterGroupFamily: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> ClusterVersionsMessageTypeDef:  # (1)
    ...
  1. See ClusterVersionsMessageTypeDef
Usage example with kwargs
kwargs: DescribeClusterVersionsMessageRequestTypeDef = {  # (1)
    "ClusterVersion": ...,
}

parent.describe_cluster_versions(**kwargs)
  1. See DescribeClusterVersionsMessageRequestTypeDef

describe_clusters

Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties.

Type annotations and code completion for boto3.client("redshift").describe_clusters method. boto3 documentation

Method definition
def describe_clusters(
    self,
    *,
    ClusterIdentifier: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
) -> ClustersMessageTypeDef:  # (1)
    ...
  1. See ClustersMessageTypeDef
Usage example with kwargs
kwargs: DescribeClustersMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.describe_clusters(**kwargs)
  1. See DescribeClustersMessageRequestTypeDef

describe_data_shares

Shows the status of any inbound or outbound datashares available in the specified account.

Type annotations and code completion for boto3.client("redshift").describe_data_shares method. boto3 documentation

Method definition
def describe_data_shares(
    self,
    *,
    DataShareArn: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeDataSharesResultTypeDef:  # (1)
    ...
  1. See DescribeDataSharesResultTypeDef
Usage example with kwargs
kwargs: DescribeDataSharesMessageRequestTypeDef = {  # (1)
    "DataShareArn": ...,
}

parent.describe_data_shares(**kwargs)
  1. See DescribeDataSharesMessageRequestTypeDef

describe_data_shares_for_consumer

Returns a list of datashares where the account identifier being called is a consumer account identifier.

Type annotations and code completion for boto3.client("redshift").describe_data_shares_for_consumer method. boto3 documentation

Method definition
def describe_data_shares_for_consumer(
    self,
    *,
    ConsumerArn: str = ...,
    Status: DataShareStatusForConsumerType = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeDataSharesForConsumerResultTypeDef:  # (2)
    ...
  1. See DataShareStatusForConsumerType
  2. See DescribeDataSharesForConsumerResultTypeDef
Usage example with kwargs
kwargs: DescribeDataSharesForConsumerMessageRequestTypeDef = {  # (1)
    "ConsumerArn": ...,
}

parent.describe_data_shares_for_consumer(**kwargs)
  1. See DescribeDataSharesForConsumerMessageRequestTypeDef

describe_data_shares_for_producer

Returns a list of datashares when the account identifier being called is a producer account identifier.

Type annotations and code completion for boto3.client("redshift").describe_data_shares_for_producer method. boto3 documentation

Method definition
def describe_data_shares_for_producer(
    self,
    *,
    ProducerArn: str = ...,
    Status: DataShareStatusForProducerType = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeDataSharesForProducerResultTypeDef:  # (2)
    ...
  1. See DataShareStatusForProducerType
  2. See DescribeDataSharesForProducerResultTypeDef
Usage example with kwargs
kwargs: DescribeDataSharesForProducerMessageRequestTypeDef = {  # (1)
    "ProducerArn": ...,
}

parent.describe_data_shares_for_producer(**kwargs)
  1. See DescribeDataSharesForProducerMessageRequestTypeDef

describe_default_cluster_parameters

Returns a list of parameter settings for the specified parameter group family.

Type annotations and code completion for boto3.client("redshift").describe_default_cluster_parameters method. boto3 documentation

Method definition
def describe_default_cluster_parameters(
    self,
    *,
    ParameterGroupFamily: str,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeDefaultClusterParametersResultTypeDef:  # (1)
    ...
  1. See DescribeDefaultClusterParametersResultTypeDef
Usage example with kwargs
kwargs: DescribeDefaultClusterParametersMessageRequestTypeDef = {  # (1)
    "ParameterGroupFamily": ...,
}

parent.describe_default_cluster_parameters(**kwargs)
  1. See DescribeDefaultClusterParametersMessageRequestTypeDef

describe_endpoint_access

Describes a Redshift-managed VPC endpoint.

Type annotations and code completion for boto3.client("redshift").describe_endpoint_access method. boto3 documentation

Method definition
def describe_endpoint_access(
    self,
    *,
    ClusterIdentifier: str = ...,
    ResourceOwner: str = ...,
    EndpointName: str = ...,
    VpcId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> EndpointAccessListTypeDef:  # (1)
    ...
  1. See EndpointAccessListTypeDef
Usage example with kwargs
kwargs: DescribeEndpointAccessMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.describe_endpoint_access(**kwargs)
  1. See DescribeEndpointAccessMessageRequestTypeDef

describe_endpoint_authorization

Describes an endpoint authorization.

Type annotations and code completion for boto3.client("redshift").describe_endpoint_authorization method. boto3 documentation

Method definition
def describe_endpoint_authorization(
    self,
    *,
    ClusterIdentifier: str = ...,
    Account: str = ...,
    Grantee: bool = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> EndpointAuthorizationListTypeDef:  # (1)
    ...
  1. See EndpointAuthorizationListTypeDef
Usage example with kwargs
kwargs: DescribeEndpointAuthorizationMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.describe_endpoint_authorization(**kwargs)
  1. See DescribeEndpointAuthorizationMessageRequestTypeDef

describe_event_categories

Displays a list of event categories for all event source types, or for a specified source type.

Type annotations and code completion for boto3.client("redshift").describe_event_categories method. boto3 documentation

Method definition
def describe_event_categories(
    self,
    *,
    SourceType: str = ...,
) -> EventCategoriesMessageTypeDef:  # (1)
    ...
  1. See EventCategoriesMessageTypeDef
Usage example with kwargs
kwargs: DescribeEventCategoriesMessageRequestTypeDef = {  # (1)
    "SourceType": ...,
}

parent.describe_event_categories(**kwargs)
  1. See DescribeEventCategoriesMessageRequestTypeDef

describe_event_subscriptions

Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account.

Type annotations and code completion for boto3.client("redshift").describe_event_subscriptions method. boto3 documentation

Method definition
def describe_event_subscriptions(
    self,
    *,
    SubscriptionName: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
) -> EventSubscriptionsMessageTypeDef:  # (1)
    ...
  1. See EventSubscriptionsMessageTypeDef
Usage example with kwargs
kwargs: DescribeEventSubscriptionsMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
}

parent.describe_event_subscriptions(**kwargs)
  1. See DescribeEventSubscriptionsMessageRequestTypeDef

describe_events

Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days.

Type annotations and code completion for boto3.client("redshift").describe_events method. boto3 documentation

Method definition
def describe_events(
    self,
    *,
    SourceIdentifier: str = ...,
    SourceType: SourceTypeType = ...,  # (1)
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    Duration: int = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> EventsMessageTypeDef:  # (2)
    ...
  1. See SourceTypeType
  2. See EventsMessageTypeDef
Usage example with kwargs
kwargs: DescribeEventsMessageRequestTypeDef = {  # (1)
    "SourceIdentifier": ...,
}

parent.describe_events(**kwargs)
  1. See DescribeEventsMessageRequestTypeDef

describe_hsm_client_certificates

Returns information about the specified HSM client certificate.

Type annotations and code completion for boto3.client("redshift").describe_hsm_client_certificates method. boto3 documentation

Method definition
def describe_hsm_client_certificates(
    self,
    *,
    HsmClientCertificateIdentifier: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
) -> HsmClientCertificateMessageTypeDef:  # (1)
    ...
  1. See HsmClientCertificateMessageTypeDef
Usage example with kwargs
kwargs: DescribeHsmClientCertificatesMessageRequestTypeDef = {  # (1)
    "HsmClientCertificateIdentifier": ...,
}

parent.describe_hsm_client_certificates(**kwargs)
  1. See DescribeHsmClientCertificatesMessageRequestTypeDef

describe_hsm_configurations

Returns information about the specified Amazon Redshift HSM configuration.

Type annotations and code completion for boto3.client("redshift").describe_hsm_configurations method. boto3 documentation

Method definition
def describe_hsm_configurations(
    self,
    *,
    HsmConfigurationIdentifier: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
) -> HsmConfigurationMessageTypeDef:  # (1)
    ...
  1. See HsmConfigurationMessageTypeDef
Usage example with kwargs
kwargs: DescribeHsmConfigurationsMessageRequestTypeDef = {  # (1)
    "HsmConfigurationIdentifier": ...,
}

parent.describe_hsm_configurations(**kwargs)
  1. See DescribeHsmConfigurationsMessageRequestTypeDef

describe_logging_status

Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.

Type annotations and code completion for boto3.client("redshift").describe_logging_status method. boto3 documentation

Method definition
def describe_logging_status(
    self,
    *,
    ClusterIdentifier: str,
) -> LoggingStatusTypeDef:  # (1)
    ...
  1. See LoggingStatusTypeDef
Usage example with kwargs
kwargs: DescribeLoggingStatusMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.describe_logging_status(**kwargs)
  1. See DescribeLoggingStatusMessageRequestTypeDef

describe_node_configuration_options

Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.

Type annotations and code completion for boto3.client("redshift").describe_node_configuration_options method. boto3 documentation

Method definition
def describe_node_configuration_options(
    self,
    *,
    ActionType: ActionTypeType,  # (1)
    ClusterIdentifier: str = ...,
    SnapshotIdentifier: str = ...,
    SnapshotArn: str = ...,
    OwnerAccount: str = ...,
    Filters: Sequence[NodeConfigurationOptionsFilterTypeDef] = ...,  # (2)
    Marker: str = ...,
    MaxRecords: int = ...,
) -> NodeConfigurationOptionsMessageTypeDef:  # (3)
    ...
  1. See ActionTypeType
  2. See NodeConfigurationOptionsFilterTypeDef
  3. See NodeConfigurationOptionsMessageTypeDef
Usage example with kwargs
kwargs: DescribeNodeConfigurationOptionsMessageRequestTypeDef = {  # (1)
    "ActionType": ...,
}

parent.describe_node_configuration_options(**kwargs)
  1. See DescribeNodeConfigurationOptionsMessageRequestTypeDef

describe_orderable_cluster_options

Returns a list of orderable cluster options.

Type annotations and code completion for boto3.client("redshift").describe_orderable_cluster_options method. boto3 documentation

Method definition
def describe_orderable_cluster_options(
    self,
    *,
    ClusterVersion: str = ...,
    NodeType: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> OrderableClusterOptionsMessageTypeDef:  # (1)
    ...
  1. See OrderableClusterOptionsMessageTypeDef
Usage example with kwargs
kwargs: DescribeOrderableClusterOptionsMessageRequestTypeDef = {  # (1)
    "ClusterVersion": ...,
}

parent.describe_orderable_cluster_options(**kwargs)
  1. See DescribeOrderableClusterOptionsMessageRequestTypeDef

describe_partners

Returns information about the partner integrations defined for a cluster.

Type annotations and code completion for boto3.client("redshift").describe_partners method. boto3 documentation

Method definition
def describe_partners(
    self,
    *,
    AccountId: str,
    ClusterIdentifier: str,
    DatabaseName: str = ...,
    PartnerName: str = ...,
) -> DescribePartnersOutputMessageTypeDef:  # (1)
    ...
  1. See DescribePartnersOutputMessageTypeDef
Usage example with kwargs
kwargs: DescribePartnersInputMessageRequestTypeDef = {  # (1)
    "AccountId": ...,
    "ClusterIdentifier": ...,
}

parent.describe_partners(**kwargs)
  1. See DescribePartnersInputMessageRequestTypeDef

describe_reserved_node_exchange_status

Returns exchange status details and associated metadata for a reserved-node exchange.

Type annotations and code completion for boto3.client("redshift").describe_reserved_node_exchange_status method. boto3 documentation

Method definition
def describe_reserved_node_exchange_status(
    self,
    *,
    ReservedNodeId: str = ...,
    ReservedNodeExchangeRequestId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeReservedNodeExchangeStatusOutputMessageTypeDef:  # (1)
    ...
  1. See DescribeReservedNodeExchangeStatusOutputMessageTypeDef
Usage example with kwargs
kwargs: DescribeReservedNodeExchangeStatusInputMessageRequestTypeDef = {  # (1)
    "ReservedNodeId": ...,
}

parent.describe_reserved_node_exchange_status(**kwargs)
  1. See DescribeReservedNodeExchangeStatusInputMessageRequestTypeDef

describe_reserved_node_offerings

Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you.

Type annotations and code completion for boto3.client("redshift").describe_reserved_node_offerings method. boto3 documentation

Method definition
def describe_reserved_node_offerings(
    self,
    *,
    ReservedNodeOfferingId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> ReservedNodeOfferingsMessageTypeDef:  # (1)
    ...
  1. See ReservedNodeOfferingsMessageTypeDef
Usage example with kwargs
kwargs: DescribeReservedNodeOfferingsMessageRequestTypeDef = {  # (1)
    "ReservedNodeOfferingId": ...,
}

parent.describe_reserved_node_offerings(**kwargs)
  1. See DescribeReservedNodeOfferingsMessageRequestTypeDef

describe_reserved_nodes

Returns the descriptions of the reserved nodes.

Type annotations and code completion for boto3.client("redshift").describe_reserved_nodes method. boto3 documentation

Method definition
def describe_reserved_nodes(
    self,
    *,
    ReservedNodeId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> ReservedNodesMessageTypeDef:  # (1)
    ...
  1. See ReservedNodesMessageTypeDef
Usage example with kwargs
kwargs: DescribeReservedNodesMessageRequestTypeDef = {  # (1)
    "ReservedNodeId": ...,
}

parent.describe_reserved_nodes(**kwargs)
  1. See DescribeReservedNodesMessageRequestTypeDef

describe_resize

Returns information about the last resize operation for the specified cluster.

Type annotations and code completion for boto3.client("redshift").describe_resize method. boto3 documentation

Method definition
def describe_resize(
    self,
    *,
    ClusterIdentifier: str,
) -> ResizeProgressMessageTypeDef:  # (1)
    ...
  1. See ResizeProgressMessageTypeDef
Usage example with kwargs
kwargs: DescribeResizeMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.describe_resize(**kwargs)
  1. See DescribeResizeMessageRequestTypeDef

describe_scheduled_actions

Describes properties of scheduled actions.

Type annotations and code completion for boto3.client("redshift").describe_scheduled_actions method. boto3 documentation

Method definition
def describe_scheduled_actions(
    self,
    *,
    ScheduledActionName: str = ...,
    TargetActionType: ScheduledActionTypeValuesType = ...,  # (1)
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    Active: bool = ...,
    Filters: Sequence[ScheduledActionFilterTypeDef] = ...,  # (2)
    Marker: str = ...,
    MaxRecords: int = ...,
) -> ScheduledActionsMessageTypeDef:  # (3)
    ...
  1. See ScheduledActionTypeValuesType
  2. See ScheduledActionFilterTypeDef
  3. See ScheduledActionsMessageTypeDef
Usage example with kwargs
kwargs: DescribeScheduledActionsMessageRequestTypeDef = {  # (1)
    "ScheduledActionName": ...,
}

parent.describe_scheduled_actions(**kwargs)
  1. See DescribeScheduledActionsMessageRequestTypeDef

describe_snapshot_copy_grants

Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.

Type annotations and code completion for boto3.client("redshift").describe_snapshot_copy_grants method. boto3 documentation

Method definition
def describe_snapshot_copy_grants(
    self,
    *,
    SnapshotCopyGrantName: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
) -> SnapshotCopyGrantMessageTypeDef:  # (1)
    ...
  1. See SnapshotCopyGrantMessageTypeDef
Usage example with kwargs
kwargs: DescribeSnapshotCopyGrantsMessageRequestTypeDef = {  # (1)
    "SnapshotCopyGrantName": ...,
}

parent.describe_snapshot_copy_grants(**kwargs)
  1. See DescribeSnapshotCopyGrantsMessageRequestTypeDef

describe_snapshot_schedules

Returns a list of snapshot schedules.

Type annotations and code completion for boto3.client("redshift").describe_snapshot_schedules method. boto3 documentation

Method definition
def describe_snapshot_schedules(
    self,
    *,
    ClusterIdentifier: str = ...,
    ScheduleIdentifier: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
    Marker: str = ...,
    MaxRecords: int = ...,
) -> DescribeSnapshotSchedulesOutputMessageTypeDef:  # (1)
    ...
  1. See DescribeSnapshotSchedulesOutputMessageTypeDef
Usage example with kwargs
kwargs: DescribeSnapshotSchedulesMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.describe_snapshot_schedules(**kwargs)
  1. See DescribeSnapshotSchedulesMessageRequestTypeDef

describe_storage

Returns account level backups storage size and provisional storage.

Type annotations and code completion for boto3.client("redshift").describe_storage method. boto3 documentation

Method definition
def describe_storage(
    self,
) -> CustomerStorageMessageTypeDef:  # (1)
    ...
  1. See CustomerStorageMessageTypeDef

describe_table_restore_status

Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action.

Type annotations and code completion for boto3.client("redshift").describe_table_restore_status method. boto3 documentation

Method definition
def describe_table_restore_status(
    self,
    *,
    ClusterIdentifier: str = ...,
    TableRestoreRequestId: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> TableRestoreStatusMessageTypeDef:  # (1)
    ...
  1. See TableRestoreStatusMessageTypeDef
Usage example with kwargs
kwargs: DescribeTableRestoreStatusMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.describe_table_restore_status(**kwargs)
  1. See DescribeTableRestoreStatusMessageRequestTypeDef

describe_tags

Returns a list of tags.

Type annotations and code completion for boto3.client("redshift").describe_tags method. boto3 documentation

Method definition
def describe_tags(
    self,
    *,
    ResourceName: str = ...,
    ResourceType: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
) -> TaggedResourceListMessageTypeDef:  # (1)
    ...
  1. See TaggedResourceListMessageTypeDef
Usage example with kwargs
kwargs: DescribeTagsMessageRequestTypeDef = {  # (1)
    "ResourceName": ...,
}

parent.describe_tags(**kwargs)
  1. See DescribeTagsMessageRequestTypeDef

describe_usage_limits

Shows usage limits on a cluster.

Type annotations and code completion for boto3.client("redshift").describe_usage_limits method. boto3 documentation

Method definition
def describe_usage_limits(
    self,
    *,
    UsageLimitId: str = ...,
    ClusterIdentifier: str = ...,
    FeatureType: UsageLimitFeatureTypeType = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    TagKeys: Sequence[str] = ...,
    TagValues: Sequence[str] = ...,
) -> UsageLimitListTypeDef:  # (2)
    ...
  1. See UsageLimitFeatureTypeType
  2. See UsageLimitListTypeDef
Usage example with kwargs
kwargs: DescribeUsageLimitsMessageRequestTypeDef = {  # (1)
    "UsageLimitId": ...,
}

parent.describe_usage_limits(**kwargs)
  1. See DescribeUsageLimitsMessageRequestTypeDef

disable_logging

Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Type annotations and code completion for boto3.client("redshift").disable_logging method. boto3 documentation

Method definition
def disable_logging(
    self,
    *,
    ClusterIdentifier: str,
) -> LoggingStatusTypeDef:  # (1)
    ...
  1. See LoggingStatusTypeDef
Usage example with kwargs
kwargs: DisableLoggingMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.disable_logging(**kwargs)
  1. See DisableLoggingMessageRequestTypeDef

disable_snapshot_copy

Disables the automatic copying of snapshots from one region to another region for a specified cluster.

Type annotations and code completion for boto3.client("redshift").disable_snapshot_copy method. boto3 documentation

Method definition
def disable_snapshot_copy(
    self,
    *,
    ClusterIdentifier: str,
) -> DisableSnapshotCopyResultTypeDef:  # (1)
    ...
  1. See DisableSnapshotCopyResultTypeDef
Usage example with kwargs
kwargs: DisableSnapshotCopyMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.disable_snapshot_copy(**kwargs)
  1. See DisableSnapshotCopyMessageRequestTypeDef

disassociate_data_share_consumer

From a datashare consumer account, remove association for the specified datashare.

Type annotations and code completion for boto3.client("redshift").disassociate_data_share_consumer method. boto3 documentation

Method definition
def disassociate_data_share_consumer(
    self,
    *,
    DataShareArn: str,
    DisassociateEntireAccount: bool = ...,
    ConsumerArn: str = ...,
    ConsumerRegion: str = ...,
) -> DataShareResponseMetadataTypeDef:  # (1)
    ...
  1. See DataShareResponseMetadataTypeDef
Usage example with kwargs
kwargs: DisassociateDataShareConsumerMessageRequestTypeDef = {  # (1)
    "DataShareArn": ...,
}

parent.disassociate_data_share_consumer(**kwargs)
  1. See DisassociateDataShareConsumerMessageRequestTypeDef

enable_logging

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Type annotations and code completion for boto3.client("redshift").enable_logging method. boto3 documentation

Method definition
def enable_logging(
    self,
    *,
    ClusterIdentifier: str,
    BucketName: str = ...,
    S3KeyPrefix: str = ...,
    LogDestinationType: LogDestinationTypeType = ...,  # (1)
    LogExports: Sequence[str] = ...,
) -> LoggingStatusTypeDef:  # (2)
    ...
  1. See LogDestinationTypeType
  2. See LoggingStatusTypeDef
Usage example with kwargs
kwargs: EnableLoggingMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.enable_logging(**kwargs)
  1. See EnableLoggingMessageRequestTypeDef

enable_snapshot_copy

Enables the automatic copy of snapshots from one region to another region for a specified cluster.

Type annotations and code completion for boto3.client("redshift").enable_snapshot_copy method. boto3 documentation

Method definition
def enable_snapshot_copy(
    self,
    *,
    ClusterIdentifier: str,
    DestinationRegion: str,
    RetentionPeriod: int = ...,
    SnapshotCopyGrantName: str = ...,
    ManualSnapshotRetentionPeriod: int = ...,
) -> EnableSnapshotCopyResultTypeDef:  # (1)
    ...
  1. See EnableSnapshotCopyResultTypeDef
Usage example with kwargs
kwargs: EnableSnapshotCopyMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
    "DestinationRegion": ...,
}

parent.enable_snapshot_copy(**kwargs)
  1. See EnableSnapshotCopyMessageRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("redshift").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_cluster_credentials

Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database.

Type annotations and code completion for boto3.client("redshift").get_cluster_credentials method. boto3 documentation

Method definition
def get_cluster_credentials(
    self,
    *,
    DbUser: str,
    ClusterIdentifier: str,
    DbName: str = ...,
    DurationSeconds: int = ...,
    AutoCreate: bool = ...,
    DbGroups: Sequence[str] = ...,
) -> ClusterCredentialsTypeDef:  # (1)
    ...
  1. See ClusterCredentialsTypeDef
Usage example with kwargs
kwargs: GetClusterCredentialsMessageRequestTypeDef = {  # (1)
    "DbUser": ...,
    "ClusterIdentifier": ...,
}

parent.get_cluster_credentials(**kwargs)
  1. See GetClusterCredentialsMessageRequestTypeDef

get_cluster_credentials_with_iam

Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database.

Type annotations and code completion for boto3.client("redshift").get_cluster_credentials_with_iam method. boto3 documentation

Method definition
def get_cluster_credentials_with_iam(
    self,
    *,
    ClusterIdentifier: str,
    DbName: str = ...,
    DurationSeconds: int = ...,
) -> ClusterExtendedCredentialsTypeDef:  # (1)
    ...
  1. See ClusterExtendedCredentialsTypeDef
Usage example with kwargs
kwargs: GetClusterCredentialsWithIAMMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.get_cluster_credentials_with_iam(**kwargs)
  1. See GetClusterCredentialsWithIAMMessageRequestTypeDef

get_reserved_node_exchange_configuration_options

Gets the configuration options for the reserved-node exchange.

Type annotations and code completion for boto3.client("redshift").get_reserved_node_exchange_configuration_options method. boto3 documentation

Method definition
def get_reserved_node_exchange_configuration_options(
    self,
    *,
    ActionType: ReservedNodeExchangeActionTypeType,  # (1)
    ClusterIdentifier: str = ...,
    SnapshotIdentifier: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> GetReservedNodeExchangeConfigurationOptionsOutputMessageTypeDef:  # (2)
    ...
  1. See ReservedNodeExchangeActionTypeType
  2. See GetReservedNodeExchangeConfigurationOptionsOutputMessageTypeDef
Usage example with kwargs
kwargs: GetReservedNodeExchangeConfigurationOptionsInputMessageRequestTypeDef = {  # (1)
    "ActionType": ...,
}

parent.get_reserved_node_exchange_configuration_options(**kwargs)
  1. See GetReservedNodeExchangeConfigurationOptionsInputMessageRequestTypeDef

get_reserved_node_exchange_offerings

Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.

Type annotations and code completion for boto3.client("redshift").get_reserved_node_exchange_offerings method. boto3 documentation

Method definition
def get_reserved_node_exchange_offerings(
    self,
    *,
    ReservedNodeId: str,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> GetReservedNodeExchangeOfferingsOutputMessageTypeDef:  # (1)
    ...
  1. See GetReservedNodeExchangeOfferingsOutputMessageTypeDef
Usage example with kwargs
kwargs: GetReservedNodeExchangeOfferingsInputMessageRequestTypeDef = {  # (1)
    "ReservedNodeId": ...,
}

parent.get_reserved_node_exchange_offerings(**kwargs)
  1. See GetReservedNodeExchangeOfferingsInputMessageRequestTypeDef

modify_aqua_configuration

This operation is retired.

Type annotations and code completion for boto3.client("redshift").modify_aqua_configuration method. boto3 documentation

Method definition
def modify_aqua_configuration(
    self,
    *,
    ClusterIdentifier: str,
    AquaConfigurationStatus: AquaConfigurationStatusType = ...,  # (1)
) -> ModifyAquaOutputMessageTypeDef:  # (2)
    ...
  1. See AquaConfigurationStatusType
  2. See ModifyAquaOutputMessageTypeDef
Usage example with kwargs
kwargs: ModifyAquaInputMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.modify_aqua_configuration(**kwargs)
  1. See ModifyAquaInputMessageRequestTypeDef

modify_authentication_profile

Modifies an authentication profile.

Type annotations and code completion for boto3.client("redshift").modify_authentication_profile method. boto3 documentation

Method definition
def modify_authentication_profile(
    self,
    *,
    AuthenticationProfileName: str,
    AuthenticationProfileContent: str,
) -> ModifyAuthenticationProfileResultTypeDef:  # (1)
    ...
  1. See ModifyAuthenticationProfileResultTypeDef
Usage example with kwargs
kwargs: ModifyAuthenticationProfileMessageRequestTypeDef = {  # (1)
    "AuthenticationProfileName": ...,
    "AuthenticationProfileContent": ...,
}

parent.modify_authentication_profile(**kwargs)
  1. See ModifyAuthenticationProfileMessageRequestTypeDef

modify_cluster

Modifies the settings for a cluster.

Type annotations and code completion for boto3.client("redshift").modify_cluster method. boto3 documentation

Method definition
def modify_cluster(
    self,
    *,
    ClusterIdentifier: str,
    ClusterType: str = ...,
    NodeType: str = ...,
    NumberOfNodes: int = ...,
    ClusterSecurityGroups: Sequence[str] = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    MasterUserPassword: str = ...,
    ClusterParameterGroupName: str = ...,
    AutomatedSnapshotRetentionPeriod: int = ...,
    ManualSnapshotRetentionPeriod: int = ...,
    PreferredMaintenanceWindow: str = ...,
    ClusterVersion: str = ...,
    AllowVersionUpgrade: bool = ...,
    HsmClientCertificateIdentifier: str = ...,
    HsmConfigurationIdentifier: str = ...,
    NewClusterIdentifier: str = ...,
    PubliclyAccessible: bool = ...,
    ElasticIp: str = ...,
    EnhancedVpcRouting: bool = ...,
    MaintenanceTrackName: str = ...,
    Encrypted: bool = ...,
    KmsKeyId: str = ...,
    AvailabilityZoneRelocation: bool = ...,
    AvailabilityZone: str = ...,
    Port: int = ...,
) -> ModifyClusterResultTypeDef:  # (1)
    ...
  1. See ModifyClusterResultTypeDef
Usage example with kwargs
kwargs: ModifyClusterMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.modify_cluster(**kwargs)
  1. See ModifyClusterMessageRequestTypeDef

modify_cluster_db_revision

Modifies the database revision of a cluster.

Type annotations and code completion for boto3.client("redshift").modify_cluster_db_revision method. boto3 documentation

Method definition
def modify_cluster_db_revision(
    self,
    *,
    ClusterIdentifier: str,
    RevisionTarget: str,
) -> ModifyClusterDbRevisionResultTypeDef:  # (1)
    ...
  1. See ModifyClusterDbRevisionResultTypeDef
Usage example with kwargs
kwargs: ModifyClusterDbRevisionMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
    "RevisionTarget": ...,
}

parent.modify_cluster_db_revision(**kwargs)
  1. See ModifyClusterDbRevisionMessageRequestTypeDef

modify_cluster_iam_roles

Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

Type annotations and code completion for boto3.client("redshift").modify_cluster_iam_roles method. boto3 documentation

Method definition
def modify_cluster_iam_roles(
    self,
    *,
    ClusterIdentifier: str,
    AddIamRoles: Sequence[str] = ...,
    RemoveIamRoles: Sequence[str] = ...,
    DefaultIamRoleArn: str = ...,
) -> ModifyClusterIamRolesResultTypeDef:  # (1)
    ...
  1. See ModifyClusterIamRolesResultTypeDef
Usage example with kwargs
kwargs: ModifyClusterIamRolesMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.modify_cluster_iam_roles(**kwargs)
  1. See ModifyClusterIamRolesMessageRequestTypeDef

modify_cluster_maintenance

Modifies the maintenance settings of a cluster.

Type annotations and code completion for boto3.client("redshift").modify_cluster_maintenance method. boto3 documentation

Method definition
def modify_cluster_maintenance(
    self,
    *,
    ClusterIdentifier: str,
    DeferMaintenance: bool = ...,
    DeferMaintenanceIdentifier: str = ...,
    DeferMaintenanceStartTime: Union[datetime, str] = ...,
    DeferMaintenanceEndTime: Union[datetime, str] = ...,
    DeferMaintenanceDuration: int = ...,
) -> ModifyClusterMaintenanceResultTypeDef:  # (1)
    ...
  1. See ModifyClusterMaintenanceResultTypeDef
Usage example with kwargs
kwargs: ModifyClusterMaintenanceMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.modify_cluster_maintenance(**kwargs)
  1. See ModifyClusterMaintenanceMessageRequestTypeDef

modify_cluster_parameter_group

Modifies the parameters of a parameter group.

Type annotations and code completion for boto3.client("redshift").modify_cluster_parameter_group method. boto3 documentation

Method definition
def modify_cluster_parameter_group(
    self,
    *,
    ParameterGroupName: str,
    Parameters: Sequence[ParameterTypeDef],  # (1)
) -> ClusterParameterGroupNameMessageTypeDef:  # (2)
    ...
  1. See ParameterTypeDef
  2. See ClusterParameterGroupNameMessageTypeDef
Usage example with kwargs
kwargs: ModifyClusterParameterGroupMessageRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
    "Parameters": ...,
}

parent.modify_cluster_parameter_group(**kwargs)
  1. See ModifyClusterParameterGroupMessageRequestTypeDef

modify_cluster_snapshot

Modifies the settings for a snapshot.

Type annotations and code completion for boto3.client("redshift").modify_cluster_snapshot method. boto3 documentation

Method definition
def modify_cluster_snapshot(
    self,
    *,
    SnapshotIdentifier: str,
    ManualSnapshotRetentionPeriod: int = ...,
    Force: bool = ...,
) -> ModifyClusterSnapshotResultTypeDef:  # (1)
    ...
  1. See ModifyClusterSnapshotResultTypeDef
Usage example with kwargs
kwargs: ModifyClusterSnapshotMessageRequestTypeDef = {  # (1)
    "SnapshotIdentifier": ...,
}

parent.modify_cluster_snapshot(**kwargs)
  1. See ModifyClusterSnapshotMessageRequestTypeDef

modify_cluster_snapshot_schedule

Modifies a snapshot schedule for a cluster.

Type annotations and code completion for boto3.client("redshift").modify_cluster_snapshot_schedule method. boto3 documentation

Method definition
def modify_cluster_snapshot_schedule(
    self,
    *,
    ClusterIdentifier: str,
    ScheduleIdentifier: str = ...,
    DisassociateSchedule: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: ModifyClusterSnapshotScheduleMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.modify_cluster_snapshot_schedule(**kwargs)
  1. See ModifyClusterSnapshotScheduleMessageRequestTypeDef

modify_cluster_subnet_group

Modifies a cluster subnet group to include the specified list of VPC subnets.

Type annotations and code completion for boto3.client("redshift").modify_cluster_subnet_group method. boto3 documentation

Method definition
def modify_cluster_subnet_group(
    self,
    *,
    ClusterSubnetGroupName: str,
    SubnetIds: Sequence[str],
    Description: str = ...,
) -> ModifyClusterSubnetGroupResultTypeDef:  # (1)
    ...
  1. See ModifyClusterSubnetGroupResultTypeDef
Usage example with kwargs
kwargs: ModifyClusterSubnetGroupMessageRequestTypeDef = {  # (1)
    "ClusterSubnetGroupName": ...,
    "SubnetIds": ...,
}

parent.modify_cluster_subnet_group(**kwargs)
  1. See ModifyClusterSubnetGroupMessageRequestTypeDef

modify_endpoint_access

Modifies a Redshift-managed VPC endpoint.

Type annotations and code completion for boto3.client("redshift").modify_endpoint_access method. boto3 documentation

Method definition
def modify_endpoint_access(
    self,
    *,
    EndpointName: str,
    VpcSecurityGroupIds: Sequence[str] = ...,
) -> EndpointAccessResponseMetadataTypeDef:  # (1)
    ...
  1. See EndpointAccessResponseMetadataTypeDef
Usage example with kwargs
kwargs: ModifyEndpointAccessMessageRequestTypeDef = {  # (1)
    "EndpointName": ...,
}

parent.modify_endpoint_access(**kwargs)
  1. See ModifyEndpointAccessMessageRequestTypeDef

modify_event_subscription

Modifies an existing Amazon Redshift event notification subscription.

Type annotations and code completion for boto3.client("redshift").modify_event_subscription method. boto3 documentation

Method definition
def modify_event_subscription(
    self,
    *,
    SubscriptionName: str,
    SnsTopicArn: str = ...,
    SourceType: str = ...,
    SourceIds: Sequence[str] = ...,
    EventCategories: Sequence[str] = ...,
    Severity: str = ...,
    Enabled: bool = ...,
) -> ModifyEventSubscriptionResultTypeDef:  # (1)
    ...
  1. See ModifyEventSubscriptionResultTypeDef
Usage example with kwargs
kwargs: ModifyEventSubscriptionMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
}

parent.modify_event_subscription(**kwargs)
  1. See ModifyEventSubscriptionMessageRequestTypeDef

modify_scheduled_action

Modifies a scheduled action.

Type annotations and code completion for boto3.client("redshift").modify_scheduled_action method. boto3 documentation

Method definition
def modify_scheduled_action(
    self,
    *,
    ScheduledActionName: str,
    TargetAction: ScheduledActionTypeTypeDef = ...,  # (1)
    Schedule: str = ...,
    IamRole: str = ...,
    ScheduledActionDescription: str = ...,
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    Enable: bool = ...,
) -> ScheduledActionResponseMetadataTypeDef:  # (2)
    ...
  1. See ScheduledActionTypeTypeDef
  2. See ScheduledActionResponseMetadataTypeDef
Usage example with kwargs
kwargs: ModifyScheduledActionMessageRequestTypeDef = {  # (1)
    "ScheduledActionName": ...,
}

parent.modify_scheduled_action(**kwargs)
  1. See ModifyScheduledActionMessageRequestTypeDef

modify_snapshot_copy_retention_period

Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.

Type annotations and code completion for boto3.client("redshift").modify_snapshot_copy_retention_period method. boto3 documentation

Method definition
def modify_snapshot_copy_retention_period(
    self,
    *,
    ClusterIdentifier: str,
    RetentionPeriod: int,
    Manual: bool = ...,
) -> ModifySnapshotCopyRetentionPeriodResultTypeDef:  # (1)
    ...
  1. See ModifySnapshotCopyRetentionPeriodResultTypeDef
Usage example with kwargs
kwargs: ModifySnapshotCopyRetentionPeriodMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
    "RetentionPeriod": ...,
}

parent.modify_snapshot_copy_retention_period(**kwargs)
  1. See ModifySnapshotCopyRetentionPeriodMessageRequestTypeDef

modify_snapshot_schedule

Modifies a snapshot schedule.

Type annotations and code completion for boto3.client("redshift").modify_snapshot_schedule method. boto3 documentation

Method definition
def modify_snapshot_schedule(
    self,
    *,
    ScheduleIdentifier: str,
    ScheduleDefinitions: Sequence[str],
) -> SnapshotScheduleResponseMetadataTypeDef:  # (1)
    ...
  1. See SnapshotScheduleResponseMetadataTypeDef
Usage example with kwargs
kwargs: ModifySnapshotScheduleMessageRequestTypeDef = {  # (1)
    "ScheduleIdentifier": ...,
    "ScheduleDefinitions": ...,
}

parent.modify_snapshot_schedule(**kwargs)
  1. See ModifySnapshotScheduleMessageRequestTypeDef

modify_usage_limit

Modifies a usage limit in a cluster.

Type annotations and code completion for boto3.client("redshift").modify_usage_limit method. boto3 documentation

Method definition
def modify_usage_limit(
    self,
    *,
    UsageLimitId: str,
    Amount: int = ...,
    BreachAction: UsageLimitBreachActionType = ...,  # (1)
) -> UsageLimitResponseMetadataTypeDef:  # (2)
    ...
  1. See UsageLimitBreachActionType
  2. See UsageLimitResponseMetadataTypeDef
Usage example with kwargs
kwargs: ModifyUsageLimitMessageRequestTypeDef = {  # (1)
    "UsageLimitId": ...,
}

parent.modify_usage_limit(**kwargs)
  1. See ModifyUsageLimitMessageRequestTypeDef

pause_cluster

Pauses a cluster.

Type annotations and code completion for boto3.client("redshift").pause_cluster method. boto3 documentation

Method definition
def pause_cluster(
    self,
    *,
    ClusterIdentifier: str,
) -> PauseClusterResultTypeDef:  # (1)
    ...
  1. See PauseClusterResultTypeDef
Usage example with kwargs
kwargs: PauseClusterMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.pause_cluster(**kwargs)
  1. See PauseClusterMessageRequestTypeDef

purchase_reserved_node_offering

Allows you to purchase reserved nodes.

Type annotations and code completion for boto3.client("redshift").purchase_reserved_node_offering method. boto3 documentation

Method definition
def purchase_reserved_node_offering(
    self,
    *,
    ReservedNodeOfferingId: str,
    NodeCount: int = ...,
) -> PurchaseReservedNodeOfferingResultTypeDef:  # (1)
    ...
  1. See PurchaseReservedNodeOfferingResultTypeDef
Usage example with kwargs
kwargs: PurchaseReservedNodeOfferingMessageRequestTypeDef = {  # (1)
    "ReservedNodeOfferingId": ...,
}

parent.purchase_reserved_node_offering(**kwargs)
  1. See PurchaseReservedNodeOfferingMessageRequestTypeDef

reboot_cluster

Reboots a cluster.

Type annotations and code completion for boto3.client("redshift").reboot_cluster method. boto3 documentation

Method definition
def reboot_cluster(
    self,
    *,
    ClusterIdentifier: str,
) -> RebootClusterResultTypeDef:  # (1)
    ...
  1. See RebootClusterResultTypeDef
Usage example with kwargs
kwargs: RebootClusterMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.reboot_cluster(**kwargs)
  1. See RebootClusterMessageRequestTypeDef

reject_data_share

From a datashare consumer account, rejects the specified datashare.

Type annotations and code completion for boto3.client("redshift").reject_data_share method. boto3 documentation

Method definition
def reject_data_share(
    self,
    *,
    DataShareArn: str,
) -> DataShareResponseMetadataTypeDef:  # (1)
    ...
  1. See DataShareResponseMetadataTypeDef
Usage example with kwargs
kwargs: RejectDataShareMessageRequestTypeDef = {  # (1)
    "DataShareArn": ...,
}

parent.reject_data_share(**kwargs)
  1. See RejectDataShareMessageRequestTypeDef

reset_cluster_parameter_group

Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default".

Type annotations and code completion for boto3.client("redshift").reset_cluster_parameter_group method. boto3 documentation

Method definition
def reset_cluster_parameter_group(
    self,
    *,
    ParameterGroupName: str,
    ResetAllParameters: bool = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
) -> ClusterParameterGroupNameMessageTypeDef:  # (2)
    ...
  1. See ParameterTypeDef
  2. See ClusterParameterGroupNameMessageTypeDef
Usage example with kwargs
kwargs: ResetClusterParameterGroupMessageRequestTypeDef = {  # (1)
    "ParameterGroupName": ...,
}

parent.reset_cluster_parameter_group(**kwargs)
  1. See ResetClusterParameterGroupMessageRequestTypeDef

resize_cluster

Changes the size of the cluster.

Type annotations and code completion for boto3.client("redshift").resize_cluster method. boto3 documentation

Method definition
def resize_cluster(
    self,
    *,
    ClusterIdentifier: str,
    ClusterType: str = ...,
    NodeType: str = ...,
    NumberOfNodes: int = ...,
    Classic: bool = ...,
    ReservedNodeId: str = ...,
    TargetReservedNodeOfferingId: str = ...,
) -> ResizeClusterResultTypeDef:  # (1)
    ...
  1. See ResizeClusterResultTypeDef
Usage example with kwargs
kwargs: ResizeClusterMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.resize_cluster(**kwargs)
  1. See ResizeClusterMessageRequestTypeDef

restore_from_cluster_snapshot

Creates a new cluster from a snapshot.

Type annotations and code completion for boto3.client("redshift").restore_from_cluster_snapshot method. boto3 documentation

Method definition
def restore_from_cluster_snapshot(
    self,
    *,
    ClusterIdentifier: str,
    SnapshotIdentifier: str = ...,
    SnapshotArn: str = ...,
    SnapshotClusterIdentifier: str = ...,
    Port: int = ...,
    AvailabilityZone: str = ...,
    AllowVersionUpgrade: bool = ...,
    ClusterSubnetGroupName: str = ...,
    PubliclyAccessible: bool = ...,
    OwnerAccount: str = ...,
    HsmClientCertificateIdentifier: str = ...,
    HsmConfigurationIdentifier: str = ...,
    ElasticIp: str = ...,
    ClusterParameterGroupName: str = ...,
    ClusterSecurityGroups: Sequence[str] = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    PreferredMaintenanceWindow: str = ...,
    AutomatedSnapshotRetentionPeriod: int = ...,
    ManualSnapshotRetentionPeriod: int = ...,
    KmsKeyId: str = ...,
    NodeType: str = ...,
    EnhancedVpcRouting: bool = ...,
    AdditionalInfo: str = ...,
    IamRoles: Sequence[str] = ...,
    MaintenanceTrackName: str = ...,
    SnapshotScheduleIdentifier: str = ...,
    NumberOfNodes: int = ...,
    AvailabilityZoneRelocation: bool = ...,
    AquaConfigurationStatus: AquaConfigurationStatusType = ...,  # (1)
    DefaultIamRoleArn: str = ...,
    ReservedNodeId: str = ...,
    TargetReservedNodeOfferingId: str = ...,
    Encrypted: bool = ...,
) -> RestoreFromClusterSnapshotResultTypeDef:  # (2)
    ...
  1. See AquaConfigurationStatusType
  2. See RestoreFromClusterSnapshotResultTypeDef
Usage example with kwargs
kwargs: RestoreFromClusterSnapshotMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.restore_from_cluster_snapshot(**kwargs)
  1. See RestoreFromClusterSnapshotMessageRequestTypeDef

restore_table_from_cluster_snapshot

Creates a new table from a table in an Amazon Redshift cluster snapshot.

Type annotations and code completion for boto3.client("redshift").restore_table_from_cluster_snapshot method. boto3 documentation

Method definition
def restore_table_from_cluster_snapshot(
    self,
    *,
    ClusterIdentifier: str,
    SnapshotIdentifier: str,
    SourceDatabaseName: str,
    SourceTableName: str,
    NewTableName: str,
    SourceSchemaName: str = ...,
    TargetDatabaseName: str = ...,
    TargetSchemaName: str = ...,
    EnableCaseSensitiveIdentifier: bool = ...,
) -> RestoreTableFromClusterSnapshotResultTypeDef:  # (1)
    ...
  1. See RestoreTableFromClusterSnapshotResultTypeDef
Usage example with kwargs
kwargs: RestoreTableFromClusterSnapshotMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
    "SnapshotIdentifier": ...,
    "SourceDatabaseName": ...,
    "SourceTableName": ...,
    "NewTableName": ...,
}

parent.restore_table_from_cluster_snapshot(**kwargs)
  1. See RestoreTableFromClusterSnapshotMessageRequestTypeDef

resume_cluster

Resumes a paused cluster.

Type annotations and code completion for boto3.client("redshift").resume_cluster method. boto3 documentation

Method definition
def resume_cluster(
    self,
    *,
    ClusterIdentifier: str,
) -> ResumeClusterResultTypeDef:  # (1)
    ...
  1. See ResumeClusterResultTypeDef
Usage example with kwargs
kwargs: ResumeClusterMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.resume_cluster(**kwargs)
  1. See ResumeClusterMessageRequestTypeDef

revoke_cluster_security_group_ingress

Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group.

Type annotations and code completion for boto3.client("redshift").revoke_cluster_security_group_ingress method. boto3 documentation

Method definition
def revoke_cluster_security_group_ingress(
    self,
    *,
    ClusterSecurityGroupName: str,
    CIDRIP: str = ...,
    EC2SecurityGroupName: str = ...,
    EC2SecurityGroupOwnerId: str = ...,
) -> RevokeClusterSecurityGroupIngressResultTypeDef:  # (1)
    ...
  1. See RevokeClusterSecurityGroupIngressResultTypeDef
Usage example with kwargs
kwargs: RevokeClusterSecurityGroupIngressMessageRequestTypeDef = {  # (1)
    "ClusterSecurityGroupName": ...,
}

parent.revoke_cluster_security_group_ingress(**kwargs)
  1. See RevokeClusterSecurityGroupIngressMessageRequestTypeDef

revoke_endpoint_access

Revokes access to a cluster.

Type annotations and code completion for boto3.client("redshift").revoke_endpoint_access method. boto3 documentation

Method definition
def revoke_endpoint_access(
    self,
    *,
    ClusterIdentifier: str = ...,
    Account: str = ...,
    VpcIds: Sequence[str] = ...,
    Force: bool = ...,
) -> EndpointAuthorizationResponseMetadataTypeDef:  # (1)
    ...
  1. See EndpointAuthorizationResponseMetadataTypeDef
Usage example with kwargs
kwargs: RevokeEndpointAccessMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.revoke_endpoint_access(**kwargs)
  1. See RevokeEndpointAccessMessageRequestTypeDef

revoke_snapshot_access

Removes the ability of the specified Amazon Web Services account to restore the specified snapshot.

Type annotations and code completion for boto3.client("redshift").revoke_snapshot_access method. boto3 documentation

Method definition
def revoke_snapshot_access(
    self,
    *,
    AccountWithRestoreAccess: str,
    SnapshotIdentifier: str = ...,
    SnapshotArn: str = ...,
    SnapshotClusterIdentifier: str = ...,
) -> RevokeSnapshotAccessResultTypeDef:  # (1)
    ...
  1. See RevokeSnapshotAccessResultTypeDef
Usage example with kwargs
kwargs: RevokeSnapshotAccessMessageRequestTypeDef = {  # (1)
    "AccountWithRestoreAccess": ...,
}

parent.revoke_snapshot_access(**kwargs)
  1. See RevokeSnapshotAccessMessageRequestTypeDef

rotate_encryption_key

Rotates the encryption keys for a cluster.

Type annotations and code completion for boto3.client("redshift").rotate_encryption_key method. boto3 documentation

Method definition
def rotate_encryption_key(
    self,
    *,
    ClusterIdentifier: str,
) -> RotateEncryptionKeyResultTypeDef:  # (1)
    ...
  1. See RotateEncryptionKeyResultTypeDef
Usage example with kwargs
kwargs: RotateEncryptionKeyMessageRequestTypeDef = {  # (1)
    "ClusterIdentifier": ...,
}

parent.rotate_encryption_key(**kwargs)
  1. See RotateEncryptionKeyMessageRequestTypeDef

update_partner_status

Updates the status of a partner integration.

Type annotations and code completion for boto3.client("redshift").update_partner_status method. boto3 documentation

Method definition
def update_partner_status(
    self,
    *,
    AccountId: str,
    ClusterIdentifier: str,
    DatabaseName: str,
    PartnerName: str,
    Status: PartnerIntegrationStatusType,  # (1)
    StatusMessage: str = ...,
) -> PartnerIntegrationOutputMessageTypeDef:  # (2)
    ...
  1. See PartnerIntegrationStatusType
  2. See PartnerIntegrationOutputMessageTypeDef
Usage example with kwargs
kwargs: UpdatePartnerStatusInputMessageRequestTypeDef = {  # (1)
    "AccountId": ...,
    "ClusterIdentifier": ...,
    "DatabaseName": ...,
    "PartnerName": ...,
    "Status": ...,
}

parent.update_partner_status(**kwargs)
  1. See UpdatePartnerStatusInputMessageRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("redshift").get_paginator method with overloads.

get_waiter

Type annotations and code completion for boto3.client("redshift").get_waiter method with overloads.