Skip to content

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.