Skip to content

Type definitions#

Index > ImportExport > Type definitions

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

ArtifactTypeDef#

# ArtifactTypeDef definition

class ArtifactTypeDef(TypedDict):
    Description: NotRequired[str],
    URL: NotRequired[str],

CancelJobInputRequestTypeDef#

# CancelJobInputRequestTypeDef definition

class CancelJobInputRequestTypeDef(TypedDict):
    JobId: str,
    APIVersion: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CreateJobInputRequestTypeDef#

# CreateJobInputRequestTypeDef definition

class CreateJobInputRequestTypeDef(TypedDict):
    JobType: JobTypeType,  # (1)
    Manifest: str,
    ValidateOnly: bool,
    ManifestAddendum: NotRequired[str],
    APIVersion: NotRequired[str],
  1. See JobTypeType

GetShippingLabelInputRequestTypeDef#

# GetShippingLabelInputRequestTypeDef definition

class GetShippingLabelInputRequestTypeDef(TypedDict):
    jobIds: Sequence[str],
    name: NotRequired[str],
    company: NotRequired[str],
    phoneNumber: NotRequired[str],
    country: NotRequired[str],
    stateOrProvince: NotRequired[str],
    city: NotRequired[str],
    postalCode: NotRequired[str],
    street1: NotRequired[str],
    street2: NotRequired[str],
    street3: NotRequired[str],
    APIVersion: NotRequired[str],

GetStatusInputRequestTypeDef#

# GetStatusInputRequestTypeDef definition

class GetStatusInputRequestTypeDef(TypedDict):
    JobId: str,
    APIVersion: NotRequired[str],

JobTypeDef#

# JobTypeDef definition

class JobTypeDef(TypedDict):
    JobId: NotRequired[str],
    CreationDate: NotRequired[datetime],
    IsCanceled: NotRequired[bool],
    JobType: NotRequired[JobTypeType],  # (1)
  1. See JobTypeType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListJobsInputRequestTypeDef#

# ListJobsInputRequestTypeDef definition

class ListJobsInputRequestTypeDef(TypedDict):
    MaxJobs: NotRequired[int],
    Marker: NotRequired[str],
    APIVersion: NotRequired[str],

UpdateJobInputRequestTypeDef#

# UpdateJobInputRequestTypeDef definition

class UpdateJobInputRequestTypeDef(TypedDict):
    JobId: str,
    Manifest: str,
    JobType: JobTypeType,  # (1)
    ValidateOnly: bool,
    APIVersion: NotRequired[str],
  1. See JobTypeType

CancelJobOutputTypeDef#

# CancelJobOutputTypeDef definition

class CancelJobOutputTypeDef(TypedDict):
    Success: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateJobOutputTypeDef#

# CreateJobOutputTypeDef definition

class CreateJobOutputTypeDef(TypedDict):
    JobId: str,
    JobType: JobTypeType,  # (1)
    Signature: str,
    SignatureFileContents: str,
    WarningMessage: str,
    ArtifactList: List[ArtifactTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See JobTypeType
  2. See ArtifactTypeDef
  3. See ResponseMetadataTypeDef

GetShippingLabelOutputTypeDef#

# GetShippingLabelOutputTypeDef definition

class GetShippingLabelOutputTypeDef(TypedDict):
    ShippingLabelURL: str,
    Warning: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetStatusOutputTypeDef#

# GetStatusOutputTypeDef definition

class GetStatusOutputTypeDef(TypedDict):
    JobId: str,
    JobType: JobTypeType,  # (1)
    LocationCode: str,
    LocationMessage: str,
    ProgressCode: str,
    ProgressMessage: str,
    Carrier: str,
    TrackingNumber: str,
    LogBucket: str,
    LogKey: str,
    ErrorCount: int,
    Signature: str,
    SignatureFileContents: str,
    CurrentManifest: str,
    CreationDate: datetime,
    ArtifactList: List[ArtifactTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See JobTypeType
  2. See ArtifactTypeDef
  3. See ResponseMetadataTypeDef

UpdateJobOutputTypeDef#

# UpdateJobOutputTypeDef definition

class UpdateJobOutputTypeDef(TypedDict):
    Success: bool,
    WarningMessage: str,
    ArtifactList: List[ArtifactTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ArtifactTypeDef
  2. See ResponseMetadataTypeDef

ListJobsOutputTypeDef#

# ListJobsOutputTypeDef definition

class ListJobsOutputTypeDef(TypedDict):
    Jobs: List[JobTypeDef],  # (1)
    IsTruncated: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobTypeDef
  2. See ResponseMetadataTypeDef

ListJobsInputListJobsPaginateTypeDef#

# ListJobsInputListJobsPaginateTypeDef definition

class ListJobsInputListJobsPaginateTypeDef(TypedDict):
    APIVersion: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef