Skip to content

Typed dictionaries#

Index > IoTDeviceAdvisor > Typed dictionaries

Auto-generated documentation for IoTDeviceAdvisor type annotations stubs module mypy-boto3-iotdeviceadvisor.

CreateSuiteDefinitionResponseTypeDef#

# CreateSuiteDefinitionResponseTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import CreateSuiteDefinitionResponseTypeDef

def get_value() -> CreateSuiteDefinitionResponseTypeDef:
    return {
        "suiteDefinitionId": ...,
        "suiteDefinitionArn": ...,
        "suiteDefinitionName": ...,
        "createdAt": ...,
        "ResponseMetadata": ...,
    }
# CreateSuiteDefinitionResponseTypeDef definition

class CreateSuiteDefinitionResponseTypeDef(TypedDict):
    suiteDefinitionId: str,
    suiteDefinitionArn: str,
    suiteDefinitionName: str,
    createdAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteSuiteDefinitionRequestRequestTypeDef#

# DeleteSuiteDefinitionRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import DeleteSuiteDefinitionRequestRequestTypeDef

def get_value() -> DeleteSuiteDefinitionRequestRequestTypeDef:
    return {
        "suiteDefinitionId": ...,
    }
# DeleteSuiteDefinitionRequestRequestTypeDef definition

class DeleteSuiteDefinitionRequestRequestTypeDef(TypedDict):
    suiteDefinitionId: str,

DeviceUnderTestTypeDef#

# DeviceUnderTestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import DeviceUnderTestTypeDef

def get_value() -> DeviceUnderTestTypeDef:
    return {
        "thingArn": ...,
    }
# DeviceUnderTestTypeDef definition

class DeviceUnderTestTypeDef(TypedDict):
    thingArn: NotRequired[str],
    certificateArn: NotRequired[str],
    deviceRoleArn: NotRequired[str],

GetEndpointRequestRequestTypeDef#

# GetEndpointRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import GetEndpointRequestRequestTypeDef

def get_value() -> GetEndpointRequestRequestTypeDef:
    return {
        "thingArn": ...,
    }
# GetEndpointRequestRequestTypeDef definition

class GetEndpointRequestRequestTypeDef(TypedDict):
    thingArn: NotRequired[str],
    certificateArn: NotRequired[str],
    deviceRoleArn: NotRequired[str],
    authenticationMethod: NotRequired[AuthenticationMethodType],  # (1)
  1. See AuthenticationMethodType

GetEndpointResponseTypeDef#

# GetEndpointResponseTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import GetEndpointResponseTypeDef

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

class GetEndpointResponseTypeDef(TypedDict):
    endpoint: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSuiteDefinitionRequestRequestTypeDef#

# GetSuiteDefinitionRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import GetSuiteDefinitionRequestRequestTypeDef

def get_value() -> GetSuiteDefinitionRequestRequestTypeDef:
    return {
        "suiteDefinitionId": ...,
    }
# GetSuiteDefinitionRequestRequestTypeDef definition

class GetSuiteDefinitionRequestRequestTypeDef(TypedDict):
    suiteDefinitionId: str,
    suiteDefinitionVersion: NotRequired[str],

GetSuiteRunReportRequestRequestTypeDef#

# GetSuiteRunReportRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import GetSuiteRunReportRequestRequestTypeDef

def get_value() -> GetSuiteRunReportRequestRequestTypeDef:
    return {
        "suiteDefinitionId": ...,
        "suiteRunId": ...,
    }
# GetSuiteRunReportRequestRequestTypeDef definition

class GetSuiteRunReportRequestRequestTypeDef(TypedDict):
    suiteDefinitionId: str,
    suiteRunId: str,

GetSuiteRunReportResponseTypeDef#

# GetSuiteRunReportResponseTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import GetSuiteRunReportResponseTypeDef

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

class GetSuiteRunReportResponseTypeDef(TypedDict):
    qualificationReportDownloadUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSuiteRunRequestRequestTypeDef#

# GetSuiteRunRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import GetSuiteRunRequestRequestTypeDef

def get_value() -> GetSuiteRunRequestRequestTypeDef:
    return {
        "suiteDefinitionId": ...,
        "suiteRunId": ...,
    }
# GetSuiteRunRequestRequestTypeDef definition

class GetSuiteRunRequestRequestTypeDef(TypedDict):
    suiteDefinitionId: str,
    suiteRunId: str,

ListSuiteDefinitionsRequestRequestTypeDef#

# ListSuiteDefinitionsRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import ListSuiteDefinitionsRequestRequestTypeDef

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

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

ListSuiteRunsRequestRequestTypeDef#

# ListSuiteRunsRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import ListSuiteRunsRequestRequestTypeDef

def get_value() -> ListSuiteRunsRequestRequestTypeDef:
    return {
        "suiteDefinitionId": ...,
    }
# ListSuiteRunsRequestRequestTypeDef definition

class ListSuiteRunsRequestRequestTypeDef(TypedDict):
    suiteDefinitionId: NotRequired[str],
    suiteDefinitionVersion: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

SuiteRunInformationTypeDef#

# SuiteRunInformationTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import SuiteRunInformationTypeDef

def get_value() -> SuiteRunInformationTypeDef:
    return {
        "suiteDefinitionId": ...,
    }
# SuiteRunInformationTypeDef definition

class SuiteRunInformationTypeDef(TypedDict):
    suiteDefinitionId: NotRequired[str],
    suiteDefinitionVersion: NotRequired[str],
    suiteDefinitionName: NotRequired[str],
    suiteRunId: NotRequired[str],
    createdAt: NotRequired[datetime],
    startedAt: NotRequired[datetime],
    endAt: NotRequired[datetime],
    status: NotRequired[SuiteRunStatusType],  # (1)
    passed: NotRequired[int],
    failed: NotRequired[int],
  1. See SuiteRunStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import ListTagsForResourceResponseTypeDef

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

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_iotdeviceadvisor.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,

StartSuiteRunResponseTypeDef#

# StartSuiteRunResponseTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import StartSuiteRunResponseTypeDef

def get_value() -> StartSuiteRunResponseTypeDef:
    return {
        "suiteRunId": ...,
        "suiteRunArn": ...,
        "createdAt": ...,
        "endpoint": ...,
        "ResponseMetadata": ...,
    }
# StartSuiteRunResponseTypeDef definition

class StartSuiteRunResponseTypeDef(TypedDict):
    suiteRunId: str,
    suiteRunArn: str,
    createdAt: datetime,
    endpoint: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopSuiteRunRequestRequestTypeDef#

# StopSuiteRunRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import StopSuiteRunRequestRequestTypeDef

def get_value() -> StopSuiteRunRequestRequestTypeDef:
    return {
        "suiteDefinitionId": ...,
        "suiteRunId": ...,
    }
# StopSuiteRunRequestRequestTypeDef definition

class StopSuiteRunRequestRequestTypeDef(TypedDict):
    suiteDefinitionId: str,
    suiteRunId: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

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

TestCaseScenarioTypeDef#

# TestCaseScenarioTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import TestCaseScenarioTypeDef

def get_value() -> TestCaseScenarioTypeDef:
    return {
        "testCaseScenarioId": ...,
    }
# TestCaseScenarioTypeDef definition

class TestCaseScenarioTypeDef(TypedDict):
    testCaseScenarioId: NotRequired[str],
    testCaseScenarioType: NotRequired[TestCaseScenarioTypeType],  # (1)
    status: NotRequired[TestCaseScenarioStatusType],  # (2)
    failure: NotRequired[str],
    systemMessage: NotRequired[str],
  1. See TestCaseScenarioTypeType
  2. See TestCaseScenarioStatusType

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

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

UpdateSuiteDefinitionResponseTypeDef#

# UpdateSuiteDefinitionResponseTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import UpdateSuiteDefinitionResponseTypeDef

def get_value() -> UpdateSuiteDefinitionResponseTypeDef:
    return {
        "suiteDefinitionId": ...,
        "suiteDefinitionArn": ...,
        "suiteDefinitionName": ...,
        "suiteDefinitionVersion": ...,
        "createdAt": ...,
        "lastUpdatedAt": ...,
        "ResponseMetadata": ...,
    }
# UpdateSuiteDefinitionResponseTypeDef definition

class UpdateSuiteDefinitionResponseTypeDef(TypedDict):
    suiteDefinitionId: str,
    suiteDefinitionArn: str,
    suiteDefinitionName: str,
    suiteDefinitionVersion: str,
    createdAt: datetime,
    lastUpdatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SuiteDefinitionConfigurationTypeDef#

# SuiteDefinitionConfigurationTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import SuiteDefinitionConfigurationTypeDef

