Skip to content

Type definitions#

Index > B2BI > Type definitions

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

SampleDocumentsUnionTypeDef#

# SampleDocumentsUnionTypeDef Union usage example

from types_boto3_b2bi.type_defs import SampleDocumentsUnionTypeDef


def get_value() -> SampleDocumentsUnionTypeDef:
    return ...


# SampleDocumentsUnionTypeDef definition

SampleDocumentsUnionTypeDef = Union[
    SampleDocumentsTypeDef,  # (1)
    SampleDocumentsOutputTypeDef,  # (2)
]
  1. See SampleDocumentsTypeDef
  2. See SampleDocumentsOutputTypeDef

CapabilitySummaryTypeDef#

# CapabilitySummaryTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import CapabilitySummaryTypeDef


def get_value() -> CapabilitySummaryTypeDef:
    return {
        "capabilityId": ...,
    }


# CapabilitySummaryTypeDef definition

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

InputFileSourceTypeDef#

# InputFileSourceTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import InputFileSourceTypeDef


def get_value() -> InputFileSourceTypeDef:
    return {
        "fileContent": ...,
    }


# InputFileSourceTypeDef definition

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

X12DetailsTypeDef#

# X12DetailsTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import X12DetailsTypeDef


def get_value() -> X12DetailsTypeDef:
    return {
        "transactionSet": ...,
    }


# X12DetailsTypeDef definition

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

S3LocationTypeDef#

# S3LocationTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import S3LocationTypeDef


def get_value() -> S3LocationTypeDef:
    return {
        "bucketName": ...,
    }


# S3LocationTypeDef definition

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

TagTypeDef#

# TagTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }


# TagTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

MappingTypeDef#

# MappingTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import MappingTypeDef


def get_value() -> MappingTypeDef:
    return {
        "templateLanguage": ...,
    }


# MappingTypeDef definition

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

DeleteCapabilityRequestTypeDef#

# DeleteCapabilityRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import DeleteCapabilityRequestTypeDef


def get_value() -> DeleteCapabilityRequestTypeDef:
    return {
        "capabilityId": ...,
    }


# DeleteCapabilityRequestTypeDef definition

class DeleteCapabilityRequestTypeDef(TypedDict):
    capabilityId: str,

DeletePartnershipRequestTypeDef#

# DeletePartnershipRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import DeletePartnershipRequestTypeDef


def get_value() -> DeletePartnershipRequestTypeDef:
    return {
        "partnershipId": ...,
    }


# DeletePartnershipRequestTypeDef definition

class DeletePartnershipRequestTypeDef(TypedDict):
    partnershipId: str,

DeleteProfileRequestTypeDef#

# DeleteProfileRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import DeleteProfileRequestTypeDef


def get_value() -> DeleteProfileRequestTypeDef:
    return {
        "profileId": ...,
    }


# DeleteProfileRequestTypeDef definition

class DeleteProfileRequestTypeDef(TypedDict):
    profileId: str,

DeleteTransformerRequestTypeDef#

# DeleteTransformerRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import DeleteTransformerRequestTypeDef


def get_value() -> DeleteTransformerRequestTypeDef:
    return {
        "transformerId": ...,
    }


# DeleteTransformerRequestTypeDef definition

class DeleteTransformerRequestTypeDef(TypedDict):
    transformerId: str,

GenerateMappingRequestTypeDef#

# GenerateMappingRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import GenerateMappingRequestTypeDef


def get_value() -> GenerateMappingRequestTypeDef:
    return {
        "inputFileContent": ...,
    }


# GenerateMappingRequestTypeDef definition

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

GetCapabilityRequestTypeDef#

# GetCapabilityRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import GetCapabilityRequestTypeDef


def get_value() -> GetCapabilityRequestTypeDef:
    return {
        "capabilityId": ...,
    }


# GetCapabilityRequestTypeDef definition

class GetCapabilityRequestTypeDef(TypedDict):
    capabilityId: str,

GetPartnershipRequestTypeDef#

# GetPartnershipRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import GetPartnershipRequestTypeDef


def get_value() -> GetPartnershipRequestTypeDef:
    return {
        "partnershipId": ...,
    }


# GetPartnershipRequestTypeDef definition

class GetPartnershipRequestTypeDef(TypedDict):
    partnershipId: str,

GetProfileRequestTypeDef#

# GetProfileRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import GetProfileRequestTypeDef


def get_value() -> GetProfileRequestTypeDef:
    return {
        "profileId": ...,
    }


# GetProfileRequestTypeDef definition

