@datafire/amazonaws_redshift v5.0.0
@datafire/amazonaws_redshift
Client library for Amazon Redshift
Installation and Usage
npm install --save @datafire/amazonaws_redshift
let amazonaws_redshift = require('@datafire/amazonaws_redshift').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_redshift.AuthorizeClusterSecurityGroupIngress({
"ClusterSecurityGroupName": ""
}).then(data => {
console.log(data);
});
Description
Amazon Redshift Overview This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces. Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers. If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide. If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.
Actions
AuthorizeClusterSecurityGroupIngress
amazonaws_redshift.AuthorizeClusterSecurityGroupIngress({
"ClusterSecurityGroupName": ""
}, context)
Input
- input
object
Output
AuthorizeSnapshotAccess
amazonaws_redshift.AuthorizeSnapshotAccess({
"SnapshotIdentifier": "",
"AccountWithRestoreAccess": ""
}, context)
Input
- input
object
Output
CopyClusterSnapshot
amazonaws_redshift.CopyClusterSnapshot({
"SourceSnapshotIdentifier": "",
"TargetSnapshotIdentifier": ""
}, context)
Input
- input
object
Output
- output CopyClusterSnapshotResult
CreateCluster
amazonaws_redshift.CreateCluster({
"ClusterIdentifier": "",
"NodeType": "",
"MasterUsername": "",
"MasterUserPassword": ""
}, context)
Input
- input
object
- AdditionalInfo String
- AllowVersionUpgrade BooleanOptional
- AutomatedSnapshotRetentionPeriod IntegerOptional
- AvailabilityZone String
- ClusterIdentifier required String
- ClusterParameterGroupName String
- ClusterSecurityGroups ClusterSecurityGroupNameList
- ClusterSubnetGroupName String
- ClusterType String
- ClusterVersion String
- DBName String
- ElasticIp String
- Encrypted BooleanOptional
- EnhancedVpcRouting BooleanOptional
- HsmClientCertificateIdentifier String
- HsmConfigurationIdentifier String
- IamRoles IamRoleArnList
- KmsKeyId String
- MasterUserPassword required String
- MasterUsername required String
- NodeType required String
- NumberOfNodes IntegerOptional
- Port IntegerOptional
- PreferredMaintenanceWindow String
- PubliclyAccessible BooleanOptional
- Tags TagList
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
- output CreateClusterResult
CreateClusterParameterGroup
amazonaws_redshift.CreateClusterParameterGroup({
"ParameterGroupName": "",
"ParameterGroupFamily": "",
"Description": ""
}, context)
Input
- input
object
Output
CreateClusterSecurityGroup
amazonaws_redshift.CreateClusterSecurityGroup({
"ClusterSecurityGroupName": "",
"Description": ""
}, context)
Input
Output
CreateClusterSnapshot
amazonaws_redshift.CreateClusterSnapshot({
"SnapshotIdentifier": "",
"ClusterIdentifier": ""
}, context)
Input
Output
- output CreateClusterSnapshotResult
CreateClusterSubnetGroup
amazonaws_redshift.CreateClusterSubnetGroup({
"ClusterSubnetGroupName": "",
"Description": "",
"SubnetIds": []
}, context)
Input
- input
object
- ClusterSubnetGroupName required String
- Description required String
- SubnetIds required SubnetIdentifierList
- Tags TagList
Output
CreateEventSubscription
amazonaws_redshift.CreateEventSubscription({
"SubscriptionName": "",
"SnsTopicArn": ""
}, context)
Input
- input
object
- Enabled BooleanOptional
- EventCategories EventCategoriesList
- Severity String
- SnsTopicArn required String
- SourceIds SourceIdsList
- SourceType String
- SubscriptionName required String
- Tags TagList
Output
CreateHsmClientCertificate
amazonaws_redshift.CreateHsmClientCertificate({
"HsmClientCertificateIdentifier": ""
}, context)
Input
Output
CreateHsmConfiguration
amazonaws_redshift.CreateHsmConfiguration({
"HsmConfigurationIdentifier": "",
"Description": "",
"HsmIpAddress": "",
"HsmPartitionName": "",
"HsmPartitionPassword": "",
"HsmServerPublicCertificate": ""
}, context)
Input
- input
object
Output
- output CreateHsmConfigurationResult
CreateSnapshotCopyGrant
amazonaws_redshift.CreateSnapshotCopyGrant({
"SnapshotCopyGrantName": ""
}, context)
Input
Output
CreateTags
amazonaws_redshift.CreateTags({
"ResourceName": "",
"Tags": []
}, context)
Input
Output
Output schema unknown
DeleteCluster
amazonaws_redshift.DeleteCluster({
"ClusterIdentifier": ""
}, context)
Input
- input
object
Output
- output DeleteClusterResult
DeleteClusterParameterGroup
amazonaws_redshift.DeleteClusterParameterGroup({
"ParameterGroupName": ""
}, context)
Input
- input
object
- ParameterGroupName required String
Output
Output schema unknown
DeleteClusterSecurityGroup
amazonaws_redshift.DeleteClusterSecurityGroup({
"ClusterSecurityGroupName": ""
}, context)
Input
- input
object
- ClusterSecurityGroupName required String
Output
Output schema unknown
DeleteClusterSnapshot
amazonaws_redshift.DeleteClusterSnapshot({
"SnapshotIdentifier": ""
}, context)
Input
Output
- output DeleteClusterSnapshotResult
DeleteClusterSubnetGroup
amazonaws_redshift.DeleteClusterSubnetGroup({
"ClusterSubnetGroupName": ""
}, context)
Input
- input
object
- ClusterSubnetGroupName required String
Output
Output schema unknown
DeleteEventSubscription
amazonaws_redshift.DeleteEventSubscription({
"SubscriptionName": ""
}, context)
Input
- input
object
- SubscriptionName required String
Output
Output schema unknown
DeleteHsmClientCertificate
amazonaws_redshift.DeleteHsmClientCertificate({
"HsmClientCertificateIdentifier": ""
}, context)
Input
- input
object
- HsmClientCertificateIdentifier required String
Output
Output schema unknown
DeleteHsmConfiguration
amazonaws_redshift.DeleteHsmConfiguration({
"HsmConfigurationIdentifier": ""
}, context)
Input
- input
object
- HsmConfigurationIdentifier required String
Output
Output schema unknown
DeleteSnapshotCopyGrant
amazonaws_redshift.DeleteSnapshotCopyGrant({
"SnapshotCopyGrantName": ""
}, context)
Input
- input
object
- SnapshotCopyGrantName required String
Output
Output schema unknown
DeleteTags
amazonaws_redshift.DeleteTags({
"ResourceName": "",
"TagKeys": []
}, context)
Input
- input
object
- ResourceName required String
- TagKeys required TagKeyList
Output
Output schema unknown
DescribeClusterParameterGroups
amazonaws_redshift.DescribeClusterParameterGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Marker String
- MaxRecords IntegerOptional
- ParameterGroupName String
- TagKeys TagKeyList
- TagValues TagValueList
- MaxRecords
Output
DescribeClusterParameters
amazonaws_redshift.DescribeClusterParameters({
"ParameterGroupName": ""
}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Marker String
- MaxRecords IntegerOptional
- ParameterGroupName required String
- Source String
- MaxRecords
Output
- output ClusterParameterGroupDetails
DescribeClusterSecurityGroups
amazonaws_redshift.DescribeClusterSecurityGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- ClusterSecurityGroupName String
- Marker String
- MaxRecords IntegerOptional
- TagKeys TagKeyList
- TagValues TagValueList
- MaxRecords
Output
- output ClusterSecurityGroupMessage
DescribeClusterSnapshots
amazonaws_redshift.DescribeClusterSnapshots({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- ClusterIdentifier String
- EndTime TStamp
- Marker String
- MaxRecords IntegerOptional
- OwnerAccount String
- SnapshotIdentifier String
- SnapshotType String
- StartTime TStamp
- TagKeys TagKeyList
- TagValues TagValueList
- MaxRecords
Output
- output SnapshotMessage
DescribeClusterSubnetGroups
amazonaws_redshift.DescribeClusterSubnetGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- ClusterSubnetGroupName String
- Marker String
- MaxRecords IntegerOptional
- TagKeys TagKeyList
- TagValues TagValueList
- MaxRecords
Output
- output ClusterSubnetGroupMessage
DescribeClusterVersions
amazonaws_redshift.DescribeClusterVersions({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- ClusterParameterGroupFamily String
- ClusterVersion String
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output ClusterVersionsMessage
DescribeClusters
amazonaws_redshift.DescribeClusters({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- ClusterIdentifier String
- Marker String
- MaxRecords IntegerOptional
- TagKeys TagKeyList
- TagValues TagValueList
- MaxRecords
Output
- output ClustersMessage
DescribeDefaultClusterParameters
amazonaws_redshift.DescribeDefaultClusterParameters({
"ParameterGroupFamily": ""
}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Marker String
- MaxRecords IntegerOptional
- ParameterGroupFamily required String
- MaxRecords
Output
DescribeEventCategories
amazonaws_redshift.DescribeEventCategories({}, context)
Input
- input
object
- SourceType String
Output
- output EventCategoriesMessage
DescribeEventSubscriptions
amazonaws_redshift.DescribeEventSubscriptions({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Marker String
- MaxRecords IntegerOptional
- SubscriptionName String
- TagKeys TagKeyList
- TagValues TagValueList
- MaxRecords
Output
- output EventSubscriptionsMessage
DescribeEvents
amazonaws_redshift.DescribeEvents({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Duration IntegerOptional
- EndTime TStamp
- Marker String
- MaxRecords IntegerOptional
- SourceIdentifier String
- SourceType SourceType
- StartTime TStamp
- MaxRecords
Output
- output EventsMessage
DescribeHsmClientCertificates
amazonaws_redshift.DescribeHsmClientCertificates({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- HsmClientCertificateIdentifier String
- Marker String
- MaxRecords IntegerOptional
- TagKeys TagKeyList
- TagValues TagValueList
- MaxRecords
Output
- output HsmClientCertificateMessage
DescribeHsmConfigurations
amazonaws_redshift.DescribeHsmConfigurations({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- HsmConfigurationIdentifier String
- Marker String
- MaxRecords IntegerOptional
- TagKeys TagKeyList
- TagValues TagValueList
- MaxRecords
Output
- output HsmConfigurationMessage
DescribeLoggingStatus
amazonaws_redshift.DescribeLoggingStatus({
"ClusterIdentifier": ""
}, context)
Input
- input
object
- ClusterIdentifier required String
Output
- output LoggingStatus
DescribeOrderableClusterOptions
amazonaws_redshift.DescribeOrderableClusterOptions({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- ClusterVersion String
- Marker String
- MaxRecords IntegerOptional
- NodeType String
- MaxRecords
Output
DescribeReservedNodeOfferings
amazonaws_redshift.DescribeReservedNodeOfferings({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Marker String
- MaxRecords IntegerOptional
- ReservedNodeOfferingId String
- MaxRecords
Output
- output ReservedNodeOfferingsMessage
DescribeReservedNodes
amazonaws_redshift.DescribeReservedNodes({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Marker String
- MaxRecords IntegerOptional
- ReservedNodeId String
- MaxRecords
Output
- output ReservedNodesMessage
DescribeResize
amazonaws_redshift.DescribeResize({
"ClusterIdentifier": ""
}, context)
Input
- input
object
- ClusterIdentifier required String
Output
- output ResizeProgressMessage
DescribeSnapshotCopyGrants
amazonaws_redshift.DescribeSnapshotCopyGrants({}, context)
Input
- input
object
- Marker String
- MaxRecords IntegerOptional
- SnapshotCopyGrantName String
- TagKeys TagKeyList
- TagValues TagValueList
Output
- output SnapshotCopyGrantMessage
DescribeTableRestoreStatus
amazonaws_redshift.DescribeTableRestoreStatus({}, context)
Input
- input
object
- ClusterIdentifier String
- Marker String
- MaxRecords IntegerOptional
- TableRestoreRequestId String
Output
- output TableRestoreStatusMessage
DescribeTags
amazonaws_redshift.DescribeTags({}, context)
Input
- input
object
- Marker String
- MaxRecords IntegerOptional
- ResourceName String
- ResourceType String
- TagKeys TagKeyList
- TagValues TagValueList
Output
- output TaggedResourceListMessage
DisableLogging
amazonaws_redshift.DisableLogging({
"ClusterIdentifier": ""
}, context)
Input
- input
object
- ClusterIdentifier required String
Output
- output LoggingStatus
DisableSnapshotCopy
amazonaws_redshift.DisableSnapshotCopy({
"ClusterIdentifier": ""
}, context)
Input
- input
object
- ClusterIdentifier required String
Output
- output DisableSnapshotCopyResult
EnableLogging
amazonaws_redshift.EnableLogging({
"ClusterIdentifier": "",
"BucketName": ""
}, context)
Input
Output
- output LoggingStatus
EnableSnapshotCopy
amazonaws_redshift.EnableSnapshotCopy({
"ClusterIdentifier": "",
"DestinationRegion": ""
}, context)
Input
- input
object
- ClusterIdentifier required String
- DestinationRegion required String
- RetentionPeriod IntegerOptional
- SnapshotCopyGrantName String
Output
- output EnableSnapshotCopyResult
GetClusterCredentials
amazonaws_redshift.GetClusterCredentials({
"DbUser": "",
"ClusterIdentifier": ""
}, context)
Input
- input
object
- AutoCreate BooleanOptional
- ClusterIdentifier required String
- DbGroups DbGroupList
- DbName String
- DbUser required String
- DurationSeconds IntegerOptional
Output
- output ClusterCredentials
ModifyCluster
amazonaws_redshift.ModifyCluster({
"ClusterIdentifier": ""
}, context)
Input
- input
object
- AllowVersionUpgrade BooleanOptional
- AutomatedSnapshotRetentionPeriod IntegerOptional
- ClusterIdentifier required String
- ClusterParameterGroupName String
- ClusterSecurityGroups ClusterSecurityGroupNameList
- ClusterType String
- ClusterVersion String
- ElasticIp String
- EnhancedVpcRouting BooleanOptional
- HsmClientCertificateIdentifier String
- HsmConfigurationIdentifier String
- MasterUserPassword String
- NewClusterIdentifier String
- NodeType String
- NumberOfNodes IntegerOptional
- PreferredMaintenanceWindow String
- PubliclyAccessible BooleanOptional
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
- output ModifyClusterResult
ModifyClusterIamRoles
amazonaws_redshift.ModifyClusterIamRoles({
"ClusterIdentifier": ""
}, context)
Input
- input
object
- AddIamRoles IamRoleArnList
- ClusterIdentifier required String
- RemoveIamRoles IamRoleArnList
Output
- output ModifyClusterIamRolesResult
ModifyClusterParameterGroup
amazonaws_redshift.ModifyClusterParameterGroup({
"ParameterGroupName": "",
"Parameters": []
}, context)
Input
- input
object
- ParameterGroupName required String
- Parameters required ParametersList
Output
ModifyClusterSubnetGroup
amazonaws_redshift.ModifyClusterSubnetGroup({
"ClusterSubnetGroupName": "",
"SubnetIds": []
}, context)
Input
- input
object
- ClusterSubnetGroupName required String
- Description String
- SubnetIds required SubnetIdentifierList
Output
ModifyEventSubscription
amazonaws_redshift.ModifyEventSubscription({
"SubscriptionName": ""
}, context)
Input
- input
object
- Enabled BooleanOptional
- EventCategories EventCategoriesList
- Severity String
- SnsTopicArn String
- SourceIds SourceIdsList
- SourceType String
- SubscriptionName required String
Output
ModifySnapshotCopyRetentionPeriod
amazonaws_redshift.ModifySnapshotCopyRetentionPeriod({
"ClusterIdentifier": "",
"RetentionPeriod": 0
}, context)
Input
Output
PurchaseReservedNodeOffering
amazonaws_redshift.PurchaseReservedNodeOffering({
"ReservedNodeOfferingId": ""
}, context)
Input
- input
object
- NodeCount IntegerOptional
- ReservedNodeOfferingId required String
Output
RebootCluster
amazonaws_redshift.RebootCluster({
"ClusterIdentifier": ""
}, context)
Input
- input
object
- ClusterIdentifier required String
Output
- output RebootClusterResult
ResetClusterParameterGroup
amazonaws_redshift.ResetClusterParameterGroup({
"ParameterGroupName": ""
}, context)
Input
- input
object
- ParameterGroupName required String
- Parameters ParametersList
- ResetAllParameters Boolean
Output
RestoreFromClusterSnapshot
amazonaws_redshift.RestoreFromClusterSnapshot({
"ClusterIdentifier": "",
"SnapshotIdentifier": ""
}, context)
Input
- input
object
- AdditionalInfo String
- AllowVersionUpgrade BooleanOptional
- AutomatedSnapshotRetentionPeriod IntegerOptional
- AvailabilityZone String
- ClusterIdentifier required String
- ClusterParameterGroupName String
- ClusterSecurityGroups ClusterSecurityGroupNameList
- ClusterSubnetGroupName String
- ElasticIp String
- EnhancedVpcRouting BooleanOptional
- HsmClientCertificateIdentifier String
- HsmConfigurationIdentifier String
- IamRoles IamRoleArnList
- KmsKeyId String
- NodeType String
- OwnerAccount String
- Port IntegerOptional
- PreferredMaintenanceWindow String
- PubliclyAccessible BooleanOptional
- SnapshotClusterIdentifier String
- SnapshotIdentifier required String
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
RestoreTableFromClusterSnapshot
amazonaws_redshift.RestoreTableFromClusterSnapshot({
"ClusterIdentifier": "",
"SnapshotIdentifier": "",
"SourceDatabaseName": "",
"SourceTableName": "",
"NewTableName": ""
}, context)
Input
- input
object
Output
RevokeClusterSecurityGroupIngress
amazonaws_redshift.RevokeClusterSecurityGroupIngress({
"ClusterSecurityGroupName": ""
}, context)
Input
- input
object
Output
RevokeSnapshotAccess
amazonaws_redshift.RevokeSnapshotAccess({
"SnapshotIdentifier": "",
"AccountWithRestoreAccess": ""
}, context)
Input
- input
object
Output
- output RevokeSnapshotAccessResult
RotateEncryptionKey
amazonaws_redshift.RotateEncryptionKey({
"ClusterIdentifier": ""
}, context)
Input
- input
object
- ClusterIdentifier required String
Output
- output RotateEncryptionKeyResult
Definitions
AccessToSnapshotDeniedFault
- AccessToSnapshotDeniedFault
object
: The owner of the specified snapshot has not authorized your account to access the snapshot.
AccountWithRestoreAccess
- AccountWithRestoreAccess
object
: Describes an AWS customer account authorized to restore a snapshot.
AccountsWithRestoreAccessList
- AccountsWithRestoreAccessList
array
- items AccountWithRestoreAccess
AuthorizationAlreadyExistsFault
- AuthorizationAlreadyExistsFault
object
: The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.
AuthorizationNotFoundFault
- AuthorizationNotFoundFault
object
: The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.
AuthorizationQuotaExceededFault
- AuthorizationQuotaExceededFault
object
: The authorization quota for the cluster security group has been reached.
AuthorizeClusterSecurityGroupIngressMessage
- AuthorizeClusterSecurityGroupIngressMessage
object
:
AuthorizeClusterSecurityGroupIngressResult
- AuthorizeClusterSecurityGroupIngressResult
object
- ClusterSecurityGroup ClusterSecurityGroup
AuthorizeSnapshotAccessMessage
- AuthorizeSnapshotAccessMessage
object
:
AuthorizeSnapshotAccessResult
- AuthorizeSnapshotAccessResult
object
- Snapshot Snapshot
AvailabilityZone
- AvailabilityZone
object
: Describes an availability zone.- Name String
AvailabilityZoneList
- AvailabilityZoneList
array
- items AvailabilityZone
Boolean
- Boolean
boolean
BooleanOptional
- BooleanOptional
boolean
BucketNotFoundFault
- BucketNotFoundFault
object
: Could not find the specified S3 bucket.
Cluster
- Cluster
object
: Describes a cluster.- AllowVersionUpgrade Boolean
- AutomatedSnapshotRetentionPeriod Integer
- AvailabilityZone String
- ClusterCreateTime TStamp
- ClusterIdentifier String
- ClusterNodes ClusterNodesList
- ClusterParameterGroups ClusterParameterGroupStatusList
- ClusterPublicKey String
- ClusterRevisionNumber String
- ClusterSecurityGroups ClusterSecurityGroupMembershipList
- ClusterSnapshotCopyStatus ClusterSnapshotCopyStatus
- ClusterStatus String
- ClusterSubnetGroupName String
- ClusterVersion String
- DBName String
- ElasticIpStatus ElasticIpStatus
- Encrypted Boolean
- Endpoint Endpoint
- EnhancedVpcRouting Boolean
- HsmStatus HsmStatus
- IamRoles ClusterIamRoleList
- KmsKeyId String
- MasterUsername String
- ModifyStatus String
- NodeType String
- NumberOfNodes Integer
- PendingModifiedValues PendingModifiedValues
- PreferredMaintenanceWindow String
- PubliclyAccessible Boolean
- RestoreStatus RestoreStatus
- Tags TagList
- VpcId String
- VpcSecurityGroups VpcSecurityGroupMembershipList
ClusterAlreadyExistsFault
- ClusterAlreadyExistsFault
object
: The account already has a cluster with the given identifier.
ClusterCredentials
- ClusterCredentials
object
: Temporary credentials with authorization to log on to an Amazon Redshift database.- DbPassword SensitiveString
- DbUser String
- Expiration TStamp
ClusterIamRole
- ClusterIamRole
object
: An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS services.
ClusterIamRoleList
- ClusterIamRoleList
array
- items ClusterIamRole
ClusterList
- ClusterList
array
- items Cluster
ClusterNode
- ClusterNode
object
: The identifier of a node in a cluster.
ClusterNodesList
- ClusterNodesList
array
- items ClusterNode
ClusterNotFoundFault
- ClusterNotFoundFault
object
: The ClusterIdentifier parameter does not refer to an existing cluster.
ClusterParameterGroup
- ClusterParameterGroup
object
: Describes a parameter group.
ClusterParameterGroupAlreadyExistsFault
- ClusterParameterGroupAlreadyExistsFault
object
: A cluster parameter group with the same name already exists.
ClusterParameterGroupDetails
- ClusterParameterGroupDetails
object
: Contains the output from the DescribeClusterParameters action.- Marker String
- Parameters ParametersList
ClusterParameterGroupNameMessage
ClusterParameterGroupNotFoundFault
- ClusterParameterGroupNotFoundFault
object
: The parameter group name does not refer to an existing parameter group.
ClusterParameterGroupQuotaExceededFault
- ClusterParameterGroupQuotaExceededFault
object
: 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.
ClusterParameterGroupStatus
- ClusterParameterGroupStatus
object
: Describes the status of a parameter group.- ClusterParameterStatusList ClusterParameterStatusList
- ParameterApplyStatus String
- ParameterGroupName String
ClusterParameterGroupStatusList
- ClusterParameterGroupStatusList
array
ClusterParameterGroupsMessage
- ClusterParameterGroupsMessage
object
: Contains the output from the DescribeClusterParameterGroups action.- Marker String
- ParameterGroups ParameterGroupList
ClusterParameterStatus
- ClusterParameterStatus
object
: Describes the status of a parameter group.
ClusterParameterStatusList
- ClusterParameterStatusList
array
- items ClusterParameterStatus
ClusterQuotaExceededFault
- ClusterQuotaExceededFault
object
: 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.
ClusterSecurityGroup
- ClusterSecurityGroup
object
: Describes a security group.- ClusterSecurityGroupName String
- Description String
- EC2SecurityGroups EC2SecurityGroupList
- IPRanges IPRangeList
- Tags TagList
ClusterSecurityGroupAlreadyExistsFault
- ClusterSecurityGroupAlreadyExistsFault
object
: A cluster security group with the same name already exists.
ClusterSecurityGroupMembership
- ClusterSecurityGroupMembership
object
: Describes a cluster security group.
ClusterSecurityGroupMembershipList
- ClusterSecurityGroupMembershipList
array
ClusterSecurityGroupMessage
- ClusterSecurityGroupMessage
object
:- ClusterSecurityGroups ClusterSecurityGroups
- Marker String
ClusterSecurityGroupNameList
- ClusterSecurityGroupNameList
array
- items String
ClusterSecurityGroupNotFoundFault
- ClusterSecurityGroupNotFoundFault
object
: The cluster security group name does not refer to an existing cluster security group.
ClusterSecurityGroupQuotaExceededFault
- ClusterSecurityGroupQuotaExceededFault
object
: 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.
ClusterSecurityGroups
- ClusterSecurityGroups
array
- items ClusterSecurityGroup
ClusterSnapshotAlreadyExistsFault
- ClusterSnapshotAlreadyExistsFault
object
: The value specified as a snapshot identifier is already used by an existing snapshot.
ClusterSnapshotCopyStatus
- ClusterSnapshotCopyStatus
object
: Returns the destination region and retention period that are configured for cross-region snapshot copy.
ClusterSnapshotNotFoundFault
- ClusterSnapshotNotFoundFault
object
: The snapshot identifier does not refer to an existing cluster snapshot.
ClusterSnapshotQuotaExceededFault
- ClusterSnapshotQuotaExceededFault
object
: The request would result in the user exceeding the allowed number of cluster snapshots.
ClusterSubnetGroup
- ClusterSubnetGroup
object
: Describes a subnet group.
ClusterSubnetGroupAlreadyExistsFault
- ClusterSubnetGroupAlreadyExistsFault
object
: A ClusterSubnetGroupName is already used by an existing cluster subnet group.
ClusterSubnetGroupMessage
- ClusterSubnetGroupMessage
object
: Contains the output from the DescribeClusterSubnetGroups action.- ClusterSubnetGroups ClusterSubnetGroups
- Marker String
ClusterSubnetGroupNotFoundFault
- ClusterSubnetGroupNotFoundFault
object
: The cluster subnet group name does not refer to an existing cluster subnet group.
ClusterSubnetGroupQuotaExceededFault
- ClusterSubnetGroupQuotaExceededFault
object
: 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.
ClusterSubnetGroups
- ClusterSubnetGroups
array
- items ClusterSubnetGroup
ClusterSubnetQuotaExceededFault
- ClusterSubnetQuotaExceededFault
object
: 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.
ClusterVersion
- ClusterVersion
object
: Describes a cluster version, including the parameter group family and description of the version.
ClusterVersionList
- ClusterVersionList
array
- items ClusterVersion
ClusterVersionsMessage
- ClusterVersionsMessage
object
: Contains the output from the DescribeClusterVersions action.- ClusterVersions ClusterVersionList
- Marker String
ClustersMessage
- ClustersMessage
object
: Contains the output from the DescribeClusters action.- Clusters ClusterList
- Marker String
CopyClusterSnapshotMessage
- CopyClusterSnapshotMessage
object
:
CopyClusterSnapshotResult
- CopyClusterSnapshotResult
object
- Snapshot Snapshot
CopyToRegionDisabledFault
- CopyToRegionDisabledFault
object
: Cross-region snapshot copy was temporarily disabled. Try your request again.
CreateClusterMessage
- CreateClusterMessage
object
:- AdditionalInfo String
- AllowVersionUpgrade BooleanOptional
- AutomatedSnapshotRetentionPeriod IntegerOptional
- AvailabilityZone String
- ClusterIdentifier required String
- ClusterParameterGroupName String
- ClusterSecurityGroups ClusterSecurityGroupNameList
- ClusterSubnetGroupName String
- ClusterType String
- ClusterVersion String
- DBName String
- ElasticIp String
- Encrypted BooleanOptional
- EnhancedVpcRouting BooleanOptional
- HsmClientCertificateIdentifier String
- HsmConfigurationIdentifier String
- IamRoles IamRoleArnList
- KmsKeyId String
- MasterUserPassword required String
- MasterUsername required String
- NodeType required String
- NumberOfNodes IntegerOptional
- Port IntegerOptional
- PreferredMaintenanceWindow String
- PubliclyAccessible BooleanOptional
- Tags TagList
- VpcSecurityGroupIds VpcSecurityGroupIdList
CreateClusterParameterGroupMessage
- CreateClusterParameterGroupMessage
object
:
CreateClusterParameterGroupResult
- CreateClusterParameterGroupResult
object
- ClusterParameterGroup ClusterParameterGroup
CreateClusterResult
- CreateClusterResult
object
- Cluster Cluster
CreateClusterSecurityGroupMessage
- CreateClusterSecurityGroupMessage
object
:
CreateClusterSecurityGroupResult
- CreateClusterSecurityGroupResult
object
- ClusterSecurityGroup ClusterSecurityGroup
CreateClusterSnapshotMessage
- CreateClusterSnapshotMessage
object
:
CreateClusterSnapshotResult
- CreateClusterSnapshotResult
object
- Snapshot Snapshot
CreateClusterSubnetGroupMessage
- CreateClusterSubnetGroupMessage
object
:- ClusterSubnetGroupName required String
- Description required String
- SubnetIds required SubnetIdentifierList
- Tags TagList
CreateClusterSubnetGroupResult
- CreateClusterSubnetGroupResult
object
- ClusterSubnetGroup ClusterSubnetGroup
CreateEventSubscriptionMessage
- CreateEventSubscriptionMessage
object
:- Enabled BooleanOptional
- EventCategories EventCategoriesList
- Severity String
- SnsTopicArn required String
- SourceIds SourceIdsList
- SourceType String
- SubscriptionName required String
- Tags TagList
CreateEventSubscriptionResult
- CreateEventSubscriptionResult
object
- EventSubscription EventSubscription
CreateHsmClientCertificateMessage
- CreateHsmClientCertificateMessage
object
:
CreateHsmClientCertificateResult
- CreateHsmClientCertificateResult
object
- HsmClientCertificate HsmClientCertificate
CreateHsmConfigurationMessage
- CreateHsmConfigurationMessage
object
:
CreateHsmConfigurationResult
- CreateHsmConfigurationResult
object
- HsmConfiguration HsmConfiguration
CreateSnapshotCopyGrantMessage
- CreateSnapshotCopyGrantMessage
object
: The result of the CreateSnapshotCopyGrant action.
CreateSnapshotCopyGrantResult
- CreateSnapshotCopyGrantResult
object
- SnapshotCopyGrant SnapshotCopyGrant
CreateTagsMessage
- CreateTagsMessage
object
: Contains the output from the CreateTags action.
DbGroupList
- DbGroupList
array
- items String
DefaultClusterParameters
- DefaultClusterParameters
object
: Describes the default cluster parameters for a parameter group family.- Marker String
- ParameterGroupFamily String
- Parameters ParametersList
DeleteClusterMessage
- DeleteClusterMessage
object
:
DeleteClusterParameterGroupMessage
- DeleteClusterParameterGroupMessage
object
:- ParameterGroupName required String
DeleteClusterResult
- DeleteClusterResult
object
- Cluster Cluster
DeleteClusterSecurityGroupMessage
- DeleteClusterSecurityGroupMessage
object
:- ClusterSecurityGroupName required String
DeleteClusterSnapshotMessage
- DeleteClusterSnapshotMessage
object
:
DeleteClusterSnapshotResult
- DeleteClusterSnapshotResult
object
- Snapshot Snapshot
DeleteClusterSubnetGroupMessage
- DeleteClusterSubnetGroupMessage
object
:- ClusterSubnetGroupName required String
DeleteEventSubscriptionMessage
- DeleteEventSubscriptionMessage
object
:- SubscriptionName required String
DeleteHsmClientCertificateMessage
- DeleteHsmClientCertificateMessage
object
:- HsmClientCertificateIdentifier required String
DeleteHsmConfigurationMessage
- DeleteHsmConfigurationMessage
object
:- HsmConfigurationIdentifier required String
DeleteSnapshotCopyGrantMessage
- DeleteSnapshotCopyGrantMessage
object
: The result of the DeleteSnapshotCopyGrant action.- SnapshotCopyGrantName required String
DeleteTagsMessage
- DeleteTagsMessage
object
: Contains the output from the DeleteTags action.- ResourceName required String
- TagKeys required TagKeyList
DependentServiceRequestThrottlingFault
- DependentServiceRequestThrottlingFault
object
: The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.
DependentServiceUnavailableFault
- DependentServiceUnavailableFault
object
: Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
DescribeClusterParameterGroupsMessage
- DescribeClusterParameterGroupsMessage
object
:- Marker String
- MaxRecords IntegerOptional
- ParameterGroupName String
- TagKeys TagKeyList
- TagValues TagValueList
DescribeClusterParametersMessage
- DescribeClusterParametersMessage
object
:- Marker String
- MaxRecords IntegerOptional
- ParameterGroupName required String
- Source String
DescribeClusterSecurityGroupsMessage
- DescribeClusterSecurityGroupsMessage
object
:- ClusterSecurityGroupName String
- Marker String
- MaxRecords IntegerOptional
- TagKeys TagKeyList
- TagValues TagValueList
DescribeClusterSnapshotsMessage
- DescribeClusterSnapshotsMessage
object
:- ClusterIdentifier String
- EndTime TStamp
- Marker String
- MaxRecords IntegerOptional
- OwnerAccount String
- SnapshotIdentifier String
- SnapshotType String
- StartTime TStamp
- TagKeys TagKeyList
- TagValues TagValueList
DescribeClusterSubnetGroupsMessage
- DescribeClusterSubnetGroupsMessage
object
:- ClusterSubnetGroupName String
- Marker String
- MaxRecords IntegerOptional
- TagKeys TagKeyList
- TagValues TagValueList
DescribeClusterVersionsMessage
- DescribeClusterVersionsMessage
object
:- ClusterParameterGroupFamily String
- ClusterVersion String
- Marker String
- MaxRecords IntegerOptional
DescribeClustersMessage
- DescribeClustersMessage
object
:- ClusterIdentifier String
- Marker String
- MaxRecords IntegerOptional
- TagKeys TagKeyList
- TagValues TagValueList
DescribeDefaultClusterParametersMessage
- DescribeDefaultClusterParametersMessage
object
:- Marker String
- MaxRecords IntegerOptional
- ParameterGroupFamily required String
DescribeDefaultClusterParametersResult
- DescribeDefaultClusterParametersResult
object
- DefaultClusterParameters DefaultClusterParameters
DescribeEventCategoriesMessage
- DescribeEventCategoriesMessage
object
:- SourceType String
DescribeEventSubscriptionsMessage
- DescribeEventSubscriptionsMessage
object
:- Marker String
- MaxRecords IntegerOptional
- SubscriptionName String
- TagKeys TagKeyList
- TagValues TagValueList
DescribeEventsMessage
- DescribeEventsMessage
object
:- Duration IntegerOptional
- EndTime TStamp
- Marker String
- MaxRecords IntegerOptional
- SourceIdentifier String
- SourceType SourceType
- StartTime TStamp
DescribeHsmClientCertificatesMessage
- DescribeHsmClientCertificatesMessage
object
:- HsmClientCertificateIdentifier String
- Marker String
- MaxRecords IntegerOptional
- TagKeys TagKeyList
- TagValues TagValueList
DescribeHsmConfigurationsMessage
- DescribeHsmConfigurationsMessage
object
:- HsmConfigurationIdentifier String
- Marker String
- MaxRecords IntegerOptional
- TagKeys TagKeyList
- TagValues TagValueList
DescribeLoggingStatusMessage
- DescribeLoggingStatusMessage
object
:- ClusterIdentifier required String
DescribeOrderableClusterOptionsMessage
- DescribeOrderableClusterOptionsMessage
object
:- ClusterVersion String
- Marker String
- MaxRecords IntegerOptional
- NodeType String
DescribeReservedNodeOfferingsMessage
- DescribeReservedNodeOfferingsMessage
object
:- Marker String
- MaxRecords IntegerOptional
- ReservedNodeOfferingId String
DescribeReservedNodesMessage
- DescribeReservedNodesMessage
object
:- Marker String
- MaxRecords IntegerOptional
- ReservedNodeId String
DescribeResizeMessage
- DescribeResizeMessage
object
:- ClusterIdentifier required String
DescribeSnapshotCopyGrantsMessage
- DescribeSnapshotCopyGrantsMessage
object
: The result of the DescribeSnapshotCopyGrants action.- Marker String
- MaxRecords IntegerOptional
- SnapshotCopyGrantName String
- TagKeys TagKeyList
- TagValues TagValueList
DescribeTableRestoreStatusMessage
- DescribeTableRestoreStatusMessage
object
:- ClusterIdentifier String
- Marker String
- MaxRecords IntegerOptional
- TableRestoreRequestId String
DescribeTagsMessage
- DescribeTagsMessage
object
:- Marker String
- MaxRecords IntegerOptional
- ResourceName String
- ResourceType String
- TagKeys TagKeyList
- TagValues TagValueList
DisableLoggingMessage
- DisableLoggingMessage
object
:- ClusterIdentifier required String
DisableSnapshotCopyMessage
- DisableSnapshotCopyMessage
object
:- ClusterIdentifier required String
DisableSnapshotCopyResult
- DisableSnapshotCopyResult
object
- Cluster Cluster
Double
- Double
number
DoubleOptional
- DoubleOptional
number
EC2SecurityGroup
- EC2SecurityGroup
object
: Describes an Amazon EC2 security group.
EC2SecurityGroupList
- EC2SecurityGroupList
array
- items EC2SecurityGroup
ElasticIpStatus
- ElasticIpStatus
object
: Describes the status of the elastic IP (EIP) address.
EnableLoggingMessage
- EnableLoggingMessage
object
:
EnableSnapshotCopyMessage
- EnableSnapshotCopyMessage
object
:- ClusterIdentifier required String
- DestinationRegion required String
- RetentionPeriod IntegerOptional
- SnapshotCopyGrantName String
EnableSnapshotCopyResult
- EnableSnapshotCopyResult
object
- Cluster Cluster
Endpoint
Event
- Event
object
: Describes an event.- Date TStamp
- EventCategories EventCategoriesList
- EventId String
- Message String
- Severity String
- SourceIdentifier String
- SourceType SourceType
EventCategoriesList
- EventCategoriesList
array
- items String
EventCategoriesMap
- EventCategoriesMap
object
: Describes event categories.- Events EventInfoMapList
- SourceType String
EventCategoriesMapList
- EventCategoriesMapList
array
- items EventCategoriesMap
EventCategoriesMessage
- EventCategoriesMessage
object
:- EventCategoriesMapList EventCategoriesMapList
EventInfoMap
- EventInfoMap
object
: Describes event information.- EventCategories EventCategoriesList
- EventDescription String
- EventId String
- Severity String
EventInfoMapList
- EventInfoMapList
array
- items EventInfoMap
EventList
- EventList
array
- items Event
EventSubscription
- EventSubscription
object
: Describes event subscriptions.
EventSubscriptionQuotaExceededFault
- EventSubscriptionQuotaExceededFault
object
: 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.
EventSubscriptionsList
- EventSubscriptionsList
array
- items EventSubscription
EventSubscriptionsMessage
- EventSubscriptionsMessage
object
:- EventSubscriptionsList EventSubscriptionsList
- Marker String
EventsMessage
GetClusterCredentialsMessage
- GetClusterCredentialsMessage
object
: The request parameters to get cluster credentials.- AutoCreate BooleanOptional
- ClusterIdentifier required String
- DbGroups DbGroupList
- DbName String
- DbUser required String
- DurationSeconds IntegerOptional
HsmClientCertificate
- HsmClientCertificate
object
: 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.
HsmClientCertificateAlreadyExistsFault
- HsmClientCertificateAlreadyExistsFault
object
: There is already an existing Amazon Redshift HSM client certificate with the specified identifier.
HsmClientCertificateList
- HsmClientCertificateList
array
- items HsmClientCertificate
HsmClientCertificateMessage
- HsmClientCertificateMessage
object
:- HsmClientCertificates HsmClientCertificateList
- Marker String
HsmClientCertificateNotFoundFault
- HsmClientCertificateNotFoundFault
object
: There is no Amazon Redshift HSM client certificate with the specified identifier.
HsmClientCertificateQuotaExceededFault
- HsmClientCertificateQuotaExceededFault
object
: 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.
HsmConfiguration
- HsmConfiguration
object
: 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.
HsmConfigurationAlreadyExistsFault
- HsmConfigurationAlreadyExistsFault
object
: There is already an existing Amazon Redshift HSM configuration with the specified identifier.
HsmConfigurationList
- HsmConfigurationList
array
- items HsmConfiguration
HsmConfigurationMessage
- HsmConfigurationMessage
object
:- HsmConfigurations HsmConfigurationList
- Marker String
HsmConfigurationNotFoundFault
- HsmConfigurationNotFoundFault
object
: There is no Amazon Redshift HSM configuration with the specified identifier.
HsmConfigurationQuotaExceededFault
- HsmConfigurationQuotaExceededFault
object
: 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.
HsmStatus
- HsmStatus
object
: Describes the status of changes to HSM settings.
IPRange
- IPRange
object
: Describes an IP range used in a security group.
IPRangeList
- IPRangeList
array
- items IPRange
IamRoleArnList
- IamRoleArnList
array
- items String
ImportTablesCompleted
- ImportTablesCompleted
array
- items String
ImportTablesInProgress
- ImportTablesInProgress
array
- items String
ImportTablesNotStarted
- ImportTablesNotStarted
array
- items String
InProgressTableRestoreQuotaExceededFault
- InProgressTableRestoreQuotaExceededFault
object
: You have exceeded the allowed number of table restore requ