partners

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

Overview

Name	partners
Type	Resource
Id	aws.partnercentral_account.partners

Fields

The following fields are returned by SELECT queries:

get_partner

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the partner account. (pattern: <code>arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}</code>)
aws_training_certification_email_domains	array	The list of verified email domains associated with AWS training and certification credentials for the partner organization.
catalog	string	The catalog identifier for the partner account. (pattern: <code>[a-zA-Z0-9-]+</code>)
created_at	string (date-time)	The timestamp when the partner account was created.
id	string	The unique identifier of the partner account. (pattern: <code>partner-[A-Za-z0-9]{13}</code>)
legal_name	string	The legal name of the partner organization. (pattern: <code>[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+</code>)
profile	object	The partner profile information including display name, description, and other public details.

list_partners

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the partner account. (pattern: <code>arn:[a-z-]+:partnercentral:[a-z0-9-]+:[0-9]{12}:catalog/[A-Za-z-_]+/partner/partner-[A-Za-z0-9]{13}</code>)
catalog	string	The catalog identifier for the partner account. (pattern: <code>[a-zA-Z0-9-]+</code>)
created_at	string (date-time)	The timestamp when the partner account was created.
id	string	The unique identifier of the partner account. (pattern: <code>partner-[A-Za-z0-9]{13}</code>)
legal_name	string	The legal name of the partner organization. (pattern: <code>[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_partner	select	region		Retrieves detailed information about a specific partner account.
list_partners	select	region		Lists partner accounts in the catalog, providing a summary view of all partners.
create_partner	insert	region, LegalName, PrimarySolutionType, AllianceLeadContact, EmailVerificationCode		Creates a new partner account in the AWS Partner Network with the specified details and configuration.

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_partner

Retrieves detailed information about a specific partner account.

SELECT
arn,
aws_training_certification_email_domains,
catalog,
created_at,
id,
legal_name,
profile
FROM aws.partnercentral_account.partners
WHERE region = '{{ region }}' -- required
;

list_partners

Lists partner accounts in the catalog, providing a summary view of all partners.

SELECT
arn,
catalog,
created_at,
id,
legal_name
FROM aws.partnercentral_account.partners
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_partner

Creates a new partner account in the AWS Partner Network with the specified details and configuration.

INSERT INTO aws.partnercentral_account.partners (
Catalog,
ClientToken,
LegalName,
PrimarySolutionType,
AllianceLeadContact,
EmailVerificationCode,
Tags,
region
)
SELECT 
'{{ Catalog }}',
'{{ ClientToken }}',
'{{ LegalName }}' /* required */,
'{{ PrimarySolutionType }}' /* required */,
'{{ AllianceLeadContact }}' /* required */,
'{{ EmailVerificationCode }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
alliance_lead_contact,
arn,
aws_training_certification_email_domains,
catalog,
created_at,
id,
legal_name,
profile
;

Manifest

# Description fields are for documentation purposes
- name: partners
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the partners resource.
  - name: Catalog
    value: "{{ Catalog }}"
    description: |
      The catalog identifier where the partner account will be created.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - name: LegalName
    value: "{{ LegalName }}"
    description: |
      The legal name of the organization becoming a partner.
  - name: PrimarySolutionType
    value: "{{ PrimarySolutionType }}"
    description: |
      The primary type of solution or service the partner provides (e.g., consulting, software, managed services).
    valid_values: ['SOFTWARE_PRODUCTS', 'CONSULTING_SERVICES', 'PROFESSIONAL_SERVICES', 'MANAGED_SERVICES', 'HARDWARE_PRODUCTS', 'COMMUNICATION_SERVICES', 'VALUE_ADDED_RESALE_AWS_SERVICES', 'TRAINING_SERVICES']
  - name: AllianceLeadContact
    description: |
      The primary contact person for alliance and partnership matters.
    value:
      FirstName: "{{ FirstName }}"
      LastName: "{{ LastName }}"
      Email: "{{ Email }}"
      BusinessTitle: "{{ BusinessTitle }}"
  - name: EmailVerificationCode
    value: "{{ EmailVerificationCode }}"
    description: |
      The verification code sent to the alliance lead contact's email to confirm account creation.
  - name: Tags
    description: |
      A list of tags to associate with the partner account for organization and billing purposes.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"