@aws-sdk/client-iotdeviceadvisor 3.378.0 → 3.382.0

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -1,4 +1,7 @@
 import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
 export interface ClientInputEndpointParameters {
     region?: string | Provider<string>;
     useDualstackEndpoint?: boolean | Provider<boolean>;

package/dist-types/index.d.ts

@@ -13,6 +13,7 @@
  */
 export * from "./IotDeviceAdvisorClient";
 export * from "./IotDeviceAdvisor";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
 export * from "./commands";
 export * from "./pagination";
 export * from "./models";

package/dist-types/models/models_0.d.ts

@@ -31,14 +31,17 @@ export declare class ConflictException extends __BaseException {
  */
 export interface DeviceUnderTest {
     /**
+     * @public
      * <p>Lists device's thing ARN.</p>
      */
     thingArn?: string;
     /**
+     * @public
      * <p>Lists device's certificate ARN.</p>
      */
     certificateArn?: string;
     /**
+     * @public
      * <p>Lists device's role ARN.</p>
      */
     deviceRoleArn?: string;
@@ -63,22 +66,27 @@ export type Protocol = (typeof Protocol)[keyof typeof Protocol];
  */
 export interface SuiteDefinitionConfiguration {
     /**
+     * @public
      * <p>Gets the suite definition name. This is a required parameter.</p>
      */
     suiteDefinitionName: string | undefined;
     /**
+     * @public
      * <p>Gets the devices configured.</p>
      */
     devices?: DeviceUnderTest[];
     /**
+     * @public
      * <p>Gets the tests intended for qualification in a suite.</p>
      */
     intendedForQualification?: boolean;
     /**
+     * @public
      * <p>Verifies if the test suite is a long duration test.</p>
      */
     isLongDurationTest?: boolean;
     /**
+     * @public
      * <p>Gets the test suite root group. This is a required parameter.
      *             For updating or creating the latest qualification suite,
      *             if <code>intendedForQualification</code> is set to true,
@@ -94,10 +102,12 @@ export interface SuiteDefinitionConfiguration {
      */
     rootGroup: string | undefined;
     /**
+     * @public
      * <p>Gets the device permission ARN. This is a required parameter.</p>
      */
     devicePermissionRoleArn: string | undefined;
     /**
+     * @public
      * <p>Sets the MQTT protocol that is configured in the suite definition.</p>
      */
     protocol?: Protocol | string;
@@ -107,10 +117,12 @@ export interface SuiteDefinitionConfiguration {
  */
 export interface CreateSuiteDefinitionRequest {
     /**
+     * @public
      * <p>Creates a Device Advisor test suite with suite definition configuration.</p>
      */
     suiteDefinitionConfiguration: SuiteDefinitionConfiguration | undefined;
     /**
+     * @public
      * <p>The tags to be attached to the suite definition.</p>
      */
     tags?: Record<string, string>;
@@ -120,18 +132,22 @@ export interface CreateSuiteDefinitionRequest {
  */
 export interface CreateSuiteDefinitionResponse {
     /**
+     * @public
      * <p>The UUID of the test suite created.</p>
      */
     suiteDefinitionId?: string;
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of the test suite.</p>
      */
     suiteDefinitionArn?: string;
     /**
+     * @public
      * <p>The suite definition name of the test suite. This is a required parameter.</p>
      */
     suiteDefinitionName?: string;
     /**
+     * @public
      * <p>The timestamp of when the test suite was created.</p>
      */
     createdAt?: Date;
@@ -165,6 +181,7 @@ export declare class ValidationException extends __BaseException {
  */
 export interface DeleteSuiteDefinitionRequest {
     /**
+     * @public
      * <p>Suite definition ID of the test suite to be deleted.</p>
      */
     suiteDefinitionId: string | undefined;
@@ -179,18 +196,22 @@ export interface DeleteSuiteDefinitionResponse {
  */
 export interface GetEndpointRequest {
     /**
+     * @public
      * <p>The thing ARN of the device. This is an optional parameter.</p>
      */
     thingArn?: string;
     /**
+     * @public
      * <p>The certificate ARN of the device. This is an optional parameter.</p>
      */
     certificateArn?: string;
     /**
+     * @public
      * <p>The device role ARN of the device. This is an optional parameter.</p>
      */
     deviceRoleArn?: string;
     /**
+     * @public
      * <p>The authentication method used during the device connection.</p>
      */
     authenticationMethod?: AuthenticationMethod | string;
@@ -200,6 +221,7 @@ export interface GetEndpointRequest {
  */
 export interface GetEndpointResponse {
     /**
+     * @public
      * <p>The response of an Device Advisor endpoint.</p>
      */
     endpoint?: string;
@@ -221,10 +243,12 @@ export declare class ResourceNotFoundException extends __BaseException {
  */
 export interface GetSuiteDefinitionRequest {
     /**
+     * @public
      * <p>Suite definition ID of the test suite to get.</p>
      */
     suiteDefinitionId: string | undefined;
     /**
+     * @public
      * <p>Suite definition version of the test suite to get.</p>
      */
     suiteDefinitionVersion?: string;
@@ -234,34 +258,42 @@ export interface GetSuiteDefinitionRequest {
  */
 export interface GetSuiteDefinitionResponse {
     /**
+     * @public
      * <p>Suite definition ID of the suite definition.</p>
      */
     suiteDefinitionId?: string;
     /**
+     * @public
      * <p>The ARN of the suite definition.</p>
      */
     suiteDefinitionArn?: string;
     /**
+     * @public
      * <p>Suite definition version of the suite definition.</p>
      */
     suiteDefinitionVersion?: string;
     /**
+     * @public
      * <p>Latest suite definition version of the suite definition.</p>
      */
     latestVersion?: string;
     /**
+     * @public
      * <p>Suite configuration of the suite definition.</p>
      */
     suiteDefinitionConfiguration?: SuiteDefinitionConfiguration;
     /**
+     * @public
      * <p>Date (in Unix epoch time) when the suite definition was created.</p>
      */
     createdAt?: Date;
     /**
+     * @public
      * <p>Date (in Unix epoch time) when the suite definition was last modified.</p>
      */
     lastModifiedAt?: Date;
     /**
+     * @public
      * <p>Tags attached to the suite definition.</p>
      */
     tags?: Record<string, string>;
@@ -271,10 +303,12 @@ export interface GetSuiteDefinitionResponse {
  */
 export interface GetSuiteRunRequest {
     /**
+     * @public
      * <p>Suite definition ID for the test suite run.</p>
      */
     suiteDefinitionId: string | undefined;
     /**
+     * @public
      * <p>Suite run ID for the test suite run.</p>
      */
     suiteRunId: string | undefined;
@@ -304,15 +338,18 @@ export type SuiteRunStatus = (typeof SuiteRunStatus)[keyof typeof SuiteRunStatus
  */
 export interface SuiteRunConfiguration {
     /**
+     * @public
      * <p>Sets the primary device for the test suite run. This requires a thing ARN or a
      *             certificate ARN.</p>
      */
     primaryDevice: DeviceUnderTest | undefined;
     /**
+     * @public
      * <p>Sets test case list.</p>
      */
     selectedTestList?: string[];
     /**
+     * @public
      * <p>TRUE if multiple test suites run in parallel.</p>
      */
     parallelRun?: boolean;
@@ -373,10 +410,12 @@ export type TestCaseScenarioType = (typeof TestCaseScenarioType)[keyof typeof Te
  */
 export interface TestCaseScenario {
     /**
+     * @public
      * <p>Provides test case scenario ID.</p>
      */
     testCaseScenarioId?: string;
     /**
+     * @public
      * <p>Provides test case scenario type. Type is one of the following:</p>
      *          <ul>
      *             <li>
@@ -389,6 +428,7 @@ export interface TestCaseScenario {
      */
     testCaseScenarioType?: TestCaseScenarioType | string;
     /**
+     * @public
      * <p>Provides the test case scenario status. Status is one of the following:</p>
      *          <ul>
      *             <li>
@@ -430,10 +470,12 @@ export interface TestCaseScenario {
      */
     status?: TestCaseScenarioStatus | string;
     /**
+     * @public
      * <p>Provides test case scenario failure result.</p>
      */
     failure?: string;
     /**
+     * @public
      * <p>Provides test case scenario system messages if any.</p>
      */
     systemMessage?: string;
@@ -444,18 +486,22 @@ export interface TestCaseScenario {
  */
 export interface TestCaseRun {
     /**
+     * @public
      * <p>Provides the test case run ID.</p>
      */
     testCaseRunId?: string;
     /**
+     * @public
      * <p>Provides the test case run definition ID.</p>
      */
     testCaseDefinitionId?: string;
     /**
+     * @public
      * <p>Provides the test case run definition name.</p>
      */
     testCaseDefinitionName?: string;
     /**
+     * @public
      * <p>Provides the test case run status. Status is one of the following:</p>
      *          <ul>
      *             <li>
@@ -497,26 +543,32 @@ export interface TestCaseRun {
      */
     status?: Status | string;
     /**
+     * @public
      * <p>Provides test case run start time.</p>
      */
     startTime?: Date;
     /**
+     * @public
      * <p>Provides test case run end time.</p>
      */
     endTime?: Date;
     /**
+     * @public
      * <p>Provides test case run log URL.</p>
      */
     logUrl?: string;
     /**
+     * @public
      * <p>Provides test case run warnings.</p>
      */
     warnings?: string;
     /**
+     * @public
      * <p>Provides test case run failure result.</p>
      */
     failure?: string;
     /**
+     * @public
      * <p> Provides the test scenarios for the test case run. </p>
      */
     testScenarios?: TestCaseScenario[];
@@ -527,14 +579,17 @@ export interface TestCaseRun {
  */
 export interface GroupResult {
     /**
+     * @public
      * <p>Group result ID.</p>
      */
     groupId?: string;
     /**
+     * @public
      * <p>Group Result Name.</p>
      */
     groupName?: string;
     /**
+     * @public
      * <p>Tests under Group Result.</p>
      */
     tests?: TestCaseRun[];
@@ -545,6 +600,7 @@ export interface GroupResult {
  */
 export interface TestResult {
     /**
+     * @public
      * <p>Show each group of test results.</p>
      */
     groups?: GroupResult[];
@@ -554,46 +610,57 @@ export interface TestResult {
  */
 export interface GetSuiteRunResponse {
     /**
+     * @public
      * <p>Suite definition ID for the test suite run.</p>
      */
     suiteDefinitionId?: string;
     /**
+     * @public
      * <p>Suite definition version for the test suite run.</p>
      */
     suiteDefinitionVersion?: string;
     /**
+     * @public
      * <p>Suite run ID for the test suite run.</p>
      */
     suiteRunId?: string;
     /**
+     * @public
      * <p>The ARN of the suite run.</p>
      */
     suiteRunArn?: string;
     /**
+     * @public
      * <p>Suite run configuration for the test suite run.</p>
      */
     suiteRunConfiguration?: SuiteRunConfiguration;
     /**
+     * @public
      * <p>Test results for the test suite run.</p>
      */
     testResult?: TestResult;
     /**
+     * @public
      * <p>Date (in Unix epoch time) when the test suite run started.</p>
      */
     startTime?: Date;
     /**
+     * @public
      * <p>Date (in Unix epoch time) when the test suite run ended.</p>
      */
     endTime?: Date;
     /**
+     * @public
      * <p>Status for the test suite run.</p>
      */
     status?: SuiteRunStatus | string;
     /**
+     * @public
      * <p>Error reason for any test suite run failure.</p>
      */
     errorReason?: string;
     /**
+     * @public
      * <p>The tags attached to the suite run.</p>
      */
     tags?: Record<string, string>;
@@ -603,10 +670,12 @@ export interface GetSuiteRunResponse {
  */
 export interface GetSuiteRunReportRequest {
     /**
+     * @public
      * <p>Suite definition ID of the test suite.</p>
      */
     suiteDefinitionId: string | undefined;
     /**
+     * @public
      * <p>Suite run ID of the test suite run.</p>
      */
     suiteRunId: string | undefined;
@@ -616,6 +685,7 @@ export interface GetSuiteRunReportRequest {
  */
 export interface GetSuiteRunReportResponse {
     /**
+     * @public
      * <p>Download URL of the qualification report.</p>
      */
     qualificationReportDownloadUrl?: string;
@@ -625,10 +695,12 @@ export interface GetSuiteRunReportResponse {
  */
 export interface ListSuiteDefinitionsRequest {
     /**
+     * @public
      * <p>The maximum number of results to return at once.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>A token used to get the next set of results.</p>
      */
     nextToken?: string;
@@ -639,30 +711,37 @@ export interface ListSuiteDefinitionsRequest {
  */
 export interface SuiteDefinitionInformation {
     /**
+     * @public
      * <p>Suite definition ID of the test suite.</p>
      */
     suiteDefinitionId?: string;
     /**
+     * @public
      * <p>Suite name of the test suite.</p>
      */
     suiteDefinitionName?: string;
     /**
+     * @public
      * <p>Specifies the devices that are under test for the test suite.</p>
      */
     defaultDevices?: DeviceUnderTest[];
     /**
+     * @public
      * <p>Specifies if the test suite is intended for qualification.</p>
      */
     intendedForQualification?: boolean;
     /**
+     * @public
      * <p>Verifies if the test suite is a long duration test.</p>
      */
     isLongDurationTest?: boolean;
     /**
+     * @public
      * <p>Gets the MQTT protocol that is configured in the suite definition.</p>
      */
     protocol?: Protocol | string;
     /**
+     * @public
      * <p>Date (in Unix epoch time) when the test suite was created.</p>
      */
     createdAt?: Date;
@@ -672,11 +751,13 @@ export interface SuiteDefinitionInformation {
  */
 export interface ListSuiteDefinitionsResponse {
     /**
+     * @public
      * <p>An array of objects that provide summaries of information about the suite definitions
      *             in the list.</p>
      */
     suiteDefinitionInformationList?: SuiteDefinitionInformation[];
     /**
+     * @public
      * <p>A token used to get the next set of results.</p>
      */
     nextToken?: string;
@@ -686,20 +767,24 @@ export interface ListSuiteDefinitionsResponse {
  */
 export interface ListSuiteRunsRequest {
     /**
+     * @public
      * <p>Lists the test suite runs of the specified test suite based on suite definition
      *             ID.</p>
      */
     suiteDefinitionId?: string;
     /**
+     * @public
      * <p>Must be passed along with <code>suiteDefinitionId</code>. Lists the test suite runs of
      *             the specified test suite based on suite definition version.</p>
      */
     suiteDefinitionVersion?: string;
     /**
+     * @public
      * <p>The maximum number of results to return at once.</p>
      */
     maxResults?: number;
     /**
+     * @public
      * <p>A token to retrieve the next set of results.</p>
      */
     nextToken?: string;
@@ -711,42 +796,52 @@ export interface ListSuiteRunsRequest {
  */
 export interface SuiteRunInformation {
     /**
+     * @public
      * <p>Suite definition ID of the suite run.</p>
      */
     suiteDefinitionId?: string;
     /**
+     * @public
      * <p>Suite definition version of the suite run.</p>
      */
     suiteDefinitionVersion?: string;
     /**
+     * @public
      * <p>Suite definition name of the suite run.</p>
      */
     suiteDefinitionName?: string;
     /**
+     * @public
      * <p>Suite run ID of the suite run.</p>
      */
     suiteRunId?: string;
     /**
+     * @public
      * <p>Date (in Unix epoch time) when the suite run was created.</p>
      */
     createdAt?: Date;
     /**
+     * @public
      * <p>Date (in Unix epoch time) when the suite run was started.</p>
      */
     startedAt?: Date;
     /**
+     * @public
      * <p>Date (in Unix epoch time) when the suite run ended.</p>
      */
     endAt?: Date;
     /**
+     * @public
      * <p>Status of the suite run.</p>
      */
     status?: SuiteRunStatus | string;
     /**
+     * @public
      * <p>Number of test cases that passed in the suite run.</p>
      */
     passed?: number;
     /**
+     * @public
      * <p>Number of test cases that failed in the suite run.</p>
      */
     failed?: number;
@@ -756,11 +851,13 @@ export interface SuiteRunInformation {
  */
 export interface ListSuiteRunsResponse {
     /**
+     * @public
      * <p>An array of objects that provide summaries of information about the suite runs in the
      *             list.</p>
      */
     suiteRunsList?: SuiteRunInformation[];
     /**
+     * @public
      * <p>A token to retrieve the next set of results.</p>
      */
     nextToken?: string;
@@ -770,6 +867,7 @@ export interface ListSuiteRunsResponse {
  */
 export interface ListTagsForResourceRequest {
     /**
+     * @public
      * <p>The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or
      *             SuiteRun ARN.</p>
      */
@@ -780,6 +878,7 @@ export interface ListTagsForResourceRequest {
  */
 export interface ListTagsForResourceResponse {
     /**
+     * @public
      * <p>The tags attached to the IoT Device Advisor resource.</p>
      */
     tags?: Record<string, string>;
@@ -789,18 +888,22 @@ export interface ListTagsForResourceResponse {
  */
 export interface StartSuiteRunRequest {
     /**
+     * @public
      * <p>Suite definition ID of the test suite.</p>
      */
     suiteDefinitionId: string | undefined;
     /**
+     * @public
      * <p>Suite definition version of the test suite.</p>
      */
     suiteDefinitionVersion?: string;
     /**
+     * @public
      * <p>Suite run configuration.</p>
      */
     suiteRunConfiguration: SuiteRunConfiguration | undefined;
     /**
+     * @public
      * <p>The tags to be attached to the suite run.</p>
      */
     tags?: Record<string, string>;
@@ -810,18 +913,22 @@ export interface StartSuiteRunRequest {
  */
 export interface StartSuiteRunResponse {
     /**
+     * @public
      * <p>Suite Run ID of the started suite run.</p>
      */
     suiteRunId?: string;
     /**
+     * @public
      * <p>Amazon Resource Name (ARN) of the started suite run.</p>
      */
     suiteRunArn?: string;
     /**
+     * @public
      * <p>Starts a Device Advisor test suite run based on suite create time.</p>
      */
     createdAt?: Date;
     /**
+     * @public
      * <p>The response of an Device Advisor test endpoint.</p>
      */
     endpoint?: string;
@@ -831,10 +938,12 @@ export interface StartSuiteRunResponse {
  */
 export interface StopSuiteRunRequest {
     /**
+     * @public
      * <p>Suite definition ID of the test suite run to be stopped.</p>
      */
     suiteDefinitionId: string | undefined;
     /**
+     * @public
      * <p>Suite run ID of the test suite run to be stopped.</p>
      */
     suiteRunId: string | undefined;
@@ -849,11 +958,13 @@ export interface StopSuiteRunResponse {
  */
 export interface TagResourceRequest {
     /**
+     * @public
      * <p>The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or
      *             SuiteRun ARN.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>The tags to be attached to the IoT Device Advisor resource.</p>
      */
     tags: Record<string, string> | undefined;
@@ -868,11 +979,13 @@ export interface TagResourceResponse {
  */
 export interface UntagResourceRequest {
     /**
+     * @public
      * <p>The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or
      *             SuiteRun ARN.</p>
      */
     resourceArn: string | undefined;
     /**
+     * @public
      * <p>List of tag keys to remove from the IoT Device Advisor resource.</p>
      */
     tagKeys: string[] | undefined;
@@ -887,10 +1000,12 @@ export interface UntagResourceResponse {
  */
 export interface UpdateSuiteDefinitionRequest {
     /**
+     * @public
      * <p>Suite definition ID of the test suite to be updated.</p>
      */
     suiteDefinitionId: string | undefined;
     /**
+     * @public
      * <p>Updates a Device Advisor test suite with suite definition configuration.</p>
      */
     suiteDefinitionConfiguration: SuiteDefinitionConfiguration | undefined;
@@ -900,26 +1015,32 @@ export interface UpdateSuiteDefinitionRequest {
  */
 export interface UpdateSuiteDefinitionResponse {
     /**
+     * @public
      * <p>Suite definition ID of the updated test suite.</p>
      */
     suiteDefinitionId?: string;
     /**
+     * @public
      * <p>Amazon Resource Name (ARN) of the updated test suite.</p>
      */
     suiteDefinitionArn?: string;
     /**
+     * @public
      * <p>Updates the suite definition name. This is a required parameter.</p>
      */
     suiteDefinitionName?: string;
     /**
+     * @public
      * <p>Suite definition version of the updated test suite.</p>
      */
     suiteDefinitionVersion?: string;
     /**
+     * @public
      * <p>Timestamp of when the test suite was created.</p>
      */
     createdAt?: Date;
     /**
+     * @public
      * <p>Timestamp of when the test suite was updated.</p>
      */
     lastUpdatedAt?: Date;

package/dist-types/ts3.4/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./IotDeviceAdvisorClient";
 export * from "./IotDeviceAdvisor";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
 export * from "./commands";
 export * from "./pagination";
 export * from "./models";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-iotdeviceadvisor",
   "description": "AWS SDK for JavaScript Iotdeviceadvisor Client for Node.js, Browser and React Native",
-  "version": "3.378.0",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.378.0",
-    "@aws-sdk/credential-provider-node": "3.378.0",
-    "@aws-sdk/middleware-host-header": "3.378.0",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
+    "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
-    "@aws-sdk/middleware-signing": "3.378.0",
-    "@aws-sdk/middleware-user-agent": "3.378.0",
+    "@aws-sdk/middleware-signing": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",