Data retrieval APIs for Amazon Redshift - AWS Online Register of Data Formats

Data retrieval APIs for Amazon Redshift

Amazon Redshift provides the following APIs for data retrieval.

Actions Description Access level
DescribeAccountAttributesDescribe attributes attached to the specified AWS accountRead
DescribeAuthenticationProfilesDescribe created Amazon Redshift authentication profilesRead
DescribeClusterDbRevisionsDescribe database revisions for a clusterList
DescribeClusterParameterGroupsDescribe Amazon Redshift parameter groups, including parameter groups you created and the default parameter groupRead
DescribeClusterParametersDescribe parameters contained within an Amazon Redshift parameter groupRead
DescribeClusterSecurityGroupsDescribe Amazon Redshift security groupsRead
DescribeClusterSnapshotsDescribe one or more snapshot objects, which contain metadata about your cluster snapshotsRead
DescribeClusterSubnetGroupsDescribe one or more cluster subnet group objects, which contain metadata about your cluster subnet groupsRead
DescribeClusterTracksDescribe available maintenance tracksList
DescribeClusterVersionsDescribe available Amazon Redshift cluster versionsRead
DescribeClustersDescribe properties of provisioned clustersList
DescribeCustomDomainAssociationsDescribe custom domain names for a clusterList
DescribeDataSharesDescribe datashares created and consumed by your clustersRead
DescribeDataSharesForConsumerDescribe only datashares consumed by your clustersRead
DescribeDataSharesForProducerDescribe only datashares created by your clustersRead
DescribeDefaultClusterParametersDescribe parameter settings for a parameter group familyRead
DescribeEndpointAccessDescribe redshift-managed vpc endpointsRead
DescribeEndpointAuthorizationAuthorize describe activity for redshift-managed vpc endpointList
DescribeEventCategoriesDescribe event categories for all event source types, or for a specified source typeRead
DescribeEventSubscriptionsDescribe Amazon Redshift event notification subscriptions for the specified AWS accountRead
DescribeEventsDescribe events related to clusters, security groups, snapshots, and parameter groups for the past 14 daysList
DescribeHsmClientCertificatesDescribe HSM client certificatesRead
DescribeHsmConfigurationsDescribe Amazon Redshift HSM configurationsRead
DescribeInboundIntegrationsList the inbound integrationsList
DescribeIntegrationsDescribe an Amazon Redshift zero-ETL integrationList
DescribeLoggingStatusDescribe whether information, such as queries and connection attempts, is being logged for a clusterRead
DescribeNodeConfigurationOptionsDescribe properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action typeList
DescribeOrderableClusterOptionsDescribe orderable cluster optionsRead
DescribePartnersRetrieve information about the partner integrations defined for a clusterRead
DescribeQev2IdcApplicationsDescribe qev2 idc applicationsList
DescribeQueryDescribe a query through the Amazon Redshift consoleRead
DescribeRedshiftIdcApplicationsDescribe redshift idc applicationsList
DescribeReservedNodeExchangeStatusDescribe exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requestedRead
DescribeReservedNodeOfferingsDescribe available reserved node offerings by Amazon RedshiftRead
DescribeReservedNodesDescribe the reserved nodesRead
DescribeResizeDescribe the last resize operation for a clusterRead
DescribeSavedQueriesDescribe saved queries through the Amazon Redshift consoleRead
DescribeScheduledActionsDescribe created Amazon Redshift scheduled actionsRead
DescribeSnapshotCopyGrantsDescribe snapshot copy grants owned by the specified AWS account in the destination AWS RegionRead
DescribeSnapshotSchedulesDescribe snapshot schedulesRead
DescribeStorageDescribe account level backups storage size and provisional storageRead
DescribeTableDescribe a table through the Amazon Redshift consoleRead
DescribeTableRestoreStatusDescribe status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API actionRead
DescribeTagsDescribe tagsRead
DescribeUsageLimitsDescribe usage limitsRead
FetchResultsFetch query results through the Amazon Redshift consoleRead
GetReservedNodeExchangeConfigurationOptionsGet the configuration options for the reserved-node exchangeRead
GetReservedNodeExchangeOfferingsGet an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved nodeRead
GetResourcePolicyGet the resource policy for a specified resourceRead
ListDatabasesList databases through the Amazon Redshift consoleList
ListRecommendationsList Advisor recommendationsList
ListSavedQueriesList saved queries through the Amazon Redshift consoleList
ListSchemasList schemas through the Amazon Redshift consoleList
ListTablesList tables through the Amazon Redshift consoleList
ViewQueriesFromConsoleView query results through the Amazon Redshift consoleList
ViewQueriesInConsoleTerminate running queries and loads through the Amazon Redshift consoleList