@aws-sdk/client-groundstation 3.310.0 → 3.315.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.
@@ -128,7 +128,10 @@ export declare class GroundStation extends GroundStationClient {
128
128
  describeEphemeris(args: DescribeEphemerisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEphemerisCommandOutput) => void): void;
129
129
  /**
130
130
  * @public
131
- * <p>Gets the latest configuration information for a registered agent.</p>
131
+ * <note>
132
+ * <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
133
+ * </note>
134
+ * <p>Gets the latest configuration information for a registered agent.</p>
132
135
  */
133
136
  getAgentConfiguration(args: GetAgentConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetAgentConfigurationCommandOutput>;
134
137
  getAgentConfiguration(args: GetAgentConfigurationCommandInput, cb: (err: any, data?: GetAgentConfigurationCommandOutput) => void): void;
@@ -230,7 +233,10 @@ export declare class GroundStation extends GroundStationClient {
230
233
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
231
234
  /**
232
235
  * @public
233
- * <p>Registers a new agent with AWS Groundstation.</p>
236
+ * <note>
237
+ * <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
238
+ * </note>
239
+ * <p> Registers a new agent with AWS Ground Station. </p>
234
240
  */
235
241
  registerAgent(args: RegisterAgentCommandInput, options?: __HttpHandlerOptions): Promise<RegisterAgentCommandOutput>;
236
242
  registerAgent(args: RegisterAgentCommandInput, cb: (err: any, data?: RegisterAgentCommandOutput) => void): void;
@@ -258,7 +264,10 @@ export declare class GroundStation extends GroundStationClient {
258
264
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
259
265
  /**
260
266
  * @public
261
- * <p>Update the status of the agent.</p>
267
+ * <note>
268
+ * <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
269
+ * </note>
270
+ * <p>Update the status of the agent.</p>
262
271
  */
263
272
  updateAgentStatus(args: UpdateAgentStatusCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAgentStatusCommandOutput>;
264
273
  updateAgentStatus(args: UpdateAgentStatusCommandInput, cb: (err: any, data?: UpdateAgentStatusCommandOutput) => void): void;
@@ -73,6 +73,10 @@ export interface CreateDataflowEndpointGroupCommandOutput extends DataflowEndpoi
73
73
  * agentStatus: "STRING_VALUE",
74
74
  * auditResults: "STRING_VALUE",
75
75
  * },
76
+ * healthStatus: "STRING_VALUE",
77
+ * healthReasons: [ // CapabilityHealthReasonList
78
+ * "STRING_VALUE",
79
+ * ],
76
80
  * },
77
81
  * ],
78
82
  * tags: { // TagsMap
@@ -19,7 +19,10 @@ export interface GetAgentConfigurationCommandOutput extends GetAgentConfiguratio
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Gets the latest configuration information for a registered agent.</p>
22
+ * <note>
23
+ * <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
24
+ * </note>
25
+ * <p>Gets the latest configuration information for a registered agent.</p>
23
26
  * @example
24
27
  * Use a bare-bones client and the command you need to make an API call.
25
28
  * ```javascript
@@ -19,7 +19,10 @@ export interface RegisterAgentCommandOutput extends RegisterAgentResponse, __Met
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Registers a new agent with AWS Groundstation.</p>
22
+ * <note>
23
+ * <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
24
+ * </note>
25
+ * <p> Registers a new agent with AWS Ground Station. </p>
23
26
  * @example
24
27
  * Use a bare-bones client and the command you need to make an API call.
25
28
  * ```javascript
@@ -42,7 +45,10 @@ export interface RegisterAgentCommandOutput extends RegisterAgentResponse, __Met
42
45
  * agentVersion: "STRING_VALUE", // required
43
46
  * instanceId: "STRING_VALUE", // required
44
47
  * instanceType: "STRING_VALUE", // required
45
- * reservedCpuCores: [ // ReservedCpuCoresList // required
48
+ * reservedCpuCores: [ // AgentCpuCoresList
49
+ * Number("int"),
50
+ * ],
51
+ * agentCpuCores: [
46
52
  * Number("int"),
47
53
  * ],
48
54
  * componentVersions: [ // ComponentVersionList // required
@@ -19,7 +19,10 @@ export interface UpdateAgentStatusCommandOutput extends UpdateAgentStatusRespons
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Update the status of the agent.</p>
22
+ * <note>
23
+ * <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
24
+ * </note>
25
+ * <p>Update the status of the agent.</p>
23
26
  * @example
24
27
  * Use a bare-bones client and the command you need to make an API call.
25
28
  * ```javascript
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region: string;
15
+ Region?: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;
@@ -66,19 +66,6 @@ export declare class ResourceNotFoundException extends __BaseException {
66
66
  */
67
67
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
68
68
  }
69
- /**
70
- * @public
71
- * @enum
72
- */
73
- export declare const ComponentType: {
74
- readonly DIGITIZER: "DIGITIZER";
75
- readonly LAMINAR_FLOW: "LAMINAR_FLOW";
76
- readonly PRISM: "PRISM";
77
- };
78
- /**
79
- * @public
80
- */
81
- export type ComponentType = (typeof ComponentType)[keyof typeof ComponentType];
82
69
  /**
83
70
  * @public
84
71
  * <p>Version information for agent components.</p>
@@ -87,7 +74,7 @@ export interface ComponentVersion {
87
74
  /**
88
75
  * <p>Component type.</p>
89
76
  */
90
- componentType: ComponentType | string | undefined;
77
+ componentType: string | undefined;
91
78
  /**
92
79
  * <p>List of versions.</p>
93
80
  */
@@ -111,9 +98,16 @@ export interface AgentDetails {
111
98
  */
112
99
  instanceType: string | undefined;
113
100
  /**
114
- * <p>Number of Cpu cores reserved for agent.</p>
101
+ * <note>
102
+ * <p>This field should not be used. Use agentCpuCores instead.</p>
103
+ * </note>
104
+ * <p>List of CPU cores reserved for processes other than the agent running on the EC2 instance.</p>
115
105
  */
116
- reservedCpuCores: number[] | undefined;
106
+ reservedCpuCores?: number[];
107
+ /**
108
+ * <p>List of CPU cores reserved for the agent.</p>
109
+ */
110
+ agentCpuCores?: number[];
117
111
  /**
118
112
  * <p>List of versions being used by agent components.</p>
119
113
  */
@@ -142,7 +136,7 @@ export interface DiscoveryData {
142
136
  */
143
137
  export interface RegisterAgentRequest {
144
138
  /**
145
- * <p>Data for associating and agent with the capabilities it is managing.</p>
139
+ * <p>Data for associating an agent with the capabilities it is managing.</p>
146
140
  */
147
141
  discoveryData: DiscoveryData | undefined;
148
142
  /**
@@ -195,7 +189,7 @@ export interface ComponentStatusData {
195
189
  /**
196
190
  * <p>The Component type.</p>
197
191
  */
198
- componentType: ComponentType | string | undefined;
192
+ componentType: string | undefined;
199
193
  /**
200
194
  * <p>Capability ARN of the component.</p>
201
195
  */
@@ -614,6 +608,35 @@ export interface ContactIdResponse {
614
608
  */
615
609
  contactId?: string;
616
610
  }
611
+ /**
612
+ * @public
613
+ * @enum
614
+ */
615
+ export declare const CapabilityHealth: {
616
+ readonly HEALTHY: "HEALTHY";
617
+ readonly UNHEALTHY: "UNHEALTHY";
618
+ };
619
+ /**
620
+ * @public
621
+ */
622
+ export type CapabilityHealth = (typeof CapabilityHealth)[keyof typeof CapabilityHealth];
623
+ /**
624
+ * @public
625
+ * @enum
626
+ */
627
+ export declare const CapabilityHealthReason: {
628
+ readonly DATAPLANE_FAILURE: "DATAPLANE_FAILURE";
629
+ readonly HEALTHY: "HEALTHY";
630
+ readonly INITIALIZING_DATAPLANE: "INITIALIZING_DATAPLANE";
631
+ readonly INVALID_IP_OWNERSHIP: "INVALID_IP_OWNERSHIP";
632
+ readonly NOT_AUTHORIZED_TO_CREATE_SLR: "NOT_AUTHORIZED_TO_CREATE_SLR";
633
+ readonly NO_REGISTERED_AGENT: "NO_REGISTERED_AGENT";
634
+ readonly UNVERIFIED_IP_OWNERSHIP: "UNVERIFIED_IP_OWNERSHIP";
635
+ };
636
+ /**
637
+ * @public
638
+ */
639
+ export type CapabilityHealthReason = (typeof CapabilityHealthReason)[keyof typeof CapabilityHealthReason];
617
640
  /**
618
641
  * @public
619
642
  * @enum
@@ -1083,6 +1106,14 @@ export interface EndpointDetails {
1083
1106
  * <p>An agent endpoint.</p>
1084
1107
  */
1085
1108
  awsGroundStationAgentEndpoint?: AwsGroundStationAgentEndpoint;
1109
+ /**
1110
+ * <p>A dataflow endpoint health status. This field is ignored when calling <code>CreateDataflowEndpointGroup</code>.</p>
1111
+ */
1112
+ healthStatus?: CapabilityHealth | string;
1113
+ /**
1114
+ * <p>Health reasons for a dataflow endpoint. This field is ignored when calling <code>CreateDataflowEndpointGroup</code>.</p>
1115
+ */
1116
+ healthReasons?: (CapabilityHealthReason | string)[];
1086
1117
  }
1087
1118
  /**
1088
1119
  * @public
@@ -1474,11 +1505,11 @@ export interface CreateDataflowEndpointGroupRequest {
1474
1505
  */
1475
1506
  tags?: Record<string, string>;
1476
1507
  /**
1477
- * <p>Amount of time, in seconds, prior to contact start for the contact to remain in a <code>PREPASS</code> state. A CloudWatch event is emitted when the contact enters and exits the <code>PREPASS</code> state.</p>
1508
+ * <p>Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a <code>PREPASS</code> state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the <code>PREPASS</code> state.</p>
1478
1509
  */
1479
1510
  contactPrePassDurationSeconds?: number;
1480
1511
  /**
1481
- * <p>Amount of time, in seconds, after a contact ends for the contact to remain in a <code>POSTPASS</code> state. A CloudWatch event is emitted when the contact enters and exits the <code>POSTPASS</code> state.</p>
1512
+ * <p>Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a <code>POSTPASS</code> state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the <code>POSTPASS</code> state.</p>
1482
1513
  */
1483
1514
  contactPostPassDurationSeconds?: number;
1484
1515
  }
@@ -1789,11 +1820,11 @@ export interface GetDataflowEndpointGroupResponse {
1789
1820
  */
1790
1821
  tags?: Record<string, string>;
1791
1822
  /**
1792
- * <p>Amount of time, in seconds, prior to contact start for the contact to remain in a <code>PREPASS</code> state. A CloudWatch event is emitted when the contact enters and exits the <code>PREPASS</code> state.</p>
1823
+ * <p>Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a <code>PREPASS</code> state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the <code>PREPASS</code> state.</p>
1793
1824
  */
1794
1825
  contactPrePassDurationSeconds?: number;
1795
1826
  /**
1796
- * <p>Amount of time, in seconds, after a contact ends for the contact to remain in a <code>POSTPASS</code> state. A CloudWatch event is emitted when the contact enters and exits the <code>POSTPASS</code> state.</p>
1827
+ * <p>Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a <code>POSTPASS</code> state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the <code>POSTPASS</code> state.</p>
1797
1828
  */
1798
1829
  contactPostPassDurationSeconds?: number;
1799
1830
  }
@@ -26,7 +26,7 @@ export declare const resolveClientEndpointParameters: <T>(
26
26
  defaultSigningName: string;
27
27
  };
28
28
  export interface EndpointParameters extends __EndpointParameters {
29
- Region: string;
29
+ Region?: string;
30
30
  UseDualStack?: boolean;
31
31
  UseFIPS?: boolean;
32
32
  Endpoint?: string;
@@ -30,21 +30,16 @@ export declare class ResourceNotFoundException extends __BaseException {
30
30
  opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
31
31
  );
32
32
  }
33
- export declare const ComponentType: {
34
- readonly DIGITIZER: "DIGITIZER";
35
- readonly LAMINAR_FLOW: "LAMINAR_FLOW";
36
- readonly PRISM: "PRISM";
37
- };
38
- export type ComponentType = (typeof ComponentType)[keyof typeof ComponentType];
39
33
  export interface ComponentVersion {
40
- componentType: ComponentType | string | undefined;
34
+ componentType: string | undefined;
41
35
  versions: string[] | undefined;
42
36
  }
43
37
  export interface AgentDetails {
44
38
  agentVersion: string | undefined;
45
39
  instanceId: string | undefined;
46
40
  instanceType: string | undefined;
47
- reservedCpuCores: number[] | undefined;
41
+ reservedCpuCores?: number[];
42
+ agentCpuCores?: number[];
48
43
  componentVersions: ComponentVersion[] | undefined;
49
44
  }
50
45
  export interface DiscoveryData {
@@ -71,7 +66,7 @@ export interface AggregateStatus {
71
66
  signatureMap?: Record<string, boolean>;
72
67
  }
73
68
  export interface ComponentStatusData {
74
- componentType: ComponentType | string | undefined;
69
+ componentType: string | undefined;
75
70
  capabilityArn: string | undefined;
76
71
  status: AgentStatus | string | undefined;
77
72
  bytesSent?: number;
@@ -198,6 +193,23 @@ export interface CancelContactRequest {
198
193
  export interface ContactIdResponse {
199
194
  contactId?: string;
200
195
  }
196
+ export declare const CapabilityHealth: {
197
+ readonly HEALTHY: "HEALTHY";
198
+ readonly UNHEALTHY: "UNHEALTHY";
199
+ };
200
+ export type CapabilityHealth =
201
+ (typeof CapabilityHealth)[keyof typeof CapabilityHealth];
202
+ export declare const CapabilityHealthReason: {
203
+ readonly DATAPLANE_FAILURE: "DATAPLANE_FAILURE";
204
+ readonly HEALTHY: "HEALTHY";
205
+ readonly INITIALIZING_DATAPLANE: "INITIALIZING_DATAPLANE";
206
+ readonly INVALID_IP_OWNERSHIP: "INVALID_IP_OWNERSHIP";
207
+ readonly NOT_AUTHORIZED_TO_CREATE_SLR: "NOT_AUTHORIZED_TO_CREATE_SLR";
208
+ readonly NO_REGISTERED_AGENT: "NO_REGISTERED_AGENT";
209
+ readonly UNVERIFIED_IP_OWNERSHIP: "UNVERIFIED_IP_OWNERSHIP";
210
+ };
211
+ export type CapabilityHealthReason =
212
+ (typeof CapabilityHealthReason)[keyof typeof CapabilityHealthReason];
201
213
  export declare const ConfigCapabilityType: {
202
214
  readonly ANTENNA_DOWNLINK: "antenna-downlink";
203
215
  readonly ANTENNA_DOWNLINK_DEMOD_DECODE: "antenna-downlink-demod-decode";
@@ -413,6 +425,8 @@ export interface EndpointDetails {
413
425
  securityDetails?: SecurityDetails;
414
426
  endpoint?: DataflowEndpoint;
415
427
  awsGroundStationAgentEndpoint?: AwsGroundStationAgentEndpoint;
428
+ healthStatus?: CapabilityHealth | string;
429
+ healthReasons?: (CapabilityHealthReason | string)[];
416
430
  }
417
431
  export interface S3RecordingDetails {
418
432
  bucketArn?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-groundstation",
3
3
  "description": "AWS SDK for JavaScript Groundstation Client for Node.js, Browser and React Native",
4
- "version": "3.310.0",
4
+ "version": "3.315.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.310.0",
24
+ "@aws-sdk/client-sts": "3.315.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.310.0",
26
+ "@aws-sdk/credential-provider-node": "3.315.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",
@@ -40,14 +40,14 @@
40
40
  "@aws-sdk/node-config-provider": "3.310.0",
41
41
  "@aws-sdk/node-http-handler": "3.310.0",
42
42
  "@aws-sdk/protocol-http": "3.310.0",
43
- "@aws-sdk/smithy-client": "3.310.0",
43
+ "@aws-sdk/smithy-client": "3.315.0",
44
44
  "@aws-sdk/types": "3.310.0",
45
45
  "@aws-sdk/url-parser": "3.310.0",
46
46
  "@aws-sdk/util-base64": "3.310.0",
47
47
  "@aws-sdk/util-body-length-browser": "3.310.0",
48
48
  "@aws-sdk/util-body-length-node": "3.310.0",
49
- "@aws-sdk/util-defaults-mode-browser": "3.310.0",
50
- "@aws-sdk/util-defaults-mode-node": "3.310.0",
49
+ "@aws-sdk/util-defaults-mode-browser": "3.315.0",
50
+ "@aws-sdk/util-defaults-mode-node": "3.315.0",
51
51
  "@aws-sdk/util-endpoints": "3.310.0",
52
52
  "@aws-sdk/util-retry": "3.310.0",
53
53
  "@aws-sdk/util-user-agent-browser": "3.310.0",