channel_handshakes

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

Overview

Name	channel_handshakes
Type	Resource
Id	aws.partnercentral_channel.channel_handshakes

Fields

The following fields are returned by SELECT queries:

list_channel_handshakes

Name	Datatype	Description
id	string	The unique identifier of the handshake. (pattern: <code>ch-[a-z0-9]{13}</code>)
arn	string	The Amazon Resource Name (ARN) of the handshake.
associated_resource_id	string	The identifier of the resource associated with the handshake. (pattern: <code>(pma|rs)-[a-z0-9]{13}</code>)
catalog	string	The catalog identifier associated with the handshake. (pattern: <code>[a-zA-Z]*</code>)
created_at	string (date-time)	The timestamp when the handshake was created.
detail	object	Detailed information about the handshake.
handshake_type	string	The type of the handshake. (START_SERVICE_PERIOD, REVOKE_SERVICE_PERIOD, PROGRAM_MANAGEMENT_ACCOUNT)
owner_account_id	string	The AWS account ID of the handshake owner. (pattern: <code>[0-9]*</code>)
receiver_account_id	string	The AWS account ID of the handshake receiver. (pattern: <code>[0-9]*</code>)
sender_account_id	string	The AWS account ID of the handshake sender. (pattern: <code>[0-9]*</code>)
sender_display_name	string	The display name of the handshake sender. (pattern: <code>[\x00-\x7E\xA9\xAE\xA2-\xA5\u202F]+</code>)
status	string	The current status of the handshake. (PENDING, ACCEPTED, REJECTED, CANCELED, EXPIRED)
updated_at	string (date-time)	The timestamp when the handshake was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_channel_handshakes	select	region		Lists channel handshakes based on specified criteria.
create_channel_handshake	insert	region, handshakeType, catalog, associatedResourceIdentifier		Creates a new channel handshake request to establish a partnership with another AWS 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_channel_handshakes

Lists channel handshakes based on specified criteria.

SELECT
id,
arn,
associated_resource_id,
catalog,
created_at,
detail,
handshake_type,
owner_account_id,
receiver_account_id,
sender_account_id,
sender_display_name,
status,
updated_at
FROM aws.partnercentral_channel.channel_handshakes
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_channel_handshake

Creates a new channel handshake request to establish a partnership with another AWS account.

INSERT INTO aws.partnercentral_channel.channel_handshakes (
handshakeType,
catalog,
associatedResourceIdentifier,
payload,
clientToken,
tags,
region
)
SELECT 
'{{ handshakeType }}' /* required */,
'{{ catalog }}' /* required */,
'{{ associatedResourceIdentifier }}' /* required */,
'{{ payload }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
channel_handshake_detail
;

Manifest

# Description fields are for documentation purposes
- name: channel_handshakes
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the channel_handshakes resource.
  - name: handshakeType
    value: "{{ handshakeType }}"
    description: |
      The type of handshake to create (e.g., start service period, revoke service period).
    valid_values: ['START_SERVICE_PERIOD', 'REVOKE_SERVICE_PERIOD', 'PROGRAM_MANAGEMENT_ACCOUNT']
  - name: catalog
    value: "{{ catalog }}"
    description: |
      The catalog identifier for the handshake request.
  - name: associatedResourceIdentifier
    value: "{{ associatedResourceIdentifier }}"
    description: |
      The identifier of the resource associated with this handshake.
  - name: payload
    description: |
      The payload containing specific details for the handshake type.
    value:
      startServicePeriodPayload:
        programManagementAccountIdentifier: "{{ programManagementAccountIdentifier }}"
        note: "{{ note }}"
        servicePeriodType: "{{ servicePeriodType }}"
        minimumNoticeDays: "{{ minimumNoticeDays }}"
        endDate: "{{ endDate }}"
      revokeServicePeriodPayload:
        programManagementAccountIdentifier: "{{ programManagementAccountIdentifier }}"
        note: "{{ note }}"
  - 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 channel handshake.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"