program_management_accounts

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

Overview

Name	program_management_accounts
Type	Resource
Id	aws.partnercentral_channel.program_management_accounts

Fields

The following fields are returned by SELECT queries:

list_program_management_accounts

Name	Datatype	Description
id	string	The unique identifier of the program management account. (pattern: <code>pma-[a-z0-9]{13}</code>)
account_id	string	The AWS account ID associated with the program management account. (pattern: <code>[0-9]*</code>)
arn	string	The Amazon Resource Name (ARN) of the program management account.
catalog	string	The catalog identifier associated with the account. (pattern: <code>[a-zA-Z]*</code>)
created_at	string (date-time)	The timestamp when the account was created.
display_name	string	The display name of the program management account. (pattern: <code>[^\x00-\x1F\x7F]*</code>)
program	string	The program type for the management account. (SOLUTION_PROVIDER, DISTRIBUTION, DISTRIBUTION_SELLER)
revision	string	The current revision number of the program management account. (pattern: <code>[0-9]*</code>)
start_date	string (date-time)	The start date of the program management account.
status	string	The current status of the program management account. (PENDING, ACTIVE, INACTIVE)
updated_at	string (date-time)	The timestamp when the account was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_program_management_accounts	select	region		Lists program management accounts based on specified criteria.
create_program_management_account	insert	region, catalog, program, displayName, accountId		Creates a new program management account for managing partner relationships.
update_program_management_account	update	region, catalog, identifier		Updates the properties of a program management account.
delete_program_management_account	delete	region		Deletes a program management account.

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

list_program_management_accounts

Lists program management accounts based on specified criteria.

SELECT
id,
account_id,
arn,
catalog,
created_at,
display_name,
program,
revision,
start_date,
status,
updated_at
FROM aws.partnercentral_channel.program_management_accounts
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_program_management_account

Creates a new program management account for managing partner relationships.

INSERT INTO aws.partnercentral_channel.program_management_accounts (
catalog,
program,
displayName,
accountId,
clientToken,
tags,
region
)
SELECT 
'{{ catalog }}' /* required */,
'{{ program }}' /* required */,
'{{ displayName }}' /* required */,
'{{ accountId }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
program_management_account_detail
;

Manifest

# Description fields are for documentation purposes
- name: program_management_accounts
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the program_management_accounts resource.
  - name: catalog
    value: "{{ catalog }}"
    description: |
      The catalog identifier for the program management account.
  - name: program
    value: "{{ program }}"
    description: |
      The program type for the management account.
    valid_values: ['SOLUTION_PROVIDER', 'DISTRIBUTION', 'DISTRIBUTION_SELLER']
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A human-readable name for the program management account.
  - name: accountId
    value: "{{ accountId }}"
    description: |
      The AWS account ID to associate with the program management account.
  - 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 program management account.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_program_management_account

Updates the properties of a program management account.

UPDATE aws.partnercentral_channel.program_management_accounts
SET 
catalog = '{{ catalog }}',
identifier = '{{ identifier }}',
revision = '{{ revision }}',
displayName = '{{ displayName }}'
WHERE 
region = '{{ region }}' --required
AND catalog = '{{ catalog }}' --required
AND identifier = '{{ identifier }}' --required
RETURNING
program_management_account_detail;

DELETE examples

delete_program_management_account

Deletes a program management account.

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