Data retrieval APIs for Amazon Redshift
Amazon Redshift provides the following APIs for data retrieval.
Actions | Description | Access level |
---|---|---|
DescribeAccountAttributes | Describe attributes attached to the specified AWS account | Read |
DescribeAuthenticationProfiles | Describe created Amazon Redshift authentication profiles | Read |
DescribeClusterDbRevisions | Describe database revisions for a cluster | List |
DescribeClusterParameterGroups | Describe Amazon Redshift parameter groups, including parameter groups you created and the default parameter group | Read |
DescribeClusterParameters | Describe parameters contained within an Amazon Redshift parameter group | Read |
DescribeClusterSecurityGroups | Describe Amazon Redshift security groups | Read |
DescribeClusterSnapshots | Describe one or more snapshot objects, which contain metadata about your cluster snapshots | Read |
DescribeClusterSubnetGroups | Describe one or more cluster subnet group objects, which contain metadata about your cluster subnet groups | Read |
DescribeClusterTracks | Describe available maintenance tracks | List |
DescribeClusterVersions | Describe available Amazon Redshift cluster versions | Read |
DescribeClusters | Describe properties of provisioned clusters | List |
DescribeCustomDomainAssociations | Describe custom domain names for a cluster | List |
DescribeDataShares | Describe datashares created and consumed by your clusters | Read |
DescribeDataSharesForConsumer | Describe only datashares consumed by your clusters | Read |
DescribeDataSharesForProducer | Describe only datashares created by your clusters | Read |
DescribeDefaultClusterParameters | Describe parameter settings for a parameter group family | Read |
DescribeEndpointAccess | Describe redshift-managed vpc endpoints | Read |
DescribeEndpointAuthorization | Authorize describe activity for redshift-managed vpc endpoint | List |
DescribeEventCategories | Describe event categories for all event source types, or for a specified source type | Read |
DescribeEventSubscriptions | Describe Amazon Redshift event notification subscriptions for the specified AWS account | Read |
DescribeEvents | Describe events related to clusters, security groups, snapshots, and parameter groups for the past 14 days | List |
DescribeHsmClientCertificates | Describe HSM client certificates | Read |
DescribeHsmConfigurations | Describe Amazon Redshift HSM configurations | Read |
DescribeInboundIntegrations | List the inbound integrations | List |
DescribeIntegrations | Describe an Amazon Redshift zero-ETL integration | List |
DescribeLoggingStatus | Describe whether information, such as queries and connection attempts, is being logged for a cluster | Read |
DescribeNodeConfigurationOptions | Describe properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type | List |
DescribeOrderableClusterOptions | Describe orderable cluster options | Read |
DescribePartners | Retrieve information about the partner integrations defined for a cluster | Read |
DescribeQev2IdcApplications | Describe qev2 idc applications | List |
DescribeQuery | Describe a query through the Amazon Redshift console | Read |
DescribeRedshiftIdcApplications | Describe redshift idc applications | List |
DescribeReservedNodeExchangeStatus | Describe exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested | Read |
DescribeReservedNodeOfferings | Describe available reserved node offerings by Amazon Redshift | Read |
DescribeReservedNodes | Describe the reserved nodes | Read |
DescribeResize | Describe the last resize operation for a cluster | Read |
DescribeSavedQueries | Describe saved queries through the Amazon Redshift console | Read |
DescribeScheduledActions | Describe created Amazon Redshift scheduled actions | Read |
DescribeSnapshotCopyGrants | Describe snapshot copy grants owned by the specified AWS account in the destination AWS Region | Read |
DescribeSnapshotSchedules | Describe snapshot schedules | Read |
DescribeStorage | Describe account level backups storage size and provisional storage | Read |
DescribeTable | Describe a table through the Amazon Redshift console | Read |
DescribeTableRestoreStatus | Describe status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action | Read |
DescribeTags | Describe tags | Read |
DescribeUsageLimits | Describe usage limits | Read |
FetchResults | Fetch query results through the Amazon Redshift console | Read |
GetReservedNodeExchangeConfigurationOptions | Get the configuration options for the reserved-node exchange | Read |
GetReservedNodeExchangeOfferings | Get an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node | Read |
GetResourcePolicy | Get the resource policy for a specified resource | Read |
ListDatabases | List databases through the Amazon Redshift console | List |
ListRecommendations | List Advisor recommendations | List |
ListSavedQueries | List saved queries through the Amazon Redshift console | List |
ListSchemas | List schemas through the Amazon Redshift console | List |
ListTables | List tables through the Amazon Redshift console | List |
ViewQueriesFromConsole | View query results through the Amazon Redshift console | List |
ViewQueriesInConsole | Terminate running queries and loads through the Amazon Redshift console | List |