Type definitions#
Index > GreengrassV2 > Type definitions
Auto-generated documentation for GreengrassV2 type annotations stubs module mypy-boto3-greengrassv2.
BlobTypeDef#
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
AssociateClientDeviceWithCoreDeviceEntryTypeDef#
# AssociateClientDeviceWithCoreDeviceEntryTypeDef definition
class AssociateClientDeviceWithCoreDeviceEntryTypeDef(TypedDict):
thingName: str,
AssociateClientDeviceWithCoreDeviceErrorEntryTypeDef#
# AssociateClientDeviceWithCoreDeviceErrorEntryTypeDef definition
class AssociateClientDeviceWithCoreDeviceErrorEntryTypeDef(TypedDict):
thingName: NotRequired[str],
code: NotRequired[str],
message: NotRequired[str],
AssociateServiceRoleToAccountRequestRequestTypeDef#
# AssociateServiceRoleToAccountRequestRequestTypeDef definition
class AssociateServiceRoleToAccountRequestRequestTypeDef(TypedDict):
roleArn: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
AssociatedClientDeviceTypeDef#
# AssociatedClientDeviceTypeDef definition
class AssociatedClientDeviceTypeDef(TypedDict):
thingName: NotRequired[str],
associationTimestamp: NotRequired[datetime],
DisassociateClientDeviceFromCoreDeviceEntryTypeDef#
# DisassociateClientDeviceFromCoreDeviceEntryTypeDef definition
class DisassociateClientDeviceFromCoreDeviceEntryTypeDef(TypedDict):
thingName: str,
DisassociateClientDeviceFromCoreDeviceErrorEntryTypeDef#
# DisassociateClientDeviceFromCoreDeviceErrorEntryTypeDef definition
class DisassociateClientDeviceFromCoreDeviceErrorEntryTypeDef(TypedDict):
thingName: NotRequired[str],
code: NotRequired[str],
message: NotRequired[str],
CancelDeploymentRequestRequestTypeDef#
# CancelDeploymentRequestRequestTypeDef definition
class CancelDeploymentRequestRequestTypeDef(TypedDict):
deploymentId: str,
CloudComponentStatusTypeDef#
# CloudComponentStatusTypeDef definition
class CloudComponentStatusTypeDef(TypedDict):
componentState: NotRequired[CloudComponentStateType], # (1)
message: NotRequired[str],
errors: NotRequired[Dict[str, str]],
vendorGuidance: NotRequired[VendorGuidanceType], # (2)
vendorGuidanceMessage: NotRequired[str],
ComponentCandidateTypeDef#
# ComponentCandidateTypeDef definition
class ComponentCandidateTypeDef(TypedDict):
componentName: NotRequired[str],
componentVersion: NotRequired[str],
versionRequirements: NotRequired[Mapping[str, str]],
ComponentConfigurationUpdateTypeDef#
# ComponentConfigurationUpdateTypeDef definition
class ComponentConfigurationUpdateTypeDef(TypedDict):
merge: NotRequired[str],
reset: NotRequired[Sequence[str]],
ComponentDependencyRequirementTypeDef#
# ComponentDependencyRequirementTypeDef definition
class ComponentDependencyRequirementTypeDef(TypedDict):
versionRequirement: NotRequired[str],
dependencyType: NotRequired[ComponentDependencyTypeType], # (1)
ComponentPlatformPaginatorTypeDef#
# ComponentPlatformPaginatorTypeDef definition
class ComponentPlatformPaginatorTypeDef(TypedDict):
name: NotRequired[str],
attributes: NotRequired[Dict[str, str]],
ComponentPlatformTypeDef#
# ComponentPlatformTypeDef definition
class ComponentPlatformTypeDef(TypedDict):
name: NotRequired[str],
attributes: NotRequired[Mapping[str, str]],
SystemResourceLimitsTypeDef#
# SystemResourceLimitsTypeDef definition
class SystemResourceLimitsTypeDef(TypedDict):
memory: NotRequired[int],
cpus: NotRequired[float],
ComponentVersionListItemTypeDef#
# ComponentVersionListItemTypeDef definition
class ComponentVersionListItemTypeDef(TypedDict):
componentName: NotRequired[str],
componentVersion: NotRequired[str],
arn: NotRequired[str],
ConnectivityInfoTypeDef#
# ConnectivityInfoTypeDef definition
class ConnectivityInfoTypeDef(TypedDict):
id: NotRequired[str],
hostAddress: NotRequired[str],
portNumber: NotRequired[int],
metadata: NotRequired[str],
CoreDeviceTypeDef#
# CoreDeviceTypeDef definition
class CoreDeviceTypeDef(TypedDict):
coreDeviceThingName: NotRequired[str],
status: NotRequired[CoreDeviceStatusType], # (1)
lastStatusUpdateTimestamp: NotRequired[datetime],
DeleteComponentRequestRequestTypeDef#
# DeleteComponentRequestRequestTypeDef definition
class DeleteComponentRequestRequestTypeDef(TypedDict):
arn: str,
DeleteCoreDeviceRequestRequestTypeDef#
# DeleteCoreDeviceRequestRequestTypeDef definition
class DeleteCoreDeviceRequestRequestTypeDef(TypedDict):
coreDeviceThingName: str,
DeleteDeploymentRequestRequestTypeDef#
# DeleteDeploymentRequestRequestTypeDef definition
class DeleteDeploymentRequestRequestTypeDef(TypedDict):
deploymentId: str,
DeploymentComponentUpdatePolicyTypeDef#
# DeploymentComponentUpdatePolicyTypeDef definition
class DeploymentComponentUpdatePolicyTypeDef(TypedDict):
timeoutInSeconds: NotRequired[int],
action: NotRequired[DeploymentComponentUpdatePolicyActionType], # (1)
DeploymentConfigurationValidationPolicyTypeDef#
# DeploymentConfigurationValidationPolicyTypeDef definition
class DeploymentConfigurationValidationPolicyTypeDef(TypedDict):
timeoutInSeconds: NotRequired[int],
IoTJobTimeoutConfigTypeDef#
# IoTJobTimeoutConfigTypeDef definition
class IoTJobTimeoutConfigTypeDef(TypedDict):
inProgressTimeoutInMinutes: NotRequired[int],
DeploymentTypeDef#
# DeploymentTypeDef definition
class DeploymentTypeDef(TypedDict):
targetArn: NotRequired[str],
revisionId: NotRequired[str],
deploymentId: NotRequired[str],
deploymentName: NotRequired[str],
creationTimestamp: NotRequired[datetime],
deploymentStatus: NotRequired[DeploymentStatusType], # (1)
isLatestForTarget: NotRequired[bool],
parentTargetArn: NotRequired[str],
DescribeComponentRequestRequestTypeDef#
# DescribeComponentRequestRequestTypeDef definition
class DescribeComponentRequestRequestTypeDef(TypedDict):
arn: str,
EffectiveDeploymentStatusDetailsTypeDef#
# EffectiveDeploymentStatusDetailsTypeDef definition
class EffectiveDeploymentStatusDetailsTypeDef(TypedDict):
errorStack: NotRequired[List[str]],
errorTypes: NotRequired[List[str]],
GetComponentRequestRequestTypeDef#
# GetComponentRequestRequestTypeDef definition
class GetComponentRequestRequestTypeDef(TypedDict):
arn: str,
recipeOutputFormat: NotRequired[RecipeOutputFormatType], # (1)
GetComponentVersionArtifactRequestRequestTypeDef#
# GetComponentVersionArtifactRequestRequestTypeDef definition
class GetComponentVersionArtifactRequestRequestTypeDef(TypedDict):
arn: str,
artifactName: str,
GetConnectivityInfoRequestRequestTypeDef#
# GetConnectivityInfoRequestRequestTypeDef definition
class GetConnectivityInfoRequestRequestTypeDef(TypedDict):
thingName: str,
GetCoreDeviceRequestRequestTypeDef#
# GetCoreDeviceRequestRequestTypeDef definition
class GetCoreDeviceRequestRequestTypeDef(TypedDict):
coreDeviceThingName: str,
GetDeploymentRequestRequestTypeDef#
# GetDeploymentRequestRequestTypeDef definition
class GetDeploymentRequestRequestTypeDef(TypedDict):
deploymentId: str,
InstalledComponentTypeDef#
# InstalledComponentTypeDef definition
class InstalledComponentTypeDef(TypedDict):
componentName: NotRequired[str],
componentVersion: NotRequired[str],
lifecycleState: NotRequired[InstalledComponentLifecycleStateType], # (1)
lifecycleStateDetails: NotRequired[str],
isRoot: NotRequired[bool],
lastStatusChangeTimestamp: NotRequired[datetime],
lastReportedTimestamp: NotRequired[datetime],
lastInstallationSource: NotRequired[str],
lifecycleStatusCodes: NotRequired[List[str]],
IoTJobAbortCriteriaTypeDef#
# IoTJobAbortCriteriaTypeDef definition
class IoTJobAbortCriteriaTypeDef(TypedDict):
failureType: IoTJobExecutionFailureTypeType, # (1)
action: IoTJobAbortActionType, # (2)
thresholdPercentage: float,
minNumberOfExecutedThings: int,
IoTJobRateIncreaseCriteriaTypeDef#
# IoTJobRateIncreaseCriteriaTypeDef definition
class IoTJobRateIncreaseCriteriaTypeDef(TypedDict):
numberOfNotifiedThings: NotRequired[int],
numberOfSucceededThings: NotRequired[int],
LambdaDeviceMountTypeDef#
# LambdaDeviceMountTypeDef definition
class LambdaDeviceMountTypeDef(TypedDict):
path: str,
permission: NotRequired[LambdaFilesystemPermissionType], # (1)
addGroupOwner: NotRequired[bool],
LambdaVolumeMountTypeDef#
# LambdaVolumeMountTypeDef definition
class LambdaVolumeMountTypeDef(TypedDict):
sourcePath: str,
destinationPath: str,
permission: NotRequired[LambdaFilesystemPermissionType], # (1)
addGroupOwner: NotRequired[bool],
LambdaEventSourceTypeDef#
# LambdaEventSourceTypeDef definition
class LambdaEventSourceTypeDef(TypedDict):
topic: str,
type: LambdaEventSourceTypeType, # (1)
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListClientDevicesAssociatedWithCoreDeviceRequestRequestTypeDef#
# ListClientDevicesAssociatedWithCoreDeviceRequestRequestTypeDef definition
class ListClientDevicesAssociatedWithCoreDeviceRequestRequestTypeDef(TypedDict):
coreDeviceThingName: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListComponentVersionsRequestRequestTypeDef#
# ListComponentVersionsRequestRequestTypeDef definition
class ListComponentVersionsRequestRequestTypeDef(TypedDict):
arn: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListComponentsRequestRequestTypeDef#
# ListComponentsRequestRequestTypeDef definition
class ListComponentsRequestRequestTypeDef(TypedDict):
scope: NotRequired[ComponentVisibilityScopeType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListCoreDevicesRequestRequestTypeDef#
# ListCoreDevicesRequestRequestTypeDef definition
class ListCoreDevicesRequestRequestTypeDef(TypedDict):
thingGroupArn: NotRequired[str],
status: NotRequired[CoreDeviceStatusType], # (1)
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListDeploymentsRequestRequestTypeDef#
# ListDeploymentsRequestRequestTypeDef definition
class ListDeploymentsRequestRequestTypeDef(TypedDict):
targetArn: NotRequired[str],
historyFilter: NotRequired[DeploymentHistoryFilterType], # (1)
parentTargetArn: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListEffectiveDeploymentsRequestRequestTypeDef#
# ListEffectiveDeploymentsRequestRequestTypeDef definition
class ListEffectiveDeploymentsRequestRequestTypeDef(TypedDict):
coreDeviceThingName: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListInstalledComponentsRequestRequestTypeDef#
# ListInstalledComponentsRequestRequestTypeDef definition
class ListInstalledComponentsRequestRequestTypeDef(TypedDict):
coreDeviceThingName: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
topologyFilter: NotRequired[InstalledComponentTopologyFilterType], # (1)
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
ResolvedComponentVersionTypeDef#
# ResolvedComponentVersionTypeDef definition
class ResolvedComponentVersionTypeDef(TypedDict):
arn: NotRequired[str],
componentName: NotRequired[str],
componentVersion: NotRequired[str],
recipe: NotRequired[bytes],
vendorGuidance: NotRequired[VendorGuidanceType], # (1)
message: NotRequired[str],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
BatchAssociateClientDeviceWithCoreDeviceRequestRequestTypeDef#
# BatchAssociateClientDeviceWithCoreDeviceRequestRequestTypeDef definition
class BatchAssociateClientDeviceWithCoreDeviceRequestRequestTypeDef(TypedDict):
coreDeviceThingName: str,
entries: NotRequired[Sequence[AssociateClientDeviceWithCoreDeviceEntryTypeDef]], # (1)
AssociateServiceRoleToAccountResponseTypeDef#
# AssociateServiceRoleToAccountResponseTypeDef definition
class AssociateServiceRoleToAccountResponseTypeDef(TypedDict):
associatedAt: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
BatchAssociateClientDeviceWithCoreDeviceResponseTypeDef#
# BatchAssociateClientDeviceWithCoreDeviceResponseTypeDef definition
class BatchAssociateClientDeviceWithCoreDeviceResponseTypeDef(TypedDict):
errorEntries: List[AssociateClientDeviceWithCoreDeviceErrorEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CancelDeploymentResponseTypeDef#
# CancelDeploymentResponseTypeDef definition
class CancelDeploymentResponseTypeDef(TypedDict):
message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDeploymentResponseTypeDef#
# CreateDeploymentResponseTypeDef definition
class CreateDeploymentResponseTypeDef(TypedDict):
deploymentId: str,
iotJobId: str,
iotJobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DisassociateServiceRoleFromAccountResponseTypeDef#
# DisassociateServiceRoleFromAccountResponseTypeDef definition
class DisassociateServiceRoleFromAccountResponseTypeDef(TypedDict):
disassociatedAt: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetComponentResponseTypeDef#
# GetComponentResponseTypeDef definition
class GetComponentResponseTypeDef(TypedDict):
recipeOutputFormat: RecipeOutputFormatType, # (1)
recipe: bytes,
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetComponentVersionArtifactResponseTypeDef#
# GetComponentVersionArtifactResponseTypeDef definition
class GetComponentVersionArtifactResponseTypeDef(TypedDict):
preSignedUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetCoreDeviceResponseTypeDef#
# GetCoreDeviceResponseTypeDef definition
class GetCoreDeviceResponseTypeDef(TypedDict):
coreDeviceThingName: str,
coreVersion: str,
platform: str,
architecture: str,
status: CoreDeviceStatusType, # (1)
lastStatusUpdateTimestamp: datetime,
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetServiceRoleForAccountResponseTypeDef#
# GetServiceRoleForAccountResponseTypeDef definition
class GetServiceRoleForAccountResponseTypeDef(TypedDict):
associatedAt: str,
roleArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateConnectivityInfoResponseTypeDef#
# UpdateConnectivityInfoResponseTypeDef definition
class UpdateConnectivityInfoResponseTypeDef(TypedDict):
version: str,
message: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListClientDevicesAssociatedWithCoreDeviceResponseTypeDef#
# ListClientDevicesAssociatedWithCoreDeviceResponseTypeDef definition
class ListClientDevicesAssociatedWithCoreDeviceResponseTypeDef(TypedDict):
associatedClientDevices: List[AssociatedClientDeviceTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchDisassociateClientDeviceFromCoreDeviceRequestRequestTypeDef#
# BatchDisassociateClientDeviceFromCoreDeviceRequestRequestTypeDef definition
class BatchDisassociateClientDeviceFromCoreDeviceRequestRequestTypeDef(TypedDict):
coreDeviceThingName: str,
entries: NotRequired[Sequence[DisassociateClientDeviceFromCoreDeviceEntryTypeDef]], # (1)
BatchDisassociateClientDeviceFromCoreDeviceResponseTypeDef#
# BatchDisassociateClientDeviceFromCoreDeviceResponseTypeDef definition
class BatchDisassociateClientDeviceFromCoreDeviceResponseTypeDef(TypedDict):
errorEntries: List[DisassociateClientDeviceFromCoreDeviceErrorEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateComponentVersionResponseTypeDef#
# CreateComponentVersionResponseTypeDef definition
class CreateComponentVersionResponseTypeDef(TypedDict):
arn: str,
componentName: str,
componentVersion: str,
creationTimestamp: datetime,
status: CloudComponentStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ComponentLatestVersionPaginatorTypeDef#
# ComponentLatestVersionPaginatorTypeDef definition
class ComponentLatestVersionPaginatorTypeDef(TypedDict):
arn: NotRequired[str],
componentVersion: NotRequired[str],
creationTimestamp: NotRequired[datetime],
description: NotRequired[str],
publisher: NotRequired[str],
platforms: NotRequired[List[ComponentPlatformPaginatorTypeDef]], # (1)