Skip to content

Commit

Permalink
docs(clients): update clients input and resolved config to interface (#…
Browse files Browse the repository at this point in the history
…2304)

This is a follow up to #2270 for the newly generated clients
  • Loading branch information
AllanZhengYP authored Apr 28, 2021
1 parent 28008c2 commit d52f7e6
Show file tree
Hide file tree
Showing 14 changed files with 182 additions and 28 deletions.
15 changes: 13 additions & 2 deletions clients/client-amp/AmpClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -167,23 +167,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
defaultUserAgentProvider?: Provider<__UserAgent>;
}

export type AmpClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
type AmpClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
ClientDefaults &
RegionInputConfig &
EndpointsInputConfig &
RetryInputConfig &
HostHeaderInputConfig &
AwsAuthInputConfig &
UserAgentInputConfig;
/**
* The configuration interface of AmpClient class constructor that set the region, credentials and other options.
*/
export interface AmpClientConfig extends AmpClientConfigType {}

export type AmpClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
type AmpClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
Required<ClientDefaults> &
RegionResolvedConfig &
EndpointsResolvedConfig &
RetryResolvedConfig &
HostHeaderResolvedConfig &
AwsAuthResolvedConfig &
UserAgentResolvedConfig;
/**
* The resolved configuration interface of AmpClient class. This is resolved and normalized from the {@link AmpClientConfig | constructor configuration interface}.
*/
export interface AmpClientResolvedConfig extends AmpClientResolvedConfigType {}

/**
* Amazon Managed Service for Prometheus
Expand All @@ -194,6 +202,9 @@ export class AmpClient extends __Client<
ServiceOutputTypes,
AmpClientResolvedConfig
> {
/**
* The resolved configuration of AmpClient class. This is resolved and normalized from the {@link AmpClientConfig | constructor configuration interface}.
*/
readonly config: AmpClientResolvedConfig;

constructor(configuration: AmpClientConfig) {
Expand Down
15 changes: 13 additions & 2 deletions clients/client-fis/FisClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -209,23 +209,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
defaultUserAgentProvider?: Provider<__UserAgent>;
}

export type FisClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
type FisClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
ClientDefaults &
RegionInputConfig &
EndpointsInputConfig &
RetryInputConfig &
HostHeaderInputConfig &
AwsAuthInputConfig &
UserAgentInputConfig;
/**
* The configuration interface of FisClient class constructor that set the region, credentials and other options.
*/
export interface FisClientConfig extends FisClientConfigType {}

export type FisClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
type FisClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
Required<ClientDefaults> &
RegionResolvedConfig &
EndpointsResolvedConfig &
RetryResolvedConfig &
HostHeaderResolvedConfig &
AwsAuthResolvedConfig &
UserAgentResolvedConfig;
/**
* The resolved configuration interface of FisClient class. This is resolved and normalized from the {@link FisClientConfig | constructor configuration interface}.
*/
export interface FisClientResolvedConfig extends FisClientResolvedConfigType {}

/**
* <p>AWS Fault Injection Simulator is a managed service that enables you to perform fault injection
Expand All @@ -237,6 +245,9 @@ export class FisClient extends __Client<
ServiceOutputTypes,
FisClientResolvedConfig
> {
/**
* The resolved configuration of FisClient class. This is resolved and normalized from the {@link FisClientConfig | constructor configuration interface}.
*/
readonly config: FisClientResolvedConfig;

constructor(configuration: FisClientConfig) {
Expand Down
15 changes: 13 additions & 2 deletions clients/client-greengrassv2/GreengrassV2Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -230,23 +230,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
defaultUserAgentProvider?: Provider<__UserAgent>;
}

export type GreengrassV2ClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
type GreengrassV2ClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
ClientDefaults &
RegionInputConfig &
EndpointsInputConfig &
RetryInputConfig &
HostHeaderInputConfig &
AwsAuthInputConfig &
UserAgentInputConfig;
/**
* The configuration interface of GreengrassV2Client class constructor that set the region, credentials and other options.
*/
export interface GreengrassV2ClientConfig extends GreengrassV2ClientConfigType {}

