Skip to content

Commit a8b16e4

Browse files
author
awstools
committed
feat(client-panorama): Added Brand field to device listings.
1 parent 19e9658 commit a8b16e4

File tree

8 files changed

+96
-44
lines changed

8 files changed

+96
-44
lines changed

‎clients/client-panorama/README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ AWS SDK for JavaScript Panorama Client for Node.js, Browser and React Native.
1212
<p>
1313
<b>Overview</b>
1414
</p>
15-
<p>This is the <i>AWS Panorama API Reference</i>. For an introduction to the service, see
16-
<a href="https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html">What is AWS Panorama?</a>
17-
in the <i>AWS Panorama Developer Guide</i>.</p>
15+
<p>This is the <i>AWS Panorama API Reference</i>. For an introduction to the service, see <a href="https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html">What is AWS Panorama?</a> in the
16+
<i>AWS Panorama Developer Guide</i>.</p>
1817

1918
## Installing
2019

‎clients/client-panorama/src/Panorama.ts

+10-10
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,8 @@ import { PanoramaClient } from "./PanoramaClient";
160160
* <p>
161161
* <b>Overview</b>
162162
* </p>
163-
* <p>This is the <i>AWS Panorama API Reference</i>. For an introduction to the service, see
164-
* <a href="https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html">What is AWS Panorama?</a>
165-
* in the <i>AWS Panorama Developer Guide</i>.</p>
163+
* <p>This is the <i>AWS Panorama API Reference</i>. For an introduction to the service, see <a href="https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html">What is AWS Panorama?</a> in the
164+
* <i>AWS Panorama Developer Guide</i>.</p>
166165
*/
167166
export class Panorama extends PanoramaClient {
168167
/**
@@ -356,10 +355,10 @@ export class Panorama extends PanoramaClient {
356355

357356
/**
358357
* <p>Deletes a package.</p>
359-
* <note>
360-
* <p>To delete a package, you need permission to call <code>s3:DeleteObject</code>
361-
* in addition to permissions for the AWS Panorama API.</p>
362-
* </note>
358+
* <note>
359+
* <p>To delete a package, you need permission to call <code>s3:DeleteObject</code> in addition to permissions for
360+
* the AWS Panorama API.</p>
361+
* </note>
363362
*/
364363
public deletePackage(
365364
args: DeletePackageCommandInput,
@@ -1013,9 +1012,10 @@ export class Panorama extends PanoramaClient {
10131012
}
10141013

10151014
/**
1016-
* <p>Creates a device and returns a configuration archive. The configuration
1017-
* archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes.
1018-
* Transfer the configuration archive to the device with the included USB storage device within 5 minutes.</p>
1015+
* <p>Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a
1016+
* provisioning certificate that is valid for 5 minutes. Name the configuration archive
1017+
* <code>certificates-omni_<i>device-name</i>.zip</code> and transfer it to the device within 5
1018+
* minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.</p>
10191019
*/
10201020
public provisionDevice(
10211021
args: ProvisionDeviceCommandInput,

‎clients/client-panorama/src/PanoramaClient.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -371,9 +371,8 @@ export interface PanoramaClientResolvedConfig extends PanoramaClientResolvedConf
371371
* <p>
372372
* <b>Overview</b>
373373
* </p>
374-
* <p>This is the <i>AWS Panorama API Reference</i>. For an introduction to the service, see
375-
* <a href="https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html">What is AWS Panorama?</a>
376-
* in the <i>AWS Panorama Developer Guide</i>.</p>
374+
* <p>This is the <i>AWS Panorama API Reference</i>. For an introduction to the service, see <a href="https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html">What is AWS Panorama?</a> in the
375+
* <i>AWS Panorama Developer Guide</i>.</p>
377376
*/
378377
export class PanoramaClient extends __Client<
379378
__HttpHandlerOptions,

‎clients/client-panorama/src/commands/DeletePackageCommand.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ export interface DeletePackageCommandOutput extends DeletePackageResponse, __Met
2323

2424
/**
2525
* <p>Deletes a package.</p>
26-
* <note>
27-
* <p>To delete a package, you need permission to call <code>s3:DeleteObject</code>
28-
* in addition to permissions for the AWS Panorama API.</p>
29-
* </note>
26+
* <note>
27+
* <p>To delete a package, you need permission to call <code>s3:DeleteObject</code> in addition to permissions for
28+
* the AWS Panorama API.</p>
29+
* </note>
3030
* @example
3131
* Use a bare-bones client and the command you need to make an API call.
3232
* ```javascript

‎clients/client-panorama/src/commands/ProvisionDeviceCommand.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@ export interface ProvisionDeviceCommandInput extends ProvisionDeviceRequest {}
2222
export interface ProvisionDeviceCommandOutput extends ProvisionDeviceResponse, __MetadataBearer {}
2323

2424
/**
25-
* <p>Creates a device and returns a configuration archive. The configuration
26-
* archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes.
27-
* Transfer the configuration archive to the device with the included USB storage device within 5 minutes.</p>
25+
* <p>Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a
26+
* provisioning certificate that is valid for 5 minutes. Name the configuration archive
27+
* <code>certificates-omni_<i>device-name</i>.zip</code> and transfer it to the device within 5
28+
* minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.</p>
2829
* @example
2930
* Use a bare-bones client and the command you need to make an API call.
3031
* ```javascript

‎clients/client-panorama/src/models/models_0.ts

+26-11
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ export enum ApplicationInstanceHealthStatus {
5151

5252
export enum ApplicationInstanceStatus {
5353
DEPLOYMENT_ERROR = "DEPLOYMENT_ERROR",
54+
DEPLOYMENT_FAILED = "DEPLOYMENT_FAILED",
5455
DEPLOYMENT_IN_PROGRESS = "DEPLOYMENT_IN_PROGRESS",
5556
DEPLOYMENT_PENDING = "DEPLOYMENT_PENDING",
5657
DEPLOYMENT_REQUESTED = "DEPLOYMENT_REQUESTED",
@@ -205,9 +206,8 @@ export enum ConnectionType {
205206
}
206207

207208
/**
208-
* <p>Parameter overrides for an application instance. This is a JSON document that has a
209-
* single key (<code>PayloadData</code>) where the value is an escaped string
210-
* representation of the overrides document.</p>
209+
* <p>Parameter overrides for an application instance. This is a JSON document that has a single key
210+
* (<code>PayloadData</code>) where the value is an escaped string representation of the overrides document.</p>
211211
*/
212212
export type ManifestOverridesPayload =
213213
| ManifestOverridesPayload.PayloadDataMember
@@ -247,10 +247,9 @@ export namespace ManifestOverridesPayload {
247247
}
248248

249249
/**
250-
* <p>A application verion's manifest file. This is a JSON document that has a
251-
* single key (<code>PayloadData</code>) where the value is an escaped string
252-
* representation of the application manifest (<code>graph.json</code>). This
253-
* file is located in the <code>graphs</code> folder in your application source.</p>
250+
* <p>A application verion's manifest file. This is a JSON document that has a single key (<code>PayloadData</code>)
251+
* where the value is an escaped string representation of the application manifest (<code>graph.json</code>). This
252+
* file is located in the <code>graphs</code> folder in your application source.</p>
254253
*/
255254
export type ManifestPayload = ManifestPayload.PayloadDataMember | ManifestPayload.$UnknownMember;
256255

@@ -1059,8 +1058,8 @@ export interface DeletePackageRequest {
10591058
PackageId: string | undefined;
10601059

10611060
/**
1062-
* <p>Delete the package even if it has artifacts stored in its access point.
1063-
* Deletes the package's artifacts from Amazon S3.</p>
1061+
* <p>Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from
1062+
* Amazon S3.</p>
10641063
*/
10651064
ForceDelete?: boolean;
10661065
}
@@ -1316,6 +1315,11 @@ export namespace DescribeDeviceRequest {
13161315
});
13171316
}
13181317

1318+
export enum DeviceBrand {
1319+
AWS_PANORAMA = "AWS_PANORAMA",
1320+
LENOVO = "LENOVO",
1321+
}
1322+
13191323
export enum NetworkConnectionStatus {
13201324
CONNECTED = "CONNECTED",
13211325
CONNECTING = "CONNECTING",
@@ -1481,8 +1485,8 @@ export namespace EthernetPayload {
14811485
}
14821486

14831487
/**
1484-
* <p>Network time protocol (NTP) server settings. Use this option to connect to local NTP
1485-
* servers instead of <code>pool.ntp.org</code>.</p>
1488+
* <p>Network time protocol (NTP) server settings. Use this option to connect to local NTP servers instead of
1489+
* <code>pool.ntp.org</code>.</p>
14861490
*/
14871491
export interface NtpPayload {
14881492
/**
@@ -1628,6 +1632,11 @@ export interface DescribeDeviceResponse {
16281632
* <p>The most recent beta software release.</p>
16291633
*/
16301634
LatestAlternateSoftware?: string;
1635+
1636+
/**
1637+
* <p>The device's maker.</p>
1638+
*/
1639+
Brand?: DeviceBrand | string;
16311640
}
16321641

16331642
export namespace DescribeDeviceResponse {
@@ -2364,6 +2373,11 @@ export interface Device {
23642373
* <p>The device's lease expiration time.</p>
23652374
*/
23662375
LeaseExpirationTime?: Date;
2376+
2377+
/**
2378+
* <p>The device's maker.</p>
2379+
*/
2380+
Brand?: DeviceBrand | string;
23672381
}
23682382

23692383
export namespace Device {
@@ -2589,6 +2603,7 @@ export namespace ListApplicationInstanceNodeInstancesResponse {
25892603

25902604
export enum StatusFilter {
25912605
DEPLOYMENT_ERROR = "DEPLOYMENT_ERROR",
2606+
DEPLOYMENT_FAILED = "DEPLOYMENT_FAILED",
25922607
DEPLOYMENT_SUCCEEDED = "DEPLOYMENT_SUCCEEDED",
25932608
PROCESSING_DEPLOYMENT = "PROCESSING_DEPLOYMENT",
25942609
PROCESSING_REMOVAL = "PROCESSING_REMOVAL",

‎clients/client-panorama/src/protocols/Aws_restJson1.ts

+5
Original file line numberDiff line numberDiff line change
@@ -1849,6 +1849,7 @@ export const deserializeAws_restJson1DescribeDeviceCommand = async (
18491849
$metadata: deserializeMetadata(output),
18501850
AlternateSoftwares: undefined,
18511851
Arn: undefined,
1852+
Brand: undefined,
18521853
CreatedTime: undefined,
18531854
CurrentNetworkingStatus: undefined,
18541855
CurrentSoftware: undefined,
@@ -1872,6 +1873,9 @@ export const deserializeAws_restJson1DescribeDeviceCommand = async (
18721873
if (data.Arn !== undefined && data.Arn !== null) {
18731874
contents.Arn = __expectString(data.Arn);
18741875
}
1876+
if (data.Brand !== undefined && data.Brand !== null) {
1877+
contents.Brand = __expectString(data.Brand);
1878+
}
18751879
if (data.CreatedTime !== undefined && data.CreatedTime !== null) {
18761880
contents.CreatedTime = __expectNonNull(__parseEpochTimestamp(__expectNumber(data.CreatedTime)));
18771881
}
@@ -3820,6 +3824,7 @@ const deserializeAws_restJson1ConflictExceptionErrorArgumentList = (
38203824

38213825
const deserializeAws_restJson1Device = (output: any, context: __SerdeContext): Device => {
38223826
return {
3827+
Brand: __expectString(output.Brand),
38233828
CreatedTime:
38243829
output.CreatedTime !== undefined && output.CreatedTime !== null
38253830
? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.CreatedTime)))

‎codegen/sdk-codegen/aws-models/panorama.json

+43-10
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,10 @@
202202
{
203203
"value": "REMOVAL_SUCCEEDED",
204204
"name": "REMOVAL_SUCCEEDED"
205+
},
206+
{
207+
"value": "DEPLOYMENT_FAILED",
208+
"name": "DEPLOYMENT_FAILED"
205209
}
206210
]
207211
}
@@ -871,7 +875,7 @@
871875
}
872876
],
873877
"traits": {
874-
"smithy.api#documentation": "<p>Deletes a package.</p>\n <note>\n <p>To delete a package, you need permission to call <code>s3:DeleteObject</code>\n in addition to permissions for the AWS Panorama API.</p>\n </note>",
878+
"smithy.api#documentation": "<p>Deletes a package.</p>\n <note>\n <p>To delete a package, you need permission to call <code>s3:DeleteObject</code> in addition to permissions for\n the AWS Panorama API.</p>\n </note>",
875879
"smithy.api#http": {
876880
"method": "DELETE",
877881
"uri": "/packages/{PackageId}",
@@ -893,7 +897,7 @@
893897
"ForceDelete": {
894898
"target": "com.amazonaws.panorama#Boolean",
895899
"traits": {
896-
"smithy.api#documentation": "<p>Delete the package even if it has artifacts stored in its access point.\n Deletes the package's artifacts from Amazon S3.</p>",
900+
"smithy.api#documentation": "<p>Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from\n Amazon S3.</p>",
897901
"smithy.api#httpQuery": "ForceDelete"
898902
}
899903
}
@@ -1468,6 +1472,12 @@
14681472
"traits": {
14691473
"smithy.api#documentation": "<p>The most recent beta software release.</p>"
14701474
}
1475+
},
1476+
"Brand": {
1477+
"target": "com.amazonaws.panorama#DeviceBrand",
1478+
"traits": {
1479+
"smithy.api#documentation": "<p>The device's maker.</p>"
1480+
}
14711481
}
14721482
}
14731483
},
@@ -2175,6 +2185,12 @@
21752185
"traits": {
21762186
"smithy.api#documentation": "<p>The device's lease expiration time.</p>"
21772187
}
2188+
},
2189+
"Brand": {
2190+
"target": "com.amazonaws.panorama#DeviceBrand",
2191+
"traits": {
2192+
"smithy.api#documentation": "<p>The device's maker.</p>"
2193+
}
21782194
}
21792195
},
21802196
"traits": {
@@ -2190,6 +2206,21 @@
21902206
}
21912207
}
21922208
},
2209+
"com.amazonaws.panorama#DeviceBrand": {
2210+
"type": "string",
2211+
"traits": {
2212+
"smithy.api#enum": [
2213+
{
2214+
"value": "AWS_PANORAMA",
2215+
"name": "AWS_PANORAMA"
2216+
},
2217+
{
2218+
"value": "LENOVO",
2219+
"name": "LENOVO"
2220+
}
2221+
]
2222+
}
2223+
},
21932224
"com.amazonaws.panorama#DeviceConnectionStatus": {
21942225
"type": "string",
21952226
"traits": {
@@ -3380,7 +3411,7 @@
33803411
}
33813412
},
33823413
"traits": {
3383-
"smithy.api#documentation": "<p>Parameter overrides for an application instance. This is a JSON document that has a \n single key (<code>PayloadData</code>) where the value is an escaped string\n representation of the overrides document.</p>"
3414+
"smithy.api#documentation": "<p>Parameter overrides for an application instance. This is a JSON document that has a single key\n (<code>PayloadData</code>) where the value is an escaped string representation of the overrides document.</p>"
33843415
}
33853416
},
33863417
"com.amazonaws.panorama#ManifestOverridesPayloadData": {
@@ -3404,7 +3435,7 @@
34043435
}
34053436
},
34063437
"traits": {
3407-
"smithy.api#documentation": "<p>A application verion's manifest file. This is a JSON document that has a \n single key (<code>PayloadData</code>) where the value is an escaped string\n representation of the application manifest (<code>graph.json</code>). This\n file is located in the <code>graphs</code> folder in your application source.</p>"
3438+
"smithy.api#documentation": "<p>A application verion's manifest file. This is a JSON document that has a single key (<code>PayloadData</code>)\n where the value is an escaped string representation of the application manifest (<code>graph.json</code>). This\n file is located in the <code>graphs</code> folder in your application source.</p>"
34083439
}
34093440
},
34103441
"com.amazonaws.panorama#ManifestPayloadData": {
@@ -3976,7 +4007,7 @@
39764007
}
39774008
},
39784009
"traits": {
3979-
"smithy.api#documentation": "<p>Network time protocol (NTP) server settings. Use this option to connect to local NTP\n servers instead of <code>pool.ntp.org</code>.</p>"
4010+
"smithy.api#documentation": "<p>Network time protocol (NTP) server settings. Use this option to connect to local NTP servers instead of\n <code>pool.ntp.org</code>.</p>"
39804011
}
39814012
},
39824013
"com.amazonaws.panorama#NtpServerList": {
@@ -4059,16 +4090,14 @@
40594090
"aws.api#service": {
40604091
"sdkId": "Panorama",
40614092
"arnNamespace": "panorama",
4062-
"cloudFormationName": "OmniCloudServiceLambda",
4063-
"cloudTrailEventSource": "panorama.amazonaws.com",
4064-
"endpointPrefix": "panorama"
4093+
"awsProductName": "AWSPanorama"
40654094
},
40664095
"aws.auth#sigv4": {
40674096
"name": "panorama"
40684097
},
40694098
"aws.protocols#restJson1": {},
40704099
"smithy.api#cors": {},
4071-
"smithy.api#documentation": "<fullname>AWS Panorama</fullname>\n <p>\n <b>Overview</b>\n </p>\n <p>This is the <i>AWS Panorama API Reference</i>. For an introduction to the service, see \n <a href=\"https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html\">What is AWS Panorama?</a> \n in the <i>AWS Panorama Developer Guide</i>.</p>",
4100+
"smithy.api#documentation": "<fullname>AWS Panorama</fullname>\n <p>\n <b>Overview</b>\n </p>\n <p>This is the <i>AWS Panorama API Reference</i>. For an introduction to the service, see <a href=\"https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html\">What is AWS Panorama?</a> in the\n <i>AWS Panorama Developer Guide</i>.</p>",
40724101
"smithy.api#title": "AWS Panorama"
40734102
},
40744103
"version": "2019-07-24",
@@ -4605,7 +4634,7 @@
46054634
}
46064635
],
46074636
"traits": {
4608-
"smithy.api#documentation": "<p>Creates a device and returns a configuration archive. The configuration\n archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes.\n Transfer the configuration archive to the device with the included USB storage device within 5 minutes.</p>",
4637+
"smithy.api#documentation": "<p>Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a\n provisioning certificate that is valid for 5 minutes. Name the configuration archive\n <code>certificates-omni_<i>device-name</i>.zip</code> and transfer it to the device within 5\n minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.</p>",
46094638
"smithy.api#http": {
46104639
"method": "POST",
46114640
"uri": "/devices",
@@ -5003,6 +5032,10 @@
50035032
{
50045033
"value": "PROCESSING_REMOVAL",
50055034
"name": "PROCESSING_REMOVAL"
5035+
},
5036+
{
5037+
"value": "DEPLOYMENT_FAILED",
5038+
"name": "DEPLOYMENT_FAILED"
50065039
}
50075040
]
50085041
}

0 commit comments

Comments
 (0)