Skip to content

Type definitions#

Index > B2BI > Type definitions

Auto-generated documentation for B2BI type annotations stubs module types-boto3-b2bi.

CapabilitySummaryTypeDef#

# CapabilitySummaryTypeDef definition

class CapabilitySummaryTypeDef(TypedDict):
    capabilityId: str,
    name: str,
    type: CapabilityTypeType,  # (1)
    createdAt: datetime,
    modifiedAt: NotRequired[datetime],
  1. See CapabilityTypeType

InputFileSourceTypeDef#

# InputFileSourceTypeDef definition

class InputFileSourceTypeDef(TypedDict):
    fileContent: NotRequired[str],

X12DetailsTypeDef#

# X12DetailsTypeDef definition

class X12DetailsTypeDef(TypedDict):
    transactionSet: NotRequired[X12TransactionSetType],  # (1)
    version: NotRequired[X12VersionType],  # (2)
  1. See X12TransactionSetType
  2. See X12VersionType

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    bucketName: NotRequired[str],
    key: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

MappingTypeDef#

# MappingTypeDef definition

class MappingTypeDef(TypedDict):
    templateLanguage: MappingTemplateLanguageType,  # (1)
    template: NotRequired[str],
  1. See MappingTemplateLanguageType

DeleteCapabilityRequestRequestTypeDef#

# DeleteCapabilityRequestRequestTypeDef definition

class DeleteCapabilityRequestRequestTypeDef(TypedDict):
    capabilityId: str,

DeletePartnershipRequestRequestTypeDef#

# DeletePartnershipRequestRequestTypeDef definition

class DeletePartnershipRequestRequestTypeDef(TypedDict):
    partnershipId: str,

DeleteProfileRequestRequestTypeDef#

# DeleteProfileRequestRequestTypeDef definition

class DeleteProfileRequestRequestTypeDef(TypedDict):
    profileId: str,

DeleteTransformerRequestRequestTypeDef#

# DeleteTransformerRequestRequestTypeDef definition

class DeleteTransformerRequestRequestTypeDef(TypedDict):
    transformerId: str,

GenerateMappingRequestRequestTypeDef#

# GenerateMappingRequestRequestTypeDef definition

class GenerateMappingRequestRequestTypeDef(TypedDict):
    inputFileContent: str,
    outputFileContent: str,
    mappingType: MappingTypeType,  # (1)
  1. See MappingTypeType

GetCapabilityRequestRequestTypeDef#

# GetCapabilityRequestRequestTypeDef definition

class GetCapabilityRequestRequestTypeDef(TypedDict):
    capabilityId: str,

GetPartnershipRequestRequestTypeDef#

# GetPartnershipRequestRequestTypeDef definition

class GetPartnershipRequestRequestTypeDef(TypedDict):
    partnershipId: str,

GetProfileRequestRequestTypeDef#

# GetProfileRequestRequestTypeDef definition

class GetProfileRequestRequestTypeDef(TypedDict):
    profileId: str,

GetTransformerJobRequestRequestTypeDef#

# GetTransformerJobRequestRequestTypeDef definition

class GetTransformerJobRequestRequestTypeDef(TypedDict):
    transformerJobId: str,
    transformerId: str,

GetTransformerRequestRequestTypeDef#

# GetTransformerRequestRequestTypeDef definition

class GetTransformerRequestRequestTypeDef(TypedDict):
    transformerId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListCapabilitiesRequestRequestTypeDef#

# ListCapabilitiesRequestRequestTypeDef definition

class ListCapabilitiesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListPartnershipsRequestRequestTypeDef#

# ListPartnershipsRequestRequestTypeDef definition

class ListPartnershipsRequestRequestTypeDef(TypedDict):
    profileId: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListProfilesRequestRequestTypeDef#

# ListProfilesRequestRequestTypeDef definition

class ListProfilesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ProfileSummaryTypeDef#

# ProfileSummaryTypeDef definition

class ProfileSummaryTypeDef(TypedDict):
    profileId: str,
    name: str,
    businessName: str,
    createdAt: datetime,
    logging: NotRequired[LoggingType],  # (1)
    logGroupName: NotRequired[str],
    modifiedAt: NotRequired[datetime],
  1. See LoggingType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

ListTransformersRequestRequestTypeDef#

# ListTransformersRequestRequestTypeDef definition

class ListTransformersRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

SampleDocumentKeysTypeDef#

