Skip to content

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,
]

ComponentConfigurationUpdateUnionTypeDef#

# ComponentConfigurationUpdateUnionTypeDef definition

ComponentConfigurationUpdateUnionTypeDef = Union[
    ComponentConfigurationUpdateTypeDef,  # (1)
    ComponentConfigurationUpdateOutputTypeDef,  # (2)
]
  1. See ComponentConfigurationUpdateTypeDef
  2. See ComponentConfigurationUpdateOutputTypeDef

ComponentPlatformUnionTypeDef#

# ComponentPlatformUnionTypeDef definition

ComponentPlatformUnionTypeDef = Union[
    ComponentPlatformTypeDef,  # (1)
    ComponentPlatformOutputTypeDef,  # (2)
]
  1. See ComponentPlatformTypeDef
  2. See ComponentPlatformOutputTypeDef

IoTJobAbortConfigUnionTypeDef#

# IoTJobAbortConfigUnionTypeDef definition

IoTJobAbortConfigUnionTypeDef = Union[
    IoTJobAbortConfigTypeDef,  # (1)
    IoTJobAbortConfigOutputTypeDef,  # (2)
]
  1. See IoTJobAbortConfigTypeDef
  2. See IoTJobAbortConfigOutputTypeDef

ComponentDeploymentSpecificationUnionTypeDef#

# ComponentDeploymentSpecificationUnionTypeDef definition

ComponentDeploymentSpecificationUnionTypeDef = Union[
    ComponentDeploymentSpecificationTypeDef,  # (1)
    ComponentDeploymentSpecificationOutputTypeDef,  # (2)
]
  1. See ComponentDeploymentSpecificationTypeDef
  2. See ComponentDeploymentSpecificationOutputTypeDef

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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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],
  1. See CloudComponentStateType
  2. See VendorGuidanceType

ComponentCandidateTypeDef#

# ComponentCandidateTypeDef definition

class ComponentCandidateTypeDef(TypedDict):
    componentName: NotRequired[str],
    componentVersion: NotRequired[str],
    versionRequirements: NotRequired[Mapping[str, str]],

ComponentConfigurationUpdateOutputTypeDef#

# ComponentConfigurationUpdateOutputTypeDef definition

class ComponentConfigurationUpdateOutputTypeDef(TypedDict):
    merge: NotRequired[str],
    reset: NotRequired[List[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)
  1. See ComponentDependencyTypeType

ComponentPlatformOutputTypeDef#

# ComponentPlatformOutputTypeDef definition

class ComponentPlatformOutputTypeDef(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],
  1. See CoreDeviceStatusType

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)
  1. See DeploymentComponentUpdatePolicyActionType

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],
  1. See DeploymentStatusType

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)
  1. See RecipeOutputFormatType

GetComponentVersionArtifactRequestRequestTypeDef#

# GetComponentVersionArtifactRequestRequestTypeDef definition

class GetComponentVersionArtifactRequestRequestTypeDef(TypedDict):
    arn: str,
    artifactName: str,
    s3EndpointType: NotRequired[S3EndpointTypeType],  # (1)
    iotEndpointType: NotRequired[IotEndpointTypeType],  # (2)
  1. See S3EndpointTypeType
  2. See IotEndpointTypeType

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]],
  1. See InstalledComponentLifecycleStateType

IoTJobAbortCriteriaTypeDef#

# IoTJobAbortCriteriaTypeDef definition

class IoTJobAbortCriteriaTypeDef(TypedDict):
    failureType: IoTJobExecutionFailureTypeType,  # (1)
    action: IoTJobAbortActionType,  # (2)
    thresholdPercentage: float,
    minNumberOfExecutedThings: int,
  1. See IoTJobExecutionFailureTypeType
  2. See IoTJobAbortActionType

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],
  1. See LambdaFilesystemPermissionType

LambdaVolumeMountTypeDef#

# LambdaVolumeMountTypeDef definition

