B2BIClient

Index > B2BI > 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)
    ...

1. See CapabilityTypeType
2. See CapabilityConfigurationTypeDef
3. See S3LocationTypeDef
4. See TagTypeDef
5. See CreateCapabilityResponseTypeDef

# create_capability method usage example with argument unpacking

kwargs: CreateCapabilityRequestRequestTypeDef = {  # (1)
    "name": ...,
    "type": ...,
    "configuration": ...,
}

parent.create_capability(**kwargs)

1. See CreateCapabilityRequestRequestTypeDef

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,
    phone: str = ...,
    capabilities: Sequence[str] = ...,
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreatePartnershipResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreatePartnershipResponseTypeDef

# create_partnership method usage example with argument unpacking

kwargs: CreatePartnershipRequestRequestTypeDef = {  # (1)
    "profileId": ...,
    "name": ...,
    "email": ...,
}

parent.create_partnership(**kwargs)

1. See CreatePartnershipRequestRequestTypeDef

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)
    ...

1. See LoggingType
2. See TagTypeDef
3. See CreateProfileResponseTypeDef

# create_profile method usage example with argument unpacking

kwargs: CreateProfileRequestRequestTypeDef = {  # (1)
    "name": ...,
    "phone": ...,
    "businessName": ...,
    "logging": ...,
}

parent.create_profile(**kwargs)

1. See CreateProfileRequestRequestTypeDef

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,
    fileFormat: FileFormatType,  # (1)
    mappingTemplate: str,
    ediType: EdiTypeTypeDef,  # (2)
    sampleDocument: str = ...,
    clientToken: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateTransformerResponseTypeDef:  # (4)
    ...

1. See FileFormatType
2. See EdiTypeTypeDef
3. See TagTypeDef
4. See CreateTransformerResponseTypeDef

# create_transformer method usage example with argument unpacking

kwargs: CreateTransformerRequestRequestTypeDef = {  # (1)
    "name": ...,
    "fileFormat": ...,
    "mappingTemplate": ...,
    "ediType": ...,
}

parent.create_transformer(**kwargs)

1. See CreateTransformerRequestRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_capability method usage example with argument unpacking

kwargs: DeleteCapabilityRequestRequestTypeDef = {  # (1)
    "capabilityId": ...,
}

parent.delete_capability(**kwargs)

1. See DeleteCapabilityRequestRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_partnership method usage example with argument unpacking

kwargs: DeletePartnershipRequestRequestTypeDef = {  # (1)
    "partnershipId": ...,
}

parent.delete_partnership(**kwargs)

1. See DeletePartnershipRequestRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_profile method usage example with argument unpacking

kwargs: DeleteProfileRequestRequestTypeDef = {  # (1)
    "profileId": ...,
}

parent.delete_profile(**kwargs)

1. See DeleteProfileRequestRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_transformer method usage example with argument unpacking

kwargs: DeleteTransformerRequestRequestTypeDef = {  # (1)
    "transformerId": ...,
}

parent.delete_transformer(**kwargs)

1. See DeleteTransformerRequestRequestTypeDef

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)
    ...

1. See GetCapabilityResponseTypeDef

# get_capability method usage example with argument unpacking

kwargs: GetCapabilityRequestRequestTypeDef = {  # (1)
    "capabilityId": ...,
}

parent.get_capability(**kwargs)

1. See GetCapabilityRequestRequestTypeDef

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)
    ...

1. See GetPartnershipResponseTypeDef

# get_partnership method usage example with argument unpacking

kwargs: GetPartnershipRequestRequestTypeDef = {  # (1)
    "partnershipId": ...,
}

parent.get_partnership(**kwargs)

1. See GetPartnershipRequestRequestTypeDef

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)
    ...

1. See GetProfileResponseTypeDef

# get_profile method usage example with argument unpacking

kwargs: GetProfileRequestRequestTypeDef = {  # (1)
    "profileId": ...,
}

parent.get_profile(**kwargs)

1. See GetProfileRequestRequestTypeDef

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)
    ...

1. See GetTransformerResponseTypeDef

# get_transformer method usage example with argument unpacking

kwargs: GetTransformerRequestRequestTypeDef = {  # (1)
    "transformerId": ...,
}

parent.get_transformer(**kwargs)

1. See GetTransformerRequestRequestTypeDef

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)
    ...

1. See GetTransformerJobResponseTypeDef

# get_transformer_job method usage example with argument unpacking

kwargs: GetTransformerJobRequestRequestTypeDef = {  # (1)
    "transformerJobId": ...,
    "transformerId": ...,
}

parent.get_transformer_job(**kwargs)

