Skip to content

ImportExportClient#

Index > ImportExport > ImportExportClient

Auto-generated documentation for ImportExport type annotations stubs module mypy-boto3-importexport.

ImportExportClient#

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

# ImportExportClient usage example

from boto3.session import Session
from mypy_boto3_importexport.client import ImportExportClient

def get_importexport_client() -> ImportExportClient:
    return Session().client("importexport")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("importexport")

try:
    do_something(client)
except (
    client.exceptions.BucketPermissionException,
    client.exceptions.CanceledJobIdException,
    client.exceptions.ClientError,
    client.exceptions.CreateJobQuotaExceededException,
    client.exceptions.ExpiredJobIdException,
    client.exceptions.InvalidAccessKeyIdException,
    client.exceptions.InvalidAddressException,
    client.exceptions.InvalidCustomsException,
    client.exceptions.InvalidFileSystemException,
    client.exceptions.InvalidJobIdException,
    client.exceptions.InvalidManifestFieldException,
    client.exceptions.InvalidParameterException,
    client.exceptions.InvalidVersionException,
    client.exceptions.MalformedManifestException,
    client.exceptions.MissingCustomsException,
    client.exceptions.MissingManifestFieldException,
    client.exceptions.MissingParameterException,
    client.exceptions.MultipleRegionsException,
    client.exceptions.NoSuchBucketException,
    client.exceptions.UnableToCancelJobIdException,
    client.exceptions.UnableToUpdateJobIdException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_importexport.client import Exceptions

def handle_error(exc: Exceptions.BucketPermissionException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("importexport").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_job#

This operation cancels a specified job.

Type annotations and code completion for boto3.client("importexport").cancel_job method. boto3 documentation

# cancel_job method definition

def cancel_job(
    self,
    *,
    JobId: str,
    APIVersion: str = ...,
) -> CancelJobOutputTypeDef:  # (1)
    ...
  1. See CancelJobOutputTypeDef 
# cancel_job method usage example with argument unpacking

kwargs: CancelJobInputRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.cancel_job(**kwargs)
  1. See CancelJobInputRequestTypeDef

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("importexport").close method. boto3 documentation

# close method definition

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

create_job#

This operation initiates the process of scheduling an upload or download of your data.

Type annotations and code completion for boto3.client("importexport").create_job method. boto3 documentation

# create_job method definition

def create_job(
    self,
    *,
    JobType: JobTypeType,  # (1)
    Manifest: str,
    ValidateOnly: bool,
    ManifestAddendum: str = ...,
    APIVersion: str = ...,
) -> CreateJobOutputTypeDef:  # (2)
    ...
  1. See JobTypeType
  2. See CreateJobOutputTypeDef 
# create_job method usage example with argument unpacking

kwargs: CreateJobInputRequestTypeDef = {  # (1)
    "JobType": ...,
    "Manifest": ...,
    "ValidateOnly": ...,
}

parent.create_job(**kwargs)
  1. See CreateJobInputRequestTypeDef

generate_presigned_url#

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

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

This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.

Type annotations and code completion for boto3.client("importexport").get_shipping_label method. boto3 documentation

# get_shipping_label method definition

def get_shipping_label(
    self,
    *,
    jobIds: Sequence[str],
    name: str = ...,
    company: str = ...,
    phoneNumber: str = ...,
    country: str = ...,
    stateOrProvince: str = ...,
    city: str = ...,
    postalCode: str = ...,
    street1: str = ...,
    street2: str = ...,
    street3: str = ...,
    APIVersion: str = ...,
) -> GetShippingLabelOutputTypeDef:  # (1)
    ...
  1. See GetShippingLabelOutputTypeDef 
# get_shipping_label method usage example with argument unpacking

kwargs: GetShippingLabelInputRequestTypeDef = {  # (1)
    "jobIds": ...,
}

parent.get_shipping_label(**kwargs)
  1. See GetShippingLabelInputRequestTypeDef

get_status#

This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job.

Type annotations and code completion for boto3.client("importexport").get_status method. boto3 documentation

# get_status method definition

def get_status(
    self,
    *,
    JobId: str,
    APIVersion: str = ...,
) -> GetStatusOutputTypeDef:  # (1)
    ...
  1. See GetStatusOutputTypeDef 
# get_status method usage example with argument unpacking

kwargs: GetStatusInputRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_status(**kwargs)
  1. See GetStatusInputRequestTypeDef

list_jobs#

This operation returns the jobs associated with the requester.

Type annotations and code completion for boto3.client("importexport").list_jobs method. boto3 documentation

# list_jobs method definition

def list_jobs(
    self,
    *,
    MaxJobs: int = ...,
    Marker: str = ...,
    APIVersion: str = ...,
) -> ListJobsOutputTypeDef:  # (1)
    ...
  1. See ListJobsOutputTypeDef 
# list_jobs method usage example with argument unpacking

kwargs: ListJobsInputRequestTypeDef = {  # (1)
    "MaxJobs": ...,
}

parent.list_jobs(**kwargs)
  1. See ListJobsInputRequestTypeDef

update_job#

You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file.

Type annotations and code completion for boto3.client("importexport").update_job method. boto3 documentation

# update_job method definition

def update_job(
    self,
    *,
    JobId: str,
    Manifest: str,
    JobType: JobTypeType,  # (1)
    ValidateOnly: bool,
    APIVersion: str = ...,
) -> UpdateJobOutputTypeDef:  # (2)
    ...
  1. See JobTypeType
  2. See UpdateJobOutputTypeDef 
# update_job method usage example with argument unpacking

kwargs: UpdateJobInputRequestTypeDef = {  # (1)
    "JobId": ...,
    "Manifest": ...,
    "JobType": ...,
    "ValidateOnly": ...,
}

parent.update_job(**kwargs)
  1. See UpdateJobInputRequestTypeDef

get_paginator#

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