def get_value() -> SuiteDefinitionConfigurationTypeDef:
    return {
        "suiteDefinitionName": ...,
        "rootGroup": ...,
        "devicePermissionRoleArn": ...,
    }
# SuiteDefinitionConfigurationTypeDef definition

class SuiteDefinitionConfigurationTypeDef(TypedDict):
    suiteDefinitionName: str,
    rootGroup: str,
    devicePermissionRoleArn: str,
    devices: NotRequired[Sequence[DeviceUnderTestTypeDef]],  # (1)
    intendedForQualification: NotRequired[bool],
    isLongDurationTest: NotRequired[bool],
    protocol: NotRequired[ProtocolType],  # (2)
  1. See DeviceUnderTestTypeDef
  2. See ProtocolType

SuiteDefinitionInformationTypeDef#

# SuiteDefinitionInformationTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import SuiteDefinitionInformationTypeDef

def get_value() -> SuiteDefinitionInformationTypeDef:
    return {
        "suiteDefinitionId": ...,
    }
# SuiteDefinitionInformationTypeDef definition

class SuiteDefinitionInformationTypeDef(TypedDict):
    suiteDefinitionId: NotRequired[str],
    suiteDefinitionName: NotRequired[str],
    defaultDevices: NotRequired[List[DeviceUnderTestTypeDef]],  # (1)
    intendedForQualification: NotRequired[bool],
    isLongDurationTest: NotRequired[bool],
    protocol: NotRequired[ProtocolType],  # (2)
    createdAt: NotRequired[datetime],
  1. See DeviceUnderTestTypeDef
  2. See ProtocolType

SuiteRunConfigurationTypeDef#

# SuiteRunConfigurationTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import SuiteRunConfigurationTypeDef

def get_value() -> SuiteRunConfigurationTypeDef:
    return {
        "primaryDevice": ...,
    }
# SuiteRunConfigurationTypeDef definition

class SuiteRunConfigurationTypeDef(TypedDict):
    primaryDevice: DeviceUnderTestTypeDef,  # (1)
    selectedTestList: NotRequired[List[str]],
    parallelRun: NotRequired[bool],
  1. See DeviceUnderTestTypeDef

ListSuiteRunsResponseTypeDef#

# ListSuiteRunsResponseTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import ListSuiteRunsResponseTypeDef

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