1. See GetTransformerJobRequestRequestTypeDef

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)
    ...

1. See ListCapabilitiesResponseTypeDef

# list_capabilities method usage example with argument unpacking

kwargs: ListCapabilitiesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_capabilities(**kwargs)

1. See ListCapabilitiesRequestRequestTypeDef

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)
    ...

1. See ListPartnershipsResponseTypeDef

# list_partnerships method usage example with argument unpacking

kwargs: ListPartnershipsRequestRequestTypeDef = {  # (1)
    "profileId": ...,
}

parent.list_partnerships(**kwargs)

1. See ListPartnershipsRequestRequestTypeDef

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)
    ...

1. See ListProfilesResponseTypeDef

# list_profiles method usage example with argument unpacking

kwargs: ListProfilesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_profiles(**kwargs)

1. See ListProfilesRequestRequestTypeDef

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)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

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)
    ...

1. See ListTransformersResponseTypeDef

# list_transformers method usage example with argument unpacking

kwargs: ListTransformersRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_transformers(**kwargs)

1. See ListTransformersRequestRequestTypeDef

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 B2BI 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)
    ...

1. See S3LocationTypeDef
2. See S3LocationTypeDef
3. See StartTransformerJobResponseTypeDef

# start_transformer_job method usage example with argument unpacking

kwargs: StartTransformerJobRequestRequestTypeDef = {  # (1)
    "inputFile": ...,
    "outputLocation": ...,
    "transformerId": ...,
}

parent.start_transformer_job(**kwargs)

1. See StartTransformerJobRequestRequestTypeDef

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)
    ...

1. See TagTypeDef
2. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

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)
    ...

1. See FileFormatType
2. See TestMappingResponseTypeDef

# test_mapping method usage example with argument unpacking

kwargs: TestMappingRequestRequestTypeDef = {  # (1)
    "inputFileContent": ...,
    "mappingTemplate": ...,
    "fileFormat": ...,
}

parent.test_mapping(**kwargs)

1. See TestMappingRequestRequestTypeDef

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)
    ...

1. See S3LocationTypeDef
2. See FileFormatType
3. See EdiTypeTypeDef
4. See TestParsingResponseTypeDef

# test_parsing method usage example with argument unpacking

kwargs: TestParsingRequestRequestTypeDef = {  # (1)
    "inputFile": ...,
    "fileFormat": ...,
    "ediType": ...,
}

parent.test_parsing(**kwargs)

1. See TestParsingRequestRequestTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

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)
    ...

1. See CapabilityConfigurationTypeDef
2. See S3LocationTypeDef
3. See UpdateCapabilityResponseTypeDef

# update_capability method usage example with argument unpacking

kwargs: UpdateCapabilityRequestRequestTypeDef = {  # (1)
    "capabilityId": ...,
}

parent.update_capability(**kwargs)

1. See UpdateCapabilityRequestRequestTypeDef

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] = ...,
) -> UpdatePartnershipResponseTypeDef:  # (1)
    ...

1. See UpdatePartnershipResponseTypeDef

# update_partnership method usage example with argument unpacking

kwargs: UpdatePartnershipRequestRequestTypeDef = {  # (1)
    "partnershipId": ...,
}

parent.update_partnership(**kwargs)

1. See UpdatePartnershipRequestRequestTypeDef

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)
    ...

1. See UpdateProfileResponseTypeDef

# update_profile method usage example with argument unpacking

kwargs: UpdateProfileRequestRequestTypeDef = {  # (1)
    "profileId": ...,
}

parent.update_profile(**kwargs)

1. See UpdateProfileRequestRequestTypeDef

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 = ...,
    fileFormat: FileFormatType = ...,  # (1)
    mappingTemplate: str = ...,
    status: TransformerStatusType = ...,  # (2)
    ediType: EdiTypeTypeDef = ...,  # (3)
    sampleDocument: str = ...,
) -> UpdateTransformerResponseTypeDef:  # (4)
    ...

1. See FileFormatType
2. See TransformerStatusType
3. See EdiTypeTypeDef
4. See UpdateTransformerResponseTypeDef

# update_transformer method usage example with argument unpacking

kwargs: UpdateTransformerRequestRequestTypeDef = {  # (1)
    "transformerId": ...,
}

parent.update_transformer(**kwargs)

1. See UpdateTransformerRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("b2bi").get_paginator method with overloads.

• client.get_paginator("list_capabilities") -> ListCapabilitiesPaginator
• client.get_paginator("list_partnerships") -> ListPartnershipsPaginator
• client.get_paginator("list_profiles") -> ListProfilesPaginator
• client.get_paginator("list_transformers") -> ListTransformersPaginator