export type GreengrassV2ClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
type GreengrassV2ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
Required<ClientDefaults> &
RegionResolvedConfig &
EndpointsResolvedConfig &
RetryResolvedConfig &
HostHeaderResolvedConfig &
AwsAuthResolvedConfig &
UserAgentResolvedConfig;
/**
* The resolved configuration interface of GreengrassV2Client class. This is resolved and normalized from the {@link GreengrassV2ClientConfig | constructor configuration interface}.
*/
export interface GreengrassV2ClientResolvedConfig extends GreengrassV2ClientResolvedConfigType {}

/**
* <p>AWS IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities
Expand All @@ -267,6 +275,9 @@ export class GreengrassV2Client extends __Client<
ServiceOutputTypes,
GreengrassV2ClientResolvedConfig
> {
/**
* The resolved configuration of GreengrassV2Client class. This is resolved and normalized from the {@link GreengrassV2ClientConfig | constructor configuration interface}.
*/
readonly config: GreengrassV2ClientResolvedConfig;

constructor(configuration: GreengrassV2ClientConfig) {
Expand Down
15 changes: 13 additions & 2 deletions clients/client-iot-wireless/IoTWirelessClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -410,23 +410,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
defaultUserAgentProvider?: Provider<__UserAgent>;
}

export type IoTWirelessClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
type IoTWirelessClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
ClientDefaults &
RegionInputConfig &
EndpointsInputConfig &
RetryInputConfig &
HostHeaderInputConfig &
AwsAuthInputConfig &
UserAgentInputConfig;
/**
* The configuration interface of IoTWirelessClient class constructor that set the region, credentials and other options.
*/
export interface IoTWirelessClientConfig extends IoTWirelessClientConfigType {}

export type IoTWirelessClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
type IoTWirelessClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
Required<ClientDefaults> &
RegionResolvedConfig &
EndpointsResolvedConfig &
RetryResolvedConfig &
HostHeaderResolvedConfig &
AwsAuthResolvedConfig &
UserAgentResolvedConfig;
/**
* The resolved configuration interface of IoTWirelessClient class. This is resolved and normalized from the {@link IoTWirelessClientConfig | constructor configuration interface}.
*/
export interface IoTWirelessClientResolvedConfig extends IoTWirelessClientResolvedConfigType {}

/**
* <p>AWS IoT Wireless API documentation</p>
Expand All @@ -437,6 +445,9 @@ export class IoTWirelessClient extends __Client<
ServiceOutputTypes,
IoTWirelessClientResolvedConfig
> {
/**
* The resolved configuration of IoTWirelessClient class. This is resolved and normalized from the {@link IoTWirelessClientConfig | constructor configuration interface}.
*/
readonly config: IoTWirelessClientResolvedConfig;

constructor(configuration: IoTWirelessClientConfig) {
Expand Down
15 changes: 13 additions & 2 deletions clients/client-iotdeviceadvisor/IotDeviceAdvisorClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -203,23 +203,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
defaultUserAgentProvider?: Provider<__UserAgent>;
}

export type IotDeviceAdvisorClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
type IotDeviceAdvisorClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
ClientDefaults &
RegionInputConfig &
EndpointsInputConfig &
RetryInputConfig &
HostHeaderInputConfig &
AwsAuthInputConfig &
UserAgentInputConfig;
/**
* The configuration interface of IotDeviceAdvisorClient class constructor that set the region, credentials and other options.
*/
export interface IotDeviceAdvisorClientConfig extends IotDeviceAdvisorClientConfigType {}

export type IotDeviceAdvisorClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
type IotDeviceAdvisorClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
Required<ClientDefaults> &
RegionResolvedConfig &
EndpointsResolvedConfig &
RetryResolvedConfig &
HostHeaderResolvedConfig &
AwsAuthResolvedConfig &
UserAgentResolvedConfig;
/**
* The resolved configuration interface of IotDeviceAdvisorClient class. This is resolved and normalized from the {@link IotDeviceAdvisorClientConfig | constructor configuration interface}.
*/
export interface IotDeviceAdvisorClientResolvedConfig extends IotDeviceAdvisorClientResolvedConfigType {}

