Skip to content

Commit

Permalink
feat(client-groundstation): AWS Ground Station Wideband DigIF GA Release
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Apr 12, 2023
1 parent 2272405 commit 90bc06f
Show file tree
Hide file tree
Showing 10 changed files with 633 additions and 385 deletions.
15 changes: 12 additions & 3 deletions clients/client-groundstation/src/GroundStation.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -531,7 +531,10 @@ export class GroundStation extends GroundStationClient {

/**
* @public
* <p>Gets the latest configuration information for a registered agent.</p>
* <note>
* <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
* </note>
* <p>Gets the latest configuration information for a registered agent.</p>
*/
public getAgentConfiguration(
args: GetAgentConfigurationCommandInput,
Expand Down Expand Up @@ -979,7 +982,10 @@ export class GroundStation extends GroundStationClient {

/**
* @public
* <p>Registers a new agent with AWS Groundstation.</p>
* <note>
* <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
* </note>
* <p> Registers a new agent with AWS Ground Station. </p>
*/
public registerAgent(
args: RegisterAgentCommandInput,
Expand Down Expand Up @@ -1105,7 +1111,10 @@ export class GroundStation extends GroundStationClient {

/**
* @public
* <p>Update the status of the agent.</p>
* <note>
* <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
* </note>
* <p>Update the status of the agent.</p>
*/
public updateAgentStatus(
args: UpdateAgentStatusCommandInput,
Expand Down
4 changes: 4 additions & 0 deletions clients/client-groundstation/src/commands/CreateDataflowEndpointGroupCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,10 @@ export interface CreateDataflowEndpointGroupCommandOutput extends DataflowEndpoi
* agentStatus: "STRING_VALUE",
* auditResults: "STRING_VALUE",
* },
* healthStatus: "STRING_VALUE",
* healthReasons: [ // CapabilityHealthReasonList
* "STRING_VALUE",
* ],
* },
* ],
* tags: { // TagsMap
Expand Down
5 changes: 4 additions & 1 deletion clients/client-groundstation/src/commands/GetAgentConfigurationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ export interface GetAgentConfigurationCommandOutput extends GetAgentConfiguratio

/**
* @public
* <p>Gets the latest configuration information for a registered agent.</p>
* <note>
* <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
* </note>
* <p>Gets the latest configuration information for a registered agent.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
10 changes: 8 additions & 2 deletions clients/client-groundstation/src/commands/RegisterAgentCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ export interface RegisterAgentCommandOutput extends RegisterAgentResponse, __Met

/**
* @public
* <p>Registers a new agent with AWS Groundstation.</p>
* <note>
* <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
* </note>
* <p> Registers a new agent with AWS Ground Station. </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand All @@ -55,7 +58,10 @@ export interface RegisterAgentCommandOutput extends RegisterAgentResponse, __Met
* agentVersion: "STRING_VALUE", // required
* instanceId: "STRING_VALUE", // required
* instanceType: "STRING_VALUE", // required
* reservedCpuCores: [ // ReservedCpuCoresList // required
* reservedCpuCores: [ // AgentCpuCoresList
* Number("int"),
* ],
* agentCpuCores: [
* Number("int"),
* ],
* componentVersions: [ // ComponentVersionList // required
Expand Down
5 changes: 4 additions & 1 deletion clients/client-groundstation/src/commands/UpdateAgentStatusCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ export interface UpdateAgentStatusCommandOutput extends UpdateAgentStatusRespons

/**
* @public
* <p>Update the status of the agent.</p>
* <note>
* <p> For use by AWS Ground Station Agent and shouldn't be called directly.</p>
* </note>
* <p>Update the status of the agent.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
2 changes: 1 addition & 1 deletion clients/client-groundstation/src/endpoint/EndpointParameters.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export const resolveClientEndpointParameters = <T>(
};

export interface EndpointParameters extends __EndpointParameters {
Region: string;
Region?: string;
UseDualStack?: boolean;
UseFIPS?: boolean;
Endpoint?: string;
Expand Down
39 changes: 20 additions & 19 deletions clients/client-groundstation/src/endpoint/ruleset.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,25 @@ import { RuleSetObject } from "@aws-sdk/util-endpoints";
or see "smithy.rules#endpointRuleSet"
in codegen/sdk-codegen/aws-models/groundstation.json */

const q="fn",
r="argv",
s="ref";
const a=true,
b=false,
c="String",
d="PartitionResult",
e="tree",
f="error",
g="endpoint",
h={"required":true,"default":false,"type":"Boolean"},
i={[s]:"Endpoint"},
j={[q]:"booleanEquals",[r]:[{[s]:"UseFIPS"},true]},
k={[q]:"booleanEquals",[r]:[{[s]:"UseDualStack"},true]},
l={},
m={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:d},"supportsFIPS"]}]},
n={[q]:"booleanEquals",[r]:[true,{[q]:"getAttr",[r]:[{[s]:d},"supportsDualStack"]}]},
const q="required",
r="fn",
s="argv",
t="ref";
const a="isSet",
b="tree",
c="error",
d="endpoint",
e="PartitionResult",
f={[q]:false,"type":"String"},
g={[q]:true,"default":false,"type":"Boolean"},
h={[t]:"Endpoint"},
i={[r]:"booleanEquals",[s]:[{[t]:"UseFIPS"},true]},
j={[r]:"booleanEquals",[s]:[{[t]:"UseDualStack"},true]},
k={},
l={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsFIPS"]}]},
m={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsDualStack"]}]},
n=[i],
o=[j],
p=[k];
const _data={version:"1.0",parameters:{Region:{required:a,type:c},UseDualStack:h,UseFIPS:h,Endpoint:{required:b,type:c}},rules:[{conditions:[{[q]:"aws.partition",[r]:[{[s]:"Region"}],assign:d}],type:e,rules:[{conditions:[{[q]:"isSet",[r]:[i]}],type:e,rules:[{conditions:o,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:f},{type:e,rules:[{conditions:p,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:f},{endpoint:{url:i,properties:l,headers:l},type:g}]}]},{conditions:[j,k],type:e,rules:[{conditions:[m,n],type:e,rules:[{type:e,rules:[{endpoint:{url:"https://groundstation-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:g}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:f}]},{conditions:o,type:e,rules:[{conditions:[m],type:e,rules:[{type:e,rules:[{endpoint:{url:"https://groundstation-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:g}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:f}]},{conditions:p,type:e,rules:[{conditions:[n],type:e,rules:[{type:e,rules:[{endpoint:{url:"https://groundstation.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:g}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:f}]},{type:e,rules:[{endpoint:{url:"https://groundstation.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:g}]}]}]};
p=[{[t]:"Region"}];
const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[r]:a,[s]:[h]}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]}]},{type:b,rules:[{conditions:[{[r]:a,[s]:p}],type:b,rules:[{conditions:[{[r]:"aws.partition",[s]:p,assign:e}],type:b,rules:[{conditions:[i,j],type:b,rules:[{conditions:[l,m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://groundstation-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[l],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://groundstation-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://groundstation.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://groundstation.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]};
export const ruleSet: RuleSetObject = _data;
84 changes: 60 additions & 24 deletions clients/client-groundstation/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,21 +100,6 @@ export class ResourceNotFoundException extends __BaseException {
}
}

/**
* @public
* @enum
*/
export const ComponentType = {
DIGITIZER: "DIGITIZER",
LAMINAR_FLOW: "LAMINAR_FLOW",
PRISM: "PRISM",
} as const;

/**
* @public
*/
export type ComponentType = (typeof ComponentType)[keyof typeof ComponentType];

/**
* @public
* <p>Version information for agent components.</p>
Expand All @@ -123,7 +108,7 @@ export interface ComponentVersion {
/**
* <p>Component type.</p>
*/
componentType: ComponentType | string | undefined;
componentType: string | undefined;

/**
* <p>List of versions.</p>
Expand Down Expand Up @@ -152,9 +137,17 @@ export interface AgentDetails {
instanceType: string | undefined;

/**
* <p>Number of Cpu cores reserved for agent.</p>
* <note>
* <p>This field should not be used. Use agentCpuCores instead.</p>
* </note>
* <p>List of CPU cores reserved for processes other than the agent running on the EC2 instance.</p>
*/
reservedCpuCores: number[] | undefined;
reservedCpuCores?: number[];

/**
* <p>List of CPU cores reserved for the agent.</p>
*/
agentCpuCores?: number[];

/**
* <p>List of versions being used by agent components.</p>
Expand Down Expand Up @@ -188,7 +181,7 @@ export interface DiscoveryData {
*/
export interface RegisterAgentRequest {
/**
* <p>Data for associating and agent with the capabilities it is managing.</p>
* <p>Data for associating an agent with the capabilities it is managing.</p>
*/
discoveryData: DiscoveryData | undefined;

Expand Down Expand Up @@ -248,7 +241,7 @@ export interface ComponentStatusData {
/**
* <p>The Component type.</p>
*/
componentType: ComponentType | string | undefined;
componentType: string | undefined;

/**
* <p>Capability ARN of the component.</p>
Expand Down Expand Up @@ -729,6 +722,39 @@ export interface ContactIdResponse {
contactId?: string;
}

/**
* @public
* @enum
*/
export const CapabilityHealth = {
HEALTHY: "HEALTHY",
UNHEALTHY: "UNHEALTHY",
} as const;

/**
* @public
*/
export type CapabilityHealth = (typeof CapabilityHealth)[keyof typeof CapabilityHealth];

/**
* @public
* @enum
*/
export const CapabilityHealthReason = {
DATAPLANE_FAILURE: "DATAPLANE_FAILURE",
HEALTHY: "HEALTHY",
INITIALIZING_DATAPLANE: "INITIALIZING_DATAPLANE",
INVALID_IP_OWNERSHIP: "INVALID_IP_OWNERSHIP",
NOT_AUTHORIZED_TO_CREATE_SLR: "NOT_AUTHORIZED_TO_CREATE_SLR",
NO_REGISTERED_AGENT: "NO_REGISTERED_AGENT",
UNVERIFIED_IP_OWNERSHIP: "UNVERIFIED_IP_OWNERSHIP",
} as const;

/**
* @public
*/
export type CapabilityHealthReason = (typeof CapabilityHealthReason)[keyof typeof CapabilityHealthReason];

/**
* @public
* @enum
Expand Down Expand Up @@ -1288,6 +1314,16 @@ export interface EndpointDetails {
* <p>An agent endpoint.</p>
*/
awsGroundStationAgentEndpoint?: AwsGroundStationAgentEndpoint;

/**
* <p>A dataflow endpoint health status. This field is ignored when calling <code>CreateDataflowEndpointGroup</code>.</p>
*/
healthStatus?: CapabilityHealth | string;

/**
* <p>Health reasons for a dataflow endpoint. This field is ignored when calling <code>CreateDataflowEndpointGroup</code>.</p>
*/
healthReasons?: (CapabilityHealthReason | string)[];
}

/**
Expand Down Expand Up @@ -1760,12 +1796,12 @@ export interface CreateDataflowEndpointGroupRequest {
tags?: Record<string, string>;

/**
* <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>
* <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>
*/
contactPrePassDurationSeconds?: number;

/**
* <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>
* <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>
*/
contactPostPassDurationSeconds?: number;
}
Expand Down Expand Up @@ -2135,12 +2171,12 @@ export interface GetDataflowEndpointGroupResponse {
tags?: Record<string, string>;

/**
* <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>
* <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>
*/
contactPrePassDurationSeconds?: number;

/**
* <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>
* <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>
*/
contactPostPassDurationSeconds?: number;
}
Expand Down
Loading

0 comments on commit 90bc06f

Please sign in to comment.