class GetProfileRequestTypeDef(TypedDict):
    profileId: str,

GetTransformerJobRequestTypeDef#

# GetTransformerJobRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import GetTransformerJobRequestTypeDef


def get_value() -> GetTransformerJobRequestTypeDef:
    return {
        "transformerJobId": ...,
    }


# GetTransformerJobRequestTypeDef definition

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

GetTransformerRequestTypeDef#

# GetTransformerRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import GetTransformerRequestTypeDef


def get_value() -> GetTransformerRequestTypeDef:
    return {
        "transformerId": ...,
    }


# GetTransformerRequestTypeDef definition

class GetTransformerRequestTypeDef(TypedDict):
    transformerId: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

ListCapabilitiesRequestTypeDef#

# ListCapabilitiesRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ListCapabilitiesRequestTypeDef


def get_value() -> ListCapabilitiesRequestTypeDef:
    return {
        "nextToken": ...,
    }


# ListCapabilitiesRequestTypeDef definition

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

ListPartnershipsRequestTypeDef#

# ListPartnershipsRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ListPartnershipsRequestTypeDef


def get_value() -> ListPartnershipsRequestTypeDef:
    return {
        "profileId": ...,
    }


# ListPartnershipsRequestTypeDef definition

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

ListProfilesRequestTypeDef#

# ListProfilesRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ListProfilesRequestTypeDef


def get_value() -> ListProfilesRequestTypeDef:
    return {
        "nextToken": ...,
    }


# ListProfilesRequestTypeDef definition

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

ProfileSummaryTypeDef#

# ProfileSummaryTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ProfileSummaryTypeDef


def get_value() -> ProfileSummaryTypeDef:
    return {
        "profileId": ...,
    }


# 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

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "ResourceARN": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    ResourceARN: str,

ListTransformersRequestTypeDef#

# ListTransformersRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ListTransformersRequestTypeDef


def get_value() -> ListTransformersRequestTypeDef:
    return {
        "nextToken": ...,
    }


# ListTransformersRequestTypeDef definition

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

SampleDocumentKeysTypeDef#

# SampleDocumentKeysTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import SampleDocumentKeysTypeDef


def get_value() -> SampleDocumentKeysTypeDef:
    return {
        "input": ...,
    }


# SampleDocumentKeysTypeDef definition

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

TestMappingRequestTypeDef#

# TestMappingRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import TestMappingRequestTypeDef


def get_value() -> TestMappingRequestTypeDef:
    return {
        "inputFileContent": ...,
    }


# TestMappingRequestTypeDef definition

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

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "ResourceARN": ...,
    }


# UntagResourceRequestTypeDef definition

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

UpdateProfileRequestTypeDef#

# UpdateProfileRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import UpdateProfileRequestTypeDef


def get_value() -> UpdateProfileRequestTypeDef:
    return {
        "profileId": ...,
    }


# UpdateProfileRequestTypeDef definition

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

X12DelimitersTypeDef#

# X12DelimitersTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import X12DelimitersTypeDef


def get_value() -> X12DelimitersTypeDef:
    return {
        "componentSeparator": ...,
    }


# X12DelimitersTypeDef definition

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

X12FunctionalGroupHeadersTypeDef#

# X12FunctionalGroupHeadersTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import X12FunctionalGroupHeadersTypeDef


def get_value() -> X12FunctionalGroupHeadersTypeDef:
    return {
        "applicationSenderCode": ...,
    }


# X12FunctionalGroupHeadersTypeDef definition

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

X12InterchangeControlHeadersTypeDef#

# X12InterchangeControlHeadersTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import X12InterchangeControlHeadersTypeDef


