partnerships

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

Overview

Name	partnerships
Type	Resource
Id	aws.b2bi.partnerships

Fields

The following fields are returned by SELECT queries:

get_partnership

Name	Datatype	Description
name	string	Returns the display name of the partnership
capabilities	array	Returns one or more capabilities associated with this partnership.
capability_options	object	Contains the details for an Outbound EDI capability.
created_at	string (date-time)	Returns a timestamp for creation date and time of the partnership.
email	string	Returns the email address associated with this trading partner. (pattern: <code>[\w.-]+@[\w.-]+</code>)
modified_at	string (date-time)	Returns a timestamp that identifies the most recent date and time that the partnership was modified.
partnership_arn	string	Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
partnership_id	string	Returns the unique, system-generated identifier for a partnership. (pattern: <code>[a-zA-Z0-9_-]+</code>)
phone	string	Returns the phone number associated with the partnership. (pattern: <code>+?([0-9 \t-()/]{7,})(?:\s*(?:#|x.?|ext.?|extension) \t*(\d+))?</code>)
profile_id	string	Returns the unique, system-generated identifier for the profile connected to this partnership. (pattern: <code>[a-zA-Z0-9_-]+</code>)
trading_partner_id	string	Returns the unique identifier for the partner for this partnership. (pattern: <code>[a-zA-Z0-9_-]+</code>)

list_partnerships

Name	Datatype	Description
name	string	Returns the name of the partnership.
capabilities	array	Returns one or more capabilities associated with this partnership.
capability_options	object	Contains the details for an Outbound EDI capability.
created_at	string (date-time)	Returns a timestamp for creation date and time of the partnership.
modified_at	string (date-time)	Returns a timestamp that identifies the most recent date and time that the partnership was modified.
partnership_id	string	Returns the unique, system-generated identifier for a partnership. (pattern: <code>[a-zA-Z0-9_-]+</code>)
profile_id	string	Returns the unique, system-generated identifier for the profile connected to this partnership. (pattern: <code>[a-zA-Z0-9_-]+</code>)
trading_partner_id	string	Returns the unique, system-generated identifier for a trading partner. (pattern: <code>[a-zA-Z0-9_-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_partnership	select	region		Retrieves the details for a partnership, based on the partner and profile IDs specified. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
list_partnerships	select	region		Lists the partnerships associated with your Amazon Web Services account for your current or specified region. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
create_partnership	insert	region, profileId, name, email, capabilities		Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
update_partnership	update	region, partnershipId		Updates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
delete_partnership	delete	region		Deletes the specified partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

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_partnership

Retrieves the details for a partnership, based on the partner and profile IDs specified. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

SELECT
name,
capabilities,
capability_options,
created_at,
email,
modified_at,
partnership_arn,
partnership_id,
phone,
profile_id,
trading_partner_id
FROM aws.b2bi.partnerships
WHERE region = '{{ region }}' -- required
;

list_partnerships

Lists the partnerships associated with your Amazon Web Services account for your current or specified region. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

SELECT
name,
capabilities,
capability_options,
created_at,
modified_at,
partnership_id,
profile_id,
trading_partner_id
FROM aws.b2bi.partnerships
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_partnership

Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

INSERT INTO aws.b2bi.partnerships (
profileId,
name,
email,
phone,
capabilities,
capabilityOptions,
clientToken,
tags,
region
)
SELECT 
'{{ profileId }}' /* required */,
'{{ name }}' /* required */,
'{{ email }}' /* required */,
'{{ phone }}',
'{{ capabilities }}' /* required */,
'{{ capabilityOptions }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
name,
capabilities,
capability_options,
created_at,
email,
partnership_arn,
partnership_id,
phone,
profile_id,
trading_partner_id
;

Manifest

# Description fields are for documentation purposes
- name: partnerships
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the partnerships resource.
  - name: profileId
    value: "{{ profileId }}"
    description: |
      Specifies the unique, system-generated identifier for the profile connected to this partnership.
  - name: name
    value: "{{ name }}"
    description: |
      Specifies a descriptive name for the partnership.
  - name: email
    value: "{{ email }}"
    description: |
      Specifies the email address associated with this trading partner.
  - name: phone
    value: "{{ phone }}"
    description: |
      Specifies the phone number associated with the partnership.
  - name: capabilities
    value:
      - "{{ capabilities }}"
    description: |
      Specifies a list of the capabilities associated with this partnership.
  - name: capabilityOptions
    description: |
      Specify the structure that contains the details for the associated capabilities.
    value:
      outboundEdi:
        x12:
          common:
            interchangeControlHeaders:
              senderIdQualifier: "{{ senderIdQualifier }}"
              senderId: "{{ senderId }}"
              receiverIdQualifier: "{{ receiverIdQualifier }}"
              receiverId: "{{ receiverId }}"
              repetitionSeparator: "{{ repetitionSeparator }}"
              acknowledgmentRequestedCode: "{{ acknowledgmentRequestedCode }}"
              usageIndicatorCode: "{{ usageIndicatorCode }}"
            functionalGroupHeaders:
              applicationSenderCode: "{{ applicationSenderCode }}"
              applicationReceiverCode: "{{ applicationReceiverCode }}"
              responsibleAgencyCode: "{{ responsibleAgencyCode }}"
            delimiters:
              componentSeparator: "{{ componentSeparator }}"
              dataElementSeparator: "{{ dataElementSeparator }}"
              segmentTerminator: "{{ segmentTerminator }}"
            validateEdi: {{ validateEdi }}
            controlNumbers:
              startingInterchangeControlNumber: {{ startingInterchangeControlNumber }}
              startingFunctionalGroupControlNumber: {{ startingFunctionalGroupControlNumber }}
              startingTransactionSetControlNumber: {{ startingTransactionSetControlNumber }}
            gs05TimeFormat: "{{ gs05TimeFormat }}"
          wrapOptions:
            wrapBy: "{{ wrapBy }}"
            lineTerminator: "{{ lineTerminator }}"
            lineLength: {{ lineLength }}
      inboundEdi:
        x12:
          acknowledgmentOptions:
            functionalAcknowledgment: "{{ functionalAcknowledgment }}"
            technicalAcknowledgment: "{{ technicalAcknowledgment }}"
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Reserved for future use.
  - name: tags
    description: |
      Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_partnership

Updates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

UPDATE aws.b2bi.partnerships
SET 
partnershipId = '{{ partnershipId }}',
name = '{{ name }}',
capabilities = '{{ capabilities }}',
capabilityOptions = '{{ capabilityOptions }}'
WHERE 
region = '{{ region }}' --required
AND partnershipId = '{{ partnershipId }}' --required
RETURNING
name,
capabilities,
capability_options,
created_at,
email,
modified_at,
partnership_arn,
partnership_id,
phone,
profile_id,
trading_partner_id;

DELETE examples

delete_partnership

Deletes the specified partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

DELETE FROM aws.b2bi.partnerships
WHERE region = '{{ region }}' --required
;