Skip to content

Type definitions#

Index > IoT1ClickProjects > Type definitions

Auto-generated documentation for IoT1ClickProjects type annotations stubs module mypy-boto3-iot1click-projects.

AssociateDeviceWithPlacementRequestRequestTypeDef#

# AssociateDeviceWithPlacementRequestRequestTypeDef definition

class AssociateDeviceWithPlacementRequestRequestTypeDef(TypedDict):
    projectName: str,
    placementName: str,
    deviceId: str,
    deviceTemplateName: str,

CreatePlacementRequestRequestTypeDef#

# CreatePlacementRequestRequestTypeDef definition

class CreatePlacementRequestRequestTypeDef(TypedDict):
    placementName: str,
    projectName: str,
    attributes: NotRequired[Mapping[str, str]],

DeletePlacementRequestRequestTypeDef#

# DeletePlacementRequestRequestTypeDef definition

class DeletePlacementRequestRequestTypeDef(TypedDict):
    placementName: str,
    projectName: str,

DeleteProjectRequestRequestTypeDef#

# DeleteProjectRequestRequestTypeDef definition

class DeleteProjectRequestRequestTypeDef(TypedDict):
    projectName: str,

DescribePlacementRequestRequestTypeDef#

# DescribePlacementRequestRequestTypeDef definition

class DescribePlacementRequestRequestTypeDef(TypedDict):
    placementName: str,
    projectName: str,

PlacementDescriptionTypeDef#

# PlacementDescriptionTypeDef definition

class PlacementDescriptionTypeDef(TypedDict):
    projectName: str,
    placementName: str,
    attributes: Dict[str, str],
    createdDate: datetime,
    updatedDate: datetime,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DescribeProjectRequestRequestTypeDef#

# DescribeProjectRequestRequestTypeDef definition

class DescribeProjectRequestRequestTypeDef(TypedDict):
    projectName: str,

DeviceTemplateTypeDef#

# DeviceTemplateTypeDef definition

class DeviceTemplateTypeDef(TypedDict):
    deviceType: NotRequired[str],
    callbackOverrides: NotRequired[Mapping[str, str]],

DisassociateDeviceFromPlacementRequestRequestTypeDef#

# DisassociateDeviceFromPlacementRequestRequestTypeDef definition

class DisassociateDeviceFromPlacementRequestRequestTypeDef(TypedDict):
    projectName: str,
    placementName: str,
    deviceTemplateName: str,

GetDevicesInPlacementRequestRequestTypeDef#

# GetDevicesInPlacementRequestRequestTypeDef definition

class GetDevicesInPlacementRequestRequestTypeDef(TypedDict):
    projectName: str,
    placementName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListPlacementsRequestRequestTypeDef#

# ListPlacementsRequestRequestTypeDef definition

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

PlacementSummaryTypeDef#

# PlacementSummaryTypeDef definition

class PlacementSummaryTypeDef(TypedDict):
    projectName: str,
    placementName: str,
    createdDate: datetime,
    updatedDate: datetime,

ListProjectsRequestRequestTypeDef#

# ListProjectsRequestRequestTypeDef definition

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

ProjectSummaryTypeDef#

# ProjectSummaryTypeDef definition

class ProjectSummaryTypeDef(TypedDict):
    projectName: str,
    createdDate: datetime,
    updatedDate: datetime,
    arn: NotRequired[str],
    tags: NotRequired[Dict[str, str]],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdatePlacementRequestRequestTypeDef#

# UpdatePlacementRequestRequestTypeDef definition

class UpdatePlacementRequestRequestTypeDef(TypedDict):
    placementName: str,
    projectName: str,
    attributes: NotRequired[Mapping[str, str]],

DescribePlacementResponseTypeDef#

# DescribePlacementResponseTypeDef definition

class DescribePlacementResponseTypeDef(TypedDict):
    placement: PlacementDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PlacementDescriptionTypeDef
  2. See ResponseMetadataTypeDef

GetDevicesInPlacementResponseTypeDef#

# GetDevicesInPlacementResponseTypeDef definition

class GetDevicesInPlacementResponseTypeDef(TypedDict):
    devices: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PlacementTemplateTypeDef#

# PlacementTemplateTypeDef definition

class PlacementTemplateTypeDef(TypedDict):
    defaultAttributes: NotRequired[Mapping[str, str]],
    deviceTemplates: NotRequired[Mapping[str, DeviceTemplateTypeDef]],  # (1)
  1. See DeviceTemplateTypeDef

ListPlacementsRequestListPlacementsPaginateTypeDef#

# ListPlacementsRequestListPlacementsPaginateTypeDef definition

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

ListProjectsRequestListProjectsPaginateTypeDef#

# ListProjectsRequestListProjectsPaginateTypeDef definition

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

ListPlacementsResponseTypeDef#

# ListPlacementsResponseTypeDef definition

class ListPlacementsResponseTypeDef(TypedDict):
    placements: List[PlacementSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PlacementSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListProjectsResponseTypeDef#

# ListProjectsResponseTypeDef definition

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

CreateProjectRequestRequestTypeDef#

# CreateProjectRequestRequestTypeDef definition

class CreateProjectRequestRequestTypeDef(TypedDict):
    projectName: str,
    description: NotRequired[str],
    placementTemplate: NotRequired[PlacementTemplateTypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See PlacementTemplateTypeDef

ProjectDescriptionTypeDef#

# ProjectDescriptionTypeDef definition

class ProjectDescriptionTypeDef(TypedDict):
    projectName: str,
    createdDate: datetime,
    updatedDate: datetime,
    arn: NotRequired[str],
    description: NotRequired[str],
    placementTemplate: NotRequired[PlacementTemplateTypeDef],  # (1)
    tags: NotRequired[Dict[str, str]],
  1. See PlacementTemplateTypeDef

UpdateProjectRequestRequestTypeDef#

# UpdateProjectRequestRequestTypeDef definition

class UpdateProjectRequestRequestTypeDef(TypedDict):
    projectName: str,
    description: NotRequired[str],
    placementTemplate: NotRequired[PlacementTemplateTypeDef],  # (1)
  1. See PlacementTemplateTypeDef

DescribeProjectResponseTypeDef#

# DescribeProjectResponseTypeDef definition

class DescribeProjectResponseTypeDef(TypedDict):
    project: ProjectDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectDescriptionTypeDef
  2. See ResponseMetadataTypeDef