Skip to content

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)
    ...
  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)
  1. See CreateBillOfMaterialsImportJobRequestRequestTypeDef

create_data_integration_flow#

Enables you to programmatically create a data pipeline to ingest data from source systems such as Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the API.

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

# create_data_integration_flow method definition

def create_data_integration_flow(
    self,
    *,
    instanceId: str,
    name: str,
    sources: Sequence[DataIntegrationFlowSourceTypeDef],  # (1)
    transformation: DataIntegrationFlowTransformationTypeDef,  # (2)
    target: DataIntegrationFlowTargetTypeDef,  # (3)
    tags: Mapping[str, str] = ...,
) -> CreateDataIntegrationFlowResponseTypeDef:  # (4)
    ...
  1. See DataIntegrationFlowSourceTypeDef
  2. See DataIntegrationFlowTransformationTypeDef
  3. See DataIntegrationFlowTargetTypeDef
  4. See CreateDataIntegrationFlowResponseTypeDef 
# create_data_integration_flow method usage example with argument unpacking

kwargs: CreateDataIntegrationFlowRequestRequestTypeDef = {  # (1)
    "instanceId": ...,
    "name": ...,
    "sources": ...,
    "transformation": ...,
    "target": ...,
}

parent.create_data_integration_flow(**kwargs)
  1. See CreateDataIntegrationFlowRequestRequestTypeDef

create_data_lake_dataset#

Enables you to programmatically create an Amazon Web Services Supply Chain data lake dataset.

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

# create_data_lake_dataset method definition

def create_data_lake_dataset(
    self,
    *,
    instanceId: str,
    namespace: str,
    name: str,
    schema: DataLakeDatasetSchemaTypeDef = ...,  # (1)
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateDataLakeDatasetResponseTypeDef:  # (2)
    ...
  1. See DataLakeDatasetSchemaTypeDef
  2. See CreateDataLakeDatasetResponseTypeDef 
# create_data_lake_dataset method usage example with argument unpacking

kwargs: CreateDataLakeDatasetRequestRequestTypeDef = {  # (1)
    "instanceId": ...,
    "namespace": ...,
    "name": ...,
}

parent.create_data_lake_dataset(**kwargs)
  1. See CreateDataLakeDatasetRequestRequestTypeDef

create_instance#

Enables you to programmatically create an Amazon Web Services Supply Chain instance by applying KMS keys and relevant information associated with the API without using the Amazon Web Services console.

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

# create_instance method definition

def create_instance(
    self,
    *,
    instanceName: str = ...,
    instanceDescription: str = ...,
    kmsKeyArn: str = ...,
    tags: Mapping[str, str] = ...,
    clientToken: str = ...,
) -> CreateInstanceResponseTypeDef:  # (1)
    ...
  1. See CreateInstanceResponseTypeDef 
# create_instance method usage example with argument unpacking

kwargs: CreateInstanceRequestRequestTypeDef = {  # (1)
    "instanceName": ...,
}

parent.create_instance(**kwargs)
  1. See CreateInstanceRequestRequestTypeDef

delete_data_integration_flow#

Enable you to programmatically delete an existing data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.

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

# delete_data_integration_flow method definition

def delete_data_integration_flow(
    self,
    *,
    instanceId: str,
    name: str,
) -> DeleteDataIntegrationFlowResponseTypeDef:  # (1)
    ...
  1. See DeleteDataIntegrationFlowResponseTypeDef 
# delete_data_integration_flow method usage example with argument unpacking

kwargs: DeleteDataIntegrationFlowRequestRequestTypeDef = {  # (1)
    "instanceId": ...,
    "name": ...,
}

parent.delete_data_integration_flow(**kwargs)
  1. See DeleteDataIntegrationFlowRequestRequestTypeDef

delete_data_lake_dataset#

Enables you to programmatically delete an Amazon Web Services Supply Chain data lake dataset.

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

# delete_data_lake_dataset method definition

def delete_data_lake_dataset(
    self,
    *,
    instanceId: str,
    namespace: str,
    name: str,
) -> DeleteDataLakeDatasetResponseTypeDef:  # (1)
    ...
  1. See DeleteDataLakeDatasetResponseTypeDef 
# delete_data_lake_dataset method usage example with argument unpacking

kwargs: DeleteDataLakeDatasetRequestRequestTypeDef = {  # (1)
    "instanceId": ...,
    "namespace": ...,
    "name": ...,
}

parent.delete_data_lake_dataset(**kwargs)
  1. See DeleteDataLakeDatasetRequestRequestTypeDef

delete_instance#

Enables you to programmatically delete an Amazon Web Services Supply Chain instance by deleting the KMS keys and relevant information associated with the API without using the Amazon Web Services console.

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

# delete_instance method definition

def delete_instance(
    self,
    *,
    instanceId: str,
) -> DeleteInstanceResponseTypeDef:  # (1)
    ...
  1. See DeleteInstanceResponseTypeDef 
# delete_instance method usage example with argument unpacking

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

parent.delete_instance(**kwargs)
  1. See DeleteInstanceRequestRequestTypeDef

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)
    ...
  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)
  1. See GetBillOfMaterialsImportJobRequestRequestTypeDef

