connection_invitations

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

Overview

Name	connection_invitations
Type	Resource
Id	aws.partnercentral_account.connection_invitations

Fields

The following fields are returned by SELECT queries:

get_connection_invitation

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the connection invitation. (pattern: <code>arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9-]*::catalog/[a-zA-Z]+/connection-invitation/pacinv-[A-Za-z0-9]{13}</code>)
catalog	string	The catalog identifier where the connection invitation exists. (pattern: <code>[a-zA-Z0-9-]+</code>)
connection_id	string	The identifier of the connection associated with this invitation. (pattern: <code>pac-[A-Za-z0-9]{13}</code>)
connection_type	string	The type of connection being requested in the invitation. (OPPORTUNITY_COLLABORATION, SUBSIDIARY)
created_at	string (date-time)	The timestamp when the connection invitation was created.
expires_at	string (date-time)	The timestamp when the connection invitation will expire.
id	string	The unique identifier of the connection invitation. (pattern: <code>pacinv-[A-Za-z0-9]{13}</code>)
invitation_message	string	The custom message included with the connection invitation. (pattern: <code>[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD\n]+</code>)
inviter_email	string	The email address of the person who sent the connection invitation. (pattern: <code>[a-zA-Z0-9.!#$%&'+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)</code>)
inviter_name	string	The name of the person who sent the connection invitation. (pattern: <code>[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+</code>)
other_participant_identifier	string	The identifier of the other participant in the connection invitation. (pattern: <code>[a-zA-Z0-9-]+</code>)
participant_type	string	The type of participant (inviter or invitee) in the connection invitation. (SENDER, RECEIVER)
status	string	The current status of the connection invitation. (PENDING, ACCEPTED, REJECTED, CANCELED, EXPIRED)
updated_at	string (date-time)	The timestamp when the connection invitation was last updated.

list_connection_invitations

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the connection invitation. (pattern: <code>arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9-]*::catalog/[a-zA-Z]+/connection-invitation/pacinv-[A-Za-z0-9]{13}</code>)
catalog	string	The catalog identifier where the connection invitation exists. (pattern: <code>[a-zA-Z0-9-]+</code>)
connection_id	string	The identifier of the connection associated with this invitation. (pattern: <code>pac-[A-Za-z0-9]{13}</code>)
connection_type	string	The type of connection being requested in the invitation. (OPPORTUNITY_COLLABORATION, SUBSIDIARY)
created_at	string (date-time)	The timestamp when the connection invitation was created.
expires_at	string (date-time)	The timestamp when the connection invitation will expire.
id	string	The unique identifier of the connection invitation. (pattern: <code>pacinv-[A-Za-z0-9]{13}</code>)
other_participant_identifier	string	The identifier of the other participant in the connection invitation. (pattern: <code>[a-zA-Z0-9-]+</code>)
participant_type	string	The type of participant (inviter or invitee) in the connection invitation. (SENDER, RECEIVER)
status	string	The current status of the connection invitation. (PENDING, ACCEPTED, REJECTED, CANCELED, EXPIRED)
updated_at	string (date-time)	The timestamp when the connection invitation was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connection_invitation	select	region		Retrieves detailed information about a specific connection invitation.
list_connection_invitations	select	region		Lists connection invitations for the partner account, with optional filtering by status, type, and other criteria.
create_connection_invitation	insert	region, ClientToken, ConnectionType, Email, Message, Name, ReceiverIdentifier		Creates a new connection invitation to establish a partnership with another organization.

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_connection_invitation

Retrieves detailed information about a specific connection invitation.

SELECT
arn,
catalog,
connection_id,
connection_type,
created_at,
expires_at,
id,
invitation_message,
inviter_email,
inviter_name,
other_participant_identifier,
participant_type,
status,
updated_at
FROM aws.partnercentral_account.connection_invitations
WHERE region = '{{ region }}' -- required
;

list_connection_invitations

Lists connection invitations for the partner account, with optional filtering by status, type, and other criteria.

SELECT
arn,
catalog,
connection_id,
connection_type,
created_at,
expires_at,
id,
other_participant_identifier,
participant_type,
status,
updated_at
FROM aws.partnercentral_account.connection_invitations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_connection_invitation

Creates a new connection invitation to establish a partnership with another organization.

INSERT INTO aws.partnercentral_account.connection_invitations (
Catalog,
ClientToken,
ConnectionType,
Email,
Message,
Name,
ReceiverIdentifier,
region
)
SELECT 
'{{ Catalog }}',
'{{ ClientToken }}' /* required */,
'{{ ConnectionType }}' /* required */,
'{{ Email }}' /* required */,
'{{ Message }}' /* required */,
'{{ Name }}' /* required */,
'{{ ReceiverIdentifier }}' /* required */,
'{{ region }}'
RETURNING
arn,
catalog,
connection_id,
connection_type,
created_at,
expires_at,
id,
invitation_message,
inviter_email,
inviter_name,
other_participant_identifier,
participant_type,
status,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: connection_invitations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connection_invitations resource.
  - name: Catalog
    value: "{{ Catalog }}"
    description: |
      The catalog identifier where the connection invitation will be created.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - name: ConnectionType
    value: "{{ ConnectionType }}"
    description: |
      The type of connection being requested (e.g., reseller, distributor, technology partner).
    valid_values: ['OPPORTUNITY_COLLABORATION', 'SUBSIDIARY']
  - name: Email
    value: "{{ Email }}"
    description: |
      The email address of the person to send the connection invitation to.
  - name: Message
    value: "{{ Message }}"
    description: |
      A custom message to include with the connection invitation.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the person sending the connection invitation.
  - name: ReceiverIdentifier
    value: "{{ ReceiverIdentifier }}"
    description: |
      The identifier of the organization or partner to invite for connection.