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
# RedshiftClient 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.
# Exceptions.exceptions usage example
client = boto3.client("redshift")
try:
do_something(client)
except (
client.exceptions.AccessToClusterDeniedFault,
client.exceptions.AccessToSnapshotDeniedFault,
client.exceptions.AuthenticationProfileAlreadyExistsFault,
client.exceptions.AuthenticationProfileNotFoundFault,
client.exceptions.AuthenticationProfileQuotaExceededFault,
client.exceptions.AuthorizationAlreadyExistsFault,
client.exceptions.AuthorizationNotFoundFault,
client.exceptions.AuthorizationQuotaExceededFault,
client.exceptions.BatchDeleteRequestSizeExceededFault,
client.exceptions.BatchModifyClusterSnapshotsLimitExceededFault,
client.exceptions.BucketNotFoundFault,
client.exceptions.ClientError,
client.exceptions.ClusterAlreadyExistsFault,
client.exceptions.ClusterNotFoundFault,
client.exceptions.ClusterOnLatestRevisionFault,
client.exceptions.ClusterParameterGroupAlreadyExistsFault,
client.exceptions.ClusterParameterGroupNotFoundFault,
client.exceptions.ClusterParameterGroupQuotaExceededFault,
client.exceptions.ClusterQuotaExceededFault,
client.exceptions.ClusterSecurityGroupAlreadyExistsFault,
client.exceptions.ClusterSecurityGroupNotFoundFault,
client.exceptions.ClusterSecurityGroupQuotaExceededFault,
client.exceptions.ClusterSnapshotAlreadyExistsFault,
client.exceptions.ClusterSnapshotNotFoundFault,
client.exceptions.ClusterSnapshotQuotaExceededFault,
client.exceptions.ClusterSubnetGroupAlreadyExistsFault,
client.exceptions.ClusterSubnetGroupNotFoundFault,
client.exceptions.ClusterSubnetGroupQuotaExceededFault,
client.exceptions.ClusterSubnetQuotaExceededFault,
client.exceptions.ConflictPolicyUpdateFault,
client.exceptions.CopyToRegionDisabledFault,
client.exceptions.CustomCnameAssociationFault,
client.exceptions.CustomDomainAssociationNotFoundFault,
client.exceptions.DependentServiceAccessDeniedFault,
client.exceptions.DependentServiceRequestThrottlingFault,
client.exceptions.DependentServiceUnavailableFault,
client.exceptions.EndpointAlreadyExistsFault,
client.exceptions.EndpointAuthorizationAlreadyExistsFault,
client.exceptions.EndpointAuthorizationNotFoundFault,
client.exceptions.EndpointAuthorizationsPerClusterLimitExceededFault,
client.exceptions.EndpointNotFoundFault,
client.exceptions.EndpointsPerAuthorizationLimitExceededFault,
client.exceptions.EndpointsPerClusterLimitExceededFault,
client.exceptions.EventSubscriptionQuotaExceededFault,
client.exceptions.HsmClientCertificateAlreadyExistsFault,
client.exceptions.HsmClientCertificateNotFoundFault,
client.exceptions.HsmClientCertificateQuotaExceededFault,
client.exceptions.HsmConfigurationAlreadyExistsFault,
client.exceptions.HsmConfigurationNotFoundFault,
client.exceptions.HsmConfigurationQuotaExceededFault,
client.exceptions.InProgressTableRestoreQuotaExceededFault,
client.exceptions.IncompatibleOrderableOptions,
client.exceptions.InsufficientClusterCapacityFault,
client.exceptions.InsufficientS3BucketPolicyFault,
client.exceptions.IntegrationAlreadyExistsFault,
client.exceptions.IntegrationConflictOperationFault,
client.exceptions.IntegrationConflictStateFault,
client.exceptions.IntegrationNotFoundFault,
client.exceptions.IntegrationQuotaExceededFault,
client.exceptions.IntegrationSourceNotFoundFault,
client.exceptions.IntegrationTargetNotFoundFault,
client.exceptions.InvalidAuthenticationProfileRequestFault,
client.exceptions.InvalidAuthorizationStateFault,
client.exceptions.InvalidClusterParameterGroupStateFault,
client.exceptions.InvalidClusterSecurityGroupStateFault,
client.exceptions.InvalidClusterSnapshotScheduleStateFault,
client.exceptions.InvalidClusterSnapshotStateFault,
client.exceptions.InvalidClusterStateFault,
client.exceptions.InvalidClusterSubnetGroupStateFault,
client.exceptions.InvalidClusterSubnetStateFault,
client.exceptions.InvalidClusterTrackFault,
client.exceptions.InvalidDataShareFault,
client.exceptions.InvalidElasticIpFault,
client.exceptions.InvalidEndpointStateFault,
client.exceptions.InvalidHsmClientCertificateStateFault,
client.exceptions.InvalidHsmConfigurationStateFault,
client.exceptions.InvalidNamespaceFault,
client.exceptions.InvalidPolicyFault,
client.exceptions.InvalidReservedNodeStateFault,
client.exceptions.InvalidRestoreFault,
client.exceptions.InvalidRetentionPeriodFault,
client.exceptions.InvalidS3BucketNameFault,
client.exceptions.InvalidS3KeyPrefixFault,
client.exceptions.InvalidScheduleFault,
client.exceptions.InvalidScheduledActionFault,
client.exceptions.InvalidSnapshotCopyGrantStateFault,
client.exceptions.InvalidSubnet,
client.exceptions.InvalidSubscriptionStateFault,
client.exceptions.InvalidTableRestoreArgumentFault,
client.exceptions.InvalidTagFault,
client.exceptions.InvalidUsageLimitFault,
client.exceptions.InvalidVPCNetworkStateFault,
client.exceptions.Ipv6CidrBlockNotFoundFault,
client.exceptions.LimitExceededFault,
client.exceptions.NumberOfNodesPerClusterLimitExceededFault,
client.exceptions.NumberOfNodesQuotaExceededFault,
client.exceptions.PartnerNotFoundFault,
client.exceptions.RedshiftIdcApplicationAlreadyExistsFault,
client.exceptions.RedshiftIdcApplicationNotExistsFault,
client.exceptions.RedshiftIdcApplicationQuotaExceededFault,
client.exceptions.ReservedNodeAlreadyExistsFault,
client.exceptions.ReservedNodeAlreadyMigratedFault,
client.exceptions.ReservedNodeExchangeNotFoundFault,
client.exceptions.ReservedNodeNotFoundFault,
client.exceptions.ReservedNodeOfferingNotFoundFault,
client.exceptions.ReservedNodeQuotaExceededFault,
client.exceptions.ResizeNotFoundFault,
client.exceptions.ResourceNotFoundFault,
client.exceptions.SNSInvalidTopicFault,
client.exceptions.SNSNoAuthorizationFault,
client.exceptions.SNSTopicArnNotFoundFault,
client.exceptions.ScheduleDefinitionTypeUnsupportedFault,
client.exceptions.ScheduledActionAlreadyExistsFault,
client.exceptions.ScheduledActionNotFoundFault,
client.exceptions.ScheduledActionQuotaExceededFault,
client.exceptions.ScheduledActionTypeUnsupportedFault,
client.exceptions.SnapshotCopyAlreadyDisabledFault,
client.exceptions.SnapshotCopyAlreadyEnabledFault,
client.exceptions.SnapshotCopyDisabledFault,
client.exceptions.SnapshotCopyGrantAlreadyExistsFault,
client.exceptions.SnapshotCopyGrantNotFoundFault,
client.exceptions.SnapshotCopyGrantQuotaExceededFault,
client.exceptions.SnapshotScheduleAlreadyExistsFault,
client.exceptions.SnapshotScheduleNotFoundFault,
client.exceptions.SnapshotScheduleQuotaExceededFault,
client.exceptions.SnapshotScheduleUpdateInProgressFault,
client.exceptions.SourceNotFoundFault,
client.exceptions.SubnetAlreadyInUse,
client.exceptions.SubscriptionAlreadyExistFault,
client.exceptions.SubscriptionCategoryNotFoundFault,
client.exceptions.SubscriptionEventIdNotFoundFault,
client.exceptions.SubscriptionNotFoundFault,
client.exceptions.SubscriptionSeverityNotFoundFault,
client.exceptions.TableLimitExceededFault,
client.exceptions.TableRestoreNotFoundFault,
client.exceptions.TagLimitExceededFault,
client.exceptions.UnauthorizedOperation,
client.exceptions.UnauthorizedPartnerIntegrationFault,
client.exceptions.UnknownSnapshotCopyRegionFault,
client.exceptions.UnsupportedOperationFault,
client.exceptions.UnsupportedOptionFault,
client.exceptions.UsageLimitAlreadyExistsFault,
client.exceptions.UsageLimitNotFoundFault,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_redshift.client import Exceptions
def handle_error(exc: Exceptions.AccessToClusterDeniedFault) -> None:
...Methods#
can_paginate#
Type annotations and code completion for boto3.client("redshift").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...generate_presigned_url#
Type annotations and code completion for boto3.client("redshift").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...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
# accept_reserved_node_exchange method definition
def accept_reserved_node_exchange(
self,
*,
ReservedNodeId: str,
TargetReservedNodeOfferingId: str,
) -> AcceptReservedNodeExchangeOutputMessageTypeDef: # (1)
...# accept_reserved_node_exchange method usage example with argument unpacking
kwargs: AcceptReservedNodeExchangeInputMessageTypeDef = { # (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
# add_partner method definition
def add_partner(
self,
*,
AccountId: str,
ClusterIdentifier: str,
DatabaseName: str,
PartnerName: str,
) -> PartnerIntegrationOutputMessageTypeDef: # (1)
...# add_partner method usage example with argument unpacking
kwargs: PartnerIntegrationInputMessageTypeDef = { # (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
# associate_data_share_consumer method definition
def associate_data_share_consumer(
self,
*,
DataShareArn: str,
AssociateEntireAccount: bool = ...,
ConsumerArn: str = ...,
ConsumerRegion: str = ...,
AllowWrites: bool = ...,
) -> DataShareResponseTypeDef: # (1)
...# associate_data_share_consumer method usage example with argument unpacking
kwargs: AssociateDataShareConsumerMessageTypeDef = { # (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
# authorize_cluster_security_group_ingress method definition
def authorize_cluster_security_group_ingress(
self,
*,
ClusterSecurityGroupName: str,
CIDRIP: str = ...,
EC2SecurityGroupName: str = ...,
EC2SecurityGroupOwnerId: str = ...,
) -> AuthorizeClusterSecurityGroupIngressResultTypeDef: # (1)
...# authorize_cluster_security_group_ingress method usage example with argument unpacking
kwargs: AuthorizeClusterSecurityGroupIngressMessageTypeDef = { # (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
# authorize_data_share method definition
def authorize_data_share(
self,
*,
DataShareArn: str,
ConsumerIdentifier: str,
AllowWrites: bool = ...,
) -> DataShareResponseTypeDef: # (1)
...# authorize_data_share method usage example with argument unpacking
kwargs: AuthorizeDataShareMessageTypeDef = { # (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
# authorize_endpoint_access method definition
def authorize_endpoint_access(
self,
*,
Account: str,
ClusterIdentifier: str = ...,
VpcIds: Sequence[str] = ...,
) -> EndpointAuthorizationResponseTypeDef: # (1)
...# authorize_endpoint_access method usage example with argument unpacking
kwargs: AuthorizeEndpointAccessMessageTypeDef = { # (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
# authorize_snapshot_access method definition
def authorize_snapshot_access(
self,
*,
AccountWithRestoreAccess: str,
SnapshotIdentifier: str = ...,
SnapshotArn: str = ...,
SnapshotClusterIdentifier: str = ...,
) -> AuthorizeSnapshotAccessResultTypeDef: # (1)
...# authorize_snapshot_access method usage example with argument unpacking
kwargs: AuthorizeSnapshotAccessMessageTypeDef = { # (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
# batch_delete_cluster_snapshots method definition
def batch_delete_cluster_snapshots(
self,
*,
Identifiers: Sequence[DeleteClusterSnapshotMessageTypeDef], # (1)
) -> BatchDeleteClusterSnapshotsResultTypeDef: # (2)
...- See
Sequence[DeleteClusterSnapshotMessageTypeDef] - See BatchDeleteClusterSnapshotsResultTypeDef
# batch_delete_cluster_snapshots method usage example with argument unpacking
kwargs: BatchDeleteClusterSnapshotsRequestTypeDef = { # (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
# batch_modify_cluster_snapshots method definition
def batch_modify_cluster_snapshots(
self,
*,
SnapshotIdentifierList: Sequence[str],
ManualSnapshotRetentionPeriod: int = ...,
Force: bool = ...,
) -> BatchModifyClusterSnapshotsOutputMessageTypeDef: # (1)
...# batch_modify_cluster_snapshots method usage example with argument unpacking
kwargs: BatchModifyClusterSnapshotsMessageTypeDef = { # (1)
"SnapshotIdentifierList": ...,
}
parent.batch_modify_cluster_snapshots(**kwargs)cancel_resize#
Cancels a resize operation for a cluster.
Type annotations and code completion for boto3.client("redshift").cancel_resize method.
boto3 documentation
# cancel_resize method definition
def cancel_resize(
self,
*,
ClusterIdentifier: str,
) -> ResizeProgressMessageTypeDef: # (1)
...# cancel_resize method usage example with argument unpacking
kwargs: CancelResizeMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.cancel_resize(**kwargs)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
# copy_cluster_snapshot method definition
def copy_cluster_snapshot(
self,
*,
SourceSnapshotIdentifier: str,
TargetSnapshotIdentifier: str,
SourceSnapshotClusterIdentifier: str = ...,
ManualSnapshotRetentionPeriod: int = ...,
) -> CopyClusterSnapshotResultTypeDef: # (1)
...# copy_cluster_snapshot method usage example with argument unpacking
kwargs: CopyClusterSnapshotMessageTypeDef = { # (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
# create_authentication_profile method definition
def create_authentication_profile(
self,
*,
AuthenticationProfileName: str,
AuthenticationProfileContent: str,
) -> CreateAuthenticationProfileResultTypeDef: # (1)
...# create_authentication_profile method usage example with argument unpacking
kwargs: CreateAuthenticationProfileMessageTypeDef = { # (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
# create_cluster method definition
def create_cluster(
self,
*,
ClusterIdentifier: str,
NodeType: str,
MasterUsername: str,
DBName: str = ...,
ClusterType: str = ...,
MasterUserPassword: 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 = ...,
ManageMasterPassword: bool = ...,
MasterPasswordSecretKmsKeyId: str = ...,
IpAddressType: str = ...,
MultiAZ: bool = ...,
RedshiftIdcApplicationArn: str = ...,
) -> CreateClusterResultTypeDef: # (3)
...- See
Sequence[TagTypeDef] - See AquaConfigurationStatusType
- See CreateClusterResultTypeDef
# create_cluster method usage example with argument unpacking
kwargs: CreateClusterMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
"NodeType": ...,
"MasterUsername": ...,
}
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
# create_cluster_parameter_group method definition
def create_cluster_parameter_group(
self,
*,
ParameterGroupName: str,
ParameterGroupFamily: str,
Description: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateClusterParameterGroupResultTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See CreateClusterParameterGroupResultTypeDef
# create_cluster_parameter_group method usage example with argument unpacking
kwargs: CreateClusterParameterGroupMessageTypeDef = { # (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
# create_cluster_security_group method definition
def create_cluster_security_group(
self,
*,
ClusterSecurityGroupName: str,
Description: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateClusterSecurityGroupResultTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See CreateClusterSecurityGroupResultTypeDef
# create_cluster_security_group method usage example with argument unpacking
kwargs: CreateClusterSecurityGroupMessageTypeDef = { # (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
# create_cluster_snapshot method definition
def create_cluster_snapshot(
self,
*,
SnapshotIdentifier: str,
ClusterIdentifier: str,
ManualSnapshotRetentionPeriod: int = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateClusterSnapshotResultTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See CreateClusterSnapshotResultTypeDef
# create_cluster_snapshot method usage example with argument unpacking
kwargs: CreateClusterSnapshotMessageTypeDef = { # (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
# create_cluster_subnet_group method definition
def create_cluster_subnet_group(
self,
*,
ClusterSubnetGroupName: str,
Description: str,
SubnetIds: Sequence[str],
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateClusterSubnetGroupResultTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See CreateClusterSubnetGroupResultTypeDef
# create_cluster_subnet_group method usage example with argument unpacking
kwargs: CreateClusterSubnetGroupMessageTypeDef = { # (1)
"ClusterSubnetGroupName": ...,
"Description": ...,
"SubnetIds": ...,
}
parent.create_cluster_subnet_group(**kwargs)create_custom_domain_association#
Used to create a custom domain name for a cluster.
Type annotations and code completion for boto3.client("redshift").create_custom_domain_association method.
boto3 documentation
# create_custom_domain_association method definition
def create_custom_domain_association(
self,
*,
CustomDomainName: str,
CustomDomainCertificateArn: str,
ClusterIdentifier: str,
) -> CreateCustomDomainAssociationResultTypeDef: # (1)
...# create_custom_domain_association method usage example with argument unpacking
kwargs: CreateCustomDomainAssociationMessageTypeDef = { # (1)
"CustomDomainName": ...,
"CustomDomainCertificateArn": ...,
"ClusterIdentifier": ...,
}
parent.create_custom_domain_association(**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
# create_endpoint_access method definition
def create_endpoint_access(
self,
*,
EndpointName: str,
SubnetGroupName: str,
ClusterIdentifier: str = ...,
ResourceOwner: str = ...,
VpcSecurityGroupIds: Sequence[str] = ...,
) -> EndpointAccessResponseTypeDef: # (1)
...# create_endpoint_access method usage example with argument unpacking
kwargs: CreateEndpointAccessMessageTypeDef = { # (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
# create_event_subscription 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)
...- See
Sequence[TagTypeDef] - See CreateEventSubscriptionResultTypeDef
# create_event_subscription method usage example with argument unpacking
kwargs: CreateEventSubscriptionMessageTypeDef = { # (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
# create_hsm_client_certificate method definition
def create_hsm_client_certificate(
self,
*,
HsmClientCertificateIdentifier: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateHsmClientCertificateResultTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See CreateHsmClientCertificateResultTypeDef
# create_hsm_client_certificate method usage example with argument unpacking
kwargs: CreateHsmClientCertificateMessageTypeDef = { # (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
# create_hsm_configuration 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)
...- See
Sequence[TagTypeDef] - See CreateHsmConfigurationResultTypeDef
# create_hsm_configuration method usage example with argument unpacking
kwargs: CreateHsmConfigurationMessageTypeDef = { # (1)
"HsmConfigurationIdentifier": ...,
"Description": ...,
"HsmIpAddress": ...,
"HsmPartitionName": ...,
"HsmPartitionPassword": ...,
"HsmServerPublicCertificate": ...,
}
parent.create_hsm_configuration(**kwargs)create_integration#
Creates a zero-ETL integration or S3 event integration with Amazon Redshift.
Type annotations and code completion for boto3.client("redshift").create_integration method.
boto3 documentation
# create_integration method definition
def create_integration(
self,
*,
SourceArn: str,
TargetArn: str,
IntegrationName: str,
KMSKeyId: str = ...,
TagList: Sequence[TagTypeDef] = ..., # (1)
AdditionalEncryptionContext: Mapping[str, str] = ...,
Description: str = ...,
) -> IntegrationResponseTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See IntegrationResponseTypeDef
# create_integration method usage example with argument unpacking
kwargs: CreateIntegrationMessageTypeDef = { # (1)
"SourceArn": ...,
"TargetArn": ...,
"IntegrationName": ...,
}
parent.create_integration(**kwargs)create_redshift_idc_application#
Creates an Amazon Redshift application for use with IAM Identity Center.
Type annotations and code completion for boto3.client("redshift").create_redshift_idc_application method.
boto3 documentation
# create_redshift_idc_application method definition
def create_redshift_idc_application(
self,
*,
IdcInstanceArn: str,
RedshiftIdcApplicationName: str,
IdcDisplayName: str,
IamRoleArn: str,
IdentityNamespace: str = ...,
AuthorizedTokenIssuerList: Sequence[AuthorizedTokenIssuerUnionTypeDef] = ..., # (1)
ServiceIntegrations: Sequence[ServiceIntegrationsUnionUnionTypeDef] = ..., # (2)
) -> CreateRedshiftIdcApplicationResultTypeDef: # (3)
...- See
Sequence[AuthorizedTokenIssuerUnionTypeDef] - See
Sequence[ServiceIntegrationsUnionUnionTypeDef] - See CreateRedshiftIdcApplicationResultTypeDef
# create_redshift_idc_application method usage example with argument unpacking
kwargs: CreateRedshiftIdcApplicationMessageTypeDef = { # (1)
"IdcInstanceArn": ...,
"RedshiftIdcApplicationName": ...,
"IdcDisplayName": ...,
"IamRoleArn": ...,
}
parent.create_redshift_idc_application(**kwargs)create_scheduled_action#
Creates a scheduled action.
Type annotations and code completion for boto3.client("redshift").create_scheduled_action method.
boto3 documentation
# create_scheduled_action method definition
def create_scheduled_action(
self,
*,
ScheduledActionName: str,
TargetAction: ScheduledActionTypeTypeDef, # (1)
Schedule: str,
IamRole: str,
ScheduledActionDescription: str = ...,
StartTime: TimestampTypeDef = ...,
EndTime: TimestampTypeDef = ...,
Enable: bool = ...,
) -> ScheduledActionResponseTypeDef: # (2)
...# create_scheduled_action method usage example with argument unpacking
kwargs: CreateScheduledActionMessageTypeDef = { # (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
# create_snapshot_copy_grant method definition
def create_snapshot_copy_grant(
self,
*,
SnapshotCopyGrantName: str,
KmsKeyId: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateSnapshotCopyGrantResultTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See CreateSnapshotCopyGrantResultTypeDef
# create_snapshot_copy_grant method usage example with argument unpacking
kwargs: CreateSnapshotCopyGrantMessageTypeDef = { # (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
# create_snapshot_schedule method definition
def create_snapshot_schedule(
self,
*,
ScheduleDefinitions: Sequence[str] = ...,
ScheduleIdentifier: str = ...,
ScheduleDescription: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
DryRun: bool = ...,
NextInvocations: int = ...,
) -> SnapshotScheduleResponseTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See SnapshotScheduleResponseTypeDef
# create_snapshot_schedule method usage example with argument unpacking
kwargs: CreateSnapshotScheduleMessageTypeDef = { # (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
# create_tags method definition
def create_tags(
self,
*,
ResourceName: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...- See
Sequence[TagTypeDef] - See EmptyResponseMetadataTypeDef
# create_tags method usage example with argument unpacking
kwargs: CreateTagsMessageTypeDef = { # (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
# create_usage_limit 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)
) -> UsageLimitResponseTypeDef: # (6)
...- See UsageLimitFeatureTypeType
- See UsageLimitLimitTypeType
- See UsageLimitPeriodType
- See UsageLimitBreachActionType
- See
Sequence[TagTypeDef] - See UsageLimitResponseTypeDef
# create_usage_limit method usage example with argument unpacking
kwargs: CreateUsageLimitMessageTypeDef = { # (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
# deauthorize_data_share method definition
def deauthorize_data_share(
self,
*,
DataShareArn: str,
ConsumerIdentifier: str,
) -> DataShareResponseTypeDef: # (1)
...# deauthorize_data_share method usage example with argument unpacking
kwargs: DeauthorizeDataShareMessageTypeDef = { # (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
# delete_authentication_profile method definition
def delete_authentication_profile(
self,
*,
AuthenticationProfileName: str,
) -> DeleteAuthenticationProfileResultTypeDef: # (1)
...# delete_authentication_profile method usage example with argument unpacking
kwargs: DeleteAuthenticationProfileMessageTypeDef = { # (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
# delete_cluster method definition
def delete_cluster(
self,
*,
ClusterIdentifier: str,
SkipFinalClusterSnapshot: bool = ...,
FinalClusterSnapshotIdentifier: str = ...,
FinalClusterSnapshotRetentionPeriod: int = ...,
) -> DeleteClusterResultTypeDef: # (1)
...# delete_cluster method usage example with argument unpacking
kwargs: DeleteClusterMessageTypeDef = { # (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
# delete_cluster_parameter_group method definition
def delete_cluster_parameter_group(
self,
*,
ParameterGroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_cluster_parameter_group method usage example with argument unpacking
kwargs: DeleteClusterParameterGroupMessageTypeDef = { # (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
# delete_cluster_security_group method definition
def delete_cluster_security_group(
self,
*,
ClusterSecurityGroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_cluster_security_group method usage example with argument unpacking
kwargs: DeleteClusterSecurityGroupMessageTypeDef = { # (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
# delete_cluster_snapshot method definition
def delete_cluster_snapshot(
self,
*,
SnapshotIdentifier: str,
SnapshotClusterIdentifier: str = ...,
) -> DeleteClusterSnapshotResultTypeDef: # (1)
...# delete_cluster_snapshot method usage example with argument unpacking
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
# delete_cluster_subnet_group method definition
def delete_cluster_subnet_group(
self,
*,
ClusterSubnetGroupName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_cluster_subnet_group method usage example with argument unpacking
kwargs: DeleteClusterSubnetGroupMessageTypeDef = { # (1)
"ClusterSubnetGroupName": ...,
}
parent.delete_cluster_subnet_group(**kwargs)delete_custom_domain_association#
Contains information about deleting a custom domain association for a cluster.
Type annotations and code completion for boto3.client("redshift").delete_custom_domain_association method.
boto3 documentation
# delete_custom_domain_association method definition
def delete_custom_domain_association(
self,
*,
ClusterIdentifier: str,
CustomDomainName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_custom_domain_association method usage example with argument unpacking
kwargs: DeleteCustomDomainAssociationMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
"CustomDomainName": ...,
}
parent.delete_custom_domain_association(**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
# delete_endpoint_access method definition
def delete_endpoint_access(
self,
*,
EndpointName: str,
) -> EndpointAccessResponseTypeDef: # (1)
...# delete_endpoint_access method usage example with argument unpacking
kwargs: DeleteEndpointAccessMessageTypeDef = { # (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.
boto3 documentation
# delete_event_subscription method definition
def delete_event_subscription(
self,
*,
SubscriptionName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_event_subscription method usage example with argument unpacking
kwargs: DeleteEventSubscriptionMessageTypeDef = { # (1)
"SubscriptionName": ...,
}
parent.delete_event_subscription(**kwargs)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
# delete_hsm_client_certificate method definition
def delete_hsm_client_certificate(
self,
*,
HsmClientCertificateIdentifier: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_hsm_client_certificate method usage example with argument unpacking
kwargs: DeleteHsmClientCertificateMessageTypeDef = { # (1)
"HsmClientCertificateIdentifier": ...,
}
parent.delete_hsm_client_certificate(**kwargs)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
# delete_hsm_configuration method definition
def delete_hsm_configuration(
self,
*,
HsmConfigurationIdentifier: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_hsm_configuration method usage example with argument unpacking
kwargs: DeleteHsmConfigurationMessageTypeDef = { # (1)
"HsmConfigurationIdentifier": ...,
}
parent.delete_hsm_configuration(**kwargs)delete_integration#
Deletes a zero-ETL integration or S3 event integration with Amazon Redshift.
Type annotations and code completion for boto3.client("redshift").delete_integration method.
boto3 documentation
# delete_integration method definition
def delete_integration(
self,
*,
IntegrationArn: str,
) -> IntegrationResponseTypeDef: # (1)
...# delete_integration method usage example with argument unpacking
kwargs: DeleteIntegrationMessageTypeDef = { # (1)
"IntegrationArn": ...,
}
parent.delete_integration(**kwargs)delete_partner#
Deletes a partner integration from a cluster.
Type annotations and code completion for boto3.client("redshift").delete_partner method.
boto3 documentation
# delete_partner method definition
def delete_partner(
self,
*,
AccountId: str,
ClusterIdentifier: str,
DatabaseName: str,
PartnerName: str,
) -> PartnerIntegrationOutputMessageTypeDef: # (1)
...# delete_partner method usage example with argument unpacking
kwargs: PartnerIntegrationInputMessageRequestTypeDef = { # (1)
"AccountId": ...,
"ClusterIdentifier": ...,
"DatabaseName": ...,
"PartnerName": ...,
}
parent.delete_partner(**kwargs)delete_redshift_idc_application#
Deletes an Amazon Redshift IAM Identity Center application.
Type annotations and code completion for boto3.client("redshift").delete_redshift_idc_application method.
boto3 documentation
# delete_redshift_idc_application method definition
def delete_redshift_idc_application(
self,
*,
RedshiftIdcApplicationArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_redshift_idc_application method usage example with argument unpacking
kwargs: DeleteRedshiftIdcApplicationMessageTypeDef = { # (1)
"RedshiftIdcApplicationArn": ...,
}
parent.delete_redshift_idc_application(**kwargs)delete_resource_policy#
Deletes the resource policy for a specified resource.
Type annotations and code completion for boto3.client("redshift").delete_resource_policy method.
boto3 documentation
# delete_resource_policy method definition
def delete_resource_policy(
self,
*,
ResourceArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_resource_policy method usage example with argument unpacking
kwargs: DeleteResourcePolicyMessageTypeDef = { # (1)
"ResourceArn": ...,
}
parent.delete_resource_policy(**kwargs)delete_scheduled_action#
Deletes a scheduled action.
Type annotations and code completion for boto3.client("redshift").delete_scheduled_action method.
boto3 documentation
# delete_scheduled_action method definition
def delete_scheduled_action(
self,
*,
ScheduledActionName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_scheduled_action method usage example with argument unpacking
kwargs: DeleteScheduledActionMessageTypeDef = { # (1)
"ScheduledActionName": ...,
}
parent.delete_scheduled_action(**kwargs)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
# delete_snapshot_copy_grant method definition
def delete_snapshot_copy_grant(
self,
*,
SnapshotCopyGrantName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_snapshot_copy_grant method usage example with argument unpacking
kwargs: DeleteSnapshotCopyGrantMessageTypeDef = { # (1)
"SnapshotCopyGrantName": ...,
}
parent.delete_snapshot_copy_grant(**kwargs)delete_snapshot_schedule#
Deletes a snapshot schedule.
Type annotations and code completion for boto3.client("redshift").delete_snapshot_schedule method.
boto3 documentation
# delete_snapshot_schedule method definition
def delete_snapshot_schedule(
self,
*,
ScheduleIdentifier: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_snapshot_schedule method usage example with argument unpacking
kwargs: DeleteSnapshotScheduleMessageTypeDef = { # (1)
"ScheduleIdentifier": ...,
}
parent.delete_snapshot_schedule(**kwargs)delete_tags#
Deletes tags from a resource.
Type annotations and code completion for boto3.client("redshift").delete_tags method.
boto3 documentation
# delete_tags method definition
def delete_tags(
self,
*,
ResourceName: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_tags method usage example with argument unpacking
kwargs: DeleteTagsMessageTypeDef = { # (1)
"ResourceName": ...,
"TagKeys": ...,
}
parent.delete_tags(**kwargs)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
# delete_usage_limit method definition
def delete_usage_limit(
self,
*,
UsageLimitId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_usage_limit method usage example with argument unpacking
kwargs: DeleteUsageLimitMessageTypeDef = { # (1)
"UsageLimitId": ...,
}
parent.delete_usage_limit(**kwargs)deregister_namespace#
Deregisters a cluster or serverless namespace from the Amazon Web Services Glue Data Catalog.
Type annotations and code completion for boto3.client("redshift").deregister_namespace method.
boto3 documentation
# deregister_namespace method definition
def deregister_namespace(
self,
*,
NamespaceIdentifier: NamespaceIdentifierUnionTypeDef, # (1)
ConsumerIdentifiers: Sequence[str],
) -> DeregisterNamespaceOutputMessageTypeDef: # (2)
...# deregister_namespace method usage example with argument unpacking
kwargs: DeregisterNamespaceInputMessageTypeDef = { # (1)
"NamespaceIdentifier": ...,
"ConsumerIdentifiers": ...,
}
parent.deregister_namespace(**kwargs)describe_account_attributes#
Returns a list of attributes attached to an account.
Type annotations and code completion for boto3.client("redshift").describe_account_attributes method.
boto3 documentation
# describe_account_attributes method definition
def describe_account_attributes(
self,
*,
AttributeNames: Sequence[str] = ...,
) -> AccountAttributeListTypeDef: # (1)
...# describe_account_attributes method usage example with argument unpacking
kwargs: DescribeAccountAttributesMessageTypeDef = { # (1)
"AttributeNames": ...,
}
parent.describe_account_attributes(**kwargs)describe_authentication_profiles#
Describes an authentication profile.
Type annotations and code completion for boto3.client("redshift").describe_authentication_profiles method.
boto3 documentation
# describe_authentication_profiles method definition
def describe_authentication_profiles(
self,
*,
AuthenticationProfileName: str = ...,
) -> DescribeAuthenticationProfilesResultTypeDef: # (1)
...# describe_authentication_profiles method usage example with argument unpacking
kwargs: DescribeAuthenticationProfilesMessageTypeDef = { # (1)
"AuthenticationProfileName": ...,
}
parent.describe_authentication_profiles(**kwargs)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
# describe_cluster_db_revisions method definition
def describe_cluster_db_revisions(
self,
*,
ClusterIdentifier: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> ClusterDbRevisionsMessageTypeDef: # (1)
...# describe_cluster_db_revisions method usage example with argument unpacking
kwargs: DescribeClusterDbRevisionsMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.describe_cluster_db_revisions(**kwargs)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
# describe_cluster_parameter_groups method definition
def describe_cluster_parameter_groups(
self,
*,
ParameterGroupName: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
TagKeys: Sequence[str] = ...,
TagValues: Sequence[str] = ...,
) -> ClusterParameterGroupsMessageTypeDef: # (1)
...# describe_cluster_parameter_groups method usage example with argument unpacking
kwargs: DescribeClusterParameterGroupsMessageTypeDef = { # (1)
"ParameterGroupName": ...,
}
parent.describe_cluster_parameter_groups(**kwargs)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
# describe_cluster_parameters method definition
def describe_cluster_parameters(
self,
*,
ParameterGroupName: str,
Source: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> ClusterParameterGroupDetailsTypeDef: # (1)
...# describe_cluster_parameters method usage example with argument unpacking
kwargs: DescribeClusterParametersMessageTypeDef = { # (1)
"ParameterGroupName": ...,
}
parent.describe_cluster_parameters(**kwargs)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
# describe_cluster_security_groups method definition
def describe_cluster_security_groups(
self,
*,
ClusterSecurityGroupName: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
TagKeys: Sequence[str] = ...,
TagValues: Sequence[str] = ...,
) -> ClusterSecurityGroupMessageTypeDef: # (1)
...# describe_cluster_security_groups method usage example with argument unpacking
kwargs: DescribeClusterSecurityGroupsMessageTypeDef = { # (1)
"ClusterSecurityGroupName": ...,
}
parent.describe_cluster_security_groups(**kwargs)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
# describe_cluster_snapshots method definition
def describe_cluster_snapshots(
self,
*,
ClusterIdentifier: str = ...,
SnapshotIdentifier: str = ...,
SnapshotArn: str = ...,
SnapshotType: str = ...,
StartTime: TimestampTypeDef = ...,
EndTime: TimestampTypeDef = ...,
MaxRecords: int = ...,
Marker: str = ...,
OwnerAccount: str = ...,
TagKeys: Sequence[str] = ...,
TagValues: Sequence[str] = ...,
ClusterExists: bool = ...,
SortingEntities: Sequence[SnapshotSortingEntityTypeDef] = ..., # (1)
) -> SnapshotMessageTypeDef: # (2)
...- See
Sequence[SnapshotSortingEntityTypeDef] - See SnapshotMessageTypeDef
# describe_cluster_snapshots method usage example with argument unpacking
kwargs: DescribeClusterSnapshotsMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.describe_cluster_snapshots(**kwargs)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
# describe_cluster_subnet_groups method definition
def describe_cluster_subnet_groups(
self,
*,
ClusterSubnetGroupName: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
TagKeys: Sequence[str] = ...,
TagValues: Sequence[str] = ...,
) -> ClusterSubnetGroupMessageTypeDef: # (1)
...# describe_cluster_subnet_groups method usage example with argument unpacking
kwargs: DescribeClusterSubnetGroupsMessageTypeDef = { # (1)
"ClusterSubnetGroupName": ...,
}
parent.describe_cluster_subnet_groups(**kwargs)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
# describe_cluster_tracks method definition
def describe_cluster_tracks(
self,
*,
MaintenanceTrackName: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> TrackListMessageTypeDef: # (1)
...# describe_cluster_tracks method usage example with argument unpacking
kwargs: DescribeClusterTracksMessageTypeDef = { # (1)
"MaintenanceTrackName": ...,
}
parent.describe_cluster_tracks(**kwargs)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
# describe_cluster_versions method definition
def describe_cluster_versions(
self,
*,
ClusterVersion: str = ...,
ClusterParameterGroupFamily: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> ClusterVersionsMessageTypeDef: # (1)
...# describe_cluster_versions method usage example with argument unpacking
kwargs: DescribeClusterVersionsMessageTypeDef = { # (1)
"ClusterVersion": ...,
}
parent.describe_cluster_versions(**kwargs)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
# describe_clusters method definition
def describe_clusters(
self,
*,
ClusterIdentifier: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
TagKeys: Sequence[str] = ...,
TagValues: Sequence[str] = ...,
) -> ClustersMessageTypeDef: # (1)
...# describe_clusters method usage example with argument unpacking
kwargs: DescribeClustersMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.describe_clusters(**kwargs)describe_custom_domain_associations#
Contains information about custom domain associations for a cluster.
Type annotations and code completion for boto3.client("redshift").describe_custom_domain_associations method.
boto3 documentation
# describe_custom_domain_associations method definition
def describe_custom_domain_associations(
self,
*,
CustomDomainName: str = ...,
CustomDomainCertificateArn: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> CustomDomainAssociationsMessageTypeDef: # (1)
...# describe_custom_domain_associations method usage example with argument unpacking
kwargs: DescribeCustomDomainAssociationsMessageTypeDef = { # (1)
"CustomDomainName": ...,
}
parent.describe_custom_domain_associations(**kwargs)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
# describe_data_shares method definition
def describe_data_shares(
self,
*,
DataShareArn: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> DescribeDataSharesResultTypeDef: # (1)
...# describe_data_shares method usage example with argument unpacking
kwargs: DescribeDataSharesMessageTypeDef = { # (1)
"DataShareArn": ...,
}
parent.describe_data_shares(**kwargs)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
# describe_data_shares_for_consumer method definition
def describe_data_shares_for_consumer(
self,
*,
ConsumerArn: str = ...,
Status: DataShareStatusForConsumerType = ..., # (1)
MaxRecords: int = ...,
Marker: str = ...,
) -> DescribeDataSharesForConsumerResultTypeDef: # (2)
...# describe_data_shares_for_consumer method usage example with argument unpacking
kwargs: DescribeDataSharesForConsumerMessageTypeDef = { # (1)
"ConsumerArn": ...,
}
parent.describe_data_shares_for_consumer(**kwargs)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
# describe_data_shares_for_producer method definition
def describe_data_shares_for_producer(
self,
*,
ProducerArn: str = ...,
Status: DataShareStatusForProducerType = ..., # (1)
MaxRecords: int = ...,
Marker: str = ...,
) -> DescribeDataSharesForProducerResultTypeDef: # (2)
...# describe_data_shares_for_producer method usage example with argument unpacking
kwargs: DescribeDataSharesForProducerMessageTypeDef = { # (1)
"ProducerArn": ...,
}
parent.describe_data_shares_for_producer(**kwargs)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
# describe_default_cluster_parameters method definition
def describe_default_cluster_parameters(
self,
*,
ParameterGroupFamily: str,
MaxRecords: int = ...,
Marker: str = ...,
) -> DescribeDefaultClusterParametersResultTypeDef: # (1)
...# describe_default_cluster_parameters method usage example with argument unpacking
kwargs: DescribeDefaultClusterParametersMessageTypeDef = { # (1)
"ParameterGroupFamily": ...,
}
parent.describe_default_cluster_parameters(**kwargs)describe_endpoint_access#
Describes a Redshift-managed VPC endpoint.
Type annotations and code completion for boto3.client("redshift").describe_endpoint_access method.
boto3 documentation
# describe_endpoint_access method definition
def describe_endpoint_access(
self,
*,
ClusterIdentifier: str = ...,
ResourceOwner: str = ...,
EndpointName: str = ...,
VpcId: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> EndpointAccessListTypeDef: # (1)
...# describe_endpoint_access method usage example with argument unpacking
kwargs: DescribeEndpointAccessMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.describe_endpoint_access(**kwargs)describe_endpoint_authorization#
Describes an endpoint authorization.
Type annotations and code completion for boto3.client("redshift").describe_endpoint_authorization method.
boto3 documentation
# describe_endpoint_authorization method definition
def describe_endpoint_authorization(
self,
*,
ClusterIdentifier: str = ...,
Account: str = ...,
Grantee: bool = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> EndpointAuthorizationListTypeDef: # (1)
...# describe_endpoint_authorization method usage example with argument unpacking
kwargs: DescribeEndpointAuthorizationMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.describe_endpoint_authorization(**kwargs)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
# describe_event_categories method definition
def describe_event_categories(
self,
*,
SourceType: str = ...,
) -> EventCategoriesMessageTypeDef: # (1)
...# describe_event_categories method usage example with argument unpacking
kwargs: DescribeEventCategoriesMessageTypeDef = { # (1)
"SourceType": ...,
}
parent.describe_event_categories(**kwargs)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
# describe_event_subscriptions method definition
def describe_event_subscriptions(
self,
*,
SubscriptionName: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
TagKeys: Sequence[str] = ...,
TagValues: Sequence[str] = ...,
) -> EventSubscriptionsMessageTypeDef: # (1)
...# describe_event_subscriptions method usage example with argument unpacking
kwargs: DescribeEventSubscriptionsMessageTypeDef = { # (1)
"SubscriptionName": ...,
}
parent.describe_event_subscriptions(**kwargs)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
# describe_events method definition
def describe_events(
self,
*,
SourceIdentifier: str = ...,
SourceType: SourceTypeType = ..., # (1)
StartTime: TimestampTypeDef = ...,
EndTime: TimestampTypeDef = ...,
Duration: int = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> EventsMessageTypeDef: # (2)
...- See SourceTypeType
- See EventsMessageTypeDef
# describe_events method usage example with argument unpacking
kwargs: DescribeEventsMessageTypeDef = { # (1)
"SourceIdentifier": ...,
}
parent.describe_events(**kwargs)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
# describe_hsm_client_certificates method definition
def describe_hsm_client_certificates(
self,
*,
HsmClientCertificateIdentifier: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
TagKeys: Sequence[str] = ...,
TagValues: Sequence[str] = ...,
) -> HsmClientCertificateMessageTypeDef: # (1)
...# describe_hsm_client_certificates method usage example with argument unpacking
kwargs: DescribeHsmClientCertificatesMessageTypeDef = { # (1)
"HsmClientCertificateIdentifier": ...,
}
parent.describe_hsm_client_certificates(**kwargs)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
# describe_hsm_configurations method definition
def describe_hsm_configurations(
self,
*,
HsmConfigurationIdentifier: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
TagKeys: Sequence[str] = ...,
TagValues: Sequence[str] = ...,
) -> HsmConfigurationMessageTypeDef: # (1)
...# describe_hsm_configurations method usage example with argument unpacking
kwargs: DescribeHsmConfigurationsMessageTypeDef = { # (1)
"HsmConfigurationIdentifier": ...,
}
parent.describe_hsm_configurations(**kwargs)describe_inbound_integrations#
Returns a list of inbound integrations.
Type annotations and code completion for boto3.client("redshift").describe_inbound_integrations method.
boto3 documentation
# describe_inbound_integrations method definition
def describe_inbound_integrations(
self,
*,
IntegrationArn: str = ...,
TargetArn: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> InboundIntegrationsMessageTypeDef: # (1)
...# describe_inbound_integrations method usage example with argument unpacking
kwargs: DescribeInboundIntegrationsMessageTypeDef = { # (1)
"IntegrationArn": ...,
}
parent.describe_inbound_integrations(**kwargs)describe_integrations#
Describes one or more zero-ETL or S3 event integrations with Amazon Redshift.
Type annotations and code completion for boto3.client("redshift").describe_integrations method.
boto3 documentation
# describe_integrations method definition
def describe_integrations(
self,
*,
IntegrationArn: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
Filters: Sequence[DescribeIntegrationsFilterTypeDef] = ..., # (1)
) -> IntegrationsMessageTypeDef: # (2)
...- See
Sequence[DescribeIntegrationsFilterTypeDef] - See IntegrationsMessageTypeDef
# describe_integrations method usage example with argument unpacking
kwargs: DescribeIntegrationsMessageTypeDef = { # (1)
"IntegrationArn": ...,
}
parent.describe_integrations(**kwargs)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
# describe_logging_status method definition
def describe_logging_status(
self,
*,
ClusterIdentifier: str,
) -> LoggingStatusTypeDef: # (1)
...# describe_logging_status method usage example with argument unpacking
kwargs: DescribeLoggingStatusMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.describe_logging_status(**kwargs)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
# describe_node_configuration_options 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)
...- See ActionTypeType
- See
Sequence[NodeConfigurationOptionsFilterTypeDef] - See NodeConfigurationOptionsMessageTypeDef
# describe_node_configuration_options method usage example with argument unpacking
kwargs: DescribeNodeConfigurationOptionsMessageTypeDef = { # (1)
"ActionType": ...,
}
parent.describe_node_configuration_options(**kwargs)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
# describe_orderable_cluster_options method definition
def describe_orderable_cluster_options(
self,
*,
ClusterVersion: str = ...,
NodeType: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> OrderableClusterOptionsMessageTypeDef: # (1)
...# describe_orderable_cluster_options method usage example with argument unpacking
kwargs: DescribeOrderableClusterOptionsMessageTypeDef = { # (1)
"ClusterVersion": ...,
}
parent.describe_orderable_cluster_options(**kwargs)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
# describe_partners method definition
def describe_partners(
self,
*,
AccountId: str,
ClusterIdentifier: str,
DatabaseName: str = ...,
PartnerName: str = ...,
) -> DescribePartnersOutputMessageTypeDef: # (1)
...# describe_partners method usage example with argument unpacking
kwargs: DescribePartnersInputMessageTypeDef = { # (1)
"AccountId": ...,
"ClusterIdentifier": ...,
}
parent.describe_partners(**kwargs)describe_redshift_idc_applications#
Lists the Amazon Redshift IAM Identity Center applications.
Type annotations and code completion for boto3.client("redshift").describe_redshift_idc_applications method.
boto3 documentation
# describe_redshift_idc_applications method definition
def describe_redshift_idc_applications(
self,
*,
RedshiftIdcApplicationArn: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> DescribeRedshiftIdcApplicationsResultTypeDef: # (1)
...# describe_redshift_idc_applications method usage example with argument unpacking
kwargs: DescribeRedshiftIdcApplicationsMessageTypeDef = { # (1)
"RedshiftIdcApplicationArn": ...,
}
parent.describe_redshift_idc_applications(**kwargs)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
# describe_reserved_node_exchange_status method definition
def describe_reserved_node_exchange_status(
self,
*,
ReservedNodeId: str = ...,
ReservedNodeExchangeRequestId: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> DescribeReservedNodeExchangeStatusOutputMessageTypeDef: # (1)
...# describe_reserved_node_exchange_status method usage example with argument unpacking
kwargs: DescribeReservedNodeExchangeStatusInputMessageTypeDef = { # (1)
"ReservedNodeId": ...,
}
parent.describe_reserved_node_exchange_status(**kwargs)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
# describe_reserved_node_offerings method definition
def describe_reserved_node_offerings(
self,
*,
ReservedNodeOfferingId: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> ReservedNodeOfferingsMessageTypeDef: # (1)
...# describe_reserved_node_offerings method usage example with argument unpacking
kwargs: DescribeReservedNodeOfferingsMessageTypeDef = { # (1)
"ReservedNodeOfferingId": ...,
}
parent.describe_reserved_node_offerings(**kwargs)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
# describe_reserved_nodes method definition
def describe_reserved_nodes(
self,
*,
ReservedNodeId: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> ReservedNodesMessageTypeDef: # (1)
...# describe_reserved_nodes method usage example with argument unpacking
kwargs: DescribeReservedNodesMessageTypeDef = { # (1)
"ReservedNodeId": ...,
}
parent.describe_reserved_nodes(**kwargs)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
# describe_resize method definition
def describe_resize(
self,
*,
ClusterIdentifier: str,
) -> ResizeProgressMessageTypeDef: # (1)
...# describe_resize method usage example with argument unpacking
kwargs: DescribeResizeMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.describe_resize(**kwargs)describe_scheduled_actions#
Describes properties of scheduled actions.
Type annotations and code completion for boto3.client("redshift").describe_scheduled_actions method.
boto3 documentation
# describe_scheduled_actions method definition
def describe_scheduled_actions(
self,
*,
ScheduledActionName: str = ...,
TargetActionType: ScheduledActionTypeValuesType = ..., # (1)
StartTime: TimestampTypeDef = ...,
EndTime: TimestampTypeDef = ...,
Active: bool = ...,
Filters: Sequence[ScheduledActionFilterTypeDef] = ..., # (2)
Marker: str = ...,
MaxRecords: int = ...,
) -> ScheduledActionsMessageTypeDef: # (3)
...- See ScheduledActionTypeValuesType
- See
Sequence[ScheduledActionFilterTypeDef] - See ScheduledActionsMessageTypeDef
# describe_scheduled_actions method usage example with argument unpacking
kwargs: DescribeScheduledActionsMessageTypeDef = { # (1)
"ScheduledActionName": ...,
}
parent.describe_scheduled_actions(**kwargs)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
# describe_snapshot_copy_grants method definition
def describe_snapshot_copy_grants(
self,
*,
SnapshotCopyGrantName: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
TagKeys: Sequence[str] = ...,
TagValues: Sequence[str] = ...,
) -> SnapshotCopyGrantMessageTypeDef: # (1)
...# describe_snapshot_copy_grants method usage example with argument unpacking
kwargs: DescribeSnapshotCopyGrantsMessageTypeDef = { # (1)
"SnapshotCopyGrantName": ...,
}
parent.describe_snapshot_copy_grants(**kwargs)describe_snapshot_schedules#
Returns a list of snapshot schedules.
Type annotations and code completion for boto3.client("redshift").describe_snapshot_schedules method.
boto3 documentation
# describe_snapshot_schedules method definition
def describe_snapshot_schedules(
self,
*,
ClusterIdentifier: str = ...,
ScheduleIdentifier: str = ...,
TagKeys: Sequence[str] = ...,
TagValues: Sequence[str] = ...,
Marker: str = ...,
MaxRecords: int = ...,
) -> DescribeSnapshotSchedulesOutputMessageTypeDef: # (1)
...# describe_snapshot_schedules method usage example with argument unpacking
kwargs: DescribeSnapshotSchedulesMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.describe_snapshot_schedules(**kwargs)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
# describe_storage method definition
def describe_storage(
self,
) -> CustomerStorageMessageTypeDef: # (1)
...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
# describe_table_restore_status method definition
def describe_table_restore_status(
self,
*,
ClusterIdentifier: str = ...,
TableRestoreRequestId: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> TableRestoreStatusMessageTypeDef: # (1)
...# describe_table_restore_status method usage example with argument unpacking
kwargs: DescribeTableRestoreStatusMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.describe_table_restore_status(**kwargs)describe_tags#
Returns a list of tags.
Type annotations and code completion for boto3.client("redshift").describe_tags method.
boto3 documentation
# describe_tags method definition
def describe_tags(
self,
*,
ResourceName: str = ...,
ResourceType: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
TagKeys: Sequence[str] = ...,
TagValues: Sequence[str] = ...,
) -> TaggedResourceListMessageTypeDef: # (1)
...# describe_tags method usage example with argument unpacking
kwargs: DescribeTagsMessageTypeDef = { # (1)
"ResourceName": ...,
}
parent.describe_tags(**kwargs)describe_usage_limits#
Shows usage limits on a cluster.
Type annotations and code completion for boto3.client("redshift").describe_usage_limits method.
boto3 documentation
# describe_usage_limits 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)
...# describe_usage_limits method usage example with argument unpacking
kwargs: DescribeUsageLimitsMessageTypeDef = { # (1)
"UsageLimitId": ...,
}
parent.describe_usage_limits(**kwargs)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
# disable_logging method definition
def disable_logging(
self,
*,
ClusterIdentifier: str,
) -> LoggingStatusTypeDef: # (1)
...# disable_logging method usage example with argument unpacking
kwargs: DisableLoggingMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.disable_logging(**kwargs)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
# disable_snapshot_copy method definition
def disable_snapshot_copy(
self,
*,
ClusterIdentifier: str,
) -> DisableSnapshotCopyResultTypeDef: # (1)
...# disable_snapshot_copy method usage example with argument unpacking
kwargs: DisableSnapshotCopyMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.disable_snapshot_copy(**kwargs)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
# disassociate_data_share_consumer method definition
def disassociate_data_share_consumer(
self,
*,
DataShareArn: str,
DisassociateEntireAccount: bool = ...,
ConsumerArn: str = ...,
ConsumerRegion: str = ...,
) -> DataShareResponseTypeDef: # (1)
...# disassociate_data_share_consumer method usage example with argument unpacking
kwargs: DisassociateDataShareConsumerMessageTypeDef = { # (1)
"DataShareArn": ...,
}
parent.disassociate_data_share_consumer(**kwargs)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
# enable_logging method definition
def enable_logging(
self,
*,
ClusterIdentifier: str,
BucketName: str = ...,
S3KeyPrefix: str = ...,
LogDestinationType: LogDestinationTypeType = ..., # (1)
LogExports: Sequence[str] = ...,
) -> LoggingStatusTypeDef: # (2)
...# enable_logging method usage example with argument unpacking
kwargs: EnableLoggingMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.enable_logging(**kwargs)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
# enable_snapshot_copy method definition
def enable_snapshot_copy(
self,
*,
ClusterIdentifier: str,
DestinationRegion: str,
RetentionPeriod: int = ...,
SnapshotCopyGrantName: str = ...,
ManualSnapshotRetentionPeriod: int = ...,
) -> EnableSnapshotCopyResultTypeDef: # (1)
...# enable_snapshot_copy method usage example with argument unpacking
kwargs: EnableSnapshotCopyMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
"DestinationRegion": ...,
}
parent.enable_snapshot_copy(**kwargs)failover_primary_compute#
Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.
Type annotations and code completion for boto3.client("redshift").failover_primary_compute method.
boto3 documentation
# failover_primary_compute method definition
def failover_primary_compute(
self,
*,
ClusterIdentifier: str,
) -> FailoverPrimaryComputeResultTypeDef: # (1)
...# failover_primary_compute method usage example with argument unpacking
kwargs: FailoverPrimaryComputeInputMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.failover_primary_compute(**kwargs)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
# get_cluster_credentials method definition
def get_cluster_credentials(
self,
*,
DbUser: str,
DbName: str = ...,
ClusterIdentifier: str = ...,
DurationSeconds: int = ...,
AutoCreate: bool = ...,
DbGroups: Sequence[str] = ...,
CustomDomainName: str = ...,
) -> ClusterCredentialsTypeDef: # (1)
...# get_cluster_credentials method usage example with argument unpacking
kwargs: GetClusterCredentialsMessageTypeDef = { # (1)
"DbUser": ...,
}
parent.get_cluster_credentials(**kwargs)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
# get_cluster_credentials_with_iam method definition
def get_cluster_credentials_with_iam(
self,
*,
DbName: str = ...,
ClusterIdentifier: str = ...,
DurationSeconds: int = ...,
CustomDomainName: str = ...,
) -> ClusterExtendedCredentialsTypeDef: # (1)
...# get_cluster_credentials_with_iam method usage example with argument unpacking
kwargs: GetClusterCredentialsWithIAMMessageTypeDef = { # (1)
"DbName": ...,
}
parent.get_cluster_credentials_with_iam(**kwargs)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
# get_reserved_node_exchange_configuration_options method definition
def get_reserved_node_exchange_configuration_options(
self,
*,
ActionType: ReservedNodeExchangeActionTypeType, # (1)
ClusterIdentifier: str = ...,
SnapshotIdentifier: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> GetReservedNodeExchangeConfigurationOptionsOutputMessageTypeDef: # (2)
...- See ReservedNodeExchangeActionTypeType
- See GetReservedNodeExchangeConfigurationOptionsOutputMessageTypeDef
# get_reserved_node_exchange_configuration_options method usage example with argument unpacking
kwargs: GetReservedNodeExchangeConfigurationOptionsInputMessageTypeDef = { # (1)
"ActionType": ...,
}
parent.get_reserved_node_exchange_configuration_options(**kwargs)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
# get_reserved_node_exchange_offerings method definition
def get_reserved_node_exchange_offerings(
self,
*,
ReservedNodeId: str,
MaxRecords: int = ...,
Marker: str = ...,
) -> GetReservedNodeExchangeOfferingsOutputMessageTypeDef: # (1)
...# get_reserved_node_exchange_offerings method usage example with argument unpacking
kwargs: GetReservedNodeExchangeOfferingsInputMessageTypeDef = { # (1)
"ReservedNodeId": ...,
}
parent.get_reserved_node_exchange_offerings(**kwargs)get_resource_policy#
Get the resource policy for a specified resource.
Type annotations and code completion for boto3.client("redshift").get_resource_policy method.
boto3 documentation
# get_resource_policy method definition
def get_resource_policy(
self,
*,
ResourceArn: str,
) -> GetResourcePolicyResultTypeDef: # (1)
...# get_resource_policy method usage example with argument unpacking
kwargs: GetResourcePolicyMessageTypeDef = { # (1)
"ResourceArn": ...,
}
parent.get_resource_policy(**kwargs)list_recommendations#
List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.
Type annotations and code completion for boto3.client("redshift").list_recommendations method.
boto3 documentation
# list_recommendations method definition
def list_recommendations(
self,
*,
ClusterIdentifier: str = ...,
NamespaceArn: str = ...,
MaxRecords: int = ...,
Marker: str = ...,
) -> ListRecommendationsResultTypeDef: # (1)
...# list_recommendations method usage example with argument unpacking
kwargs: ListRecommendationsMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.list_recommendations(**kwargs)modify_aqua_configuration#
This operation is retired.
Type annotations and code completion for boto3.client("redshift").modify_aqua_configuration method.
boto3 documentation
# modify_aqua_configuration method definition
def modify_aqua_configuration(
self,
*,
ClusterIdentifier: str,
AquaConfigurationStatus: AquaConfigurationStatusType = ..., # (1)
) -> ModifyAquaOutputMessageTypeDef: # (2)
...# modify_aqua_configuration method usage example with argument unpacking
kwargs: ModifyAquaInputMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.modify_aqua_configuration(**kwargs)modify_authentication_profile#
Modifies an authentication profile.
Type annotations and code completion for boto3.client("redshift").modify_authentication_profile method.
boto3 documentation
# modify_authentication_profile method definition
def modify_authentication_profile(
self,
*,
AuthenticationProfileName: str,
AuthenticationProfileContent: str,
) -> ModifyAuthenticationProfileResultTypeDef: # (1)
...# modify_authentication_profile method usage example with argument unpacking
kwargs: ModifyAuthenticationProfileMessageTypeDef = { # (1)
"AuthenticationProfileName": ...,
"AuthenticationProfileContent": ...,
}
parent.modify_authentication_profile(**kwargs)modify_cluster#
Modifies the settings for a cluster.
Type annotations and code completion for boto3.client("redshift").modify_cluster method.
boto3 documentation
# modify_cluster 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 = ...,
ManageMasterPassword: bool = ...,
MasterPasswordSecretKmsKeyId: str = ...,
IpAddressType: str = ...,
MultiAZ: bool = ...,
) -> ModifyClusterResultTypeDef: # (1)
...# modify_cluster method usage example with argument unpacking
kwargs: ModifyClusterMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.modify_cluster(**kwargs)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
# modify_cluster_db_revision method definition
def modify_cluster_db_revision(
self,
*,
ClusterIdentifier: str,
RevisionTarget: str,
) -> ModifyClusterDbRevisionResultTypeDef: # (1)
...# modify_cluster_db_revision method usage example with argument unpacking
kwargs: ModifyClusterDbRevisionMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
"RevisionTarget": ...,
}
parent.modify_cluster_db_revision(**kwargs)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
# modify_cluster_iam_roles method definition
def modify_cluster_iam_roles(
self,
*,
ClusterIdentifier: str,
AddIamRoles: Sequence[str] = ...,
RemoveIamRoles: Sequence[str] = ...,
DefaultIamRoleArn: str = ...,
) -> ModifyClusterIamRolesResultTypeDef: # (1)
...# modify_cluster_iam_roles method usage example with argument unpacking
kwargs: ModifyClusterIamRolesMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.modify_cluster_iam_roles(**kwargs)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
# modify_cluster_maintenance method definition
def modify_cluster_maintenance(
self,
*,
ClusterIdentifier: str,
DeferMaintenance: bool = ...,
DeferMaintenanceIdentifier: str = ...,
DeferMaintenanceStartTime: TimestampTypeDef = ...,
DeferMaintenanceEndTime: TimestampTypeDef = ...,
DeferMaintenanceDuration: int = ...,
) -> ModifyClusterMaintenanceResultTypeDef: # (1)
...# modify_cluster_maintenance method usage example with argument unpacking
kwargs: ModifyClusterMaintenanceMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.modify_cluster_maintenance(**kwargs)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
# modify_cluster_parameter_group method definition
def modify_cluster_parameter_group(
self,
*,
ParameterGroupName: str,
Parameters: Sequence[ParameterTypeDef], # (1)
) -> ClusterParameterGroupNameMessageTypeDef: # (2)
...- See
Sequence[ParameterTypeDef] - See ClusterParameterGroupNameMessageTypeDef
# modify_cluster_parameter_group method usage example with argument unpacking
kwargs: ModifyClusterParameterGroupMessageTypeDef = { # (1)
"ParameterGroupName": ...,
"Parameters": ...,
}
parent.modify_cluster_parameter_group(**kwargs)modify_cluster_snapshot#
Modifies the settings for a snapshot.
Type annotations and code completion for boto3.client("redshift").modify_cluster_snapshot method.
boto3 documentation
# modify_cluster_snapshot method definition
def modify_cluster_snapshot(
self,
*,
SnapshotIdentifier: str,
ManualSnapshotRetentionPeriod: int = ...,
Force: bool = ...,
) -> ModifyClusterSnapshotResultTypeDef: # (1)
...# modify_cluster_snapshot method usage example with argument unpacking
kwargs: ModifyClusterSnapshotMessageTypeDef = { # (1)
"SnapshotIdentifier": ...,
}
parent.modify_cluster_snapshot(**kwargs)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
# modify_cluster_snapshot_schedule method definition
def modify_cluster_snapshot_schedule(
self,
*,
ClusterIdentifier: str,
ScheduleIdentifier: str = ...,
DisassociateSchedule: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# modify_cluster_snapshot_schedule method usage example with argument unpacking
kwargs: ModifyClusterSnapshotScheduleMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.modify_cluster_snapshot_schedule(**kwargs)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
# modify_cluster_subnet_group method definition
def modify_cluster_subnet_group(
self,
*,
ClusterSubnetGroupName: str,
SubnetIds: Sequence[str],
Description: str = ...,
) -> ModifyClusterSubnetGroupResultTypeDef: # (1)
...# modify_cluster_subnet_group method usage example with argument unpacking
kwargs: ModifyClusterSubnetGroupMessageTypeDef = { # (1)
"ClusterSubnetGroupName": ...,
"SubnetIds": ...,
}
parent.modify_cluster_subnet_group(**kwargs)modify_custom_domain_association#
Contains information for changing a custom domain association.
Type annotations and code completion for boto3.client("redshift").modify_custom_domain_association method.
boto3 documentation
# modify_custom_domain_association method definition
def modify_custom_domain_association(
self,
*,
CustomDomainName: str,
CustomDomainCertificateArn: str,
ClusterIdentifier: str,
) -> ModifyCustomDomainAssociationResultTypeDef: # (1)
...# modify_custom_domain_association method usage example with argument unpacking
kwargs: ModifyCustomDomainAssociationMessageTypeDef = { # (1)
"CustomDomainName": ...,
"CustomDomainCertificateArn": ...,
"ClusterIdentifier": ...,
}
parent.modify_custom_domain_association(**kwargs)modify_endpoint_access#
Modifies a Redshift-managed VPC endpoint.
Type annotations and code completion for boto3.client("redshift").modify_endpoint_access method.
boto3 documentation
# modify_endpoint_access method definition
def modify_endpoint_access(
self,
*,
EndpointName: str,
VpcSecurityGroupIds: Sequence[str] = ...,
) -> EndpointAccessResponseTypeDef: # (1)
...# modify_endpoint_access method usage example with argument unpacking
kwargs: ModifyEndpointAccessMessageTypeDef = { # (1)
"EndpointName": ...,
}
parent.modify_endpoint_access(**kwargs)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
# modify_event_subscription 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)
...# modify_event_subscription method usage example with argument unpacking
kwargs: ModifyEventSubscriptionMessageTypeDef = { # (1)
"SubscriptionName": ...,
}
parent.modify_event_subscription(**kwargs)modify_integration#
Modifies a zero-ETL integration or S3 event integration with Amazon Redshift.
Type annotations and code completion for boto3.client("redshift").modify_integration method.
boto3 documentation
# modify_integration method definition
def modify_integration(
self,
*,
IntegrationArn: str,
Description: str = ...,
IntegrationName: str = ...,
) -> IntegrationResponseTypeDef: # (1)
...# modify_integration method usage example with argument unpacking
kwargs: ModifyIntegrationMessageTypeDef = { # (1)
"IntegrationArn": ...,
}
parent.modify_integration(**kwargs)modify_redshift_idc_application#
Changes an existing Amazon Redshift IAM Identity Center application.
Type annotations and code completion for boto3.client("redshift").modify_redshift_idc_application method.
boto3 documentation
# modify_redshift_idc_application method definition
def modify_redshift_idc_application(
self,
*,
RedshiftIdcApplicationArn: str,
IdentityNamespace: str = ...,
IamRoleArn: str = ...,
IdcDisplayName: str = ...,
AuthorizedTokenIssuerList: Sequence[AuthorizedTokenIssuerUnionTypeDef] = ..., # (1)
ServiceIntegrations: Sequence[ServiceIntegrationsUnionUnionTypeDef] = ..., # (2)
) -> ModifyRedshiftIdcApplicationResultTypeDef: # (3)
...- See
Sequence[AuthorizedTokenIssuerUnionTypeDef] - See
Sequence[ServiceIntegrationsUnionUnionTypeDef] - See ModifyRedshiftIdcApplicationResultTypeDef
# modify_redshift_idc_application method usage example with argument unpacking
kwargs: ModifyRedshiftIdcApplicationMessageTypeDef = { # (1)
"RedshiftIdcApplicationArn": ...,
}
parent.modify_redshift_idc_application(**kwargs)modify_scheduled_action#
Modifies a scheduled action.
Type annotations and code completion for boto3.client("redshift").modify_scheduled_action method.
boto3 documentation
# modify_scheduled_action method definition
def modify_scheduled_action(
self,
*,
ScheduledActionName: str,
TargetAction: ScheduledActionTypeTypeDef = ..., # (1)
Schedule: str = ...,
IamRole: str = ...,
ScheduledActionDescription: str = ...,
StartTime: TimestampTypeDef = ...,
EndTime: TimestampTypeDef = ...,
Enable: bool = ...,
) -> ScheduledActionResponseTypeDef: # (2)
...# modify_scheduled_action method usage example with argument unpacking
kwargs: ModifyScheduledActionMessageTypeDef = { # (1)
"ScheduledActionName": ...,
}
parent.modify_scheduled_action(**kwargs)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
# modify_snapshot_copy_retention_period method definition
def modify_snapshot_copy_retention_period(
self,
*,
ClusterIdentifier: str,
RetentionPeriod: int,
Manual: bool = ...,
) -> ModifySnapshotCopyRetentionPeriodResultTypeDef: # (1)
...# modify_snapshot_copy_retention_period method usage example with argument unpacking
kwargs: ModifySnapshotCopyRetentionPeriodMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
"RetentionPeriod": ...,
}
parent.modify_snapshot_copy_retention_period(**kwargs)modify_snapshot_schedule#
Modifies a snapshot schedule.
Type annotations and code completion for boto3.client("redshift").modify_snapshot_schedule method.
boto3 documentation
# modify_snapshot_schedule method definition
def modify_snapshot_schedule(
self,
*,
ScheduleIdentifier: str,
ScheduleDefinitions: Sequence[str],
) -> SnapshotScheduleResponseTypeDef: # (1)
...# modify_snapshot_schedule method usage example with argument unpacking
kwargs: ModifySnapshotScheduleMessageTypeDef = { # (1)
"ScheduleIdentifier": ...,
"ScheduleDefinitions": ...,
}
parent.modify_snapshot_schedule(**kwargs)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
# modify_usage_limit method definition
def modify_usage_limit(
self,
*,
UsageLimitId: str,
Amount: int = ...,
BreachAction: UsageLimitBreachActionType = ..., # (1)
) -> UsageLimitResponseTypeDef: # (2)
...# modify_usage_limit method usage example with argument unpacking
kwargs: ModifyUsageLimitMessageTypeDef = { # (1)
"UsageLimitId": ...,
}
parent.modify_usage_limit(**kwargs)pause_cluster#
Pauses a cluster.
Type annotations and code completion for boto3.client("redshift").pause_cluster method.
boto3 documentation
# pause_cluster method definition
def pause_cluster(
self,
*,
ClusterIdentifier: str,
) -> PauseClusterResultTypeDef: # (1)
...# pause_cluster method usage example with argument unpacking
kwargs: PauseClusterMessageRequestTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.pause_cluster(**kwargs)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
# purchase_reserved_node_offering method definition
def purchase_reserved_node_offering(
self,
*,
ReservedNodeOfferingId: str,
NodeCount: int = ...,
) -> PurchaseReservedNodeOfferingResultTypeDef: # (1)
...# purchase_reserved_node_offering method usage example with argument unpacking
kwargs: PurchaseReservedNodeOfferingMessageTypeDef = { # (1)
"ReservedNodeOfferingId": ...,
}
parent.purchase_reserved_node_offering(**kwargs)put_resource_policy#
Updates the resource policy for a specified resource.
Type annotations and code completion for boto3.client("redshift").put_resource_policy method.
boto3 documentation
# put_resource_policy method definition
def put_resource_policy(
self,
*,
ResourceArn: str,
Policy: str,
) -> PutResourcePolicyResultTypeDef: # (1)
...# put_resource_policy method usage example with argument unpacking
kwargs: PutResourcePolicyMessageTypeDef = { # (1)
"ResourceArn": ...,
"Policy": ...,
}
parent.put_resource_policy(**kwargs)reboot_cluster#
Reboots a cluster.
Type annotations and code completion for boto3.client("redshift").reboot_cluster method.
boto3 documentation
# reboot_cluster method definition
def reboot_cluster(
self,
*,
ClusterIdentifier: str,
) -> RebootClusterResultTypeDef: # (1)
...# reboot_cluster method usage example with argument unpacking
kwargs: RebootClusterMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.reboot_cluster(**kwargs)register_namespace#
Registers a cluster or serverless namespace to the Amazon Web Services Glue Data Catalog.
Type annotations and code completion for boto3.client("redshift").register_namespace method.
boto3 documentation
# register_namespace method definition
def register_namespace(
self,
*,
NamespaceIdentifier: NamespaceIdentifierUnionTypeDef, # (1)
ConsumerIdentifiers: Sequence[str],
) -> RegisterNamespaceOutputMessageTypeDef: # (2)
...# register_namespace method usage example with argument unpacking
kwargs: RegisterNamespaceInputMessageTypeDef = { # (1)
"NamespaceIdentifier": ...,
"ConsumerIdentifiers": ...,
}
parent.register_namespace(**kwargs)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
# reject_data_share method definition
def reject_data_share(
self,
*,
DataShareArn: str,
) -> DataShareResponseTypeDef: # (1)
...# reject_data_share method usage example with argument unpacking
kwargs: RejectDataShareMessageTypeDef = { # (1)
"DataShareArn": ...,
}
parent.reject_data_share(**kwargs)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
# reset_cluster_parameter_group method definition
def reset_cluster_parameter_group(
self,
*,
ParameterGroupName: str,
ResetAllParameters: bool = ...,
Parameters: Sequence[ParameterTypeDef] = ..., # (1)
) -> ClusterParameterGroupNameMessageTypeDef: # (2)
...- See
Sequence[ParameterTypeDef] - See ClusterParameterGroupNameMessageTypeDef
# reset_cluster_parameter_group method usage example with argument unpacking
kwargs: ResetClusterParameterGroupMessageTypeDef = { # (1)
"ParameterGroupName": ...,
}
parent.reset_cluster_parameter_group(**kwargs)resize_cluster#
Changes the size of the cluster.
Type annotations and code completion for boto3.client("redshift").resize_cluster method.
boto3 documentation
# resize_cluster method definition
def resize_cluster(
self,
*,
ClusterIdentifier: str,
ClusterType: str = ...,
NodeType: str = ...,
NumberOfNodes: int = ...,
Classic: bool = ...,
ReservedNodeId: str = ...,
TargetReservedNodeOfferingId: str = ...,
) -> ResizeClusterResultTypeDef: # (1)
...# resize_cluster method usage example with argument unpacking
kwargs: ResizeClusterMessageRequestTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.resize_cluster(**kwargs)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
# restore_from_cluster_snapshot 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 = ...,
ManageMasterPassword: bool = ...,
MasterPasswordSecretKmsKeyId: str = ...,
IpAddressType: str = ...,
MultiAZ: bool = ...,
) -> RestoreFromClusterSnapshotResultTypeDef: # (2)
...# restore_from_cluster_snapshot method usage example with argument unpacking
kwargs: RestoreFromClusterSnapshotMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.restore_from_cluster_snapshot(**kwargs)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
# restore_table_from_cluster_snapshot 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)
...# restore_table_from_cluster_snapshot method usage example with argument unpacking
kwargs: RestoreTableFromClusterSnapshotMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
"SnapshotIdentifier": ...,
"SourceDatabaseName": ...,
"SourceTableName": ...,
"NewTableName": ...,
}
parent.restore_table_from_cluster_snapshot(**kwargs)resume_cluster#
Resumes a paused cluster.
Type annotations and code completion for boto3.client("redshift").resume_cluster method.
boto3 documentation
# resume_cluster method definition
def resume_cluster(
self,
*,
ClusterIdentifier: str,
) -> ResumeClusterResultTypeDef: # (1)
...# resume_cluster method usage example with argument unpacking
kwargs: ResumeClusterMessageRequestTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.resume_cluster(**kwargs)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
# revoke_cluster_security_group_ingress method definition
def revoke_cluster_security_group_ingress(
self,
*,
ClusterSecurityGroupName: str,
CIDRIP: str = ...,
EC2SecurityGroupName: str = ...,
EC2SecurityGroupOwnerId: str = ...,
) -> RevokeClusterSecurityGroupIngressResultTypeDef: # (1)
...# revoke_cluster_security_group_ingress method usage example with argument unpacking
kwargs: RevokeClusterSecurityGroupIngressMessageTypeDef = { # (1)
"ClusterSecurityGroupName": ...,
}
parent.revoke_cluster_security_group_ingress(**kwargs)revoke_endpoint_access#
Revokes access to a cluster.
Type annotations and code completion for boto3.client("redshift").revoke_endpoint_access method.
boto3 documentation
# revoke_endpoint_access method definition
def revoke_endpoint_access(
self,
*,
ClusterIdentifier: str = ...,
Account: str = ...,
VpcIds: Sequence[str] = ...,
Force: bool = ...,
) -> EndpointAuthorizationResponseTypeDef: # (1)
...# revoke_endpoint_access method usage example with argument unpacking
kwargs: RevokeEndpointAccessMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.revoke_endpoint_access(**kwargs)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
# revoke_snapshot_access method definition
def revoke_snapshot_access(
self,
*,
AccountWithRestoreAccess: str,
SnapshotIdentifier: str = ...,
SnapshotArn: str = ...,
SnapshotClusterIdentifier: str = ...,
) -> RevokeSnapshotAccessResultTypeDef: # (1)
...# revoke_snapshot_access method usage example with argument unpacking
kwargs: RevokeSnapshotAccessMessageTypeDef = { # (1)
"AccountWithRestoreAccess": ...,
}
parent.revoke_snapshot_access(**kwargs)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
# rotate_encryption_key method definition
def rotate_encryption_key(
self,
*,
ClusterIdentifier: str,
) -> RotateEncryptionKeyResultTypeDef: # (1)
...# rotate_encryption_key method usage example with argument unpacking
kwargs: RotateEncryptionKeyMessageTypeDef = { # (1)
"ClusterIdentifier": ...,
}
parent.rotate_encryption_key(**kwargs)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
# update_partner_status method definition
def update_partner_status(
self,
*,
AccountId: str,
ClusterIdentifier: str,
DatabaseName: str,
PartnerName: str,
Status: PartnerIntegrationStatusType, # (1)
StatusMessage: str = ...,
) -> PartnerIntegrationOutputMessageTypeDef: # (2)
...# update_partner_status method usage example with argument unpacking
kwargs: UpdatePartnerStatusInputMessageTypeDef = { # (1)
"AccountId": ...,
"ClusterIdentifier": ...,
"DatabaseName": ...,
"PartnerName": ...,
"Status": ...,
}
parent.update_partner_status(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("redshift").get_paginator method with overloads.
client.get_paginator("describe_cluster_db_revisions")-> DescribeClusterDbRevisionsPaginatorclient.get_paginator("describe_cluster_parameter_groups")-> DescribeClusterParameterGroupsPaginatorclient.get_paginator("describe_cluster_parameters")-> DescribeClusterParametersPaginatorclient.get_paginator("describe_cluster_security_groups")-> DescribeClusterSecurityGroupsPaginatorclient.get_paginator("describe_cluster_snapshots")-> DescribeClusterSnapshotsPaginatorclient.get_paginator("describe_cluster_subnet_groups")-> DescribeClusterSubnetGroupsPaginatorclient.get_paginator("describe_cluster_tracks")-> DescribeClusterTracksPaginatorclient.get_paginator("describe_cluster_versions")-> DescribeClusterVersionsPaginatorclient.get_paginator("describe_clusters")-> DescribeClustersPaginatorclient.get_paginator("describe_custom_domain_associations")-> DescribeCustomDomainAssociationsPaginatorclient.get_paginator("describe_data_shares_for_consumer")-> DescribeDataSharesForConsumerPaginatorclient.get_paginator("describe_data_shares_for_producer")-> DescribeDataSharesForProducerPaginatorclient.get_paginator("describe_data_shares")-> DescribeDataSharesPaginatorclient.get_paginator("describe_default_cluster_parameters")-> DescribeDefaultClusterParametersPaginatorclient.get_paginator("describe_endpoint_access")-> DescribeEndpointAccessPaginatorclient.get_paginator("describe_endpoint_authorization")-> DescribeEndpointAuthorizationPaginatorclient.get_paginator("describe_event_subscriptions")-> DescribeEventSubscriptionsPaginatorclient.get_paginator("describe_events")-> DescribeEventsPaginatorclient.get_paginator("describe_hsm_client_certificates")-> DescribeHsmClientCertificatesPaginatorclient.get_paginator("describe_hsm_configurations")-> DescribeHsmConfigurationsPaginatorclient.get_paginator("describe_inbound_integrations")-> DescribeInboundIntegrationsPaginatorclient.get_paginator("describe_integrations")-> DescribeIntegrationsPaginatorclient.get_paginator("describe_node_configuration_options")-> DescribeNodeConfigurationOptionsPaginatorclient.get_paginator("describe_orderable_cluster_options")-> DescribeOrderableClusterOptionsPaginatorclient.get_paginator("describe_redshift_idc_applications")-> DescribeRedshiftIdcApplicationsPaginatorclient.get_paginator("describe_reserved_node_exchange_status")-> DescribeReservedNodeExchangeStatusPaginatorclient.get_paginator("describe_reserved_node_offerings")-> DescribeReservedNodeOfferingsPaginatorclient.get_paginator("describe_reserved_nodes")-> DescribeReservedNodesPaginatorclient.get_paginator("describe_scheduled_actions")-> DescribeScheduledActionsPaginatorclient.get_paginator("describe_snapshot_copy_grants")-> DescribeSnapshotCopyGrantsPaginatorclient.get_paginator("describe_snapshot_schedules")-> DescribeSnapshotSchedulesPaginatorclient.get_paginator("describe_table_restore_status")-> DescribeTableRestoreStatusPaginatorclient.get_paginator("describe_tags")-> DescribeTagsPaginatorclient.get_paginator("describe_usage_limits")-> DescribeUsageLimitsPaginatorclient.get_paginator("get_reserved_node_exchange_configuration_options")-> GetReservedNodeExchangeConfigurationOptionsPaginatorclient.get_paginator("get_reserved_node_exchange_offerings")-> GetReservedNodeExchangeOfferingsPaginatorclient.get_paginator("list_recommendations")-> ListRecommendationsPaginator
get_waiter#
Type annotations and code completion for boto3.client("redshift").get_waiter method with overloads.
client.get_waiter("cluster_available")-> ClusterAvailableWaiterclient.get_waiter("cluster_deleted")-> ClusterDeletedWaiterclient.get_waiter("cluster_restored")-> ClusterRestoredWaiterclient.get_waiter("snapshot_available")-> SnapshotAvailableWaiter