get_data_integration_flow#

Enables you to programmatically view a specific data pipeline for the provided Amazon Web Services Supply Chain instance and DataIntegrationFlow name.

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

# get_data_integration_flow method definition

def get_data_integration_flow(
    self,
    *,
    instanceId: str,
    name: str,
) -> GetDataIntegrationFlowResponseTypeDef:  # (1)
    ...
  1. See GetDataIntegrationFlowResponseTypeDef 
# get_data_integration_flow method usage example with argument unpacking

kwargs: GetDataIntegrationFlowRequestRequestTypeDef = {  # (1)
    "instanceId": ...,
    "name": ...,
}

parent.get_data_integration_flow(**kwargs)
  1. See GetDataIntegrationFlowRequestRequestTypeDef

get_data_lake_dataset#

Enables you to programmatically view an Amazon Web Services Supply Chain data lake dataset.

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

# get_data_lake_dataset method definition

def get_data_lake_dataset(
    self,
    *,
    instanceId: str,
    namespace: str,
    name: str,
) -> GetDataLakeDatasetResponseTypeDef:  # (1)
    ...
  1. See GetDataLakeDatasetResponseTypeDef 
# get_data_lake_dataset method usage example with argument unpacking

kwargs: GetDataLakeDatasetRequestRequestTypeDef = {  # (1)
    "instanceId": ...,
    "namespace": ...,
    "name": ...,
}

parent.get_data_lake_dataset(**kwargs)
  1. See GetDataLakeDatasetRequestRequestTypeDef

get_instance#

Enables you to programmatically retrieve the information related to an Amazon Web Services Supply Chain instance ID.

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

# get_instance method definition

def get_instance(
    self,
    *,
    instanceId: str,
) -> GetInstanceResponseTypeDef:  # (1)
    ...
  1. See GetInstanceResponseTypeDef 
# get_instance method usage example with argument unpacking

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

parent.get_instance(**kwargs)
  1. See GetInstanceRequestRequestTypeDef

list_data_integration_flows#

Enables you to programmatically list all data pipelines for the provided Amazon Web Services Supply Chain instance.

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

# list_data_integration_flows method definition

