relationships

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

Overview

Name	relationships
Type	Resource
Id	aws.partnercentral_channel.relationships

Fields

The following fields are returned by SELECT queries:

get_relationship

Name	Datatype	Description
id	string	The unique identifier of the relationship. (pattern: <code>rs-[a-z0-9]{13}</code>)
arn	string	The Amazon Resource Name (ARN) of the relationship.
associated_account_id	string	The AWS account ID associated in this relationship. (pattern: <code>[0-9]*</code>)
association_type	string	The type of association for the relationship. (DOWNSTREAM_SELLER, END_CUSTOMER, INTERNAL)
catalog	string	The catalog identifier associated with the relationship. (pattern: <code>[a-zA-Z]*</code>)
created_at	string (date-time)	The timestamp when the relationship was created.
display_name	string	The display name of the relationship. (pattern: <code>[^\x00-\x1F\x7F]*</code>)
program_management_account_id	string	The identifier of the program management account. (pattern: <code>pma-[a-z0-9]{13}</code>)
resale_account_model	string	The resale account model for the relationship. (DISTRIBUTOR, END_CUSTOMER, SOLUTION_PROVIDER)
revision	string	The current revision number of the relationship. (pattern: <code>[0-9]*</code>)
sector	string	The business sector for the relationship. (COMMERCIAL, GOVERNMENT, GOVERNMENT_EXCEPTION)
start_date	string (date-time)	The start date of the relationship.
updated_at	string (date-time)	The timestamp when the relationship was last updated.

list_relationships

Name	Datatype	Description
id	string	The unique identifier of the relationship. (pattern: <code>rs-[a-z0-9]{13}</code>)
arn	string	The Amazon Resource Name (ARN) of the relationship.
associated_account_id	string	The AWS account ID associated in this relationship. (pattern: <code>[0-9]*</code>)
association_type	string	The type of association for the relationship. (DOWNSTREAM_SELLER, END_CUSTOMER, INTERNAL)
catalog	string	The catalog identifier associated with the relationship. (pattern: <code>[a-zA-Z]*</code>)
created_at	string (date-time)	The timestamp when the relationship was created.
display_name	string	The display name of the relationship. (pattern: <code>[^\x00-\x1F\x7F]*</code>)
program_management_account_id	string	The identifier of the program management account. (pattern: <code>pma-[a-z0-9]{13}</code>)
revision	string	The current revision number of the relationship. (pattern: <code>[0-9]*</code>)
sector	string	The business sector for the relationship. (COMMERCIAL, GOVERNMENT, GOVERNMENT_EXCEPTION)
start_date	string (date-time)	The start date of the relationship.
updated_at	string (date-time)	The timestamp when the relationship was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_relationship	select	region		Retrieves details of a specific partner relationship.
list_relationships	select	region		Lists partner relationships based on specified criteria.
create_relationship	insert	region, catalog, associationType, programManagementAccountIdentifier, associatedAccountId, displayName, sector		Creates a new partner relationship between accounts.
update_relationship	update	region, catalog, identifier, programManagementAccountIdentifier		Updates the properties of a partner relationship.
delete_relationship	delete	region		Deletes a partner relationship.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_relationship

Retrieves details of a specific partner relationship.

SELECT
id,
arn,
associated_account_id,
association_type,
catalog,
created_at,
display_name,
program_management_account_id,
resale_account_model,
revision,
sector,
start_date,
updated_at
FROM aws.partnercentral_channel.relationships
WHERE region = '{{ region }}' -- required
;

list_relationships

Lists partner relationships based on specified criteria.

SELECT
id,
arn,
associated_account_id,
association_type,
catalog,
created_at,
display_name,
program_management_account_id,
revision,
sector,
start_date,
updated_at
FROM aws.partnercentral_channel.relationships
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_relationship

Creates a new partner relationship between accounts.

INSERT INTO aws.partnercentral_channel.relationships (
catalog,
associationType,
programManagementAccountIdentifier,
associatedAccountId,
displayName,
resaleAccountModel,
sector,
clientToken,
tags,
requestedSupportPlan,
region
)
SELECT 
'{{ catalog }}' /* required */,
'{{ associationType }}' /* required */,
'{{ programManagementAccountIdentifier }}' /* required */,
'{{ associatedAccountId }}' /* required */,
'{{ displayName }}' /* required */,
'{{ resaleAccountModel }}',
'{{ sector }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ requestedSupportPlan }}',
'{{ region }}'
RETURNING
relationship_detail
;

Manifest

# Description fields are for documentation purposes
- name: relationships
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the relationships resource.
  - name: catalog
    value: "{{ catalog }}"
    description: |
      The catalog identifier for the relationship.
  - name: associationType
    value: "{{ associationType }}"
    description: |
      The type of association for the relationship (e.g., reseller, distributor).
    valid_values: ['DOWNSTREAM_SELLER', 'END_CUSTOMER', 'INTERNAL']
  - name: programManagementAccountIdentifier
    value: "{{ programManagementAccountIdentifier }}"
    description: |
      The identifier of the program management account for this relationship.
  - name: associatedAccountId
    value: "{{ associatedAccountId }}"
    description: |
      The AWS account ID to associate in this relationship.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A human-readable name for the relationship.
  - name: resaleAccountModel
    value: "{{ resaleAccountModel }}"
    description: |
      The resale account model for the relationship.
    valid_values: ['DISTRIBUTOR', 'END_CUSTOMER', 'SOLUTION_PROVIDER']
  - name: sector
    value: "{{ sector }}"
    description: |
      The business sector for the relationship.
    valid_values: ['COMMERCIAL', 'GOVERNMENT', 'GOVERNMENT_EXCEPTION']
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      A unique, case-sensitive identifier to ensure idempotency of the request.
  - name: tags
    description: |
      Key-value pairs to associate with the relationship.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: requestedSupportPlan
    description: |
      The support plan requested for this relationship.
    value:
      resoldEnterprise:
        coverage: "{{ coverage }}"
        tamLocation: "{{ tamLocation }}"
        chargeAccountId: "{{ chargeAccountId }}"
      partnerLedSupport:
        coverage: "{{ coverage }}"
        provider: "{{ provider }}"
        tamLocation: "{{ tamLocation }}"
      resoldUnifiedOperations:
        coverage: "{{ coverage }}"
        tamLocation: "{{ tamLocation }}"
        chargeAccountId: "{{ chargeAccountId }}"

UPDATE examples

update_relationship

Updates the properties of a partner relationship.

UPDATE aws.partnercentral_channel.relationships
SET 
catalog = '{{ catalog }}',
identifier = '{{ identifier }}',
programManagementAccountIdentifier = '{{ programManagementAccountIdentifier }}',
revision = '{{ revision }}',
displayName = '{{ displayName }}',
requestedSupportPlan = '{{ requestedSupportPlan }}'
WHERE 
region = '{{ region }}' --required
AND catalog = '{{ catalog }}' --required
AND identifier = '{{ identifier }}' --required
AND programManagementAccountIdentifier = '{{ programManagementAccountIdentifier }}' --required
RETURNING
relationship_detail;

DELETE examples

delete_relationship

Deletes a partner relationship.

DELETE FROM aws.partnercentral_channel.relationships
WHERE region = '{{ region }}' --required
;