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 B2B Data Interchange
<a name="AWS_B2BI"></a>

**Resource types**
+ [AWS::B2BI::Capability](aws-resource-b2bi-capability.md)
+ [AWS::B2BI::Partnership](aws-resource-b2bi-partnership.md)
+ [AWS::B2BI::Profile](aws-resource-b2bi-profile.md)
+ [AWS::B2BI::Transformer](aws-resource-b2bi-transformer.md)

# AWS::B2BI::Capability
<a name="aws-resource-b2bi-capability"></a>

Instantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

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

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

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

```
{
  "Type" : "AWS::B2BI::Capability",
  "Properties" : {
      "[Configuration](#cfn-b2bi-capability-configuration)" : CapabilityConfiguration,
      "[InstructionsDocuments](#cfn-b2bi-capability-instructionsdocuments)" : [ S3Location, ... ],
      "[Name](#cfn-b2bi-capability-name)" : String,
      "[Tags](#cfn-b2bi-capability-tags)" : [ Tag, ... ],
      "[Type](#cfn-b2bi-capability-type)" : String
    }
}
```

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

```
Type: AWS::B2BI::Capability
Properties:
  [Configuration](#cfn-b2bi-capability-configuration): 
    CapabilityConfiguration
  [InstructionsDocuments](#cfn-b2bi-capability-instructionsdocuments): 
    - S3Location
  [Name](#cfn-b2bi-capability-name): String
  [Tags](#cfn-b2bi-capability-tags): 
    - Tag
  [Type](#cfn-b2bi-capability-type): String
```

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

