partnerships

Creates, updates, deletes or gets a partnership resource or lists partnerships in a region

Overview

Name	partnerships
Type	Resource
Description	Definition of AWS::B2BI::Partnership Resource Type
Id	aws.b2bi.partnerships

Fields

Name	Datatype	Description
capabilities	array
created_at	string
email	string
modified_at	string
name	string
partnership_arn	string
partnership_id	string
phone	string
profile_id	string
tags	array
trading_partner_id	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Email, Name, ProfileId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all partnerships in a region.

SELECT
region,
capabilities,
created_at,
email,
modified_at,
name,
partnership_arn,
partnership_id,
phone,
profile_id,
tags,
trading_partner_id
FROM aws.b2bi.partnerships
WHERE region = 'us-east-1';

Gets all properties from an individual partnership.

SELECT
region,
capabilities,
created_at,
email,
modified_at,
name,
partnership_arn,
partnership_id,
phone,
profile_id,
tags,
trading_partner_id
FROM aws.b2bi.partnerships
WHERE region = 'us-east-1' AND data__Identifier = '<PartnershipId>';

INSERT example

Use the following StackQL query and manifest file to create a new partnership resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.b2bi.partnerships (
 Email,
 Name,
 ProfileId,
 region
)
SELECT 
'{{ Email }}',
 '{{ Name }}',
 '{{ ProfileId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.b2bi.partnerships (
 Capabilities,
 Email,
 Name,
 Phone,
 ProfileId,
 Tags,
 region
)
SELECT 
 '{{ Capabilities }}',
 '{{ Email }}',
 '{{ Name }}',
 '{{ Phone }}',
 '{{ ProfileId }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: partnership
    props:
      - name: Capabilities
        value:
          - '{{ Capabilities[0] }}'
      - name: Email
        value: '{{ Email }}'
      - name: Name
        value: '{{ Name }}'
      - name: Phone
        value: '{{ Phone }}'
      - name: ProfileId
        value: '{{ ProfileId }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.b2bi.partnerships
WHERE data__Identifier = '<PartnershipId>'
AND region = 'us-east-1';

Permissions

To operate on the partnerships resource, the following permissions are required:

Create

b2bi:CreatePartnership,
b2bi:TagResource,
s3:PutObject

Read

b2bi:GetPartnership,
b2bi:ListTagsForResource

Update

b2bi:TagResource,
b2bi:UntagResource,
b2bi:UpdatePartnership

Delete

b2bi:DeletePartnership

List

b2bi:ListPartnerships