# SampleDocumentKeysTypeDef definition

class SampleDocumentKeysTypeDef(TypedDict):
    input: NotRequired[str],
    output: NotRequired[str],

TestMappingRequestRequestTypeDef#

# TestMappingRequestRequestTypeDef definition

class TestMappingRequestRequestTypeDef(TypedDict):
    inputFileContent: str,
    mappingTemplate: str,
    fileFormat: FileFormatType,  # (1)
  1. See FileFormatType

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateProfileRequestRequestTypeDef#

# UpdateProfileRequestRequestTypeDef definition

class UpdateProfileRequestRequestTypeDef(TypedDict):
    profileId: str,
    name: NotRequired[str],
    email: NotRequired[str],
    phone: NotRequired[str],
    businessName: NotRequired[str],

X12DelimitersTypeDef#

# X12DelimitersTypeDef definition

class X12DelimitersTypeDef(TypedDict):
    componentSeparator: NotRequired[str],
    dataElementSeparator: NotRequired[str],
    segmentTerminator: NotRequired[str],

X12FunctionalGroupHeadersTypeDef#

# X12FunctionalGroupHeadersTypeDef definition

class X12FunctionalGroupHeadersTypeDef(TypedDict):
    applicationSenderCode: NotRequired[str],
    applicationReceiverCode: NotRequired[str],
    responsibleAgencyCode: NotRequired[str],

X12InterchangeControlHeadersTypeDef#

# X12InterchangeControlHeadersTypeDef definition

class X12InterchangeControlHeadersTypeDef(TypedDict):
    senderIdQualifier: NotRequired[str],
    senderId: NotRequired[str],
    receiverIdQualifier: NotRequired[str],
    receiverId: NotRequired[str],
    repetitionSeparator: NotRequired[str],
    acknowledgmentRequestedCode: NotRequired[str],
    usageIndicatorCode: NotRequired[str],

ConversionSourceTypeDef#

# ConversionSourceTypeDef definition

class ConversionSourceTypeDef(TypedDict):
    fileFormat: ConversionSourceFormatType,  # (1)
    inputFile: InputFileSourceTypeDef,  # (2)
  1. See ConversionSourceFormatType
  2. See InputFileSourceTypeDef

ConversionTargetFormatDetailsTypeDef#

# ConversionTargetFormatDetailsTypeDef definition

class ConversionTargetFormatDetailsTypeDef(TypedDict):
    x12: NotRequired[X12DetailsTypeDef],  # (1)
  1. See X12DetailsTypeDef

EdiTypeTypeDef#

# EdiTypeTypeDef definition

class EdiTypeTypeDef(TypedDict):
    x12Details: NotRequired[X12DetailsTypeDef],  # (1)
  1. See X12DetailsTypeDef

FormatOptionsTypeDef#

# FormatOptionsTypeDef definition

class FormatOptionsTypeDef(TypedDict):
    x12: NotRequired[X12DetailsTypeDef],  # (1)
  1. See X12DetailsTypeDef

TemplateDetailsTypeDef#

# TemplateDetailsTypeDef definition

class TemplateDetailsTypeDef(TypedDict):
    x12: NotRequired[X12DetailsTypeDef],  # (1)
  1. See X12DetailsTypeDef

OutputSampleFileSourceTypeDef#

# OutputSampleFileSourceTypeDef definition

class OutputSampleFileSourceTypeDef(TypedDict):
    fileLocation: NotRequired[S3LocationTypeDef],  # (1)
  1. See S3LocationTypeDef

StartTransformerJobRequestRequestTypeDef#

# StartTransformerJobRequestRequestTypeDef definition

class StartTransformerJobRequestRequestTypeDef(TypedDict):
    inputFile: S3LocationTypeDef,  # (1)
    outputLocation: S3LocationTypeDef,  # (1)
    transformerId: str,
    clientToken: NotRequired[str],
  1. See S3LocationTypeDef
  2. See S3LocationTypeDef

CreateProfileRequestRequestTypeDef#

# CreateProfileRequestRequestTypeDef definition

class CreateProfileRequestRequestTypeDef(TypedDict):
    name: str,
    phone: str,
    businessName: str,
    logging: LoggingType,  # (1)
    email: NotRequired[str],
    clientToken: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See LoggingType
  2. See TagTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateProfileResponseTypeDef#

# CreateProfileResponseTypeDef definition

