Skip to content

Typed dictionaries#

Index > Mobile > Typed dictionaries

Auto-generated documentation for Mobile type annotations stubs module mypy-boto3-mobile.

BundleDetailsTypeDef#

# BundleDetailsTypeDef usage example

from mypy_boto3_mobile.type_defs import BundleDetailsTypeDef

def get_value() -> BundleDetailsTypeDef:
    return {
        "bundleId": ...,
    }
# BundleDetailsTypeDef definition

class BundleDetailsTypeDef(TypedDict):
    bundleId: NotRequired[str],
    title: NotRequired[str],
    version: NotRequired[str],
    description: NotRequired[str],
    iconUrl: NotRequired[str],
    availablePlatforms: NotRequired[List[PlatformType]],  # (1)
  1. See PlatformType

CreateProjectRequestRequestTypeDef#

# CreateProjectRequestRequestTypeDef usage example

from mypy_boto3_mobile.type_defs import CreateProjectRequestRequestTypeDef

def get_value() -> CreateProjectRequestRequestTypeDef:
    return {
        "name": ...,
    }
# CreateProjectRequestRequestTypeDef definition

class CreateProjectRequestRequestTypeDef(TypedDict):
    name: NotRequired[str],
    region: NotRequired[str],
    contents: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
    snapshotId: NotRequired[str],

DeleteProjectRequestRequestTypeDef#

# DeleteProjectRequestRequestTypeDef usage example

from mypy_boto3_mobile.type_defs import DeleteProjectRequestRequestTypeDef

def get_value() -> DeleteProjectRequestRequestTypeDef:
    return {
        "projectId": ...,
    }
# DeleteProjectRequestRequestTypeDef definition

class DeleteProjectRequestRequestTypeDef(TypedDict):
    projectId: str,

ResourceTypeDef#

# ResourceTypeDef usage example

from mypy_boto3_mobile.type_defs import ResourceTypeDef

def get_value() -> ResourceTypeDef:
    return {
        "type": ...,
    }
# ResourceTypeDef definition

class ResourceTypeDef(TypedDict):
    type: NotRequired[str],
    name: NotRequired[str],
    arn: NotRequired[str],
    feature: NotRequired[str],
    attributes: NotRequired[Dict[str, str]],

DescribeBundleRequestRequestTypeDef#

# DescribeBundleRequestRequestTypeDef usage example

from mypy_boto3_mobile.type_defs import DescribeBundleRequestRequestTypeDef

def get_value() -> DescribeBundleRequestRequestTypeDef:
    return {
        "bundleId": ...,
    }
# DescribeBundleRequestRequestTypeDef definition

class DescribeBundleRequestRequestTypeDef(TypedDict):
    bundleId: str,

DescribeProjectRequestRequestTypeDef#

# DescribeProjectRequestRequestTypeDef usage example

from mypy_boto3_mobile.type_defs import DescribeProjectRequestRequestTypeDef

def get_value() -> DescribeProjectRequestRequestTypeDef:
    return {
        "projectId": ...,
    }
# DescribeProjectRequestRequestTypeDef definition

class DescribeProjectRequestRequestTypeDef(TypedDict):
    projectId: str,
    syncFromResources: NotRequired[bool],

ExportBundleRequestRequestTypeDef#

# ExportBundleRequestRequestTypeDef usage example

from mypy_boto3_mobile.type_defs import ExportBundleRequestRequestTypeDef

def get_value() -> ExportBundleRequestRequestTypeDef:
    return {
        "bundleId": ...,
    }
# ExportBundleRequestRequestTypeDef definition

class ExportBundleRequestRequestTypeDef(TypedDict):
    bundleId: str,
    projectId: NotRequired[str],
    platform: NotRequired[PlatformType],  # (1)
  1. See PlatformType

ExportBundleResultTypeDef#

# ExportBundleResultTypeDef usage example

from mypy_boto3_mobile.type_defs import ExportBundleResultTypeDef