def list_data_integration_flows(
    self,
    *,
    instanceId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDataIntegrationFlowsResponseTypeDef:  # (1)
    ...
  1. See ListDataIntegrationFlowsResponseTypeDef 
# list_data_integration_flows method usage example with argument unpacking

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

parent.list_data_integration_flows(**kwargs)
  1. See ListDataIntegrationFlowsRequestRequestTypeDef

list_data_lake_datasets#

Enables you to programmatically view the list of Amazon Web Services Supply Chain data lake datasets.

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

# list_data_lake_datasets method definition

def list_data_lake_datasets(
    self,
    *,
    instanceId: str,
    namespace: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDataLakeDatasetsResponseTypeDef:  # (1)
    ...
  1. See ListDataLakeDatasetsResponseTypeDef 
# list_data_lake_datasets method usage example with argument unpacking

kwargs: ListDataLakeDatasetsRequestRequestTypeDef = {  # (1)
    "instanceId": ...,
    "namespace": ...,
}

parent.list_data_lake_datasets(**kwargs)
  1. See ListDataLakeDatasetsRequestRequestTypeDef

list_instances#

List all Amazon Web Services Supply Chain instances for a specific account.

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

# list_instances method definition

def list_instances(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    instanceNameFilter: Sequence[str] = ...,
    instanceStateFilter: Sequence[InstanceStateType] = ...,  # (1)
) -> ListInstancesResponseTypeDef:  # (2)
    ...
  1. See InstanceStateType
  2. See ListInstancesResponseTypeDef 
# list_instances method usage example with argument unpacking

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

parent.list_instances(**kwargs)
  1. See ListInstancesRequestRequestTypeDef

list_tags_for_resource#

List all the tags for an Amazon Web ServicesSupply Chain resource.

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

send_data_integration_event#

Send the transactional data payload for the event 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: TimestampTypeDef = ...,
    clientToken: str = ...,
) -> SendDataIntegrationEventResponseTypeDef:  # (2)
    ...
  1. See DataIntegrationEventTypeType
  2. See SendDataIntegrationEventResponseTypeDef 
# send_data_integration_event method usage example with argument unpacking

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

parent.send_data_integration_event(**kwargs)
  1. See SendDataIntegrationEventRequestRequestTypeDef

tag_resource#

You can create tags during or after creating a resource such as instance, data flow, or dataset in AWS Supply chain.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

You can delete tags for an Amazon Web Services Supply chain resource such as instance, data flow, or dataset in AWS Supply Chain.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_data_integration_flow#

Enables you to programmatically update an existing data pipeline to ingest data from the source systems such as, Amazon S3 buckets, to a predefined Amazon Web Services Supply Chain dataset (product, inbound_order) or a temporary dataset along with the data transformation query provided with the A...

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

# update_data_integration_flow method definition

def update_data_integration_flow(
    self,
    *,
    instanceId: str,
    name: str,
    sources: Sequence[DataIntegrationFlowSourceTypeDef] = ...,  # (1)
    transformation: DataIntegrationFlowTransformationTypeDef = ...,  # (2)
    target: DataIntegrationFlowTargetTypeDef = ...,  # (3)
) -> UpdateDataIntegrationFlowResponseTypeDef:  # (4)
    ...
  1. See DataIntegrationFlowSourceTypeDef
  2. See DataIntegrationFlowTransformationTypeDef
  3. See DataIntegrationFlowTargetTypeDef
  4. See UpdateDataIntegrationFlowResponseTypeDef 
# update_data_integration_flow method usage example with argument unpacking

kwargs: UpdateDataIntegrationFlowRequestRequestTypeDef = {  # (1)
    "instanceId": ...,
    "name": ...,
}

parent.update_data_integration_flow(**kwargs)
  1. See UpdateDataIntegrationFlowRequestRequestTypeDef

update_data_lake_dataset#

Enables you to programmatically update an Amazon Web Services Supply Chain data lake dataset.

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

# update_data_lake_dataset method definition

def update_data_lake_dataset(
    self,
    *,
    instanceId: str,
    namespace: str,
    name: str,
    description: str = ...,
) -> UpdateDataLakeDatasetResponseTypeDef:  # (1)
    ...
  1. See UpdateDataLakeDatasetResponseTypeDef 
# update_data_lake_dataset method usage example with argument unpacking

kwargs: UpdateDataLakeDatasetRequestRequestTypeDef = {  # (1)
    "instanceId": ...,
    "namespace": ...,
    "name": ...,
}

parent.update_data_lake_dataset(**kwargs)
  1. See UpdateDataLakeDatasetRequestRequestTypeDef

update_instance#

Enables you to programmatically update an Amazon Web Services Supply Chain instance description by providing all the relevant information such as account ID, instance ID and so on without using the AWS console.

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

# update_instance method definition

def update_instance(
    self,
    *,
    instanceId: str,
    instanceName: str = ...,
    instanceDescription: str = ...,
) -> UpdateInstanceResponseTypeDef:  # (1)
    ...
  1. See UpdateInstanceResponseTypeDef 
# update_instance method usage example with argument unpacking

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

parent.update_instance(**kwargs)
  1. See UpdateInstanceRequestRequestTypeDef

get_paginator#

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