class CreateProfileResponseTypeDef(TypedDict):
    profileId: str,
    profileArn: str,
    name: str,
    businessName: str,
    phone: str,
    email: str,
    logging: LoggingType,  # (1)
    logGroupName: str,
    createdAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoggingType
  2. See ResponseMetadataTypeDef

CreateStarterMappingTemplateResponseTypeDef#

# CreateStarterMappingTemplateResponseTypeDef definition

class CreateStarterMappingTemplateResponseTypeDef(TypedDict):
    mappingTemplate: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GenerateMappingResponseTypeDef#

# GenerateMappingResponseTypeDef definition

class GenerateMappingResponseTypeDef(TypedDict):
    mappingTemplate: str,
    mappingAccuracy: float,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetProfileResponseTypeDef#

# GetProfileResponseTypeDef definition

class GetProfileResponseTypeDef(TypedDict):
    profileId: str,
    profileArn: str,
    name: str,
    email: str,
    phone: str,
    businessName: str,
    logging: LoggingType,  # (1)
    logGroupName: str,
    createdAt: datetime,
    modifiedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoggingType
  2. See ResponseMetadataTypeDef

GetTransformerJobResponseTypeDef#

# GetTransformerJobResponseTypeDef definition

class GetTransformerJobResponseTypeDef(TypedDict):
    status: TransformerJobStatusType,  # (1)
    outputFiles: list[S3LocationTypeDef],  # (2)
    message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See TransformerJobStatusType
  2. See S3LocationTypeDef
  3. See ResponseMetadataTypeDef

ListCapabilitiesResponseTypeDef#

# ListCapabilitiesResponseTypeDef definition