class ListSuiteRunsResponseTypeDef(TypedDict):
    suiteRunsList: List[SuiteRunInformationTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SuiteRunInformationTypeDef
  2. See ResponseMetadataTypeDef

TestCaseRunTypeDef#

# TestCaseRunTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import TestCaseRunTypeDef

def get_value() -> TestCaseRunTypeDef:
    return {
        "testCaseRunId": ...,
    }
# TestCaseRunTypeDef definition

class TestCaseRunTypeDef(TypedDict):
    testCaseRunId: NotRequired[str],
    testCaseDefinitionId: NotRequired[str],
    testCaseDefinitionName: NotRequired[str],
    status: NotRequired[StatusType],  # (1)
    startTime: NotRequired[datetime],
    endTime: NotRequired[datetime],
    logUrl: NotRequired[str],
    warnings: NotRequired[str],
    failure: NotRequired[str],
    testScenarios: NotRequired[List[TestCaseScenarioTypeDef]],  # (2)
  1. See StatusType
  2. See TestCaseScenarioTypeDef

CreateSuiteDefinitionRequestRequestTypeDef#

# CreateSuiteDefinitionRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import CreateSuiteDefinitionRequestRequestTypeDef

def get_value() -> CreateSuiteDefinitionRequestRequestTypeDef:
    return {
        "suiteDefinitionConfiguration": ...,
    }
# CreateSuiteDefinitionRequestRequestTypeDef definition

class CreateSuiteDefinitionRequestRequestTypeDef(TypedDict):
    suiteDefinitionConfiguration: SuiteDefinitionConfigurationTypeDef,  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See SuiteDefinitionConfigurationTypeDef

GetSuiteDefinitionResponseTypeDef#

# GetSuiteDefinitionResponseTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import GetSuiteDefinitionResponseTypeDef

def get_value() -> GetSuiteDefinitionResponseTypeDef:
    return {
        "suiteDefinitionId": ...,
        "suiteDefinitionArn": ...,
        "suiteDefinitionVersion": ...,
        "latestVersion": ...,
        "suiteDefinitionConfiguration": ...,
        "createdAt": ...,
        "lastModifiedAt": ...,
        "tags": ...,
        "ResponseMetadata": ...,
    }
# GetSuiteDefinitionResponseTypeDef definition

class GetSuiteDefinitionResponseTypeDef(TypedDict):
    suiteDefinitionId: str,
    suiteDefinitionArn: str,
    suiteDefinitionVersion: str,
    latestVersion: str,
    suiteDefinitionConfiguration: SuiteDefinitionConfigurationTypeDef,  # (1)
    createdAt: datetime,
    lastModifiedAt: datetime,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SuiteDefinitionConfigurationTypeDef
  2. See ResponseMetadataTypeDef

UpdateSuiteDefinitionRequestRequestTypeDef#

# UpdateSuiteDefinitionRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import UpdateSuiteDefinitionRequestRequestTypeDef

def get_value() -> UpdateSuiteDefinitionRequestRequestTypeDef:
    return {
        "suiteDefinitionId": ...,
        "suiteDefinitionConfiguration": ...,
    }
# UpdateSuiteDefinitionRequestRequestTypeDef definition

class UpdateSuiteDefinitionRequestRequestTypeDef(TypedDict):
    suiteDefinitionId: str,
    suiteDefinitionConfiguration: SuiteDefinitionConfigurationTypeDef,  # (1)
  1. See SuiteDefinitionConfigurationTypeDef

ListSuiteDefinitionsResponseTypeDef#

# ListSuiteDefinitionsResponseTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import ListSuiteDefinitionsResponseTypeDef

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

class ListSuiteDefinitionsResponseTypeDef(TypedDict):
    suiteDefinitionInformationList: List[SuiteDefinitionInformationTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SuiteDefinitionInformationTypeDef
  2. See ResponseMetadataTypeDef

StartSuiteRunRequestRequestTypeDef#

# StartSuiteRunRequestRequestTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import StartSuiteRunRequestRequestTypeDef

def get_value() -> StartSuiteRunRequestRequestTypeDef:
    return {
        "suiteDefinitionId": ...,
        "suiteRunConfiguration": ...,
    }
# StartSuiteRunRequestRequestTypeDef definition

class StartSuiteRunRequestRequestTypeDef(TypedDict):
    suiteDefinitionId: str,
    suiteRunConfiguration: SuiteRunConfigurationTypeDef,  # (1)
    suiteDefinitionVersion: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See SuiteRunConfigurationTypeDef

GroupResultTypeDef#

# GroupResultTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import GroupResultTypeDef

def get_value() -> GroupResultTypeDef:
    return {
        "groupId": ...,
    }
# GroupResultTypeDef definition

class GroupResultTypeDef(TypedDict):
    groupId: NotRequired[str],
    groupName: NotRequired[str],
    tests: NotRequired[List[TestCaseRunTypeDef]],  # (1)
  1. See TestCaseRunTypeDef

TestResultTypeDef#

# TestResultTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import TestResultTypeDef

def get_value() -> TestResultTypeDef:
    return {
        "groups": ...,
    }
# TestResultTypeDef definition

class TestResultTypeDef(TypedDict):
    groups: NotRequired[List[GroupResultTypeDef]],  # (1)
  1. See GroupResultTypeDef

GetSuiteRunResponseTypeDef#

# GetSuiteRunResponseTypeDef usage example

from mypy_boto3_iotdeviceadvisor.type_defs import GetSuiteRunResponseTypeDef

def get_value() -> GetSuiteRunResponseTypeDef:
    return {
        "suiteDefinitionId": ...,
        "suiteDefinitionVersion": ...,
        "suiteRunId": ...,
        "suiteRunArn": ...,
        "suiteRunConfiguration": ...,
        "testResult": ...,
        "startTime": ...,
        "endTime": ...,
        "status": ...,
        "errorReason": ...,
        "tags": ...,
        "ResponseMetadata": ...,
    }
# GetSuiteRunResponseTypeDef definition

class GetSuiteRunResponseTypeDef(TypedDict):
    suiteDefinitionId: str,
    suiteDefinitionVersion: str,
    suiteRunId: str,
    suiteRunArn: str,
    suiteRunConfiguration: SuiteRunConfigurationTypeDef,  # (1)
    testResult: TestResultTypeDef,  # (2)
    startTime: datetime,
    endTime: datetime,
    status: SuiteRunStatusType,  # (3)
    errorReason: str,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See SuiteRunConfigurationTypeDef
  2. See TestResultTypeDef
  3. See SuiteRunStatusType
  4. See ResponseMetadataTypeDef