/**
* <p>AWS IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development. Device Advisor provides pre-built tests that you can use to validate IoT devices for reliable and secure connectivity with AWS IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to AWS IoT Core, follow security best practices and, if applicable, receive software updates from IoT Device Management. You can also download signed qualification reports to submit to the AWS Partner Network to get your device qualified for the AWS Partner Device Catalog without the need to send your device in and wait for it to be tested.</p>
Expand All @@ -230,6 +238,9 @@ export class IotDeviceAdvisorClient extends __Client<
ServiceOutputTypes,
IotDeviceAdvisorClientResolvedConfig
> {
/**
* The resolved configuration of IotDeviceAdvisorClient class. This is resolved and normalized from the {@link IotDeviceAdvisorClientConfig | constructor configuration interface}.
*/
readonly config: IotDeviceAdvisorClientResolvedConfig;

constructor(configuration: IotDeviceAdvisorClientConfig) {
Expand Down
15 changes: 13 additions & 2 deletions clients/client-iotfleethub/IoTFleetHubClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -179,23 +179,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
defaultUserAgentProvider?: Provider<__UserAgent>;
}

export type IoTFleetHubClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
type IoTFleetHubClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
ClientDefaults &
RegionInputConfig &
EndpointsInputConfig &
RetryInputConfig &
HostHeaderInputConfig &
AwsAuthInputConfig &
UserAgentInputConfig;
/**
* The configuration interface of IoTFleetHubClient class constructor that set the region, credentials and other options.
*/
export interface IoTFleetHubClientConfig extends IoTFleetHubClientConfigType {}

export type IoTFleetHubClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
type IoTFleetHubClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
Required<ClientDefaults> &
RegionResolvedConfig &
EndpointsResolvedConfig &
RetryResolvedConfig &
HostHeaderResolvedConfig &
AwsAuthResolvedConfig &
UserAgentResolvedConfig;
/**
* The resolved configuration interface of IoTFleetHubClient class. This is resolved and normalized from the {@link IoTFleetHubClientConfig | constructor configuration interface}.
*/
export interface IoTFleetHubClientResolvedConfig extends IoTFleetHubClientResolvedConfigType {}

/**
* <p>With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.</p>
Expand All @@ -209,6 +217,9 @@ export class IoTFleetHubClient extends __Client<
ServiceOutputTypes,
IoTFleetHubClientResolvedConfig
> {
/**
* The resolved configuration of IoTFleetHubClient class. This is resolved and normalized from the {@link IoTFleetHubClientConfig | constructor configuration interface}.
*/
readonly config: IoTFleetHubClientResolvedConfig;

constructor(configuration: IoTFleetHubClientConfig) {
Expand Down
15 changes: 13 additions & 2 deletions clients/client-lex-models-v2/LexModelsV2Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -275,23 +275,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
defaultUserAgentProvider?: Provider<__UserAgent>;
}

export type LexModelsV2ClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
type LexModelsV2ClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
ClientDefaults &
RegionInputConfig &
EndpointsInputConfig &
RetryInputConfig &
HostHeaderInputConfig &
AwsAuthInputConfig &
UserAgentInputConfig;
/**
* The configuration interface of LexModelsV2Client class constructor that set the region, credentials and other options.
*/
export interface LexModelsV2ClientConfig extends LexModelsV2ClientConfigType {}

export type LexModelsV2ClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
type LexModelsV2ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
Required<ClientDefaults> &
RegionResolvedConfig &
EndpointsResolvedConfig &
RetryResolvedConfig &
HostHeaderResolvedConfig &
AwsAuthResolvedConfig &
UserAgentResolvedConfig;
/**
* The resolved configuration interface of LexModelsV2Client class. This is resolved and normalized from the {@link LexModelsV2ClientConfig | constructor configuration interface}.
*/
export interface LexModelsV2ClientResolvedConfig extends LexModelsV2ClientResolvedConfigType {}

