Skip to content

Type definitions#

Index > B2BI > Type definitions

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

CapabilitySummaryTypeDef#

# CapabilitySummaryTypeDef definition

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

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],

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,

X12DetailsTypeDef#

# X12DetailsTypeDef definition

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

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],

PartnershipSummaryTypeDef#

# PartnershipSummaryTypeDef definition

class PartnershipSummaryTypeDef(TypedDict):
    profileId: str,
    partnershipId: str,
    createdAt: datetime,
    name: NotRequired[str],
    capabilities: NotRequired[List[str]],
    tradingPartnerId: NotRequired[str],
    modifiedAt: NotRequired[datetime],

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],

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],

UpdatePartnershipRequestRequestTypeDef#

# UpdatePartnershipRequestRequestTypeDef definition

class UpdatePartnershipRequestRequestTypeDef(TypedDict):
    partnershipId: str,
    name: NotRequired[str],
    capabilities: NotRequired[Sequence[str]],

UpdateProfileRequestRequestTypeDef#

# UpdateProfileRequestRequestTypeDef definition

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

StartTransformerJobRequestRequestTypeDef#

# StartTransformerJobRequestRequestTypeDef definition

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

CreatePartnershipRequestRequestTypeDef#

# CreatePartnershipRequestRequestTypeDef definition

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

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

CreatePartnershipResponseTypeDef#

# CreatePartnershipResponseTypeDef definition

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

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

GetPartnershipResponseTypeDef#

# GetPartnershipResponseTypeDef definition

class GetPartnershipResponseTypeDef(TypedDict):
    profileId: str,
    partnershipId: str,
    partnershipArn: str,
    name: str,
    email: str,
    phone: str,
    capabilities: List[str],
    tradingPartnerId: str,
    createdAt: datetime,
    modifiedAt: datetime,
    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)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  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

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

UpdatePartnershipResponseTypeDef#

# UpdatePartnershipResponseTypeDef definition

class UpdatePartnershipResponseTypeDef(TypedDict):
    profileId: str,
    partnershipId: str,
    partnershipArn: str,
    name: str,
    email: str,
    phone: str,
    capabilities: List[str],
    tradingPartnerId: str,
    createdAt: datetime,
    modifiedAt: datetime,
    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

EdiTypeTypeDef#

# EdiTypeTypeDef definition

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

ListCapabilitiesRequestListCapabilitiesPaginateTypeDef#

# ListCapabilitiesRequestListCapabilitiesPaginateTypeDef definition

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

ListPartnershipsRequestListPartnershipsPaginateTypeDef#

# ListPartnershipsRequestListPartnershipsPaginateTypeDef definition

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

ListProfilesRequestListProfilesPaginateTypeDef#

# ListProfilesRequestListProfilesPaginateTypeDef definition

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

ListTransformersRequestListTransformersPaginateTypeDef#

# ListTransformersRequestListTransformersPaginateTypeDef definition

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

ListPartnershipsResponseTypeDef#

# ListPartnershipsResponseTypeDef definition

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

ListProfilesResponseTypeDef#

# ListProfilesResponseTypeDef definition

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

CreateTransformerRequestRequestTypeDef#

# CreateTransformerRequestRequestTypeDef definition

class CreateTransformerRequestRequestTypeDef(TypedDict):
    name: str,
    fileFormat: FileFormatType,  # (1)
    mappingTemplate: str,
    ediType: EdiTypeTypeDef,  # (2)
    sampleDocument: NotRequired[str],
    clientToken: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See FileFormatType
  2. See EdiTypeTypeDef
  3. See TagTypeDef

CreateTransformerResponseTypeDef#

# CreateTransformerResponseTypeDef definition

class CreateTransformerResponseTypeDef(TypedDict):
    transformerId: str,
    transformerArn: str,
    name: str,
    fileFormat: FileFormatType,  # (1)
    mappingTemplate: str,
    status: TransformerStatusType,  # (2)
    ediType: EdiTypeTypeDef,  # (3)
    sampleDocument: str,
    createdAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See FileFormatType
  2. See TransformerStatusType
  3. See EdiTypeTypeDef
  4. See ResponseMetadataTypeDef

EdiConfigurationTypeDef#

# EdiConfigurationTypeDef definition

class EdiConfigurationTypeDef(TypedDict):
    type: EdiTypeTypeDef,  # (1)
    inputLocation: S3LocationTypeDef,  # (2)
    outputLocation: S3LocationTypeDef,  # (2)
    transformerId: str,
  1. See EdiTypeTypeDef
  2. See S3LocationTypeDef
  3. See S3LocationTypeDef

GetTransformerResponseTypeDef#

# GetTransformerResponseTypeDef definition

class GetTransformerResponseTypeDef(TypedDict):
    transformerId: str,
    transformerArn: str,
    name: str,
    fileFormat: FileFormatType,  # (1)
    mappingTemplate: str,
    status: TransformerStatusType,  # (2)
    ediType: EdiTypeTypeDef,  # (3)
    sampleDocument: str,
    createdAt: datetime,
    modifiedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See FileFormatType
  2. See TransformerStatusType
  3. See EdiTypeTypeDef
  4. See ResponseMetadataTypeDef

TestParsingRequestRequestTypeDef#

# TestParsingRequestRequestTypeDef definition

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

TransformerSummaryTypeDef#

# TransformerSummaryTypeDef definition

class TransformerSummaryTypeDef(TypedDict):
    transformerId: str,
    name: str,
    fileFormat: FileFormatType,  # (1)
    mappingTemplate: str,
    status: TransformerStatusType,  # (2)
    ediType: EdiTypeTypeDef,  # (3)
    createdAt: datetime,
    sampleDocument: NotRequired[str],
    modifiedAt: NotRequired[datetime],
  1. See FileFormatType
  2. See TransformerStatusType
  3. See EdiTypeTypeDef

UpdateTransformerRequestRequestTypeDef#

# UpdateTransformerRequestRequestTypeDef definition

class UpdateTransformerRequestRequestTypeDef(TypedDict):
    transformerId: str,
    name: NotRequired[str],
    fileFormat: NotRequired[FileFormatType],  # (1)
    mappingTemplate: NotRequired[str],
    status: NotRequired[TransformerStatusType],  # (2)
    ediType: NotRequired[EdiTypeTypeDef],  # (3)
    sampleDocument: NotRequired[str],
  1. See FileFormatType
  2. See TransformerStatusType
  3. See EdiTypeTypeDef

UpdateTransformerResponseTypeDef#

# UpdateTransformerResponseTypeDef definition

class UpdateTransformerResponseTypeDef(TypedDict):
    transformerId: str,
    transformerArn: str,
    name: str,
    fileFormat: FileFormatType,  # (1)
    mappingTemplate: str,
    status: TransformerStatusType,  # (2)
    ediType: EdiTypeTypeDef,  # (3)
    sampleDocument: str,
    createdAt: datetime,
    modifiedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See FileFormatType
  2. See TransformerStatusType
  3. See EdiTypeTypeDef
  4. See ResponseMetadataTypeDef

CapabilityConfigurationTypeDef#

# CapabilityConfigurationTypeDef definition

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

ListTransformersResponseTypeDef#

# ListTransformersResponseTypeDef definition

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

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