connections
Creates, updates, deletes, gets or lists a connections resource.
Overview
| Name | connections |
| Type | Resource |
| Id | aws.partnercentral_account.connections |
Fields
The following fields are returned by SELECT queries:
- get_connection
- list_connections
| Name | Datatype | Description |
|---|---|---|
arn | string | The 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>) |
catalog | string | The catalog identifier where the connection exists. (pattern: <code>[a-zA-Z0-9-]+</code>) |
connection_types | object | The list of connection types active between the partners. |
id | string | The unique identifier of the connection. (pattern: <code>pac-[A-Za-z0-9]{13}</code>) |
other_participant_account_id | string | The AWS account ID of the other participant in the connection. (pattern: <code>[0-9]{12}</code>) |
updated_at | string (date-time) | The timestamp when the connection was last updated. |
| Name | Datatype | Description |
|---|---|---|
arn | string | The 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>) |
catalog | string | The catalog identifier where the connection exists. (pattern: <code>[a-zA-Z0-9-]+</code>) |
connection_types | object | A map of connection types and their summary information for this connection. |
id | string | The unique identifier of the connection. (pattern: <code>pac-[A-Za-z0-9]{13}</code>) |
other_participant_account_id | string | The AWS account ID of the other participant in the connection. (pattern: <code>[0-9]{12}</code>) |
updated_at | string (date-time) | The timestamp when the connection was last updated. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_connection | select | region | Retrieves detailed information about a specific connection between partners. | |
list_connections | select | region | Lists active connections for the partner account, with optional filtering by connection type and participant. | |
accept_connection_invitation | exec | region, Identifier, ClientToken | Accepts a connection invitation from another partner, establishing a formal partnership connection between the two parties. | |
cancel_connection_invitation | exec | region, Identifier, ClientToken | Cancels a pending connection invitation before it has been accepted or rejected. | |
reject_connection_invitation | exec | region, Identifier, ClientToken | Rejects 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.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_connection
- list_connections
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
;
Lists active connections for the partner account, with optional filtering by connection type and participant.
SELECT
arn,
catalog,
connection_types,
id,
other_participant_account_id,
updated_at
FROM aws.partnercentral_account.connections
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- accept_connection_invitation
- cancel_connection_invitation
- reject_connection_invitation
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 }}"
}'
;
Cancels a pending connection invitation before it has been accepted or rejected.
EXEC aws.partnercentral_account.connections.cancel_connection_invitation
@region='{{ region }}' --required
@@json=
'{
"Catalog": "{{ Catalog }}",
"Identifier": "{{ Identifier }}",
"ClientToken": "{{ ClientToken }}"
}'
;
Rejects a connection invitation from another partner, declining the partnership request.
EXEC aws.partnercentral_account.connections.reject_connection_invitation
@region='{{ region }}' --required
@@json=
'{
"Catalog": "{{ Catalog }}",
"Identifier": "{{ Identifier }}",
"ClientToken": "{{ ClientToken }}",
"Reason": "{{ Reason }}"
}'
;