@aws-sdk/client-greengrassv2 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/dist-types/GreengrassV2.d.ts +30 -0
  2. package/dist-types/GreengrassV2Client.d.ts +24 -4
  3. package/dist-types/commands/AssociateServiceRoleToAccountCommand.d.ts +16 -0
  4. package/dist-types/commands/BatchAssociateClientDeviceWithCoreDeviceCommand.d.ts +16 -0
  5. package/dist-types/commands/BatchDisassociateClientDeviceFromCoreDeviceCommand.d.ts +16 -0
  6. package/dist-types/commands/CancelDeploymentCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateComponentVersionCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateDeploymentCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteComponentCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteCoreDeviceCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteDeploymentCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeComponentCommand.d.ts +16 -0
  13. package/dist-types/commands/DisassociateServiceRoleFromAccountCommand.d.ts +16 -0
  14. package/dist-types/commands/GetComponentCommand.d.ts +16 -0
  15. package/dist-types/commands/GetComponentVersionArtifactCommand.d.ts +16 -0
  16. package/dist-types/commands/GetConnectivityInfoCommand.d.ts +16 -0
  17. package/dist-types/commands/GetCoreDeviceCommand.d.ts +16 -0
  18. package/dist-types/commands/GetDeploymentCommand.d.ts +16 -0
  19. package/dist-types/commands/GetServiceRoleForAccountCommand.d.ts +16 -0
  20. package/dist-types/commands/ListClientDevicesAssociatedWithCoreDeviceCommand.d.ts +16 -0
  21. package/dist-types/commands/ListComponentVersionsCommand.d.ts +16 -0
  22. package/dist-types/commands/ListComponentsCommand.d.ts +16 -0
  23. package/dist-types/commands/ListCoreDevicesCommand.d.ts +16 -0
  24. package/dist-types/commands/ListDeploymentsCommand.d.ts +16 -0
  25. package/dist-types/commands/ListEffectiveDeploymentsCommand.d.ts +16 -0
  26. package/dist-types/commands/ListInstalledComponentsCommand.d.ts +16 -0
  27. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  28. package/dist-types/commands/ResolveComponentCandidatesCommand.d.ts +16 -0
  29. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  30. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  31. package/dist-types/commands/UpdateConnectivityInfoCommand.d.ts +16 -0
  32. package/dist-types/models/GreengrassV2ServiceException.d.ts +2 -0
  33. package/dist-types/models/models_0.d.ts +274 -0
  34. package/dist-types/pagination/Interfaces.d.ts +3 -0
  35. package/dist-types/pagination/ListClientDevicesAssociatedWithCoreDevicePaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListComponentVersionsPaginator.d.ts +3 -0
  37. package/dist-types/pagination/ListComponentsPaginator.d.ts +3 -0
  38. package/dist-types/pagination/ListCoreDevicesPaginator.d.ts +3 -0
  39. package/dist-types/pagination/ListDeploymentsPaginator.d.ts +3 -0
  40. package/dist-types/pagination/ListEffectiveDeploymentsPaginator.d.ts +3 -0
  41. package/dist-types/pagination/ListInstalledComponentsPaginator.d.ts +3 -0
  42. package/package.json +3 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GreengrassV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GreengrassV2Client";
5
5
  import { DeleteComponentRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteComponentCommand}.
8
10
  */
9
11
  export interface DeleteComponentCommandInput extends DeleteComponentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteComponentCommand}.
13
17
  */
14
18
  export interface DeleteComponentCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a version of a component from IoT Greengrass.</p>
18
23
  * <note>
19
24
  * <p>This operation deletes the component's recipe and artifacts. As a result, deployments
