SupplyChainClient#

Index > SupplyChain > SupplyChainClient

Auto-generated documentation for SupplyChain type annotations stubs module mypy-boto3-supplychain.

SupplyChainClient#

Type annotations and code completion for boto3.client("supplychain"). boto3 documentation

# SupplyChainClient usage example

from boto3.session import Session
from mypy_boto3_supplychain.client import SupplyChainClient

def get_supplychain_client() -> SupplyChainClient:
    return Session().client("supplychain")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("supplychain").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("supplychain")

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_supplychain.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("supplychain").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("supplychain").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_bill_of_materials_import_job#

CreateBillOfMaterialsImportJob creates an import job for the Product Bill Of Materials (BOM) entity.

Type annotations and code completion for boto3.client("supplychain").create_bill_of_materials_import_job method. boto3 documentation

# create_bill_of_materials_import_job method definition

def create_bill_of_materials_import_job(
    self,
    *,
    instanceId: str,
    s3uri: str,
    clientToken: str = ...,
) -> CreateBillOfMaterialsImportJobResponseTypeDef:  # (1)
    ...

See CreateBillOfMaterialsImportJobResponseTypeDef

# create_bill_of_materials_import_job method usage example with argument unpacking

kwargs: CreateBillOfMaterialsImportJobRequestRequestTypeDef = {  # (1)
    "instanceId": ...,
    "s3uri": ...,
}

parent.create_bill_of_materials_import_job(**kwargs)

See CreateBillOfMaterialsImportJobRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("supplychain").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_bill_of_materials_import_job#

Get status and details of a BillOfMaterialsImportJob.

Type annotations and code completion for boto3.client("supplychain").get_bill_of_materials_import_job method. boto3 documentation

# get_bill_of_materials_import_job method definition

def get_bill_of_materials_import_job(
    self,
    *,
    instanceId: str,
    jobId: str,
) -> GetBillOfMaterialsImportJobResponseTypeDef:  # (1)
    ...

See GetBillOfMaterialsImportJobResponseTypeDef

# get_bill_of_materials_import_job method usage example with argument unpacking

kwargs: GetBillOfMaterialsImportJobRequestRequestTypeDef = {  # (1)
    "instanceId": ...,
    "jobId": ...,
}

parent.get_bill_of_materials_import_job(**kwargs)

See GetBillOfMaterialsImportJobRequestRequestTypeDef

send_data_integration_event#

Send transactional data events with real-time data for analysis or monitoring.

Type annotations and code completion for boto3.client("supplychain").send_data_integration_event method. boto3 documentation

# send_data_integration_event method definition

def send_data_integration_event(
    self,
    *,
    instanceId: str,
    eventType: DataIntegrationEventTypeType,  # (1)
    data: str,
    eventGroupId: str,
    eventTimestamp: Union[datetime, str] = ...,
    clientToken: str = ...,
) -> SendDataIntegrationEventResponseTypeDef:  # (2)
    ...

# send_data_integration_event method usage example with argument unpacking

kwargs: SendDataIntegrationEventRequestRequestTypeDef = {  # (1)
    "instanceId": ...,
    "eventType": ...,
    "data": ...,
    "eventGroupId": ...,
}

parent.send_data_integration_event(**kwargs)

See SendDataIntegrationEventRequestRequestTypeDef