Skip to content

Describe Partners

redshift_describe_partners R Documentation

Returns information about the partner integrations defined for a cluster

Description

Returns information about the partner integrations defined for a cluster.

Usage

redshift_describe_partners(AccountId, ClusterIdentifier, DatabaseName,
  PartnerName)

Arguments

AccountId

[required] The Amazon Web Services account ID that owns the cluster.

ClusterIdentifier

[required] The cluster identifier of the cluster whose partner integration is being described.

DatabaseName

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.

PartnerName

The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.

Value

A list with the following syntax:

list(
  PartnerIntegrationInfoList = list(
    list(
      DatabaseName = "string",
      PartnerName = "string",
      Status = "Active"|"Inactive"|"RuntimeFailure"|"ConnectionFailure",
      StatusMessage = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$describe_partners(
  AccountId = "string",
  ClusterIdentifier = "string",
  DatabaseName = "string",
  PartnerName = "string"
)