def get_value() -> ExportBundleResultTypeDef:
    return {
        "downloadUrl": ...,
        "ResponseMetadata": ...,
    }
# ExportBundleResultTypeDef definition

class ExportBundleResultTypeDef(TypedDict):
    downloadUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExportProjectRequestRequestTypeDef#

# ExportProjectRequestRequestTypeDef usage example

from mypy_boto3_mobile.type_defs import ExportProjectRequestRequestTypeDef

def get_value() -> ExportProjectRequestRequestTypeDef:
    return {
        "projectId": ...,
    }
# ExportProjectRequestRequestTypeDef definition

class ExportProjectRequestRequestTypeDef(TypedDict):
    projectId: str,

ExportProjectResultTypeDef#

# ExportProjectResultTypeDef usage example

from mypy_boto3_mobile.type_defs import ExportProjectResultTypeDef

def get_value() -> ExportProjectResultTypeDef:
    return {
        "downloadUrl": ...,
        "shareUrl": ...,
        "snapshotId": ...,
        "ResponseMetadata": ...,
    }
# ExportProjectResultTypeDef definition

class ExportProjectResultTypeDef(TypedDict):
    downloadUrl: str,
    shareUrl: str,
    snapshotId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListBundlesRequestListBundlesPaginateTypeDef#

# ListBundlesRequestListBundlesPaginateTypeDef usage example

from mypy_boto3_mobile.type_defs import ListBundlesRequestListBundlesPaginateTypeDef

def get_value() -> ListBundlesRequestListBundlesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
# ListBundlesRequestListBundlesPaginateTypeDef definition

class ListBundlesRequestListBundlesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListBundlesRequestRequestTypeDef#

# ListBundlesRequestRequestTypeDef usage example

from mypy_boto3_mobile.type_defs import ListBundlesRequestRequestTypeDef

def get_value() -> ListBundlesRequestRequestTypeDef:
    return {
        "maxResults": ...,
    }
# ListBundlesRequestRequestTypeDef definition

class ListBundlesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListProjectsRequestListProjectsPaginateTypeDef#

# ListProjectsRequestListProjectsPaginateTypeDef usage example

from mypy_boto3_mobile.type_defs import ListProjectsRequestListProjectsPaginateTypeDef

def get_value() -> ListProjectsRequestListProjectsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
# ListProjectsRequestListProjectsPaginateTypeDef definition

class ListProjectsRequestListProjectsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListProjectsRequestRequestTypeDef#

# ListProjectsRequestRequestTypeDef usage example

from mypy_boto3_mobile.type_defs import ListProjectsRequestRequestTypeDef

def get_value() -> ListProjectsRequestRequestTypeDef:
    return {
        "maxResults": ...,
    }
# ListProjectsRequestRequestTypeDef definition

class ListProjectsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ProjectSummaryTypeDef#

# ProjectSummaryTypeDef usage example

from mypy_boto3_mobile.type_defs import ProjectSummaryTypeDef

def get_value() -> ProjectSummaryTypeDef:
    return {
        "name": ...,
    }
# ProjectSummaryTypeDef definition

class ProjectSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    projectId: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_mobile.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_mobile.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,

UpdateProjectRequestRequestTypeDef#

# UpdateProjectRequestRequestTypeDef usage example

from mypy_boto3_mobile.type_defs import UpdateProjectRequestRequestTypeDef

def get_value() -> UpdateProjectRequestRequestTypeDef:
    return {
        "projectId": ...,
    }
# UpdateProjectRequestRequestTypeDef definition

class UpdateProjectRequestRequestTypeDef(TypedDict):
    projectId: str,
    contents: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],

DescribeBundleResultTypeDef#

# DescribeBundleResultTypeDef usage example

from mypy_boto3_mobile.type_defs import DescribeBundleResultTypeDef

def get_value() -> DescribeBundleResultTypeDef:
    return {
        "details": ...,
        "ResponseMetadata": ...,
    }
# DescribeBundleResultTypeDef definition

