Smaws_Client_Redshift.Typestype nonrec vpc_security_group_membership = {status : string_ option;The status of the VPC security group.
*)vpc_security_group_id : string_ option;The identifier of the VPC security group.
*)}Describes the members of a VPC security group.
type nonrec vpc_security_group_membership_list =
vpc_security_group_membership listtype nonrec vpc_security_group_id_list = string_ listtype nonrec vpc_identifier_list = string_ listtype nonrec network_interface = {ipv6_address : string_ option;The IPv6 address of the network interface within the subnet.
*)availability_zone : string_ option;The Availability Zone.
*)private_ip_address : string_ option;The IPv4 address of the network interface within the subnet.
*)subnet_id : string_ option;The subnet identifier.
*)network_interface_id : string_ option;The network interface identifier.
*)}Describes a network interface.
type nonrec network_interface_list = network_interface listtype nonrec vpc_endpoint = {network_interfaces : network_interface_list option;One or more network interfaces of the endpoint. Also known as an interface endpoint.
*)vpc_id : string_ option;The VPC identifier that the endpoint is associated.
*)vpc_endpoint_id : string_ option;The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
*)}The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
type nonrec vpc_endpoints_list = vpc_endpoint listtype nonrec value_string_list = string_ listtype nonrec long = Smaws_Lib.CoreTypes.Int64.ttype nonrec tag = {value : string_ option;The value for the resource tag.
*)key : string_ option;The key, or name, for the resource tag.
*)}A tag consisting of a name/value pair for a resource.
type nonrec tag_list = tag listtype nonrec usage_limit = {breach_action : usage_limit_breach_action option;The action that Amazon Redshift takes when the limit is reached. Possible values are:
period : usage_limit_period option;The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
amount : long option;The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).
*)limit_type : usage_limit_limit_type option;The type of limit. Depending on the feature type, this can be based on a time duration or data size.
*)feature_type : usage_limit_feature_type option;The Amazon Redshift feature to which the limit applies.
*)cluster_identifier : string_ option;The identifier of the cluster with a usage limit.
*)usage_limit_id : string_ option;The identifier of the usage limit.
*)}Describes a usage limit object for a cluster.
type nonrec usage_limits = usage_limit listThe usage limit identifier can't be found.
type nonrec usage_limit_list = {marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
usage_limits : usage_limits option;Contains the output from the DescribeUsageLimits action.
}The usage limit already exists.
type nonrec supported_operation = {operation_name : string_ option;A list of the supported operations.
*)}Describes the operations that are allowed on a maintenance track.
type nonrec supported_operation_list = supported_operation listtype nonrec update_target = {supported_operations : supported_operation_list option;A list of operations supported by the maintenance track.
*)database_version : string_ option;The cluster version for the new maintenance track.
*)maintenance_track_name : string_ option;The name of the new maintenance track.
*)}A maintenance track that you can switch the current track to.
type nonrec update_partner_status_input_message = {status_message : partner_integration_status_message option;The status message provided by the partner.
*)status : partner_integration_status;The value of the updated status.
*)partner_name : partner_integration_partner_name;The name of the partner whose integration status is being updated.
*)database_name : partner_integration_database_name;The name of the database whose partner integration status is being updated.
*)cluster_identifier : partner_integration_cluster_identifier;The cluster identifier of the cluster whose partner integration status is being updated.
*)account_id : partner_integration_account_id;The Amazon Web Services account ID that owns the cluster.
*)}The requested operation isn't supported.
The name of the partner was not found.
The ClusterIdentifier parameter does not refer to an existing cluster.
type nonrec partner_integration_output_message = {partner_name : partner_integration_partner_name option;The name of the partner that is authorized to send data.
*)database_name : partner_integration_database_name option;The name of the database that receives data from the partner.
*)}A request option was specified that is not supported.
The specified region is incorrect or does not exist.
Your account is not authorized to perform the requested operation.
type nonrec eligible_tracks_to_update_list = update_target listtype nonrec maintenance_track = {update_targets : eligible_tracks_to_update_list option;An array of UpdateTarget objects to update with the maintenance track.
database_version : string_ option;The version number for the cluster release.
*)maintenance_track_name : string_ option;The name of the maintenance track. Possible values are current and trailing.
}Defines a maintenance track that determines which Amazon Redshift version to apply during a maintenance window. If the value for MaintenanceTrack is current, the cluster is updated to the most recently certified maintenance release. If the value is trailing, the cluster is updated to the previously certified maintenance release.
type nonrec track_list = maintenance_track listtype nonrec track_list_message = {marker : string_ option;The starting point to return a set of response tracklist records. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
maintenance_tracks : track_list option;A list of maintenance tracks output by the DescribeClusterTracks operation.
}type nonrec tagged_resource = {resource_type : string_ option;The type of resource with which the tag is associated. Valid resource types are:
For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.
*)resource_name : string_ option;The Amazon Resource Name (ARN) with which the tag is associated, for example: arn:aws:redshift:us-east-2:123456789:cluster:t1.
tag : tag option;The tag for the resource.
*)}A tag and its associated resource.
type nonrec tagged_resource_list = tagged_resource listtype nonrec tagged_resource_list_message = {marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
tagged_resources : tagged_resource_list option;A list of tags with their associated resources.
*)}type nonrec tag_value_list = string_ listYou have exceeded the number of tags allowed.
type nonrec tag_key_list = string_ listtype nonrec long_optional = Smaws_Lib.CoreTypes.Int64.ttype nonrec table_restore_status = {new_table_name : string_ option;The name of the table to create as a result of the table restore request.
*)target_schema_name : string_ option;The name of the schema to restore the table to.
*)target_database_name : string_ option;The name of the database to restore the table to.
*)source_table_name : string_ option;The name of the source table being restored.
*)source_schema_name : string_ option;The name of the source schema that contains the table being restored.
*)source_database_name : string_ option;The name of the source database that contains the table being restored.
*)snapshot_identifier : string_ option;The identifier of the snapshot that the table is being restored from.
*)cluster_identifier : string_ option;The identifier of the Amazon Redshift cluster that the table is being restored to.
*)total_data_in_mega_bytes : long_optional option;The total amount of data to restore to the new table, in megabytes (MB).
*)progress_in_mega_bytes : long_optional option;The amount of data restored to the new table so far, in megabytes (MB).
*)request_time : t_stamp option;The time that the table restore request was made, in Universal Coordinated Time (UTC).
*)message : string_ option;A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.
status : table_restore_status_type option;A value that describes the current state of the table restore request.
Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS
table_restore_request_id : string_ option;The unique identifier for the table restore request.
*)}Describes the status of a RestoreTableFromClusterSnapshot operation.
type nonrec table_restore_status_list = table_restore_status listtype nonrec table_restore_status_message = {marker : string_ option;A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.
table_restore_status_details : table_restore_status_list option;A list of status details for one or more table restore requests.
*)}The specified TableRestoreRequestId value was not found.
The number of tables in the cluster exceeds the limit for the requested new cluster node type.
A list of supported platforms for orderable clusters.
type nonrec supported_platforms_list = supported_platform listThe value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.
An Amazon Redshift event notification subscription with the specified name does not exist.
An Amazon Redshift event with the specified event ID does not exist.
The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.
There is already an existing event notification subscription with the specified name.
type nonrec availability_zone = {supported_platforms : supported_platforms_list option;name : string_ option;The name of the availability zone.
*)}Describes an availability zone.
type nonrec subnet = {subnet_status : string_ option;The status of the subnet.
*)subnet_availability_zone : availability_zone option;subnet_identifier : string_ option;The identifier of the subnet.
*)}Describes a subnet.
type nonrec subnet_list = subnet listtype nonrec subnet_identifier_list = string_ listA specified subnet is already in use by another cluster.
The specified Amazon Redshift event source could not be found.
type nonrec source_ids_list = string_ listtype nonrec snapshot_sorting_entity = {sort_order : sort_by_order option;The order for listing the attributes.
*)attribute : snapshot_attribute_to_sort_by;The category for sorting the snapshots.
*)}Describes a sorting entity
type nonrec snapshot_sorting_entity_list = snapshot_sorting_entity listThe specified snapshot schedule is already being updated.
You have exceeded the quota of snapshot schedules.
We could not find the specified snapshot schedule.
type nonrec schedule_definition_list = string_ listtype nonrec scheduled_snapshot_time_list = t_stamp listtype nonrec cluster_associated_to_schedule = {schedule_association_state : schedule_state option;cluster_identifier : string_ option;}type nonrec associated_cluster_list = cluster_associated_to_schedule listtype nonrec snapshot_schedule = {associated_clusters : associated_cluster_list option;A list of clusters associated with the schedule. A maximum of 100 clusters is returned.
*)associated_cluster_count : integer_optional option;The number of clusters associated with the schedule.
*)next_invocations : scheduled_snapshot_time_list option;schedule_description : string_ option;The description of the schedule.
*)schedule_identifier : string_ option;A unique identifier for the schedule.
*)schedule_definitions : schedule_definition_list option;A list of ScheduleDefinitions.
*)}Describes a snapshot schedule. You can set a regular interval for creating snapshots of a cluster. You can also schedule snapshots for specific dates.
type nonrec snapshot_schedule_list = snapshot_schedule listThe specified snapshot schedule already exists.
type nonrec account_with_restore_access = {account_alias : string_ option;The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support.
account_id : string_ option;The identifier of an Amazon Web Services account authorized to restore a snapshot.
*)}Describes an Amazon Web Services account authorized to restore a snapshot.
type nonrec accounts_with_restore_access_list =
account_with_restore_access listtype nonrec restorable_node_type_list = string_ listtype nonrec snapshot = {snapshot_arn : string_ option;The Amazon Resource Name (ARN) of the snapshot.
*)master_password_secret_kms_key_id : string_ option;The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
*)master_password_secret_arn : string_ option;The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
*)snapshot_retention_start_time : t_stamp option;A timestamp representing the start of the retention period for the snapshot.
*)manual_snapshot_remaining_days : integer_optional option;The number of days until a manual snapshot will pass its retention period.
*)manual_snapshot_retention_period : integer_optional option;The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
*)maintenance_track_name : string_ option;The name of the maintenance track for the snapshot.
*)enhanced_vpc_routing : boolean_ option;An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
*)restorable_node_types : restorable_node_type_list option;The list of node types that this cluster snapshot is able to restore into.
*)source_region : string_ option;The source region from which the snapshot was copied.
*)elapsed_time_in_seconds : long option;The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
*)estimated_seconds_to_completion : long option;The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
current_backup_rate_in_mega_bytes_per_second : double option;The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
backup_progress_in_mega_bytes : double option;The number of megabytes that have been transferred to the snapshot backup.
*)actual_incremental_backup_size_in_mega_bytes : double option;The size of the incremental backup.
*)total_backup_size_in_mega_bytes : double option;The size of the complete set of backup data that would be used to restore the cluster.
*)owner_account : string_ option;For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
*)accounts_with_restore_access : accounts_with_restore_access_list option;A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
encrypted_with_hs_m : boolean_ option;A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
kms_key_id : string_ option;The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
*)encrypted : boolean_ option;If true, the data in the snapshot is encrypted at rest.
vpc_id : string_ option;The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
*)db_name : string_ option;The name of the database that was created when the cluster was created.
*)number_of_nodes : integer option;The number of nodes in the cluster.
*)node_type : string_ option;The node type of the nodes in the cluster.
*)snapshot_type : string_ option;The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".
engine_full_version : string_ option;The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.
*)cluster_version : string_ option;The version ID of the Amazon Redshift engine that is running on the cluster.
*)master_username : string_ option;The admin user name for the cluster.
*)cluster_create_time : t_stamp option;The time (UTC) when the cluster was originally created.
*)availability_zone : string_ option;The Availability Zone in which the cluster was created.
*)port : integer option;The port that the cluster is listening on.
*)status : string_ option;The snapshot status. The value of the status depends on the API operation used:
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".DeleteClusterSnapshot returns status as "deleted".snapshot_create_time : t_stamp option;The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
*)cluster_identifier : string_ option;The identifier of the cluster for which the snapshot was taken.
*)snapshot_identifier : string_ option;The snapshot identifier that is provided in the request.
*)}Describes a snapshot.
type nonrec snapshot_list = snapshot listtype nonrec snapshot_message = {snapshots : snapshot_list option;A list of Snapshot instances.
marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}Contains the output from the DescribeClusterSnapshots action.
type nonrec snapshot_identifier_list = string_ listtype nonrec snapshot_error_message = {failure_reason : string_ option;The text message describing the error.
*)failure_code : string_ option;The failure code for the error.
*)snapshot_cluster_identifier : string_ option;A unique identifier for the cluster.
*)snapshot_identifier : string_ option;A unique identifier for the snapshot returning the error.
*)}Describes the errors returned by a snapshot.
The Amazon Web Services account has exceeded the maximum number of snapshot copy grants in this region.
The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.
type nonrec snapshot_copy_grant = {kms_key_id : string_ option;The unique identifier of the encrypted symmetric key in Amazon Web Services KMS to which Amazon Redshift is granted permission.
*)snapshot_copy_grant_name : string_ option;The name of the snapshot copy grant.
*)}The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified encrypted symmetric key from Amazon Web Services KMS in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
type nonrec snapshot_copy_grant_list = snapshot_copy_grant listtype nonrec snapshot_copy_grant_message = {snapshot_copy_grants : snapshot_copy_grant_list option;The list of SnapshotCopyGrant objects.
marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
*)}The snapshot copy grant can't be created because a grant with the same name already exists.
Cross-region snapshot copy was temporarily disabled. Try your request again.
The cluster already has cross-region snapshot copy enabled.
The cluster already has cross-region snapshot copy disabled.
type nonrec lake_formation_scope_union = | LakeFormationQuery of lake_formation_queryThe Lake Formation scope.
*)A list of scopes set up for Lake Formation integration.
type nonrec lake_formation_service_integrations =
lake_formation_scope_union listtype nonrec s3_access_grants_scope_union = | ReadWriteAccess of read_write_accessThe S3 Access Grants scope.
*)A list of scopes set up for S3 Access Grants integration.
type nonrec s3_access_grants_service_integrations =
s3_access_grants_scope_union listA structure that defines the Amazon Redshift connect service integration scope.
type nonrec redshift_scope_union = | Connect of connectThe Amazon Redshift connect integration scope configuration. Defines authorization settings for Amazon Redshift connect service integration.
*)A union structure that defines the scope of Amazon Redshift service integrations. Contains configuration for different integration types such as Amazon Redshift.
type nonrec redshift_service_integrations = redshift_scope_union listtype nonrec service_integrations_union = | Redshift of redshift_service_integrationsA list of scopes set up for Amazon Redshift integration.
*)| S3AccessGrants of s3_access_grants_service_integrationsA list of scopes set up for S3 Access Grants integration.
*)| LakeFormation of lake_formation_service_integrationsA list of scopes set up for Lake Formation integration.
*)A list of service integrations.
type nonrec service_integration_list = service_integrations_union listtype nonrec serverless_identifier = {workgroup_identifier : string_;The unique identifier for the workgroup associated with the serverless namespace.
*)namespace_identifier : string_;The unique identifier for the serverless namespace.
*)}The identifier for a serverless namespace.
type nonrec cluster_node = {public_ip_address : string_ option;The public IP address of a node within a cluster.
*)private_ip_address : string_ option;The private IP address of a node within a cluster.
*)node_role : string_ option;Whether the node is a leader node or a compute node.
*)}The identifier of a node in a cluster.
type nonrec cluster_nodes_list = cluster_node listtype nonrec secondary_cluster_info = {cluster_nodes : cluster_nodes_list option;The nodes in the secondary compute unit.
*)availability_zone : string_ option;The name of the Availability Zone in which the secondary compute unit of the cluster is located.
*)}The AvailabilityZone and ClusterNodes information of the secondary compute unit.
type nonrec resize_cluster_message = {target_reserved_node_offering_id : string_ option;The identifier of the target reserved node offering.
*)reserved_node_id : string_ option;The identifier of the reserved node.
*)classic : boolean_optional option;A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic.
number_of_nodes : integer_optional option;The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.
*)node_type : string_ option;The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
*)cluster_type : string_ option;The new cluster type for the specified cluster.
*)cluster_identifier : string_;The unique identifier for the cluster to resize.
*)}Describes a resize cluster operation. For example, a scheduled action to run the ResizeCluster API operation.
type nonrec pause_cluster_message = {cluster_identifier : string_;The identifier of the cluster to be paused.
*)}Describes a pause cluster operation. For example, a scheduled action to run the PauseCluster API operation.
type nonrec resume_cluster_message = {cluster_identifier : string_;The identifier of the cluster to be resumed.
*)}Describes a resume cluster operation. For example, a scheduled action to run the ResumeCluster API operation.
type nonrec scheduled_action_type = {resume_cluster : resume_cluster_message option;An action that runs a ResumeCluster API operation.
pause_cluster : pause_cluster_message option;An action that runs a PauseCluster API operation.
resize_cluster : resize_cluster_message option;An action that runs a ResizeCluster API operation.
}The action type that specifies an Amazon Redshift API operation that is supported by the Amazon Redshift scheduler.
type nonrec scheduled_action_time_list = t_stamp listtype nonrec scheduled_action = {end_time : t_stamp option;The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
*)start_time : t_stamp option;The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
*)next_invocations : scheduled_action_time_list option;List of times when the scheduled action will run.
*)state : scheduled_action_state option;The state of the scheduled action. For example, DISABLED.
scheduled_action_description : string_ option;The description of the scheduled action.
*)iam_role : string_ option;The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.
*)schedule : string_ option;The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".
Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
target_action : scheduled_action_type option;A JSON format string of the Amazon Redshift API operation with input parameters.
"{\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".
scheduled_action_name : string_ option;The name of the scheduled action.
*)}Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift API operations on a schedule. For information about which API operations can be scheduled, see ScheduledActionType.
type nonrec scheduled_action_list = scheduled_action listtype nonrec scheduled_actions_message = {scheduled_actions : scheduled_action_list option;List of retrieved scheduled actions.
*)marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
}The action type specified for a scheduled action is not supported.
The quota for scheduled actions exceeded.
The scheduled action cannot be found.
type nonrec scheduled_action_filter = {values : value_string_list;List of values. Compare if the value (of type defined by Name) equals an item in the list of scheduled actions.
name : scheduled_action_filter_name;The type of element to filter.
*)}A set of elements to filter the returned scheduled actions.
type nonrec scheduled_action_filter_list = scheduled_action_filter listThe scheduled action already exists.
The definition you submitted is not supported.
An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.
You do not have permission to publish to the specified Amazon SNS topic.
Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.
type nonrec endpoint = {vpc_endpoints : vpc_endpoints_list option;Describes a connection endpoint.
*)port : integer option;The port that the database engine is listening on.
*)address : string_ option;The DNS address of the Cluster.
*)}Describes a connection endpoint.
type nonrec cluster_security_group_membership = {status : string_ option;The status of the cluster security group.
*)cluster_security_group_name : string_ option;The name of the cluster security group.
*)}Describes a cluster security group.
type nonrec cluster_security_group_membership_list =
cluster_security_group_membership listtype nonrec cluster_parameter_status = {parameter_apply_error_description : string_ option;The error that prevented the parameter from being applied to the database.
*)parameter_apply_status : string_ option;The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync: The parameter value is in sync with the database.pending-reboot: The parameter value will be applied after the cluster reboots.applying: The parameter value is being applied to the database.invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.parameter_name : string_ option;The name of the parameter.
*)}Describes the status of a parameter group.
type nonrec cluster_parameter_status_list = cluster_parameter_status listtype nonrec cluster_parameter_group_status = {cluster_parameter_status_list : cluster_parameter_status_list option;The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
*)parameter_apply_status : string_ option;The status of parameter updates.
*)parameter_group_name : string_ option;The name of the cluster parameter group.
*)}Describes the status of a parameter group.
type nonrec cluster_parameter_group_status_list =
cluster_parameter_group_status listtype nonrec pending_modified_values = {encryption_type : string_ option;The encryption type for a cluster. Possible values are: KMS and None.
*)maintenance_track_name : string_ option;The name of the maintenance track that the cluster will change to during the next maintenance window.
*)enhanced_vpc_routing : boolean_optional option;An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
*)publicly_accessible : boolean_optional option;The pending or in-progress change of the ability to connect to the cluster from the public network.
*)cluster_identifier : string_ option;The pending or in-progress change of the new identifier for the cluster.
*)automated_snapshot_retention_period : integer_optional option;The pending or in-progress change of the automated snapshot retention period.
*)cluster_version : string_ option;The pending or in-progress change of the service version.
*)cluster_type : string_ option;The pending or in-progress change of the cluster type.
*)number_of_nodes : integer_optional option;The pending or in-progress change of the number of nodes in the cluster.
*)node_type : string_ option;The pending or in-progress change of the cluster's node type.
*)master_user_password : sensitive_string option;The pending or in-progress change of the admin user password for the cluster.
*)}Describes cluster attributes that are in a pending state. A change to one or more the attributes was requested and is in progress or will be applied.
type nonrec restore_status = {estimated_time_to_completion_in_seconds : long option;The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 node types.
*)elapsed_time_in_seconds : long option;The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 node types.
*)progress_in_mega_bytes : long option;The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 node types.
*)snapshot_size_in_mega_bytes : long option;The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 node types.
*)current_restore_rate_in_mega_bytes_per_second : double option;The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 node types.
*)status : string_ option;The status of the restore action. Returns starting, restoring, completed, or failed.
*)}Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
type nonrec data_transfer_progress = {elapsed_time_in_seconds : long_optional option;Describes the number of seconds that have elapsed during the data transfer.
*)estimated_time_to_completion_in_seconds : long_optional option;Describes the estimated number of seconds remaining to complete the transfer.
*)data_transferred_in_mega_bytes : long option;Describes the total amount of data that has been transfered in MB's.
*)total_data_in_mega_bytes : long option;Describes the total amount of data to be transfered in megabytes.
*)current_rate_in_mega_bytes_per_second : double_optional option;Describes the data transfer rate in MB's per second.
*)status : string_ option;Describes the status of the cluster. While the transfer is in progress the status is transferringdata.
}Describes the status of a cluster while it is in the process of resizing with an incremental resize.
type nonrec hsm_status = {status : string_ option;Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
*)hsm_configuration_identifier : string_ option;Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
*)hsm_client_certificate_identifier : string_ option;Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
*)}Describes the status of changes to HSM settings.
type nonrec cluster_snapshot_copy_status = {snapshot_copy_grant_name : string_ option;The name of the snapshot copy grant.
*)manual_snapshot_retention_period : integer option;The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
*)retention_period : long option;The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
*)destination_region : string_ option;The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
*)}Returns the destination region and retention period that are configured for cross-region snapshot copy.
type nonrec elastic_ip_status = {status : string_ option;The status of the elastic IP (EIP) address.
*)elastic_ip : string_ option;The elastic IP (EIP) address for the cluster.
*)}Describes the status of the elastic IP (EIP) address.
type nonrec cluster_iam_role = {apply_status : string_ option;A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync: The role is available for use by the cluster.adding: The role is in the process of being associated with the cluster.removing: The role is in the process of being disassociated with the cluster.iam_role_arn : string_ option;The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.
}An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
type nonrec cluster_iam_role_list = cluster_iam_role listtype nonrec pending_actions_list = string_ listtype nonrec deferred_maintenance_window = {defer_maintenance_end_time : t_stamp option;A timestamp for the end of the time period when we defer maintenance.
*)defer_maintenance_start_time : t_stamp option;A timestamp for the beginning of the time period when we defer maintenance.
*)defer_maintenance_identifier : string_ option;A unique identifier for the maintenance window.
*)}Describes a deferred maintenance window
type nonrec deferred_maintenance_windows_list =
deferred_maintenance_window listtype nonrec resize_info = {allow_cancel_resize : boolean_ option;A boolean value indicating if the resize operation can be cancelled.
*)resize_type : string_ option;Returns the value ClassicResize.
}Describes a resize operation.
type nonrec aqua_configuration = {aqua_configuration_status : aqua_configuration_status option;This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
*)aqua_status : aqua_status option;This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
*)}The operation that uses this structure is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
type nonrec reserved_node_exchange_status = {target_reserved_node_count : integer option;The count of target reserved nodes in the cluster.
*)target_reserved_node_type : string_ option;The node type of the target reserved node, for example ra3.4xlarge.
*)target_reserved_node_offering_id : string_ option;The identifier of the target reserved node offering.
*)source_reserved_node_count : integer option;The source reserved-node count in the cluster.
*)source_reserved_node_type : string_ option;The source reserved-node type, for example ra3.4xlarge.
*)source_reserved_node_id : string_ option;The identifier of the source reserved node.
*)request_time : t_stamp option;A date and time that indicate when the reserved-node exchange was requested.
*)status : reserved_node_exchange_status_type option;The status of the reserved-node exchange request. Statuses include in-progress and requested.
*)reserved_node_exchange_request_id : string_ option;The identifier of the reserved-node exchange request.
*)}Reserved-node status details, such as the source reserved-node identifier, the target reserved-node identifier, the node type, the node count, and other details.
type nonrec cluster = {extra_compute_for_automatic_optimization : string_ option;A boolean value that, if true, indicates that the cluster allocates additional compute resources to run automatic optimization operations.
Default: false
*)catalog_arn : string_ option;The Amazon Resource Name (ARN) of the Glue data catalog associated with the cluster enabled with Amazon Redshift federated permissions.
*)lakehouse_registration_status : string_ option;The status of the lakehouse registration for the cluster. Indicates whether the cluster is successfully registered with Amazon Redshift federated permissions.
*)multi_az_secondary : secondary_cluster_info option;The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
*)multi_a_z : string_ option;A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
*)ip_address_type : string_ option;The IP address type for the cluster. Possible values are ipv4 and dualstack.
master_password_secret_kms_key_id : string_ option;The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
*)master_password_secret_arn : string_ option;The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
*)custom_domain_certificate_expiry_date : t_stamp option;The expiration date for the certificate associated with the custom domain name.
*)custom_domain_certificate_arn : string_ option;The certificate Amazon Resource Name (ARN) for the custom domain name.
*)custom_domain_name : string_ option;The custom domain name associated with the cluster.
*)reserved_node_exchange_status : reserved_node_exchange_status option;The status of the reserved-node exchange request. Statuses include in-progress and requested.
*)default_iam_role_arn : string_ option;The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
*)aqua_configuration : aqua_configuration option;This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
*)total_storage_capacity_in_mega_bytes : long_optional option;The total storage capacity of the cluster in megabytes.
*)cluster_namespace_arn : string_ option;The namespace Amazon Resource Name (ARN) of the cluster.
*)availability_zone_relocation_status : string_ option;Describes the status of the Availability Zone relocation operation.
*)resize_info : resize_info option;Returns the following:
next_maintenance_window_start_time : t_stamp option;The date and time in UTC when system maintenance can begin.
*)expected_next_snapshot_schedule_time_status : string_ option;The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
expected_next_snapshot_schedule_time : t_stamp option;The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
*)snapshot_schedule_state : schedule_state option;The current state of the cluster snapshot schedule.
*)snapshot_schedule_identifier : string_ option;A unique identifier for the cluster snapshot schedule.
*)deferred_maintenance_windows : deferred_maintenance_windows_list option;Describes a group of DeferredMaintenanceWindow objects.
elastic_resize_number_of_node_options : string_ option;The number of nodes that you can resize the cluster to with the elastic resize method.
*)maintenance_track_name : string_ option;The name of the maintenance track for the cluster.
*)pending_actions : pending_actions_list option;Cluster operations that are waiting to be started.
*)iam_roles : cluster_iam_role_list option;A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
*)enhanced_vpc_routing : boolean_ option;An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
*)kms_key_id : string_ option;The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
*)cluster_revision_number : string_ option;The specific revision number of the database in the cluster.
*)elastic_ip_status : elastic_ip_status option;The status of the elastic IP (EIP) address.
*)cluster_nodes : cluster_nodes_list option;The nodes in the cluster.
*)cluster_public_key : string_ option;The public key for the cluster.
*)cluster_snapshot_copy_status : cluster_snapshot_copy_status option;A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
*)hsm_status : hsm_status option;A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.
Values: active, applying
*)data_transfer_progress : data_transfer_progress option;restore_status : restore_status option;A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
*)encrypted : boolean_ option;A boolean value that, if true, indicates that data in the cluster is encrypted at rest.
publicly_accessible : boolean_ option;A boolean value that, if true, indicates that the cluster can be accessed from a public network.
Default: false
*)number_of_nodes : integer option;The number of compute nodes in the cluster.
*)allow_version_upgrade : boolean_ option;A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
cluster_version : string_ option;The version ID of the Amazon Redshift engine that is running on the cluster.
*)pending_modified_values : pending_modified_values option;A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
*)preferred_maintenance_window : string_ option;The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
*)availability_zone : string_ option;The name of the Availability Zone in which the cluster is located.
*)vpc_id : string_ option;The identifier of the VPC the cluster is in, if the cluster is in a VPC.
*)cluster_subnet_group_name : string_ option;The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
*)cluster_parameter_groups : cluster_parameter_group_status_list option;The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
*)vpc_security_groups : vpc_security_group_membership_list option;A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
*)cluster_security_groups : cluster_security_group_membership_list option;A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
*)manual_snapshot_retention_period : integer option;The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
*)automated_snapshot_retention_period : integer option;The number of days that automatic cluster snapshots are retained.
*)cluster_create_time : t_stamp option;The date and time that the cluster was created.
*)endpoint : endpoint option;The connection endpoint.
*)db_name : string_ option;The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.
master_username : string_ option;The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
*)modify_status : string_ option;The status of a modify operation, if any, initiated for the cluster.
*)cluster_availability_status : string_ option;The availability status of the cluster for queries. Possible values are the following:
cluster_status : string_ option;The current state of the cluster. Possible values are the following:
availableavailable, prep-for-resizeavailable, resize-cleanupcancelling-resizecreatingdeletingfinal-snapshothardware-failureincompatible-hsmincompatible-networkincompatible-parametersincompatible-restoremodifyingpausedrebootingrenamingresizingrotating-keysstorage-fullupdating-hsmnode_type : string_ option;The node type for the nodes in the cluster.
*)cluster_identifier : string_ option;The unique identifier of the cluster.
*)}Describes a cluster.
type nonrec rotate_encryption_key_message = {cluster_identifier : string_;The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.
*)}The specified cluster is not in the available state.
The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
type nonrec revoke_snapshot_access_message = {account_with_restore_access : string_;The identifier of the Amazon Web Services account that can no longer restore the specified snapshot.
*)snapshot_cluster_identifier : string_ option;The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
*)snapshot_arn : string_ option;The Amazon Resource Name (ARN) of the snapshot associated with the message to revoke access.
*)snapshot_identifier : string_ option;The identifier of the snapshot that the account can no longer access.
*)}The snapshot identifier does not refer to an existing cluster snapshot.
The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.
The owner of the specified snapshot has not authorized your account to access the snapshot.
type nonrec revoke_endpoint_access_message = {force : boolean_ option;Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
*)vpc_ids : vpc_identifier_list option;The virtual private cloud (VPC) identifiers for which access is to be revoked.
*)account : string_ option;The Amazon Web Services account ID whose access is to be revoked.
*)cluster_identifier : string_ option;The cluster to revoke access from.
*)}The status of the endpoint is not valid.
The state of the cluster security group is not available.
The endpoint name doesn't refer to an existing endpoint.
The authorization for this endpoint can't be found.
Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across Amazon Web Services accounts.
type nonrec ec2_security_group = {ec2_security_group_owner_id : string_ option;The Amazon Web Services account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
ec2_security_group_name : string_ option;The name of the EC2 Security Group.
*)status : string_ option;The status of the EC2 security group.
*)}Describes an Amazon EC2 security group.
type nonrec ec2_security_group_list = ec2_security_group listtype nonrec ip_range = {cidri_p : string_ option;The IP range in Classless Inter-Domain Routing (CIDR) notation.
*)status : string_ option;The status of the IP range, for example, "authorized".
*)}Describes an IP range used in a security group.
type nonrec ip_range_list = ip_range listtype nonrec cluster_security_group = {ip_ranges : ip_range_list option;A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.
*)ec2_security_groups : ec2_security_group_list option;A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.
*)description : string_ option;A description of the security group.
*)cluster_security_group_name : string_ option;The name of the cluster security group to which the operation was applied.
*)}Describes a security group.
type nonrec revoke_cluster_security_group_ingress_result = {cluster_security_group : cluster_security_group option;}type nonrec revoke_cluster_security_group_ingress_message = {ec2_security_group_owner_id : string_ option;The Amazon Web Services account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.
Example: 111122223333
ec2_security_group_name : string_ option;The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.
cidri_p : string_ option;The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
cluster_security_group_name : string_;The name of the security Group from which to revoke the ingress rule.
*)}The cluster security group name does not refer to an existing cluster security group.
type nonrec revision_target = {database_revision_release_date : t_stamp option;The date on which the database revision was released.
*)description : string_ option;A string that describes the changes and features that will be applied to the cluster when it is updated to the corresponding ClusterDbRevision.
database_revision : string_ option;A unique string that identifies the version to update the cluster to. You can use this value in ModifyClusterDbRevision.
}Describes a RevisionTarget.
type nonrec revision_targets_list = revision_target listThe number of nodes specified exceeds the allotted capacity of the cluster.
type nonrec restore_table_from_cluster_snapshot_result = {table_restore_status : table_restore_status option;}type nonrec restore_table_from_cluster_snapshot_message = {enable_case_sensitive_identifier : boolean_optional option;Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false (default), the names are not case sensitive.
new_table_name : string_;The name of the table to create as a result of the current request.
*)target_schema_name : string_ option;The name of the schema to restore the table to.
*)target_database_name : string_ option;The name of the database to restore the table to.
*)source_table_name : string_;The name of the source table to restore from.
*)source_schema_name : string_ option;The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.
source_database_name : string_;The name of the source database that contains the table to restore from.
*)snapshot_identifier : string_;The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
cluster_identifier : string_;The identifier of the Amazon Redshift cluster to restore the table to.
*)}The value specified for the sourceDatabaseName, sourceSchemaName, or sourceTableName parameter, or a combination of these, doesn't exist in the snapshot.
The specified cluster snapshot is not in the available state, or other accounts are authorized to access the snapshot.
You have exceeded the allowed number of table restore requests. Wait for your current table restore requests to complete before making a new request.
type nonrec cluster_security_group_name_list = string_ listtype nonrec iam_role_arn_list = string_ listtype nonrec restore_from_cluster_snapshot_message = {redshift_idc_application_arn : string_ option;The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions.
*)catalog_name : catalog_name_string option;The name of the Glue Data Catalog that will be associated with the cluster enabled with Amazon Redshift federated permissions.
Constraints:
Pattern: ^[a-z0-9_-]*[a-z]+[a-z0-9_-]*$
Example: my-catalog_01
multi_a_z : boolean_optional option;If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
*)ip_address_type : string_ option;The IP address type for the cluster. Possible values are ipv4 and dualstack.
master_password_secret_kms_key_id : string_ option;The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.
manage_master_password : boolean_optional option;If true, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. If ManageMasterPassword is false or not set, Amazon Redshift uses the admin credentials the cluster had at the time the snapshot was taken.
encrypted : boolean_optional option;Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.
*)target_reserved_node_offering_id : string_ option;The identifier of the target reserved node offering.
*)reserved_node_id : string_ option;The identifier of the target reserved node offering.
*)default_iam_role_arn : string_ option;The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.
*)aqua_configuration_status : aqua_configuration_status option;This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
*)availability_zone_relocation : boolean_optional option;The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
*)number_of_nodes : integer_optional option;The number of nodes specified when provisioning the restored cluster.
*)snapshot_schedule_identifier : string_ option;A unique identifier for the snapshot schedule.
*)maintenance_track_name : string_ option;The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.
iam_roles : iam_role_arn_list option;A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
*)additional_info : string_ option;Reserved.
*)enhanced_vpc_routing : boolean_optional option;An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
*)node_type : string_ option;The node type that the restored cluster will be provisioned with.
If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc2.large node type into another dc2 type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
*)kms_key_id : string_ option;The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.
*)manual_snapshot_retention_period : integer_optional option;The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
*)automated_snapshot_retention_period : integer_optional option;The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
You can't disable automated snapshots for RG or RA3 node types. Set the automated retention period from 1-35 days.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
*)preferred_maintenance_window : string_ option;The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
*)vpc_security_group_ids : vpc_security_group_id_list option;A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Default: The default VPC security group is associated with the cluster.
VPC security groups only apply to clusters in VPCs.
*)cluster_security_groups : cluster_security_group_name_list option;A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
*)cluster_parameter_group_name : string_ option;The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
elastic_ip : string_ option;The Elastic IP (EIP) address for the cluster. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on.
*)hsm_configuration_identifier : string_ option;Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
*)hsm_client_certificate_identifier : string_ option;Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
*)owner_account : string_ option;The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
*)publicly_accessible : boolean_optional option;If true, the cluster can be accessed from a public network.
Default: false
*)cluster_subnet_group_name : string_ option;The name of the subnet group where you want to cluster restored.
A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
*)allow_version_upgrade : boolean_optional option;If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
Default: true
availability_zone : string_ option;The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-2a
port : integer_optional option;The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Valid values: For clusters with DC2 nodes, must be within the range 1150-65535. For clusters with RG or RA3 nodes, must be within the ranges 5431-5455 or 8191-8215.
snapshot_cluster_identifier : string_ option;The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
*)snapshot_arn : string_ option;The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must specify this parameter or snapshotIdentifier, but not both.
snapshot_identifier : string_ option;The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must specify this parameter or snapshotArn, but not both.
Example: my-snapshot-id
cluster_identifier : string_;The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
}Specified offering does not exist.
The specified reserved compute node not found.
Indicates that the reserved node has already been exchanged.
User already has a reservation with the given identifier.
The application you attempted to find doesn't exist.
The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
type nonrec number_of_nodes_per_cluster_limit_exceeded_fault = {message : exception_message option;}The operation would exceed the number of nodes allowed for a cluster.
The encryption key has exceeded its grant limit in Amazon Web Services KMS.
There are no subnets in your VPC with associated IPv6 CIDR blocks. To use dual-stack mode, associate an IPv6 CIDR block with each subnet in your VPC.
The cluster subnet group does not cover all Availability Zones.
The tag is invalid.
The requested subnet is not valid, or not all of the subnets are in the same VPC.
The restore is invalid.
Indicates that the Reserved Node being exchanged is not in an active state.
The Elastic IP (EIP) is invalid or cannot be found.
The provided cluster track name is not valid.
The cluster subnet group cannot be deleted because it is in use.
There is no Amazon Redshift HSM configuration with the specified identifier.
There is no Amazon Redshift HSM client certificate with the specified identifier.
Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
A dependent service denied access for the integration.
The cluster subnet group name does not refer to an existing cluster subnet group.
The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
The parameter group name does not refer to an existing parameter group.
The account already has a cluster with the given identifier.
type nonrec resource_policy = {policy : string_ option;The content of a resource policy.
*)resource_arn : string_ option;The resources that a policy is attached to.
*)}The policy that is attached to a resource.
The resource could not be found.
type nonrec import_tables_completed = string_ listtype nonrec import_tables_in_progress = string_ listtype nonrec import_tables_not_started = string_ listtype nonrec resize_progress_message = {data_transfer_progress_percent : double_optional option;The percent of data transferred from source cluster to target cluster.
*)target_encryption_type : string_ option;The type of encryption for the cluster after the resize is complete.
Possible values are KMS and None.
message : string_ option;An optional string to provide additional details about the resize action.
*)resize_type : string_ option;An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.
estimated_time_to_completion_in_seconds : long_optional option;The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.
*)elapsed_time_in_seconds : long_optional option;The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.
*)progress_in_mega_bytes : long_optional option;While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).
*)total_resize_data_in_mega_bytes : long_optional option;The estimated total amount of data, in megabytes, on the cluster before the resize operation began.
*)avg_resize_rate_in_mega_bytes_per_second : double_optional option;The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.
*)import_tables_not_started : import_tables_not_started option;The names of tables that have not been yet imported.
Valid Values: List of table names
*)import_tables_in_progress : import_tables_in_progress option;The names of tables that are being currently imported.
Valid Values: List of table names.
*)import_tables_completed : import_tables_completed option;The names of tables that have been completely imported .
Valid Values: List of table names.
*)status : string_ option;The status of the resize operation.
Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING
target_cluster_type : string_ option;The cluster type after the resize operation is complete.
Valid Values: multi-node | single-node
target_number_of_nodes : integer_optional option;The number of nodes that the cluster will have after the resize operation is complete.
*)target_node_type : string_ option;The node type that the cluster will have after the resize operation is complete.
*)}Describes the result of a cluster resize operation.
A resize operation for the specified cluster is not found.
type nonrec parameter = {minimum_engine_version : string_ option;The earliest engine version to which the parameter can apply.
*)is_modifiable : boolean_ option;If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
apply_type : parameter_apply_type option;Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
*)allowed_values : string_ option;The valid range of values for the parameter.
*)data_type : string_ option;The data type of the parameter.
*)source : string_ option;The source of the parameter value, such as "engine-default" or "user".
*)description : string_ option;A description of the parameter.
*)parameter_value : string_ option;The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.
parameter_name : string_ option;The name of the parameter.
*)}Describes a parameter in a cluster parameter group.
type nonrec parameters_list = parameter listtype nonrec reset_cluster_parameter_group_message = {parameters : parameters_list option;An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.
Constraints: A maximum of 20 parameters can be reset in a single request.
*)reset_all_parameters : boolean_ option;If true, all parameters in the specified parameter group will be reset to their default values.
Default: true
parameter_group_name : string_;The name of the cluster parameter group to be reset.
*)}The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.
type nonrec cluster_parameter_group_name_message = {parameter_group_status : string_ option;The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.
*)parameter_group_name : string_ option;The name of the cluster parameter group.
*)}type nonrec recurring_charge = {recurring_charge_frequency : string_ option;The frequency at which the recurring charge amount is applied.
*)recurring_charge_amount : double option;The amount charged per the period of time specified by the recurring charge frequency.
*)}Describes a recurring charge.
type nonrec recurring_charge_list = recurring_charge listtype nonrec reserved_node = {reserved_node_offering_type : reserved_node_offering_type option;recurring_charges : recurring_charge_list option;The recurring charges for the reserved node.
*)offering_type : string_ option;The anticipated utilization of the reserved node, as defined in the reserved node offering.
*)state : string_ option;The state of the reserved compute node.
Possible Values:
node_count : integer option;The number of reserved compute nodes.
*)currency_code : string_ option;The currency code for the reserved cluster.
*)usage_price : double option;The hourly rate Amazon Redshift charges you for this reserved node.
*)fixed_price : double option;The fixed cost Amazon Redshift charges you for this reserved node.
*)duration : integer option;The duration of the node reservation in seconds.
*)start_time : t_stamp option;The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.
*)node_type : string_ option;The node type of the reserved node.
*)reserved_node_offering_id : string_ option;The identifier for the reserved node offering.
*)reserved_node_id : string_ option;The unique identifier for the reservation.
*)}Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.
type nonrec reserved_node_list = reserved_node listtype nonrec reserved_nodes_message = {reserved_nodes : reserved_node_list option;The list of ReservedNode objects.
marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
type nonrec reserved_node_offering = {reserved_node_offering_type : reserved_node_offering_type option;recurring_charges : recurring_charge_list option;The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.
*)offering_type : string_ option;The anticipated utilization of the reserved node, as defined in the reserved node offering.
*)currency_code : string_ option;The currency code for the compute nodes offering.
*)usage_price : double option;The rate you are charged for each hour the cluster that is using the offering is running.
*)fixed_price : double option;The upfront fixed charge you will pay to purchase the specific reserved node offering.
*)duration : integer option;The duration, in seconds, for which the offering will reserve the node.
*)node_type : string_ option;The node type offered by the reserved node offering.
*)reserved_node_offering_id : string_ option;The offering identifier.
*)}Describes a reserved node offering.
type nonrec reserved_node_offering_list = reserved_node_offering listtype nonrec reserved_node_offerings_message = {reserved_node_offerings : reserved_node_offering_list option;A list of ReservedNodeOffering objects.
marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}type nonrec reserved_node_exchange_status_list =
reserved_node_exchange_status listThe reserved-node exchange status wasn't found.
type nonrec reserved_node_configuration_option = {target_reserved_node_offering : reserved_node_offering option;target_reserved_node_count : integer option;The target reserved-node count.
*)source_reserved_node : reserved_node option;}Details for a reserved-node exchange. Examples include the node type for a reserved node, the price for a node, the node's state, and other details.
type nonrec reserved_node_configuration_option_list =
reserved_node_configuration_option listThere is an error with the datashare.
The association of a datashare from a producer account with a data consumer.
type nonrec register_namespace_output_message = {status : namespace_registration_status option;The registration status of the cluster or serverless namespace.
*)}type nonrec provisioned_identifier = {cluster_identifier : string_;The unique identifier for the provisioned cluster.
*)}The identifier for a provisioned cluster.
type nonrec namespace_identifier_union = | ProvisionedIdentifier of provisioned_identifierThe identifier for a provisioned cluster.
*)| ServerlessIdentifier of serverless_identifierThe identifier for a serverless namespace.
*)Object to store union of values for a provisioned cluster or serverless namespace’s identifier.
type nonrec consumer_identifier_list = string_ listtype nonrec register_namespace_input_message = {consumer_identifiers : consumer_identifier_list;An array containing the ID of the consumer account that you want to register the namespace to.
*)namespace_identifier : namespace_identifier_union;The unique identifier of the cluster or serverless namespace that you want to register.
*)}The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.
type nonrec reference_link = {link : string_ option;The URL address to find more information.
*)text : string_ option;The hyperlink text that describes the link to more information.
*)}A link to an Amazon Redshift Advisor reference for more information about a recommendation.
type nonrec reference_link_list = reference_link listThe resource policy isn't valid.
There is a conflict while updating the resource policy.
type nonrec put_resource_policy_result = {resource_policy : resource_policy option;The content of the updated resource policy.
*)}type nonrec purchase_reserved_node_offering_message = {node_count : integer_optional option;The number of reserved nodes that you want to purchase.
Default: 1
reserved_node_offering_id : string_;The unique identifier of the reserved node offering you want to purchase.
*)}The usage limit is not valid.
type nonrec modify_usage_limit_message = {breach_action : usage_limit_breach_action option;The new action that Amazon Redshift takes when the limit is reached. For more information about this parameter, see UsageLimit.
amount : long_optional option;The new limit amount. For more information about this parameter, see UsageLimit.
usage_limit_id : string_;The identifier of the usage limit to modify.
*)}The schedule you submitted isn't valid.
type nonrec modify_snapshot_schedule_message = {schedule_definitions : schedule_definition_list;An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".
*)schedule_identifier : string_;A unique alphanumeric identifier of the schedule to modify.
*)}The retention period specified is either in the past or is not a valid value.
The value must be either -1 or an integer between 1 and 3,653.
type nonrec modify_snapshot_copy_retention_period_message = {manual : boolean_ option;Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
*)retention_period : integer;The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
*)cluster_identifier : string_;The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination Amazon Web Services Region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
*)}The scheduled action is not valid.
type nonrec modify_scheduled_action_message = {enable : boolean_optional option;A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.
*)end_time : t_stamp option;A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.
start_time : t_stamp option;A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.
scheduled_action_description : string_ option;A modified description of the scheduled action.
*)iam_role : string_ option;A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
schedule : string_ option;A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.
target_action : scheduled_action_type option;A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.
scheduled_action_name : string_;The name of the scheduled action to modify.
*)}type nonrec authorized_audience_list = string_ listThe authorized token issuer for the Amazon Redshift IAM Identity Center application.
type nonrec authorized_token_issuer_list = authorized_token_issuer listtype nonrec redshift_idc_application = {sso_tag_keys : tag_key_list option;A list of tags keys that Redshift Identity Center applications copy to IAM Identity Center. For each input key, the tag corresponding to the key-value pair is propagated.
*)application_type : application_type option;The type of application being created. Valid values are None or Lakehouse. Use Lakehouse to enable Amazon Redshift federated permissions on cluster.
service_integrations : service_integration_list option;A list of service integrations for the Redshift IAM Identity Center application.
*)idc_onboard_status : string_ option;The onboarding status for the Amazon Redshift IAM Identity Center application.
*)idc_managed_application_arn : string_ option;The ARN for the Amazon Redshift IAM Identity Center application.
*)iam_role_arn : string_ option;The ARN for the Amazon Redshift IAM Identity Center application. It has the required permissions to be assumed and invoke the IDC Identity Center API.
*)idc_display_name : idc_display_name_string option;The display name for the Amazon Redshift IAM Identity Center application. It appears on the console.
*)identity_namespace : identity_namespace_string option;The identity namespace for the Amazon Redshift IAM Identity Center application. It determines which managed application verifies the connection token.
*)redshift_idc_application_arn : string_ option;The ARN for the Redshift application that integrates with IAM Identity Center.
*)redshift_idc_application_name : redshift_idc_application_name option;The name of the Redshift application in IAM Identity Center.
*)idc_instance_arn : string_ option;The ARN for the IAM Identity Center instance that Redshift integrates with.
*)}Contains properties for the Redshift IDC application.
type nonrec modify_redshift_idc_application_result = {redshift_idc_application : redshift_idc_application option;}type nonrec modify_redshift_idc_application_message = {service_integrations : service_integration_list option;A collection of service integrations associated with the application.
*)idc_display_name : idc_display_name_string option;The display name for the Amazon Redshift IAM Identity Center application to change. It appears on the console.
*)iam_role_arn : string_ option;The IAM role ARN associated with the Amazon Redshift IAM Identity Center application to change. It has the required permissions to be assumed and invoke the IDC Identity Center API.
*)identity_namespace : identity_namespace_string option;The namespace for the Amazon Redshift IAM Identity Center application to change. It determines which managed application verifies the connection token.
*)redshift_idc_application_arn : string_;The ARN for the Redshift application that integrates with IAM Identity Center.
*)}type nonrec lakehouse_configuration = {catalog_arn : string_ option;The Amazon Resource Name (ARN) of the Glue data catalog associated with the lakehouse configuration.
*)lakehouse_registration_status : string_ option;The current status of the lakehouse registration. Indicates whether the cluster is successfully registered with the lakehouse.
*)lakehouse_idc_application_arn : string_ option;The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions.
*)cluster_identifier : string_ option;The unique identifier of the cluster associated with this lakehouse configuration.
*)}Contains configuration information for lakehouse integration, including the cluster identifier, catalog ARN, and registration status.
type nonrec modify_lakehouse_configuration_message = {dry_run : boolean_optional option;A boolean value that, if true, validates the request without actually modifying the lakehouse configuration. Use this to check for errors before making changes.
lakehouse_idc_application_arn : string_ option;The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions.
*)lakehouse_idc_registration : lakehouse_idc_registration option;Modifies the Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions. Valid values are Associate or Disassociate.
catalog_name : catalog_name_string option;The name of the Glue data catalog that will be associated with the cluster enabled with Amazon Redshift federated permissions.
Constraints:
Pattern: ^[a-z0-9_-]*[a-z]+[a-z0-9_-]*$
Example: my-catalog_01
lakehouse_registration : lakehouse_registration option;Specifies whether to register or deregister the cluster with Amazon Redshift federated permissions. Valid values are Register or Deregister.
cluster_identifier : string_;The unique identifier of the cluster whose lakehouse configuration you want to modify.
*)}The integration can't be found.
The integration is in an invalid state and can't perform the requested operation.
A conflicting conditional operation is currently in progress against this resource. This typically occurs when there are multiple requests being made to the same resource at the same time, and these requests conflict with each other.
The integration you are trying to create already exists.
type nonrec integration_error = {error_message : string_ option;The error message of an inbound integration error.
*)error_code : string_;The error code of an inbound integration error.
*)}The error of an inbound integration.
type nonrec integration_error_list = integration_error listtype nonrec integration = {additional_encryption_context : encryption_context_map option;The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
*)kms_key_id : string_ option;The Key Management Service (KMS) key identifier for the key used to encrypt the integration.
*)description : description option;The description of the integration.
*)create_time : t_stamp option;The time (UTC) when the integration was created.
*)errors : integration_error_list option;Any errors associated with the integration.
*)status : zero_etl_integration_status option;The current status of the integration.
*)target_arn : target_arn option;The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.
*)source_arn : source_arn option;The Amazon Resource Name (ARN) of the database used as the source for replication.
*)integration_name : integration_name option;The name of the integration.
*)integration_arn : integration_arn option;The Amazon Resource Name (ARN) of the integration.
*)}type nonrec modify_integration_message = {integration_name : integration_name option;A new name for the integration.
*)description : integration_description option;A new description for the integration.
*)integration_arn : integration_arn;The unique identifier of the integration to modify.
*)}The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.
type nonrec event_categories_list = string_ listtype nonrec event_subscription = {enabled : boolean_ option;A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled.
severity : string_ option;The event severity specified in the Amazon Redshift event notification subscription.
Values: ERROR, INFO
*)event_categories_list : event_categories_list option;The list of Amazon Redshift event categories specified in the event notification subscription.
Values: Configuration, Management, Monitoring, Security, Pending
*)source_ids_list : source_ids_list option;A list of the sources that publish events to the Amazon Redshift event notification subscription.
*)source_type : string_ option;The source type of the events returned by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.
*)subscription_creation_time : t_stamp option;The date and time the Amazon Redshift event notification subscription was created.
*)status : string_ option;The status of the Amazon Redshift event notification subscription.
Constraints:
sns_topic_arn : string_ option;The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.
*)cust_subscription_id : string_ option;The name of the Amazon Redshift event notification subscription.
*)customer_aws_id : string_ option;The Amazon Web Services account associated with the Amazon Redshift event notification subscription.
*)}Describes event subscriptions.
type nonrec modify_event_subscription_message = {enabled : boolean_optional option;A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled
severity : string_ option;Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
*)event_categories : event_categories_list option;Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security, pending
*)source_ids : source_ids_list option;A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
*)source_type : string_ option;The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
*)sns_topic_arn : string_ option;The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.
*)subscription_name : string_;The name of the modified Amazon Redshift event notification subscription.
*)}type nonrec endpoint_access = {vpc_endpoint : vpc_endpoint option;vpc_security_groups : vpc_security_group_membership_list option;The security groups associated with the endpoint.
*)address : string_ option;The DNS address of the endpoint.
*)port : integer option;The port number on which the cluster accepts incoming connections.
*)endpoint_create_time : t_stamp option;The time (UTC) that the endpoint was created.
*)endpoint_name : string_ option;The name of the endpoint.
*)endpoint_status : string_ option;The status of the endpoint.
*)subnet_group_name : string_ option;The subnet group name where Amazon Redshift chooses to deploy the endpoint.
*)resource_owner : string_ option;The Amazon Web Services account ID of the owner of the cluster.
*)cluster_identifier : string_ option;The cluster identifier of the cluster associated with the endpoint.
*)}Describes a Redshift-managed VPC endpoint.
type nonrec modify_endpoint_access_message = {vpc_security_group_ids : vpc_security_group_id_list option;The complete list of VPC security groups associated with the endpoint after the endpoint is modified.
*)endpoint_name : string_;The endpoint to be modified.
*)}An error occurred. The custom domain name couldn't be found.
An error occurred when an attempt was made to change the custom domain association.
type nonrec modify_custom_domain_association_result = {custom_domain_cert_expiry_time : string_ option;The certificate expiration time associated with the result for the changed custom domain association.
*)cluster_identifier : string_ option;The identifier of the cluster associated with the result for the changed custom domain association.
*)custom_domain_certificate_arn : custom_domain_certificate_arn_string option;The certificate Amazon Resource Name (ARN) associated with the result for the changed custom domain association.
*)custom_domain_name : custom_domain_name_string option;The custom domain name associated with the result for the changed custom domain association.
*)}type nonrec modify_custom_domain_association_message = {cluster_identifier : string_;The identifier of the cluster to change a custom domain association for.
*)custom_domain_certificate_arn : custom_domain_certificate_arn_string;The certificate Amazon Resource Name (ARN) for the changed custom domain association.
*)custom_domain_name : custom_domain_name_string;The custom domain name for a changed custom domain association.
*)}The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
type nonrec cluster_subnet_group = {supported_cluster_ip_address_types : value_string_list option;The IP address types supported by this cluster subnet group. Possible values are ipv4 and dualstack.
subnets : subnet_list option;A list of the VPC Subnet elements.
subnet_group_status : string_ option;The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.
vpc_id : string_ option;The VPC ID of the cluster subnet group.
*)description : string_ option;The description of the cluster subnet group.
*)cluster_subnet_group_name : string_ option;The name of the cluster subnet group.
*)}Describes a subnet group.
type nonrec modify_cluster_subnet_group_result = {cluster_subnet_group : cluster_subnet_group option;}type nonrec modify_cluster_subnet_group_message = {subnet_ids : subnet_identifier_list;An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
*)description : string_ option;A text description of the subnet group to be modified.
*)cluster_subnet_group_name : string_;The name of the subnet group to be modified.
*)}The cluster snapshot schedule state is not valid.
type nonrec modify_cluster_snapshot_schedule_message = {disassociate_schedule : boolean_optional option;A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.
*)schedule_identifier : string_ option;A unique alphanumeric identifier for the schedule that you want to associate with the cluster.
*)cluster_identifier : string_;A unique identifier for the cluster whose snapshot schedule you want to modify.
*)}type nonrec modify_cluster_snapshot_message = {force : boolean_ option;A Boolean option to override an exception if the retention period has already passed.
*)manual_snapshot_retention_period : integer_optional option;The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.
The value must be either -1 or an integer between 1 and 3,653.
*)snapshot_identifier : string_;The identifier of the snapshot whose setting you want to modify.
*)}type nonrec modify_cluster_parameter_group_message = {parameters : parameters_list;An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
*)parameter_group_name : string_;The name of the parameter group to be modified.
*)}Describes a modify cluster parameter group operation.
type nonrec modify_cluster_maintenance_message = {defer_maintenance_duration : integer_optional option;An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 60 days or less.
*)defer_maintenance_end_time : t_stamp option;A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
*)defer_maintenance_start_time : t_stamp option;A timestamp indicating the start time for the deferred maintenance window.
*)defer_maintenance_identifier : string_ option;A unique identifier for the deferred maintenance window.
*)defer_maintenance : boolean_optional option;A boolean indicating whether to enable the deferred maintenance window.
*)cluster_identifier : string_;A unique identifier for the cluster.
*)}type nonrec modify_cluster_iam_roles_message = {default_iam_role_arn : string_ option;The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified.
*)remove_iam_roles : iam_role_arn_list option;Zero or more IAM roles in ARN format to disassociate from the cluster.
*)add_iam_roles : iam_role_arn_list option;Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format.
*)cluster_identifier : string_;The unique identifier of the cluster for which you want to associate or disassociate IAM roles.
*)}Cluster is already on the latest database revision.
type nonrec modify_cluster_db_revision_message = {revision_target : string_;The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
cluster_identifier : string_;The unique identifier of a cluster whose database revision you want to modify.
Example: examplecluster
}type nonrec modify_cluster_message = {extra_compute_for_automatic_optimization : boolean_optional option;If true, allocates additional compute resources for running automatic optimization operations.
Default: false
*)multi_a_z : boolean_optional option;If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to be deployed in two Availability Zones.
*)ip_address_type : string_ option;The IP address types that the cluster supports. Possible values are ipv4 and dualstack.
master_password_secret_kms_key_id : string_ option;The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.
manage_master_password : boolean_optional option;If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.
port : integer_optional option;The option to change the port of an Amazon Redshift cluster.
Valid Values:
5431-5455 or 8191-8215. (If you have an existing cluster with RG or RA3 nodes, it isn't required that you change the port to these ranges.)1150-65535.availability_zone : string_ option;The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
*)availability_zone_relocation : boolean_optional option;The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
*)kms_key_id : string_ option;The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
*)encrypted : boolean_optional option;Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the KmsKeyId parameter, we encrypt the cluster with the provided KmsKeyId. If you don't provide a KmsKeyId, we encrypt with the default key.
If the value is not encrypted (false), then the cluster is decrypted.
*)maintenance_track_name : string_ option;The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
enhanced_vpc_routing : boolean_optional option;An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
*)elastic_ip : string_ option;The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
*)publicly_accessible : boolean_optional option;If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
Default: false
*)new_cluster_identifier : string_ option;The new identifier for the cluster.
Constraints:
Example: examplecluster
hsm_configuration_identifier : string_ option;Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
*)hsm_client_certificate_identifier : string_ option;Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
*)allow_version_upgrade : boolean_optional option;If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
Default: false
cluster_version : string_ option;The new version number of the Amazon Redshift engine to upgrade to.
For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example: 1.0
preferred_maintenance_window : string_ option;The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.
This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes.
*)manual_snapshot_retention_period : integer_optional option;The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
*)automated_snapshot_retention_period : integer_optional option;The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.
You can't disable automated snapshots for RG or RA3 node types. Set the automated retention period from 1-35 days.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
*)cluster_parameter_group_name : string_ option;The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.
Default: Uses existing setting.
Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
*)master_user_password : sensitive_string option;The new password for the cluster admin user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
You can't use MasterUserPassword if ManageMasterPassword is true.
Operations never return the password, so this operation provides a way to regain access to the admin user account for a cluster if the password is lost.
Default: Uses existing setting.
Constraints:
' (single quote), " (double quote), ], [/], or [@]. } } vpc_security_group_ids : vpc_security_group_id_list option;A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.
*)cluster_security_groups : cluster_security_group_name_list option;A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.
Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.
Constraints:
number_of_nodes : integer_optional option;The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: Integer greater than 0.
node_type : string_ option;The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large | dc2.8xlarge| rg.xlarge | rg.4xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
cluster_type : string_ option;The new cluster type.
When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.
Valid Values: multi-node | single-node
cluster_identifier : string_;The unique identifier of the cluster to be modified.
Example: examplecluster
}The authentication profile request is not valid. The profile name can't be null or empty. The authentication profile API operation must be available in the Amazon Web Services Region.
The size or number of authentication profiles has exceeded the quota. The maximum length of the JSON string and maximum number of authentication profiles is determined by a quota for your account.
The authentication profile can't be found.
type nonrec modify_authentication_profile_result = {authentication_profile_content : string_ option;The updated content of the authentication profile in JSON format.
*)authentication_profile_name : authentication_profile_name_string option;The name of the authentication profile that was replaced.
*)}type nonrec modify_authentication_profile_message = {authentication_profile_content : string_;The new content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
*)authentication_profile_name : authentication_profile_name_string;The name of the authentication profile to replace.
*)}type nonrec modify_aqua_output_message = {aqua_configuration : aqua_configuration option;This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
*)}type nonrec modify_aqua_input_message = {aqua_configuration_status : aqua_configuration_status option;This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
*)cluster_identifier : string_;The identifier of the cluster to be modified.
*)}type nonrec recommended_action = {type_ : recommended_action_type option;The type of command.
*)command : string_ option;The command to run.
*)database : string_ option;The database name to perform the action on. Only applicable if the type of command is SQL.
*)text : string_ option;The specific instruction about the command.
*)}The recommended action from the Amazon Redshift Advisor recommendation.
type nonrec recommended_action_list = recommended_action listtype nonrec recommendation = {reference_links : reference_link_list option;List of helpful links for more information about the Advisor recommendation.
*)recommended_actions : recommended_action_list option;List of Amazon Redshift recommended actions.
*)recommendation_text : string_ option;The description of the recommendation.
*)impact_ranking : impact_ranking_type option;The scale of the impact that the Advisor recommendation has to the performance and cost of the cluster.
*)observation : string_ option;The description of what was observed about your cluster.
*)description : string_ option;The description of the recommendation.
*)title : string_ option;The title of the recommendation.
*)recommendation_type : string_ option;The type of Advisor recommendation.
*)created_at : t_stamp option;The date and time (UTC) that the recommendation was created.
*)namespace_arn : string_ option;The Amazon Redshift cluster namespace ARN for which the recommendations is returned.
*)cluster_identifier : string_ option;The unique identifier of the cluster for which the recommendation is returned.
*)id : string_ option;A unique identifier of the Advisor recommendation.
*)}An Amazon Redshift Advisor recommended action on the Amazon Redshift cluster.
type nonrec recommendation_list = recommendation listtype nonrec list_recommendations_result = {marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*)recommendations : recommendation_list option;The Advisor recommendations for action on the Amazon Redshift cluster.
*)}type nonrec list_recommendations_message = {marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*)max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
*)namespace_arn : string_ option;The Amazon Redshift cluster namespace Amazon Resource Name (ARN) for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.
*)cluster_identifier : string_ option;The unique identifier of the Amazon Redshift cluster for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.
*)}type nonrec get_resource_policy_result = {resource_policy : resource_policy option;The content of the resource policy.
*)}type nonrec get_resource_policy_message = {resource_arn : string_;The Amazon Resource Name (ARN) of the resource of which its resource policy is fetched.
*)}type nonrec get_reserved_node_exchange_offerings_output_message = {reserved_node_offerings : reserved_node_offering_list option;Returns an array of ReservedNodeOffering objects.
marker : string_ option;An optional parameter that specifies the starting point for returning a set of response records. When the results of a GetReservedNodeExchangeOfferings request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
}type nonrec get_reserved_node_exchange_offerings_input_message = {marker : string_ option;A value that indicates the starting point for the next set of ReservedNodeOfferings.
*)max_records : integer_optional option;An integer setting the maximum number of ReservedNodeOfferings to retrieve.
*)reserved_node_id : string_;A string representing the node identifier for the DC1 Reserved Node to be exchanged.
*)}type nonrec get_reserved_node_exchange_configuration_options_output_message = {reserved_node_configuration_option_list : reserved_node_configuration_option_list
option;the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node. Details include the node type, the price, the node count, and the offering type.
*)marker : string_ option;A pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions request.
}type nonrec get_reserved_node_exchange_configuration_options_input_message = {marker : string_ option;An optional pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a Marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
snapshot_identifier : string_ option;The identifier for the snapshot that is the source for the reserved-node exchange.
*)cluster_identifier : string_ option;The identifier for the cluster that is the source for a reserved-node exchange.
*)action_type : reserved_node_exchange_action_type;The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize.
*)}The request contains one or more invalid parameters. This error occurs when required parameters are missing, parameter values are outside acceptable ranges, or parameter formats are incorrect.
type nonrec get_identity_center_auth_token_response = {expiration_time : t_stamp option;The time (UTC) when the token expires. After this timestamp, the token will no longer be valid for authentication.
*)token : sensitive_string option;The encrypted authentication token containing the caller's Amazon Web Services IAM Identity Center identity information. This token is encrypted using Key Management Service and can only be decrypted by the specified Amazon Redshift clusters. Use this token with Amazon Redshift drivers to authenticate using your Amazon Web Services IAM Identity Center identity.
*)}The response from GetIdentityCenterAuthToken containing the encrypted authentication token and expiration time.
type nonrec cluster_identifier_list = string_ listtype nonrec get_identity_center_auth_token_request = {cluster_ids : cluster_identifier_list;A list of cluster identifiers that the generated token can be used with. The token will be scoped to only allow authentication to the specified clusters.
Constraints:
ClusterIds must contain at least 1 cluster identifier.ClusterIds can hold a maximum of 20 cluster identifiers.The characters accepted for cluster identifiers are the following:
}The request parameters for GetIdentityCenterAuthToken.
type nonrec cluster_extended_credentials = {next_refresh_time : t_stamp option;Reserved for future use.
*)expiration : t_stamp option;The time (UTC) when the temporary password expires. After this timestamp, a log in with the temporary password fails.
*)db_password : sensitive_string option;A temporary password that you provide when you connect to a database.
*)db_user : string_ option;A database user name that you provide when you connect to a database. The database user is mapped 1:1 to the source IAM identity.
*)}type nonrec get_cluster_credentials_with_iam_message = {custom_domain_name : string_ option;The custom domain name for the IAM message cluster credentials.
*)duration_seconds : integer_optional option;The number of seconds until the returned temporary password expires.
Range: 900-3600. Default: 900.
*)cluster_identifier : string_ option;The unique identifier of the cluster that contains the database for which you are requesting credentials.
*)db_name : string_ option;The name of the database for which you are requesting credentials. If the database name is specified, the IAM policy must allow access to the resource dbname for the specified database name. If the database name is not specified, access to all databases is allowed.
}type nonrec cluster_credentials = {expiration : t_stamp option;The date and time the password in DbPassword expires.
db_password : sensitive_string option;A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.
db_user : string_ option;A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database permissions as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter is specifed, DbUser is added to the listed groups for any sessions created using these credentials.
}Temporary credentials with authorization to log on to an Amazon Redshift database.
type nonrec db_group_list = string_ listtype nonrec get_cluster_credentials_message = {custom_domain_name : string_ option;The custom domain name for the cluster credentials.
*)db_groups : db_group_list option;A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.
Database group name constraints
auto_create : boolean_optional option;Create a database user with the name specified for the user named in DbUser if one does not exist.
duration_seconds : integer_optional option;The number of seconds until the returned temporary password expires.
Constraint: minimum 900, maximum 3600.
Default: 900
*)cluster_identifier : string_ option;The unique identifier of the cluster that contains the database for which you are requesting credentials. This parameter is case sensitive.
*)db_name : string_ option;The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log on to any existing database.
Constraints:
db_user : string_;The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn't exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn't exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.
For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.
Constraints:
PUBLIC.}The request parameters to get cluster credentials.
type nonrec failover_primary_compute_input_message = {cluster_identifier : string_;The unique identifier of the cluster for which the primary compute unit will be failed over to another Availability Zone.
*)}The specified options are incompatible.
Cross-region snapshot copy was temporarily disabled. Try your request again.
type nonrec enable_snapshot_copy_message = {manual_snapshot_retention_period : integer_optional option;The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
*)snapshot_copy_grant_name : string_ option;The name of the snapshot copy grant to use when snapshots of an Amazon Web Services KMS-encrypted cluster are copied to the destination region.
*)retention_period : integer_optional option;The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
*)destination_region : string_;The destination Amazon Web Services Region that you want to copy snapshots to.
Constraints: Must be the name of a valid Amazon Web Services Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
*)cluster_identifier : string_;The unique identifier of the source cluster to copy snapshots from.
Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
*)}The string specified for the logging S3 key prefix does not comply with the documented constraints.
The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.
The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.
Could not find the specified S3 bucket.
type nonrec log_type_list = string_ listtype nonrec logging_status = {log_exports : log_type_list option;The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.
log_destination_type : log_destination_type option;The log destination type. An enum with possible values of s3 and cloudwatch.
last_failure_message : string_ option;The message indicating that logs failed to be delivered.
*)last_failure_time : t_stamp option;The last time when logs failed to be delivered.
*)last_successful_delivery_time : t_stamp option;The last time that logs were delivered.
*)s3_key_prefix : s3_key_prefix_value option;The prefix applied to the log file names.
*)bucket_name : string_ option;The name of the S3 bucket where the log files are stored.
*)logging_enabled : boolean_ option;true if logging is on, false if logging is off.
}Describes the status of logging for a cluster.
type nonrec enable_logging_message = {log_exports : log_type_list option;The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.
log_destination_type : log_destination_type option;The log destination type. An enum with possible values of s3 and cloudwatch.
s3_key_prefix : s3_key_prefix_value option;The prefix applied to the log file names.
Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore (_), period (.), colon (:), slash (/), equal (=), plus (+), backslash (]), hyphen ([-]), at symbol ([@]).
bucket_name : string_ option;The name of an existing S3 bucket where the log files are to be stored.
Constraints:
cluster_identifier : string_;The identifier of the cluster on which logging is to be started.
Example: examplecluster
}type nonrec disable_snapshot_copy_message = {cluster_identifier : string_;The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
*)}type nonrec disable_logging_message = {cluster_identifier : string_;The identifier of the cluster on which logging is to be stopped.
Example: examplecluster
}type nonrec describe_usage_limits_message = {tag_values : tag_value_list option;A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.
tag_keys : tag_key_list option;A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.
marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)feature_type : usage_limit_feature_type option;The feature type for which you want to describe usage limits.
*)cluster_identifier : string_ option;The identifier of the cluster for which you want to describe usage limits.
*)usage_limit_id : string_ option;The identifier of the usage limit to describe.
*)}type nonrec describe_table_restore_status_message = {marker : string_ option;An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
max_records : integer_optional option;The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
table_restore_request_id : string_ option;The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.
cluster_identifier : string_ option;The Amazon Redshift cluster that the table is being restored to.
*)}type nonrec describe_snapshot_schedules_output_message = {marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
snapshot_schedules : snapshot_schedule_list option;A list of SnapshotSchedules.
*)}type nonrec describe_snapshot_schedules_message = {max_records : integer_optional option;The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.
tag_values : tag_value_list option;The value corresponding to the key of the snapshot schedule tag.
*)tag_keys : tag_key_list option;The key value for a snapshot schedule tag.
*)schedule_identifier : string_ option;A unique identifier for a snapshot schedule.
*)cluster_identifier : string_ option;The unique identifier for the cluster whose snapshot schedules you want to view.
*)}type nonrec describe_snapshot_copy_grants_message = {tag_values : tag_value_list option;A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
tag_keys : tag_key_list option;A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
*)max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)snapshot_copy_grant_name : string_ option;The name of the snapshot copy grant.
*)}The result of the DescribeSnapshotCopyGrants action.
type nonrec describe_scheduled_actions_message = {max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
filters : scheduled_action_filter_list option;List of scheduled action filters.
*)active : boolean_optional option;If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*)end_time : t_stamp option;The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.
*)start_time : t_stamp option;The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.
*)target_action_type : scheduled_action_type_values option;The type of the scheduled actions to retrieve.
*)scheduled_action_name : string_ option;The name of the scheduled action to retrieve.
*)}type nonrec describe_resize_message = {cluster_identifier : string_;The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.
By default, resize operations for all clusters defined for an Amazon Web Services account are returned.
*)}type nonrec describe_reserved_nodes_message = {marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)reserved_node_id : string_ option;Identifier for the node reservation.
*)}type nonrec describe_reserved_node_offerings_message = {marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)reserved_node_offering_id : string_ option;The unique identifier for the offering.
*)}type nonrec describe_reserved_node_exchange_status_output_message = {marker : string_ option;A pagination token provided by a previous DescribeReservedNodeExchangeStatus request.
reserved_node_exchange_status_details : reserved_node_exchange_status_list
option;The details of the reserved-node exchange request, including the status, request time, source reserved-node identifier, and additional details.
*)}type nonrec describe_reserved_node_exchange_status_input_message = {marker : string_ option;An optional pagination token provided by a previous DescribeReservedNodeExchangeStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a Marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
reserved_node_exchange_request_id : string_ option;The identifier of the reserved-node exchange request.
*)reserved_node_id : string_ option;The identifier of the source reserved node in a reserved-node exchange request.
*)}type nonrec redshift_idc_application_list = redshift_idc_application listtype nonrec describe_redshift_idc_applications_result = {marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*)redshift_idc_applications : redshift_idc_application_list option;The list of Amazon Redshift IAM Identity Center applications.
*)}type nonrec describe_redshift_idc_applications_message = {marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
*)max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
*)redshift_idc_application_arn : string_ option;The ARN for the Redshift application that integrates with IAM Identity Center.
*)}type nonrec partner_integration_info = {updated_at : t_stamp option;The date (UTC) that the partner integration status was last updated by the partner.
*)created_at : t_stamp option;The date (UTC) that the partner integration was created.
*)status_message : partner_integration_status_message option;The status message provided by the partner.
*)status : partner_integration_status option;The partner integration status.
*)partner_name : partner_integration_partner_name option;The name of the partner.
*)database_name : partner_integration_database_name option;The name of the database that receives data from a partner.
*)}Describes a partner integration.
type nonrec partner_integration_info_list = partner_integration_info listtype nonrec describe_partners_output_message = {partner_integration_info_list : partner_integration_info_list option;A list of partner integrations.
*)}type nonrec describe_partners_input_message = {partner_name : partner_integration_partner_name option;The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.
*)database_name : partner_integration_database_name option;The name of the database whose partner integration is being described. If database name is not specified, then all databases in the cluster are described.
*)cluster_identifier : partner_integration_cluster_identifier;The cluster identifier of the cluster whose partner integration is being described.
*)account_id : partner_integration_account_id;The Amazon Web Services account ID that owns the cluster.
*)}type nonrec availability_zone_list = availability_zone listtype nonrec orderable_cluster_option = {availability_zones : availability_zone_list option;A list of availability zones for the orderable cluster.
*)node_type : string_ option;The node type for the orderable cluster.
*)cluster_type : string_ option;The cluster type, for example multi-node.
cluster_version : string_ option;The version of the orderable cluster.
*)}Describes an orderable cluster option.
type nonrec orderable_cluster_options_list = orderable_cluster_option listtype nonrec orderable_cluster_options_message = {marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
orderable_cluster_options : orderable_cluster_options_list option;An OrderableClusterOption structure containing information about orderable options for the cluster.
}Contains the output from the DescribeOrderableClusterOptions action.
type nonrec describe_orderable_cluster_options_message = {marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)node_type : string_ option;The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
*)cluster_version : string_ option;The version filter value. Specify this parameter to show only the available offerings matching the specified version.
Default: All versions.
Constraints: Must be one of the version returned from DescribeClusterVersions.
}type nonrec node_configuration_option = {mode : mode option;The category of the node configuration recommendation.
*)estimated_disk_utilization_percent : double_optional option;The estimated disk utilizaton percentage.
*)number_of_nodes : integer option;The number of nodes.
*)node_type : string_ option;The node type, such as, "ra3.4xlarge".
*)}A list of node configurations.
type nonrec node_configuration_option_list = node_configuration_option listtype nonrec node_configuration_options_message = {marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
node_configuration_option_list : node_configuration_option_list option;A list of valid node configurations.
*)}type nonrec node_configuration_options_filter = {values : value_string_list option;List of values. Compare Name using Operator to Values. If filter Name is NumberOfNodes, then values can range from 0 to 200. If filter Name is EstimatedDiskUtilizationPercent, then values can range from 0 to 100. For example, filter NumberOfNodes (name) GT (operator) 3 (values).
*)operator : operator_type option;The filter operator. If filter Name is NodeType only the 'in' operator is supported. Provide one value to evaluate for 'eq', 'lt', 'le', 'gt', and 'ge'. Provide two values to evaluate for 'between'. Provide a list of values for 'in'.
*)name : node_configuration_options_filter_name option;The name of the element to filter.
*)}A set of elements to filter the returned node configurations.
type nonrec node_configuration_options_filter_list =
node_configuration_options_filter listtype nonrec describe_node_configuration_options_message = {max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 500
Constraints: minimum 100, maximum 500.
*)marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
filters : node_configuration_options_filter_list option;A set of name, operator, and value items to filter the results.
*)owner_account : string_ option;The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
*)snapshot_arn : string_ option;The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
*)snapshot_identifier : string_ option;The identifier of the snapshot to evaluate for possible node configurations.
*)cluster_identifier : string_ option;The identifier of the cluster to evaluate for possible node configurations.
*)action_type : action_type;The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
*)}type nonrec describe_logging_status_message = {cluster_identifier : string_;The identifier of the cluster from which to get the logging status.
Example: examplecluster
}type nonrec integration_list = integration listtype nonrec integrations_message = {integrations : integration_list option;List of integrations that are described.
*)marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}type nonrec describe_integrations_filter_value_list = string_ listtype nonrec describe_integrations_filter = {values : describe_integrations_filter_value_list;Specifies the values to filter on.
*)name : describe_integrations_filter_name;Specifies the type of integration filter.
*)}A set of elements to filter the returned integrations.
type nonrec describe_integrations_filter_list =
describe_integrations_filter listtype nonrec describe_integrations_message = {filters : describe_integrations_filter_list option;A filter that specifies one or more resources to return.
*)marker : string_ option;An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)integration_arn : integration_arn option;The unique identifier of the integration.
*)}type nonrec inbound_integration = {create_time : t_stamp option;The creation time of an inbound integration.
*)errors : integration_error_list option;The outstanding errors of an inbound integration. Each item is an "IntegrationError". This is null if there is no error.
*)status : zero_etl_integration_status option;The status of an inbound integration.
*)target_arn : target_arn option;The Amazon Resource Name (ARN) of the target of an inbound integration.
*)source_arn : string_ option;The Amazon Resource Name (ARN) of the source of an inbound integration.
*)integration_arn : inbound_integration_arn option;The Amazon Resource Name (ARN) of an inbound integration.
*)}The content of an inbound integration.
type nonrec inbound_integration_list = inbound_integration listtype nonrec inbound_integrations_message = {inbound_integrations : inbound_integration_list option;A list of InboundIntegration instances.
marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}type nonrec describe_inbound_integrations_message = {marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeInboundIntegrations request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)target_arn : target_arn option;The Amazon Resource Name (ARN) of the target of an inbound integration.
*)integration_arn : inbound_integration_arn option;The Amazon Resource Name (ARN) of the inbound integration.
*)}type nonrec hsm_configuration = {hsm_partition_name : string_ option;The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
*)hsm_ip_address : string_ option;The IP address that the Amazon Redshift cluster must use to access the HSM.
*)description : string_ option;A text description of the HSM configuration.
*)hsm_configuration_identifier : string_ option;The name of the Amazon Redshift HSM configuration.
*)}Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.
type nonrec hsm_configuration_list = hsm_configuration listtype nonrec hsm_configuration_message = {hsm_configurations : hsm_configuration_list option;A list of HsmConfiguration objects.
marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}type nonrec describe_hsm_configurations_message = {tag_values : tag_value_list option;A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.
tag_keys : tag_key_list option;A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.
marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)hsm_configuration_identifier : string_ option;The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your Amazon Web Services account.
*)}type nonrec hsm_client_certificate = {hsm_client_certificate_public_key : string_ option;The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.
*)hsm_client_certificate_identifier : string_ option;The identifier of the HSM client certificate.
*)}Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.
type nonrec hsm_client_certificate_list = hsm_client_certificate listtype nonrec hsm_client_certificate_message = {hsm_client_certificates : hsm_client_certificate_list option;A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.
*)marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}type nonrec describe_hsm_client_certificates_message = {tag_values : tag_value_list option;A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.
tag_keys : tag_key_list option;A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.
marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)hsm_client_certificate_identifier : string_ option;The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your Amazon Web Services account.
*)}type nonrec event_subscriptions_list = event_subscription listtype nonrec event_subscriptions_message = {event_subscriptions_list : event_subscriptions_list option;A list of event subscriptions.
*)marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}type nonrec describe_event_subscriptions_message = {tag_values : tag_value_list option;A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them.
tag_keys : tag_key_list option;A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them.
marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)subscription_name : string_ option;The name of the Amazon Redshift event notification subscription to be described.
*)}type nonrec event = {event_id : string_ option;The identifier of the event.
*)date : t_stamp option;The date and time of the event.
*)severity : string_ option;The severity of the event.
Values: ERROR, INFO
*)event_categories : event_categories_list option;A list of the event categories.
Values: Configuration, Management, Monitoring, Security, Pending
*)message : string_ option;The text of this event.
*)source_type : source_type option;The source type for this event.
*)source_identifier : string_ option;The identifier for the source of the event.
*)}Describes an event.
type nonrec event_list = event listtype nonrec events_message = {events : event_list option;A list of Event instances.
marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}type nonrec describe_events_message = {marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)duration : integer_optional option;The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default: 60
end_time : t_stamp option;The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
start_time : t_stamp option;The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
source_type : source_type option;The event source to retrieve events for. If no value is specified, all events are returned.
Constraints:
If SourceType is supplied, SourceIdentifier must also be provided.
cluster when SourceIdentifier is a cluster identifier.cluster-security-group when SourceIdentifier is a cluster security group name.cluster-parameter-group when SourceIdentifier is a cluster parameter group name.cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.source_identifier : string_ option;The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
cluster.cluster-security-group.cluster-parameter-group.cluster-snapshot.}type nonrec event_info_map = {severity : string_ option;The severity of the event.
Values: ERROR, INFO
*)event_description : string_ option;The description of an Amazon Redshift event.
*)event_categories : event_categories_list option;The category of an Amazon Redshift event.
*)event_id : string_ option;The identifier of an Amazon Redshift event.
*)}Describes event information.
type nonrec event_info_map_list = event_info_map listtype nonrec event_categories_map = {events : event_info_map_list option;The events in the event category.
*)source_type : string_ option;The source type, such as cluster or cluster-snapshot, that the returned categories belong to.
*)}Describes event categories.
type nonrec event_categories_map_list = event_categories_map listtype nonrec event_categories_message = {event_categories_map_list : event_categories_map_list option;A list of event categories descriptions.
*)}type nonrec describe_event_categories_message = {source_type : string_ option;The source type, such as cluster or parameter group, to which the described event categories apply.
Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.
*)}type nonrec endpoint_authorizations = endpoint_authorization listtype nonrec endpoint_accesses = endpoint_access listtype nonrec endpoint_access_list = {marker : string_ option;An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
endpoint_access_list : endpoint_accesses option;The list of endpoints with access to the cluster.
*)}type nonrec describe_endpoint_access_message = {marker : string_ option;An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
max_records : integer_optional option;The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a Marker is included in the response so that the remaining results can be retrieved.
vpc_id : string_ option;The virtual private cloud (VPC) identifier with access to the cluster.
*)endpoint_name : string_ option;The name of the endpoint to be described.
*)resource_owner : string_ option;The Amazon Web Services account ID of the owner of the cluster.
*)cluster_identifier : string_ option;The cluster identifier associated with the described endpoint.
*)}type nonrec default_cluster_parameters = {parameters : parameters_list option;The list of cluster default parameters.
*)marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
parameter_group_family : string_ option;The name of the cluster parameter group family to which the engine default parameters apply.
*)}Describes the default cluster parameters for a parameter group family.
type nonrec describe_default_cluster_parameters_result = {default_cluster_parameters : default_cluster_parameters option;}type nonrec describe_default_cluster_parameters_message = {marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)parameter_group_family : string_;The name of the cluster parameter group family.
*)}type nonrec certificate_association = {cluster_identifier : string_ option;The cluster identifier for the certificate association.
*)custom_domain_name : string_ option;The custom domain name for the certificate association.
*)}A cluster ID and custom domain name tied to a specific certificate. These are typically returned in a list.
type nonrec certificate_association_list = certificate_association listtype nonrec association = {certificate_associations : certificate_association_list option;A list of all associated clusters and domain names tied to a specific certificate.
*)custom_domain_certificate_expiry_date : t_stamp option;The expiration date for the certificate.
*)custom_domain_certificate_arn : string_ option;The Amazon Resource Name (ARN) for the certificate associated with the custom domain.
*)}Contains information about the custom domain name association.
type nonrec association_list = association listtype nonrec custom_domain_associations_message = {associations : association_list option;The associations for the custom domain.
*)marker : string_ option;The marker for the custom domain association.
*)}type nonrec describe_custom_domain_associations_message = {marker : string_ option;The marker for the custom domain association.
*)max_records : integer_optional option;The maximum records setting for the associated custom domain.
*)custom_domain_certificate_arn : custom_domain_certificate_arn_string option;The certificate Amazon Resource Name (ARN) for the custom domain association.
*)custom_domain_name : custom_domain_name_string option;The custom domain name for the custom domain association.
*)}type nonrec cluster_version = {description : string_ option;The description of the cluster version.
*)cluster_parameter_group_family : string_ option;The name of the cluster parameter group family for the cluster.
*)cluster_version : string_ option;The version number used by the cluster.
*)}Describes a cluster version, including the parameter group family and description of the version.
type nonrec cluster_version_list = cluster_version listtype nonrec cluster_versions_message = {cluster_versions : cluster_version_list option;A list of Version elements.
marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}Contains the output from the DescribeClusterVersions action.
type nonrec describe_cluster_versions_message = {marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)cluster_parameter_group_family : string_ option;The name of a specific cluster parameter group family to return details for.
Constraints:
cluster_version : string_ option;The specific cluster version to return.
Example: 1.0
}type nonrec describe_cluster_tracks_message = {marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterTracks request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;An integer value for the maximum number of maintenance tracks to return.
*)maintenance_track_name : string_ option;The name of the maintenance track.
*)}type nonrec cluster_subnet_groups = cluster_subnet_group listtype nonrec cluster_subnet_group_message = {cluster_subnet_groups : cluster_subnet_groups option;A list of ClusterSubnetGroup instances.
marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}Contains the output from the DescribeClusterSubnetGroups action.
type nonrec describe_cluster_subnet_groups_message = {tag_values : tag_value_list option;A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.
tag_keys : tag_key_list option;A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.
marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)cluster_subnet_group_name : string_ option;The name of the cluster subnet group for which information is requested.
*)}type nonrec describe_cluster_snapshots_message = {sorting_entities : snapshot_sorting_entity_list option;cluster_exists : boolean_optional option;A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:
ClusterExists is set to true, ClusterIdentifier is required.ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.tag_values : tag_value_list option;A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.
tag_keys : tag_key_list option;A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.
owner_account : string_ option;The Amazon Web Services account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your Amazon Web Services account, or do not specify the parameter.
*)marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)end_time : t_stamp option;A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
start_time : t_stamp option;A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2012-07-16T18:00:00Z
snapshot_type : string_ option;The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.
Valid Values: automated | manual
snapshot_arn : string_ option;The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.
*)snapshot_identifier : string_ option;The snapshot identifier of the snapshot about which to return information.
*)cluster_identifier : string_ option;The identifier of the cluster which generated the requested snapshots.
*)}type nonrec cluster_security_groups = cluster_security_group listtype nonrec cluster_security_group_message = {cluster_security_groups : cluster_security_groups option;A list of ClusterSecurityGroup instances.
marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}type nonrec describe_cluster_security_groups_message = {tag_values : tag_value_list option;A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.
tag_keys : tag_key_list option;A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.
marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You must specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
*)max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)cluster_security_group_name : string_ option;The name of a cluster security group for which you are requesting details. You must specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example: securitygroup1
}type nonrec cluster_list = cluster listtype nonrec clusters_message = {clusters : cluster_list option;A list of Cluster objects, where each object describes one cluster.
marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}Contains the output from the DescribeClusters action.
type nonrec describe_clusters_message = {tag_values : tag_value_list option;A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
tag_keys : tag_key_list option;A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
*)max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)cluster_identifier : string_ option;The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned.
*)}type nonrec cluster_parameter_group_details = {marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
parameters : parameters_list option;A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.
}Contains the output from the DescribeClusterParameters action.
type nonrec describe_cluster_parameters_message = {marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)source : string_ option;The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default
parameter_group_name : string_;The name of a cluster parameter group for which to return details.
*)}type nonrec cluster_parameter_group = {description : string_ option;The description of the parameter group.
*)parameter_group_family : string_ option;The name of the cluster parameter group family that this cluster parameter group is compatible with.
*)parameter_group_name : string_ option;The name of the cluster parameter group.
*)}Describes a parameter group.
type nonrec parameter_group_list = cluster_parameter_group listtype nonrec cluster_parameter_groups_message = {parameter_groups : parameter_group_list option;A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.
marker : string_ option;A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
}Contains the output from the DescribeClusterParameterGroups action.
type nonrec describe_cluster_parameter_groups_message = {tag_values : tag_value_list option;A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
tag_keys : tag_key_list option;A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
marker : string_ option;An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
*)parameter_group_name : string_ option;The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.
*)}type nonrec cluster_db_revision = {revision_targets : revision_targets_list option;A list of RevisionTarget objects, where each object describes the database revision that a cluster can be updated to.
database_revision_release_date : t_stamp option;The date on which the database revision was released.
*)current_database_revision : string_ option;A string representing the current cluster version.
*)cluster_identifier : string_ option;The unique identifier of the cluster.
*)}Describes a ClusterDbRevision.
type nonrec cluster_db_revisions_list = cluster_db_revision listtype nonrec cluster_db_revisions_message = {cluster_db_revisions : cluster_db_revisions_list option;A list of revisions.
*)marker : string_ option;A string representing the starting point for the next set of revisions. If a value is returned in a response, you can retrieve the next set of revisions by providing the value in the marker parameter and retrying the command. If the marker field is empty, all revisions have already been returned.
}type nonrec describe_cluster_db_revisions_message = {marker : string_ option;An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.
max_records : integer_optional option;The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.
Default: 100
Constraints: minimum 20, maximum 100.
*)cluster_identifier : string_ option;A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
}type nonrec authentication_profile = {authentication_profile_content : string_ option;The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
*)authentication_profile_name : authentication_profile_name_string option;The name of the authentication profile.
*)}Describes an authentication profile.
type nonrec authentication_profile_list = authentication_profile listtype nonrec describe_authentication_profiles_result = {authentication_profiles : authentication_profile_list option;The list of authentication profiles.
*)}type nonrec describe_authentication_profiles_message = {authentication_profile_name : authentication_profile_name_string option;The name of the authentication profile to describe. If not specified then all authentication profiles owned by the account are listed.
*)}type nonrec attribute_value_target = {attribute_value : string_ option;The value of the attribute.
*)}Describes an attribute value.
type nonrec attribute_value_list = attribute_value_target listtype nonrec account_attribute = {attribute_values : attribute_value_list option;A list of attribute values.
*)attribute_name : string_ option;The name of the attribute.
*)}A name value pair that describes an aspect of an account.
type nonrec attribute_list = account_attribute listtype nonrec account_attribute_list = {account_attributes : attribute_list option;A list of attributes assigned to an account.
*)}type nonrec attribute_name_list = string_ listtype nonrec describe_account_attributes_message = {attribute_names : attribute_name_list option;A list of attribute names.
*)}type nonrec deregister_namespace_output_message = {status : namespace_registration_status option;The registration status of the cluster or serverless namespace.
*)}type nonrec deregister_namespace_input_message = {consumer_identifiers : consumer_identifier_list;An array containing the ID of the consumer account that you want to deregister the cluster or serverless namespace from.
*)namespace_identifier : namespace_identifier_union;The unique identifier of the cluster or serverless namespace that you want to deregister.
*)}type nonrec delete_usage_limit_message = {usage_limit_id : string_;The identifier of the usage limit to delete.
*)}type nonrec delete_snapshot_schedule_message = {schedule_identifier : string_;A unique identifier of the snapshot schedule to delete.
*)}The snapshot copy grant can't be deleted because it is used by one or more clusters.
type nonrec delete_snapshot_copy_grant_message = {snapshot_copy_grant_name : string_;The name of the snapshot copy grant to delete.
*)}The result of the DeleteSnapshotCopyGrant action.
type nonrec delete_scheduled_action_message = {scheduled_action_name : string_;The name of the scheduled action to delete.
*)}type nonrec delete_resource_policy_message = {resource_arn : string_;The Amazon Resource Name (ARN) of the resource of which its resource policy is deleted.
*)}type nonrec delete_redshift_idc_application_message = {redshift_idc_application_arn : string_;The ARN for a deleted Amazon Redshift IAM Identity Center application.
*)}type nonrec partner_integration_input_message = {partner_name : partner_integration_partner_name;The name of the partner that is authorized to send data.
*)database_name : partner_integration_database_name;The name of the database that receives data from the partner.
*)cluster_identifier : partner_integration_cluster_identifier;The cluster identifier of the cluster that receives data from the partner.
*)account_id : partner_integration_account_id;The Amazon Web Services account ID that owns the cluster.
*)}type nonrec delete_integration_message = {integration_arn : integration_arn;The unique identifier of the integration to delete.
*)}The specified HSM configuration is not in the available state, or it is still in use by one or more Amazon Redshift clusters.
type nonrec delete_hsm_configuration_message = {hsm_configuration_identifier : string_;The identifier of the Amazon Redshift HSM configuration to be deleted.
*)}The specified HSM client certificate is not in the available state, or it is still in use by one or more Amazon Redshift clusters.
type nonrec delete_hsm_client_certificate_message = {hsm_client_certificate_identifier : string_;The identifier of the HSM client certificate to be deleted.
*)}type nonrec delete_event_subscription_message = {subscription_name : string_;The name of the Amazon Redshift event notification subscription to be deleted.
*)}type nonrec delete_endpoint_access_message = {endpoint_name : string_;The Redshift-managed VPC endpoint to delete.
*)}type nonrec delete_custom_domain_association_message = {custom_domain_name : custom_domain_name_string;The custom domain name for the custom domain association.
*)cluster_identifier : string_;The identifier of the cluster to delete a custom domain association for.
*)}The state of the subnet is invalid.
type nonrec delete_cluster_subnet_group_message = {cluster_subnet_group_name : string_;The name of the cluster subnet group name to be deleted.
*)}type nonrec delete_cluster_snapshot_message = {snapshot_cluster_identifier : string_ option;The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints: Must be the name of valid cluster.
*)snapshot_identifier : string_;The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state.
}type nonrec delete_cluster_security_group_message = {cluster_security_group_name : string_;The name of the cluster security group to be deleted.
*)}type nonrec delete_cluster_parameter_group_message = {parameter_group_name : string_;The name of the parameter group to be deleted.
Constraints:
}The request would result in the user exceeding the allowed number of cluster snapshots.
The value specified as a snapshot identifier is already used by an existing snapshot.
type nonrec delete_cluster_message = {final_cluster_snapshot_retention_period : integer_optional option;The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
*)final_cluster_snapshot_identifier : string_ option;The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
skip_final_cluster_snapshot : boolean_ option;Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.
The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.
Default: false
cluster_identifier : string_;The identifier of the cluster to be deleted.
Constraints:
}type nonrec delete_authentication_profile_result = {authentication_profile_name : authentication_profile_name_string option;The name of the authentication profile that was deleted.
*)}type nonrec delete_authentication_profile_message = {authentication_profile_name : authentication_profile_name_string;The name of the authentication profile to delete.
*)}type nonrec create_usage_limit_message = {breach_action : usage_limit_breach_action option;The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.
period : usage_limit_period option;The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
amount : long;The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.
*)limit_type : usage_limit_limit_type;The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned. If FeatureType is extra-compute-for-automatic-optimization, then LimitType must be time.
feature_type : usage_limit_feature_type;The Amazon Redshift feature that you want to limit.
*)cluster_identifier : string_;The identifier of the cluster that you want to limit usage.
*)}type nonrec create_snapshot_schedule_message = {next_invocations : integer_optional option;dry_run : boolean_optional option;schedule_description : string_ option;The description of the snapshot schedule.
*)schedule_identifier : string_ option;A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.
*)schedule_definitions : schedule_definition_list option;The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".
*)}type nonrec create_snapshot_copy_grant_message = {kms_key_id : string_ option;The unique identifier of the encrypted symmetric key to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
*)snapshot_copy_grant_name : string_;The name of the snapshot copy grant. This name must be unique in the region for the Amazon Web Services account.
Constraints:
}The result of the CreateSnapshotCopyGrant action.
type nonrec create_scheduled_action_message = {enable : boolean_optional option;If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.
end_time : t_stamp option;The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.
start_time : t_stamp option;The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.
scheduled_action_description : string_ option;The description of the scheduled action.
*)iam_role : string_;The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
schedule : string_;The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.
target_action : scheduled_action_type;A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.
scheduled_action_name : string_;The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.
}The maximum number of Redshift IAM Identity Center applications was exceeded.
The application you attempted to add already exists.
type nonrec create_redshift_idc_application_result = {redshift_idc_application : redshift_idc_application option;}type nonrec create_redshift_idc_application_message = {sso_tag_keys : tag_key_list option;A list of tags keys that Redshift Identity Center applications copy to IAM Identity Center. For each input key, the tag corresponding to the key-value pair is propagated.
*)application_type : application_type option;The type of application being created. Valid values are None or Lakehouse. Use Lakehouse to enable Amazon Redshift federated permissions on cluster.
service_integrations : service_integration_list option;A collection of service integrations for the Redshift IAM Identity Center application.
*)iam_role_arn : string_;The IAM role ARN for the Amazon Redshift IAM Identity Center application instance. It has the required permissions to be assumed and invoke the IDC Identity Center API.
*)idc_display_name : idc_display_name_string;The display name for the Amazon Redshift IAM Identity Center application instance. It appears in the console.
*)identity_namespace : identity_namespace_string option;The namespace for the Amazon Redshift IAM Identity Center application instance. It determines which managed application verifies the connection token.
*)redshift_idc_application_name : redshift_idc_application_name;The name of the Redshift application in IAM Identity Center.
*)idc_instance_arn : string_;The Amazon resource name (ARN) of the IAM Identity Center instance where Amazon Redshift creates a new managed application.
*)}The specified integration target can't be found.
The specified integration source can't be found.
You can't create any more zero-ETL or S3 event integrations because the quota has been reached.
type nonrec create_integration_message = {description : integration_description option;A description of the integration.
*)additional_encryption_context : encryption_context_map option;An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
You can only include this parameter if you specify the KMSKeyId parameter.
tag_list : tag_list option;A list of tags.
*)kms_key_id : string_ option;An Key Management Service (KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default Amazon Web Services owned key is used.
*)integration_name : integration_name;The name of the integration.
*)target_arn : target_arn;The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.
*)source_arn : source_arn;The Amazon Resource Name (ARN) of the database to use as the source for replication.
*)}The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
There is already an existing Amazon Redshift HSM configuration with the specified identifier.
type nonrec create_hsm_configuration_message = {hsm_server_public_certificate : string_;The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.
*)hsm_partition_password : string_;The password required to access the HSM partition.
*)hsm_partition_name : string_;The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.
*)hsm_ip_address : string_;The IP address that the Amazon Redshift cluster must use to access the HSM.
*)description : string_;A text description of the HSM configuration to be created.
*)hsm_configuration_identifier : string_;The identifier to be assigned to the new Amazon Redshift HSM configuration.
*)}The quota for HSM client certificates has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
There is already an existing Amazon Redshift HSM client certificate with the specified identifier.
type nonrec create_hsm_client_certificate_result = {hsm_client_certificate : hsm_client_certificate option;}type nonrec create_hsm_client_certificate_message = {hsm_client_certificate_identifier : string_;The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.
*)}The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
type nonrec create_event_subscription_message = {enabled : boolean_optional option;A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
severity : string_ option;Specifies the Amazon Redshift event severity to be published by the event notification subscription.
Values: ERROR, INFO
*)event_categories : event_categories_list option;Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security, pending
*)source_ids : source_ids_list option;A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.
Example: my-cluster-1, my-cluster-2
Example: my-snapshot-20131010
*)source_type : string_ option;The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.
Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
*)sns_topic_arn : string_;The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
*)subscription_name : string_;The name of the event subscription to be created.
Constraints:
}The number of Redshift-managed VPC endpoints per cluster has exceeded its limit.
The number of Redshift-managed VPC endpoints per authorization has exceeded its limit.
The account already has a Redshift-managed VPC endpoint with the given identifier.
You are not authorized to access the cluster.
type nonrec create_endpoint_access_message = {vpc_security_group_ids : vpc_security_group_id_list option;The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
*)subnet_group_name : string_;The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
*)endpoint_name : string_;The Redshift-managed VPC endpoint name.
An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.
*)resource_owner : string_ option;The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
*)cluster_identifier : string_ option;The cluster identifier of the cluster to access.
*)}type nonrec create_custom_domain_association_result = {custom_domain_cert_expiry_time : string_ option;The expiration time for the certificate for the custom domain.
*)cluster_identifier : string_ option;The identifier of the cluster that the custom domain is associated with.
*)custom_domain_certificate_arn : custom_domain_certificate_arn_string option;The Amazon Resource Name (ARN) for the certificate associated with the custom domain name.
*)custom_domain_name : custom_domain_name_string option;The custom domain name for the association result.
*)}type nonrec create_custom_domain_association_message = {cluster_identifier : string_;The cluster identifier that the custom domain is associated with.
*)custom_domain_certificate_arn : custom_domain_certificate_arn_string;The certificate Amazon Resource Name (ARN) for the custom domain name association.
*)custom_domain_name : custom_domain_name_string;The custom domain name for a custom domain association.
*)}The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
A ClusterSubnetGroupName is already used by an existing cluster subnet group.
type nonrec create_cluster_subnet_group_result = {cluster_subnet_group : cluster_subnet_group option;}type nonrec create_cluster_subnet_group_message = {subnet_ids : subnet_identifier_list;An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
*)description : string_;A description for the subnet group.
*)cluster_subnet_group_name : string_;The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Example: examplesubnetgroup
}type nonrec create_cluster_snapshot_message = {manual_snapshot_retention_period : integer_optional option;The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
*)cluster_identifier : string_;The cluster identifier for which you want a snapshot.
*)snapshot_identifier : string_;A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.
Constraints:
Example: my-snapshot-id
}The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
A cluster security group with the same name already exists.
type nonrec create_cluster_security_group_result = {cluster_security_group : cluster_security_group option;}type nonrec create_cluster_security_group_message = {description : string_;A description for the security group.
*)cluster_security_group_name : string_;The name for the security group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Example: examplesecuritygroup
}The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.
A cluster parameter group with the same name already exists.
type nonrec create_cluster_parameter_group_result = {cluster_parameter_group : cluster_parameter_group option;}type nonrec create_cluster_parameter_group_message = {description : string_;A description of the parameter group.
*)parameter_group_family : string_;The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your Amazon Web Services account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".
parameter_group_name : string_;The name of the cluster parameter group.
Constraints:
This value is stored as a lower-case string.
*)}type nonrec create_cluster_message = {extra_compute_for_automatic_optimization : boolean_optional option;If true, allocates additional compute resources for running automatic optimization operations.
Default: false
*)catalog_name : catalog_name_string option;The name of the Glue data catalog that will be associated with the cluster enabled with Amazon Redshift federated permissions.
Constraints:
Pattern: ^[a-z0-9_-]*[a-z]+[a-z0-9_-]*$
Example: my-catalog_01
redshift_idc_application_arn : string_ option;The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.
*)multi_a_z : boolean_optional option;If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).
*)ip_address_type : string_ option;The IP address types that the cluster supports. Possible values are ipv4 and dualstack.
master_password_secret_kms_key_id : string_ option;The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.
manage_master_password : boolean_optional option;If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.
load_sample_data : string_ option;A flag that specifies whether to load sample data once the cluster is created.
*)default_iam_role_arn : string_ option;The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
*)aqua_configuration_status : aqua_configuration_status option;This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
*)availability_zone_relocation : boolean_optional option;The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
*)snapshot_schedule_identifier : string_ option;A unique identifier for the snapshot schedule.
*)maintenance_track_name : string_ option;An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.
iam_roles : iam_role_arn_list option;A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
*)additional_info : string_ option;Reserved.
*)enhanced_vpc_routing : boolean_optional option;An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
*)kms_key_id : string_ option;The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
*)elastic_ip : string_ option;The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
*)hsm_configuration_identifier : string_ option;Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
*)hsm_client_certificate_identifier : string_ option;Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
*)encrypted : boolean_optional option;If true, the data in the cluster is encrypted at rest. If you set the value on this parameter to false, the request will fail.
Default: true
*)publicly_accessible : boolean_optional option;If true, the cluster can be accessed from a public network.
Default: false
*)number_of_nodes : integer_optional option;The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default: 1
Constraints: Value must be at least 1 and no more than 100.
*)allow_version_upgrade : boolean_optional option;If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
cluster_version : string_ option;The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
port : integer_optional option;The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values:
5431-5455 or 8191-8215. (If you have an existing cluster with RG or RA3 nodes, it isn't required that you change the port to these ranges.)1150-65535.manual_snapshot_retention_period : integer_optional option;The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
*)automated_snapshot_retention_period : integer_optional option;The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
You can't disable automated snapshots for RG or RA3 node types. Set the automated retention period from 1-35 days.
Default: 1
Constraints: Must be a value from 0 to 35.
*)cluster_parameter_group_name : string_ option;The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
preferred_maintenance_window : string_ option;The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
*)availability_zone : string_ option;The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
*)cluster_subnet_group_name : string_ option;The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
*)vpc_security_group_ids : vpc_security_group_id_list option;A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Default: The default VPC security group is associated with the cluster.
*)cluster_security_groups : cluster_security_group_name_list option;A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
*)master_user_password : sensitive_string option;The password associated with the admin user account for the cluster that is being created.
You can't use MasterUserPassword if ManageMasterPassword is true.
Constraints:
' (single quote), " (double quote), ], [/], or [@]. } } master_username : string_;The user name associated with the admin user account for the cluster that is being created.
Constraints:
PUBLIC.node_type : string_;The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large | dc2.8xlarge| rg.xlarge | rg.4xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
cluster_type : string_ option;The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.multi-node, the NumberOfNodes parameter is required.Valid Values: multi-node | single-node
Default: multi-node
cluster_identifier : string_;A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
Example: myexamplecluster
db_name : string_ option;The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
}The authentication profile already exists.
type nonrec create_authentication_profile_result = {authentication_profile_content : string_ option;The content of the authentication profile in JSON format.
*)authentication_profile_name : authentication_profile_name_string option;The name of the authentication profile that was created.
*)}type nonrec create_authentication_profile_message = {authentication_profile_content : string_;The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.
*)authentication_profile_name : authentication_profile_name_string;The name of the authentication profile to be created.
*)}type nonrec copy_cluster_snapshot_message = {manual_snapshot_retention_period : integer_optional option;The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
*)target_snapshot_identifier : string_;The identifier given to the new manual snapshot.
Constraints:
source_snapshot_cluster_identifier : string_ option;The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
Constraints:
source_snapshot_identifier : string_;The identifier for the source snapshot.
Constraints:
available.}type nonrec cancel_resize_message = {cluster_identifier : string_;The unique identifier for the cluster that you want to cancel a resize operation for.
*)}type nonrec batch_modify_cluster_snapshots_limit_exceeded_fault = {message : exception_message option;}The maximum number for snapshot identifiers has been reached. The limit is 100.
type nonrec batch_snapshot_operation_errors = snapshot_error_message listtype nonrec batch_modify_cluster_snapshots_output_message = {errors : batch_snapshot_operation_errors option;A list of any errors returned.
*)resources : snapshot_identifier_list option;A list of the snapshots that were modified.
*)}type nonrec batch_modify_cluster_snapshots_message = {force : boolean_ option;A boolean value indicating whether to override an exception if the retention period has passed.
*)manual_snapshot_retention_period : integer_optional option;The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.
The number must be either -1 or an integer between 1 and 3,653.
If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.
*)snapshot_identifier_list : snapshot_identifier_list;A list of snapshot identifiers you want to modify.
*)}The maximum number for a batch delete of snapshots has been reached. The limit is 100.
type nonrec batch_snapshot_operation_error_list = snapshot_error_message listtype nonrec batch_delete_cluster_snapshots_result = {errors : batch_snapshot_operation_error_list option;A list of any errors returned.
*)resources : snapshot_identifier_list option;A list of the snapshot identifiers that were deleted.
*)}type nonrec delete_cluster_snapshot_message_list =
delete_cluster_snapshot_message listtype nonrec batch_delete_cluster_snapshots_request = {identifiers : delete_cluster_snapshot_message_list;A list of identifiers for the snapshots that you want to delete.
*)}The authorization quota for the cluster security group has been reached.
The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.
The number of endpoint authorizations per cluster has exceeded its limit.
The authorization already exists for this endpoint.
type nonrec accept_reserved_node_exchange_output_message = {exchanged_reserved_node : reserved_node option;}type nonrec accept_reserved_node_exchange_input_message = {target_reserved_node_offering_id : string_;The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings
reserved_node_id : string_;A string representing the node identifier of the DC1 Reserved Node to be exchanged.
*)}