This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::B2BI::Partnership
<a name="aws-resource-b2bi-partnership"></a>

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.

## Syntax
<a name="aws-resource-b2bi-partnership-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-b2bi-partnership-syntax.json"></a>

```
{
  "Type" : "AWS::B2BI::Partnership",
  "Properties" : {
      "[Capabilities](#cfn-b2bi-partnership-capabilities)" : [ String, ... ],
      "[CapabilityOptions](#cfn-b2bi-partnership-capabilityoptions)" : CapabilityOptions,
      "[Email](#cfn-b2bi-partnership-email)" : String,
      "[Name](#cfn-b2bi-partnership-name)" : String,
      "[Phone](#cfn-b2bi-partnership-phone)" : String,
      "[ProfileId](#cfn-b2bi-partnership-profileid)" : String,
      "[Tags](#cfn-b2bi-partnership-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-b2bi-partnership-syntax.yaml"></a>

```
Type: AWS::B2BI::Partnership
Properties:
  [Capabilities](#cfn-b2bi-partnership-capabilities): 
    - String
  [CapabilityOptions](#cfn-b2bi-partnership-capabilityoptions): 
    CapabilityOptions
  [Email](#cfn-b2bi-partnership-email): String
  [Name](#cfn-b2bi-partnership-name): String
  [Phone](#cfn-b2bi-partnership-phone): String
  [ProfileId](#cfn-b2bi-partnership-profileid): String
  [Tags](#cfn-b2bi-partnership-tags): 
    - Tag
```

## Properties
<a name="aws-resource-b2bi-partnership-properties"></a>

`Capabilities`  <a name="cfn-b2bi-partnership-capabilities"></a>
Returns one or more capabilities associated with this partnership.  
*Required*: Yes  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CapabilityOptions`  <a name="cfn-b2bi-partnership-capabilityoptions"></a>
Contains the details for an Outbound EDI capability.  
*Required*: No  
*Type*: [CapabilityOptions](aws-properties-b2bi-partnership-capabilityoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Email`  <a name="cfn-b2bi-partnership-email"></a>
Specifies the email address associated with this trading partner.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[\w\.\-]+@[\w\.\-]+$`  
*Minimum*: `5`  
*Maximum*: `254`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-b2bi-partnership-name"></a>
Returns the name of the partnership.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `254`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Phone`  <a name="cfn-b2bi-partnership-phone"></a>
Specifies the phone number associated with the partnership.  
*Required*: No  
*Type*: String  
*Pattern*: `^\+?([0-9 \t\-()\/]{7,})(?:\s*(?:#|x\.?|ext\.?|extension) \t*(\d+))?$`  
*Minimum*: `7`  
*Maximum*: `22`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ProfileId`  <a name="cfn-b2bi-partnership-profileid"></a>
Returns the unique, system-generated identifier for the profile connected to this partnership.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_-]+$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-b2bi-partnership-tags"></a>
A key-value pair for a specific partnership. Tags are metadata that you can use to search for and group capabilities for various purposes.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-b2bi-partnership-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-b2bi-partnership-return-values"></a>

### Ref
<a name="aws-resource-b2bi-partnership-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-b2bi-partnership-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-b2bi-partnership-return-values-fn--getatt-fn--getatt"></a>

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
Returns a timestamp for creation date and time of the partnership.

`ModifiedAt`  <a name="ModifiedAt-fn::getatt"></a>
Returns a timestamp that identifies the most recent date and time that the partnership was modified.

`PartnershipArn`  <a name="PartnershipArn-fn::getatt"></a>
Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.

`PartnershipId`  <a name="PartnershipId-fn::getatt"></a>
Returns the unique, system-generated identifier for a partnership.

`TradingPartnerId`  <a name="TradingPartnerId-fn::getatt"></a>
Returns the unique, system-generated identifier for a trading partner.

# AWS::B2BI::Partnership CapabilityOptions
<a name="aws-properties-b2bi-partnership-capabilityoptions"></a>

Contains the details for an Outbound EDI capability.

## Syntax
<a name="aws-properties-b2bi-partnership-capabilityoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-capabilityoptions-syntax.json"></a>

```
{
  "[InboundEdi](#cfn-b2bi-partnership-capabilityoptions-inboundedi)" : InboundEdiOptions,
  "[OutboundEdi](#cfn-b2bi-partnership-capabilityoptions-outboundedi)" : OutboundEdiOptions
}
```

### YAML
<a name="aws-properties-b2bi-partnership-capabilityoptions-syntax.yaml"></a>

```
  [InboundEdi](#cfn-b2bi-partnership-capabilityoptions-inboundedi): 
    InboundEdiOptions
  [OutboundEdi](#cfn-b2bi-partnership-capabilityoptions-outboundedi): 
    OutboundEdiOptions
```

## Properties
<a name="aws-properties-b2bi-partnership-capabilityoptions-properties"></a>

`InboundEdi`  <a name="cfn-b2bi-partnership-capabilityoptions-inboundedi"></a>
A structure that contains the inbound EDI options for the capability.  
*Required*: No  
*Type*: [InboundEdiOptions](aws-properties-b2bi-partnership-inboundedioptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OutboundEdi`  <a name="cfn-b2bi-partnership-capabilityoptions-outboundedi"></a>
A structure that contains the outbound EDI options.  
*Required*: No  
*Type*: [OutboundEdiOptions](aws-properties-b2bi-partnership-outboundedioptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Partnership InboundEdiOptions
<a name="aws-properties-b2bi-partnership-inboundedioptions"></a>

Contains options for processing inbound EDI files. These options allow for customizing how incoming EDI documents are processed.

## Syntax
<a name="aws-properties-b2bi-partnership-inboundedioptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-inboundedioptions-syntax.json"></a>

```
{
  "[X12](#cfn-b2bi-partnership-inboundedioptions-x12)" : X12InboundEdiOptions
}
```

### YAML
<a name="aws-properties-b2bi-partnership-inboundedioptions-syntax.yaml"></a>

```
  [X12](#cfn-b2bi-partnership-inboundedioptions-x12): 
    X12InboundEdiOptions
```

## Properties
<a name="aws-properties-b2bi-partnership-inboundedioptions-properties"></a>

`X12`  <a name="cfn-b2bi-partnership-inboundedioptions-x12"></a>
A structure that contains X12-specific options for processing inbound X12 EDI files.  
*Required*: No  
*Type*: [X12InboundEdiOptions](aws-properties-b2bi-partnership-x12inboundedioptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Partnership OutboundEdiOptions
<a name="aws-properties-b2bi-partnership-outboundedioptions"></a>

A container for outbound EDI options.

## Syntax
<a name="aws-properties-b2bi-partnership-outboundedioptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-outboundedioptions-syntax.json"></a>

```
{
  "[X12](#cfn-b2bi-partnership-outboundedioptions-x12)" : X12Envelope
}
```

### YAML
<a name="aws-properties-b2bi-partnership-outboundedioptions-syntax.yaml"></a>

```
  [X12](#cfn-b2bi-partnership-outboundedioptions-x12): 
    X12Envelope
```

## Properties
<a name="aws-properties-b2bi-partnership-outboundedioptions-properties"></a>

`X12`  <a name="cfn-b2bi-partnership-outboundedioptions-x12"></a>
A structure that contains an X12 envelope structure.  
*Required*: Yes  
*Type*: [X12Envelope](aws-properties-b2bi-partnership-x12envelope.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Partnership Tag
<a name="aws-properties-b2bi-partnership-tag"></a>

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.

## Syntax
<a name="aws-properties-b2bi-partnership-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-tag-syntax.json"></a>

```
{
  "[Key](#cfn-b2bi-partnership-tag-key)" : String,
  "[Value](#cfn-b2bi-partnership-tag-value)" : String
}
```

### YAML
<a name="aws-properties-b2bi-partnership-tag-syntax.yaml"></a>

```
  [Key](#cfn-b2bi-partnership-tag-key): String
  [Value](#cfn-b2bi-partnership-tag-value): String
```

## Properties
<a name="aws-properties-b2bi-partnership-tag-properties"></a>

`Key`  <a name="cfn-b2bi-partnership-tag-key"></a>
Specifies the name assigned to the tag that you create.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-b2bi-partnership-tag-value"></a>
Contains one or more values that you assigned to the key name that you create.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Partnership WrapOptions
<a name="aws-properties-b2bi-partnership-wrapoptions"></a>

Contains options for wrapping (line folding) in X12 EDI files. Wrapping controls how long lines are handled in the EDI output.

## Syntax
<a name="aws-properties-b2bi-partnership-wrapoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-wrapoptions-syntax.json"></a>

```
{
  "[LineLength](#cfn-b2bi-partnership-wrapoptions-linelength)" : Number,
  "[LineTerminator](#cfn-b2bi-partnership-wrapoptions-lineterminator)" : String,
  "[WrapBy](#cfn-b2bi-partnership-wrapoptions-wrapby)" : String
}
```

### YAML
<a name="aws-properties-b2bi-partnership-wrapoptions-syntax.yaml"></a>

```
  [LineLength](#cfn-b2bi-partnership-wrapoptions-linelength): Number
  [LineTerminator](#cfn-b2bi-partnership-wrapoptions-lineterminator): String
  [WrapBy](#cfn-b2bi-partnership-wrapoptions-wrapby): String
```

## Properties
<a name="aws-properties-b2bi-partnership-wrapoptions-properties"></a>

`LineLength`  <a name="cfn-b2bi-partnership-wrapoptions-linelength"></a>
Specifies the maximum length of a line before wrapping occurs. This value is used when `wrapBy` is set to `LINE_LENGTH`.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LineTerminator`  <a name="cfn-b2bi-partnership-wrapoptions-lineterminator"></a>
Specifies the character sequence used to terminate lines when wrapping. Valid values:  
+ `CRLF`: carriage return and line feed
+ `LF`: line feed)
+ `CR`: carriage return
*Required*: No  
*Type*: String  
*Allowed values*: `CRLF | LF | CR`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WrapBy`  <a name="cfn-b2bi-partnership-wrapoptions-wrapby"></a>
Specifies the method used for wrapping lines in the EDI output. Valid values:  
+ `SEGMENT`: Wraps by segment.
+ `ONE_LINE`: Indicates that the entire content is on a single line.
**Note**  
When you specify `ONE_LINE`, do not provide either the line length nor the line terminator value.
+ `LINE_LENGTH`: Wraps by character count, as specified by `lineLength` value.
*Required*: No  
*Type*: String  
*Allowed values*: `SEGMENT | ONE_LINE | LINE_LENGTH`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Partnership X12AcknowledgmentOptions
<a name="aws-properties-b2bi-partnership-x12acknowledgmentoptions"></a>

Contains options for configuring X12 acknowledgments. These options control how functional and technical acknowledgments are handled.

## Syntax
<a name="aws-properties-b2bi-partnership-x12acknowledgmentoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-x12acknowledgmentoptions-syntax.json"></a>

```
{
  "[FunctionalAcknowledgment](#cfn-b2bi-partnership-x12acknowledgmentoptions-functionalacknowledgment)" : String,
  "[TechnicalAcknowledgment](#cfn-b2bi-partnership-x12acknowledgmentoptions-technicalacknowledgment)" : String
}
```

### YAML
<a name="aws-properties-b2bi-partnership-x12acknowledgmentoptions-syntax.yaml"></a>

```
  [FunctionalAcknowledgment](#cfn-b2bi-partnership-x12acknowledgmentoptions-functionalacknowledgment): String
  [TechnicalAcknowledgment](#cfn-b2bi-partnership-x12acknowledgmentoptions-technicalacknowledgment): String
```

## Properties
<a name="aws-properties-b2bi-partnership-x12acknowledgmentoptions-properties"></a>

`FunctionalAcknowledgment`  <a name="cfn-b2bi-partnership-x12acknowledgmentoptions-functionalacknowledgment"></a>
Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions. Valid values are `DO_NOT_GENERATE`, `GENERATE_ALL_SEGMENTS` and `GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP`.  
If you choose `GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP`, AWS B2B Data Interchange skips the AK2\$1Loop when generating an acknowledgment document.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `DO_NOT_GENERATE | GENERATE_ALL_SEGMENTS | GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TechnicalAcknowledgment`  <a name="cfn-b2bi-partnership-x12acknowledgmentoptions-technicalacknowledgment"></a>
Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges. Valid values are `DO_NOT_GENERATE` and `GENERATE_ALL_SEGMENTS` and.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `DO_NOT_GENERATE | GENERATE_ALL_SEGMENTS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Partnership X12ControlNumbers
<a name="aws-properties-b2bi-partnership-x12controlnumbers"></a>

Contains configuration for X12 control numbers used in X12 EDI generation. Control numbers are used to uniquely identify interchanges, functional groups, and transaction sets.

## Syntax
<a name="aws-properties-b2bi-partnership-x12controlnumbers-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-x12controlnumbers-syntax.json"></a>

```
{
  "[StartingFunctionalGroupControlNumber](#cfn-b2bi-partnership-x12controlnumbers-startingfunctionalgroupcontrolnumber)" : Number,
  "[StartingInterchangeControlNumber](#cfn-b2bi-partnership-x12controlnumbers-startinginterchangecontrolnumber)" : Number,
  "[StartingTransactionSetControlNumber](#cfn-b2bi-partnership-x12controlnumbers-startingtransactionsetcontrolnumber)" : Number
}
```

### YAML
<a name="aws-properties-b2bi-partnership-x12controlnumbers-syntax.yaml"></a>

```
  [StartingFunctionalGroupControlNumber](#cfn-b2bi-partnership-x12controlnumbers-startingfunctionalgroupcontrolnumber): 
    Number
  [StartingInterchangeControlNumber](#cfn-b2bi-partnership-x12controlnumbers-startinginterchangecontrolnumber): 
    Number
  [StartingTransactionSetControlNumber](#cfn-b2bi-partnership-x12controlnumbers-startingtransactionsetcontrolnumber): 
    Number
```

## Properties
<a name="aws-properties-b2bi-partnership-x12controlnumbers-properties"></a>

`StartingFunctionalGroupControlNumber`  <a name="cfn-b2bi-partnership-x12controlnumbers-startingfunctionalgroupcontrolnumber"></a>
Specifies the starting functional group control number (GS06) to use for X12 EDI generation. This number is incremented for each new functional group. For the GS (functional group) envelope, AWS B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination.   
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `999999999`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StartingInterchangeControlNumber`  <a name="cfn-b2bi-partnership-x12controlnumbers-startinginterchangecontrolnumber"></a>
Specifies the starting interchange control number (ISA13) to use for X12 EDI generation. This number is incremented for each new interchange. For the ISA (interchange) envelope, AWS B2B Data Interchange generates an interchange control number that is unique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.   
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `999999999`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StartingTransactionSetControlNumber`  <a name="cfn-b2bi-partnership-x12controlnumbers-startingtransactionsetcontrolnumber"></a>
Specifies the starting transaction set control number (ST02) to use for X12 EDI generation. This number is incremented for each new transaction set.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `999999999`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Partnership X12Delimiters
<a name="aws-properties-b2bi-partnership-x12delimiters"></a>

In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header. The delimiters are part of the message's syntax and divide up its different elements.

## Syntax
<a name="aws-properties-b2bi-partnership-x12delimiters-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-x12delimiters-syntax.json"></a>

```
{
  "[ComponentSeparator](#cfn-b2bi-partnership-x12delimiters-componentseparator)" : String,
  "[DataElementSeparator](#cfn-b2bi-partnership-x12delimiters-dataelementseparator)" : String,
  "[SegmentTerminator](#cfn-b2bi-partnership-x12delimiters-segmentterminator)" : String
}
```

### YAML
<a name="aws-properties-b2bi-partnership-x12delimiters-syntax.yaml"></a>

```
  [ComponentSeparator](#cfn-b2bi-partnership-x12delimiters-componentseparator): String
  [DataElementSeparator](#cfn-b2bi-partnership-x12delimiters-dataelementseparator): String
  [SegmentTerminator](#cfn-b2bi-partnership-x12delimiters-segmentterminator): String
```

## Properties
<a name="aws-properties-b2bi-partnership-x12delimiters-properties"></a>

`ComponentSeparator`  <a name="cfn-b2bi-partnership-x12delimiters-componentseparator"></a>
The component, or sub-element, separator. The default value is `:` (colon).  
*Required*: No  
*Type*: String  
*Pattern*: `^[!&'()*+,\-./:;?=%@\[\]_{}|<>~^`"]$`  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DataElementSeparator`  <a name="cfn-b2bi-partnership-x12delimiters-dataelementseparator"></a>
The data element separator. The default value is `*` (asterisk).  
*Required*: No  
*Type*: String  
*Pattern*: `^[!&'()*+,\-./:;?=%@\[\]_{}|<>~^`"]$`  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SegmentTerminator`  <a name="cfn-b2bi-partnership-x12delimiters-segmentterminator"></a>
The segment terminator. The default value is `~` (tilde).  
*Required*: No  
*Type*: String  
*Pattern*: `^[!&'()*+,\-./:;?=%@\[\]_{}|<>~^`"]$`  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Partnership X12Envelope
<a name="aws-properties-b2bi-partnership-x12envelope"></a>

A wrapper structure for an X12 definition object.

the X12 envelope ensures the integrity of the data and the efficiency of the information exchange. The X12 message structure has hierarchical levels. From highest to the lowest, they are:
+ Interchange Envelope
+ Functional Group
+ Transaction Set

## Syntax
<a name="aws-properties-b2bi-partnership-x12envelope-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-x12envelope-syntax.json"></a>

```
{
  "[Common](#cfn-b2bi-partnership-x12envelope-common)" : X12OutboundEdiHeaders,
  "[WrapOptions](#cfn-b2bi-partnership-x12envelope-wrapoptions)" : WrapOptions
}
```

### YAML
<a name="aws-properties-b2bi-partnership-x12envelope-syntax.yaml"></a>

```
  [Common](#cfn-b2bi-partnership-x12envelope-common): 
    X12OutboundEdiHeaders
  [WrapOptions](#cfn-b2bi-partnership-x12envelope-wrapoptions): 
    WrapOptions
```

## Properties
<a name="aws-properties-b2bi-partnership-x12envelope-properties"></a>

`Common`  <a name="cfn-b2bi-partnership-x12envelope-common"></a>
A container for the X12 outbound EDI headers.  
*Required*: No  
*Type*: [X12OutboundEdiHeaders](aws-properties-b2bi-partnership-x12outboundediheaders.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WrapOptions`  <a name="cfn-b2bi-partnership-x12envelope-wrapoptions"></a>
Property description not available.  
*Required*: No  
*Type*: [WrapOptions](aws-properties-b2bi-partnership-wrapoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Partnership X12FunctionalGroupHeaders
<a name="aws-properties-b2bi-partnership-x12functionalgroupheaders"></a>

Part of the X12 message structure. These are the functional group headers for the X12 EDI object.

## Syntax
<a name="aws-properties-b2bi-partnership-x12functionalgroupheaders-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-x12functionalgroupheaders-syntax.json"></a>

```
{
  "[ApplicationReceiverCode](#cfn-b2bi-partnership-x12functionalgroupheaders-applicationreceivercode)" : String,
  "[ApplicationSenderCode](#cfn-b2bi-partnership-x12functionalgroupheaders-applicationsendercode)" : String,
  "[ResponsibleAgencyCode](#cfn-b2bi-partnership-x12functionalgroupheaders-responsibleagencycode)" : String
}
```

### YAML
<a name="aws-properties-b2bi-partnership-x12functionalgroupheaders-syntax.yaml"></a>

```
  [ApplicationReceiverCode](#cfn-b2bi-partnership-x12functionalgroupheaders-applicationreceivercode): String
  [ApplicationSenderCode](#cfn-b2bi-partnership-x12functionalgroupheaders-applicationsendercode): String
  [ResponsibleAgencyCode](#cfn-b2bi-partnership-x12functionalgroupheaders-responsibleagencycode): String
```

## Properties
<a name="aws-properties-b2bi-partnership-x12functionalgroupheaders-properties"></a>

`ApplicationReceiverCode`  <a name="cfn-b2bi-partnership-x12functionalgroupheaders-applicationreceivercode"></a>
A value representing the code used to identify the party receiving a message, at position GS-03.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9 ]*$`  
*Minimum*: `2`  
*Maximum*: `15`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ApplicationSenderCode`  <a name="cfn-b2bi-partnership-x12functionalgroupheaders-applicationsendercode"></a>
A value representing the code used to identify the party transmitting a message, at position GS-02.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9 ]*$`  
*Minimum*: `2`  
*Maximum*: `15`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResponsibleAgencyCode`  <a name="cfn-b2bi-partnership-x12functionalgroupheaders-responsibleagencycode"></a>
A code that identifies the issuer of the standard, at position GS-07.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]*$`  
*Minimum*: `1`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Partnership X12InboundEdiOptions
<a name="aws-properties-b2bi-partnership-x12inboundedioptions"></a>

Contains options specific to processing inbound X12 EDI files.

## Syntax
<a name="aws-properties-b2bi-partnership-x12inboundedioptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-x12inboundedioptions-syntax.json"></a>

```
{
  "[AcknowledgmentOptions](#cfn-b2bi-partnership-x12inboundedioptions-acknowledgmentoptions)" : X12AcknowledgmentOptions
}
```

### YAML
<a name="aws-properties-b2bi-partnership-x12inboundedioptions-syntax.yaml"></a>

```
  [AcknowledgmentOptions](#cfn-b2bi-partnership-x12inboundedioptions-acknowledgmentoptions): 
    X12AcknowledgmentOptions
```

## Properties
<a name="aws-properties-b2bi-partnership-x12inboundedioptions-properties"></a>

`AcknowledgmentOptions`  <a name="cfn-b2bi-partnership-x12inboundedioptions-acknowledgmentoptions"></a>
Specifies acknowledgment options for inbound X12 EDI files. These options control how functional and technical acknowledgments are handled.  
*Required*: No  
*Type*: [X12AcknowledgmentOptions](aws-properties-b2bi-partnership-x12acknowledgmentoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Partnership X12InterchangeControlHeaders
<a name="aws-properties-b2bi-partnership-x12interchangecontrolheaders"></a>

In X12, the Interchange Control Header is the first segment of an EDI document and is part of the Interchange Envelope. It contains information about the sender and receiver, the date and time of transmission, and the X12 version being used. It also includes delivery information, such as the sender and receiver IDs.

## Syntax
<a name="aws-properties-b2bi-partnership-x12interchangecontrolheaders-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-x12interchangecontrolheaders-syntax.json"></a>

```
{
  "[AcknowledgmentRequestedCode](#cfn-b2bi-partnership-x12interchangecontrolheaders-acknowledgmentrequestedcode)" : String,
  "[ReceiverId](#cfn-b2bi-partnership-x12interchangecontrolheaders-receiverid)" : String,
  "[ReceiverIdQualifier](#cfn-b2bi-partnership-x12interchangecontrolheaders-receiveridqualifier)" : String,
  "[RepetitionSeparator](#cfn-b2bi-partnership-x12interchangecontrolheaders-repetitionseparator)" : String,
  "[SenderId](#cfn-b2bi-partnership-x12interchangecontrolheaders-senderid)" : String,
  "[SenderIdQualifier](#cfn-b2bi-partnership-x12interchangecontrolheaders-senderidqualifier)" : String,
  "[UsageIndicatorCode](#cfn-b2bi-partnership-x12interchangecontrolheaders-usageindicatorcode)" : String
}
```

### YAML
<a name="aws-properties-b2bi-partnership-x12interchangecontrolheaders-syntax.yaml"></a>

```
  [AcknowledgmentRequestedCode](#cfn-b2bi-partnership-x12interchangecontrolheaders-acknowledgmentrequestedcode): String
  [ReceiverId](#cfn-b2bi-partnership-x12interchangecontrolheaders-receiverid): String
  [ReceiverIdQualifier](#cfn-b2bi-partnership-x12interchangecontrolheaders-receiveridqualifier): String
  [RepetitionSeparator](#cfn-b2bi-partnership-x12interchangecontrolheaders-repetitionseparator): String
  [SenderId](#cfn-b2bi-partnership-x12interchangecontrolheaders-senderid): String
  [SenderIdQualifier](#cfn-b2bi-partnership-x12interchangecontrolheaders-senderidqualifier): String
  [UsageIndicatorCode](#cfn-b2bi-partnership-x12interchangecontrolheaders-usageindicatorcode): String
```

## Properties
<a name="aws-properties-b2bi-partnership-x12interchangecontrolheaders-properties"></a>

`AcknowledgmentRequestedCode`  <a name="cfn-b2bi-partnership-x12interchangecontrolheaders-acknowledgmentrequestedcode"></a>
Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]*$`  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReceiverId`  <a name="cfn-b2bi-partnership-x12interchangecontrolheaders-receiverid"></a>
Located at position ISA-08 in the header. This value (along with the `receiverIdQualifier`) identifies the intended recipient of the interchange.   
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9 ]*$`  
*Minimum*: `15`  
*Maximum*: `15`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReceiverIdQualifier`  <a name="cfn-b2bi-partnership-x12interchangecontrolheaders-receiveridqualifier"></a>
Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]*$`  
*Minimum*: `2`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RepetitionSeparator`  <a name="cfn-b2bi-partnership-x12interchangecontrolheaders-repetitionseparator"></a>
Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.  
This parameter is only honored for version greater than 401 (`VERSION_4010` and higher).  
For versions less than 401, this field is called [StandardsId](https://www.stedi.com/edi/x12-004010/segment/ISA#ISA-11), in which case our service sets the value to `U`.
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SenderId`  <a name="cfn-b2bi-partnership-x12interchangecontrolheaders-senderid"></a>
Located at position ISA-06 in the header. This value (along with the `senderIdQualifier`) identifies the sender of the interchange.   
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9 ]*$`  
*Minimum*: `15`  
*Maximum*: `15`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SenderIdQualifier`  <a name="cfn-b2bi-partnership-x12interchangecontrolheaders-senderidqualifier"></a>
Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]*$`  
*Minimum*: `2`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UsageIndicatorCode`  <a name="cfn-b2bi-partnership-x12interchangecontrolheaders-usageindicatorcode"></a>
Located at position ISA-15 in the header. Specifies how this interchange is being used:  
+ `T` indicates this interchange is for testing.
+ `P` indicates this interchange is for production.
+ `I` indicates this interchange is informational.
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]*$`  
*Minimum*: `1`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Partnership X12OutboundEdiHeaders
<a name="aws-properties-b2bi-partnership-x12outboundediheaders"></a>

A structure containing the details for an outbound EDI object.

## Syntax
<a name="aws-properties-b2bi-partnership-x12outboundediheaders-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-b2bi-partnership-x12outboundediheaders-syntax.json"></a>

```
{
  "[ControlNumbers](#cfn-b2bi-partnership-x12outboundediheaders-controlnumbers)" : X12ControlNumbers,
  "[Delimiters](#cfn-b2bi-partnership-x12outboundediheaders-delimiters)" : X12Delimiters,
  "[FunctionalGroupHeaders](#cfn-b2bi-partnership-x12outboundediheaders-functionalgroupheaders)" : X12FunctionalGroupHeaders,
  "[Gs05TimeFormat](#cfn-b2bi-partnership-x12outboundediheaders-gs05timeformat)" : String,
  "[InterchangeControlHeaders](#cfn-b2bi-partnership-x12outboundediheaders-interchangecontrolheaders)" : X12InterchangeControlHeaders,
  "[ValidateEdi](#cfn-b2bi-partnership-x12outboundediheaders-validateedi)" : Boolean
}
```

### YAML
<a name="aws-properties-b2bi-partnership-x12outboundediheaders-syntax.yaml"></a>

```
  [ControlNumbers](#cfn-b2bi-partnership-x12outboundediheaders-controlnumbers): 
    X12ControlNumbers
  [Delimiters](#cfn-b2bi-partnership-x12outboundediheaders-delimiters): 
    X12Delimiters
  [FunctionalGroupHeaders](#cfn-b2bi-partnership-x12outboundediheaders-functionalgroupheaders): 
    X12FunctionalGroupHeaders
  [Gs05TimeFormat](#cfn-b2bi-partnership-x12outboundediheaders-gs05timeformat): String
  [InterchangeControlHeaders](#cfn-b2bi-partnership-x12outboundediheaders-interchangecontrolheaders): 
    X12InterchangeControlHeaders
  [ValidateEdi](#cfn-b2bi-partnership-x12outboundediheaders-validateedi): Boolean
```

## Properties
<a name="aws-properties-b2bi-partnership-x12outboundediheaders-properties"></a>

`ControlNumbers`  <a name="cfn-b2bi-partnership-x12outboundediheaders-controlnumbers"></a>
Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.  
*Required*: No  
*Type*: [X12ControlNumbers](aws-properties-b2bi-partnership-x12controlnumbers.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Delimiters`  <a name="cfn-b2bi-partnership-x12outboundediheaders-delimiters"></a>
The delimiters, for example semicolon (`;`), that separates sections of the headers for the X12 object.  
*Required*: No  
*Type*: [X12Delimiters](aws-properties-b2bi-partnership-x12delimiters.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FunctionalGroupHeaders`  <a name="cfn-b2bi-partnership-x12outboundediheaders-functionalgroupheaders"></a>
The functional group headers for the X12 object.  
*Required*: No  
*Type*: [X12FunctionalGroupHeaders](aws-properties-b2bi-partnership-x12functionalgroupheaders.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Gs05TimeFormat`  <a name="cfn-b2bi-partnership-x12outboundediheaders-gs05timeformat"></a>
Specifies the time format in the GS05 element (time) of the functional group header. The following formats use 24-hour clock time:  
+ `HHMM` - Hours and minutes
+ `HHMMSS` - Hours, minutes, and seconds
+ `HHMMSSDD` - Hours, minutes, seconds, and decimal seconds
Where:  
+ `HH` - Hours (00-23)
+ `MM` - Minutes (00-59)
+ `SS` - Seconds (00-59)
+ `DD` - Hundredths of seconds (00-99)
*Required*: No  
*Type*: String  
*Allowed values*: `HHMM | HHMMSS | HHMMSSDD`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InterchangeControlHeaders`  <a name="cfn-b2bi-partnership-x12outboundediheaders-interchangecontrolheaders"></a>
In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.  
*Required*: No  
*Type*: [X12InterchangeControlHeaders](aws-properties-b2bi-partnership-x12interchangecontrolheaders.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ValidateEdi`  <a name="cfn-b2bi-partnership-x12outboundediheaders-validateedi"></a>
Specifies whether or not to validate the EDI for this X12 object: `TRUE` or `FALSE`. When enabled, this performs both standard EDI validation and applies any configured custom validation rules including element length constraints, code list validations, and element requirement checks. Validation results are returned in the response validation messages.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)