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,
    capabilities: Sequence[str],
    phone: 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": ...,
    "capabilities": ...,
}

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.