`Configuration`  <a name="cfn-b2bi-capability-configuration"></a>
Specifies a structure that contains the details for a capability.  
*Required*: Yes  
*Type*: [CapabilityConfiguration](aws-properties-b2bi-capability-capabilityconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InstructionsDocuments`  <a name="cfn-b2bi-capability-instructionsdocuments"></a>
Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location.  
*Required*: No  
*Type*: Array of [S3Location](aws-properties-b2bi-capability-s3location.md)  
*Minimum*: `0`  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-b2bi-capability-name"></a>
The display name of the capability.  
*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)

`Tags`  <a name="cfn-b2bi-capability-tags"></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.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-b2bi-capability-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)

`Type`  <a name="cfn-b2bi-capability-type"></a>
Returns the type of the capability. Currently, only `edi` is supported.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `edi`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

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

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

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

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

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

`CapabilityId`  <a name="CapabilityId-fn::getatt"></a>
Returns a system-assigned unique identifier for the capability.

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

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

# AWS::B2BI::Capability CapabilityConfiguration
<a name="aws-properties-b2bi-capability-capabilityconfiguration"></a>

A capability object. Currently, only EDI (electronic data interchange) capabilities are supported. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

## Syntax
<a name="aws-properties-b2bi-capability-capabilityconfiguration-syntax"></a>

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

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

```
{
  "[Edi](#cfn-b2bi-capability-capabilityconfiguration-edi)" : EdiConfiguration
}
```

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

```
  [Edi](#cfn-b2bi-capability-capabilityconfiguration-edi): 
    EdiConfiguration
```

## Properties
<a name="aws-properties-b2bi-capability-capabilityconfiguration-properties"></a>

`Edi`  <a name="cfn-b2bi-capability-capabilityconfiguration-edi"></a>
An EDI (electronic data interchange) configuration object.  
*Required*: Yes  
*Type*: [EdiConfiguration](aws-properties-b2bi-capability-ediconfiguration.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::Capability EdiConfiguration
<a name="aws-properties-b2bi-capability-ediconfiguration"></a>

Specifies the details for the EDI (electronic data interchange) transformation.

## Syntax
<a name="aws-properties-b2bi-capability-ediconfiguration-syntax"></a>

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

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

```
{
  "[CapabilityDirection](#cfn-b2bi-capability-ediconfiguration-capabilitydirection)" : String,
  "[InputLocation](#cfn-b2bi-capability-ediconfiguration-inputlocation)" : S3Location,
  "[OutputLocation](#cfn-b2bi-capability-ediconfiguration-outputlocation)" : S3Location,
  "[TransformerId](#cfn-b2bi-capability-ediconfiguration-transformerid)" : String,
  "[Type](#cfn-b2bi-capability-ediconfiguration-type)" : EdiType
}
```

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

```
  [CapabilityDirection](#cfn-b2bi-capability-ediconfiguration-capabilitydirection): String
  [InputLocation](#cfn-b2bi-capability-ediconfiguration-inputlocation): 
    S3Location
  [OutputLocation](#cfn-b2bi-capability-ediconfiguration-outputlocation): 
    S3Location
  [TransformerId](#cfn-b2bi-capability-ediconfiguration-transformerid): String
  [Type](#cfn-b2bi-capability-ediconfiguration-type): 
    EdiType
```

## Properties
<a name="aws-properties-b2bi-capability-ediconfiguration-properties"></a>

`CapabilityDirection`  <a name="cfn-b2bi-capability-ediconfiguration-capabilitydirection"></a>
Specifies whether this is capability is for inbound or outbound transformations.  
*Required*: No  
*Type*: String  
*Allowed values*: `INBOUND | OUTBOUND`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InputLocation`  <a name="cfn-b2bi-capability-ediconfiguration-inputlocation"></a>
Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an `S3Location` object.  
*Required*: Yes  
*Type*: [S3Location](aws-properties-b2bi-capability-s3location.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OutputLocation`  <a name="cfn-b2bi-capability-ediconfiguration-outputlocation"></a>
Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an `S3Location` object.  
*Required*: Yes  
*Type*: [S3Location](aws-properties-b2bi-capability-s3location.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TransformerId`  <a name="cfn-b2bi-capability-ediconfiguration-transformerid"></a>
Returns the system-assigned unique identifier for the transformer.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_-]+$`  
*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)

`Type`  <a name="cfn-b2bi-capability-ediconfiguration-type"></a>
Returns the type of the capability. Currently, only `edi` is supported.  
*Required*: Yes  
*Type*: [EdiType](aws-properties-b2bi-capability-editype.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::Capability EdiType
<a name="aws-properties-b2bi-capability-editype"></a>

<a name="aws-properties-b2bi-capability-editype-description"></a>The `EdiType` property type specifies Property description not available. for an [AWS::B2BI::Capability](aws-resource-b2bi-capability.md).

## Syntax
<a name="aws-properties-b2bi-capability-editype-syntax"></a>

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

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

```
{
  "[X12Details](#cfn-b2bi-capability-editype-x12details)" : X12Details
}
```

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

```
  [X12Details](#cfn-b2bi-capability-editype-x12details): 
    X12Details
```

## Properties
<a name="aws-properties-b2bi-capability-editype-properties"></a>

`X12Details`  <a name="cfn-b2bi-capability-editype-x12details"></a>
Property description not available.  
*Required*: Yes  
*Type*: [X12Details](aws-properties-b2bi-capability-x12details.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::Capability S3Location
<a name="aws-properties-b2bi-capability-s3location"></a>

Specifies the details for the Amazon S3 file location that is being used with AWS B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key.

## Syntax
<a name="aws-properties-b2bi-capability-s3location-syntax"></a>

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

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

```
{
  "[BucketName](#cfn-b2bi-capability-s3location-bucketname)" : String,
  "[Key](#cfn-b2bi-capability-s3location-key)" : String
}
```

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

```
  [BucketName](#cfn-b2bi-capability-s3location-bucketname): String
  [Key](#cfn-b2bi-capability-s3location-key): String
```

## Properties
<a name="aws-properties-b2bi-capability-s3location-properties"></a>

`BucketName`  <a name="cfn-b2bi-capability-s3location-bucketname"></a>
Specifies the name of the Amazon S3 bucket.  
*Required*: No  
*Type*: String  
*Minimum*: `3`  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Key`  <a name="cfn-b2bi-capability-s3location-key"></a>
Specifies the Amazon S3 key for the file location.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

A key-value pair for a specific capability. Tags are metadata that you can use to search for and group capabilities for various purposes. 

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

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

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

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

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

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

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

`Key`  <a name="cfn-b2bi-capability-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-capability-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::Capability X12Details
<a name="aws-properties-b2bi-capability-x12details"></a>

A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.

**Note**  
If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.

## Syntax
<a name="aws-properties-b2bi-capability-x12details-syntax"></a>

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

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

```
{
  "[TransactionSet](#cfn-b2bi-capability-x12details-transactionset)" : String,
  "[Version](#cfn-b2bi-capability-x12details-version)" : String
}
```

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

```
  [TransactionSet](#cfn-b2bi-capability-x12details-transactionset): String
  [Version](#cfn-b2bi-capability-x12details-version): String
```

## Properties
<a name="aws-properties-b2bi-capability-x12details-properties"></a>

`TransactionSet`  <a name="cfn-b2bi-capability-x12details-transactionset"></a>
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.  
*Required*: No  
*Type*: String  
*Allowed values*: `X12_100 | X12_101 | X12_102 | X12_103 | X12_104 | X12_105 | X12_106 | X12_107 | X12_108 | X12_109 | X12_110 | X12_111 | X12_112 | X12_113 | X12_120 | X12_121 | X12_124 | X12_125 | X12_126 | X12_127 | X12_128 | X12_129 | X12_130 | X12_131 | X12_132 | X12_133 | X12_135 | X12_138 | X12_139 | X12_140 | X12_141 | X12_142 | X12_143 | X12_144 | X12_146 | X12_147 | X12_148 | X12_149 | X12_150 | X12_151 | X12_152 | X12_153 | X12_154 | X12_155 | X12_157 | X12_158 | X12_159 | X12_160 | X12_161 | X12_163 | X12_170 | X12_175 | X12_176 | X12_179 | X12_180 | X12_185 | X12_186 | X12_187 | X12_188 | X12_189 | X12_190 | X12_191 | X12_194 | X12_195 | X12_196 | X12_197 | X12_198 | X12_199 | X12_200 | X12_201 | X12_202 | X12_203 | X12_204 | X12_205 | X12_206 | X12_210 | X12_211 | X12_212 | X12_213 | X12_214 | X12_215 | X12_216 | X12_217 | X12_218 | X12_219 | X12_220 | X12_222 | X12_223 | X12_224 | X12_225 | X12_227 | X12_228 | X12_240 | X12_242 | X12_244 | X12_245 | X12_248 | X12_249 | X12_250 | X12_251 | X12_252 | X12_255 | X12_256 | X12_259 | X12_260 | X12_261 | X12_262 | X12_263 | X12_264 | X12_265 | X12_266 | X12_267 | X12_268 | X12_269 | X12_270 | X12_271 | X12_272 | X12_273 | X12_274 | X12_275 | X12_276 | X12_277 | X12_278 | X12_280 | X12_283 | X12_284 | X12_285 | X12_286 | X12_288 | X12_290 | X12_300 | X12_301 | X12_303 | X12_304 | X12_309 | X12_310 | X12_311 | X12_312 | X12_313 | X12_315 | X12_317 | X12_319 | X12_322 | X12_323 | X12_324 | X12_325 | X12_326 | X12_350 | X12_352 | X12_353 | X12_354 | X12_355 | X12_356 | X12_357 | X12_358 | X12_361 | X12_362 | X12_404 | X12_410 | X12_412 | X12_414 | X12_417 | X12_418 | X12_419 | X12_420 | X12_421 | X12_422 | X12_423 | X12_424 | X12_425 | X12_426 | X12_429 | X12_431 | X12_432 | X12_433 | X12_434 | X12_435 | X12_436 | X12_437 | X12_440 | X12_451 | X12_452 | X12_453 | X12_455 | X12_456 | X12_460 | X12_463 | X12_466 | X12_468 | X12_470 | X12_475 | X12_485 | X12_486 | X12_490 | X12_492 | X12_494 | X12_500 | X12_501 | X12_503 | X12_504 | X12_511 | X12_517 | X12_521 | X12_527 | X12_536 | X12_540 | X12_561 | X12_567 | X12_568 | X12_601 | X12_602 | X12_620 | X12_625 | X12_650 | X12_715 | X12_753 | X12_754 | X12_805 | X12_806 | X12_810 | X12_811 | X12_812 | X12_813 | X12_814 | X12_815 | X12_816 | X12_818 | X12_819 | X12_820 | X12_821 | X12_822 | X12_823 | X12_824 | X12_826 | X12_827 | X12_828 | X12_829 | X12_830 | X12_831 | X12_832 | X12_833 | X12_834 | X12_835 | X12_836 | X12_837 | X12_838 | X12_839 | X12_840 | X12_841 | X12_842 | X12_843 | X12_844 | X12_845 | X12_846 | X12_847 | X12_848 | X12_849 | X12_850 | X12_851 | X12_852 | X12_853 | X12_854 | X12_855 | X12_856 | X12_857 | X12_858 | X12_859 | X12_860 | X12_861 | X12_862 | X12_863 | X12_864 | X12_865 | X12_866 | X12_867 | X12_868 | X12_869 | X12_870 | X12_871 | X12_872 | X12_873 | X12_874 | X12_875 | X12_876 | X12_877 | X12_878 | X12_879 | X12_880 | X12_881 | X12_882 | X12_883 | X12_884 | X12_885 | X12_886 | X12_887 | X12_888 | X12_889 | X12_891 | X12_893 | X12_894 | X12_895 | X12_896 | X12_920 | X12_924 | X12_925 | X12_926 | X12_928 | X12_940 | X12_943 | X12_944 | X12_945 | X12_947 | X12_980 | X12_990 | X12_993 | X12_996 | X12_997 | X12_998 | X12_999 | X12_270_X279 | X12_271_X279 | X12_275_X210 | X12_275_X211 | X12_276_X212 | X12_277_X212 | X12_277_X214 | X12_277_X364 | X12_278_X217 | X12_820_X218 | X12_820_X306 | X12_824_X186 | X12_834_X220 | X12_834_X307 | X12_834_X318 | X12_835_X221 | X12_837_X222 | X12_837_X223 | X12_837_X224 | X12_837_X291 | X12_837_X292 | X12_837_X298 | X12_999_X231`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Version`  <a name="cfn-b2bi-capability-x12details-version"></a>
Returns the version to use for the specified X12 transaction set.  
*Required*: No  
*Type*: String  
*Allowed values*: `VERSION_4010 | VERSION_4030 | VERSION_4050 | VERSION_4060 | VERSION_5010 | VERSION_5010_HIPAA`  
*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
<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)

# AWS::B2BI::Profile
<a name="aws-resource-b2bi-profile"></a>

Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.

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

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

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

```
{
  "Type" : "AWS::B2BI::Profile",
  "Properties" : {
      "[BusinessName](#cfn-b2bi-profile-businessname)" : String,
      "[Email](#cfn-b2bi-profile-email)" : String,
      "[Logging](#cfn-b2bi-profile-logging)" : String,
      "[Name](#cfn-b2bi-profile-name)" : String,
      "[Phone](#cfn-b2bi-profile-phone)" : String,
      "[Tags](#cfn-b2bi-profile-tags)" : [ Tag, ... ]
    }
}
```

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

```
Type: AWS::B2BI::Profile
Properties:
  [BusinessName](#cfn-b2bi-profile-businessname): String
  [Email](#cfn-b2bi-profile-email): String
  [Logging](#cfn-b2bi-profile-logging): String
  [Name](#cfn-b2bi-profile-name): String
  [Phone](#cfn-b2bi-profile-phone): String
  [Tags](#cfn-b2bi-profile-tags): 
    - Tag
```

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

`BusinessName`  <a name="cfn-b2bi-profile-businessname"></a>
Returns the name for the business associated with this profile.  
*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)

`Email`  <a name="cfn-b2bi-profile-email"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\w\.\-]+@[\w\.\-]+$`  
*Minimum*: `5`  
*Maximum*: `254`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Logging`  <a name="cfn-b2bi-profile-logging"></a>
Specifies whether or not logging is enabled for this profile.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*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-profile-name"></a>
Returns the display name for profile.  
*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-profile-phone"></a>
Specifies the phone number associated with the profile.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^\+?([0-9 \t\-()\/]{7,})(?:\s*(?:#|x\.?|ext\.?|extension) \t*(\d+))?$`  
*Minimum*: `7`  
*Maximum*: `22`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-b2bi-profile-tags"></a>
A key-value pair for a specific profile. 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-profile-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-profile-return-values"></a>

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

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

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

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

`LogGroupName`  <a name="LogGroupName-fn::getatt"></a>
Returns the name of the logging group.

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

`ProfileArn`  <a name="ProfileArn-fn::getatt"></a>
Returns an Amazon Resource Name (ARN) for the profile.

`ProfileId`  <a name="ProfileId-fn::getatt"></a>
Property description not available.

# AWS::B2BI::Profile Tag
<a name="aws-properties-b2bi-profile-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-profile-tag-syntax"></a>

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

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

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

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

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

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

`Key`  <a name="cfn-b2bi-profile-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-profile-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::Transformer
<a name="aws-resource-b2bi-transformer"></a>

Creates a transformer. AWS B2B Data Interchange currently supports two scenarios:
+ *Inbound EDI*: the AWS customer receives an EDI file from their trading partner. AWS B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
+ *Outbound EDI*: the AWS customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.

**Note**  
The following fields are provided for backwards compatibility only: `fileFormat`, `mappingTemplate`, `ediType`, and `sampleDocument`.  
Use the `mapping` data type in place of `mappingTemplate` and `fileFormat`
Use the `sampleDocuments` data type in place of `sampleDocument`
Use either the `inputConversion` or `outputConversion` in place of `ediType`

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

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

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

```
{
  "Type" : "AWS::B2BI::Transformer",
  "Properties" : {
      "[InputConversion](#cfn-b2bi-transformer-inputconversion)" : InputConversion,
      "[Mapping](#cfn-b2bi-transformer-mapping)" : Mapping,
      "[Name](#cfn-b2bi-transformer-name)" : String,
      "[OutputConversion](#cfn-b2bi-transformer-outputconversion)" : OutputConversion,
      "[SampleDocuments](#cfn-b2bi-transformer-sampledocuments)" : SampleDocuments,
      "[Status](#cfn-b2bi-transformer-status)" : String,
      "[Tags](#cfn-b2bi-transformer-tags)" : [ Tag, ... ]
    }
}
```

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

```
Type: AWS::B2BI::Transformer
Properties:
  [InputConversion](#cfn-b2bi-transformer-inputconversion): 
    InputConversion
  [Mapping](#cfn-b2bi-transformer-mapping): 
    Mapping
  [Name](#cfn-b2bi-transformer-name): String
  [OutputConversion](#cfn-b2bi-transformer-outputconversion): 
    OutputConversion
  [SampleDocuments](#cfn-b2bi-transformer-sampledocuments): 
    SampleDocuments
  [Status](#cfn-b2bi-transformer-status): String
  [Tags](#cfn-b2bi-transformer-tags): 
    - Tag
```

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

`InputConversion`  <a name="cfn-b2bi-transformer-inputconversion"></a>
Returns a structure that contains the format options for the transformation.  
*Required*: No  
*Type*: [InputConversion](aws-properties-b2bi-transformer-inputconversion.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Mapping`  <a name="cfn-b2bi-transformer-mapping"></a>
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).  
*Required*: No  
*Type*: [Mapping](aws-properties-b2bi-transformer-mapping.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-b2bi-transformer-name"></a>
Returns the descriptive name for the transformer.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_-]{1,512}$`  
*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)

`OutputConversion`  <a name="cfn-b2bi-transformer-outputconversion"></a>
Returns the `OutputConversion` object, which contains the format options for the outbound transformation.  
*Required*: No  
*Type*: [OutputConversion](aws-properties-b2bi-transformer-outputconversion.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SampleDocuments`  <a name="cfn-b2bi-transformer-sampledocuments"></a>
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.  
*Required*: No  
*Type*: [SampleDocuments](aws-properties-b2bi-transformer-sampledocuments.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-b2bi-transformer-status"></a>
Returns the state of the newly created transformer. The transformer can be either `active` or `inactive`. For the transformer to be used in a capability, its status must `active`.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `active | inactive`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-b2bi-transformer-tags"></a>
A key-value pair for a specific transformer. 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-transformer-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-transformer-return-values"></a>

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

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

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

`CreatedAt`  <a name="CreatedAt-fn::getatt"></a>
Returns a timestamp indicating when the transformer was created. For example, `2023-07-20T19:58:44.624Z`.

`ModifiedAt`  <a name="ModifiedAt-fn::getatt"></a>
Returns a timestamp representing the date and time for the most recent change for the transformer object.

`TransformerArn`  <a name="TransformerArn-fn::getatt"></a>
Returns an Amazon Resource Name (ARN) for a specific transformer.

`TransformerId`  <a name="TransformerId-fn::getatt"></a>
The system-assigned unique identifier for the transformer.

# AWS::B2BI::Transformer AdvancedOptions
<a name="aws-properties-b2bi-transformer-advancedoptions"></a>

A structure that contains advanced options for EDI processing. Currently, only X12 advanced options are supported.

## Syntax
<a name="aws-properties-b2bi-transformer-advancedoptions-syntax"></a>

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

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

```
{
  "[X12](#cfn-b2bi-transformer-advancedoptions-x12)" : X12AdvancedOptions
}
```

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

```
  [X12](#cfn-b2bi-transformer-advancedoptions-x12): 
    X12AdvancedOptions
```

## Properties
<a name="aws-properties-b2bi-transformer-advancedoptions-properties"></a>

`X12`  <a name="cfn-b2bi-transformer-advancedoptions-x12"></a>
A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files.  
*Required*: No  
*Type*: [X12AdvancedOptions](aws-properties-b2bi-transformer-x12advancedoptions.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::Transformer FormatOptions
<a name="aws-properties-b2bi-transformer-formatoptions"></a>

A structure that contains the X12 transaction set and version.

## Syntax
<a name="aws-properties-b2bi-transformer-formatoptions-syntax"></a>

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

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

```
{
  "[X12](#cfn-b2bi-transformer-formatoptions-x12)" : X12Details
}
```

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

```
  [X12](#cfn-b2bi-transformer-formatoptions-x12): 
    X12Details
```

## Properties
<a name="aws-properties-b2bi-transformer-formatoptions-properties"></a>

`X12`  <a name="cfn-b2bi-transformer-formatoptions-x12"></a>
Property description not available.  
*Required*: Yes  
*Type*: [X12Details](aws-properties-b2bi-transformer-x12details.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::Transformer InputConversion
<a name="aws-properties-b2bi-transformer-inputconversion"></a>

Contains the input formatting options for an inbound transformer (takes an X12-formatted EDI document as input and converts it to JSON or XML.

## Syntax
<a name="aws-properties-b2bi-transformer-inputconversion-syntax"></a>

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

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

```
{
  "[AdvancedOptions](#cfn-b2bi-transformer-inputconversion-advancedoptions)" : AdvancedOptions,
  "[FormatOptions](#cfn-b2bi-transformer-inputconversion-formatoptions)" : FormatOptions,
  "[FromFormat](#cfn-b2bi-transformer-inputconversion-fromformat)" : String
}
```

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

```
  [AdvancedOptions](#cfn-b2bi-transformer-inputconversion-advancedoptions): 
    AdvancedOptions
  [FormatOptions](#cfn-b2bi-transformer-inputconversion-formatoptions): 
    FormatOptions
  [FromFormat](#cfn-b2bi-transformer-inputconversion-fromformat): String
```

## Properties
<a name="aws-properties-b2bi-transformer-inputconversion-properties"></a>

`AdvancedOptions`  <a name="cfn-b2bi-transformer-inputconversion-advancedoptions"></a>
Specifies advanced options for the input conversion process. These options provide additional control over how EDI files are processed during transformation.  
*Required*: No  
*Type*: [AdvancedOptions](aws-properties-b2bi-transformer-advancedoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FormatOptions`  <a name="cfn-b2bi-transformer-inputconversion-formatoptions"></a>
A structure that contains the formatting options for an inbound transformer.  
*Required*: No  
*Type*: [FormatOptions](aws-properties-b2bi-transformer-formatoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FromFormat`  <a name="cfn-b2bi-transformer-inputconversion-fromformat"></a>
The format for the transformer input: currently on `X12` is supported.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `X12`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Transformer Mapping
<a name="aws-properties-b2bi-transformer-mapping"></a>

Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

## Syntax
<a name="aws-properties-b2bi-transformer-mapping-syntax"></a>

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

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

```
{
  "[Template](#cfn-b2bi-transformer-mapping-template)" : String,
  "[TemplateLanguage](#cfn-b2bi-transformer-mapping-templatelanguage)" : String
}
```

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

```
  [Template](#cfn-b2bi-transformer-mapping-template): String
  [TemplateLanguage](#cfn-b2bi-transformer-mapping-templatelanguage): String
```

## Properties
<a name="aws-properties-b2bi-transformer-mapping-properties"></a>

`Template`  <a name="cfn-b2bi-transformer-mapping-template"></a>
A string that represents the mapping template, in the transformation language specified in `templateLanguage`.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `350000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TemplateLanguage`  <a name="cfn-b2bi-transformer-mapping-templatelanguage"></a>
The transformation language for the template, either XSLT or JSONATA.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `XSLT | JSONATA`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Transformer OutputConversion
<a name="aws-properties-b2bi-transformer-outputconversion"></a>

Contains the formatting options for an outbound transformer (takes JSON or XML as input and converts it to an EDI document (currently only X12 format is supported).

## Syntax
<a name="aws-properties-b2bi-transformer-outputconversion-syntax"></a>

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

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

```
{
  "[AdvancedOptions](#cfn-b2bi-transformer-outputconversion-advancedoptions)" : AdvancedOptions,
  "[FormatOptions](#cfn-b2bi-transformer-outputconversion-formatoptions)" : FormatOptions,
  "[ToFormat](#cfn-b2bi-transformer-outputconversion-toformat)" : String
}
```

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

```
  [AdvancedOptions](#cfn-b2bi-transformer-outputconversion-advancedoptions): 
    AdvancedOptions
  [FormatOptions](#cfn-b2bi-transformer-outputconversion-formatoptions): 
    FormatOptions
  [ToFormat](#cfn-b2bi-transformer-outputconversion-toformat): String
```

## Properties
<a name="aws-properties-b2bi-transformer-outputconversion-properties"></a>

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

`FormatOptions`  <a name="cfn-b2bi-transformer-outputconversion-formatoptions"></a>
A structure that contains the X12 transaction set and version for the transformer output.  
*Required*: No  
*Type*: [FormatOptions](aws-properties-b2bi-transformer-formatoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ToFormat`  <a name="cfn-b2bi-transformer-outputconversion-toformat"></a>
The format for the output from an outbound transformer: only X12 is currently supported.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `X12`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Transformer SampleDocumentKeys
<a name="aws-properties-b2bi-transformer-sampledocumentkeys"></a>

An array of the Amazon S3 keys used to identify the location for your sample documents.

## Syntax
<a name="aws-properties-b2bi-transformer-sampledocumentkeys-syntax"></a>

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

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

```
{
  "[Input](#cfn-b2bi-transformer-sampledocumentkeys-input)" : String,
  "[Output](#cfn-b2bi-transformer-sampledocumentkeys-output)" : String
}
```

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

```
  [Input](#cfn-b2bi-transformer-sampledocumentkeys-input): String
  [Output](#cfn-b2bi-transformer-sampledocumentkeys-output): String
```

## Properties
<a name="aws-properties-b2bi-transformer-sampledocumentkeys-properties"></a>

`Input`  <a name="cfn-b2bi-transformer-sampledocumentkeys-input"></a>
An array of keys for your input sample documents.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Output`  <a name="cfn-b2bi-transformer-sampledocumentkeys-output"></a>
An array of keys for your output sample documents.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Transformer SampleDocuments
<a name="aws-properties-b2bi-transformer-sampledocuments"></a>

Describes a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

## Syntax
<a name="aws-properties-b2bi-transformer-sampledocuments-syntax"></a>

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

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

```
{
  "[BucketName](#cfn-b2bi-transformer-sampledocuments-bucketname)" : String,
  "[Keys](#cfn-b2bi-transformer-sampledocuments-keys)" : [ SampleDocumentKeys, ... ]
}
```

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

```
  [BucketName](#cfn-b2bi-transformer-sampledocuments-bucketname): String
  [Keys](#cfn-b2bi-transformer-sampledocuments-keys): 
    - SampleDocumentKeys
```

## Properties
<a name="aws-properties-b2bi-transformer-sampledocuments-properties"></a>

`BucketName`  <a name="cfn-b2bi-transformer-sampledocuments-bucketname"></a>
Contains the Amazon S3 bucket that is used to hold your sample documents.  
*Required*: Yes  
*Type*: String  
*Minimum*: `3`  
*Maximum*: `63`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Keys`  <a name="cfn-b2bi-transformer-sampledocuments-keys"></a>
Contains an array of the Amazon S3 keys used to identify the location for your sample documents.  
*Required*: Yes  
*Type*: Array of [SampleDocumentKeys](aws-properties-b2bi-transformer-sampledocumentkeys.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::Transformer Tag
<a name="aws-properties-b2bi-transformer-tag"></a>

A key-value pair for a specific transformer. Tags are metadata that you can use to search for and group capabilities for various purposes.

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

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

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

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

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

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

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

`Key`  <a name="cfn-b2bi-transformer-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-transformer-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::Transformer X12AdvancedOptions
<a name="aws-properties-b2bi-transformer-x12advancedoptions"></a>

Contains advanced options specific to X12 EDI processing, such as splitting large X12 files into smaller units.

## Syntax
<a name="aws-properties-b2bi-transformer-x12advancedoptions-syntax"></a>

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

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

```
{
  "[SplitOptions](#cfn-b2bi-transformer-x12advancedoptions-splitoptions)" : X12SplitOptions,
  "[ValidationOptions](#cfn-b2bi-transformer-x12advancedoptions-validationoptions)" : X12ValidationOptions
}
```

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

```
  [SplitOptions](#cfn-b2bi-transformer-x12advancedoptions-splitoptions): 
    X12SplitOptions
  [ValidationOptions](#cfn-b2bi-transformer-x12advancedoptions-validationoptions): 
    X12ValidationOptions
```

## Properties
<a name="aws-properties-b2bi-transformer-x12advancedoptions-properties"></a>

`SplitOptions`  <a name="cfn-b2bi-transformer-x12advancedoptions-splitoptions"></a>
Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units.  
*Required*: No  
*Type*: [X12SplitOptions](aws-properties-b2bi-transformer-x12splitoptions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ValidationOptions`  <a name="cfn-b2bi-transformer-x12advancedoptions-validationoptions"></a>
Specifies validation options for X12 EDI processing. These options control how validation rules are applied during EDI document processing, including custom validation rules for element length constraints, code list validations, and element requirement checks.  
*Required*: No  
*Type*: [X12ValidationOptions](aws-properties-b2bi-transformer-x12validationoptions.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::Transformer X12CodeListValidationRule
<a name="aws-properties-b2bi-transformer-x12codelistvalidationrule"></a>

Code list validation rule configuration.

## Syntax
<a name="aws-properties-b2bi-transformer-x12codelistvalidationrule-syntax"></a>

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

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

```
{
  "[CodesToAdd](#cfn-b2bi-transformer-x12codelistvalidationrule-codestoadd)" : [ String, ... ],
  "[CodesToRemove](#cfn-b2bi-transformer-x12codelistvalidationrule-codestoremove)" : [ String, ... ],
  "[ElementId](#cfn-b2bi-transformer-x12codelistvalidationrule-elementid)" : String
}
```

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

```
  [CodesToAdd](#cfn-b2bi-transformer-x12codelistvalidationrule-codestoadd): 
    - String
  [CodesToRemove](#cfn-b2bi-transformer-x12codelistvalidationrule-codestoremove): 
    - String
  [ElementId](#cfn-b2bi-transformer-x12codelistvalidationrule-elementid): String
```

## Properties
<a name="aws-properties-b2bi-transformer-x12codelistvalidationrule-properties"></a>

`CodesToAdd`  <a name="cfn-b2bi-transformer-x12codelistvalidationrule-codestoadd"></a>
Specifies a list of code values to add to the element's allowed values. These codes will be considered valid for the specified element in addition to the standard codes defined by the X12 specification.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CodesToRemove`  <a name="cfn-b2bi-transformer-x12codelistvalidationrule-codestoremove"></a>
Specifies a list of code values to remove from the element's allowed values. These codes will be considered invalid for the specified element, even if they are part of the standard codes defined by the X12 specification.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ElementId`  <a name="cfn-b2bi-transformer-x12codelistvalidationrule-elementid"></a>
Specifies the four-digit element ID to which the code list modifications apply. This identifies which X12 element will have its allowed code values modified.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[0-9]{4}$`  
*Minimum*: `4`  
*Maximum*: `4`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Transformer X12Details
<a name="aws-properties-b2bi-transformer-x12details"></a>

A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.

**Note**  
If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.

## Syntax
<a name="aws-properties-b2bi-transformer-x12details-syntax"></a>

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

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

```
{
  "[TransactionSet](#cfn-b2bi-transformer-x12details-transactionset)" : String,
  "[Version](#cfn-b2bi-transformer-x12details-version)" : String
}
```

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

```
  [TransactionSet](#cfn-b2bi-transformer-x12details-transactionset): String
  [Version](#cfn-b2bi-transformer-x12details-version): String
```

## Properties
<a name="aws-properties-b2bi-transformer-x12details-properties"></a>

`TransactionSet`  <a name="cfn-b2bi-transformer-x12details-transactionset"></a>
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.  
*Required*: No  
*Type*: String  
*Allowed values*: `X12_100 | X12_101 | X12_102 | X12_103 | X12_104 | X12_105 | X12_106 | X12_107 | X12_108 | X12_109 | X12_110 | X12_111 | X12_112 | X12_113 | X12_120 | X12_121 | X12_124 | X12_125 | X12_126 | X12_127 | X12_128 | X12_129 | X12_130 | X12_131 | X12_132 | X12_133 | X12_135 | X12_138 | X12_139 | X12_140 | X12_141 | X12_142 | X12_143 | X12_144 | X12_146 | X12_147 | X12_148 | X12_149 | X12_150 | X12_151 | X12_152 | X12_153 | X12_154 | X12_155 | X12_157 | X12_158 | X12_159 | X12_160 | X12_161 | X12_163 | X12_170 | X12_175 | X12_176 | X12_179 | X12_180 | X12_185 | X12_186 | X12_187 | X12_188 | X12_189 | X12_190 | X12_191 | X12_194 | X12_195 | X12_196 | X12_197 | X12_198 | X12_199 | X12_200 | X12_201 | X12_202 | X12_203 | X12_204 | X12_205 | X12_206 | X12_210 | X12_211 | X12_212 | X12_213 | X12_214 | X12_215 | X12_216 | X12_217 | X12_218 | X12_219 | X12_220 | X12_222 | X12_223 | X12_224 | X12_225 | X12_227 | X12_228 | X12_240 | X12_242 | X12_244 | X12_245 | X12_248 | X12_249 | X12_250 | X12_251 | X12_252 | X12_255 | X12_256 | X12_259 | X12_260 | X12_261 | X12_262 | X12_263 | X12_264 | X12_265 | X12_266 | X12_267 | X12_268 | X12_269 | X12_270 | X12_271 | X12_272 | X12_273 | X12_274 | X12_275 | X12_276 | X12_277 | X12_278 | X12_280 | X12_283 | X12_284 | X12_285 | X12_286 | X12_288 | X12_290 | X12_300 | X12_301 | X12_303 | X12_304 | X12_309 | X12_310 | X12_311 | X12_312 | X12_313 | X12_315 | X12_317 | X12_319 | X12_322 | X12_323 | X12_324 | X12_325 | X12_326 | X12_350 | X12_352 | X12_353 | X12_354 | X12_355 | X12_356 | X12_357 | X12_358 | X12_361 | X12_362 | X12_404 | X12_410 | X12_412 | X12_414 | X12_417 | X12_418 | X12_419 | X12_420 | X12_421 | X12_422 | X12_423 | X12_424 | X12_425 | X12_426 | X12_429 | X12_431 | X12_432 | X12_433 | X12_434 | X12_435 | X12_436 | X12_437 | X12_440 | X12_451 | X12_452 | X12_453 | X12_455 | X12_456 | X12_460 | X12_463 | X12_466 | X12_468 | X12_470 | X12_475 | X12_485 | X12_486 | X12_490 | X12_492 | X12_494 | X12_500 | X12_501 | X12_503 | X12_504 | X12_511 | X12_517 | X12_521 | X12_527 | X12_536 | X12_540 | X12_561 | X12_567 | X12_568 | X12_601 | X12_602 | X12_620 | X12_625 | X12_650 | X12_715 | X12_753 | X12_754 | X12_805 | X12_806 | X12_810 | X12_811 | X12_812 | X12_813 | X12_814 | X12_815 | X12_816 | X12_818 | X12_819 | X12_820 | X12_821 | X12_822 | X12_823 | X12_824 | X12_826 | X12_827 | X12_828 | X12_829 | X12_830 | X12_831 | X12_832 | X12_833 | X12_834 | X12_835 | X12_836 | X12_837 | X12_838 | X12_839 | X12_840 | X12_841 | X12_842 | X12_843 | X12_844 | X12_845 | X12_846 | X12_847 | X12_848 | X12_849 | X12_850 | X12_851 | X12_852 | X12_853 | X12_854 | X12_855 | X12_856 | X12_857 | X12_858 | X12_859 | X12_860 | X12_861 | X12_862 | X12_863 | X12_864 | X12_865 | X12_866 | X12_867 | X12_868 | X12_869 | X12_870 | X12_871 | X12_872 | X12_873 | X12_874 | X12_875 | X12_876 | X12_877 | X12_878 | X12_879 | X12_880 | X12_881 | X12_882 | X12_883 | X12_884 | X12_885 | X12_886 | X12_887 | X12_888 | X12_889 | X12_891 | X12_893 | X12_894 | X12_895 | X12_896 | X12_920 | X12_924 | X12_925 | X12_926 | X12_928 | X12_940 | X12_943 | X12_944 | X12_945 | X12_947 | X12_980 | X12_990 | X12_993 | X12_996 | X12_997 | X12_998 | X12_999 | X12_270_X279 | X12_271_X279 | X12_275_X210 | X12_275_X211 | X12_276_X212 | X12_277_X212 | X12_277_X214 | X12_277_X364 | X12_278_X217 | X12_820_X218 | X12_820_X306 | X12_824_X186 | X12_834_X220 | X12_834_X307 | X12_834_X318 | X12_835_X221 | X12_837_X222 | X12_837_X223 | X12_837_X224 | X12_837_X291 | X12_837_X292 | X12_837_X298 | X12_999_X231`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Version`  <a name="cfn-b2bi-transformer-x12details-version"></a>
Returns the version to use for the specified X12 transaction set.  
*Required*: No  
*Type*: String  
*Allowed values*: `VERSION_4010 | VERSION_4030 | VERSION_4050 | VERSION_4060 | VERSION_5010 | VERSION_5010_HIPAA`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Transformer X12ElementLengthValidationRule
<a name="aws-properties-b2bi-transformer-x12elementlengthvalidationrule"></a>

Defines a validation rule that specifies custom length constraints for a specific X12 element. This rule allows you to override the standard minimum and maximum length requirements for an element, enabling validation of trading partner-specific length requirements that may differ from the X12 specification. Both minimum and maximum length values must be specified.

## Syntax
<a name="aws-properties-b2bi-transformer-x12elementlengthvalidationrule-syntax"></a>

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

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

```
{
  "[ElementId](#cfn-b2bi-transformer-x12elementlengthvalidationrule-elementid)" : String,
  "[MaxLength](#cfn-b2bi-transformer-x12elementlengthvalidationrule-maxlength)" : Number,
  "[MinLength](#cfn-b2bi-transformer-x12elementlengthvalidationrule-minlength)" : Number
}
```

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

```
  [ElementId](#cfn-b2bi-transformer-x12elementlengthvalidationrule-elementid): String
  [MaxLength](#cfn-b2bi-transformer-x12elementlengthvalidationrule-maxlength): Number
  [MinLength](#cfn-b2bi-transformer-x12elementlengthvalidationrule-minlength): Number
```

## Properties
<a name="aws-properties-b2bi-transformer-x12elementlengthvalidationrule-properties"></a>

`ElementId`  <a name="cfn-b2bi-transformer-x12elementlengthvalidationrule-elementid"></a>
Specifies the four-digit element ID to which the length constraints will be applied. This identifies which X12 element will have its length requirements modified.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[0-9]{4}$`  
*Minimum*: `4`  
*Maximum*: `4`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxLength`  <a name="cfn-b2bi-transformer-x12elementlengthvalidationrule-maxlength"></a>
Specifies the maximum allowed length for the identified element. This value defines the upper limit for the element's content length.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `1000000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinLength`  <a name="cfn-b2bi-transformer-x12elementlengthvalidationrule-minlength"></a>
Specifies the minimum required length for the identified element. This value defines the lower limit for the element's content length.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `1000000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Transformer X12ElementRequirementValidationRule
<a name="aws-properties-b2bi-transformer-x12elementrequirementvalidationrule"></a>

Defines a validation rule that modifies the requirement status of a specific X12 element within a segment. This rule allows you to make optional elements mandatory or mandatory elements optional, providing flexibility to accommodate different trading partner requirements and business rules. The rule targets a specific element position within a segment and sets its requirement status to either OPTIONAL or MANDATORY.

## Syntax
<a name="aws-properties-b2bi-transformer-x12elementrequirementvalidationrule-syntax"></a>

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

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

```
{
  "[ElementPosition](#cfn-b2bi-transformer-x12elementrequirementvalidationrule-elementposition)" : String,
  "[Requirement](#cfn-b2bi-transformer-x12elementrequirementvalidationrule-requirement)" : String
}
```

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

```
  [ElementPosition](#cfn-b2bi-transformer-x12elementrequirementvalidationrule-elementposition): String
  [Requirement](#cfn-b2bi-transformer-x12elementrequirementvalidationrule-requirement): String
```

## Properties
<a name="aws-properties-b2bi-transformer-x12elementrequirementvalidationrule-properties"></a>

`ElementPosition`  <a name="cfn-b2bi-transformer-x12elementrequirementvalidationrule-elementposition"></a>
Specifies the position of the element within an X12 segment for which the requirement status will be modified. The format follows the pattern of segment identifier followed by element position (e.g., "ST-01" for the first element of the ST segment).  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9]+(?:-\d{2})(?:-\d{2})?$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Requirement`  <a name="cfn-b2bi-transformer-x12elementrequirementvalidationrule-requirement"></a>
Specifies the requirement status for the element at the specified position. Valid values are OPTIONAL (the element may be omitted) or MANDATORY (the element must be present).  
*Required*: Yes  
*Type*: String  
*Allowed values*: `OPTIONAL | MANDATORY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Transformer X12SplitOptions
<a name="aws-properties-b2bi-transformer-x12splitoptions"></a>

Contains options for splitting X12 EDI files into smaller units. This is useful for processing large EDI files more efficiently.

## Syntax
<a name="aws-properties-b2bi-transformer-x12splitoptions-syntax"></a>

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

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

```
{
  "[SplitBy](#cfn-b2bi-transformer-x12splitoptions-splitby)" : String
}
```

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

```
  [SplitBy](#cfn-b2bi-transformer-x12splitoptions-splitby): String
```

## Properties
<a name="aws-properties-b2bi-transformer-x12splitoptions-properties"></a>

`SplitBy`  <a name="cfn-b2bi-transformer-x12splitoptions-splitby"></a>
Specifies the method used to split X12 EDI files. Valid values include `TRANSACTION` (split by individual transaction sets), or `NONE` (no splitting).  
*Required*: No  
*Type*: String  
*Allowed values*: `NONE | TRANSACTION`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::B2BI::Transformer X12ValidationOptions
<a name="aws-properties-b2bi-transformer-x12validationoptions"></a>

Contains configuration options for X12 EDI validation. This structure allows you to specify custom validation rules that will be applied during EDI document processing, including element length constraints, code list modifications, and element requirement changes. These validation options provide flexibility to accommodate trading partner-specific requirements while maintaining EDI compliance. The validation rules are applied in addition to standard X12 validation to ensure documents meet both standard and custom requirements.

## Syntax
<a name="aws-properties-b2bi-transformer-x12validationoptions-syntax"></a>

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

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

```
{
  "[ValidationRules](#cfn-b2bi-transformer-x12validationoptions-validationrules)" : [ X12ValidationRule, ... ]
}
```

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

```
  [ValidationRules](#cfn-b2bi-transformer-x12validationoptions-validationrules): 
    - X12ValidationRule
```

## Properties
<a name="aws-properties-b2bi-transformer-x12validationoptions-properties"></a>

`ValidationRules`  <a name="cfn-b2bi-transformer-x12validationoptions-validationrules"></a>
Specifies a list of validation rules to apply during EDI document processing. These rules can include code list modifications, element length constraints, and element requirement changes.  
*Required*: No  
*Type*: Array of [X12ValidationRule](aws-properties-b2bi-transformer-x12validationrule.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::Transformer X12ValidationRule
<a name="aws-properties-b2bi-transformer-x12validationrule"></a>

Represents a single validation rule that can be applied during X12 EDI processing. This is a union type that can contain one of several specific validation rule types: code list validation rules for modifying allowed element codes, element length validation rules for enforcing custom length constraints, or element requirement validation rules for changing mandatory/optional status. Each validation rule targets specific aspects of EDI document validation to ensure compliance with trading partner requirements and business rules.

## Syntax
<a name="aws-properties-b2bi-transformer-x12validationrule-syntax"></a>

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

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

```
{
  "[CodeListValidationRule](#cfn-b2bi-transformer-x12validationrule-codelistvalidationrule)" : X12CodeListValidationRule,
  "[ElementLengthValidationRule](#cfn-b2bi-transformer-x12validationrule-elementlengthvalidationrule)" : X12ElementLengthValidationRule,
  "[ElementRequirementValidationRule](#cfn-b2bi-transformer-x12validationrule-elementrequirementvalidationrule)" : X12ElementRequirementValidationRule
}
```

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

```
  [CodeListValidationRule](#cfn-b2bi-transformer-x12validationrule-codelistvalidationrule): 
    X12CodeListValidationRule
  [ElementLengthValidationRule](#cfn-b2bi-transformer-x12validationrule-elementlengthvalidationrule): 
    X12ElementLengthValidationRule
  [ElementRequirementValidationRule](#cfn-b2bi-transformer-x12validationrule-elementrequirementvalidationrule): 
    X12ElementRequirementValidationRule
```

## Properties
<a name="aws-properties-b2bi-transformer-x12validationrule-properties"></a>

`CodeListValidationRule`  <a name="cfn-b2bi-transformer-x12validationrule-codelistvalidationrule"></a>
Specifies a code list validation rule that modifies the allowed code values for a specific X12 element. This rule enables you to customize which codes are considered valid for an element, allowing for trading partner-specific code requirements.  
*Required*: No  
*Type*: [X12CodeListValidationRule](aws-properties-b2bi-transformer-x12codelistvalidationrule.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ElementLengthValidationRule`  <a name="cfn-b2bi-transformer-x12validationrule-elementlengthvalidationrule"></a>
Specifies an element length validation rule that defines custom length constraints for a specific X12 element. This rule allows you to enforce minimum and maximum length requirements that may differ from the standard X12 specification.  
*Required*: No  
*Type*: [X12ElementLengthValidationRule](aws-properties-b2bi-transformer-x12elementlengthvalidationrule.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ElementRequirementValidationRule`  <a name="cfn-b2bi-transformer-x12validationrule-elementrequirementvalidationrule"></a>
Specifies an element requirement validation rule that modifies whether a specific X12 element is required or optional within a segment. This rule provides flexibility to accommodate different trading partner requirements for element presence.  
*Required*: No  
*Type*: [X12ElementRequirementValidationRule](aws-properties-b2bi-transformer-x12elementrequirementvalidationrule.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)