Typed dictionaries#
Index > ImportExport > Typed dictionaries
Auto-generated documentation for ImportExport type annotations stubs module mypy-boto3-importexport.
ArtifactTypeDef#
# ArtifactTypeDef usage example
from mypy_boto3_importexport.type_defs import ArtifactTypeDef
def get_value() -> ArtifactTypeDef:
return {
"Description": ...,
}
# ArtifactTypeDef definition
class ArtifactTypeDef(TypedDict):
Description: NotRequired[str],
URL: NotRequired[str],
CancelJobInputRequestTypeDef#
# CancelJobInputRequestTypeDef usage example
from mypy_boto3_importexport.type_defs import CancelJobInputRequestTypeDef
def get_value() -> CancelJobInputRequestTypeDef:
return {
"JobId": ...,
}
# CancelJobInputRequestTypeDef definition
class CancelJobInputRequestTypeDef(TypedDict):
JobId: str,
APIVersion: NotRequired[str],
CancelJobOutputTypeDef#
# CancelJobOutputTypeDef usage example
from mypy_boto3_importexport.type_defs import CancelJobOutputTypeDef
def get_value() -> CancelJobOutputTypeDef:
return {
"Success": ...,
"ResponseMetadata": ...,
}
# CancelJobOutputTypeDef definition
class CancelJobOutputTypeDef(TypedDict):
Success: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateJobInputRequestTypeDef#
# CreateJobInputRequestTypeDef usage example
from mypy_boto3_importexport.type_defs import CreateJobInputRequestTypeDef
def get_value() -> CreateJobInputRequestTypeDef:
return {
"JobType": ...,
"Manifest": ...,
"ValidateOnly": ...,
}
# CreateJobInputRequestTypeDef definition
class CreateJobInputRequestTypeDef(TypedDict):
JobType: JobTypeType, # (1)
Manifest: str,
ValidateOnly: bool,
ManifestAddendum: NotRequired[str],
APIVersion: NotRequired[str],
- See JobTypeType
GetShippingLabelInputRequestTypeDef#
# GetShippingLabelInputRequestTypeDef usage example
from mypy_boto3_importexport.type_defs import GetShippingLabelInputRequestTypeDef
def get_value() -> GetShippingLabelInputRequestTypeDef:
return {
"jobIds": ...,
}
# 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],
GetShippingLabelOutputTypeDef#
# GetShippingLabelOutputTypeDef usage example
from mypy_boto3_importexport.type_defs import GetShippingLabelOutputTypeDef
def get_value() -> GetShippingLabelOutputTypeDef:
return {
"ShippingLabelURL": ...,
"Warning": ...,
"ResponseMetadata": ...,
}
# GetShippingLabelOutputTypeDef definition
class GetShippingLabelOutputTypeDef(TypedDict):
ShippingLabelURL: str,
Warning: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetStatusInputRequestTypeDef#
# GetStatusInputRequestTypeDef usage example
from mypy_boto3_importexport.type_defs import GetStatusInputRequestTypeDef
def get_value() -> GetStatusInputRequestTypeDef:
return {
"JobId": ...,
}
# GetStatusInputRequestTypeDef definition
class GetStatusInputRequestTypeDef(TypedDict):
JobId: str,
APIVersion: NotRequired[str],
JobTypeDef#
# JobTypeDef usage example
from mypy_boto3_importexport.type_defs import JobTypeDef
def get_value() -> JobTypeDef:
return {
"JobId": ...,
}
# JobTypeDef definition
class JobTypeDef(TypedDict):
JobId: NotRequired[str],
CreationDate: NotRequired[datetime],
IsCanceled: NotRequired[bool],
JobType: NotRequired[JobTypeType], # (1)
- See JobTypeType
ListJobsInputListJobsPaginateTypeDef#
# ListJobsInputListJobsPaginateTypeDef usage example
from mypy_boto3_importexport.type_defs import ListJobsInputListJobsPaginateTypeDef
def get_value() -> ListJobsInputListJobsPaginateTypeDef:
return {
"APIVersion": ...,
}
# ListJobsInputListJobsPaginateTypeDef definition
class ListJobsInputListJobsPaginateTypeDef(TypedDict):
APIVersion: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListJobsInputRequestTypeDef#
# ListJobsInputRequestTypeDef usage example
from mypy_boto3_importexport.type_defs import ListJobsInputRequestTypeDef
def get_value() -> ListJobsInputRequestTypeDef:
return {
"MaxJobs": ...,
}
# ListJobsInputRequestTypeDef definition
class ListJobsInputRequestTypeDef(TypedDict):
MaxJobs: NotRequired[int],
Marker: NotRequired[str],
APIVersion: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_importexport.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_importexport.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
UpdateJobInputRequestTypeDef#
# UpdateJobInputRequestTypeDef usage example
from mypy_boto3_importexport.type_defs import UpdateJobInputRequestTypeDef
def get_value() -> UpdateJobInputRequestTypeDef:
return {
"JobId": ...,
"Manifest": ...,
"JobType": ...,
"ValidateOnly": ...,
}
# UpdateJobInputRequestTypeDef definition
class UpdateJobInputRequestTypeDef(TypedDict):
JobId: str,
Manifest: str,
JobType: JobTypeType, # (1)
ValidateOnly: bool,
APIVersion: NotRequired[str],
- See JobTypeType
CreateJobOutputTypeDef#
# CreateJobOutputTypeDef usage example
from mypy_boto3_importexport.type_defs import CreateJobOutputTypeDef
def get_value() -> CreateJobOutputTypeDef:
return {
"JobId": ...,
"JobType": ...,
"Signature": ...,
"SignatureFileContents": ...,
"WarningMessage": ...,
"ArtifactList": ...,
"ResponseMetadata": ...,
}
# CreateJobOutputTypeDef definition
class CreateJobOutputTypeDef(TypedDict):
JobId: str,
JobType: JobTypeType, # (1)
Signature: str,
SignatureFileContents: str,
WarningMessage: str,
ArtifactList: List[ArtifactTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See JobTypeType
- See ArtifactTypeDef
- See ResponseMetadataTypeDef
GetStatusOutputTypeDef#
# GetStatusOutputTypeDef usage example
from mypy_boto3_importexport.type_defs import GetStatusOutputTypeDef
def get_value() -> GetStatusOutputTypeDef:
return {
"JobId": ...,
"JobType": ...,
"LocationCode": ...,
"LocationMessage": ...,
"ProgressCode": ...,
"ProgressMessage": ...,
"Carrier": ...,
"TrackingNumber": ...,
"LogBucket": ...,
"LogKey": ...,
"ErrorCount": ...,
"Signature": ...,
"SignatureFileContents": ...,
"CurrentManifest": ...,
"CreationDate": ...,
"ArtifactList": ...,
"ResponseMetadata": ...,
}
# 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)
- See JobTypeType
- See ArtifactTypeDef
- See ResponseMetadataTypeDef
UpdateJobOutputTypeDef#
# UpdateJobOutputTypeDef usage example
from mypy_boto3_importexport.type_defs import UpdateJobOutputTypeDef
def get_value() -> UpdateJobOutputTypeDef:
return {
"Success": ...,
"WarningMessage": ...,
"ArtifactList": ...,
"ResponseMetadata": ...,
}
# UpdateJobOutputTypeDef definition
class UpdateJobOutputTypeDef(TypedDict):
Success: bool,
WarningMessage: str,
ArtifactList: List[ArtifactTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListJobsOutputTypeDef#
# ListJobsOutputTypeDef usage example
from mypy_boto3_importexport.type_defs import ListJobsOutputTypeDef
def get_value() -> ListJobsOutputTypeDef:
return {
"Jobs": ...,
"IsTruncated": ...,
"ResponseMetadata": ...,
}
# ListJobsOutputTypeDef definition
class ListJobsOutputTypeDef(TypedDict):
Jobs: List[JobTypeDef], # (1)
IsTruncated: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobTypeDef
- See ResponseMetadataTypeDef