Skip to content

Type definitions#

Index > IoTDeviceAdvisor > Type definitions

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

SuiteDefinitionConfigurationUnionTypeDef#

# SuiteDefinitionConfigurationUnionTypeDef definition

SuiteDefinitionConfigurationUnionTypeDef = Union[
    SuiteDefinitionConfigurationTypeDef,  # (1)
    SuiteDefinitionConfigurationOutputTypeDef,  # (2)
]
  1. See SuiteDefinitionConfigurationTypeDef
  2. See SuiteDefinitionConfigurationOutputTypeDef

SuiteRunConfigurationUnionTypeDef#

# SuiteRunConfigurationUnionTypeDef definition

SuiteRunConfigurationUnionTypeDef = Union[
    SuiteRunConfigurationTypeDef,  # (1)
    SuiteRunConfigurationOutputTypeDef,  # (2)
]
  1. See SuiteRunConfigurationTypeDef
  2. See SuiteRunConfigurationOutputTypeDef

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DeleteSuiteDefinitionRequestRequestTypeDef#

# DeleteSuiteDefinitionRequestRequestTypeDef definition

class DeleteSuiteDefinitionRequestRequestTypeDef(TypedDict):
    suiteDefinitionId: str,

DeviceUnderTestTypeDef#

# DeviceUnderTestTypeDef definition

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

GetEndpointRequestRequestTypeDef#

# GetEndpointRequestRequestTypeDef definition

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

GetSuiteDefinitionRequestRequestTypeDef#

# GetSuiteDefinitionRequestRequestTypeDef definition

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

GetSuiteRunReportRequestRequestTypeDef#

# GetSuiteRunReportRequestRequestTypeDef definition

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

GetSuiteRunRequestRequestTypeDef#

# GetSuiteRunRequestRequestTypeDef definition

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

ListSuiteDefinitionsRequestRequestTypeDef#

# ListSuiteDefinitionsRequestRequestTypeDef definition

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

ListSuiteRunsRequestRequestTypeDef#

# ListSuiteRunsRequestRequestTypeDef definition

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

SuiteRunInformationTypeDef#

# 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 definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

StopSuiteRunRequestRequestTypeDef#

# StopSuiteRunRequestRequestTypeDef definition

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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

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

TestCaseScenarioTypeDef#

# 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 definition

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

CreateSuiteDefinitionResponseTypeDef#

# CreateSuiteDefinitionResponseTypeDef definition

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

GetEndpointResponseTypeDef#

# GetEndpointResponseTypeDef definition

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

GetSuiteRunReportResponseTypeDef#

# GetSuiteRunReportResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

StartSuiteRunResponseTypeDef#

# StartSuiteRunResponseTypeDef definition

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

UpdateSuiteDefinitionResponseTypeDef#

# UpdateSuiteDefinitionResponseTypeDef definition

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

SuiteDefinitionConfigurationOutputTypeDef#

# SuiteDefinitionConfigurationOutputTypeDef definition

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

SuiteDefinitionConfigurationTypeDef#

# 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 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

SuiteRunConfigurationOutputTypeDef#

# SuiteRunConfigurationOutputTypeDef definition

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

SuiteRunConfigurationTypeDef#

# SuiteRunConfigurationTypeDef definition

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

ListSuiteRunsResponseTypeDef#

# ListSuiteRunsResponseTypeDef definition

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

TestCaseRunTypeDef#

# 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

GetSuiteDefinitionResponseTypeDef#

# GetSuiteDefinitionResponseTypeDef definition

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

CreateSuiteDefinitionRequestRequestTypeDef#

# CreateSuiteDefinitionRequestRequestTypeDef definition

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

UpdateSuiteDefinitionRequestRequestTypeDef#

# UpdateSuiteDefinitionRequestRequestTypeDef definition

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

ListSuiteDefinitionsResponseTypeDef#

# ListSuiteDefinitionsResponseTypeDef definition

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

StartSuiteRunRequestRequestTypeDef#

# StartSuiteRunRequestRequestTypeDef definition

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

GroupResultTypeDef#

# GroupResultTypeDef definition

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

TestResultTypeDef#

# TestResultTypeDef definition

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

GetSuiteRunResponseTypeDef#

# GetSuiteRunResponseTypeDef definition

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