class DescribeBundleResultTypeDef(TypedDict):
    details: BundleDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BundleDetailsTypeDef
  2. See ResponseMetadataTypeDef

ListBundlesResultTypeDef#

# ListBundlesResultTypeDef usage example

from mypy_boto3_mobile.type_defs import ListBundlesResultTypeDef

def get_value() -> ListBundlesResultTypeDef:
    return {
        "bundleList": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# ListBundlesResultTypeDef definition

class ListBundlesResultTypeDef(TypedDict):
    bundleList: List[BundleDetailsTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BundleDetailsTypeDef
  2. See ResponseMetadataTypeDef

DeleteProjectResultTypeDef#

# DeleteProjectResultTypeDef usage example

from mypy_boto3_mobile.type_defs import DeleteProjectResultTypeDef

def get_value() -> DeleteProjectResultTypeDef:
    return {
        "deletedResources": ...,
        "orphanedResources": ...,
        "ResponseMetadata": ...,
    }
# DeleteProjectResultTypeDef definition

class DeleteProjectResultTypeDef(TypedDict):
    deletedResources: List[ResourceTypeDef],  # (1)
    orphanedResources: List[ResourceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ResourceTypeDef
  2. See ResourceTypeDef
  3. See ResponseMetadataTypeDef

ProjectDetailsTypeDef#

# ProjectDetailsTypeDef usage example

from mypy_boto3_mobile.type_defs import ProjectDetailsTypeDef

def get_value() -> ProjectDetailsTypeDef:
    return {
        "name": ...,
    }
# ProjectDetailsTypeDef definition

class ProjectDetailsTypeDef(TypedDict):
    name: NotRequired[str],
    projectId: NotRequired[str],
    region: NotRequired[str],
    state: NotRequired[ProjectStateType],  # (1)
    createdDate: NotRequired[datetime],
    lastUpdatedDate: NotRequired[datetime],
    consoleUrl: NotRequired[str],
    resources: NotRequired[List[ResourceTypeDef]],  # (2)
  1. See ProjectStateType
  2. See ResourceTypeDef

ListProjectsResultTypeDef#

# ListProjectsResultTypeDef usage example

from mypy_boto3_mobile.type_defs import ListProjectsResultTypeDef

def get_value() -> ListProjectsResultTypeDef:
    return {
        "projects": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# ListProjectsResultTypeDef definition

class ListProjectsResultTypeDef(TypedDict):
    projects: List[ProjectSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateProjectResultTypeDef#

# CreateProjectResultTypeDef usage example

from mypy_boto3_mobile.type_defs import CreateProjectResultTypeDef

def get_value() -> CreateProjectResultTypeDef:
    return {
        "details": ...,
        "ResponseMetadata": ...,
    }
# CreateProjectResultTypeDef definition

class CreateProjectResultTypeDef(TypedDict):
    details: ProjectDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectDetailsTypeDef
  2. See ResponseMetadataTypeDef

DescribeProjectResultTypeDef#

# DescribeProjectResultTypeDef usage example

from mypy_boto3_mobile.type_defs import DescribeProjectResultTypeDef

def get_value() -> DescribeProjectResultTypeDef:
    return {
        "details": ...,
        "ResponseMetadata": ...,
    }
# DescribeProjectResultTypeDef definition

class DescribeProjectResultTypeDef(TypedDict):
    details: ProjectDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectDetailsTypeDef
  2. See ResponseMetadataTypeDef

UpdateProjectResultTypeDef#

# UpdateProjectResultTypeDef usage example

from mypy_boto3_mobile.type_defs import UpdateProjectResultTypeDef

def get_value() -> UpdateProjectResultTypeDef:
    return {
        "details": ...,
        "ResponseMetadata": ...,
    }
# UpdateProjectResultTypeDef definition

class UpdateProjectResultTypeDef(TypedDict):
    details: ProjectDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectDetailsTypeDef
  2. See ResponseMetadataTypeDef