Typed dictionaries

Index > Mobile > Typed dictionaries

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

BundleDetailsTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import BundleDetailsTypeDef

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

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

Usage Example

from mypy_boto3_mobile.type_defs import CreateProjectRequestRequestTypeDef

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

Definition

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

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

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

DeleteProjectRequestRequestTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import DeleteProjectRequestRequestTypeDef

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

Definition

class DeleteProjectRequestRequestTypeDef(TypedDict):
    projectId: str,

ResourceTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ResourceTypeDef

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

Definition

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

DescribeBundleRequestRequestTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import DescribeBundleRequestRequestTypeDef

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

Definition

class DescribeBundleRequestRequestTypeDef(TypedDict):
    bundleId: str,

DescribeProjectRequestRequestTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import DescribeProjectRequestRequestTypeDef

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

Definition

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

ExportBundleRequestRequestTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ExportBundleRequestRequestTypeDef

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

Definition

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

1. See PlatformType

ExportProjectRequestRequestTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ExportProjectRequestRequestTypeDef

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

Definition

class ExportProjectRequestRequestTypeDef(TypedDict):
    projectId: str,

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

Definition

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

ListBundlesRequestRequestTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ListBundlesRequestRequestTypeDef

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

Definition

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

ListProjectsRequestRequestTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ListProjectsRequestRequestTypeDef

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

Definition

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

ProjectSummaryTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ProjectSummaryTypeDef

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

Definition

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

UpdateProjectRequestRequestTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import UpdateProjectRequestRequestTypeDef

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

Definition

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

DescribeBundleResultTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import DescribeBundleResultTypeDef

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

Definition

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

1. See BundleDetailsTypeDef
2. See ResponseMetadataTypeDef

ExportBundleResultTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ExportBundleResultTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

ExportProjectResultTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ExportProjectResultTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

ListBundlesResultTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ListBundlesResultTypeDef

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

Definition

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

1. See BundleDetailsTypeDef
2. See ResponseMetadataTypeDef

DeleteProjectResultTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import DeleteProjectResultTypeDef

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

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

Usage Example

from mypy_boto3_mobile.type_defs import ProjectDetailsTypeDef

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

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

ListBundlesRequestListBundlesPaginateTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ListBundlesRequestListBundlesPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListProjectsRequestListProjectsPaginateTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ListProjectsRequestListProjectsPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListProjectsResultTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import ListProjectsResultTypeDef

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

Definition

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

1. See ProjectSummaryTypeDef
2. See ResponseMetadataTypeDef

CreateProjectResultTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import CreateProjectResultTypeDef

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

Definition

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

1. See ProjectDetailsTypeDef
2. See ResponseMetadataTypeDef

DescribeProjectResultTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import DescribeProjectResultTypeDef

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

Definition

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

1. See ProjectDetailsTypeDef
2. See ResponseMetadataTypeDef

UpdateProjectResultTypeDef

Usage Example

from mypy_boto3_mobile.type_defs import UpdateProjectResultTypeDef

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

Definition

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

1. See ProjectDetailsTypeDef
2. See ResponseMetadataTypeDef