Skip to main content

connections

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

Overview

Nameconnections
TypeResource
Idaws.partnercentral_account.connections

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
arnstringThe Amazon Resource Name (ARN) of the connection. (pattern: <code>arn:[a-zA-Z0-9-]+:partnercentral:[a-z0-9-]*::catalog/[a-zA-Z]+/connection/pac-[A-Za-z0-9]{13}</code>)
catalogstringThe catalog identifier where the connection exists. (pattern: <code>[a-zA-Z0-9-]+</code>)
connection_typesobjectThe list of connection types active between the partners.
idstringThe unique identifier of the connection. (pattern: <code>pac-[A-Za-z0-9]{13}</code>)
other_participant_account_idstringThe AWS account ID of the other participant in the connection. (pattern: <code>[0-9]{12}</code>)
updated_atstring (date-time)The timestamp when the connection was last updated.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_connectionselectregionRetrieves detailed information about a specific connection between partners.
list_connectionsselectregionLists active connections for the partner account, with optional filtering by connection type and participant.
accept_connection_invitationexecregion, Identifier, ClientTokenAccepts a connection invitation from another partner, establishing a formal partnership connection between the two parties.
cancel_connection_invitationexecregion, Identifier, ClientTokenCancels a pending connection invitation before it has been accepted or rejected.
reject_connection_invitationexecregion, Identifier, ClientTokenRejects a connection invitation from another partner, declining the partnership request.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Retrieves detailed information about a specific connection between partners.

SELECT
arn,
catalog,
connection_types,
id,
other_participant_account_id,
updated_at
FROM aws.partnercentral_account.connections
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

Accepts a connection invitation from another partner, establishing a formal partnership connection between the two parties.

EXEC aws.partnercentral_account.connections.accept_connection_invitation
@region='{{ region }}' --required
@@json=
'{
"Catalog": "{{ Catalog }}",
"Identifier": "{{ Identifier }}",
"ClientToken": "{{ ClientToken }}"
}'
;