def get_value() -> X12InterchangeControlHeadersTypeDef:
    return {
        "senderIdQualifier": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import ConversionSourceTypeDef


def get_value() -> ConversionSourceTypeDef:
    return {
        "fileFormat": ...,
    }


# ConversionSourceTypeDef definition

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

ConversionTargetFormatDetailsTypeDef#

# ConversionTargetFormatDetailsTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ConversionTargetFormatDetailsTypeDef


def get_value() -> ConversionTargetFormatDetailsTypeDef:
    return {
        "x12": ...,
    }


# ConversionTargetFormatDetailsTypeDef definition

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

EdiTypeTypeDef#

# EdiTypeTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import EdiTypeTypeDef


def get_value() -> EdiTypeTypeDef:
    return {
        "x12Details": ...,
    }


# EdiTypeTypeDef definition

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

FormatOptionsTypeDef#

# FormatOptionsTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import FormatOptionsTypeDef


def get_value() -> FormatOptionsTypeDef:
    return {
        "x12": ...,
    }


# FormatOptionsTypeDef definition

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

TemplateDetailsTypeDef#

# TemplateDetailsTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import TemplateDetailsTypeDef


def get_value() -> TemplateDetailsTypeDef:
    return {
        "x12": ...,
    }


# TemplateDetailsTypeDef definition

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

OutputSampleFileSourceTypeDef#

# OutputSampleFileSourceTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import OutputSampleFileSourceTypeDef


def get_value() -> OutputSampleFileSourceTypeDef:
    return {
        "fileLocation": ...,
    }


# OutputSampleFileSourceTypeDef definition

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

StartTransformerJobRequestTypeDef#

# StartTransformerJobRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import StartTransformerJobRequestTypeDef


def get_value() -> StartTransformerJobRequestTypeDef:
    return {
        "inputFile": ...,
    }


# StartTransformerJobRequestTypeDef definition

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

CreateProfileRequestTypeDef#

# CreateProfileRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import CreateProfileRequestTypeDef


def get_value() -> CreateProfileRequestTypeDef:
    return {
        "name": ...,
    }


# CreateProfileRequestTypeDef definition

class CreateProfileRequestTypeDef(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

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "ResourceARN": ...,
    }


# TagResourceRequestTypeDef definition

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

CreateProfileResponseTypeDef#

# CreateProfileResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import CreateProfileResponseTypeDef


def get_value() -> CreateProfileResponseTypeDef:
    return {
        "profileId": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import CreateStarterMappingTemplateResponseTypeDef


def get_value() -> CreateStarterMappingTemplateResponseTypeDef:
    return {
        "mappingTemplate": ...,
    }


# CreateStarterMappingTemplateResponseTypeDef definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

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

GenerateMappingResponseTypeDef#

# GenerateMappingResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import GenerateMappingResponseTypeDef


def get_value() -> GenerateMappingResponseTypeDef:
    return {
        "mappingTemplate": ...,
    }


# GenerateMappingResponseTypeDef definition

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

GetProfileResponseTypeDef#

# GetProfileResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import GetProfileResponseTypeDef


def get_value() -> GetProfileResponseTypeDef:
    return {
        "profileId": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import GetTransformerJobResponseTypeDef


def get_value() -> GetTransformerJobResponseTypeDef:
    return {
        "status": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import ListCapabilitiesResponseTypeDef


def get_value() -> ListCapabilitiesResponseTypeDef:
    return {
        "capabilities": ...,
    }


# ListCapabilitiesResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

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

StartTransformerJobResponseTypeDef#

# StartTransformerJobResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import StartTransformerJobResponseTypeDef


def get_value() -> StartTransformerJobResponseTypeDef:
    return {
        "transformerJobId": ...,
    }


# StartTransformerJobResponseTypeDef definition

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

TestConversionResponseTypeDef#

# TestConversionResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import TestConversionResponseTypeDef


def get_value() -> TestConversionResponseTypeDef:
    return {
        "convertedFileContent": ...,
    }


# TestConversionResponseTypeDef definition

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

TestMappingResponseTypeDef#

# TestMappingResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import TestMappingResponseTypeDef


def get_value() -> TestMappingResponseTypeDef:
    return {
        "mappedFileContent": ...,
    }


# TestMappingResponseTypeDef definition

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

TestParsingResponseTypeDef#

# TestParsingResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import TestParsingResponseTypeDef


def get_value() -> TestParsingResponseTypeDef:
    return {
        "parsedFileContent": ...,
    }


# TestParsingResponseTypeDef definition

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

UpdateProfileResponseTypeDef#

# UpdateProfileResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import UpdateProfileResponseTypeDef


def get_value() -> UpdateProfileResponseTypeDef:
    return {
        "profileId": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import ListCapabilitiesRequestPaginateTypeDef


def get_value() -> ListCapabilitiesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListCapabilitiesRequestPaginateTypeDef definition

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

ListPartnershipsRequestPaginateTypeDef#

# ListPartnershipsRequestPaginateTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ListPartnershipsRequestPaginateTypeDef


def get_value() -> ListPartnershipsRequestPaginateTypeDef:
    return {
        "profileId": ...,
    }


# ListPartnershipsRequestPaginateTypeDef definition

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

ListProfilesRequestPaginateTypeDef#

# ListProfilesRequestPaginateTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ListProfilesRequestPaginateTypeDef


def get_value() -> ListProfilesRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListProfilesRequestPaginateTypeDef definition

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

ListTransformersRequestPaginateTypeDef#

# ListTransformersRequestPaginateTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ListTransformersRequestPaginateTypeDef


def get_value() -> ListTransformersRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListTransformersRequestPaginateTypeDef definition

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

ListProfilesResponseTypeDef#

# ListProfilesResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ListProfilesResponseTypeDef


def get_value() -> ListProfilesResponseTypeDef:
    return {
        "profiles": ...,
    }


# ListProfilesResponseTypeDef definition

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

SampleDocumentsOutputTypeDef#

# SampleDocumentsOutputTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import SampleDocumentsOutputTypeDef


def get_value() -> SampleDocumentsOutputTypeDef:
    return {
        "bucketName": ...,
    }


# SampleDocumentsOutputTypeDef definition

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

SampleDocumentsTypeDef#

# SampleDocumentsTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import SampleDocumentsTypeDef


def get_value() -> SampleDocumentsTypeDef:
    return {
        "bucketName": ...,
    }


# SampleDocumentsTypeDef definition

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

X12OutboundEdiHeadersTypeDef#

# X12OutboundEdiHeadersTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import X12OutboundEdiHeadersTypeDef


def get_value() -> X12OutboundEdiHeadersTypeDef:
    return {
        "interchangeControlHeaders": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import EdiConfigurationTypeDef


def get_value() -> EdiConfigurationTypeDef:
    return {
        "capabilityDirection": ...,
    }


# 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

TestParsingRequestTypeDef#

# TestParsingRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import TestParsingRequestTypeDef


def get_value() -> TestParsingRequestTypeDef:
    return {
        "inputFile": ...,
    }


# TestParsingRequestTypeDef definition

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

InputConversionTypeDef#

# InputConversionTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import InputConversionTypeDef


def get_value() -> InputConversionTypeDef:
    return {
        "fromFormat": ...,
    }


# InputConversionTypeDef definition

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

OutputConversionTypeDef#

# OutputConversionTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import OutputConversionTypeDef


def get_value() -> OutputConversionTypeDef:
    return {
        "toFormat": ...,
    }


# OutputConversionTypeDef definition

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

CreateStarterMappingTemplateRequestTypeDef#

# CreateStarterMappingTemplateRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import CreateStarterMappingTemplateRequestTypeDef


def get_value() -> CreateStarterMappingTemplateRequestTypeDef:
    return {
        "mappingType": ...,
    }


# CreateStarterMappingTemplateRequestTypeDef definition

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

ConversionTargetTypeDef#

# ConversionTargetTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import ConversionTargetTypeDef


def get_value() -> ConversionTargetTypeDef:
    return {
        "fileFormat": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import X12EnvelopeTypeDef


def get_value() -> X12EnvelopeTypeDef:
    return {
        "common": ...,
    }


# X12EnvelopeTypeDef definition

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

CapabilityConfigurationTypeDef#

# CapabilityConfigurationTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import CapabilityConfigurationTypeDef


def get_value() -> CapabilityConfigurationTypeDef:
    return {
        "edi": ...,
    }


# CapabilityConfigurationTypeDef definition

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

CreateTransformerResponseTypeDef#

# CreateTransformerResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import CreateTransformerResponseTypeDef


def get_value() -> CreateTransformerResponseTypeDef:
    return {
        "transformerId": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import GetTransformerResponseTypeDef


def get_value() -> GetTransformerResponseTypeDef:
    return {
        "transformerId": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import TransformerSummaryTypeDef


def get_value() -> TransformerSummaryTypeDef:
    return {
        "transformerId": ...,
    }


# 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

UpdateTransformerResponseTypeDef#

# UpdateTransformerResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import UpdateTransformerResponseTypeDef


def get_value() -> UpdateTransformerResponseTypeDef:
    return {
        "transformerId": ...,
    }


# 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

TestConversionRequestTypeDef#

# TestConversionRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import TestConversionRequestTypeDef


def get_value() -> TestConversionRequestTypeDef:
    return {
        "source": ...,
    }


# TestConversionRequestTypeDef definition

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

CreateTransformerRequestTypeDef#

# CreateTransformerRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import CreateTransformerRequestTypeDef


def get_value() -> CreateTransformerRequestTypeDef:
    return {
        "name": ...,
    }


# CreateTransformerRequestTypeDef definition

class CreateTransformerRequestTypeDef(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[SampleDocumentsUnionTypeDef],  # (7)
  1. See TagTypeDef
  2. See FileFormatType
  3. See EdiTypeTypeDef
  4. See InputConversionTypeDef
  5. See MappingTypeDef
  6. See OutputConversionTypeDef
  7. See SampleDocumentsTypeDef SampleDocumentsOutputTypeDef

UpdateTransformerRequestTypeDef#

# UpdateTransformerRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import UpdateTransformerRequestTypeDef


def get_value() -> UpdateTransformerRequestTypeDef:
    return {
        "transformerId": ...,
    }


# UpdateTransformerRequestTypeDef definition

class UpdateTransformerRequestTypeDef(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[SampleDocumentsUnionTypeDef],  # (7)
  1. See TransformerStatusType
  2. See FileFormatType
  3. See EdiTypeTypeDef
  4. See InputConversionTypeDef
  5. See MappingTypeDef
  6. See OutputConversionTypeDef
  7. See SampleDocumentsTypeDef SampleDocumentsOutputTypeDef

OutboundEdiOptionsTypeDef#

# OutboundEdiOptionsTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import OutboundEdiOptionsTypeDef


def get_value() -> OutboundEdiOptionsTypeDef:
    return {
        "x12": ...,
    }


# OutboundEdiOptionsTypeDef definition

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

CreateCapabilityRequestTypeDef#

# CreateCapabilityRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import CreateCapabilityRequestTypeDef


def get_value() -> CreateCapabilityRequestTypeDef:
    return {
        "name": ...,
    }


# CreateCapabilityRequestTypeDef definition

class CreateCapabilityRequestTypeDef(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 TypedDict usage example

from types_boto3_b2bi.type_defs import CreateCapabilityResponseTypeDef


def get_value() -> CreateCapabilityResponseTypeDef:
    return {
        "capabilityId": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import GetCapabilityResponseTypeDef


def get_value() -> GetCapabilityResponseTypeDef:
    return {
        "capabilityId": ...,
    }


# 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

UpdateCapabilityRequestTypeDef#

# UpdateCapabilityRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import UpdateCapabilityRequestTypeDef


def get_value() -> UpdateCapabilityRequestTypeDef:
    return {
        "capabilityId": ...,
    }


# UpdateCapabilityRequestTypeDef definition

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

UpdateCapabilityResponseTypeDef#

# UpdateCapabilityResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import UpdateCapabilityResponseTypeDef


def get_value() -> UpdateCapabilityResponseTypeDef:
    return {
        "capabilityId": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import ListTransformersResponseTypeDef


def get_value() -> ListTransformersResponseTypeDef:
    return {
        "transformers": ...,
    }


# ListTransformersResponseTypeDef definition

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

CapabilityOptionsTypeDef#

# CapabilityOptionsTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import CapabilityOptionsTypeDef


def get_value() -> CapabilityOptionsTypeDef:
    return {
        "outboundEdi": ...,
    }


# CapabilityOptionsTypeDef definition

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

CreatePartnershipRequestTypeDef#

# CreatePartnershipRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import CreatePartnershipRequestTypeDef


def get_value() -> CreatePartnershipRequestTypeDef:
    return {
        "profileId": ...,
    }


# CreatePartnershipRequestTypeDef definition

class CreatePartnershipRequestTypeDef(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 TypedDict usage example

from types_boto3_b2bi.type_defs import CreatePartnershipResponseTypeDef


def get_value() -> CreatePartnershipResponseTypeDef:
    return {
        "profileId": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import GetPartnershipResponseTypeDef


def get_value() -> GetPartnershipResponseTypeDef:
    return {
        "profileId": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import PartnershipSummaryTypeDef


def get_value() -> PartnershipSummaryTypeDef:
    return {
        "profileId": ...,
    }


# 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

UpdatePartnershipRequestTypeDef#

# UpdatePartnershipRequestTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import UpdatePartnershipRequestTypeDef


def get_value() -> UpdatePartnershipRequestTypeDef:
    return {
        "partnershipId": ...,
    }


# UpdatePartnershipRequestTypeDef definition

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

UpdatePartnershipResponseTypeDef#

# UpdatePartnershipResponseTypeDef TypedDict usage example

from types_boto3_b2bi.type_defs import UpdatePartnershipResponseTypeDef


def get_value() -> UpdatePartnershipResponseTypeDef:
    return {
        "profileId": ...,
    }


# 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 TypedDict usage example

from types_boto3_b2bi.type_defs import ListPartnershipsResponseTypeDef


def get_value() -> ListPartnershipsResponseTypeDef:
    return {
        "partnerships": ...,
    }


# ListPartnershipsResponseTypeDef definition

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