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
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.
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)
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
def accept_reserved_node_exchange(
self,
*,
ReservedNodeId: str,
TargetReservedNodeOfferingId: str,
) -> AcceptReservedNodeExchangeOutputMessageTypeDef: # (1)
...
kwargs: AcceptReservedNodeExchangeInputMessageRequestTypeDef = { # (1)
"ReservedNodeId": ...,
"TargetReservedNodeOfferingId": ...,
}
parent.accept_reserved_node_exchange(**kwargs)
add_partner
Adds a partner integration to a cluster.
Type annotations and code completion for boto3.client("redshift").add_partner
method.
boto3 documentation
def add_partner(
self,
*,
AccountId: str,
ClusterIdentifier: str,
DatabaseName: str,
PartnerName: str,
) -> PartnerIntegrationOutputMessageTypeDef: # (1)
...
kwargs: PartnerIntegrationInputMessageRequestTypeDef = { # (1)
"AccountId": ...,
"ClusterIdentifier": ...,
"DatabaseName": ...,
"PartnerName": ...,
}
parent.add_partner(**kwargs)
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
def associate_data_share_consumer(
self,
*,
DataShareArn: str,
AssociateEntireAccount: bool = ...,
ConsumerArn: str = ...,
ConsumerRegion: str = ...,
) -> DataShareResponseMetadataTypeDef: # (1)
...
kwargs: AssociateDataShareConsumerMessageRequestTypeDef = { # (1)
"DataShareArn": ...,
}
parent.associate_data_share_consumer(**kwargs)
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
def authorize_cluster_security_group_ingress(
self,
*,
ClusterSecurityGroupName: str,
CIDRIP: str = ...,
EC2SecurityGroupName: str = ...,
EC2SecurityGroupOwnerId: str = ...,
) -> AuthorizeClusterSecurityGroupIngressResultTypeDef: # (1)
...
kwargs: AuthorizeClusterSecurityGroupIngressMessageRequestTypeDef = { # (1)
"ClusterSecurityGroupName": ...,
}
parent.authorize_cluster_security_group_ingress(**kwargs)
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
def authorize_data_share(
self,
*,
DataShareArn: str,
ConsumerIdentifier: str,
) -> DataShareResponseMetadataTypeDef: # (1)
...
kwargs: AuthorizeDataShareMessageRequestTypeDef = { # (1)
"DataShareArn": ...,
"ConsumerIdentifier": ...,
}
parent.authorize_data_share(**kwargs)
authorize_endpoint_access
Grants access to a cluster.
Type annotations and code completion for boto3.client("redshift").authorize_endpoint_access
method.
boto3 documentation
def authorize_endpoint_access(
self,
*,
Account: str,
ClusterIdentifier: str = ...,
VpcIds: Sequence[str] = ...,
) -> EndpointAuthorizationResponseMetadataTypeDef: # (1)
...
kwargs: AuthorizeEndpointAccessMessageRequestTypeDef = { # (1)
"Account": ...,
}
parent.authorize_endpoint_access(**kwargs)
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
def authorize_snapshot_access(
self,
*,
AccountWithRestoreAccess: str,
SnapshotIdentifier: str = ...,
SnapshotArn: str = ...,
SnapshotClusterIdentifier: str = ...,
) -> AuthorizeSnapshotAccessResultTypeDef: # (1)
...
kwargs: AuthorizeSnapshotAccessMessageRequestTypeDef = { # (1)
"AccountWithRestoreAccess": ...,
}
parent.authorize_snapshot_access(**kwargs)
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
def batch_delete_cluster_snapshots(
self,
*,
Identifiers: Sequence[DeleteClusterSnapshotMessageTypeDef], # (1)
) -> BatchDeleteClusterSnapshotsResultTypeDef: # (2)
...
kwargs: BatchDeleteClusterSnapshotsRequestRequestTypeDef = { # (1)
"Identifiers": ...,
}
parent.batch_delete_cluster_snapshots(**kwargs)
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
def batch_modify_cluster_snapshots(
self,
*,
SnapshotIdentifierList: Sequence[str],
ManualSnapshotRetentionPeriod: int = ...,
Force: bool = ...,
) -> BatchModifyClusterSnapshotsOutputMessageTypeDef: # (1)
...
kwargs: BatchModifyClusterSnapshotsMessageRequestTypeDef = { # (1)
"SnapshotIdentifierList": ...,
}
parent.batch_modify_cluster_snapshots(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("redshift").can_paginate
method.
boto3 documentation
cancel_resize
Cancels a resize operation for a cluster.
Type annotations and code completion for boto3.client("redshift").cancel_resize
method.
boto3 documentation
def cancel_resize(
self,
*,
ClusterIdentifier: str,
) -> ResizeProgressMessageTypeDef: # (1)
...
kwargs: CancelResizeMessageRequestTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.cancel_resize(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("redshift").close
method.
boto3 documentation
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
def copy_cluster_snapshot(
self,
*,
SourceSnapshotIdentifier: str,
TargetSnapshotIdentifier: str,
SourceSnapshotClusterIdentifier: str = ...,
ManualSnapshotRetentionPeriod: int = ...,
) -> CopyClusterSnapshotResultTypeDef: # (1)
...
kwargs: CopyClusterSnapshotMessageRequestTypeDef = { # (1)
"SourceSnapshotIdentifier": ...,
"TargetSnapshotIdentifier": ...,
}
parent.copy_cluster_snapshot(**kwargs)
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
def create_authentication_profile(
self,
*,
AuthenticationProfileName: str,
AuthenticationProfileContent: str,
) -> CreateAuthenticationProfileResultTypeDef: # (1)
...
kwargs: CreateAuthenticationProfileMessageRequestTypeDef = { # (1)
"AuthenticationProfileName": ...,
"AuthenticationProfileContent": ...,
}
parent.create_authentication_profile(**kwargs)
create_cluster
Creates a new cluster with the specified parameters.
Type annotations and code completion for boto3.client("redshift").create_cluster
method.
boto3 documentation
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)
...
kwargs: CreateClusterMessageRequestTypeDef = { # (1)
"ClusterIdentifier": ...,
"NodeType": ...,
"MasterUsername": ...,
"MasterUserPassword": ...,
}
parent.create_cluster(**kwargs)
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
def create_cluster_parameter_group(
self,
*,
ParameterGroupName: str,
ParameterGroupFamily: str,
Description: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateClusterParameterGroupResultTypeDef: # (2)
...
kwargs: CreateClusterParameterGroupMessageRequestTypeDef = { # (1)
"ParameterGroupName": ...,
"ParameterGroupFamily": ...,
"Description": ...,
}
parent.create_cluster_parameter_group(**kwargs)
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
def create_cluster_security_group(
self,
*,
ClusterSecurityGroupName: str,
Description: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateClusterSecurityGroupResultTypeDef: # (2)
...
kwargs: CreateClusterSecurityGroupMessageRequestTypeDef = { # (1)
"ClusterSecurityGroupName": ...,
"Description": ...,
}
parent.create_cluster_security_group(**kwargs)
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
def create_cluster_snapshot(
self,
*,
SnapshotIdentifier: str,
ClusterIdentifier: str,
ManualSnapshotRetentionPeriod: int = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateClusterSnapshotResultTypeDef: # (2)
...
kwargs: CreateClusterSnapshotMessageRequestTypeDef = { # (1)
"SnapshotIdentifier": ...,
"ClusterIdentifier": ...,
}
parent.create_cluster_snapshot(**kwargs)
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
def create_cluster_subnet_group(
self,
*,
ClusterSubnetGroupName: str,
Description: str,
SubnetIds: Sequence[str],
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateClusterSubnetGroupResultTypeDef: # (2)
...
kwargs: CreateClusterSubnetGroupMessageRequestTypeDef = { # (1)
"ClusterSubnetGroupName": ...,
"Description": ...,
"SubnetIds": ...,
}
parent.create_cluster_subnet_group(**kwargs)
create_endpoint_access
Creates a Redshift-managed VPC endpoint.
Type annotations and code completion for boto3.client("redshift").create_endpoint_access
method.
boto3 documentation
def create_endpoint_access(
self,
*,
EndpointName: str,
SubnetGroupName: str,
ClusterIdentifier: str = ...,
ResourceOwner: str = ...,
VpcSecurityGroupIds: Sequence[str] = ...,
) -> EndpointAccessResponseMetadataTypeDef: # (1)
...
kwargs: CreateEndpointAccessMessageRequestTypeDef = { # (1)
"EndpointName": ...,
"SubnetGroupName": ...,
}
parent.create_endpoint_access(**kwargs)
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
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)
...
kwargs: CreateEventSubscriptionMessageRequestTypeDef = { # (1)
"SubscriptionName": ...,
"SnsTopicArn": ...,
}
parent.create_event_subscription(**kwargs)
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
def create_hsm_client_certificate(
self,
*,
HsmClientCertificateIdentifier: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateHsmClientCertificateResultTypeDef: # (2)
...
kwargs: CreateHsmClientCertificateMessageRequestTypeDef = { # (1)
"HsmClientCertificateIdentifier": ...,
}
parent.create_hsm_client_certificate(**kwargs)
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
def create_hsm_configuration(
self,
*,
HsmConfigurationIdentifier: str,
Description: str,
HsmIpAddress: str,
HsmPartitionName: str,
HsmPartitionPassword: str,
HsmServerPublicCertificate: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateHsmConfigurationResultTypeDef: # (2)
...
kwargs: CreateHsmConfigurationMessageRequestTypeDef = { # (1)
"HsmConfigurationIdentifier": ...,
"Description": ...,
"HsmIpAddress": ...,
"HsmPartitionName": ...,
"HsmPartitionPassword": ...,
"HsmServerPublicCertificate": ...,
}
parent.create_hsm_configuration(**kwargs)
create_scheduled_action
Creates a scheduled action.
Type annotations and code completion for boto3.client("redshift").create_scheduled_action
method.
boto3 documentation
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)
...
kwargs: CreateScheduledActionMessageRequestTypeDef = { # (1)
"ScheduledActionName": ...,
"TargetAction": ...,
"Schedule": ...,
"IamRole": ...,
}
parent.create_scheduled_action(**kwargs)
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
def create_snapshot_copy_grant(
self,
*,
SnapshotCopyGrantName: str,
KmsKeyId: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateSnapshotCopyGrantResultTypeDef: # (2)
...
kwargs: CreateSnapshotCopyGrantMessageRequestTypeDef = { # (1)
"SnapshotCopyGrantName": ...,
}
parent.create_snapshot_copy_grant(**kwargs)
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
def create_snapshot_schedule(
self,
*,
ScheduleDefinitions: Sequence[str] = ...,
ScheduleIdentifier: str = ...,
ScheduleDescription: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
DryRun: bool = ...,
NextInvocations: int = ...,
) -> SnapshotScheduleResponseMetadataTypeDef: # (2)
...
kwargs: CreateSnapshotScheduleMessageRequestTypeDef = { # (1)
"ScheduleDefinitions": ...,
}
parent.create_snapshot_schedule(**kwargs)
create_tags
Adds tags to a cluster.
Type annotations and code completion for boto3.client("redshift").create_tags
method.
boto3 documentation
def create_tags(
self,
*,
ResourceName: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: CreateTagsMessageRequestTypeDef = { # (1)
"ResourceName": ...,
"Tags": ...,
}
parent.create_tags(**kwargs)
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
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)
...
- See UsageLimitFeatureTypeType
- See UsageLimitLimitTypeType
- See UsageLimitPeriodType
- See UsageLimitBreachActionType
- See TagTypeDef
- See UsageLimitResponseMetadataTypeDef
kwargs: CreateUsageLimitMessageRequestTypeDef = { # (1)
"ClusterIdentifier": ...,
"FeatureType": ...,
"LimitType": ...,
"Amount": ...,
}
parent.create_usage_limit(**kwargs)
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
def deauthorize_data_share(
self,
*,
DataShareArn: str,
ConsumerIdentifier: str,
) -> DataShareResponseMetadataTypeDef: # (1)
...
kwargs: DeauthorizeDataShareMessageRequestTypeDef = { # (1)
"DataShareArn": ...,
"ConsumerIdentifier": ...,
}
parent.deauthorize_data_share(**kwargs)
delete_authentication_profile
Deletes an authentication profile.
Type annotations and code completion for boto3.client("redshift").delete_authentication_profile
method.
boto3 documentation
def delete_authentication_profile(
self,
*,
AuthenticationProfileName: str,
) -> DeleteAuthenticationProfileResultTypeDef: # (1)
...
kwargs: DeleteAuthenticationProfileMessageRequestTypeDef = { # (1)
"AuthenticationProfileName": ...,
}
parent.delete_authentication_profile(**kwargs)
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
def delete_cluster(
self,
*,
ClusterIdentifier: str,
SkipFinalClusterSnapshot: bool = ...,
FinalClusterSnapshotIdentifier: str = ...,
FinalClusterSnapshotRetentionPeriod: int = ...,
) -> DeleteClusterResultTypeDef: # (1)
...
kwargs: DeleteClusterMessageRequestTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.delete_cluster(**kwargs)
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
def delete_cluster_parameter_group(
self,
*,
ParameterGroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteClusterParameterGroupMessageRequestTypeDef = { # (1)
"ParameterGroupName": ...,
}
parent.delete_cluster_parameter_group(**kwargs)
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
def delete_cluster_security_group(
self,
*,
ClusterSecurityGroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteClusterSecurityGroupMessageRequestTypeDef = { # (1)
"ClusterSecurityGroupName": ...,
}
parent.delete_cluster_security_group(**kwargs)
delete_cluster_snapshot
Deletes the specified manual snapshot.
Type annotations and code completion for boto3.client("redshift").delete_cluster_snapshot
method.
boto3 documentation
def delete_cluster_snapshot(
self,
*,
SnapshotIdentifier: str,
SnapshotClusterIdentifier: str = ...,
) -> DeleteClusterSnapshotResultTypeDef: # (1)
...
kwargs: DeleteClusterSnapshotMessageRequestTypeDef = { # (1)
"SnapshotIdentifier": ...,
}
parent.delete_cluster_snapshot(**kwargs)
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
def delete_cluster_subnet_group(
self,
*,
ClusterSubnetGroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteClusterSubnetGroupMessageRequestTypeDef = { # (1)
"ClusterSubnetGroupName": ...,
}
parent.delete_cluster_subnet_group(**kwargs)
delete_endpoint_access
Deletes a Redshift-managed VPC endpoint.
Type annotations and code completion for boto3.client("redshift").delete_endpoint_access
method.
boto3 documentation
def delete_endpoint_access(
self,
*,
EndpointName: str,
) -> EndpointAccessResponseMetadataTypeDef: # (1)
...
kwargs: DeleteEndpointAccessMessageRequestTypeDef = { # (1)
"EndpointName": ...,
}
parent.delete_endpoint_access(**kwargs)
delete_event_subscription
Deletes an Amazon Redshift event notification subscription.
Type annotations and code completion for boto3.client("redshift").delete_event_subscription
method.