class LambdaVolumeMountTypeDef(TypedDict):
    sourcePath: str,
    destinationPath: str,
    permission: NotRequired[LambdaFilesystemPermissionType],  # (1)
    addGroupOwner: NotRequired[bool],
  1. See LambdaFilesystemPermissionType

LambdaEventSourceTypeDef#

# LambdaEventSourceTypeDef definition

class LambdaEventSourceTypeDef(TypedDict):
    topic: str,
    type: LambdaEventSourceTypeType,  # (1)
  1. See LambdaEventSourceTypeType

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],
  1. See ComponentVisibilityScopeType

ListCoreDevicesRequestRequestTypeDef#

# ListCoreDevicesRequestRequestTypeDef definition

class ListCoreDevicesRequestRequestTypeDef(TypedDict):
    thingGroupArn: NotRequired[str],
    status: NotRequired[CoreDeviceStatusType],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See CoreDeviceStatusType

ListDeploymentsRequestRequestTypeDef#

# ListDeploymentsRequestRequestTypeDef definition

class ListDeploymentsRequestRequestTypeDef(TypedDict):
    targetArn: NotRequired[str],
    historyFilter: NotRequired[DeploymentHistoryFilterType],  # (1)
    parentTargetArn: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See DeploymentHistoryFilterType

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)
  1. See InstalledComponentTopologyFilterType

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],
  1. See VendorGuidanceType

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)
  1. See AssociateClientDeviceWithCoreDeviceEntryTypeDef

AssociateServiceRoleToAccountResponseTypeDef#

# AssociateServiceRoleToAccountResponseTypeDef definition

class AssociateServiceRoleToAccountResponseTypeDef(TypedDict):
    associatedAt: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

BatchAssociateClientDeviceWithCoreDeviceResponseTypeDef#

# BatchAssociateClientDeviceWithCoreDeviceResponseTypeDef definition

class BatchAssociateClientDeviceWithCoreDeviceResponseTypeDef(TypedDict):
    errorEntries: List[AssociateClientDeviceWithCoreDeviceErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssociateClientDeviceWithCoreDeviceErrorEntryTypeDef
  2. See ResponseMetadataTypeDef

CancelDeploymentResponseTypeDef#

# CancelDeploymentResponseTypeDef definition

class CancelDeploymentResponseTypeDef(TypedDict):
    message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDeploymentResponseTypeDef#

# CreateDeploymentResponseTypeDef definition

class CreateDeploymentResponseTypeDef(TypedDict):
    deploymentId: str,
    iotJobId: str,
    iotJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DisassociateServiceRoleFromAccountResponseTypeDef#

# DisassociateServiceRoleFromAccountResponseTypeDef definition

class DisassociateServiceRoleFromAccountResponseTypeDef(TypedDict):
    disassociatedAt: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetComponentResponseTypeDef#

# GetComponentResponseTypeDef definition

class GetComponentResponseTypeDef(TypedDict):
    recipeOutputFormat: RecipeOutputFormatType,  # (1)
    recipe: bytes,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecipeOutputFormatType
  2. See ResponseMetadataTypeDef

GetComponentVersionArtifactResponseTypeDef#

# GetComponentVersionArtifactResponseTypeDef definition

class GetComponentVersionArtifactResponseTypeDef(TypedDict):
    preSignedUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

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)
  1. See CoreDeviceStatusType
  2. See ResponseMetadataTypeDef

GetServiceRoleForAccountResponseTypeDef#

# GetServiceRoleForAccountResponseTypeDef definition

class GetServiceRoleForAccountResponseTypeDef(TypedDict):
    associatedAt: str,
    roleArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

UpdateConnectivityInfoResponseTypeDef#

# UpdateConnectivityInfoResponseTypeDef definition

class UpdateConnectivityInfoResponseTypeDef(TypedDict):
    version: str,
    message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListClientDevicesAssociatedWithCoreDeviceResponseTypeDef#

