B2BIClient#
Auto-generated documentation for B2BI type annotations stubs module mypy-boto3-b2bi.
B2BIClient#
Type annotations and code completion for boto3.client("b2bi")
.
boto3 documentation
# B2BIClient usage example
from boto3.session import Session
from mypy_boto3_b2bi.client import B2BIClient
def get_b2bi_client() -> B2BIClient:
return Session().client("b2bi")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("b2bi").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("b2bi")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_b2bi.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("b2bi").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("b2bi").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_capability#
Instantiates a capability based on the specified parameters.
Type annotations and code completion for boto3.client("b2bi").create_capability
method.
boto3 documentation
# create_capability method definition
def create_capability(
self,
*,
name: str,
type: CapabilityTypeType, # (1)
configuration: CapabilityConfigurationTypeDef, # (2)
instructionsDocuments: Sequence[S3LocationTypeDef] = ..., # (3)
clientToken: str = ...,
tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateCapabilityResponseTypeDef: # (5)
...
- See CapabilityTypeType
- See CapabilityConfigurationTypeDef
- See S3LocationTypeDef
- See TagTypeDef
- See CreateCapabilityResponseTypeDef
# create_capability method usage example with argument unpacking
kwargs: CreateCapabilityRequestRequestTypeDef = { # (1)
"name": ...,
"type": ...,
"configuration": ...,
}
parent.create_capability(**kwargs)
create_partnership#
Creates a partnership between a customer and a trading partner, based on the supplied parameters.
Type annotations and code completion for boto3.client("b2bi").create_partnership
method.
boto3 documentation
# create_partnership method definition
def create_partnership(
self,
*,
profileId: str,
name: str,
email: str,
capabilities: Sequence[str],
phone: str = ...,
capabilityOptions: CapabilityOptionsTypeDef = ..., # (1)
clientToken: str = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreatePartnershipResponseTypeDef: # (3)
...
# create_partnership method usage example with argument unpacking
kwargs: CreatePartnershipRequestRequestTypeDef = { # (1)
"profileId": ...,
"name": ...,
"email": ...,
"capabilities": ...,
}
parent.create_partnership(**kwargs)
create_profile#
Creates a customer profile.
Type annotations and code completion for boto3.client("b2bi").create_profile
method.
boto3 documentation
# create_profile method definition
def create_profile(
self,
*,
name: str,
phone: str,
businessName: str,
logging: LoggingType, # (1)
email: str = ...,
clientToken: str = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateProfileResponseTypeDef: # (3)
...
- See LoggingType
- See TagTypeDef
- See CreateProfileResponseTypeDef
# create_profile method usage example with argument unpacking
kwargs: CreateProfileRequestRequestTypeDef = { # (1)
"name": ...,
"phone": ...,
"businessName": ...,
"logging": ...,
}
parent.create_profile(**kwargs)
create_starter_mapping_template#
Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.
Type annotations and code completion for boto3.client("b2bi").create_starter_mapping_template
method.
boto3 documentation
# create_starter_mapping_template method definition
def create_starter_mapping_template(
self,
*,
mappingType: MappingTypeType, # (1)
templateDetails: TemplateDetailsTypeDef, # (2)
outputSampleLocation: S3LocationTypeDef = ..., # (3)
) -> CreateStarterMappingTemplateResponseTypeDef: # (4)
...
- See MappingTypeType
- See TemplateDetailsTypeDef
- See S3LocationTypeDef
- See CreateStarterMappingTemplateResponseTypeDef
# create_starter_mapping_template method usage example with argument unpacking
kwargs: CreateStarterMappingTemplateRequestRequestTypeDef = { # (1)
"mappingType": ...,
"templateDetails": ...,
}
parent.create_starter_mapping_template(**kwargs)
create_transformer#
Creates a transformer.
Type annotations and code completion for boto3.client("b2bi").create_transformer
method.
boto3 documentation
# create_transformer method definition
def create_transformer(
self,
*,
name: str,
clientToken: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
fileFormat: FileFormatType = ..., # (2)
mappingTemplate: str = ...,
ediType: EdiTypeTypeDef = ..., # (3)
sampleDocument: str = ...,
inputConversion: InputConversionTypeDef = ..., # (4)
mapping: MappingTypeDef = ..., # (5)
outputConversion: OutputConversionTypeDef = ..., # (6)
sampleDocuments: SampleDocumentsTypeDef = ..., # (7)
) -> CreateTransformerResponseTypeDef: # (8)
...
- See TagTypeDef
- See FileFormatType
- See EdiTypeTypeDef
- See InputConversionTypeDef
- See MappingTypeDef
- See OutputConversionTypeDef
- See SampleDocumentsTypeDef
- See CreateTransformerResponseTypeDef
# create_transformer method usage example with argument unpacking
kwargs: CreateTransformerRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_transformer(**kwargs)
delete_capability#
Deletes the specified capability.
Type annotations and code completion for boto3.client("b2bi").delete_capability
method.
boto3 documentation
# delete_capability method definition
def delete_capability(
self,
*,
capabilityId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_capability method usage example with argument unpacking
kwargs: DeleteCapabilityRequestRequestTypeDef = { # (1)
"capabilityId": ...,
}
parent.delete_capability(**kwargs)
delete_partnership#
Deletes the specified partnership.
Type annotations and code completion for boto3.client("b2bi").delete_partnership
method.
boto3 documentation
# delete_partnership method definition
def delete_partnership(
self,
*,
partnershipId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_partnership method usage example with argument unpacking
kwargs: DeletePartnershipRequestRequestTypeDef = { # (1)
"partnershipId": ...,
}
parent.delete_partnership(**kwargs)
delete_profile#
Deletes the specified profile.
Type annotations and code completion for boto3.client("b2bi").delete_profile
method.
boto3 documentation
# delete_profile method definition
def delete_profile(
self,
*,
profileId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_profile method usage example with argument unpacking
kwargs: DeleteProfileRequestRequestTypeDef = { # (1)
"profileId": ...,
}
parent.delete_profile(**kwargs)
delete_transformer#
Deletes the specified transformer.
Type annotations and code completion for boto3.client("b2bi").delete_transformer
method.
boto3 documentation
# delete_transformer method definition
def delete_transformer(
self,
*,
transformerId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_transformer method usage example with argument unpacking
kwargs: DeleteTransformerRequestRequestTypeDef = { # (1)
"transformerId": ...,
}
parent.delete_transformer(**kwargs)
generate_mapping#
Takes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically.
Type annotations and code completion for boto3.client("b2bi").generate_mapping
method.
boto3 documentation
# generate_mapping method definition
def generate_mapping(
self,
*,
inputFileContent: str,
outputFileContent: str,
mappingType: MappingTypeType, # (1)
) -> GenerateMappingResponseTypeDef: # (2)
...
# generate_mapping method usage example with argument unpacking
kwargs: GenerateMappingRequestRequestTypeDef = { # (1)
"inputFileContent": ...,
"outputFileContent": ...,
"mappingType": ...,
}
parent.generate_mapping(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("b2bi").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_capability#
Retrieves the details for the specified capability.
Type annotations and code completion for boto3.client("b2bi").get_capability
method.
boto3 documentation
# get_capability method definition
def get_capability(
self,
*,
capabilityId: str,
) -> GetCapabilityResponseTypeDef: # (1)
...
# get_capability method usage example with argument unpacking
kwargs: GetCapabilityRequestRequestTypeDef = { # (1)
"capabilityId": ...,
}
parent.get_capability(**kwargs)
get_partnership#
Retrieves the details for a partnership, based on the partner and profile IDs specified.
Type annotations and code completion for boto3.client("b2bi").get_partnership
method.
boto3 documentation
# get_partnership method definition
def get_partnership(
self,
*,
partnershipId: str,
) -> GetPartnershipResponseTypeDef: # (1)
...
# get_partnership method usage example with argument unpacking
kwargs: GetPartnershipRequestRequestTypeDef = { # (1)
"partnershipId": ...,
}
parent.get_partnership(**kwargs)
get_profile#
Retrieves the details for the profile specified by the profile ID.
Type annotations and code completion for boto3.client("b2bi").get_profile
method.
boto3 documentation
# get_profile method definition
def get_profile(
self,
*,
profileId: str,
) -> GetProfileResponseTypeDef: # (1)
...
# get_profile method usage example with argument unpacking
kwargs: GetProfileRequestRequestTypeDef = { # (1)
"profileId": ...,
}
parent.get_profile(**kwargs)
get_transformer#
Retrieves the details for the transformer specified by the transformer ID.
Type annotations and code completion for boto3.client("b2bi").get_transformer
method.
boto3 documentation
# get_transformer method definition
def get_transformer(
self,
*,
transformerId: str,
) -> GetTransformerResponseTypeDef: # (1)
...
# get_transformer method usage example with argument unpacking
kwargs: GetTransformerRequestRequestTypeDef = { # (1)
"transformerId": ...,
}
parent.get_transformer(**kwargs)
get_transformer_job#
Returns the details of the transformer run, based on the Transformer job ID.
Type annotations and code completion for boto3.client("b2bi").get_transformer_job
method.
boto3 documentation
# get_transformer_job method definition
def get_transformer_job(
self,
*,
transformerJobId: str,
transformerId: str,
) -> GetTransformerJobResponseTypeDef: # (1)
...
# get_transformer_job method usage example with argument unpacking
kwargs: GetTransformerJobRequestRequestTypeDef = { # (1)
"transformerJobId": ...,
"transformerId": ...,
}
parent.get_transformer_job(**kwargs)
list_capabilities#
Lists the capabilities associated with your Amazon Web Services account for your current or specified region.
Type annotations and code completion for boto3.client("b2bi").list_capabilities
method.
boto3 documentation
# list_capabilities method definition
def list_capabilities(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListCapabilitiesResponseTypeDef: # (1)
...
# list_capabilities method usage example with argument unpacking
kwargs: ListCapabilitiesRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_capabilities(**kwargs)
list_partnerships#
Lists the partnerships associated with your Amazon Web Services account for your current or specified region.
Type annotations and code completion for boto3.client("b2bi").list_partnerships
method.
boto3 documentation
# list_partnerships method definition
def list_partnerships(
self,
*,
profileId: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> ListPartnershipsResponseTypeDef: # (1)
...
# list_partnerships method usage example with argument unpacking
kwargs: ListPartnershipsRequestRequestTypeDef = { # (1)
"profileId": ...,
}
parent.list_partnerships(**kwargs)
list_profiles#
Lists the profiles associated with your Amazon Web Services account for your current or specified region.
Type annotations and code completion for boto3.client("b2bi").list_profiles
method.
boto3 documentation
# list_profiles method definition
def list_profiles(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListProfilesResponseTypeDef: # (1)
...
# list_profiles method usage example with argument unpacking
kwargs: ListProfilesRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_profiles(**kwargs)
list_tags_for_resource#
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
Type annotations and code completion for boto3.client("b2bi").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
list_transformers#
Lists the available transformers.
Type annotations and code completion for boto3.client("b2bi").list_transformers
method.
boto3 documentation
# list_transformers method definition
def list_transformers(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListTransformersResponseTypeDef: # (1)
...
# list_transformers method usage example with argument unpacking
kwargs: ListTransformersRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_transformers(**kwargs)
start_transformer_job#
Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.
Type annotations and code completion for boto3.client("b2bi").start_transformer_job
method.
boto3 documentation
# start_transformer_job method definition
def start_transformer_job(
self,
*,
inputFile: S3LocationTypeDef, # (1)
outputLocation: S3LocationTypeDef, # (1)
transformerId: str,
clientToken: str = ...,
) -> StartTransformerJobResponseTypeDef: # (3)
...
# start_transformer_job method usage example with argument unpacking
kwargs: StartTransformerJobRequestRequestTypeDef = { # (1)
"inputFile": ...,
"outputLocation": ...,
"transformerId": ...,
}
parent.start_transformer_job(**kwargs)
tag_resource#
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("b2bi").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
test_conversion#
This operation mimics the latter half of a typical Outbound EDI request.
Type annotations and code completion for boto3.client("b2bi").test_conversion
method.
boto3 documentation
# test_conversion method definition
def test_conversion(
self,
*,
source: ConversionSourceTypeDef, # (1)
target: ConversionTargetTypeDef, # (2)
) -> TestConversionResponseTypeDef: # (3)
...
# test_conversion method usage example with argument unpacking
kwargs: TestConversionRequestRequestTypeDef = { # (1)
"source": ...,
"target": ...,
}
parent.test_conversion(**kwargs)
test_mapping#
Maps the input file according to the provided template file.
Type annotations and code completion for boto3.client("b2bi").test_mapping
method.
boto3 documentation
# test_mapping method definition
def test_mapping(
self,
*,
inputFileContent: str,
mappingTemplate: str,
fileFormat: FileFormatType, # (1)
) -> TestMappingResponseTypeDef: # (2)
...
# test_mapping method usage example with argument unpacking
kwargs: TestMappingRequestRequestTypeDef = { # (1)
"inputFileContent": ...,
"mappingTemplate": ...,
"fileFormat": ...,
}
parent.test_mapping(**kwargs)
test_parsing#
Parses the input EDI (electronic data interchange) file.
Type annotations and code completion for boto3.client("b2bi").test_parsing
method.
boto3 documentation
# test_parsing method definition
def test_parsing(
self,
*,
inputFile: S3LocationTypeDef, # (1)
fileFormat: FileFormatType, # (2)
ediType: EdiTypeTypeDef, # (3)
) -> TestParsingResponseTypeDef: # (4)
...
- See S3LocationTypeDef
- See FileFormatType
- See EdiTypeTypeDef
- See TestParsingResponseTypeDef
# test_parsing method usage example with argument unpacking
kwargs: TestParsingRequestRequestTypeDef = { # (1)
"inputFile": ...,
"fileFormat": ...,
"ediType": ...,
}
parent.test_parsing(**kwargs)
untag_resource#
Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("b2bi").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_capability#
Updates some of the parameters for a capability, based on the specified parameters.
Type annotations and code completion for boto3.client("b2bi").update_capability
method.
boto3 documentation
# update_capability method definition
def update_capability(
self,
*,
capabilityId: str,
name: str = ...,
configuration: CapabilityConfigurationTypeDef = ..., # (1)
instructionsDocuments: Sequence[S3LocationTypeDef] = ..., # (2)
) -> UpdateCapabilityResponseTypeDef: # (3)
...
# update_capability method usage example with argument unpacking
kwargs: UpdateCapabilityRequestRequestTypeDef = { # (1)
"capabilityId": ...,
}
parent.update_capability(**kwargs)
update_partnership#
Updates some of the parameters for a partnership between a customer and trading partner.
Type annotations and code completion for boto3.client("b2bi").update_partnership
method.
boto3 documentation
# update_partnership method definition
def update_partnership(
self,
*,
partnershipId: str,
name: str = ...,
capabilities: Sequence[str] = ...,
capabilityOptions: CapabilityOptionsTypeDef = ..., # (1)
) -> UpdatePartnershipResponseTypeDef: # (2)
...
# update_partnership method usage example with argument unpacking
kwargs: UpdatePartnershipRequestRequestTypeDef = { # (1)
"partnershipId": ...,
}
parent.update_partnership(**kwargs)
update_profile#
Updates the specified parameters for a profile.
Type annotations and code completion for boto3.client("b2bi").update_profile
method.
boto3 documentation
# update_profile method definition
def update_profile(
self,
*,
profileId: str,
name: str = ...,
email: str = ...,
phone: str = ...,
businessName: str = ...,
) -> UpdateProfileResponseTypeDef: # (1)
...
# update_profile method usage example with argument unpacking
kwargs: UpdateProfileRequestRequestTypeDef = { # (1)
"profileId": ...,
}
parent.update_profile(**kwargs)
update_transformer#
Updates the specified parameters for a transformer.
Type annotations and code completion for boto3.client("b2bi").update_transformer
method.
boto3 documentation
# update_transformer method definition
def update_transformer(
self,
*,
transformerId: str,
name: str = ...,
status: TransformerStatusType = ..., # (1)
fileFormat: FileFormatType = ..., # (2)
mappingTemplate: str = ...,
ediType: EdiTypeTypeDef = ..., # (3)
sampleDocument: str = ...,
inputConversion: InputConversionTypeDef = ..., # (4)
mapping: MappingTypeDef = ..., # (5)
outputConversion: OutputConversionTypeDef = ..., # (6)
sampleDocuments: SampleDocumentsTypeDef = ..., # (7)
) -> UpdateTransformerResponseTypeDef: # (8)
...
- See TransformerStatusType
- See FileFormatType
- See EdiTypeTypeDef
- See InputConversionTypeDef
- See MappingTypeDef
- See OutputConversionTypeDef
- See SampleDocumentsTypeDef
- See UpdateTransformerResponseTypeDef
# update_transformer method usage example with argument unpacking
kwargs: UpdateTransformerRequestRequestTypeDef = { # (1)
"transformerId": ...,
}
parent.update_transformer(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("b2bi").get_paginator
method with overloads.
client.get_paginator("list_capabilities")
-> ListCapabilitiesPaginatorclient.get_paginator("list_partnerships")
-> ListPartnershipsPaginatorclient.get_paginator("list_profiles")
-> ListProfilesPaginatorclient.get_paginator("list_transformers")
-> ListTransformersPaginator