partners

Creates, updates, deletes, gets or lists a partners resource.

Overview

Name	partners
Type	Resource
Id	aws.redshift.partners

Fields

The following fields are returned by SELECT queries:

describe_partners

Name	Datatype	Description
created_at	string	The date (UTC) that the partner integration was created.
database_name	string	The name of the database that receives data from a partner.
partner_name	string	The name of the partner.
status	string	The partner integration status.
status_message	string	The status message provided by the partner.
updated_at	string	The date (UTC) that the partner integration status was last updated by the partner.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_partners	select	AccountId, ClusterIdentifier, region	DatabaseName, PartnerName	Returns information about the partner integrations defined for a cluster.
add_partner	update	AccountId, ClusterIdentifier, DatabaseName, PartnerName, region		Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration, you also set up the integration on the partner website.
delete_partner	delete	AccountId, ClusterIdentifier, DatabaseName, PartnerName, region		Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.
update_partner_status	exec	AccountId, ClusterIdentifier, DatabaseName, PartnerName, region	Status, StatusMessage	Updates the status of a partner integration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
AccountId	string	The Amazon Web Services account ID that owns the cluster.
ClusterIdentifier	string	The cluster identifier of the cluster whose partner integration status is being updated.
DatabaseName	string	The name of the database whose partner integration status is being updated.
PartnerName	string	The name of the partner whose integration status is being updated.
region	string	AWS region (default: us-east-1)
DatabaseName	string	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	string	The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.
Status	string	The value of the updated status.
StatusMessage	string	The status message provided by the partner.

SELECT examples

describe_partners

Returns information about the partner integrations defined for a cluster.

SELECT
created_at,
database_name,
partner_name,
status,
status_message,
updated_at
FROM aws.redshift.partners
WHERE AccountId = '{{ AccountId }}' -- required
AND ClusterIdentifier = '{{ ClusterIdentifier }}' -- required
AND region = '{{ region }}' -- required
AND DatabaseName = '{{ DatabaseName }}'
AND PartnerName = '{{ PartnerName }}'
;

UPDATE examples

add_partner

Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration, you also set up the integration on the partner website.

UPDATE aws.redshift.partners
SET 
-- No updatable properties
WHERE 
AccountId = '{{ AccountId }}' --required
AND ClusterIdentifier = '{{ ClusterIdentifier }}' --required
AND DatabaseName = '{{ DatabaseName }}' --required
AND PartnerName = '{{ PartnerName }}' --required
AND region = '{{ region }}' --required
RETURNING
database_name,
partner_name;

DELETE examples

delete_partner

Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.

DELETE FROM aws.redshift.partners
WHERE AccountId = '{{ AccountId }}' --required
AND ClusterIdentifier = '{{ ClusterIdentifier }}' --required
AND DatabaseName = '{{ DatabaseName }}' --required
AND PartnerName = '{{ PartnerName }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

update_partner_status

Updates the status of a partner integration.

EXEC aws.redshift.partners.update_partner_status 
@AccountId='{{ AccountId }}' --required, 
@ClusterIdentifier='{{ ClusterIdentifier }}' --required, 
@DatabaseName='{{ DatabaseName }}' --required, 
@PartnerName='{{ PartnerName }}' --required, 
@region='{{ region }}' --required, 
@Status='{{ Status }}', 
@StatusMessage='{{ StatusMessage }}'
;