# ListClientDevicesAssociatedWithCoreDeviceResponseTypeDef definition

class ListClientDevicesAssociatedWithCoreDeviceResponseTypeDef(TypedDict):
    associatedClientDevices: List[AssociatedClientDeviceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See AssociatedClientDeviceTypeDef
  2. See ResponseMetadataTypeDef

BatchDisassociateClientDeviceFromCoreDeviceRequestRequestTypeDef#

# BatchDisassociateClientDeviceFromCoreDeviceRequestRequestTypeDef definition

class BatchDisassociateClientDeviceFromCoreDeviceRequestRequestTypeDef(TypedDict):
    coreDeviceThingName: str,
    entries: NotRequired[Sequence[DisassociateClientDeviceFromCoreDeviceEntryTypeDef]],  # (1)
  1. See DisassociateClientDeviceFromCoreDeviceEntryTypeDef

BatchDisassociateClientDeviceFromCoreDeviceResponseTypeDef#

# BatchDisassociateClientDeviceFromCoreDeviceResponseTypeDef definition

class BatchDisassociateClientDeviceFromCoreDeviceResponseTypeDef(TypedDict):
    errorEntries: List[DisassociateClientDeviceFromCoreDeviceErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DisassociateClientDeviceFromCoreDeviceErrorEntryTypeDef
  2. See ResponseMetadataTypeDef

CreateComponentVersionResponseTypeDef#

# CreateComponentVersionResponseTypeDef definition

class CreateComponentVersionResponseTypeDef(TypedDict):
    arn: str,
    componentName: str,
    componentVersion: str,
    creationTimestamp: datetime,
    status: CloudComponentStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CloudComponentStatusTypeDef
  2. See ResponseMetadataTypeDef

ComponentLatestVersionTypeDef#

# ComponentLatestVersionTypeDef definition

class ComponentLatestVersionTypeDef(TypedDict):
    arn: NotRequired[str],
    componentVersion: NotRequired[str],
    creationTimestamp: NotRequired[datetime],
    description: NotRequired[str],
    publisher: NotRequired[str],
    platforms: NotRequired[List[ComponentPlatformOutputTypeDef]],  # (1)
  1. See ComponentPlatformOutputTypeDef

DescribeComponentResponseTypeDef#

# DescribeComponentResponseTypeDef definition

class DescribeComponentResponseTypeDef(TypedDict):
    arn: str,
    componentName: str,
    componentVersion: str,
    creationTimestamp: datetime,
    publisher: str,
    description: str,
    status: CloudComponentStatusTypeDef,  # (1)
    platforms: List[ComponentPlatformOutputTypeDef],  # (2)
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See CloudComponentStatusTypeDef
  2. See ComponentPlatformOutputTypeDef
  3. See ResponseMetadataTypeDef

ResolveComponentCandidatesRequestRequestTypeDef#

# ResolveComponentCandidatesRequestRequestTypeDef definition

class ResolveComponentCandidatesRequestRequestTypeDef(TypedDict):
    platform: NotRequired[ComponentPlatformTypeDef],  # (1)
    componentCandidates: NotRequired[Sequence[ComponentCandidateTypeDef]],  # (2)
  1. See ComponentPlatformTypeDef
  2. See ComponentCandidateTypeDef

ComponentRunWithTypeDef#

# ComponentRunWithTypeDef definition

class ComponentRunWithTypeDef(TypedDict):
    posixUser: NotRequired[str],
    systemResourceLimits: NotRequired[SystemResourceLimitsTypeDef],  # (1)
    windowsUser: NotRequired[str],
  1. See SystemResourceLimitsTypeDef

ListComponentVersionsResponseTypeDef#

# ListComponentVersionsResponseTypeDef definition

class ListComponentVersionsResponseTypeDef(TypedDict):
    componentVersions: List[ComponentVersionListItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ComponentVersionListItemTypeDef
  2. See ResponseMetadataTypeDef

GetConnectivityInfoResponseTypeDef#

# GetConnectivityInfoResponseTypeDef definition

class GetConnectivityInfoResponseTypeDef(TypedDict):
    connectivityInfo: List[ConnectivityInfoTypeDef],  # (1)
    message: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectivityInfoTypeDef
  2. See ResponseMetadataTypeDef

UpdateConnectivityInfoRequestRequestTypeDef#

# UpdateConnectivityInfoRequestRequestTypeDef definition

class UpdateConnectivityInfoRequestRequestTypeDef(TypedDict):
    thingName: str,
    connectivityInfo: Sequence[ConnectivityInfoTypeDef],  # (1)
  1. See ConnectivityInfoTypeDef

ListCoreDevicesResponseTypeDef#

# ListCoreDevicesResponseTypeDef definition

class ListCoreDevicesResponseTypeDef(TypedDict):
    coreDevices: List[CoreDeviceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See CoreDeviceTypeDef
  2. See ResponseMetadataTypeDef

DeploymentPoliciesTypeDef#

# DeploymentPoliciesTypeDef definition

class DeploymentPoliciesTypeDef(TypedDict):
    failureHandlingPolicy: NotRequired[DeploymentFailureHandlingPolicyType],  # (1)
    componentUpdatePolicy: NotRequired[DeploymentComponentUpdatePolicyTypeDef],  # (2)
    configurationValidationPolicy: NotRequired[DeploymentConfigurationValidationPolicyTypeDef],  # (3)
  1. See DeploymentFailureHandlingPolicyType
  2. See DeploymentComponentUpdatePolicyTypeDef
  3. See DeploymentConfigurationValidationPolicyTypeDef

ListDeploymentsResponseTypeDef#

# ListDeploymentsResponseTypeDef definition

class ListDeploymentsResponseTypeDef(TypedDict):
    deployments: List[DeploymentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DeploymentTypeDef
  2. See ResponseMetadataTypeDef

EffectiveDeploymentTypeDef#

# EffectiveDeploymentTypeDef definition

class EffectiveDeploymentTypeDef(TypedDict):
    deploymentId: str,
    deploymentName: str,
    targetArn: str,
    coreDeviceExecutionStatus: EffectiveDeploymentExecutionStatusType,  # (1)
    creationTimestamp: datetime,
    modifiedTimestamp: datetime,
    iotJobId: NotRequired[str],
    iotJobArn: NotRequired[str],
    description: NotRequired[str],
    reason: NotRequired[str],
    statusDetails: NotRequired[EffectiveDeploymentStatusDetailsTypeDef],  # (2)
  1. See EffectiveDeploymentExecutionStatusType
  2. See EffectiveDeploymentStatusDetailsTypeDef

ListInstalledComponentsResponseTypeDef#

# ListInstalledComponentsResponseTypeDef definition

class ListInstalledComponentsResponseTypeDef(TypedDict):
    installedComponents: List[InstalledComponentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See InstalledComponentTypeDef
  2. See ResponseMetadataTypeDef

IoTJobAbortConfigOutputTypeDef#

# IoTJobAbortConfigOutputTypeDef definition

class IoTJobAbortConfigOutputTypeDef(TypedDict):
    criteriaList: List[IoTJobAbortCriteriaTypeDef],  # (1)
  1. See IoTJobAbortCriteriaTypeDef

IoTJobAbortConfigTypeDef#

# IoTJobAbortConfigTypeDef definition

class IoTJobAbortConfigTypeDef(TypedDict):
    criteriaList: Sequence[IoTJobAbortCriteriaTypeDef],  # (1)
  1. See IoTJobAbortCriteriaTypeDef

IoTJobExponentialRolloutRateTypeDef#

# IoTJobExponentialRolloutRateTypeDef definition

class IoTJobExponentialRolloutRateTypeDef(TypedDict):
    baseRatePerMinute: int,
    incrementFactor: float,
    rateIncreaseCriteria: IoTJobRateIncreaseCriteriaTypeDef,  # (1)
  1. See IoTJobRateIncreaseCriteriaTypeDef

LambdaContainerParamsTypeDef#

# LambdaContainerParamsTypeDef definition

class LambdaContainerParamsTypeDef(TypedDict):
    memorySizeInKB: NotRequired[int],
    mountROSysfs: NotRequired[bool],
    volumes: NotRequired[Sequence[LambdaVolumeMountTypeDef]],  # (1)
    devices: NotRequired[Sequence[LambdaDeviceMountTypeDef]],  # (2)
  1. See LambdaVolumeMountTypeDef
  2. See LambdaDeviceMountTypeDef

ListClientDevicesAssociatedWithCoreDeviceRequestListClientDevicesAssociatedWithCoreDevicePaginateTypeDef#

# ListClientDevicesAssociatedWithCoreDeviceRequestListClientDevicesAssociatedWithCoreDevicePaginateTypeDef definition

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

ListComponentVersionsRequestListComponentVersionsPaginateTypeDef#

# ListComponentVersionsRequestListComponentVersionsPaginateTypeDef definition

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

ListComponentsRequestListComponentsPaginateTypeDef#

# ListComponentsRequestListComponentsPaginateTypeDef definition

class ListComponentsRequestListComponentsPaginateTypeDef(TypedDict):
    scope: NotRequired[ComponentVisibilityScopeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ComponentVisibilityScopeType
  2. See PaginatorConfigTypeDef

ListCoreDevicesRequestListCoreDevicesPaginateTypeDef#

# ListCoreDevicesRequestListCoreDevicesPaginateTypeDef definition

class ListCoreDevicesRequestListCoreDevicesPaginateTypeDef(TypedDict):
    thingGroupArn: NotRequired[str],
    status: NotRequired[CoreDeviceStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See CoreDeviceStatusType
  2. See PaginatorConfigTypeDef

ListDeploymentsRequestListDeploymentsPaginateTypeDef#

# ListDeploymentsRequestListDeploymentsPaginateTypeDef definition

class ListDeploymentsRequestListDeploymentsPaginateTypeDef(TypedDict):
    targetArn: NotRequired[str],
    historyFilter: NotRequired[DeploymentHistoryFilterType],  # (1)
    parentTargetArn: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See DeploymentHistoryFilterType
  2. See PaginatorConfigTypeDef

ListEffectiveDeploymentsRequestListEffectiveDeploymentsPaginateTypeDef#

# ListEffectiveDeploymentsRequestListEffectiveDeploymentsPaginateTypeDef definition

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

ListInstalledComponentsRequestListInstalledComponentsPaginateTypeDef#

# ListInstalledComponentsRequestListInstalledComponentsPaginateTypeDef definition

class ListInstalledComponentsRequestListInstalledComponentsPaginateTypeDef(TypedDict):
    coreDeviceThingName: str,
    topologyFilter: NotRequired[InstalledComponentTopologyFilterType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See InstalledComponentTopologyFilterType
  2. See PaginatorConfigTypeDef

ResolveComponentCandidatesResponseTypeDef#

# ResolveComponentCandidatesResponseTypeDef definition

class ResolveComponentCandidatesResponseTypeDef(TypedDict):
    resolvedComponentVersions: List[ResolvedComponentVersionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResolvedComponentVersionTypeDef
  2. See ResponseMetadataTypeDef

ComponentTypeDef#

# ComponentTypeDef definition

class ComponentTypeDef(TypedDict):
    arn: NotRequired[str],
    componentName: NotRequired[str],
    latestVersion: NotRequired[ComponentLatestVersionTypeDef],  # (1)
  1. See ComponentLatestVersionTypeDef

ComponentDeploymentSpecificationOutputTypeDef#

# ComponentDeploymentSpecificationOutputTypeDef definition

class ComponentDeploymentSpecificationOutputTypeDef(TypedDict):
    componentVersion: str,
    configurationUpdate: NotRequired[ComponentConfigurationUpdateOutputTypeDef],  # (1)
    runWith: NotRequired[ComponentRunWithTypeDef],  # (2)
  1. See ComponentConfigurationUpdateOutputTypeDef
  2. See ComponentRunWithTypeDef

ComponentDeploymentSpecificationTypeDef#

# ComponentDeploymentSpecificationTypeDef definition

class ComponentDeploymentSpecificationTypeDef(TypedDict):
    componentVersion: str,
    configurationUpdate: NotRequired[ComponentConfigurationUpdateUnionTypeDef],  # (1)
    runWith: NotRequired[ComponentRunWithTypeDef],  # (2)
  1. See ComponentConfigurationUpdateTypeDef ComponentConfigurationUpdateOutputTypeDef
  2. See ComponentRunWithTypeDef

ListEffectiveDeploymentsResponseTypeDef#

# ListEffectiveDeploymentsResponseTypeDef definition

class ListEffectiveDeploymentsResponseTypeDef(TypedDict):
    effectiveDeployments: List[EffectiveDeploymentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See EffectiveDeploymentTypeDef
  2. See ResponseMetadataTypeDef

IoTJobExecutionsRolloutConfigTypeDef#

# IoTJobExecutionsRolloutConfigTypeDef definition

class IoTJobExecutionsRolloutConfigTypeDef(TypedDict):
    exponentialRate: NotRequired[IoTJobExponentialRolloutRateTypeDef],  # (1)
    maximumPerMinute: NotRequired[int],
  1. See IoTJobExponentialRolloutRateTypeDef

LambdaLinuxProcessParamsTypeDef#

# LambdaLinuxProcessParamsTypeDef definition

class LambdaLinuxProcessParamsTypeDef(TypedDict):
    isolationMode: NotRequired[LambdaIsolationModeType],  # (1)
    containerParams: NotRequired[LambdaContainerParamsTypeDef],  # (2)
  1. See LambdaIsolationModeType
  2. See LambdaContainerParamsTypeDef

ListComponentsResponseTypeDef#

# ListComponentsResponseTypeDef definition

class ListComponentsResponseTypeDef(TypedDict):
    components: List[ComponentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ComponentTypeDef
  2. See ResponseMetadataTypeDef

DeploymentIoTJobConfigurationOutputTypeDef#

# DeploymentIoTJobConfigurationOutputTypeDef definition

class DeploymentIoTJobConfigurationOutputTypeDef(TypedDict):
    jobExecutionsRolloutConfig: NotRequired[IoTJobExecutionsRolloutConfigTypeDef],  # (1)
    abortConfig: NotRequired[IoTJobAbortConfigOutputTypeDef],  # (2)
    timeoutConfig: NotRequired[IoTJobTimeoutConfigTypeDef],  # (3)
  1. See IoTJobExecutionsRolloutConfigTypeDef
  2. See IoTJobAbortConfigOutputTypeDef
  3. See IoTJobTimeoutConfigTypeDef

DeploymentIoTJobConfigurationTypeDef#

# DeploymentIoTJobConfigurationTypeDef definition

class DeploymentIoTJobConfigurationTypeDef(TypedDict):
    jobExecutionsRolloutConfig: NotRequired[IoTJobExecutionsRolloutConfigTypeDef],  # (1)
    abortConfig: NotRequired[IoTJobAbortConfigUnionTypeDef],  # (2)
    timeoutConfig: NotRequired[IoTJobTimeoutConfigTypeDef],  # (3)
  1. See IoTJobExecutionsRolloutConfigTypeDef
  2. See IoTJobAbortConfigTypeDef IoTJobAbortConfigOutputTypeDef
  3. See IoTJobTimeoutConfigTypeDef

LambdaExecutionParametersTypeDef#

# LambdaExecutionParametersTypeDef definition

class LambdaExecutionParametersTypeDef(TypedDict):
    eventSources: NotRequired[Sequence[LambdaEventSourceTypeDef]],  # (1)
    maxQueueSize: NotRequired[int],
    maxInstancesCount: NotRequired[int],
    maxIdleTimeInSeconds: NotRequired[int],
    timeoutInSeconds: NotRequired[int],
    statusTimeoutInSeconds: NotRequired[int],
    pinned: NotRequired[bool],
    inputPayloadEncodingType: NotRequired[LambdaInputPayloadEncodingTypeType],  # (2)
    execArgs: NotRequired[Sequence[str]],
    environmentVariables: NotRequired[Mapping[str, str]],
    linuxProcessParams: NotRequired[LambdaLinuxProcessParamsTypeDef],  # (3)
  1. See LambdaEventSourceTypeDef
  2. See LambdaInputPayloadEncodingTypeType
  3. See LambdaLinuxProcessParamsTypeDef

GetDeploymentResponseTypeDef#

# GetDeploymentResponseTypeDef definition

class GetDeploymentResponseTypeDef(TypedDict):
    targetArn: str,
    revisionId: str,
    deploymentId: str,
    deploymentName: str,
    deploymentStatus: DeploymentStatusType,  # (1)
    iotJobId: str,
    iotJobArn: str,
    components: Dict[str, ComponentDeploymentSpecificationOutputTypeDef],  # (2)
    deploymentPolicies: DeploymentPoliciesTypeDef,  # (3)
    iotJobConfiguration: DeploymentIoTJobConfigurationOutputTypeDef,  # (4)
    creationTimestamp: datetime,
    isLatestForTarget: bool,
    parentTargetArn: str,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See DeploymentStatusType
  2. See ComponentDeploymentSpecificationOutputTypeDef
  3. See DeploymentPoliciesTypeDef
  4. See DeploymentIoTJobConfigurationOutputTypeDef
  5. See ResponseMetadataTypeDef

CreateDeploymentRequestRequestTypeDef#

# CreateDeploymentRequestRequestTypeDef definition

class CreateDeploymentRequestRequestTypeDef(TypedDict):
    targetArn: str,
    deploymentName: NotRequired[str],
    components: NotRequired[Mapping[str, ComponentDeploymentSpecificationUnionTypeDef]],  # (1)
    iotJobConfiguration: NotRequired[DeploymentIoTJobConfigurationTypeDef],  # (2)
    deploymentPolicies: NotRequired[DeploymentPoliciesTypeDef],  # (3)
    parentTargetArn: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    clientToken: NotRequired[str],
  1. See ComponentDeploymentSpecificationTypeDef ComponentDeploymentSpecificationOutputTypeDef
  2. See DeploymentIoTJobConfigurationTypeDef
  3. See DeploymentPoliciesTypeDef

LambdaFunctionRecipeSourceTypeDef#

# LambdaFunctionRecipeSourceTypeDef definition

class LambdaFunctionRecipeSourceTypeDef(TypedDict):
    lambdaArn: str,
    componentName: NotRequired[str],
    componentVersion: NotRequired[str],
    componentPlatforms: NotRequired[Sequence[ComponentPlatformUnionTypeDef]],  # (1)
    componentDependencies: NotRequired[Mapping[str, ComponentDependencyRequirementTypeDef]],  # (2)
    componentLambdaParameters: NotRequired[LambdaExecutionParametersTypeDef],  # (3)
  1. See ComponentPlatformTypeDef ComponentPlatformOutputTypeDef
  2. See ComponentDependencyRequirementTypeDef
  3. See LambdaExecutionParametersTypeDef

CreateComponentVersionRequestRequestTypeDef#

# CreateComponentVersionRequestRequestTypeDef definition

class CreateComponentVersionRequestRequestTypeDef(TypedDict):
    inlineRecipe: NotRequired[BlobTypeDef],
    lambdaFunction: NotRequired[LambdaFunctionRecipeSourceTypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],
    clientToken: NotRequired[str],
  1. See LambdaFunctionRecipeSourceTypeDef