AWS Redshift #Action=DescribeClusters API
The #Action=DescribeClusters API from AWS Redshift — 1 operation(s) for #action=describeclusters.
The #Action=DescribeClusters API from AWS Redshift — 1 operation(s) for #action=describeclusters.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/aws-redshift-action-describeclusters-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 1.0.0
x-release: v4
title: 'Redshift Data API Service #Action=AcceptReservedNodeExchange #Action=AcceptReservedNodeExchange #Action=DescribeClusters #Action=Describe Clusters API'
description: <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: redshift-data
x-aws-signingName: redshift-data
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/redshift-data-2019-12-20.normal.json
converter:
url: https://github.com/mermade/aws2openapi
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://redshift-data.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Redshift Data API Service multi-region endpoint
- url: https://redshift-data.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Redshift Data API Service multi-region endpoint
- url: http://redshift-data.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
- url: https://redshift-data.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#Action=DescribeClusters'
paths:
/#Action=DescribeClusters:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
x-aws-operation-name: DescribeClusters
operationId: GET_DescribeClusters
description: <p>Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all clusters that have any combination of those values are returned.</p> <p>If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.</p>
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ClustersMessage'
'480':
description: ClusterNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterNotFoundFault'
'481':
description: InvalidTagFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidTagFault'
parameters:
- name: ClusterIdentifier
in: query
required: false
description: <p>The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.</p> <p>The default is that all clusters defined for an account are returned.</p>
schema:
type: string
maxLength: 2147483647
- name: MaxRecords
in: query
required: false
description: '<p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20, maximum 100.</p>'
schema:
type: integer
- name: Marker
in: query
required: false
description: '<p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeClusters</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </p> <p>Constraints: You can specify either the <b>ClusterIdentifier</b> parameter or the <b>Marker</b> parameter, but not both. </p>'
schema:
type: string
maxLength: 2147483647
- name: TagKeys
in: query
required: false
description: 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 <code>owner</code> and <code>environment</code>. 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.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: TagKey
- name: TagValues
in: query
required: false
description: 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 <code>admin</code> and <code>test</code>. 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.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: TagValue
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeClusters
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2012-12-01'
summary: Amazon Redshift - G E T_ Describe Clusters
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DescribeClusters'
post:
x-aws-operation-name: DescribeClusters
operationId: POST_DescribeClusters
description: <p>Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all clusters that have any combination of those values are returned.</p> <p>If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.</p>
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ClustersMessage'
'480':
description: ClusterNotFoundFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ClusterNotFoundFault'
'481':
description: InvalidTagFault
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidTagFault'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeClustersMessage'
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: Marker
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeClusters
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2012-12-01'
summary: Amazon Redshift - P O S T_ Describe Clusters
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DescribeClusters'
components:
schemas:
Endpoint:
type: object
properties:
Address:
allOf:
- $ref: '#/components/schemas/String'
- description: The DNS address of the Cluster.
Port:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The port that the database engine is listening on.
VpcEndpoints:
allOf:
- $ref: '#/components/schemas/VpcEndpointsList'
- description: Describes a connection endpoint.
description: Describes a connection endpoint.
ClusterIamRoleList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ClusterIamRole'
- xml:
name: ClusterIamRole
Integer:
type: integer
VpcSecurityGroupMembership:
type: object
properties:
VpcSecurityGroupId:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier of the VPC security group.
Status:
allOf:
- $ref: '#/components/schemas/String'
- description: The status of the VPC security group.
description: Describes the members of a VPC security group.
AquaStatus:
type: string
enum:
- enabled
- disabled
- applying
TagList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Tag'
- xml:
name: Tag
ClusterParameterGroupStatusList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ClusterParameterGroupStatus'
- xml:
name: ClusterParameterGroup
ResizeInfo:
type: object
properties:
ResizeType:
allOf:
- $ref: '#/components/schemas/String'
- description: Returns the value <code>ClassicResize</code>.
AllowCancelResize:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: A boolean value indicating if the resize operation can be cancelled.
description: Describes a resize operation.
Cluster:
type: object
properties:
ClusterIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: The unique identifier of the cluster.
NodeType:
allOf:
- $ref: '#/components/schemas/String'
- description: The node type for the nodes in the cluster.
ClusterStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: <p> The current state of the cluster. Possible values are the following:</p> <ul> <li> <p> <code>available</code> </p> </li> <li> <p> <code>available, prep-for-resize</code> </p> </li> <li> <p> <code>available, resize-cleanup</code> </p> </li> <li> <p> <code>cancelling-resize</code> </p> </li> <li> <p> <code>creating</code> </p> </li> <li> <p> <code>deleting</code> </p> </li> <li> <p> <code>final-snapshot</code> </p> </li> <li> <p> <code>hardware-failure</code> </p> </li> <li> <p> <code>incompatible-hsm</code> </p> </li> <li> <p> <code>incompatible-network</code> </p> </li> <li> <p> <code>incompatible-parameters</code> </p> </li> <li> <p> <code>incompatible-restore</code> </p> </li> <li> <p> <code>modifying</code> </p> </li> <li> <p> <code>paused</code> </p> </li> <li> <p> <code>rebooting</code> </p> </li> <li> <p> <code>renaming</code> </p> </li> <li> <p> <code>resizing</code> </p> </li> <li> <p> <code>rotating-keys</code> </p> </li> <li> <p> <code>storage-full</code> </p> </li> <li> <p> <code>updating-hsm</code> </p> </li> </ul>
ClusterAvailabilityStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The availability status of the cluster for queries. Possible values are the following:</p> <ul> <li> <p>Available - The cluster is available for queries. </p> </li> <li> <p>Unavailable - The cluster is not available for queries.</p> </li> <li> <p>Maintenance - The cluster is intermittently available for queries due to maintenance activities.</p> </li> <li> <p>Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.</p> </li> <li> <p>Failed - The cluster failed and is not available for queries.</p> </li> </ul>
ModifyStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: The status of a modify operation, if any, initiated for the cluster.
MasterUsername:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The admin user name for the cluster. This name is used to connect to the database that is specified in the <b>DBName</b> parameter. '
DBName:
allOf:
- $ref: '#/components/schemas/String'
- description: '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 <code>dev</code>dev was created by default. '
Endpoint:
allOf:
- $ref: '#/components/schemas/Endpoint'
- description: The connection endpoint.
ClusterCreateTime:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod:
allOf:
- $ref: '#/components/schemas/Integer'
- description: <p>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.</p> <p>The value must be either -1 or an integer between 1 and 3,653.</p>
ClusterSecurityGroups:
allOf:
- $ref: '#/components/schemas/ClusterSecurityGroupMembershipList'
- description: <p>A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains <code>ClusterSecurityGroup.Name</code> and <code>ClusterSecurityGroup.Status</code> subelements. </p> <p>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 <b>VpcSecurityGroups</b> parameter. </p>
VpcSecurityGroups:
allOf:
- $ref: '#/components/schemas/VpcSecurityGroupMembershipList'
- description: 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.
ClusterParameterGroups:
allOf:
- $ref: '#/components/schemas/ClusterParameterGroupStatusList'
- description: The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
ClusterSubnetGroupName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow:
allOf:
- $ref: '#/components/schemas/String'
- description: The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues:
allOf:
- $ref: '#/components/schemas/PendingModifiedValues'
- description: A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
ClusterVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'A boolean value that, if <code>true</code>, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window. '
NumberOfNodes:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of compute nodes in the cluster.
PubliclyAccessible:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: A boolean value that, if <code>true</code>, indicates that the cluster can be accessed from a public network.
Encrypted:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: A boolean value that, if <code>true</code>, indicates that data in the cluster is encrypted at rest.
RestoreStatus:
allOf:
- $ref: '#/components/schemas/RestoreStatus'
- description: 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.
DataTransferProgress:
allOf:
- $ref: '#/components/schemas/DataTransferProgress'
- description: <p/>
HsmStatus:
allOf:
- $ref: '#/components/schemas/HsmStatus'
- description: '<p>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.</p> <p>Values: active, applying</p>'
ClusterSnapshotCopyStatus:
allOf:
- $ref: '#/components/schemas/ClusterSnapshotCopyStatus'
- description: A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
ClusterPublicKey:
allOf:
- $ref: '#/components/schemas/String'
- description: The public key for the cluster.
ClusterNodes:
allOf:
- $ref: '#/components/schemas/ClusterNodesList'
- description: The nodes in the cluster.
ElasticIpStatus:
allOf:
- $ref: '#/components/schemas/ElasticIpStatus'
- description: The status of the elastic IP (EIP) address.
ClusterRevisionNumber:
allOf:
- $ref: '#/components/schemas/String'
- description: The specific revision number of the database in the cluster.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The list of tags for the cluster.
KmsKeyId:
allOf:
- $ref: '#/components/schemas/String'
- description: The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '<p>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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide.</p> <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p> <p>Default: false</p>'
IamRoles:
allOf:
- $ref: '#/components/schemas/ClusterIamRoleList'
- description: A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
PendingActions:
allOf:
- $ref: '#/components/schemas/PendingActionsList'
- description: Cluster operations that are waiting to be started.
MaintenanceTrackName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The number of nodes that you can resize the cluster to with the elastic resize method. '
DeferredMaintenanceWindows:
allOf:
- $ref: '#/components/schemas/DeferredMaintenanceWindowsList'
- description: Describes a group of <code>DeferredMaintenanceWindow</code> objects.
SnapshotScheduleIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState:
allOf:
- $ref: '#/components/schemas/ScheduleState'
- description: The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: 'The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled. '
ExpectedNextSnapshotScheduleTimeStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: <p> The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:</p> <ul> <li> <p>OnTrack - The next snapshot is expected to be taken on time. </p> </li> <li> <p>Pending - The next snapshot is pending to be taken. </p> </li> </ul>
NextMaintenanceWindowStartTime:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: The date and time in UTC when system maintenance can begin.
ResizeInfo:
allOf:
- $ref: '#/components/schemas/ResizeInfo'
- description: '<p>Returns the following:</p> <ul> <li> <p>AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.</p> </li> <li> <p>ResizeType: Returns ClassicResize</p> </li> </ul>'
AvailabilityZoneRelocationStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes:
allOf:
- $ref: '#/components/schemas/LongOptional'
- description: 'The total storage capacity of the cluster in megabytes. '
AquaConfiguration:
allOf:
- $ref: '#/components/schemas/AquaConfiguration'
- description: This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus:
allOf:
- $ref: '#/components/schemas/ReservedNodeExchangeStatus'
- description: The status of the reserved-node exchange request. Statuses include in-progress and requested.
description: Describes a cluster.
ClusterParameterGroupStatus:
type: object
properties:
ParameterGroupName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the cluster parameter group.
ParameterApplyStatus:
allOf:
- $ref: '#/components/schemas/String'
- description: The status of parameter updates.
ClusterParameterStatusList:
allOf:
- $ref: '#/components/schemas/ClusterParameterStatusList'
- description: <p>The list of parameter statuses.</p> <p> For more information about parameters and parameter groups, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
description: Describes the status of a parameter group.
NetworkInterfaceList:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInterface'
- xml:
name: NetworkInterface
HsmStatus:
type: object
properties:
HsmClientCertificateIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
HsmConfigurationIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: 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.
Status:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.</p> <p>Values: active, applying</p>'
description: Describes the status of changes to HSM settings.
Tag:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/String'
- description: The key, or name, for the resource tag.
Value:
allOf:
- $ref: '#/components/schemas/String'
- description: The value for the resource tag.
description: A tag consisting of a name/value pair for a resource.
ClusterParameterStatusList:
type: array
items:
$ref: '#/components/schemas/ClusterParameterStatus'
TagValueList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: TagValue
ClusterList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Cluster'
- xml:
name: Cluster
ReservedNodeExchangeStatus:
type: object
properties:
ReservedNodeExchangeRequestId:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier of the reserved-node exchange request.
Status:
allOf:
- $ref: '#/components/schemas/ReservedNodeExchangeStatusType'
- description: The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime:
allOf:
- $ref: '#/components/schemas/TStamp'
- description: A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier of the source reserved node.
SourceReservedNodeType:
allOf:
- $ref: '#/components/schemas/String'
- description: The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The source reserved-node count in the cluster.
TargetReservedNodeOfferingId:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier of the target reserved node offering.
TargetReservedNodeType:
allOf:
- $ref: '#/components/schemas/String'
- description: The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The count of target reserved nodes in the cluster.
description: 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.
PendingModifiedValues:
type: object
properties:
MasterUserPassword:
allOf:
- $ref: '#/components/schemas/String'
- description: The pending or in-progress change of the admin user password for the cluster.
NodeType:
allOf:
- $ref: '#/components/schemas/String'
- description: The pending or in-progress change of the cluster's node type.
NumberOfNo
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aws-redshift/refs/heads/main/openapi/aws-redshift-action-describeclusters-api-openapi.yml