class ListCapabilitiesResponseTypeDef(TypedDict):
    capabilities: list[CapabilitySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See CapabilitySummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

StartTransformerJobResponseTypeDef#

# StartTransformerJobResponseTypeDef definition

class StartTransformerJobResponseTypeDef(TypedDict):
    transformerJobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TestConversionResponseTypeDef#

# TestConversionResponseTypeDef definition

class TestConversionResponseTypeDef(TypedDict):
    convertedFileContent: str,
    validationMessages: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TestMappingResponseTypeDef#

# TestMappingResponseTypeDef definition

class TestMappingResponseTypeDef(TypedDict):
    mappedFileContent: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TestParsingResponseTypeDef#

# TestParsingResponseTypeDef definition

class TestParsingResponseTypeDef(TypedDict):
    parsedFileContent: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateProfileResponseTypeDef#

# UpdateProfileResponseTypeDef definition

class UpdateProfileResponseTypeDef(TypedDict):
    profileId: str,
    profileArn: str,
    name: str,
    email: str,
    phone: str,
    businessName: str,
    logging: LoggingType,  # (1)
    logGroupName: str,
    createdAt: datetime,
    modifiedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoggingType
  2. See ResponseMetadataTypeDef

ListCapabilitiesRequestPaginateTypeDef#

# ListCapabilitiesRequestPaginateTypeDef definition

class ListCapabilitiesRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPartnershipsRequestPaginateTypeDef#

# ListPartnershipsRequestPaginateTypeDef definition

class ListPartnershipsRequestPaginateTypeDef(TypedDict):
    profileId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListProfilesRequestPaginateTypeDef#

# ListProfilesRequestPaginateTypeDef definition

class ListProfilesRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTransformersRequestPaginateTypeDef#

# ListTransformersRequestPaginateTypeDef definition

class ListTransformersRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListProfilesResponseTypeDef#

# ListProfilesResponseTypeDef definition

class ListProfilesResponseTypeDef(TypedDict):
    profiles: list[ProfileSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ProfileSummaryTypeDef
  2. See ResponseMetadataTypeDef

SampleDocumentsOutputTypeDef#

# SampleDocumentsOutputTypeDef definition

class SampleDocumentsOutputTypeDef(TypedDict):
    bucketName: str,
    keys: list[SampleDocumentKeysTypeDef],  # (1)
  1. See SampleDocumentKeysTypeDef

SampleDocumentsTypeDef#

# SampleDocumentsTypeDef definition

class SampleDocumentsTypeDef(TypedDict):
    bucketName: str,
    keys: Sequence[SampleDocumentKeysTypeDef],  # (1)
  1. See SampleDocumentKeysTypeDef

X12OutboundEdiHeadersTypeDef#

# X12OutboundEdiHeadersTypeDef definition

class X12OutboundEdiHeadersTypeDef(TypedDict):
    interchangeControlHeaders: NotRequired[X12InterchangeControlHeadersTypeDef],  # (1)
    functionalGroupHeaders: NotRequired[X12FunctionalGroupHeadersTypeDef],  # (2)
    delimiters: NotRequired[X12DelimitersTypeDef],  # (3)
    validateEdi: NotRequired[bool],
  1. See X12InterchangeControlHeadersTypeDef
  2. See X12FunctionalGroupHeadersTypeDef
  3. See X12DelimitersTypeDef

EdiConfigurationTypeDef#

# EdiConfigurationTypeDef definition

class EdiConfigurationTypeDef(TypedDict):
    type: EdiTypeTypeDef,  # (2)
    inputLocation: S3LocationTypeDef,  # (3)
    outputLocation: S3LocationTypeDef,  # (3)
    transformerId: str,
    capabilityDirection: NotRequired[CapabilityDirectionType],  # (1)
  1. See CapabilityDirectionType
  2. See EdiTypeTypeDef
  3. See S3LocationTypeDef
  4. See S3LocationTypeDef

TestParsingRequestRequestTypeDef#

# TestParsingRequestRequestTypeDef definition

class TestParsingRequestRequestTypeDef(TypedDict):
    inputFile: S3LocationTypeDef,  # (1)
    fileFormat: FileFormatType,  # (2)
    ediType: EdiTypeTypeDef,  # (3)
  1. See S3LocationTypeDef
  2. See FileFormatType
  3. See EdiTypeTypeDef

InputConversionTypeDef#

# InputConversionTypeDef definition

class InputConversionTypeDef(TypedDict):
    fromFormat: FromFormatType,  # (1)
    formatOptions: NotRequired[FormatOptionsTypeDef],  # (2)
  1. See FromFormatType
  2. See FormatOptionsTypeDef

OutputConversionTypeDef#

# OutputConversionTypeDef definition

class OutputConversionTypeDef(TypedDict):
    toFormat: ToFormatType,  # (1)
    formatOptions: NotRequired[FormatOptionsTypeDef],  # (2)
  1. See ToFormatType
  2. See FormatOptionsTypeDef

CreateStarterMappingTemplateRequestRequestTypeDef#

# CreateStarterMappingTemplateRequestRequestTypeDef definition

class CreateStarterMappingTemplateRequestRequestTypeDef(TypedDict):
    mappingType: MappingTypeType,  # (1)
    templateDetails: TemplateDetailsTypeDef,  # (2)
    outputSampleLocation: NotRequired[S3LocationTypeDef],  # (3)
  1. See MappingTypeType
  2. See TemplateDetailsTypeDef
  3. See S3LocationTypeDef

ConversionTargetTypeDef#

# ConversionTargetTypeDef definition

class ConversionTargetTypeDef(TypedDict):
    fileFormat: ConversionTargetFormatType,  # (1)
    formatDetails: NotRequired[ConversionTargetFormatDetailsTypeDef],  # (2)
    outputSampleFile: NotRequired[OutputSampleFileSourceTypeDef],  # (3)
  1. See ConversionTargetFormatType
  2. See ConversionTargetFormatDetailsTypeDef
  3. See OutputSampleFileSourceTypeDef

X12EnvelopeTypeDef#

# X12EnvelopeTypeDef definition

class X12EnvelopeTypeDef(TypedDict):
    common: NotRequired[X12OutboundEdiHeadersTypeDef],  # (1)
  1. See X12OutboundEdiHeadersTypeDef

CapabilityConfigurationTypeDef#

# CapabilityConfigurationTypeDef definition

class CapabilityConfigurationTypeDef(TypedDict):
    edi: NotRequired[EdiConfigurationTypeDef],  # (1)
  1. See EdiConfigurationTypeDef

CreateTransformerRequestRequestTypeDef#

# CreateTransformerRequestRequestTypeDef definition

class CreateTransformerRequestRequestTypeDef(TypedDict):
    name: str,
    clientToken: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    fileFormat: NotRequired[FileFormatType],  # (2)
    mappingTemplate: NotRequired[str],
    ediType: NotRequired[EdiTypeTypeDef],  # (3)
    sampleDocument: NotRequired[str],
    inputConversion: NotRequired[InputConversionTypeDef],  # (4)
    mapping: NotRequired[MappingTypeDef],  # (5)
    outputConversion: NotRequired[OutputConversionTypeDef],  # (6)
    sampleDocuments: NotRequired[SampleDocumentsTypeDef],  # (7)
  1. See TagTypeDef
  2. See FileFormatType
  3. See EdiTypeTypeDef
  4. See InputConversionTypeDef
  5. See MappingTypeDef
  6. See OutputConversionTypeDef
  7. See SampleDocumentsTypeDef

CreateTransformerResponseTypeDef#

# CreateTransformerResponseTypeDef definition

class CreateTransformerResponseTypeDef(TypedDict):
    transformerId: str,
    transformerArn: str,
    name: str,
    status: TransformerStatusType,  # (1)
    createdAt: datetime,
    fileFormat: FileFormatType,  # (2)
    mappingTemplate: str,
    ediType: EdiTypeTypeDef,  # (3)
    sampleDocument: str,
    inputConversion: InputConversionTypeDef,  # (4)
    mapping: MappingTypeDef,  # (5)
    outputConversion: OutputConversionTypeDef,  # (6)
    sampleDocuments: SampleDocumentsOutputTypeDef,  # (7)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)
  1. See TransformerStatusType
  2. See FileFormatType
  3. See EdiTypeTypeDef
  4. See InputConversionTypeDef
  5. See MappingTypeDef
  6. See OutputConversionTypeDef
  7. See SampleDocumentsOutputTypeDef
  8. See ResponseMetadataTypeDef

GetTransformerResponseTypeDef#

# GetTransformerResponseTypeDef definition

class GetTransformerResponseTypeDef(TypedDict):
    transformerId: str,
    transformerArn: str,
    name: str,
    status: TransformerStatusType,  # (1)
    createdAt: datetime,
    modifiedAt: datetime,
    fileFormat: FileFormatType,  # (2)
    mappingTemplate: str,
    ediType: EdiTypeTypeDef,  # (3)
    sampleDocument: str,
    inputConversion: InputConversionTypeDef,  # (4)
    mapping: MappingTypeDef,  # (5)
    outputConversion: OutputConversionTypeDef,  # (6)
    sampleDocuments: SampleDocumentsOutputTypeDef,  # (7)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)
  1. See TransformerStatusType
  2. See FileFormatType
  3. See EdiTypeTypeDef
  4. See InputConversionTypeDef
  5. See MappingTypeDef
  6. See OutputConversionTypeDef
  7. See SampleDocumentsOutputTypeDef
  8. See ResponseMetadataTypeDef

TransformerSummaryTypeDef#

# TransformerSummaryTypeDef definition

class TransformerSummaryTypeDef(TypedDict):
    transformerId: str,
    name: str,
    status: TransformerStatusType,  # (1)
    createdAt: datetime,
    modifiedAt: NotRequired[datetime],
    fileFormat: NotRequired[FileFormatType],  # (2)
    mappingTemplate: NotRequired[str],
    ediType: NotRequired[EdiTypeTypeDef],  # (3)
    sampleDocument: NotRequired[str],
    inputConversion: NotRequired[InputConversionTypeDef],  # (4)
    mapping: NotRequired[MappingTypeDef],  # (5)
    outputConversion: NotRequired[OutputConversionTypeDef],  # (6)
    sampleDocuments: NotRequired[SampleDocumentsOutputTypeDef],  # (7)
  1. See TransformerStatusType
  2. See FileFormatType
  3. See EdiTypeTypeDef
  4. See InputConversionTypeDef
  5. See MappingTypeDef
  6. See OutputConversionTypeDef
  7. See SampleDocumentsOutputTypeDef

UpdateTransformerRequestRequestTypeDef#

# UpdateTransformerRequestRequestTypeDef definition

class UpdateTransformerRequestRequestTypeDef(TypedDict):
    transformerId: str,
    name: NotRequired[str],
    status: NotRequired[TransformerStatusType],  # (1)
    fileFormat: NotRequired[FileFormatType],  # (2)
    mappingTemplate: NotRequired[str],
    ediType: NotRequired[EdiTypeTypeDef],  # (3)
    sampleDocument: NotRequired[str],
    inputConversion: NotRequired[InputConversionTypeDef],  # (4)
    mapping: NotRequired[MappingTypeDef],  # (5)
    outputConversion: NotRequired[OutputConversionTypeDef],  # (6)
    sampleDocuments: NotRequired[SampleDocumentsTypeDef],  # (7)
  1. See TransformerStatusType
  2. See FileFormatType
  3. See EdiTypeTypeDef
  4. See InputConversionTypeDef
  5. See MappingTypeDef
  6. See OutputConversionTypeDef
  7. See SampleDocumentsTypeDef

UpdateTransformerResponseTypeDef#

# UpdateTransformerResponseTypeDef definition

class UpdateTransformerResponseTypeDef(TypedDict):
    transformerId: str,
    transformerArn: str,
    name: str,
    status: TransformerStatusType,  # (1)
    createdAt: datetime,
    modifiedAt: datetime,
    fileFormat: FileFormatType,  # (2)
    mappingTemplate: str,
    ediType: EdiTypeTypeDef,  # (3)
    sampleDocument: str,
    inputConversion: InputConversionTypeDef,  # (4)
    mapping: MappingTypeDef,  # (5)
    outputConversion: OutputConversionTypeDef,  # (6)
    sampleDocuments: SampleDocumentsOutputTypeDef,  # (7)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)
  1. See TransformerStatusType
  2. See FileFormatType
  3. See EdiTypeTypeDef
  4. See InputConversionTypeDef
  5. See MappingTypeDef
  6. See OutputConversionTypeDef
  7. See SampleDocumentsOutputTypeDef
  8. See ResponseMetadataTypeDef

TestConversionRequestRequestTypeDef#

# TestConversionRequestRequestTypeDef definition

class TestConversionRequestRequestTypeDef(TypedDict):
    source: ConversionSourceTypeDef,  # (1)
    target: ConversionTargetTypeDef,  # (2)
  1. See ConversionSourceTypeDef
  2. See ConversionTargetTypeDef

OutboundEdiOptionsTypeDef#

# OutboundEdiOptionsTypeDef definition

class OutboundEdiOptionsTypeDef(TypedDict):
    x12: NotRequired[X12EnvelopeTypeDef],  # (1)
  1. See X12EnvelopeTypeDef

CreateCapabilityRequestRequestTypeDef#

# CreateCapabilityRequestRequestTypeDef definition

class CreateCapabilityRequestRequestTypeDef(TypedDict):
    name: str,
    type: CapabilityTypeType,  # (1)
    configuration: CapabilityConfigurationTypeDef,  # (2)
    instructionsDocuments: NotRequired[Sequence[S3LocationTypeDef]],  # (3)
    clientToken: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See CapabilityTypeType
  2. See CapabilityConfigurationTypeDef
  3. See S3LocationTypeDef
  4. See TagTypeDef

CreateCapabilityResponseTypeDef#

# CreateCapabilityResponseTypeDef definition

class CreateCapabilityResponseTypeDef(TypedDict):
    capabilityId: str,
    capabilityArn: str,
    name: str,
    type: CapabilityTypeType,  # (1)
    configuration: CapabilityConfigurationTypeDef,  # (2)
    instructionsDocuments: list[S3LocationTypeDef],  # (3)
    createdAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See CapabilityTypeType
  2. See CapabilityConfigurationTypeDef
  3. See S3LocationTypeDef
  4. See ResponseMetadataTypeDef

GetCapabilityResponseTypeDef#

# GetCapabilityResponseTypeDef definition

class GetCapabilityResponseTypeDef(TypedDict):
    capabilityId: str,
    capabilityArn: str,
    name: str,
    type: CapabilityTypeType,  # (1)
    configuration: CapabilityConfigurationTypeDef,  # (2)
    instructionsDocuments: list[S3LocationTypeDef],  # (3)
    createdAt: datetime,
    modifiedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See CapabilityTypeType
  2. See CapabilityConfigurationTypeDef
  3. See S3LocationTypeDef
  4. See ResponseMetadataTypeDef

UpdateCapabilityRequestRequestTypeDef#

# UpdateCapabilityRequestRequestTypeDef definition

class UpdateCapabilityRequestRequestTypeDef(TypedDict):
    capabilityId: str,
    name: NotRequired[str],
    configuration: NotRequired[CapabilityConfigurationTypeDef],  # (1)
    instructionsDocuments: NotRequired[Sequence[S3LocationTypeDef]],  # (2)
  1. See CapabilityConfigurationTypeDef
  2. See S3LocationTypeDef

UpdateCapabilityResponseTypeDef#

# UpdateCapabilityResponseTypeDef definition

class UpdateCapabilityResponseTypeDef(TypedDict):
    capabilityId: str,
    capabilityArn: str,
    name: str,
    type: CapabilityTypeType,  # (1)
    configuration: CapabilityConfigurationTypeDef,  # (2)
    instructionsDocuments: list[S3LocationTypeDef],  # (3)
    createdAt: datetime,
    modifiedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See CapabilityTypeType
  2. See CapabilityConfigurationTypeDef
  3. See S3LocationTypeDef
  4. See ResponseMetadataTypeDef

ListTransformersResponseTypeDef#

# ListTransformersResponseTypeDef definition

class ListTransformersResponseTypeDef(TypedDict):
    transformers: list[TransformerSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See TransformerSummaryTypeDef
  2. See ResponseMetadataTypeDef

CapabilityOptionsTypeDef#

# CapabilityOptionsTypeDef definition

class CapabilityOptionsTypeDef(TypedDict):
    outboundEdi: NotRequired[OutboundEdiOptionsTypeDef],  # (1)
  1. See OutboundEdiOptionsTypeDef

CreatePartnershipRequestRequestTypeDef#

# CreatePartnershipRequestRequestTypeDef definition

class CreatePartnershipRequestRequestTypeDef(TypedDict):
    profileId: str,
    name: str,
    email: str,
    capabilities: Sequence[str],
    phone: NotRequired[str],
    capabilityOptions: NotRequired[CapabilityOptionsTypeDef],  # (1)
    clientToken: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See CapabilityOptionsTypeDef
  2. See TagTypeDef

CreatePartnershipResponseTypeDef#

# CreatePartnershipResponseTypeDef definition

class CreatePartnershipResponseTypeDef(TypedDict):
    profileId: str,
    partnershipId: str,
    partnershipArn: str,
    name: str,
    email: str,
    phone: str,
    capabilities: list[str],
    capabilityOptions: CapabilityOptionsTypeDef,  # (1)
    tradingPartnerId: str,
    createdAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CapabilityOptionsTypeDef
  2. See ResponseMetadataTypeDef

GetPartnershipResponseTypeDef#

# GetPartnershipResponseTypeDef definition

class GetPartnershipResponseTypeDef(TypedDict):
    profileId: str,
    partnershipId: str,
    partnershipArn: str,
    name: str,
    email: str,
    phone: str,
    capabilities: list[str],
    capabilityOptions: CapabilityOptionsTypeDef,  # (1)
    tradingPartnerId: str,
    createdAt: datetime,
    modifiedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CapabilityOptionsTypeDef
  2. See ResponseMetadataTypeDef

PartnershipSummaryTypeDef#

# PartnershipSummaryTypeDef definition

class PartnershipSummaryTypeDef(TypedDict):
    profileId: str,
    partnershipId: str,
    createdAt: datetime,
    name: NotRequired[str],
    capabilities: NotRequired[list[str]],
    capabilityOptions: NotRequired[CapabilityOptionsTypeDef],  # (1)
    tradingPartnerId: NotRequired[str],
    modifiedAt: NotRequired[datetime],
  1. See CapabilityOptionsTypeDef

UpdatePartnershipRequestRequestTypeDef#

# UpdatePartnershipRequestRequestTypeDef definition

class UpdatePartnershipRequestRequestTypeDef(TypedDict):
    partnershipId: str,
    name: NotRequired[str],
    capabilities: NotRequired[Sequence[str]],
    capabilityOptions: NotRequired[CapabilityOptionsTypeDef],  # (1)
  1. See CapabilityOptionsTypeDef

UpdatePartnershipResponseTypeDef#

# UpdatePartnershipResponseTypeDef definition

class UpdatePartnershipResponseTypeDef(TypedDict):
    profileId: str,
    partnershipId: str,
    partnershipArn: str,
    name: str,
    email: str,
    phone: str,
    capabilities: list[str],
    capabilityOptions: CapabilityOptionsTypeDef,  # (1)
    tradingPartnerId: str,
    createdAt: datetime,
    modifiedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CapabilityOptionsTypeDef
  2. See ResponseMetadataTypeDef

ListPartnershipsResponseTypeDef#

# ListPartnershipsResponseTypeDef definition

class ListPartnershipsResponseTypeDef(TypedDict):
    partnerships: list[PartnershipSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See PartnershipSummaryTypeDef
  2. See ResponseMetadataTypeDef