@@ -31,6 +36,8 @@ export interface DeleteComponentCommandOutput extends __MetadataBearer {
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param DeleteComponentCommandInput - {@link DeleteComponentCommandInput}
40
+ * @returns {@link DeleteComponentCommandOutput}
34
41
  * @see {@link DeleteComponentCommandInput} for command's `input` shape.
35
42
  * @see {@link DeleteComponentCommandOutput} for command's `response` shape.
36
43
  * @see {@link GreengrassV2ClientResolvedConfig | config} for GreengrassV2Client's `config` shape.
@@ -61,11 +68,20 @@ export interface DeleteComponentCommandOutput extends __MetadataBearer {
61
68
  export declare class DeleteComponentCommand extends $Command<DeleteComponentCommandInput, DeleteComponentCommandOutput, GreengrassV2ClientResolvedConfig> {
62
69
  readonly input: DeleteComponentCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DeleteComponentCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GreengrassV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteComponentCommandInput, DeleteComponentCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GreengrassV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GreengrassV2Client";
5
5
  import { DeleteCoreDeviceRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteCoreDeviceCommand}.
8
10
  */
9
11
  export interface DeleteCoreDeviceCommandInput extends DeleteCoreDeviceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteCoreDeviceCommand}.
13
17
  */
14
18
  export interface DeleteCoreDeviceCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a Greengrass core device, which is an IoT thing. This operation removes the core
18
23
  * device from the list of core devices. This operation doesn't delete the IoT thing. For more
19
24
  * information about how to delete the IoT thing, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteThing.html">DeleteThing</a> in the
@@ -28,6 +33,8 @@ export interface DeleteCoreDeviceCommandOutput extends __MetadataBearer {
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DeleteCoreDeviceCommandInput - {@link DeleteCoreDeviceCommandInput}
37
+ * @returns {@link DeleteCoreDeviceCommandOutput}
31
38
  * @see {@link DeleteCoreDeviceCommandInput} for command's `input` shape.
32
39
  * @see {@link DeleteCoreDeviceCommandOutput} for command's `response` shape.
33
40
  * @see {@link GreengrassV2ClientResolvedConfig | config} for GreengrassV2Client's `config` shape.
@@ -58,11 +65,20 @@ export interface DeleteCoreDeviceCommandOutput extends __MetadataBearer {
58
65
  export declare class DeleteCoreDeviceCommand extends $Command<DeleteCoreDeviceCommandInput, DeleteCoreDeviceCommandOutput, GreengrassV2ClientResolvedConfig> {
59
66
  readonly input: DeleteCoreDeviceCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DeleteCoreDeviceCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GreengrassV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCoreDeviceCommandInput, DeleteCoreDeviceCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GreengrassV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GreengrassV2Client";
5
5
  import { DeleteDeploymentRequest } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteDeploymentCommand}.
8
10
  */
9
11
  export interface DeleteDeploymentCommandInput extends DeleteDeploymentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteDeploymentCommand}.
13
17
  */
14
18
  export interface DeleteDeploymentCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a deployment. To delete an active deployment, you must first cancel it. For more
18
23
  * information, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_CancelDeployment.html">CancelDeployment</a>.</p>
19
24
  * <p>Deleting a deployment doesn't affect core devices that run that deployment, because core
@@ -29,6 +34,8 @@ export interface DeleteDeploymentCommandOutput extends __MetadataBearer {
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteDeploymentCommandInput - {@link DeleteDeploymentCommandInput}
38
+ * @returns {@link DeleteDeploymentCommandOutput}
32
39
  * @see {@link DeleteDeploymentCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteDeploymentCommandOutput} for command's `response` shape.
34
41
  * @see {@link GreengrassV2ClientResolvedConfig | config} for GreengrassV2Client's `config` shape.
@@ -59,11 +66,20 @@ export interface DeleteDeploymentCommandOutput extends __MetadataBearer {
59
66
  export declare class DeleteDeploymentCommand extends $Command<DeleteDeploymentCommandInput, DeleteDeploymentCommandOutput, GreengrassV2ClientResolvedConfig> {
60
67
  readonly input: DeleteDeploymentCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: DeleteDeploymentCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GreengrassV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDeploymentCommandInput, DeleteDeploymentCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GreengrassV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GreengrassV2Client";
5
5
  import { DescribeComponentRequest, DescribeComponentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeComponentCommand}.
8
10
  */
9
11
  export interface DescribeComponentCommandInput extends DescribeComponentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeComponentCommand}.
13
17
  */
14
18
  export interface DescribeComponentCommandOutput extends DescribeComponentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves metadata for a version of a component.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeComponentCommandOutput extends DescribeComponentRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeComponentCommandInput - {@link DescribeComponentCommandInput}
34
+ * @returns {@link DescribeComponentCommandOutput}
28
35
  * @see {@link DescribeComponentCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeComponentCommandOutput} for command's `response` shape.
30
37
  * @see {@link GreengrassV2ClientResolvedConfig | config} for GreengrassV2Client's `config` shape.
@@ -51,11 +58,20 @@ export interface DescribeComponentCommandOutput extends DescribeComponentRespons
51
58
  export declare class DescribeComponentCommand extends $Command<DescribeComponentCommandInput, DescribeComponentCommandOutput, GreengrassV2ClientResolvedConfig> {
52
59
  readonly input: DescribeComponentCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DescribeComponentCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GreengrassV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeComponentCommandInput, DescribeComponentCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GreengrassV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GreengrassV2Client";
5
5
  import { DisassociateServiceRoleFromAccountRequest, DisassociateServiceRoleFromAccountResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisassociateServiceRoleFromAccountCommand}.
8
10
  */
9
11
  export interface DisassociateServiceRoleFromAccountCommandInput extends DisassociateServiceRoleFromAccountRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisassociateServiceRoleFromAccountCommand}.
13
17
  */
14
18
  export interface DisassociateServiceRoleFromAccountCommandOutput extends DisassociateServiceRoleFromAccountResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
18
23
  * Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device
19
24
  * connectivity information. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html">Greengrass service role</a> in
@@ -28,6 +33,8 @@ export interface DisassociateServiceRoleFromAccountCommandOutput extends Disasso
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DisassociateServiceRoleFromAccountCommandInput - {@link DisassociateServiceRoleFromAccountCommandInput}
37
+ * @returns {@link DisassociateServiceRoleFromAccountCommandOutput}
31
38
  * @see {@link DisassociateServiceRoleFromAccountCommandInput} for command's `input` shape.
32
39
  * @see {@link DisassociateServiceRoleFromAccountCommandOutput} for command's `response` shape.
33
40
  * @see {@link GreengrassV2ClientResolvedConfig | config} for GreengrassV2Client's `config` shape.
@@ -40,11 +47,20 @@ export interface DisassociateServiceRoleFromAccountCommandOutput extends Disasso
40
47
  export declare class DisassociateServiceRoleFromAccountCommand extends $Command<DisassociateServiceRoleFromAccountCommandInput, DisassociateServiceRoleFromAccountCommandOutput, GreengrassV2ClientResolvedConfig> {
41
48
  readonly input: DisassociateServiceRoleFromAccountCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: DisassociateServiceRoleFromAccountCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GreengrassV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateServiceRoleFromAccountCommandInput, DisassociateServiceRoleFromAccountCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GreengrassV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GreengrassV2Client";
5
5
  import { GetComponentRequest, GetComponentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetComponentCommand}.
8
10
  */
9
11
  export interface GetComponentCommandInput extends GetComponentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetComponentCommand}.
13
17
  */
14
18
  export interface GetComponentCommandOutput extends GetComponentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the recipe for a version of a component.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetComponentCommandOutput extends GetComponentResponse, __Metad
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetComponentCommandInput - {@link GetComponentCommandInput}
34
+ * @returns {@link GetComponentCommandOutput}
28
35
  * @see {@link GetComponentCommandInput} for command's `input` shape.
29
36
  * @see {@link GetComponentCommandOutput} for command's `response` shape.
30
37
  * @see {@link GreengrassV2ClientResolvedConfig | config} for GreengrassV2Client's `config` shape.
@@ -51,11 +58,20 @@ export interface GetComponentCommandOutput extends GetComponentResponse, __Metad
51
58
  export declare class GetComponentCommand extends $Command<GetComponentCommandInput, GetComponentCommandOutput, GreengrassV2ClientResolvedConfig> {
52
59
  readonly input: GetComponentCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: GetComponentCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GreengrassV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetComponentCommandInput, GetComponentCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GreengrassV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GreengrassV2Client";
5
5
  import { GetComponentVersionArtifactRequest, GetComponentVersionArtifactResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetComponentVersionArtifactCommand}.
8
10
  */
9
11
  export interface GetComponentVersionArtifactCommandInput extends GetComponentVersionArtifactRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetComponentVersionArtifactCommand}.
13
17
  */
14
18
  export interface GetComponentVersionArtifactCommandOutput extends GetComponentVersionArtifactResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this
18
23
  * operation to identify the URL that they can use to download an artifact to install.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface GetComponentVersionArtifactCommandOutput extends GetComponentVe
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param GetComponentVersionArtifactCommandInput - {@link GetComponentVersionArtifactCommandInput}
35
+ * @returns {@link GetComponentVersionArtifactCommandOutput}
29
36
  * @see {@link GetComponentVersionArtifactCommandInput} for command's `input` shape.
30
37
  * @see {@link GetComponentVersionArtifactCommandOutput} for command's `response` shape.
31
38
  * @see {@link GreengrassV2ClientResolvedConfig | config} for GreengrassV2Client's `config` shape.
@@ -52,11 +59,20 @@ export interface GetComponentVersionArtifactCommandOutput extends GetComponentVe
52
59
  export declare class GetComponentVersionArtifactCommand extends $Command<GetComponentVersionArtifactCommandInput, GetComponentVersionArtifactCommandOutput, GreengrassV2ClientResolvedConfig> {
53
60
  readonly input: GetComponentVersionArtifactCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: GetComponentVersionArtifactCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GreengrassV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetComponentVersionArtifactCommandInput, GetComponentVersionArtifactCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GreengrassV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GreengrassV2Client";
5
5
  import { GetConnectivityInfoRequest, GetConnectivityInfoResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetConnectivityInfoCommand}.
8
10
  */
9
11
  export interface GetConnectivityInfoCommandInput extends GetConnectivityInfoRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetConnectivityInfoCommand}.
13
17
  */
14
18
  export interface GetConnectivityInfoCommandOutput extends GetConnectivityInfoResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves connectivity information for a Greengrass core device.</p>
18
23
  * <p>Connectivity information includes endpoints and ports where client devices
19
24
  * can connect to an MQTT broker on the core device. When a client device
@@ -31,6 +36,8 @@ export interface GetConnectivityInfoCommandOutput extends GetConnectivityInfoRes
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param GetConnectivityInfoCommandInput - {@link GetConnectivityInfoCommandInput}
40
+ * @returns {@link GetConnectivityInfoCommandOutput}
34
41
  * @see {@link GetConnectivityInfoCommandInput} for command's `input` shape.
35
42
  * @see {@link GetConnectivityInfoCommandOutput} for command's `response` shape.
36
43
  * @see {@link GreengrassV2ClientResolvedConfig | config} for GreengrassV2Client's `config` shape.
@@ -47,11 +54,20 @@ export interface GetConnectivityInfoCommandOutput extends GetConnectivityInfoRes
47
54
  export declare class GetConnectivityInfoCommand extends $Command<GetConnectivityInfoCommandInput, GetConnectivityInfoCommandOutput, GreengrassV2ClientResolvedConfig> {
48
55
  readonly input: GetConnectivityInfoCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: GetConnectivityInfoCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GreengrassV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConnectivityInfoCommandInput, GetConnectivityInfoCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GreengrassV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GreengrassV2Client";
5
5
  import { GetCoreDeviceRequest, GetCoreDeviceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetCoreDeviceCommand}.
8
10
  */
9
11
  export interface GetCoreDeviceCommandInput extends GetCoreDeviceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetCoreDeviceCommand}.
13
17
  */
14
18
  export interface GetCoreDeviceCommandOutput extends GetCoreDeviceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves metadata for a Greengrass core device.</p>
18
23
  * <note>
19
24
  * <p>IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core
@@ -52,6 +57,8 @@ export interface GetCoreDeviceCommandOutput extends GetCoreDeviceResponse, __Met
52
57
  * const response = await client.send(command);
53
58
  * ```
54
59
  *
60
+ * @param GetCoreDeviceCommandInput - {@link GetCoreDeviceCommandInput}
61
+ * @returns {@link GetCoreDeviceCommandOutput}
55
62
  * @see {@link GetCoreDeviceCommandInput} for command's `input` shape.
56
63
  * @see {@link GetCoreDeviceCommandOutput} for command's `response` shape.
57
64
  * @see {@link GreengrassV2ClientResolvedConfig | config} for GreengrassV2Client's `config` shape.
@@ -78,11 +85,20 @@ export interface GetCoreDeviceCommandOutput extends GetCoreDeviceResponse, __Met
78
85
  export declare class GetCoreDeviceCommand extends $Command<GetCoreDeviceCommandInput, GetCoreDeviceCommandOutput, GreengrassV2ClientResolvedConfig> {
79
86
  readonly input: GetCoreDeviceCommandInput;
80
87
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
88
+ /**
89
+ * @public
90
+ */
81
91
  constructor(input: GetCoreDeviceCommandInput);
82
92
  /**
83
93
  * @internal
84
94
  */
85
95
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GreengrassV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetCoreDeviceCommandInput, GetCoreDeviceCommandOutput>;
96
+ /**
97
+ * @internal
98
+ */
86
99
  private serialize;
100
+ /**
101
+ * @internal
102
+ */
87
103
  private deserialize;
88
104
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GreengrassV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GreengrassV2Client";
5
5
  import { GetDeploymentRequest, GetDeploymentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetDeploymentCommand}.
8
10
  */
9
11
  export interface GetDeploymentCommandInput extends GetDeploymentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetDeploymentCommand}.
13
17
  */
14
18
  export interface GetDeploymentCommandOutput extends GetDeploymentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets a deployment. Deployments define the components that run on Greengrass core devices.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface GetDeploymentCommandOutput extends GetDeploymentResponse, __Met
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param GetDeploymentCommandInput - {@link GetDeploymentCommandInput}
34
+ * @returns {@link GetDeploymentCommandOutput}
28
35
  * @see {@link GetDeploymentCommandInput} for command's `input` shape.
29
36
  * @see {@link GetDeploymentCommandOutput} for command's `response` shape.
30
37
  * @see {@link GreengrassV2ClientResolvedConfig | config} for GreengrassV2Client's `config` shape.
@@ -51,11 +58,20 @@ export interface GetDeploymentCommandOutput extends GetDeploymentResponse, __Met
51
58
  export declare class GetDeploymentCommand extends $Command<GetDeploymentCommandInput, GetDeploymentCommandOutput, GreengrassV2ClientResolvedConfig> {
52
59
  readonly input: GetDeploymentCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: GetDeploymentCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GreengrassV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDeploymentCommandInput, GetDeploymentCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GreengrassV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GreengrassV2Client";
5
5
  import { GetServiceRoleForAccountRequest, GetServiceRoleForAccountResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetServiceRoleForAccountCommand}.
8
10
  */
9
11
  export interface GetServiceRoleForAccountCommandInput extends GetServiceRoleForAccountRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetServiceRoleForAccountCommand}.
13
17
  */
14
18
  export interface GetServiceRoleForAccountCommandOutput extends GetServiceRoleForAccountResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
18
23
  * IoT Greengrass uses this role to verify the identity of client devices and manage core device
19
24
  * connectivity information. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html">Greengrass service role</a> in
@@ -28,6 +33,8 @@ export interface GetServiceRoleForAccountCommandOutput extends GetServiceRoleFor
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param GetServiceRoleForAccountCommandInput - {@link GetServiceRoleForAccountCommandInput}
37
+ * @returns {@link GetServiceRoleForAccountCommandOutput}
31
38
  * @see {@link GetServiceRoleForAccountCommandInput} for command's `input` shape.
32
39
  * @see {@link GetServiceRoleForAccountCommandOutput} for command's `response` shape.
33
40
  * @see {@link GreengrassV2ClientResolvedConfig | config} for GreengrassV2Client's `config` shape.
@@ -40,11 +47,20 @@ export interface GetServiceRoleForAccountCommandOutput extends GetServiceRoleFor
40
47
  export declare class GetServiceRoleForAccountCommand extends $Command<GetServiceRoleForAccountCommandInput, GetServiceRoleForAccountCommandOutput, GreengrassV2ClientResolvedConfig> {
41
48
  readonly input: GetServiceRoleForAccountCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: GetServiceRoleForAccountCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GreengrassV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetServiceRoleForAccountCommandInput, GetServiceRoleForAccountCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GreengrassV2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GreengrassV2Client";
5
5
  import { ListClientDevicesAssociatedWithCoreDeviceRequest, ListClientDevicesAssociatedWithCoreDeviceResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListClientDevicesAssociatedWithCoreDeviceCommand}.
8
10
  */
9
11
  export interface ListClientDevicesAssociatedWithCoreDeviceCommandInput extends ListClientDevicesAssociatedWithCoreDeviceRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListClientDevicesAssociatedWithCoreDeviceCommand}.
13
17
  */
14
18
  export interface ListClientDevicesAssociatedWithCoreDeviceCommandOutput extends ListClientDevicesAssociatedWithCoreDeviceResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a paginated list of client devices that are associated with a core
18
23
  * device.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface ListClientDevicesAssociatedWithCoreDeviceCommandOutput extends
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param ListClientDevicesAssociatedWithCoreDeviceCommandInput - {@link ListClientDevicesAssociatedWithCoreDeviceCommandInput}
35
+ * @returns {@link ListClientDevicesAssociatedWithCoreDeviceCommandOutput}
29
36
  * @see {@link ListClientDevicesAssociatedWithCoreDeviceCommandInput} for command's `input` shape.
30
37
  * @see {@link ListClientDevicesAssociatedWithCoreDeviceCommandOutput} for command's `response` shape.
31
38
  * @see {@link GreengrassV2ClientResolvedConfig | config} for GreengrassV2Client's `config` shape.
@@ -52,11 +59,20 @@ export interface ListClientDevicesAssociatedWithCoreDeviceCommandOutput extends
52
59
  export declare class ListClientDevicesAssociatedWithCoreDeviceCommand extends $Command<ListClientDevicesAssociatedWithCoreDeviceCommandInput, ListClientDevicesAssociatedWithCoreDeviceCommandOutput, GreengrassV2ClientResolvedConfig> {
53
60
  readonly input: ListClientDevicesAssociatedWithCoreDeviceCommandInput;
54
61
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
62
+ /**
63
+ * @public
64
+ */
55
65
  constructor(input: ListClientDevicesAssociatedWithCoreDeviceCommandInput);
56
66
  /**
57
67
  * @internal
58
68
  */
59
69
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: GreengrassV2ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListClientDevicesAssociatedWithCoreDeviceCommandInput, ListClientDevicesAssociatedWithCoreDeviceCommandOutput>;
70
+ /**
71
+ * @internal
72
+ */
60
73
  private serialize;
74
+ /**
75
+ * @internal
76
+ */
61
77
  private deserialize;
62
78
  }