/**
* <p></p>
Expand All @@ -302,6 +310,9 @@ export class LexModelsV2Client extends __Client<
ServiceOutputTypes,
LexModelsV2ClientResolvedConfig
> {
/**
* The resolved configuration of LexModelsV2Client class. This is resolved and normalized from the {@link LexModelsV2ClientConfig | constructor configuration interface}.
*/
readonly config: LexModelsV2ClientResolvedConfig;

constructor(configuration: LexModelsV2ClientConfig) {
Expand Down
15 changes: 13 additions & 2 deletions clients/client-lex-runtime-v2/LexRuntimeV2Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
eventStreamSerdeProvider?: __EventStreamSerdeProvider;
}

export type LexRuntimeV2ClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
type LexRuntimeV2ClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
ClientDefaults &
RegionInputConfig &
EndpointsInputConfig &
Expand All @@ -199,8 +199,12 @@ export type LexRuntimeV2ClientConfig = Partial<__SmithyConfiguration<__HttpHandl
EventStreamInputConfig &
UserAgentInputConfig &
EventStreamSerdeInputConfig;
/**
* The configuration interface of LexRuntimeV2Client class constructor that set the region, credentials and other options.
*/
export interface LexRuntimeV2ClientConfig extends LexRuntimeV2ClientConfigType {}

export type LexRuntimeV2ClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
type LexRuntimeV2ClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
Required<ClientDefaults> &
RegionResolvedConfig &
EndpointsResolvedConfig &
Expand All @@ -210,6 +214,10 @@ export type LexRuntimeV2ClientResolvedConfig = __SmithyResolvedConfiguration<__H
EventStreamResolvedConfig &
UserAgentResolvedConfig &
EventStreamSerdeResolvedConfig;
/**
* The resolved configuration interface of LexRuntimeV2Client class. This is resolved and normalized from the {@link LexRuntimeV2ClientConfig | constructor configuration interface}.
*/
export interface LexRuntimeV2ClientResolvedConfig extends LexRuntimeV2ClientResolvedConfigType {}

/**
* <p></p>
Expand All @@ -220,6 +228,9 @@ export class LexRuntimeV2Client extends __Client<
ServiceOutputTypes,
LexRuntimeV2ClientResolvedConfig
> {
/**
* The resolved configuration of LexRuntimeV2Client class. This is resolved and normalized from the {@link LexRuntimeV2ClientConfig | constructor configuration interface}.
*/
readonly config: LexRuntimeV2ClientResolvedConfig;

constructor(configuration: LexRuntimeV2ClientConfig) {
Expand Down
15 changes: 13 additions & 2 deletions clients/client-location/LocationClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -299,23 +299,31 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
defaultUserAgentProvider?: Provider<__UserAgent>;
}

export type LocationClientConfig = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
type LocationClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> &
ClientDefaults &
RegionInputConfig &
EndpointsInputConfig &
RetryInputConfig &
HostHeaderInputConfig &
AwsAuthInputConfig &
UserAgentInputConfig;
/**
* The configuration interface of LocationClient class constructor that set the region, credentials and other options.
*/
export interface LocationClientConfig extends LocationClientConfigType {}

export type LocationClientResolvedConfig = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
type LocationClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> &
Required<ClientDefaults> &
RegionResolvedConfig &
EndpointsResolvedConfig &
RetryResolvedConfig &
HostHeaderResolvedConfig &
AwsAuthResolvedConfig &
UserAgentResolvedConfig;
/**
* The resolved configuration interface of LocationClient class. This is resolved and normalized from the {@link LocationClientConfig | constructor configuration interface}.
*/
export interface LocationClientResolvedConfig extends LocationClientResolvedConfigType {}

/**
* Suite of geospatial services including Maps, Places, Tracking, and Geofencing
Expand All @@ -326,6 +334,9 @@ export class LocationClient extends __Client<
ServiceOutputTypes,
LocationClientResolvedConfig
> {
/**
* The resolved configuration of LocationClient class. This is resolved and normalized from the {@link LocationClientConfig | constructor configuration interface}.
*/
readonly config: LocationClientResolvedConfig;

constructor(configuration: LocationClientConfig) {
Expand Down
Loading

0 comments on commit d52f7e6

Please sign in to comment.